[prev in list] [next in list] [prev in thread] [next in thread]
List: php-doc-cvs
Subject: [DOC-CVS] =?utf-8?q?svn:_/phpdoc/_doc-base/trunk/entities/global.ent_en/trunk/language-snippets.ent_
From: Jeremy_Mikola <jmikola () php ! net>
Date: 2015-11-11 21:17:47
Message-ID: svn-jmikola-1447276667-338112-1940283192 () svn ! php ! net
[Download RAW message or body]
jmikola Wed, 11 Nov 2015 21:17:47 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=338112
Log:
Update MongoDB\Driver\Manager and Server docs
Changed paths:
U phpdoc/doc-base/trunk/entities/global.ent
U phpdoc/en/trunk/language-snippets.ent
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/construct.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/executecommand.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/executequery.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/getservers.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/selectserver.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/construct.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/executebulkwrite.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/executecommand.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/executequery.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/gethost.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getinfo.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getlatency.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getport.xml
D phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getstate.xml
A phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/gettags.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/gettype.xml
A phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/isarbiter.xml
D phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/isdelayed.xml
A phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/ishidden.xml
U phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/ispassive.xml
A phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/isprimary.xml
A phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/issecondary.xml
U phpdoc/en/trunk/reference/mongodb/versions.xml
["svn-diffs-338112.txt" (text/x-diff)]
Modified: phpdoc/doc-base/trunk/entities/global.ent
===================================================================
--- phpdoc/doc-base/trunk/entities/global.ent 2015-11-11 18:51:47 UTC (rev 338111)
+++ phpdoc/doc-base/trunk/entities/global.ent 2015-11-11 21:17:47 UTC (rev 338112)
@@ -305,7 +305,10 @@
<!ENTITY url.mongodb.library "http://github.com/mongodb/mongo-php-library">
<!ENTITY url.mongodb.library.apidocs \
"http://mongodb.github.io/mongo-php-library/api"> <!ENTITY url.mongodb.libmongoc \
"http://github.com/mongodb/mongo-c-driver"> +<!ENTITY url.mongodb.glossary \
"https://docs.mongodb.org/manual/reference/glossary/"> <!ENTITY url.mongodb.crud \
"https://github.com/mongodb/specifications/blob/master/source/crud/crud.rst"> \
+<!ENTITY url.mongodb.serverselection \
"https://github.com/mongodb/specifications/blob/master/source/server-selection/server-selection.rst">
+<!ENTITY url.mongodb.sdam \
"https://github.com/mongodb/specifications/blob/master/source/server-discovery-and-monitoring/server-discovery-and-monitoring.rst">
<!ENTITY url.mongodb.docs.bson \
"https://docs.mongodb.org/manual/reference/bson-types/"> <!ENTITY \
url.mongodb.docs.extendedjson \
"https://docs.mongodb.org/manual/reference/mongodb-extended-json/"> <!ENTITY \
url.mongodb.docs.connecttimeoutms \
"https://docs.mongodb.org/manual/reference/connection-string/#uri.connectTimeoutMS">
Modified: phpdoc/en/trunk/language-snippets.ent
===================================================================
--- phpdoc/en/trunk/language-snippets.ent 2015-11-11 18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/language-snippets.ent 2015-11-11 21:17:47 UTC (rev 338112)
@@ -1890,20 +1890,60 @@
<!-- mongodb -->
<!ENTITY mongodb.parameter.namespace '
<varlistentry xmlns="http://docbook.org/ns/docbook">
- <term><parameter>namespace</parameter></term>
+ <term><parameter>namespace</parameter> (<type>string</type>)</term>
<listitem>
<para>
- A fully qualified namespace (databaseName.collectionName)
+ A fully qualified namespace (e.g. \
<literal>"databaseName.collectionName"</literal>). </para>
</listitem>
</varlistentry>
'>
+<!ENTITY mongodb.parameter.db '
+ <varlistentry xmlns="http://docbook.org/ns/docbook">
+ <term><parameter>db</parameter> (<type>string</type>)</term>
+ <listitem>
+ <para>
+ The name of the database on which to execute the command.
+ </para>
+ </listitem>
+ </varlistentry>
+'>
+<!ENTITY mongodb.parameter.bulkwrite '
+ <varlistentry xmlns="http://docbook.org/ns/docbook">
+ <term><parameter>bulk</parameter> (<type>MongoDB\Driver\BulkWrite</type>)</term>
+ <listitem>
+ <para>
+ The <classname>MongoDB\Driver\BulkWrite</classname> to execute.
+ </para>
+ </listitem>
+ </varlistentry>
+'>
+<!ENTITY mongodb.parameter.command '
+ <varlistentry xmlns="http://docbook.org/ns/docbook">
+ <term><parameter>command</parameter> \
(<type>MongoDB\Driver\Command</type>)</term> + <listitem>
+ <para>
+ The <classname>MongoDB\Driver\Command</classname> to execute.
+ </para>
+ </listitem>
+ </varlistentry>
+'>
+<!ENTITY mongodb.parameter.query '
+ <varlistentry xmlns="http://docbook.org/ns/docbook">
+ <term><parameter>query</parameter> (<type>MongoDB\Driver\Query</type>)</term>
+ <listitem>
+ <para>
+ The <classname>MongoDB\Driver\Query</classname> to execute.
+ </para>
+ </listitem>
+ </varlistentry>
+'>
<!ENTITY mongodb.parameter.readPreference '
<varlistentry xmlns="http://docbook.org/ns/docbook">
- <term><parameter>readPreference</parameter></term>
+ <term><parameter>readPreference</parameter> \
(<type>MongoDB\Driver\ReadPreference</type>)</term> <listitem>
<para>
- Optionally, a <classname>MongoDB\Driver\ReadPreference</classname> to route \
the command to. If none given, defaults to the Read Preferences set by the <link \
linkend="mongodb-driver-manager.construct-uri">MongoDB Connection URI</link>. + \
Optionally, a <classname>MongoDB\Driver\ReadPreference</classname> to select the \
server for this operation. If none is given, the read preference from the <link \
linkend="mongodb-driver-manager.construct-uri">MongoDB Connection URI</link> will be \
used. </para>
</listitem>
</varlistentry>
@@ -1920,10 +1960,10 @@
'>
<!ENTITY mongodb.parameter.writeConcern '
<varlistentry xmlns="http://docbook.org/ns/docbook">
- <term><parameter>writeConcern</parameter></term>
+ <term><parameter>writeConcern</parameter> \
(<type>MongoDB\Driver\WriteConcern</type>)</term> <listitem>
<para>
-Optionally, a <classname>MongoDB\Driver\WriteConcern</classname>. If none given, \
default to the Write Concern set by the <link \
linkend="mongodb-driver-manager.construct-uri">MongoDB Connection URI</link>. + \
Optionally, a <classname>MongoDB\Driver\WriteConcern</classname> to apply to the \
write operation. If none is given, the write concern from the <link \
linkend="mongodb-driver-manager.construct-uri">MongoDB Connection URI</link> will be \
used. </para>
</listitem>
</varlistentry>
@@ -1938,21 +1978,13 @@
</listitem>
</varlistentry>
'>
-<!ENTITY mongodb.returns.WriteResult '
- <para xmlns="http://docbook.org/ns/docbook">
- Returns <classname>MongoDB\Driver\WriteResult</classname> on success, \
&mongodb.throws.onfailure;.
- </para>
-'>
-<!ENTITY mongodb.throws.onfailure 'throws exception (instanceof <classname \
xmlns="http://docbook.org/ns/docbook" >MongoDB\Driver\Exception</classname>) on \
failure'>
-<!ENTITY mongodb.throws.std \
'&mongodb.throws.authentication;&mongodb.throws.connection;'>
-<!ENTITY mongodb.throws.executesingle \
'&mongodb.throws.duplicatekey;&mongodb.throws.writeexception;&mongodb.throws.writeconcernexception;'>
-<!ENTITY mongodb.throws.bulkwriteexception '<member \
xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoDB\Driver\BulkWriteException</classname> on any write failure \
(WriteError and WriteConcern failures)</member>'>
-<!ENTITY mongodb.throws.argumentparsing '<member \
xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoDB\Driver\InvalidArgumentException</classname> on argument parsing \
errors.</member>'>
-<!ENTITY mongodb.throws.duplicatekey '<member \
xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoDB\Driver\DuplicateKeyException</classname> if a write causes \
Duplicate Key error</member>'>
-<!ENTITY mongodb.throws.writeexception '<member \
xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoDB\Driver\WriteException</classname> on Write \
Error</member>'>
-<!ENTITY mongodb.throws.writeconcernexception '<member \
xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoDB\Driver\WriteConcernException</classname> on Write Concern \
failure</member>'>
-<!ENTITY mongodb.throws.authentication '<member \
xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoDB\Driver\AuthenticationException</classname> if authentication is \
needed and fails</member>'>
-<!ENTITY mongodb.throws.connection '<member \
xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoDB\Driver\ConnectionException</classname> if connection to the server \
fails for other then authentication reasons</member>'> +<!ENTITY \
mongodb.returns.cursor '<para xmlns="http://docbook.org/ns/docbook">Returns \
<classname>MongoDB\Driver\Cursor</classname> on success.</para>'> +<!ENTITY \
mongodb.returns.writeresult '<para xmlns="http://docbook.org/ns/docbook">Returns \
<classname>MongoDB\Driver\WriteResult</classname> on success.</para>'> +<!ENTITY \
mongodb.throws.std '&mongodb.throws.argumentparsing;&mongodb.throws.connection;&mongodb.throws.authentication;'>
+<!ENTITY mongodb.throws.bulkwriteexception '<member \
xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoDB\Driver\Exception\BulkWriteException</classname> on any write \
failure (e.g. write error, failure to apply a write concern)</member>'> +<!ENTITY \
mongodb.throws.argumentparsing '<member xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoDB\Driver\Exception\InvalidArgumentException</classname> on argument \
parsing errors.</member>'> +<!ENTITY mongodb.throws.authentication '<member \
xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoDB\Driver\Exception\AuthenticationException</classname> if \
authentication is needed and fails.</member>'> +<!ENTITY mongodb.throws.connection \
'<member xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoDB\Driver\Exception\ConnectionException</classname> if connection to \
the server fails (for reasons other than authentication).</member>'> <!ENTITY \
mongodb.note.getwriteerrors ' <note xmlns="http://docbook.org/ns/docbook">
<para>
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/construct.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/construct.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -56,7 +56,8 @@
<term><parameter>driverOptions</parameter></term>
<listitem>
<para>
- Any driver-specific options not included in MongoDB connection spec.
+ Any driver-specific options not included in MongoDB connection string
+ specification.
</para>
</listitem>
</varlistentry>
@@ -66,8 +67,8 @@
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
- <member>Throws <classname>InvalidArgumentException</classname> on argument \
parsing errors.</member>
- <member>Throws <classname>MongoDB\Driver\RuntimeException</classname> if the \
<parameter>uri</parameter> format is invalid</member> + \
&mongodb.throws.argumentparsing; + <member>Throws \
<classname>MongoDB\Driver\Exception\RuntimeException</classname> if the \
<parameter>uri</parameter> format is invalid</member> </simplelist>
</refsect1>
@@ -75,7 +76,7 @@
&reftitle.examples;
<example>
<title><function>MongoDB\Driver\Manager::__construct</function> basic \
examples</title>
- <para>Connecting to standalone MongoDB node</para>
+ <para>Connecting to standalone MongoDB node:</para>
<programlisting role="php">
<![CDATA[
<?php
@@ -85,7 +86,7 @@
?>
]]>
</programlisting>
- <para>Connecting to a replica set</para>
+ <para>Connecting to a replica set:</para>
<programlisting role="php">
<![CDATA[
<?php
@@ -95,7 +96,7 @@
?>
]]>
</programlisting>
- <para>Connecting to a sharded cluster (i.e. one or more mongos instances)</para>
+ <para>Connecting to a sharded cluster (i.e. one or more mongos instances):</para>
<programlisting role="php">
<![CDATA[
<?php
@@ -105,7 +106,7 @@
?>
]]>
</programlisting>
- <para>Connecting to MongoDB with authentication credentials for a particular user \
and database.</para> + <para>Connecting to MongoDB with authentication credentials \
for a particular user and database:</para> <programlisting role="php">
<![CDATA[
<?php
@@ -121,8 +122,7 @@
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
- <member><methodname>MongoDB\Driver\Server::__construct</methodname></member>
- <member><link xlink:href="&url.mongodb.docs;reference/connection-string/">Connection \
string URI format</link></member> + <member><link \
xlink:href="&url.mongodb.docs;reference/connection-string/">MongoDB Connection String \
Format</link></member> </simplelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/executebulkwrite.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -16,7 +16,7 @@
<methodparam choice="opt"><type>MongoDB\Driver\WriteConcern</type><parameter>writeConcern</parameter></methodparam>
</methodsynopsis>
<para>
- Executes one or more write operations.
+ Executes one or more write operations on the primary server.
</para>
<para>
A <classname>MongoDB\Driver\BulkWrite</classname> can be constructed with
@@ -30,29 +30,22 @@
&reftitle.parameters;
<variablelist>
&mongodb.parameter.namespace;
- <varlistentry>
- <term><parameter>bulk</parameter></term>
- <listitem>
- <para>
- The <classname>MongoDB\Driver\BulkWrite</classname> to execute.
- </para>
- </listitem>
- </varlistentry>
+ &mongodb.parameter.bulkwrite;
&mongodb.parameter.writeConcern;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- &mongodb.returns.WriteResult;
+ &mongodb.returns.writeresult;
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
- &mongodb.throws.std;
&mongodb.throws.bulkwriteexception;
- <member>Throws <classname>MongoDB\Driver\RuntimeException</classname> on other \
errors.</member> + &mongodb.throws.std;
+ <member>Throws <classname>MongoDB\Driver\Exception\RuntimeException</classname> \
on other errors.</member> </simplelist>
</refsect1>
@@ -63,23 +56,23 @@
<programlisting role="php">
<![CDATA[
<?php
+
$bulk = new MongoDB\Driver\BulkWrite();
-$bulk->insert(array("_id" => 1, "x" => 1));
-$bulk->insert(array("_id" => 2, "x" => 2));
+$bulk->insert(['_id' => 1, 'x' => 1]);
+$bulk->insert(['_id' => 2, 'x' => 2]);
-$bulk->update(array( "x" => 2), array('$set' => array("x" => 1)), array("multi" => \
false, "upsert" => false));
-$bulk->update(array( "x" => 3), array('$set' => array("x" => 3)), array("multi" => \
false, "upsert" => true));
-$bulk->update(array("_id" => 3), array('$set' => array("x" => 3)), array("multi" => \
false, "upsert" => true)); +$bulk->update(['x' => 2], ['$set' => ['x' => 1]], \
['multi' => false, 'upsert' => false]); +$bulk->update(['x' => 3], ['$set' => ['x' => \
3]], ['multi' => false, 'upsert' => true]); +$bulk->update(['_id' => 3], ['$set' => \
['x' => 3]], ['multi' => false, 'upsert' => true]);
-$bulk->insert(array("_id" => 4, "x" => 2));
+$bulk->insert(['_id' => 4, 'x' => 2]);
-$bulk->delete(array("x" => 1), array("limit" => 1));
+$bulk->delete(['x' => 1], ['limit' => 1]);
-
-$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
+$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
$writeConcern = new \
MongoDB\Driver\WriteConcern(MongoDB\Driver\WriteConcern::MAJORITY, \
100);
-$result = $manager->executeBulkWrite("databaseName.collectionName", $bulk, \
$writeConcern); +$result = $manager->executeBulkWrite('db.collection', $bulk, \
$writeConcern);
printf("Inserted %d document(s)\n", $result->getInsertedCount());
printf("Matched %d document(s)\n", $result->getMatchedCount());
@@ -88,7 +81,7 @@
printf("Deleted %d document(s)\n", $result->getDeletedCount());
foreach ($result->getUpsertedIds() as $index => $id) {
- printf("upsertedId[%d]: ", $index);
+ printf('upsertedId[%d]: ', $index);
var_dump($id);
}
@@ -128,6 +121,7 @@
<member><classname>MongoDB\Driver\BulkWrite</classname></member>
<member><classname>MongoDB\Driver\WriteResult</classname></member>
<member><classname>MongoDB\Driver\WriteConcern</classname></member>
+ <member><function>MongoDB\Driver\Server::executeBulkWrite</function></member>
</simplelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/executecommand.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/executecommand.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/executecommand.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,7 +4,7 @@
<refentry xml:id="mongodb-driver-manager.executecommand" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Manager::executeCommand</refname>
- <refpurpose>Execute a MongoDB database command</refpurpose>
+ <refpurpose>Execute a database command</refpurpose>
</refnamediv>
<refsect1 role="description">
@@ -16,83 +16,120 @@
<methodparam choice="opt"><type>MongoDB\Driver\ReadPreference</type><parameter>readPreference</parameter></methodparam>
</methodsynopsis>
<para>
- Executes <parameter>command</parameter> on a MongoDB server matching \
<parameter>readPreference</parameter>. + Executes <parameter>command</parameter> on \
a server If + <parameter>readPreference</parameter> is provided, it will be used \
for server + selection; otherwise, the default read preference will be used.
</para>
-
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
- <varlistentry>
- <term><parameter>db</parameter></term>
- <listitem>
- <para>
- The name of the database on which to execute the command.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>command</parameter></term>
- <listitem>
- <para>
- The command document.
- </para>
- </listitem>
- </varlistentry>
+ &mongodb.parameter.db;
+ &mongodb.parameter.command;
&mongodb.parameter.readPreference;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
- Returns <classname>MongoDB\Driver\Cursor</classname> on success, \
&mongodb.throws.onfailure;.
- </para>
+ &mongodb.returns.cursor;
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
&mongodb.throws.std;
- &mongodb.throws.executesingle;
- <member>Throws <classname>MongoDB\Driver\RuntimeException</classname> on other \
errors (invalid command, command arguments, ...)</member> + <member>Throws \
<classname>MongoDB\Driver\Exception\RuntimeException</classname> on other errors \
(e.g. invalid command, issuing a write command to a secondary).</member> \
</simplelist> </refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
- <title><function>MongoDB\Driver\Manager::executeCommand</function> \
example</title> + <title><function>MongoDB\Driver\Manager::executeCommand</function> \
with a command returning a single result document</title> <programlisting \
role="php"> <![CDATA[
<?php
-$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
-$command = new MongoDB\Driver\Command(array("ping" => 1));
+$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
+$command = new MongoDB\Driver\Command(['ping' => 1]);
try {
- $cursor = $manager->executeCommand("admin", $command);
- $response = $cursor->toArray()[0];
+ $cursor = $manager->executeCommand('admin', $command);
} catch(MongoDB\Driver\Exception $e) {
echo $e->getMessage(), "\n";
exit;
}
+
+/* The ping command returns a single result document, so we need to access the
+ * first result in the cursor. */
+$response = $cursor->toArray()[0];
+
var_dump($response);
?>
]]>
</programlisting>
- &example.outputs.similar;
+ &example.outputs;
<screen>
<![CDATA[
-
array(1) {
["ok"]=>
float(1)
}
+]]>
+ </screen>
+ </example>
+ <example>
+ <title><function>MongoDB\Driver\Manager::executeCommand</function> with a command \
returning a cursor</title> + <programlisting role="php">
+<![CDATA[
+<?php
+$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
+
+$bulk = new MongoDB\Driver\BulkWrite;
+$bulk->insert(['x' => 1, 'y' => 'foo']);
+$bulk->insert(['x' => 2, 'y' => 'bar']);
+$bulk->insert(['x' => 3, 'y' => 'bar']);
+$manager->executeBulkWrite('db.collection', $bulk);
+
+$command = new MongoDB\Driver\Command([
+ 'aggregate' => 'collection',
+ 'pipeline' => [
+ ['$group' => ['_id' => '$y', 'sum' => ['$sum' => '$x']]],
+ ],
+ 'cursor' => new stdClass,
+]);
+$cursor = $manager->executeCommand('db', $command);
+
+/* The aggregate command can optionally return its results in a cursor instead
+ * of a single result document. In this case, we can iterate on the cursor
+ * directly to access those results. */
+foreach ($cursor as $document) {
+ var_dump($document);
+}
+
+?>
]]>
+ </programlisting>
+ &example.outputs;
+ <screen>
+<![CDATA[
+object(stdClass)#6 (2) {
+ ["_id"]=>
+ string(3) "bar"
+ ["sum"]=>
+ int(10)
+}
+object(stdClass)#7 (2) {
+ ["_id"]=>
+ string(3) "foo"
+ ["sum"]=>
+ int(2)
+}
+]]>
</screen>
</example>
</refsect1>
@@ -101,15 +138,18 @@
&reftitle.notes;
<note>
<para>
- For write commands, <classname>MongoDB\Driver\WriteConcern</classname> is
- included in the <parameter>command</parameter> document itself.
+ This method does not take a
+ <classname>MongoDB\Driver\WriteConcern</classname> parameter. For write
+ commands (e.g.
+ <link xlink:href="&url.mongodb.docs;reference/command/findAndModify/">findAndModify</link>
+ in MongoDB 3.2+), the write concern should be included in the
+ <parameter>command</parameter> document itself.
</para>
- </note>
- <note>
<para>
If a secondary <parameter>readPreference</parameter> is used, it is the
- caller's responsibility to ensure that the <parameter>command</parameter>
- can be executed on a secondary. No validation is done by the driver.
+ caller's responsibility to ensure that the
+ <parameter>command</parameter> can be executed on a secondary. No validation
+ is done by the driver.
</para>
</note>
</refsect1>
@@ -120,6 +160,7 @@
<member><classname>MongoDB\Driver\Command</classname></member>
<member><classname>MongoDB\Driver\Cursor</classname></member>
<member><classname>MongoDB\Driver\ReadPreference</classname></member>
+ <member><function>MongoDB\Driver\Server::executeCommand</function></member>
</simplelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/executequery.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/executequery.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/executequery.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,7 +4,7 @@
<refentry xml:id="mongodb-driver-manager.executequery" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Manager::executeQuery</refname>
- <refpurpose>Execute a MongoDB query</refpurpose>
+ <refpurpose>Execute a database query</refpurpose>
</refnamediv>
<refsect1 role="description">
@@ -16,39 +16,31 @@
<methodparam choice="opt"><type>MongoDB\Driver\ReadPreference</type><parameter>readPreference</parameter></methodparam>
</methodsynopsis>
<para>
-
+ Executes <parameter>query</parameter> on a server. If
+ <parameter>readPreference</parameter> is provided, it will be used for server
+ selection; otherwise, the default read preference will be used.
</para>
-
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
&mongodb.parameter.namespace;
- <varlistentry>
- <term><parameter>query</parameter></term>
- <listitem>
- <para>
- A <classname>MongoDB\Driver\Query</classname> to execute.
- </para>
- </listitem>
- </varlistentry>
+ &mongodb.parameter.query;
&mongodb.parameter.readPreference;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
- Returns <classname>MongoDB\Driver\Cursor</classname> on success, \
&mongodb.throws.onfailure;.
- </para>
+ &mongodb.returns.cursor;
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
&mongodb.throws.std;
- <member>Throws <classname>MongoDB\Driver\RuntimeException</classname> on other \
errors, such as invalid queries</member> + <member>Throws \
<classname>MongoDB\Driver\Exception\RuntimeException</classname> on other errors \
(e.g. invalid query operators).</member> </simplelist>
</refsect1>
@@ -59,32 +51,44 @@
<programlisting role="php">
<![CDATA[
<?php
-$filter = array(
- "tag" => "mongodb",
- "views" => array('$gt' => 5),
-);
-$options = array(
- "projection" => array(
- "title" => 1,
- "article" => 1,
- ),
- "sort" => array(
- "views" => -1,
- ),
-);
-$readPreference = new \
MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
-$query = new MongoDB\Driver\Query($filter, $options);
$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
-$cursor = $manager->executeQuery("databaseName.collectionName", $query, \
$readPreference);
-foreach($cursor as $document) {
- echo $document["title"], "\n";
+$bulk = new MongoDB\Driver\BulkWrite;
+$bulk->insert(['x' => 1]);
+$bulk->insert(['x' => 2]);
+$bulk->insert(['x' => 3]);
+$manager->executeBulkWrite('db.collection', $bulk);
+
+$filter = ['x' => ['$gt' => 1]];
+$options = [
+ 'projection' => ['_id' => 0],
+ 'sort' => ['x' => -1],
+];
+
+$query = new MongoDB\Driver\Query($filter, $options);
+$cursor = $manager->executeQuery('db.collection', $query);
+
+foreach ($cursor as $document) {
+ var_dump($document);
}
?>
]]>
</programlisting>
+ &example.outputs;
+ <screen>
+<![CDATA[
+object(stdClass)#6 (1) {
+ ["x"]=>
+ int(3)
+}
+object(stdClass)#7 (1) {
+ ["x"]=>
+ int(2)
+}
+]]>
+ </screen>
</example>
</refsect1>
@@ -94,6 +98,7 @@
<member><classname>MongoDB\Driver\Cursor</classname></member>
<member><classname>MongoDB\Driver\Query</classname></member>
<member><classname>MongoDB\Driver\ReadPreference</classname></member>
+ <member><function>MongoDB\Driver\Server::executeQuery</function></member>
</simplelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/getservers.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/getservers.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/getservers.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,19 +4,26 @@
<refentry xml:id="mongodb-driver-manager.getservers" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Manager::getServers</refname>
- <refpurpose>Description</refpurpose>
+ <refpurpose>Return the servers to which this manager is connected</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<type>ReturnType</type><methodname>MongoDB\Driver\Manager::getServers</methodname> + \
<modifier>final</modifier> <modifier>public</modifier> \
<type>array</type><methodname>MongoDB\Driver\Manager::getServers</methodname> <void \
/> </methodsynopsis>
<para>
-
+ Returns an <type>array</type> of <classname>MongoDB\Driver\Server</classname>
+ instances to which this manager is connected.
</para>
-
+ <note>
+ <para>
+ Since the driver connects to the database lazily, this method may return an
+ empty <type>array</type> if called before executing an operation on the
+ <classname>MongoDB\Driver\Manager</classname>.
+ </para>
+ </note>
</refsect1>
<refsect1 role="parameters">
@@ -27,15 +34,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns an <type>array</type> of <classname>MongoDB\Driver\Server</classname>
+ instances to which this manager is connected.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
-
- </para>
+ <simplelist>
+ &mongodb.throws.argumentparsing;
+ </simplelist>
</refsect1>
@@ -47,15 +55,70 @@
<![CDATA[
<?php
-/* ... */
+$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
+/* The driver connects to the database server lazily, so Manager::getServers()
+ * may initially return an empty array. */
+var_dump($manager->getServers());
+
+$command = new MongoDB\Driver\Command(['ping' => 1]);
+$manager->executeCommand('db', $command);
+
+var_dump($manager->getServers());
+
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
-...
+array(0) {
+}
+array(1) {
+ [0]=>
+ object(MongoDB\Driver\Server)#3 (10) {
+ ["host"]=>
+ string(9) "localhost"
+ ["port"]=>
+ int(27017)
+ ["type"]=>
+ int(1)
+ ["is_primary"]=>
+ bool(false)
+ ["is_secondary"]=>
+ bool(false)
+ ["is_arbiter"]=>
+ bool(false)
+ ["is_hidden"]=>
+ bool(false)
+ ["is_passive"]=>
+ bool(false)
+ ["last_is_master"]=>
+ array(8) {
+ ["ismaster"]=>
+ bool(true)
+ ["maxBsonObjectSize"]=>
+ int(16777216)
+ ["maxMessageSizeBytes"]=>
+ int(48000000)
+ ["maxWriteBatchSize"]=>
+ int(1000)
+ ["localTime"]=>
+ object(MongoDB\BSON\UTCDateTime)#4 (1) {
+ ["milliseconds"]=>
+ int(1447267964517)
+ }
+ ["maxWireVersion"]=>
+ int(3)
+ ["minWireVersion"]=>
+ int(0)
+ ["ok"]=>
+ float(1)
+ }
+ ["round_trip_time"]=>
+ int(554)
+ }
+}
]]>
</screen>
</example>
@@ -65,7 +128,8 @@
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
- <member></member>
+ <member><classname>MongoDB\Driver\Server</classname></member>
+ <member><function>MongoDB\Driver\Manager::selectServer</function></member>
</simplelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/selectserver.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/selectserver.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/manager/selectserver.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,7 +4,7 @@
<refentry xml:id="mongodb-driver-manager.selectserver" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Manager::selectServer</refname>
- <refpurpose>Preselect MongoDB node</refpurpose>
+ <refpurpose>Select a server matching a read preference</refpurpose>
</refnamediv>
<refsect1 role="description">
@@ -14,9 +14,10 @@
<methodparam><type>MongoDB\Driver\ReadPreference</type><parameter>readPreference</parameter></methodparam>
</methodsynopsis>
<para>
- Preselect a MongoDB node based on provided <parameter>readPreference</parameter>. \
This can be useful to gurantee a command runs on a specific server when operating in \
a mixed version cluster. + Selects a <classname>MongoDB\Driver\Server</classname> \
matching + <parameter>readPreference</parameter>. This may be used to preselect a \
server + in order to perform version checking before executing an operation.
</para>
-
</refsect1>
<refsect1 role="parameters">
@@ -29,12 +30,28 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
- Returns an instance of <type>MongoDB\Driver\Server</type> ready for action.
+ Returns an <type>MongoDB\Driver\Server</type> matching the read preference.
</para>
</refsect1>
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <simplelist>
+ &mongodb.throws.std;
+ <member>Throws <classname>MongoDB\Driver\Exception\RuntimeException</classname> \
if a server matching the read preference could not be found.</member> + \
</simplelist> + </refsect1>
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><classname>MongoDB\Driver\Server</classname></member>
+ <member><function>MongoDB\Driver\Manager::getServers</function></member>
+ <member><link xlink:href="&url.mongodb.serverselection;">Server Selection \
Specification</link></member> + </simplelist>
+ </refsect1>
+
</refentry>
<!-- Keep this comment at the end of the file
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/construct.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/construct.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/construct.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,104 +4,35 @@
<refentry xml:id="mongodb-driver-server.construct" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Server::__construct</refname>
- <refpurpose>Description</refpurpose>
+ <refpurpose>Create a new Server (not used)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<methodname>MongoDB\Driver\Server::__construct</methodname>
- <methodparam><type>string</type><parameter>host</parameter></methodparam>
- <methodparam><type>string</type><parameter>port</parameter></methodparam>
- <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam>
- <methodparam choice="opt"><type>array</type><parameter>driverOptions</parameter></methodparam>
+ <modifier>final</modifier> <modifier>private</modifier> \
<methodname>MongoDB\Driver\Server::__construct</methodname> + <void />
</methodsynopsis>
<para>
-
+ <classname>MongoDB\Driver\Server</classname> objects are created internally
+ by <classname>MongoDB\Driver\Manager</classname> when a database connection
+ is established and may be returned by
+ <function>MongoDB\Driver\Manager::getServers</function> and
+ <function>MongoDB\Driver\Manager::selectServer</function>.
</para>
-
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
- <variablelist>
- <varlistentry>
- <term><parameter>host</parameter></term>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>port</parameter></term>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>options</parameter></term>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>driverOptions</parameter></term>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
+ &no.function.parameters;
</refsect1>
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
-
- </para>
- </refsect1>
- <refsect1 role="errors">
- &reftitle.errors;
- <para>
-
- </para>
- </refsect1>
-
-
- <refsect1 role="examples">
- &reftitle.examples;
- <example>
- <title><function>MongoDB\Driver\Server::__construct</function> example</title>
- <programlisting role="php">
-<![CDATA[
-<?php
-
-/* ... */
-
-?>
-]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
-<![CDATA[
-...
-]]>
- </screen>
- </example>
- </refsect1>
-
-
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
- <member></member>
+ <member><function>MongoDB\Driver\Manager::getServers</function></member>
+ <member><function>MongoDB\Driver\Manager::selectServer</function></member>
</simplelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/executebulkwrite.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/executebulkwrite.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/executebulkwrite.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,86 +4,71 @@
<refentry xml:id="mongodb-driver-server.executebulkwrite" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Server::executeBulkWrite</refname>
- <refpurpose>Description</refpurpose>
+ <refpurpose>Execute one or more write operations on this server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<type>ReturnType</type><methodname>MongoDB\Driver\Server::executeBulkWrite</methodname>
+ <modifier>final</modifier> <modifier>public</modifier> \
<type>MongoDB\Driver\WriteResult</type><methodname>MongoDB\Driver\Server::executeBulkWrite</methodname>
<methodparam><type>string</type><parameter>namespace</parameter></methodparam>
- <methodparam><type>BulkWrite</type><parameter>zwrite</parameter></methodparam>
+ <methodparam><type>MongoDB\Driver\BulkWrite</type><parameter>bulk</parameter></methodparam>
+ <methodparam choice="opt"><type>MongoDB\Driver\WriteConcern</type><parameter>writeConcern</parameter></methodparam>
</methodsynopsis>
<para>
-
+ Executes one or more write operations on this server.
</para>
-
+ <para>
+ A <classname>MongoDB\Driver\BulkWrite</classname> can be constructed with
+ one or more write operations of varying types (e.g. updates, deletes, and
+ inserts). The driver will attempt to send operations of the same type to the
+ server in as few requests as possible to optimize round trips.
+ </para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
- <varlistentry>
- <term><parameter>namespace</parameter></term>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>zwrite</parameter></term>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </varlistentry>
+ &mongodb.parameter.namespace;
+ &mongodb.parameter.bulkwrite;
+ &mongodb.parameter.writeConcern;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
-
- </para>
+ &mongodb.returns.writeresult;
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
-
- </para>
+ <simplelist>
+ &mongodb.throws.bulkwriteexception;
+ &mongodb.throws.std;
+ <member>Throws <classname>MongoDB\Driver\Exception\RuntimeException</classname> \
on other errors.</member> + </simplelist>
</refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <example>
- <title><function>MongoDB\Driver\Server::executeBulkWrite</function> \
example</title>
- <programlisting role="php">
-<![CDATA[
-<?php
-
-/* ... */
-
-?>
-]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
-<![CDATA[
-...
-]]>
- </screen>
- </example>
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
+ <para>
+ It is the caller's responsibility to ensure that the server is capable
+ of executing the write operation. For example, executing a write operation
+ on a secondary (excluding its "local" database) will fail.
+ </para>
+ </note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
- <member></member>
+ <member><classname>MongoDB\Driver\BulkWrite</classname></member>
+ <member><classname>MongoDB\Driver\WriteResult</classname></member>
+ <member><classname>MongoDB\Driver\WriteConcern</classname></member>
+ <member><function>MongoDB\Driver\Manager::executeBulkWrite</function></member>
</simplelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/executecommand.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/executecommand.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/executecommand.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,86 +4,80 @@
<refentry xml:id="mongodb-driver-server.executecommand" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Server::executeCommand</refname>
- <refpurpose>Description</refpurpose>
+ <refpurpose>Execute a database command on this server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<type>ReturnType</type><methodname>MongoDB\Driver\Server::executeCommand</methodname> \
+ <modifier>final</modifier> <modifier>public</modifier> \
<type>MongoDB\Driver\Cursor</type><methodname>MongoDB\Driver\Server::executeCommand</methodname>
<methodparam><type>string</type><parameter>db</parameter></methodparam>
- <methodparam><type>Command</type><parameter>command</parameter></methodparam>
+ <methodparam><type>MongoDB\Driver\Command</type><parameter>command</parameter></methodparam>
+ <methodparam choice="opt"><type>MongoDB\Driver\ReadPreference</type><parameter>readPreference</parameter></methodparam>
</methodsynopsis>
<para>
-
+ Executes <parameter>command</parameter> on this server.
</para>
-
+ <note>
+ <para>
+ The <parameter>readPreference</parameter> parameter does not control the
+ server to which the driver issues the command; the command will always be
+ executed on this server object. Instead, it may be used when issuing the
+ command to a secondary (from a replica set connection, not standalone) or
+ mongos node to ensure that the driver sets the wire protocol accordingly or
+ adds the read preference to the command document, respectively.
+ </para>
+ </note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
- <varlistentry>
- <term><parameter>db</parameter></term>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>command</parameter></term>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </varlistentry>
+ &mongodb.parameter.db;
+ &mongodb.parameter.command;
+ &mongodb.parameter.readPreference;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
-
- </para>
+ &mongodb.returns.cursor;
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
-
- </para>
+ <simplelist>
+ &mongodb.throws.std;
+ <member>Throws <classname>MongoDB\Driver\Exception\RuntimeException</classname> \
on other errors (e.g. invalid command, issuing a write command to a \
secondary).</member> + </simplelist>
</refsect1>
-
- <refsect1 role="examples">
- &reftitle.examples;
- <example>
- <title><function>MongoDB\Driver\Server::executeCommand</function> example</title>
- <programlisting role="php">
-<![CDATA[
-<?php
-
-/* ... */
-
-?>
-]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
-<![CDATA[
-...
-]]>
- </screen>
- </example>
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
+ <para>
+ This method does not take a
+ <classname>MongoDB\Driver\WriteConcern</classname> parameter. For write
+ commands (e.g.
+ <link xlink:href="&url.mongodb.docs;reference/command/findAndModify/">findAndModify</link>
+ in MongoDB 3.2+), the write concern should be included in the
+ <parameter>command</parameter> document itself.
+ </para>
+ <para>
+ It is the caller's responsibility to ensure that the server is capable
+ of executing the command. For example, executing a write operation on a
+ secondary (excluding its "local" database) will fail.
+ </para>
+ </note>
</refsect1>
-
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
- <member></member>
+ <member><classname>MongoDB\Driver\Command</classname></member>
+ <member><classname>MongoDB\Driver\Cursor</classname></member>
+ <member><classname>MongoDB\Driver\ReadPreference</classname></member>
+ <member><function>MongoDB\Driver\Manager::executeCommand</function></member>
</simplelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/executequery.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/executequery.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/executequery.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,86 +4,62 @@
<refentry xml:id="mongodb-driver-server.executequery" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Server::executeQuery</refname>
- <refpurpose>Description</refpurpose>
+ <refpurpose>Execute a database query on this server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<type>ReturnType</type><methodname>MongoDB\Driver\Server::executeQuery</methodname> + \
<modifier>final</modifier> <modifier>public</modifier> \
<type>MongoDB\Driver\Cursor</type><methodname>MongoDB\Driver\Manager::executeQuery</methodname>
<methodparam><type>string</type><parameter>namespace</parameter></methodparam>
- <methodparam><type>Query</type><parameter>zquery</parameter></methodparam>
+ <methodparam><type>MongoDB\Driver\Query</type><parameter>query</parameter></methodparam>
+ <methodparam choice="opt"><type>MongoDB\Driver\ReadPreference</type><parameter>readPreference</parameter></methodparam>
</methodsynopsis>
<para>
-
+ Executes <parameter>query</parameter> on this server.
</para>
-
+ <note>
+ <para>
+ The <parameter>readPreference</parameter> parameter does not control the
+ server to which the driver issues the query; the query will always be
+ executed on this server object. Instead, it may be used when issuing the
+ command to a secondary (from a replica set connection, not standalone) or
+ mongos node to ensure that the driver sets the wire protocol accordingly or
+ adds the read preference to the query document, respectively.
+ </para>
+ </note>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
- <varlistentry>
- <term><parameter>namespace</parameter></term>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><parameter>zquery</parameter></term>
- <listitem>
- <para>
-
- </para>
- </listitem>
- </varlistentry>
+ &mongodb.parameter.namespace;
+ &mongodb.parameter.query;
+ &mongodb.parameter.readPreference;
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
-
- </para>
+ &mongodb.returns.cursor;
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
-
- </para>
+ <simplelist>
+ &mongodb.throws.std;
+ <member>Throws <classname>MongoDB\Driver\Exception\RuntimeException</classname> \
on other errors (e.g. invalid query operators).</member> + </simplelist>
</refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <example>
- <title><function>MongoDB\Driver\Server::executeQuery</function> example</title>
- <programlisting role="php">
-<![CDATA[
-<?php
-
-/* ... */
-
-?>
-]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
-<![CDATA[
-...
-]]>
- </screen>
- </example>
- </refsect1>
-
-
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
- <member></member>
+ <member><classname>MongoDB\Driver\Cursor</classname></member>
+ <member><classname>MongoDB\Driver\Query</classname></member>
+ <member><classname>MongoDB\Driver\ReadPreference</classname></member>
+ <member><function>MongoDB\Driver\Manager::executeQuery</function></member>
</simplelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/gethost.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/gethost.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/gethost.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,19 +4,18 @@
<refentry xml:id="mongodb-driver-server.gethost" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Server::getHost</refname>
- <refpurpose>Description</refpurpose>
+ <refpurpose>Returns the hostname of this server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<type>ReturnType</type><methodname>MongoDB\Driver\Server::getHost</methodname> + \
<modifier>final</modifier> <modifier>public</modifier> \
<type>string</type><methodname>MongoDB\Driver\Server::getHost</methodname> <void />
</methodsynopsis>
<para>
-
+ Returns the hostname of this server.
</para>
-
</refsect1>
<refsect1 role="parameters">
@@ -27,15 +26,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns the hostname of this server.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
-
- </para>
+ <simplelist>
+ &mongodb.throws.argumentparsing;
+ </simplelist>
</refsect1>
@@ -47,15 +46,20 @@
<![CDATA[
<?php
-/* ... */
+$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017/");
+$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
+$server = $manager->selectServer($rp);
+
+var_dump($server->getHost());
+
?>
]]>
</programlisting>
- &example.outputs.similar;
+ &example.outputs;
<screen>
<![CDATA[
-...
+string(9) "localhost"
]]>
</screen>
</example>
@@ -65,7 +69,7 @@
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
- <member></member>
+ <member><function>MongoDB\Driver\Server::getInfo</function></member>
</simplelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getinfo.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getinfo.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getinfo.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,19 +4,18 @@
<refentry xml:id="mongodb-driver-server.getinfo" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Server::getInfo</refname>
- <refpurpose>Description</refpurpose>
+ <refpurpose>Returns an array of information about this server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<type>ReturnType</type><methodname>MongoDB\Driver\Server::getInfo</methodname> + \
<modifier>final</modifier> <modifier>public</modifier> \
<type>array</type><methodname>MongoDB\Driver\Server::getInfo</methodname> <void />
</methodsynopsis>
<para>
-
+ Returns an array of information about this server.
</para>
-
</refsect1>
<refsect1 role="parameters">
@@ -27,15 +26,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns an array of information about this server.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
-
- </para>
+ <simplelist>
+ &mongodb.throws.argumentparsing;
+ </simplelist>
</refsect1>
@@ -47,28 +46,45 @@
<![CDATA[
<?php
-/* ... */
+$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017/");
+$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
+$server = $manager->selectServer($rp);
+
+var_dump($server->getInfo());
+
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
-...
+array(8) {
+ ["ismaster"]=>
+ bool(true)
+ ["maxBsonObjectSize"]=>
+ int(16777216)
+ ["maxMessageSizeBytes"]=>
+ int(48000000)
+ ["maxWriteBatchSize"]=>
+ int(1000)
+ ["localTime"]=>
+ object(MongoDB\BSON\UTCDateTime)#4 (1) {
+ ["milliseconds"]=>
+ int(1447276242774)
+ }
+ ["maxWireVersion"]=>
+ int(3)
+ ["minWireVersion"]=>
+ int(0)
+ ["ok"]=>
+ float(1)
+}
]]>
</screen>
</example>
</refsect1>
-
- <refsect1 role="seealso">
- &reftitle.seealso;
- <simplelist>
- <member></member>
- </simplelist>
- </refsect1>
-
</refentry>
<!-- Keep this comment at the end of the file
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getlatency.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getlatency.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getlatency.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,19 +4,20 @@
<refentry xml:id="mongodb-driver-server.getlatency" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Server::getLatency</refname>
- <refpurpose>Description</refpurpose>
+ <refpurpose>Returns the latency of this server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<type>ReturnType</type><methodname>MongoDB\Driver\Server::getLatency</methodname> + \
<modifier>final</modifier> <modifier>public</modifier> \
<type>string</type><methodname>MongoDB\Driver\Server::getLatency</methodname> <void \
/> </methodsynopsis>
<para>
-
+ Returns the latency of this server (i.e. the client's measured
+ <link xlink:href="&url.mongodb.sdam;#round-trip-time">round trip time</link>
+ of an <literal>ismaster</literal> command).
</para>
-
</refsect1>
<refsect1 role="parameters">
@@ -27,15 +28,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns the latency of this server.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
-
- </para>
+ <simplelist>
+ &mongodb.throws.argumentparsing;
+ </simplelist>
</refsect1>
@@ -47,15 +48,20 @@
<![CDATA[
<?php
-/* ... */
+$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017/");
+$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
+$server = $manager->selectServer($rp);
+
+var_dump($server->getLatency());
+
?>
]]>
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
-...
+int(592)
]]>
</screen>
</example>
@@ -65,7 +71,8 @@
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
- <member></member>
+ <member><function>MongoDB\Driver\Server::getInfo</function></member>
+ <member><link xlink:href="&url.mongodb.sdam;">Server Discovery and Monitoring \
Specification</link></member> </simplelist>
</refsect1>
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getport.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getport.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getport.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,19 +4,18 @@
<refentry xml:id="mongodb-driver-server.getport" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Server::getPort</refname>
- <refpurpose>Description</refpurpose>
+ <refpurpose>Returns the port on which this server is listening</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<type>ReturnType</type><methodname>MongoDB\Driver\Server::getPort</methodname> + \
<modifier>final</modifier> <modifier>public</modifier> \
<type>int</type><methodname>MongoDB\Driver\Server::getPort</methodname> <void />
</methodsynopsis>
<para>
-
+ Returns the port on which this server is listening.
</para>
-
</refsect1>
<refsect1 role="parameters">
@@ -27,15 +26,15 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns the port on which this server is listening.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
-
- </para>
+ <simplelist>
+ &mongodb.throws.argumentparsing;
+ </simplelist>
</refsect1>
@@ -47,15 +46,20 @@
<![CDATA[
<?php
-/* ... */
+$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017/");
+$rp = new MongoDB\Driver\ReadPreference(MongoDB\Driver\ReadPreference::RP_PRIMARY);
+$server = $manager->selectServer($rp);
+
+var_dump($server->getPort());
+
?>
]]>
</programlisting>
- &example.outputs.similar;
+ &example.outputs;
<screen>
<![CDATA[
-...
+int(27017)
]]>
</screen>
</example>
@@ -65,7 +69,7 @@
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
- <member></member>
+ <member><function>MongoDB\Driver\Server::getInfo</function></member>
</simplelist>
</refsect1>
Deleted: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getstate.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getstate.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/getstate.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -1,93 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision$ -->
-
-<refentry xml:id="mongodb-driver-server.getstate" \
xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink">
- <refnamediv>
- <refname>MongoDB\Driver\Server::getState</refname>
- <refpurpose>Description</refpurpose>
- </refnamediv>
-
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<type>ReturnType</type><methodname>MongoDB\Driver\Server::getState</methodname>
- <void />
- </methodsynopsis>
- <para>
-
- </para>
-
- </refsect1>
-
- <refsect1 role="parameters">
- &reftitle.parameters;
- &no.function.parameters;
- </refsect1>
-
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
-
- </para>
- </refsect1>
-
- <refsect1 role="errors">
- &reftitle.errors;
- <para>
-
- </para>
- </refsect1>
-
-
- <refsect1 role="examples">
- &reftitle.examples;
- <example>
- <title><function>MongoDB\Driver\Server::getState</function> example</title>
- <programlisting role="php">
-<![CDATA[
-<?php
-
-/* ... */
-
-?>
-]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
-<![CDATA[
-...
-]]>
- </screen>
- </example>
- </refsect1>
-
-
- <refsect1 role="seealso">
- &reftitle.seealso;
- <simplelist>
- <member></member>
- </simplelist>
- </refsect1>
-
-</refentry>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-indent-tabs-mode:nil
-sgml-parent-document:nil
-sgml-default-dtd-file:"~/.phpdoc/manual.ced"
-sgml-exposed-tags:nil
-sgml-local-catalogs:nil
-sgml-local-ecat-files:nil
-End:
-vim600: syn=xml fen fdm=syntax fdl=2 si
-vim: et tw=78 syn=sgml
-vi: ts=1 sw=1
--->
Added: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/gettags.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/gettags.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/gettags.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 336263 $ -->
+
+<refentry xml:id="mongodb-driver-server.gettags" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + \
<refnamediv> + <refname>MongoDB\Driver\Server::getTags</refname>
+ <refpurpose>Returns an array of tags describing this server in a replica \
set</refpurpose> + </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>final</modifier> <modifier>public</modifier> \
<type>array</type><methodname>MongoDB\Driver\Server::getTags</methodname> + <void \
/> + </methodsynopsis>
+ <para>
+ Returns an <type>array</type> of
+ <link xlink:href="&url.mongodb.glossary;#term-tag">tags</link> used to
+ describe this server in a replica set. The array will contain zero or more
+ <type>string</type> key and value pairs.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns an <type>array</type> of tags used to describe this server in a
+ replica set.
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <simplelist>
+ &mongodb.throws.argumentparsing;
+ </simplelist>
+ </refsect1>
+
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><function>MongoDB\Driver\Server::getInfo</function></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/gettype.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/gettype.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/gettype.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,19 +4,19 @@
<refentry xml:id="mongodb-driver-server.gettype" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Server::getType</refname>
- <refpurpose>Description</refpurpose>
+ <refpurpose>Returns an integer denoting the type of this server</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<type>ReturnType</type><methodname>MongoDB\Driver\Server::getType</methodname> + \
<modifier>final</modifier> <modifier>public</modifier> \
<type>int</type><methodname>MongoDB\Driver\Server::getType</methodname> <void />
</methodsynopsis>
<para>
-
+ Returns an <type>integer</type> denoting the type of this server. The value
+ will correlate with a <classname>MongoDB\Driver\Server</classname> constant.
</para>
-
</refsect1>
<refsect1 role="parameters">
@@ -27,45 +27,22 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns an <type>integer</type> denoting the type of this server.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
-
- </para>
+ <simplelist>
+ &mongodb.throws.argumentparsing;
+ </simplelist>
</refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <example>
- <title><function>MongoDB\Driver\Server::getType</function> example</title>
- <programlisting role="php">
-<![CDATA[
-<?php
-
-/* ... */
-
-?>
-]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
-<![CDATA[
-...
-]]>
- </screen>
- </example>
- </refsect1>
-
-
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
- <member></member>
+ <member><function>MongoDB\Driver\Server::getInfo</function></member>
</simplelist>
</refsect1>
Added: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/isarbiter.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/isarbiter.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/isarbiter.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 336263 $ -->
+
+<refentry xml:id="mongodb-driver-server.isarbiter" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + \
<refnamediv> + <refname>MongoDB\Driver\Server::isArbiter</refname>
+ <refpurpose>Checks if this server is an arbiter member of a replica \
set</refpurpose> + </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>final</modifier> <modifier>public</modifier> \
<type>bool</type><methodname>MongoDB\Driver\Server::isArbiter</methodname> + <void \
/> + </methodsynopsis>
+ <para>
+ Returns whether this server is an
+ <link xlink:href="&url.mongodb.glossary;#term-arbiter">arbiter member</link>
+ of a replica set.
+ </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &true; if this server is an arbiter member of a replica set, and
+ &false; otherwise.
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <simplelist>
+ &mongodb.throws.argumentparsing;
+ </simplelist>
+ </refsect1>
+
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><function>MongoDB\Driver\Server::getInfo</function></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Deleted: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/isdelayed.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/isdelayed.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/isdelayed.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -1,93 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- $Revision$ -->
-
-<refentry xml:id="mongodb-driver-server.isdelayed" \
xmlns="http://docbook.org/ns/docbook" \
xmlns:xlink="http://www.w3.org/1999/xlink">
- <refnamediv>
- <refname>MongoDB\Driver\Server::isDelayed</refname>
- <refpurpose>Description</refpurpose>
- </refnamediv>
-
- <refsect1 role="description">
- &reftitle.description;
- <methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<type>ReturnType</type><methodname>MongoDB\Driver\Server::isDelayed</methodname>
- <void />
- </methodsynopsis>
- <para>
-
- </para>
-
- </refsect1>
-
- <refsect1 role="parameters">
- &reftitle.parameters;
- &no.function.parameters;
- </refsect1>
-
- <refsect1 role="returnvalues">
- &reftitle.returnvalues;
- <para>
-
- </para>
- </refsect1>
-
- <refsect1 role="errors">
- &reftitle.errors;
- <para>
-
- </para>
- </refsect1>
-
-
- <refsect1 role="examples">
- &reftitle.examples;
- <example>
- <title><function>MongoDB\Driver\Server::isDelayed</function> example</title>
- <programlisting role="php">
-<![CDATA[
-<?php
-
-/* ... */
-
-?>
-]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
-<![CDATA[
-...
-]]>
- </screen>
- </example>
- </refsect1>
-
-
- <refsect1 role="seealso">
- &reftitle.seealso;
- <simplelist>
- <member></member>
- </simplelist>
- </refsect1>
-
-</refentry>
-
-<!-- Keep this comment at the end of the file
-Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-indent-tabs-mode:nil
-sgml-parent-document:nil
-sgml-default-dtd-file:"~/.phpdoc/manual.ced"
-sgml-exposed-tags:nil
-sgml-local-catalogs:nil
-sgml-local-ecat-files:nil
-End:
-vim600: syn=xml fen fdm=syntax fdl=2 si
-vim: et tw=78 syn=sgml
-vi: ts=1 sw=1
--->
Added: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/ishidden.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/ishidden.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/ishidden.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 336263 $ -->
+
+<refentry xml:id="mongodb-driver-server.ishidden" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + \
<refnamediv> + <refname>MongoDB\Driver\Server::isHidden</refname>
+ <refpurpose>Checks if this server is a hidden member of a replica set</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>final</modifier> <modifier>public</modifier> \
<type>bool</type><methodname>MongoDB\Driver\Server::isHidden</methodname> + <void \
/> + </methodsynopsis>
+ <para>
+ Returns whether this server is a
+ <link xlink:href="&url.mongodb.glossary;#term-hidden-member">hidden member</link>
+ of a replica set.
+ </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &true; if this server is a hidden member of a replica set, and
+ &false; otherwise.
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <simplelist>
+ &mongodb.throws.argumentparsing;
+ </simplelist>
+ </refsect1>
+
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><function>MongoDB\Driver\Server::getInfo</function></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Modified: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/ispassive.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/ispassive.xml 2015-11-11 \
18:51:47 UTC (rev 338111)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/ispassive.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -4,17 +4,19 @@
<refentry xml:id="mongodb-driver-server.ispassive" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> \
<refnamediv> <refname>MongoDB\Driver\Server::isPassive</refname>
- <refpurpose>Description</refpurpose>
+ <refpurpose>Checks if this server is a passive member of a replica \
set</refpurpose> </refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
- <modifier>final</modifier> <modifier>public</modifier> \
<type>ReturnType</type><methodname>MongoDB\Driver\Server::isPassive</methodname> + \
<modifier>final</modifier> <modifier>public</modifier> \
<type>bool</type><methodname>MongoDB\Driver\Server::isPassive</methodname> <void />
</methodsynopsis>
<para>
-
+ Returns whether this server is a
+ <link xlink:href="&url.mongodb.glossary;#term-passive-member">passive \
member</link> + of a replica set (i.e. its priority is <literal>0</literal>).
</para>
</refsect1>
@@ -27,45 +29,23 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
-
+ Returns &true; if this server is a passive member of a replica set, and
+ &false; otherwise.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
- <para>
-
- </para>
+ <simplelist>
+ &mongodb.throws.argumentparsing;
+ </simplelist>
</refsect1>
- <refsect1 role="examples">
- &reftitle.examples;
- <example>
- <title><function>MongoDB\Driver\Server::isPassive</function> example</title>
- <programlisting role="php">
-<![CDATA[
-<?php
-
-/* ... */
-
-?>
-]]>
- </programlisting>
- &example.outputs.similar;
- <screen>
-<![CDATA[
-...
-]]>
- </screen>
- </example>
- </refsect1>
-
-
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
- <member></member>
+ <member><function>MongoDB\Driver\Server::getInfo</function></member>
</simplelist>
</refsect1>
Added: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/isprimary.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/isprimary.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/isprimary.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 336263 $ -->
+
+<refentry xml:id="mongodb-driver-server.isprimary" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + \
<refnamediv> + <refname>MongoDB\Driver\Server::isPrimary</refname>
+ <refpurpose>Checks if this server is a primary member of a replica \
set</refpurpose> + </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>final</modifier> <modifier>public</modifier> \
<type>bool</type><methodname>MongoDB\Driver\Server::isPrimary</methodname> + <void \
/> + </methodsynopsis>
+ <para>
+ Returns whether this server is a
+ <link xlink:href="&url.mongodb.glossary;#term-primary">primary member</link>
+ of a replica set.
+ </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &true; if this server is a primary member of a replica set, and
+ &false; otherwise.
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <simplelist>
+ &mongodb.throws.argumentparsing;
+ </simplelist>
+ </refsect1>
+
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><function>MongoDB\Driver\Server::getInfo</function></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Added: phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/issecondary.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/issecondary.xml \
(rev 0)
+++ phpdoc/en/trunk/reference/mongodb/mongodb/driver/server/issecondary.xml 2015-11-11 \
21:17:47 UTC (rev 338112) @@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 336263 $ -->
+
+<refentry xml:id="mongodb-driver-server.issecondary" \
xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + \
<refnamediv> + <refname>MongoDB\Driver\Server::isSecondary</refname>
+ <refpurpose>Checks if this server is a secondary member of a replica \
set</refpurpose> + </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>final</modifier> <modifier>public</modifier> \
<type>bool</type><methodname>MongoDB\Driver\Server::isSecondary</methodname> + \
<void /> + </methodsynopsis>
+ <para>
+ Returns whether this server is a
+ <link xlink:href="&url.mongodb.glossary;#term-secondary">secondary member</link>
+ of a replica set.
+ </para>
+
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns &true; if this server is a secondary member of a replica set, and
+ &false; otherwise.
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <simplelist>
+ &mongodb.throws.argumentparsing;
+ </simplelist>
+ </refsect1>
+
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
+ <simplelist>
+ <member><function>MongoDB\Driver\Server::getInfo</function></member>
+ </simplelist>
+ </refsect1>
+
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"~/.phpdoc/manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
Modified: phpdoc/en/trunk/reference/mongodb/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/mongodb/versions.xml 2015-11-11 18:51:47 UTC (rev \
338111)
+++ phpdoc/en/trunk/reference/mongodb/versions.xml 2015-11-11 21:17:47 UTC (rev \
338112) @@ -27,15 +27,13 @@
<function name='mongodb\driver\cursorid::__construct' from='mongodb >=0.2.0'/>
<function name='mongodb\driver\cursorid::__tostring' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\manager' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\manager::__construct' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\manager::executecommand' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\manager::executequery' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\manager::executebulkwrite' from='mongodb \
>=0.2.0'/>
- <function name='mongodb\driver\manager::executeinsert' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\manager::executeupdate' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\manager::executedelete' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\manager::getservers' from='mongodb >=0.2.0'/>
+ <function name='mongodb\driver\manager' from='mongodb >=1.0.0'/>
+ <function name='mongodb\driver\manager::__construct' from='mongodb >=1.0.0'/>
+ <function name='mongodb\driver\manager::executebulkwrite' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\manager::executecommand' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\manager::executequery' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\manager::getservers' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\manager::selectserver' from='mongodb \
>=1.0.0'/>
<function name='mongodb\driver\query' from='mongodb >=0.2.0'/>
<function name='mongodb\driver\query::__construct' from='mongodb >=0.2.0'/>
@@ -43,19 +41,22 @@
<function name='mongodb\driver\readpreference' from='mongodb >=0.2.0'/>
<function name='mongodb\driver\readpreference::__construct' from='mongodb \
>=0.2.0'/>
- <function name='mongodb\driver\server' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\server::__construct' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\server::executecommand' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\server::executequery' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\server::executebulkwrite' from='mongodb \
>=0.2.0'/>
- <function name='mongodb\driver\server::gethost' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\server::getinfo' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\server::getlatency' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\server::getport' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\server::getstate' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\server::gettype' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\server::isdelayed' from='mongodb >=0.2.0'/>
- <function name='mongodb\driver\server::ispassive' from='mongodb >=0.2.0'/>
+ <function name='mongodb\driver\server' from='mongodb >=1.0.0'/>
+ <function name='mongodb\driver\server::__construct' from='mongodb >=1.0.0'/>
+ <function name='mongodb\driver\server::executecommand' from='mongodb >=1.0.0'/>
+ <function name='mongodb\driver\server::executequery' from='mongodb >=1.0.0'/>
+ <function name='mongodb\driver\server::executebulkwrite' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\server::gethost' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\server::getinfo' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\server::getlatency' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\server::getport' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\server::gettags' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\server::gettype' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\server::isarbiter' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\server::ishidden' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\server::ispassive' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\server::isprimary' from='mongodb \
>=1.0.0'/> + <function name='mongodb\driver\server::issecondary' from='mongodb \
>=1.0.0'/>
<function name='mongodb\driver\bulkwrite' from='mongodb >=0.2.0'/>
<function name='mongodb\driver\bulkwrite::__construct' from='mongodb >=0.2.0'/>
--
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