mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-28 14:58:55 +00:00
2ee99d1e90
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@308234 c90b9560-bf6c-de11-be94-00142212c4b1
138 lines
3.7 KiB
XML
138 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="mongocursor.slaveokay" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>MongoCursor::slaveOkay</refname>
|
|
<refpurpose>Sets whether this query can be done on a slave</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <type>MongoCursor</type><methodname>MongoCursor::slaveOkay</methodname>
|
|
<methodparam choice="opt"><type>bool</type><parameter>okay</parameter><initializer>true</initializer></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Calling this will make the driver route reads to slaves if:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
You are using a replica set and
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
You created a <classname>Mongo</classname> instance using the option
|
|
<literal>"replicaSet" => true and</literal>
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
There is a healthy slave that can be reached by the driver.
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
You can check which server was used for this query by calling
|
|
<function>MongoCursor::info</function> after running the query. It's
|
|
<literal>server</literal> field will show which server the query was sent to.
|
|
</para>
|
|
<para>
|
|
Note that you should use this function even if you do not use the automatic
|
|
routing to slaves. If you connect directly to a secondary in a replica set,
|
|
you still need to call this function, which basically tells the database that
|
|
you are aware that you might be getting older data and you're okay with that.
|
|
If you do not call this, you'll get "not master" errors when you try to
|
|
query.
|
|
</para>
|
|
<para>
|
|
This method will override the static class variable
|
|
<varname>MongoCursor::slaveOkay</varname>. It will also override
|
|
<function>Mongo::setSlaveOkay</function>,
|
|
<function>MongoDB::setSlaveOkay</function> and
|
|
<function>MongoCollection::setSlaveOkay</function>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>okay</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
If it is okay to query the slave.
|
|
</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>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<example>
|
|
<title><function>MongoCursor::slaveOkay</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
MongoCursor::$slaveOkay = false;
|
|
|
|
// cannot query slave
|
|
$cursor = $collection->find();
|
|
|
|
// can query slave
|
|
$cursor = $collection->find()->slaveOkay();
|
|
|
|
MongoCursor::$slaveOkay = true;
|
|
|
|
// can query slave
|
|
$cursor = $collection->find();
|
|
|
|
// cannot query slave
|
|
$cursor = $collection->find()->slaveOkay(false);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</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
|
|
-->
|