1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 317663 $ -->
<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>bool</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
-->
|
