mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
added w & wtimeout doc
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@299357 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Kristina Chodorow
parent
1b93e89734
commit
84c6f6bcf4
3 changed files with 120 additions and 12 deletions
|
|
@ -50,6 +50,16 @@
|
|||
<varname>db</varname>
|
||||
<initializer>&null;</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<type>integer</type>
|
||||
<varname>w</varname>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<type>integer</type>
|
||||
<varname>wtimeout</varname>
|
||||
</fieldsynopsis>
|
||||
|
||||
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
||||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongocollection')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
|
||||
|
|
@ -58,6 +68,42 @@
|
|||
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Fields</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>db</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The "parent" database for this collection.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>w</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The number of servers to replicate a change to before returning success.
|
||||
Value is inherited from the parent database. The
|
||||
<classname>MongoDB</classname> class has a more detailed description of
|
||||
how <literal>w</literal> works.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>wtimeout</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The number of milliseconds to wait for <literal>$this->w</literal>
|
||||
replications to take place. Value is inherited from the parent database.
|
||||
The <classname>MongoDB</classname> class has a more detailed description
|
||||
of how <literal>wtimeout</literal> works.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
|
|
|
|||
|
|
@ -71,6 +71,20 @@ $db = $m->selectDB("example");
|
|||
<initializer>2</initializer>
|
||||
</fieldsynopsis>
|
||||
|
||||
<classsynopsisinfo role="comment">Fields</classsynopsisinfo>
|
||||
<fieldsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<type>integer</type>
|
||||
<varname>w</varname>
|
||||
<initializer>1</initializer>
|
||||
</fieldsynopsis>
|
||||
<fieldsynopsis>
|
||||
<modifier>public</modifier>
|
||||
<type>integer</type>
|
||||
<varname>wtimeout</varname>
|
||||
<initializer>10000</initializer>
|
||||
</fieldsynopsis>
|
||||
|
||||
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
|
||||
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongodb')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
|
||||
</classsynopsis>
|
||||
|
|
@ -115,6 +129,65 @@ $db = $m->selectDB("example");
|
|||
</section>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
<title>Fields</title>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>w</term>
|
||||
<term>1</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The number of servers to replicate a change to before returning success.
|
||||
Inherited by instances of <classname>MongoCollection</classname> derived
|
||||
from this. <literal>w</literal> functionality is only available in
|
||||
version 1.5.1+ of the MongoDB server and 1.0.8+ of the driver.
|
||||
</para>
|
||||
<para>
|
||||
<literal>w</literal> is used whenever you perform a "safe" operation
|
||||
(<function>MongoCollection::insert</function>,
|
||||
<function>MongoCollection::update</function>,
|
||||
<function>MongoCollection::remove</function>,
|
||||
<function>MongoCollection::save</function>, and
|
||||
<function>MongoCollection::ensureIndex</function> all support safe
|
||||
options). With the default value (1), a safe operation will return once
|
||||
the database server has the operation. If the server goes down before
|
||||
the operation has been replicated to a slave, it is possible to lose the
|
||||
operation forever. Thus, you can specify <literal>w</literal> to be
|
||||
higher than one and guarantee that at least one slave has the operation
|
||||
before it is considered successful.
|
||||
</para>
|
||||
<para>
|
||||
For example, if <literal>w</literal> is 2, the main server and one slave
|
||||
must have a record of the operation or the driver will throw a
|
||||
<classname>MongoCursorException</classname>. It is tempting to set
|
||||
<literal>w</literal> to the total number of slaves + master, but then if
|
||||
one slave is down the op will fail and an exception will be thrown, so
|
||||
usually <literal>w=2</literal> is safest (master+1 slave).
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>wtimeout</term>
|
||||
<term>10000</term>
|
||||
<listitem>
|
||||
<para>
|
||||
The number of milliseconds to wait for <literal>MongoDB::$w</literal>
|
||||
replications to take place. Inherited by instances of
|
||||
<classname>MongoCollection</classname> derived from this.
|
||||
<literal>w</literal> functionality is only available in version 1.5.1+ of
|
||||
the MongoDB server and 1.0.8+ of the driver.
|
||||
</para>
|
||||
<para>
|
||||
Unless <literal>wtimeout</literal> is set, the server waits forever for
|
||||
replicating to <literal>w</literal> servers to finish. The driver
|
||||
defaults to waiting for 10 seconds, you can change this value to alter
|
||||
its behavior.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</section>
|
||||
|
||||
<section>
|
||||
&reftitle.seealso;
|
||||
<para>
|
||||
|
|
|
|||
|
|
@ -12,7 +12,6 @@
|
|||
<methodsynopsis>
|
||||
<modifier>public</modifier> <type>boolean</type><methodname>MongoGridFS::remove</methodname>
|
||||
<methodparam choice="opt"><type>array</type><parameter>criteria</parameter><initializer>array()</initializer></methodparam>
|
||||
<methodparam choice="opt"><type>boolean</type><parameter>just_one</parameter><initializer>&false;</initializer></methodparam>
|
||||
</methodsynopsis>
|
||||
</refsect1>
|
||||
|
||||
|
|
@ -30,16 +29,6 @@
|
|||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
<varlistentry>
|
||||
<term>
|
||||
<parameter>just_one</parameter>
|
||||
</term>
|
||||
<listitem>
|
||||
<para>
|
||||
If only one matching file should be removed.
|
||||
</para>
|
||||
</listitem>
|
||||
</varlistentry>
|
||||
</variablelist>
|
||||
</para>
|
||||
</refsect1>
|
||||
|
|
@ -47,7 +36,7 @@
|
|||
<refsect1 role="returnvalues">
|
||||
&reftitle.returnvalues;
|
||||
<para>
|
||||
Returns if the removal was successful.
|
||||
Returns if the removal was successfully sent to the database.
|
||||
</para>
|
||||
</refsect1>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue