[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/_language-snippets.ent_reference/mongo/mongo/getslave.xml_
From: Hannes_Magnusson <bjori () php ! net>
Date: 2012-11-29 0:16:49
Message-ID: svn-bjori-1354148209-328550-1820023549 () svn ! php ! net
[Download RAW message or body]
bjori Thu, 29 Nov 2012 00:16:49 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=328550
Log:
More ReadPreference love rather then slaveokay
Changed paths:
U phpdoc/en/trunk/language-snippets.ent
U phpdoc/en/trunk/reference/mongo/mongo/getslave.xml
U phpdoc/en/trunk/reference/mongo/mongo/getslaveokay.xml
U phpdoc/en/trunk/reference/mongo/mongo/setslaveokay.xml
U phpdoc/en/trunk/reference/mongo/mongo/switchslave.xml
U phpdoc/en/trunk/reference/mongo/mongoclient/gethosts.xml
U phpdoc/en/trunk/reference/mongo/mongocollection/getslaveokay.xml
U phpdoc/en/trunk/reference/mongo/mongocollection/setslaveokay.xml
U phpdoc/en/trunk/reference/mongo/mongocursor/doquery.xml
U phpdoc/en/trunk/reference/mongo/mongocursor/info.xml
U phpdoc/en/trunk/reference/mongo/mongocursor/setflag.xml
U phpdoc/en/trunk/reference/mongo/mongocursor/slaveokay.xml
U phpdoc/en/trunk/reference/mongo/mongocursor.xml
U phpdoc/en/trunk/reference/mongo/mongodb/getslaveokay.xml
U phpdoc/en/trunk/reference/mongo/mongodb/setslaveokay.xml
["svn-diffs-328550.txt" (text/x-diff)]
Modified: phpdoc/en/trunk/language-snippets.ent
===================================================================
--- phpdoc/en/trunk/language-snippets.ent 2012-11-28 23:25:17 UTC (rev 328549)
+++ phpdoc/en/trunk/language-snippets.ent 2012-11-29 00:16:49 UTC (rev 328550)
@@ -1726,3 +1726,7 @@
<!ENTITY mongo.writes.parameters.timeout '<listitem \
xmlns="http://docbook.org/ns/docbook"><para><literal>"timeout"</literal></para><para>Integer, \
defaults to <literal>MongoCursor::$timeout</literal>. If "safe" is set, this sets \
how long (in milliseconds) for the client to wait for a database response. If the \
database does not respond within the timeout period, a \
<classname>MongoCursorTimeoutException</classname> will be \
thrown.</para></listitem>'> <!ENTITY mongo.writes.parameters.safe '<listitem \
xmlns="http://docbook.org/ns/docbook"><para><literal>"safe"</literal></para><para><emphasis>Deprecated</emphasis>. \
Please use the <link linkend="mongo.writeconcerns">WriteConcern</link> \
<literal>w</literal> option.</para></listitem>'> <!ENTITY \
mongo.errors.exceptions.writeconcern '<para \
xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoCursorException</classname> if the "w" option is set and the write \
fails.</para><para xmlns="http://docbook.org/ns/docbook">Throws \
<classname>MongoCursorTimeoutException</classname> if the "w" option is set to a \
value greater than one and the operation takes longer than \
<varname>MongoCursor::$timeout</varname> milliseconds to complete. This does not \
kill the operation on the server, it is a client-side timeout. The operation in \
<literal>MongoCollection::$wtimeout</literal> is milliseconds.</para>'> +<!ENTITY \
mongo.errors.deprecated '<para xmlns="http://docbook.org/ns/docbook">Issues \
<constant>E_DEPRECATED</constant> warning</para>'> +
+
+
Modified: phpdoc/en/trunk/reference/mongo/mongo/getslave.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongo/getslave.xml 2012-11-28 23:25:17 UTC (rev \
328549)
+++ phpdoc/en/trunk/reference/mongo/mongo/getslave.xml 2012-11-29 00:16:49 UTC (rev \
328550) @@ -52,6 +52,15 @@
</para>
</refsect1>
+ <refsect1 role="errors"><!-- {{{ -->
+ &reftitle.errors;
+ &mongo.errors.deprecated;
+ <para>
+ The returned results aren't really useful as the secondary selection
+ process is done on each query and database command execution.
+ </para>
+ </refsect1><!-- }}} -->
+
<refsect1 role="changelog">
&reftitle.changelog;
<para>
@@ -74,6 +83,13 @@
</para>
</refsect1>
+ <refsect1 role="seealso"><!-- {{{ -->
+ &reftitle.seealso;
+ <simplelist>
+ <member><function>MongoCursor::info</function></member>
+ </simplelist>
+ </refsect1><!-- }}} -->
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Modified: phpdoc/en/trunk/reference/mongo/mongo/getslaveokay.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongo/getslaveokay.xml 2012-11-28 23:25:17 UTC \
(rev 328549)
+++ phpdoc/en/trunk/reference/mongo/mongo/getslaveokay.xml 2012-11-29 00:16:49 UTC \
(rev 328550) @@ -32,6 +32,11 @@
</para>
</refsect1>
+ <refsect1 role="errors">
+ &reftitle.errors;
+ &mongo.errors.deprecated;
+ </refsect1>
+
<refsect1 role="changelog">
&reftitle.changelog;
<para>
@@ -54,6 +59,14 @@
</para>
</refsect1>
+ <refsect1 role="seealso"><!-- {{{ -->
+ &reftitle.seealso;
+ <simplelist>
+ <member><xref linkend="mongo.readpreferences" /></member>
+ <member><methodname>MongoClient::getReadPreference</methodname></member>
+ </simplelist>
+ </refsect1><!-- }}} -->
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Modified: phpdoc/en/trunk/reference/mongo/mongo/setslaveokay.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongo/setslaveokay.xml 2012-11-28 23:25:17 UTC \
(rev 328549)
+++ phpdoc/en/trunk/reference/mongo/mongo/setslaveokay.xml 2012-11-29 00:16:49 UTC \
(rev 328550) @@ -68,6 +68,14 @@
</para>
</refsect1>
+ <refsect1 role="seealso"><!-- {{{ -->
+ &reftitle.seealso;
+ <simplelist>
+ <member><xref linkend="mongo.readpreferences" /></member>
+ <member><methodname>MongoClient::setReadPreference</methodname></member>
+ </simplelist>
+ </refsect1><!-- }}} -->
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Modified: phpdoc/en/trunk/reference/mongo/mongo/switchslave.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongo/switchslave.xml 2012-11-28 23:25:17 UTC \
(rev 328549)
+++ phpdoc/en/trunk/reference/mongo/mongo/switchslave.xml 2012-11-29 00:16:49 UTC \
(rev 328550) @@ -82,7 +82,14 @@
</para>
</refsect1>
+ <refsect1 role="seealso"><!-- {{{ -->
+ &reftitle.seealso;
+ <simplelist>
+ <member><xref linkend="mongo.readpreferences" /></member>
+ </simplelist>
+ </refsect1><!-- }}} -->
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Modified: phpdoc/en/trunk/reference/mongo/mongoclient/gethosts.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongoclient/gethosts.xml 2012-11-28 23:25:17 UTC \
(rev 328549)
+++ phpdoc/en/trunk/reference/mongo/mongoclient/gethosts.xml 2012-11-29 00:16:49 UTC \
(rev 328550) @@ -92,11 +92,6 @@
}
]]>
</screen>
- <para>
- In the example above, B and C are secondaries (state 2). B is likely to be
- selected for queries if slaveOkay is set, as it has a lower ping time (and
- thus is likely closer or handling less load) than C.
- </para>
</refsect1>
<refsect1 role="changelog">
Modified: phpdoc/en/trunk/reference/mongo/mongocollection/getslaveokay.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocollection/getslaveokay.xml 2012-11-28 \
23:25:17 UTC (rev 328549)
+++ phpdoc/en/trunk/reference/mongo/mongocollection/getslaveokay.xml 2012-11-29 \
00:16:49 UTC (rev 328550) @@ -54,6 +54,14 @@
</para>
</refsect1>
+ <refsect1 role="seealso"><!-- {{{ -->
+ &reftitle.seealso;
+ <simplelist>
+ <member><xref linkend="mongo.readpreferences" /></member>
+ <member><methodname>MongoCollection::getReadPreference</methodname></member>
+ </simplelist>
+ </refsect1><!-- }}} -->
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Modified: phpdoc/en/trunk/reference/mongo/mongocollection/setslaveokay.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocollection/setslaveokay.xml 2012-11-28 \
23:25:17 UTC (rev 328549)
+++ phpdoc/en/trunk/reference/mongo/mongocollection/setslaveokay.xml 2012-11-29 \
00:16:49 UTC (rev 328550) @@ -69,6 +69,14 @@
</para>
</refsect1>
+ <refsect1 role="seealso"><!-- {{{ -->
+ &reftitle.seealso;
+ <simplelist>
+ <member><xref linkend="mongo.readpreferences" /></member>
+ <member><methodname>MongoCollection::setReadPreference</methodname></member>
+ </simplelist>
+ </refsect1><!-- }}} -->
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Modified: phpdoc/en/trunk/reference/mongo/mongocursor/doquery.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor/doquery.xml 2012-11-28 23:25:17 UTC \
(rev 328549)
+++ phpdoc/en/trunk/reference/mongo/mongocursor/doquery.xml 2012-11-29 00:16:49 UTC \
(rev 328550) @@ -13,6 +13,11 @@
<modifier>protected</modifier> \
<type>void</type><methodname>MongoCursor::doQuery</methodname> <void/>
</methodsynopsis>
+ <warning>
+ <para>
+ Please do not use me.
+ </para>
+ </warning>
<para>
This function actually queries the database. All queries and commands go
through this function. Thus, this function can be overridden to provide
Modified: phpdoc/en/trunk/reference/mongo/mongocursor/info.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor/info.xml 2012-11-28 23:25:17 UTC (rev \
328549)
+++ phpdoc/en/trunk/reference/mongo/mongocursor/info.xml 2012-11-29 00:16:49 UTC (rev \
328550) @@ -50,8 +50,8 @@
document is current), <literal>numReturned</literal> (the number
returned by the server in the current batch), and
<literal>server</literal> (which server the query was sent
- to—useful in conjunction with
- <function>MongoCursor::slaveOkay</function>).
+ to—useful in conjunction with
+ <xref linkend="mongo.readpreferences" />.
</entry>
</row>
<row>
Modified: phpdoc/en/trunk/reference/mongo/mongocursor/setflag.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor/setflag.xml 2012-11-28 23:25:17 UTC \
(rev 328549)
+++ phpdoc/en/trunk/reference/mongo/mongocursor/setflag.xml 2012-11-29 00:16:49 UTC \
(rev 328550) @@ -90,16 +90,12 @@
<refsect1 role="seealso">
&reftitle.seealso;
<para>
- MongoDB core docs on
- <link xlink:href="&url.mongodb.dochub.wireprotocol;#MongoWireProtocol-OPQUERY">wire \
protocol query flags</link>.
- </para>
- <para>
<simplelist>
<member><function>MongoCursor::tailable</function></member>
- <member><function>MongoCursor::slaveOkay</function></member>
<member><function>MongoCursor::immortal</function></member>
<member><function>MongoCursor::awaitData</function></member>
<member><function>MongoCursor::partial</function></member>
+ <member>MongoDB core docs on<link \
xlink:href="&url.mongodb.dochub.wireprotocol;#MongoWireProtocol-OPQUERY">wire \
protocol query flags</link></member> </simplelist>
</para>
</refsect1>
Modified: phpdoc/en/trunk/reference/mongo/mongocursor/slaveokay.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor/slaveokay.xml 2012-11-28 23:25:17 UTC \
(rev 328549)
+++ phpdoc/en/trunk/reference/mongo/mongocursor/slaveokay.xml 2012-11-29 00:16:49 UTC \
(rev 328550) @@ -47,7 +47,7 @@
</para>
<para>
This method will override the static class variable
- <varname>MongoCursor::slaveOkay</varname>. It will also override
+ <varname>MongoCursor::$slaveOkay</varname>. It will also override
<function>Mongo::setSlaveOkay</function>,
<function>MongoDB::setSlaveOkay</function> and
<function>MongoCollection::setSlaveOkay</function>.
@@ -116,6 +116,16 @@
</example>
</refsect1>
+ <refsect1 role="seealso"><!-- {{{ -->
+ &reftitle.seealso;
+ <simplelist>
+ <member><xref linkend="mongo.readpreferences" /></member>
+ <member><methodname>MongoCursor::setReadPreference</methodname></member>
+ <member><methodname>MongoCursor::getReadPreference</methodname></member>
+ </simplelist>
+ </refsect1><!-- }}} -->
+
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Modified: phpdoc/en/trunk/reference/mongo/mongocursor.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongocursor.xml 2012-11-28 23:25:17 UTC (rev \
328549)
+++ phpdoc/en/trunk/reference/mongo/mongocursor.xml 2012-11-29 00:16:49 UTC (rev \
328550) @@ -152,6 +152,10 @@
the secondary (secondaries are, by default, just for backup and not
queried). Can be overridden with <function>MongoCursor::slaveOkay</function>.
</para>
+ <para>
+ This functionality is <emphasis>deprecated</emphasis>. Please use
+ <xref linkend="mongo.readpreferences" /> instead.
+ </para>
</listitem>
</varlistentry>
<varlistentry xml:id="mongocursor.props.timeout">
@@ -169,7 +173,7 @@
</variablelist>
</section>
- <section>
+ <section role="seealso">
&reftitle.seealso;
<para>
MongoDB core docs on <link \
xlink:href="&url.mongodb.dochub.cursors;">cursors</link>.
Modified: phpdoc/en/trunk/reference/mongo/mongodb/getslaveokay.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongodb/getslaveokay.xml 2012-11-28 23:25:17 UTC \
(rev 328549)
+++ phpdoc/en/trunk/reference/mongo/mongodb/getslaveokay.xml 2012-11-29 00:16:49 UTC \
(rev 328550) @@ -54,6 +54,16 @@
</para>
</refsect1>
+ <refsect1 role="seealso"><!-- {{{ -->
+ &reftitle.seealso;
+ <simplelist>
+ <member><xref linkend="mongo.readpreferences" /></member>
+ <member><methodname>MongoDB::getReadPreference</methodname></member>
+ <member><methodname>MongoDB::setReadPreference</methodname></member>
+ </simplelist>
+ </refsect1><!-- }}} -->
+
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Modified: phpdoc/en/trunk/reference/mongo/mongodb/setslaveokay.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongodb/setslaveokay.xml 2012-11-28 23:25:17 UTC \
(rev 328549)
+++ phpdoc/en/trunk/reference/mongo/mongodb/setslaveokay.xml 2012-11-29 00:16:49 UTC \
(rev 328550) @@ -68,7 +68,16 @@
</para>
</refsect1>
+ <refsect1 role="seealso"><!-- {{{ -->
+ &reftitle.seealso;
+ <simplelist>
+ <member><xref linkend="mongo.readpreferences" /></member>
+ <member><methodname>MongoDB::setReadPreference</methodname></member>
+ <member><methodname>MongoDB::getReadPreference</methodname></member>
+ </simplelist>
+ </refsect1><!-- }}} -->
+
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
--
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