svn: /phpdoc/en/trunk/reference/mongo/ mongocursor.xml
| From: | Kristina Chodorow | Date: | Tue, 11 May 2010 19:59:21 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/mongo/ mongocursor.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-6631@lists.php.net to get a copy of this message | ||
kristina Tue, 11 May 2010 19:59:21 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=299265
Log:
added static vars
Changed paths:
U phpdoc/en/trunk/reference/mongo/mongocursor.xml
Modified: phpdoc/en/trunk/reference/mongo/mongocursor.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor.xml 2010-05-11 19:48:14 UTC (rev 299264)
+++ phpdoc/en/trunk/reference/mongo/mongocursor.xml 2010-05-11 19:59:21 UTC (rev 299265)
@@ -77,6 +77,12 @@
<varname>slaveOkay</varname>
<initializer>&false;</initializer>
</fieldsynopsis>
+ <fieldsynopsis>
+ <modifier>static</modifier>
+ <type>integer</type>
+ <varname>timeout</varname>
+ <initializer>20000</initializer>
+ </fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook)
xpointer(id('class.mongocursor')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])"
/>
@@ -86,6 +92,35 @@
</section>
<section>
+ <title>Static Variables</title>
+
+ <variablelist>
+ <varlistentry>
+ <term><property>MongoCursor::slaveOkay</property></term>
+ <listitem>
+ <para>
+ If the query should have the "slaveOkay" flag set, which allows reads on
+ the slave (slaves are, by default, just for backup and unreadable). Can
+ be overridden with <function>MongoCursor::slaveOkay</function>.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><property>MongoCursor::timeout</property></term>
+ <listitem>
+ <para>
+ Set timeout in milliseconds for all database responses. To wait forever,
+ use -1. Can be overridden with <function>MongoCursor::timeout</function>.
+ This does not cause the MongoDB server to cancel the operation, it just
+ causes the driver to stop waiting for a response and throw a
+ MongoCursorTimeoutException.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ <section>
&reftitle.seealso;
<para>
MongoDB core docs on <link
xlink:href="&url.mongodb.dochub.cursors;">cursors</link>.