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

Make the role=errors section consistent for all write methods

Browse source 
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@328545 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hannes Magnusson 2012-11-28 20:33:41 +00:00
parent e7dbde68a1
commit ec6cb30f0e
9 changed files with 9 additions and 67 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
language-snippets.ent
View file

@ -1725,3 +1725,4 @@ on replica set members.</para></listitem></varlistentry></variablelist>
<!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.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.errors.exceptions.writeconcern '<para>Throws <classname>MongoCursorException</classname> if the "w" option is set and the write fails.</para><para>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>'>

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

@ -76,15 +76,7 @@
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>MongoCursorException</classname> if the "w" option is
set and the insert fails.
</para>
<para>
Throws <classname>MongoCursorTimeoutException</classname> if the "w"
option is set to a value greater than one and the database cannot replicate
the operation in <literal>MongoCollection::$wtimeout</literal> milliseconds.
</para>
&mongo.errors.exceptions.writeconcern;
</refsect1>
<refsect1 role="changelog">

11
reference/mongo/mongocollection/ensureindex.xml
View file

@ -215,16 +215,7 @@
Throws <classname>MongoException</classname> if the index name is longer than
128 bytes. (Version 1.0.11+)
</para>
<para>
Throws <classname>MongoCursorException</classname> if the "w" option is
set and the index creation fails.
</para>
<para>
Throws <classname>MongoCursorTimeoutException</classname> if the "w"
option is set 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.
</para>
&mongo.errors.exceptions.writeconcern;
</refsect1>
<refsect1 role="examples">

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

@ -189,16 +189,7 @@
<para>
Throws <classname>MongoException</classname> if the inserted array is empty.
</para>
<para>
Throws <classname>MongoCursorException</classname> if the
<literal>"w"</literal> option is set and the operation fails.
</para>
<para>
Throws <classname>MongoCursorTimeoutException</classname> if the
<literal>"w"</literal> option is set 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.
</para>
&mongo.errors.exceptions.writeconcern;
</refsect1>
<refsect1 role="changelog">

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

@ -72,16 +72,7 @@
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>MongoCursorException</classname> if the
<literal>"w"</literal> option is set and the operation fails.
</para>
<para>
Throws <classname>MongoCursorTimeoutException</classname> if the
<literal>"w"</literal> option is set 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.
</para>
&mongo.errors.exceptions.writeconcern;
</refsect1>
<refsect1 role="changelog">

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

@ -65,16 +65,7 @@
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>MongoCursorException</classname> if the "w" option is
set and the save fails.
</para>
<para>
Throws <classname>MongoCursorTimeoutException</classname> if the "w"
option is set 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.
</para>
&mongo.errors.exceptions.writeconcern;
</refsect1>
<refsect1 role="changelog">

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

@ -109,16 +109,7 @@
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>MongoCursorException</classname> if the
<literal>"w"</literal> option is set and the operation fails.
</para>
<para>
Throws <classname>MongoCursorTimeoutException</classname> if the
<literal>"w"</literal> option is set 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.
</para>
&mongo.errors.exceptions.writeconcern;
</refsect1>
<refsect1 role="changelog">

5
reference/mongo/mongogridfs/storebytes.xml
View file

@ -67,10 +67,7 @@
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>MongoCursorException</classname> if the "w" option is
set and the insert fails.
</para>
&mongo.errors.exceptions.writeconcern;
</refsect1>
</refentry>

5
reference/mongo/mongogridfs/storefile.xml
View file

@ -67,10 +67,7 @@
<refsect1 role="errors">
&reftitle.errors;
<para>
Throws <classname>MongoCursorException</classname> if the "w" option is
set and the insert fails.
</para>
&mongo.errors.exceptions.writeconcern;
</refsect1>
</refentry>