-
Notifications
You must be signed in to change notification settings - Fork 724
/
executecommand.xml
302 lines (275 loc) · 8.7 KB
/
executecommand.xml
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mongodb-driver-manager.executecommand" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\Driver\Manager::executeCommand</refname>
<refpurpose>Execute a database command</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>MongoDB\Driver\Cursor</type><methodname>MongoDB\Driver\Manager::executeCommand</methodname>
<methodparam><type>string</type><parameter>db</parameter></methodparam>
<methodparam><type>MongoDB\Driver\Command</type><parameter>command</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>MongoDB\Driver\ReadPreference</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
Selects a server according to the <literal>"readPreference"</literal> option
and executes the command on that server.
</para>
<para>
This method applies no special logic to the command. The
Default values for the <literal>"readPreference"</literal>,
<literal>"readConcern"</literal>, and <literal>"writeConcern"</literal>
options will be inferred from an active transaction (indicated by the
<literal>"session"</literal> option). If there is no active transaction, a
primary read preference will be used for server selection.
</para>
<para>
Default values will <emphasis>not</emphasis> be inferred from the
<link linkend="mongodb-driver-manager.construct-uri">connection URI</link>.
Users are therefore encouraged to use specific read and/or write command
methods if possible.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
&mongodb.parameter.db;
&mongodb.parameter.command;
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<table>
<title>options</title>
<tgroup cols="3">
<thead>
<row>
<entry>Option</entry>
<entry>Type</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
&mongodb.option.readConcern;
&mongodb.option.readPreference;
&mongodb.option.session;
&mongodb.option.writeConcern;
</tbody>
</tgroup>
</table>
</para>
&mongodb.option.transactionReadWriteConcern;
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
&mongodb.returns.cursor;
</refsect1>
<refsect1 role="errors">
&reftitle.errors;
<simplelist>
&mongodb.throws.session-readwriteconcern;
&mongodb.throws.session-unacknowledged;
&mongodb.throws.std;
<member>Throws <classname>MongoDB\Driver\Exception\RuntimeException</classname> on other errors (e.g. invalid command, issuing a write command to a secondary).</member>
</simplelist>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 1.4.4</entry>
<entry>
<classname>MongoDB\Driver\Exception\InvalidArgumentException</classname>
will be thrown if the <literal>"session"</literal> option is used in
combination with an unacknowledged write concern.
</entry>
</row>
<row>
<entry>PECL mongodb 1.4.0</entry>
<entry>
The third parameter is now an <parameter>options</parameter> array.
For backwards compatibility, this paramater will still accept a
<classname>MongoDB\Driver\ReadPreference</classname> object.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>MongoDB\Driver\Manager::executeCommand</function> with a command returning a single result document</title>
<programlisting role="php">
<![CDATA[
<?php
$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
$command = new MongoDB\Driver\Command(['ping' => 1]);
try {
$cursor = $manager->executeCommand('admin', $command);
} catch(MongoDB\Driver\Exception $e) {
echo $e->getMessage(), "\n";
exit;
}
/* The ping command returns a single result document, so we need to access the
* first result in the cursor. */
$response = $cursor->toArray()[0];
var_dump($response);
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
array(1) {
["ok"]=>
float(1)
}
]]>
</screen>
</example>
<example>
<title><function>MongoDB\Driver\Manager::executeCommand</function> with a command returning a cursor</title>
<programlisting role="php">
<![CDATA[
<?php
$manager = new MongoDB\Driver\Manager("mongodb://localhost:27017");
$bulk = new MongoDB\Driver\BulkWrite;
$bulk->insert(['x' => 1, 'y' => 'foo']);
$bulk->insert(['x' => 2, 'y' => 'bar']);
$bulk->insert(['x' => 3, 'y' => 'bar']);
$manager->executeBulkWrite('db.collection', $bulk);
$command = new MongoDB\Driver\Command([
'aggregate' => 'collection',
'pipeline' => [
['$group' => ['_id' => '$y', 'sum' => ['$sum' => '$x']]],
],
'cursor' => new stdClass,
]);
$cursor = $manager->executeCommand('db', $command);
/* The aggregate command can optionally return its results in a cursor instead
* of a single result document. In this case, we can iterate on the cursor
* directly to access those results. */
foreach ($cursor as $document) {
var_dump($document);
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
object(stdClass)#6 (2) {
["_id"]=>
string(3) "bar"
["sum"]=>
int(10)
}
object(stdClass)#7 (2) {
["_id"]=>
string(3) "foo"
["sum"]=>
int(2)
}
]]>
</screen>
</example>
<example>
<title>Limiting execution time for a command</title>
<para>
The execution time of a command may be limited by specifying a value for
<literal>"maxTimeMS"</literal> in the
<classname>MongoDB\Driver\Command</classname> document. Note that this time
limit is enforced on the server side and does not take network latency into
account. See
<link xlink:href="&url.mongodb.docs.maxtimems;">Terminate Running Operations</link>
in the MongoDB manual for more information.
</para>
<programlisting role="php">
<![CDATA[
<?php
$manager = new MongoDB\Driver\Manager('mongodb://localhost:27017');
$command = new MongoDB\Driver\Command([
'count' => 'collection',
'query' => ['x' => ['$gt' => 1]],
'maxTimeMS' => 1000,
]);
$cursor = $manager->executeCommand('db', $command);
var_dump($cursor->toArray()[0]);
?>
]]>
</programlisting>
<para>
If the command fails to complete after one second of execution time on the
server, a
<classname>MongoDB\Driver\Exception\ExecutionTimeoutException</classname>
will be thrown.
</para>
</example>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
<note>
<simpara>
If a secondary <parameter>readPreference</parameter> is used, it is the
caller's responsibility to ensure that the
<parameter>command</parameter> can be executed on a secondary. No validation
is done by the driver.
</simpara>
</note>
<note>
<simpara>
This method does not default to using the read preference from the
<link linkend="mongodb-driver-manager.construct-uri">MongoDB Connection
URI</link>. Applications in need of that behavior should consider using
<function>MongoDB\Driver\Manager::executeReadCommand</function>.
</simpara>
</note>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><classname>MongoDB\Driver\Command</classname></member>
<member><classname>MongoDB\Driver\Cursor</classname></member>
<member><function>MongoDB\Driver\Manager::executeReadCommand</function></member>
<member><function>MongoDB\Driver\Manager::executeReadWriteCommand</function></member>
<member><function>MongoDB\Driver\Manager::executeWriteCommand</function></member>
<member><function>MongoDB\Driver\Server::executeCommand</function></member>
</simplelist>
</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
indent-tabs-mode:nil
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
-->