svn: /phpdoc/en/trunk/reference/mongo/ mongocursor/partial.xml versions.xml
| From: | Kristina Chodorow | Date: | Thu, 27 Jan 2011 21:07:56 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/mongo/ mongocursor/partial.xml versions.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-7688@lists.php.net to get a copy of this message | ||
kristina Thu, 27 Jan 2011 21:07:56 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=307801
Log:
added partial
Changed paths:
A phpdoc/en/trunk/reference/mongo/mongocursor/partial.xml
U phpdoc/en/trunk/reference/mongo/versions.xml
Added: phpdoc/en/trunk/reference/mongo/mongocursor/partial.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor/partial.xml (rev 0)
+++ phpdoc/en/trunk/reference/mongo/mongocursor/partial.xml 2011-01-27 21:07:56 UTC (rev 307801)
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!-- $Revision$ -->
+<refentry xml:id="mongocursor.partial" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>MongoCursor::partial</refname>
+ <refpurpose>If this query should fetch partial results from
<emphasis>mongos</emphasis> if a shard is down</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier>
<type>MongoCursor</type><methodname>MongoCursor::partial</methodname>
+ <methodparam
choice="opt"><type>boolean</type><parameter>okay</parameter><initializer>true</initializer></methodparam>
+ </methodsynopsis>
+ <para>
+ This option allows <emphasis>mongos</emphasis> to send partial query results
+ if a shard is unreachable. This is only applicable when running a sharded
+ MongoDB cluster and connecting to a <emphasis>mongos</emphasis>.
+ </para>
+ <para>
+ If a shard goes down and a query needs to be sent to that shard,
+ <emphasis>mongos</emphasis> will return the results (if any) from shards it
+ already contacted, then an error message that it could not reach the shard
+ (a <classname>MongoCursorException</classname> in PHP). If you would like to
+ get whatever results <emphasis>mongos</emphasis> can provide and no
+ exception, you can use this method. Note that this means that you won't have
+ an indication that a shard is down in your query response.
+ </para>
+ <para>
+ This has no effect on the query if all shards are reachable. This flag was
+ implemented in MongoDB version 1.7.5, so will only work with that version and
+ higher.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>okay</parameter>
+ </term>
+ <listitem>
+ <para>
+ If receiving partial results is okay.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns this cursor.
+ </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+ &reftitle.errors;
+ <para>
+ Throws <classname>MongoCursorException</classname> if this cursor has started
iterating.
+ </para>
+ </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
+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
+-->
Property changes on: phpdoc/en/trunk/reference/mongo/mongocursor/partial.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
Modified: phpdoc/en/trunk/reference/mongo/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/versions.xml 2011-01-27 19:23:05 UTC (rev 307800)
+++ phpdoc/en/trunk/reference/mongo/versions.xml 2011-01-27 21:07:56 UTC (rev 307801)
@@ -98,6 +98,7 @@
<function name='mongocursor::addoption' from='PECL mongo
>=1.0.4'/>
<function name='mongocursor::info' from='PECL mongo >=1.0.5'/>
<function name='mongocursor::batchSize' from='PECL mongo
>=1.0.11'/>
+ <function name='mongocursor::partial' from='PECL mongo >=1.2.0'/>
<!-- MongoGridFS -->
<function name='mongogridfs::__construct' from='PECL mongo
>=0.9.0'/>
<function name='mongogridfs::find' from='PECL mongo >=0.9.0'/>