svn: /phpdoc/en/trunk/ language-snippets.ent
| From: | Derick Rethans | Date: | Mon, 10 Mar 2014 16:30:15 +0000 |
| Subject: | svn: /phpdoc/en/trunk/ language-snippets.ent | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-12189@lists.php.net to get a copy of this message | ||
derick Mon, 10 Mar 2014 16:30:15 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=332948
Log:
- Added missing snippets.
Changed paths:
U phpdoc/en/trunk/language-snippets.ent
Modified: phpdoc/en/trunk/language-snippets.ent
===================================================================
--- phpdoc/en/trunk/language-snippets.ent 2014-03-10 15:03:19 UTC (rev 332947)
+++ phpdoc/en/trunk/language-snippets.ent 2014-03-10 16:30:15 UTC (rev 332948)
@@ -1732,12 +1732,13 @@
<!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.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><warning><para>Deprecated
in favour of the <literal>"wTimeoutMS"</literal>
option</para></warning></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">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;. If journalling is enabled, it works exactly like
<literal>"j"</literal>. If journalling is not enabled, it 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><note><para>This option is
<emphasis>deprecated</emphasis>. Please use the
<literal>"j"</literal> option
instead.</para></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.sockettimeoutms '<listitem xmlns="http://docbook.org/ns/docbook"><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><para><literal>"socketTimeoutMS"</literal></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.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><warning><para>Deprecated in favour of the
<literal>"socketTimeoutMS"</literal>
option</para></warning></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>'>