svn: /phpdoc/en/trunk/ language-snippets.ent
| From: | Jeremy Mikola | Date: | Thu, 19 May 2016 14:10:00 +0000 |
| Subject: | svn: /phpdoc/en/trunk/ language-snippets.ent | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-14137@lists.php.net to get a copy of this message | ||
jmikola Thu, 19 May 2016 14:10:00 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=339184
Log:
Clarify error handling implications for MongoWriteBatch's ordered option
Changed paths:
U phpdoc/en/trunk/language-snippets.ent
Modified: phpdoc/en/trunk/language-snippets.ent
===================================================================
--- phpdoc/en/trunk/language-snippets.ent 2016-05-17 22:23:00 UTC (rev 339183)
+++ phpdoc/en/trunk/language-snippets.ent 2016-05-19 14:10:00 UTC (rev 339184)
@@ -1892,7 +1892,7 @@
<!ENTITY mongo.errors.deprecated '<para xmlns="http://docbook.org/ns/docbook">Issues
<constant>E_DEPRECATED</constant> warning</para>'>
<!ENTITY mongo.gridfs.store.metadata.note '<note xmlns="http://docbook.org/ns/docbook"><para>These
fields may also overwrite those that would be created automatically by the driver, as described in
the MongoDB core documentation for the <link
xlink:href="&url.mongodb.docs.gridfs;#the-files-collection" xmlns:xlink="http://www.w3.org/1999/xlink">files
collection</link>. Some practical use cases for this behavior would be to specify a custom
<literal>chunkSize</literal> or <literal>_id</literal> for the
file.</para></note>'>
<!ENTITY mongo.gridfs.store.return '<para xmlns="http://docbook.org/ns/docbook">Returns the
<literal>_id</literal> of the saved file document. This will be a generated
<classname>MongoId</classname> unless an <literal>_id</literal> was
explicitly specified in the <parameter>metadata</parameter>
parameter.</para>'>
-<!ENTITY mongo.mongowritebatch.writeoptions.description '<listitem xmlns="http://docbook.org/ns/docbook"><para>An
array of Write
Options.<informaltable><thead><row><entry>key</entry><entry>value
meaning</entry></row></thead><tbody><row><entry>w
(int|string)</entry><entry><link linkend="mongo.writeconcerns">Write
concern</link> value</entry></row><row><entry>wtimeout
(int)</entry><entry><link linkend="mongo.writeconcerns">Maximum time to
wait for
replication</link></entry></row><row><entry>ordered</entry><entry>Determins
if MongoDB must apply this batch in order (sequentally, one item at a time) or can rearrange it.
Defaults to &true;</entry></row><row><entry>j
(bool)</entry><entry>Wait for journaling on the primary. This value is discouraged, use
WriteConcern instead</entry></row><row><entry>fsync
(bool)</entry><entry>Wait for fsync on the primary. This value is discouraged, use
WriteConcern
instead</entry></row></tbody></informaltable></para></listitem>'>
+<!ENTITY mongo.mongowritebatch.writeoptions.description '<listitem xmlns="http://docbook.org/ns/docbook"><para>An
array of Write
Options.<informaltable><thead><row><entry>key</entry><entry>value
meaning</entry></row></thead><tbody><row><entry>w
(int|string)</entry><entry><link linkend="mongo.writeconcerns">Write
concern</link> value</entry></row><row><entry>wtimeout
(int)</entry><entry><link linkend="mongo.writeconcerns">Maximum time to
wait for
replication</link></entry></row><row><entry>ordered</entry><entry>Determines
if MongoDB must apply this batch in order. Ordered writes execute serially (i.e. one at a time) and
execution will stop after the first error. Unordered writes may execute in parallel and execution
will not stop after the first error. Defaults to
&true;</entry></row><row><entry>j (bool)</entry><entry>Wait
for journaling on the primary. This value is discouraged, use WriteConcern
instead</entry></row><row><entry>fsync (bool)</entry><entry>Wait
for fsync on the primary. This value is discouraged, use WriteConcern
instead</entry></row></tbody></informaltable></para></listitem>'>
<!ENTITY mongo.mongowritebatch.collection.description '<listitem xmlns="http://docbook.org/ns/docbook"><para>The
<classname>MongoCollection</classname> to execute the batch on. Its <link
linkend="mongo.writeconcerns">write concern</link> will be copied and used as the
default write concern if none is given as <parameter>$write_options</parameter> or
during
<methodname>MongoWriteBatch::execute</methodname>.</para></listitem>'>
<!ENTITY mongo.context.server ' <varlistentry xmlns="http://docbook.org/ns/docbook"> <term>
<parameter>server</parameter> </term> <listitem> <para> An array
containing the basic information about the server that was picked. <informaltable> <tgroup
cols="2"> <thead> <row> <entry>key</entry>
<entry>value</entry> </row> </thead> <tbody> <row>
<entry>hash</entry> <entry>server hash, example:
<literal>localhost:27017;-;X;56052</literal></entry> </row> <row>
<entry>type</entry> <entry>Node type (primary/secondary/mongos/arbiter):
<literal>2</literal></entry> </row> <row>
<entry>max_bson_size</entry> <entry>The maximum BSON Size over the wire this node
accepts: <literal>16777216</literal></entry> </row> <row>
<entry>max_message_size</entry> <entry>The maximum Message Size over the wire this
node accepts: <literal>48000000</literal></entry> </row> <row>
<entry>request_id</entry> <entry>The request identifier for this message:
<literal>42</literal></entry> </row> </tbody> </tgroup>
</informaltable> </para> </listitem> </varlistentry>'>
<!ENTITY mongo.context.writeoptions '<varlistentry xmlns="http://docbook.org/ns/docbook"> <term>
<parameter>writeOptions</parameter> </term> <listitem> <para>
<informaltable> <tgroup cols="2"> <thead> <row>
<entry>key</entry> <entry>value</entry> </row> </thead>
<tbody> <row> <entry>ordered</entry> <entry>boolean, if the operation
(in case of batch operation) must be executed sequentually (ordered=true)</entry> </row>
<row> <entry>writeConcern</entry> <entry>An array of writeConcern options
(see below)</entry> </row> </tbody> </tgroup> </informaltable>
<table> <title>writeConcern array values</title> <tgroup cols="2">
<thead> <row> <entry>key</entry> <entry>value</entry>
</row> </thead> <tbody> <row> <entry>fsync</entry>
<entry>boolean, force flushing to disk before returning</entry> </row> <row>
<entry>j</entry> <entry>boolean, force journal write before
returning</entry> </row> <row> <entry>wtimeout</entry>
<entry>integer, milliseconds, maximum time the primary is allowed to wait to verify
replication</entry> </row> <row> <entry>w</entry>
<entry>integer=server count, or string=replication-tag</entry> </row>
</tbody> </tgroup> </table> </para> </listitem>
</varlistentry>'>