svn: /phpdoc/en/trunk/ language-snippets.ent reference/mongo/mongoclient/construct.xml
| From: | Jeremy Mikola | Date: | Fri, 25 Jul 2014 19:18:16 +0000 |
| Subject: | svn: /phpdoc/en/trunk/ language-snippets.ent reference/mongo/mongoclient/construct.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-12644@lists.php.net to get a copy of this message | ||
jmikola Fri, 25 Jul 2014 19:18:16 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=334385
Log:
Clarify wTimeoutMS option for MongoClient and write params
https://jira.mongodb.org/browse/PHP-791
Changed paths:
U phpdoc/en/trunk/language-snippets.ent
U phpdoc/en/trunk/reference/mongo/mongoclient/construct.xml
Modified: phpdoc/en/trunk/language-snippets.ent
===================================================================
--- phpdoc/en/trunk/language-snippets.ent 2014-07-25 17:06:40 UTC (rev 334384)
+++ phpdoc/en/trunk/language-snippets.ent 2014-07-25 19:18:16 UTC (rev 334385)
@@ -1747,7 +1747,7 @@
<!ENTITY mongo.index.parameters.unique '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"unique"</literal></para><para>Specify
&true; to create a unique index. The default value is &false;. This option applies only to
ascending/descending indexes.</para><note xmlns="http://docbook.org/ns/docbook"><para>When
MongoDB indexes a field, if a document does not have a value for the field, a &null; value is
indexed. If multiple documents do not contain a field, a unique index will reject all but the first
of those documents. The <literal>"sparse"</literal> option may be used to
overcome this, since it will prevent documents without the field from being
indexed.</para></note></listitem>'>
<!ENTITY mongo.writes.parameters.writeconcern '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"w"</literal></para><para>See
<link linkend="mongo.writeconcerns">Write Concerns</link>. The default value
for <classname>MongoClient</classname> is
<literal>1</literal>.</para></listitem>'>
<!ENTITY mongo.writes.parameters.writeconcerntimeout '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"wtimeout"</literal></para><para>Deprecated
alias for
<literal>"wTimeoutMS"</literal>.</para></listitem>'>
-<!ENTITY mongo.writes.parameters.writeconcerntimeoutms '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"wTimeoutMS"</literal></para><para>How
long to wait for <link linkend="mongo.writeconcerns">write concern</link>
acknowledgement. The default value for <classname>MongoClient</classname> is
<literal>10000</literal> milliseconds.</para></listitem>'>
+<!ENTITY mongo.writes.parameters.writeconcerntimeoutms '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"wTimeoutMS"</literal></para><para>This
option specifies the time limit, in milliseconds, for <link
linkend="mongo.writeconcerns">write concern</link> acknowledgement. It is only
applicable when <literal>"w"</literal> is greater than
<literal>1</literal>, as the timeout pertains to replication. If the write concern is
not satisfied within the time limit, a <classname>MongoCursorException</classname> will
be thrown. A value of <literal>0</literal> may be specified to block indefinitely. The
default value for <classname>MongoClient</classname> is
<literal>10000</literal> (ten seconds).</para></listitem>'>
<!ENTITY mongo.writes.parameters.fsync '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"fsync"</literal></para><para>Boolean,
defaults to &false;. If journaling is enabled, it works exactly like
<literal>"j"</literal>. If journaling is not enabled, the write operation
blocks until it is synced to database files on disk. If &true;, an acknowledged insert is
implied and this option will override setting <literal>"w"</literal> to
<literal>0</literal>.</para><note><simpara>If journaling is enabled,
users are strongly encouraged to use the <literal>"j"</literal> option instead
of <literal>"fsync"</literal>. Do not use
<literal>"fsync"</literal> and <literal>"j"</literal>
simultaneously, as that will result in an
error.</simpara></note></listitem>'>
<!ENTITY mongo.writes.parameters.sockettimeoutms '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"socketTimeoutMS"</literal></para><para>Integer,
defaults to <literal>MongoCursor::$timeout</literal>. If acknowledged writes are used,
this sets how long (in milliseconds) for the client to wait for a database response. If the database
does not respond within the timeout period, a
<classname>MongoCursorTimeoutException</classname> will be
thrown.</para></listitem>'>
<!ENTITY mongo.writes.parameters.journal '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"j"</literal></para><para>Boolean,
defaults to &false;. Forces the write operation to block until it is synced to the journal on
disk. If &true;, an acknowledged write is implied and this option will override setting
<literal>"w"</literal> to
<literal>0</literal>.</para><note><simpara>If this option is used and
journaling is disabled, MongoDB 2.6+ will raise an error and the write will fail; older server
versions will simply ignore the option.</simpara></note></listitem>'>
Modified: phpdoc/en/trunk/reference/mongo/mongoclient/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongoclient/construct.xml 2014-07-25 17:06:40 UTC (rev 334384)
+++ phpdoc/en/trunk/reference/mongo/mongoclient/construct.xml 2014-07-25 19:18:16 UTC (rev 334385)
@@ -361,11 +361,15 @@
<literal>"wTimeoutMS"</literal>
</para>
<para>
- This option is used in combination with the <literal>"w"</literal>
- option. It controls how many milliseconds the server waits for the
- write concern to be satisfied. If it takes longer then the server
- signals to the driver that it took too long and the driver will throw
- a <classname>MongoCursorException</classname> exception.
+ This option specifies the time limit, in milliseconds, for
+ <link linkend="mongo.writeconcerns">write concern</link>
+ acknowledgement. It is only applicable for write operations where
+ <literal>"w"</literal> is greater than
<literal>1</literal>, as the
+ timeout pertains to replication. If the write concern is not satisfied
+ within the time limit, a <classname>MongoCursorException</classname>
+ will be thrown. A value of <literal>0</literal> may be specified to
+ block indefinitely. The default value is <literal>10000</literal>
+ (ten seconds).
</para>
</listitem>
</itemizedlist>