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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 330940 $ -->
<refentry xml:id="mongocursor.setflag" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoCursor::setFlag</refname>
<refpurpose>Sets arbitrary flags in case there is no method available the specific flag</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>MongoCursor</type><methodname>MongoCursor::setFlag</methodname>
<methodparam><type>int</type><parameter>flag</parameter></methodparam>
<methodparam choice="opt"><type>bool</type><parameter>set</parameter><initializer>true</initializer></methodparam>
</methodsynopsis>
<para>
The <classname>MongoCursor</classname> class has several methods for
setting flags on the query object. This method is available in case the
MongoDB wire protocol has acquired a new flag, and the driver has not been
updated with a method for this new flag. In all other cases, the method
should be used. See the "See also" section for available methods.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term>
<parameter>flag</parameter>
</term>
<listitem>
<para>
Which flag to set. You can not set flag 6 (EXHAUST) as the driver does
not know how to handle them. You will get a warning if you try to use
this flag. For available flags, please refer to the wire protocol
<link xlink:href="&url.mongodb.dochub.wireprotocol;#MongoWireProtocol-OPQUERY">documentation</link>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>set</parameter>
</term>
<listitem>
<para>
Whether the flag should be set (&true;) or unset (&false;).
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns this cursor.
</para>
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<para>
Shows a warning when an unsupport flag is attempted to be set.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>1.4.0</entry>
<entry>
Support for flag 3 (OPLOG_REPLAY) is added. Versions before 1.4.0
would throw a warning saying that the flag is unsupported.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>MongoCursor::setFlag</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
$m = new MongoClient( 'mongodb://localhost:13000', array( 'replSet' => 'seta' ) );
$c = $m->local->selectCollection( 'oplog.rs' );
$cursor = $c->find( array( 'ns' => 'demo.article', 'op' => 'i' ) );
$cursor->setFlag( 1, true ); // sets the tailable flag
$cursor->setFlag( 5, true ); // sets the await data flag
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>MongoCursor::tailable</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>
</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
-->
|
