sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-16 00:48:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Fixed PHP-789: Document fsync, j, and wtimeout options for MongoCollection write operations.

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@330300 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Derick Rethans 2013-05-20 17:16:05 +00:00
parent 1e5c571e6a
commit e354213395
6 changed files with 76 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
language-snippets.ent
View file

@ -1715,9 +1715,12 @@ paths</simpara></warning>
<!ENTITY mongo.setreadpreference.errors '<para xmlns="http://docbook.org/ns/docbook">Emits <constant>E_WARNING</constant> if either parameter is invalid, or if one or more tag sets are provided with the <constant>MongoClient::RP_PRIMARY</constant> read preference mode.</para>'>
<!ENTITY mongo.getreadpreference.returnvalues '<para xmlns="http://docbook.org/ns/docbook">This function returns an array describing the read preference. The array contains the values <literal>type</literal> for the string read preference mode (corresponding to the <classname>MongoClient</classname> constants), and <literal>tagsets</literal> containing a list of all tag set criteria. If no tag sets were specified, <literal>tagsets</literal> will not be present in the array.</para>'>
<!ENTITY mongo.writes.parameters.writeconcern '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"w"</literal></para><para>See <link linkend="mongo.writeconcerns">WriteConcerns</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>How long to wait for <link linkend="mongo.writeconcerns">WriteConcern</link> acknowledgement. The default value for <classname>MongoClient</classname> is <literal>10000</literal> milliseconds.</para></listitem>'>
<!ENTITY mongo.writes.parameters.fsync '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"fsync"</literal></para><para>Boolean, defaults to &false;. Forces the insert to be synced to disk before returning success. If &true;, an acknowledged insert is implied and will override setting <literal>w</literal> to <literal>0</literal>.</para></listitem>'>
<!ENTITY mongo.writes.parameters.timeout '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"timeout"</literal></para><para>Integer, defaults to <literal>MongoCursor::$timeout</literal>. If "safe" is set, 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.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 insert to be synced to the journal before returning success. If &true;, an acknowledged insert is implied and will override setting <literal>w</literal> to <literal>0</literal>.</para></listitem>'>
<!ENTITY mongo.writes.parameters.safe '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"safe"</literal></para><para><emphasis>Deprecated</emphasis>. Please use the <link linkend="mongo.writeconcerns">WriteConcern</link> <literal>w</literal> option.</para></listitem>'>
<!ENTITY mongo.writes.parameters.timeout '<listitem xmlns="http://docbook.org/ns/docbook"><para><literal>"timeout"</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.errors.exceptions.writeconcern '<para xmlns="http://docbook.org/ns/docbook">Throws <classname>MongoCursorException</classname> if the "w" option is set and the write fails.</para><para xmlns="http://docbook.org/ns/docbook">Throws <classname>MongoCursorTimeoutException</classname> if the "w" option is set to a value greater than one and the operation takes longer than <varname>MongoCursor::$timeout</varname> milliseconds to complete. This does not kill the operation on the server, it is a client-side timeout. The operation in <literal>MongoCollection::$wtimeout</literal> is milliseconds.</para>'>
<!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>'>

20
reference/mongo/mongocollection/batchinsert.xml
View file

@ -47,9 +47,6 @@
<para>
Options for the inserts.
<itemizedlist>
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.fsync;
&mongo.writes.parameters.timeout;
<listitem>
<para>
<literal>"continueOnError"</literal>
@ -75,7 +72,15 @@
</para>
</note>
</listitem>
&mongo.writes.parameters.safe;
&mongo.writes.parameters.fsync;
&mongo.writes.parameters.journal;
<!--
&mongo.writes.parameters.sockettimeoutms;
-->
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.writeconcerntimeout;
&mongo.writes.parameters.safe;
&mongo.writes.parameters.timeout;
</itemizedlist>
</para>
</listitem>
@ -116,6 +121,13 @@
</row>
</thead>
<tbody>
<!--
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"timeout"</literal> option to
<literal>"socketTimeoutMS"</literal>.</entry>
</row>
-->
<row>
<entry>1.2.7</entry>
<entry>Added <literal>"continueOnError"</literal> option.</entry>

16
reference/mongo/mongocollection/insert.xml
View file

@ -52,10 +52,15 @@
<para>
Options for the insert.
<itemizedlist>
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.fsync;
&mongo.writes.parameters.timeout;
&mongo.writes.parameters.journal;
<!--
&mongo.writes.parameters.sockettimeoutms;
-->
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.writeconcerntimeout;
&mongo.writes.parameters.safe;
&mongo.writes.parameters.timeout;
</itemizedlist>
</para>
</listitem>
@ -216,6 +221,13 @@
</row>
</thead>
<tbody>
<!--
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"timeout"</literal> option to
<literal>"socketTimeoutMS"</literal>.</entry>
</row>
-->
<row>
<entry>1.3.0</entry>
<entry>

15
reference/mongo/mongocollection/remove.xml
View file

@ -48,8 +48,14 @@
</para>
</listitem>
&mongo.writes.parameters.fsync;
&mongo.writes.parameters.timeout;
&mongo.writes.parameters.journal;
<!--
&mongo.writes.parameters.sockettimeoutms;
-->
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.writeconcerntimeout;
&mongo.writes.parameters.safe;
&mongo.writes.parameters.timeout;
</itemizedlist>
</para>
</listitem>
@ -87,6 +93,13 @@
</row>
</thead>
<tbody>
<!--
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"timeout"</literal> option to
<literal>"socketTimeoutMS"</literal>.</entry>
</row>
-->
<row>
<entry>1.3.0</entry>
<entry>

16
reference/mongo/mongocollection/save.xml
View file

@ -51,10 +51,15 @@
<para>
Options for the save.
<itemizedlist>
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.fsync;
&mongo.writes.parameters.timeout;
&mongo.writes.parameters.journal;
<!--
&mongo.writes.parameters.sockettimeoutms;
-->
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.writeconcerntimeout;
&mongo.writes.parameters.safe;
&mongo.writes.parameters.timeout;
</itemizedlist>
</para>
</listitem>
@ -94,6 +99,13 @@
</row>
</thead>
<tbody>
<!--
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"timeout"</literal> option to
<literal>"socketTimeoutMS"</literal>.</entry>
</row>
-->
<row>
<entry>1.2.0</entry>
<entry>Added <literal>"timeout"</literal> option.</entry>

15
reference/mongo/mongocollection/update.xml
View file

@ -85,8 +85,14 @@
</para>
</listitem>
&mongo.writes.parameters.fsync;
&mongo.writes.parameters.timeout;
&mongo.writes.parameters.journal;
<!--
&mongo.writes.parameters.sockettimeoutms;
-->
&mongo.writes.parameters.writeconcern;
&mongo.writes.parameters.writeconcerntimeout;
&mongo.writes.parameters.safe;
&mongo.writes.parameters.timeout;
</itemizedlist>
</para>
</listitem>
@ -124,6 +130,13 @@
</row>
</thead>
<tbody>
<!--
<row>
<entry>1.5.0</entry>
<entry>Renamed the <literal>"timeout"</literal> option to
<literal>"socketTimeoutMS"</literal>.</entry>
</row>
-->
<row>
<entry>1.3.0</entry>
<entry>