[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] =?utf-8?q?svn:_/phpdoc/en/trunk/reference/mongo/_mongocollection/remove.xml_mongocollectio
From: Jeremy_Mikola <jmikola () php ! net>
Date: 2014-11-07 19:51:28
Message-ID: svn-jmikola-1415389888-335169-2141344418 () svn ! php ! net
[Download RAW message or body]
jmikola Fri, 07 Nov 2014 19:51:28 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=335169
Log:
Revise MongoWriteBatch::add() parameter docs
Rewrote argument descriptions and cross-referenced relevant update() and remove() \
parameters/options. Also clarified valid "limit" values for delete operations.
https://jira.mongodb.org/browse/PHP-1126
Changed paths:
U phpdoc/en/trunk/reference/mongo/mongocollection/remove.xml
U phpdoc/en/trunk/reference/mongo/mongocollection/update.xml
U phpdoc/en/trunk/reference/mongo/mongowritebatch/add.xml
Modified: phpdoc/en/trunk/reference/mongo/mongocollection/remove.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocollection/remove.xml 2014-11-07 19:47:27 \
UTC (rev 335168)
+++ phpdoc/en/trunk/reference/mongo/mongocollection/remove.xml 2014-11-07 19:51:28 \
UTC (rev 335169) @@ -20,7 +20,7 @@
&reftitle.parameters;
<para>
<variablelist>
- <varlistentry xml:id="mongocollection.delete.criteria">
+ <varlistentry xml:id="mongocollection.remove.criteria">
<term>
<parameter>criteria</parameter>
</term>
@@ -40,7 +40,7 @@
include:
<itemizedlist>
&mongo.writes.parameters.writeconcern;
- <listitem>
+ <listitem xml:id="mongocollection.remove.justone">
<para>
<literal>"justOne"</literal>
</para>
Modified: phpdoc/en/trunk/reference/mongo/mongocollection/update.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocollection/update.xml 2014-11-07 19:47:27 \
UTC (rev 335168)
+++ phpdoc/en/trunk/reference/mongo/mongocollection/update.xml 2014-11-07 19:51:28 \
UTC (rev 335169) @@ -31,7 +31,7 @@
</para>
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry xml:id="mongocollection.update.new_object">
<term>
<parameter>new_object</parameter>
</term>
@@ -52,7 +52,7 @@
An array of options for the update operation. Currently available options
include:
<itemizedlist>
- <listitem>
+ <listitem xml:id="mongocollection.update.upsert">
<para>
<literal>"upsert"</literal>
</para>
@@ -70,7 +70,7 @@
document. See the upsert examples below for more information.
</para>
</listitem>
- <listitem>
+ <listitem xml:id="mongocollection.update.multiple">
<para>
<literal>"multiple"</literal>
</para>
Modified: phpdoc/en/trunk/reference/mongo/mongowritebatch/add.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongowritebatch/add.xml 2014-11-07 19:47:27 UTC \
(rev 335168)
+++ phpdoc/en/trunk/reference/mongo/mongowritebatch/add.xml 2014-11-07 19:51:28 UTC \
(rev 335169) @@ -4,7 +4,7 @@
<refentry xml:id="mongowritebatch.add" xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink"> <refnamediv>
<refname>MongoWriteBatch::add</refname>
- <refpurpose>Adds an CRUD operation to a batch</refpurpose>
+ <refpurpose>Adds a write operation to a batch</refpurpose>
</refnamediv>
<refsect1 role="description">
@@ -14,14 +14,15 @@
<methodparam><type>array</type><parameter>item</parameter></methodparam>
</methodsynopsis>
<para>
- The operation to add to the batch.
+ Adds a write operation to the batch.
</para>
<para>
- If <parameter>$item</parameter> causes the batch to hit the <link \
xlink:href="url.mongodb.dochub.maxWriteBatchSize">maxWriteBatchSize</link>
- or <link xlink:href="url.mongodb.dochub.maxBsonObjectSize">maxBsonObjectSize</link> \
limits, a new batch will be created internally and
- the batches batched up and sent one at a time upon calling \
<methodname>MongoWriteBatch::execute</methodname>. + If \
<parameter>$item</parameter> causes the batch to exceed the + <link \
xlink:href="url.mongodb.dochub.maxWriteBatchSize">maxWriteBatchSize</link> + or \
<link xlink:href="url.mongodb.dochub.maxBsonObjectSize">maxBsonObjectSize</link> + \
limits, the driver will internally split the batches into multiple write + commands \
upon calling <methodname>MongoWriteBatch::execute</methodname>. </para>
-
</refsect1>
<refsect1 role="parameters">
@@ -31,30 +32,36 @@
<term><parameter>item</parameter></term>
<listitem>
<para>
+ An array that describes a write operation. The structure of this value
+ depends on the batch's operation type.
<informaltable>
<thead>
<row>
- <entry>When current batch is</entry>
+ <entry>Batch type</entry>
<entry>Argument expectation</entry>
</row>
</thead>
<tbody>
<row>
- <entry>MongoWriteBatch::COMMAND_INSERT</entry>
- <entry>The document to add</entry>
+ <entry><constant>MongoWriteBatch::COMMAND_INSERT</constant></entry>
+ <entry>
+ <simpara>The document to add.</simpara>
+ </entry>
</row>
<row>
- <entry>MongoWriteBatch::COMMAND_UPDATE</entry>
+ <entry><constant>MongoWriteBatch::COMMAND_UPDATE</constant></entry>
<entry>
- <para>Raw update operation. Required keys are: array("q" => <link \
linkend="mongocollection.update.criteria">array("criteria")</link>, "u" => array("new \
data"))</para>
- <para>Optionally with the "multi" and "upsert" keys as boolean \
values</para>
- <para>"upsert": If set to true, creates a new document when no document \
matches the query criteria. The default value is false, which does not insert a new \
document when no match is found.</para> + <para>Raw update operation.</para>
+ <para>Required keys are <literal>"q"</literal> and <literal>"u"</literal>, \
which correspond to the <link \
linkend="mongocollection.update.criteria"><parameter>$criteria</parameter></link> and \
<link linkend="mongocollection.update.new_object"><parameter>$new_object</parameter></link> \
parameters of <function>MongoCollection::update</function>, respectively.</para> + \
<para>Optional keys are <literal>"multi"</literal> and <literal>"upsert"</literal>, \
which correspond to the <link \
linkend="mongocollection.update.multiple"><literal>"multiple"</literal></link> and \
<link linkend="mongocollection.update.upsert"><literal>"upsert"</literal></link> \
options for <function>MongoCollection::update</function>, respectively. If \
unspecified, both options default to &false;.</para> </entry>
</row>
<row>
- <entry>MongoWriteBatch::COMMAND_DELETE</entry>
+ <entry><constant>MongoWriteBatch::COMMAND_DELETE</constant></entry>
<entry>
- <simpara>Raw delete operation. Required keys are: array("q" => <link \
linkend="mongocollection.delete.criteria">array("criteria")</link>, "limit" => \
1)</simpara> + <para>Raw delete operation.</para>
+ <para>Required keys are: <literal>"q"</literal> and \
<literal>"limit"</literal>, which correspond to the <link \
linkend="mongocollection.remove.criteria"><parameter>$criteria</parameter></link> \
parameter and <link linkend="mongocollection.remove.justone"><literal>"justOne"</literal></link> \
option of <function>MongoCollection::remove</function>, respectively.</para> + \
<para>The <literal>"limit"</literal> option is an <type>integer</type>; however, \
MongoDB only supports <literal>0</literal> (i.e. remove all matching documents) and \
<literal>1</literal> (i.e. remove at most one matching document) at this time.</para> \
</entry> </row>
</tbody>
@@ -68,7 +75,7 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns &true; on success, throws exception on failure.
+ Returns &true; on success and throws an exception on failure.
</para>
</refsect1>
--
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic