<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <head> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <title>Execute a database command</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-manager.executebulkwrite.html">MongoDB\Driver\Manager::executeBulkWrite</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-manager.executequery.html">MongoDB\Driver\Manager::executeQuery</a></div> <div class="up"><a href="class.mongodb-driver-manager.html">MongoDB\Driver\Manager</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="mongodb-driver-manager.executecommand" class="refentry"> <div class="refnamediv"> <h1 class="refname">MongoDB\Driver\Manager::executeCommand</h1> <p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\Manager::executeCommand</span> — <span class="dc-title">Execute a database command</span></p> </div> <div class="refsect1 description" id="refsect1-mongodb-driver-manager.executecommand-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">final</span> <span class="modifier">public</span> <span class="type"><span class="type MongoDB\Driver\Cursor">MongoDB\Driver\Cursor</span></span> <span class="methodname"><strong>MongoDB\Driver\Manager::executeCommand</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$db</code></span> , <span class="methodparam"><span class="type"><span class="type MongoDB\Driver\Command">MongoDB\Driver\Command</span></span> <code class="parameter">$command</code></span> [, <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code><span class="initializer"> = array()</span></span> ] )</div> <p class="para rdfs-comment"> Selects a server according to the <em>"readPreference"</em> option and executes the command on that server. By default, the read preference from the <a href="mongodb-driver-manager.construct.html#mongodb-driver-manager.construct-uri" class="link">MongoDB Connection URI</a> will be used. </p> <p class="para"> This method applies no special logic to the command. Although this method accepts <em>"readConcern"</em> and <em>"writeConcern"</em> options, which will be incorporated into the command document, those options will not default to corresponding values from the <a href="mongodb-driver-manager.construct.html#mongodb-driver-manager.construct-uri" class="link">MongoDB Connection URI</a> nor will the MongoDB server version be taken into account. Users are therefore encouraged to use specific read and/or write command methods if possible. </p> </div> <div class="refsect1 parameters" id="refsect1-mongodb-driver-manager.executecommand-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">db</code> (<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)</dt> <dd> <p class="para"> The name of the database on which to execute the command. </p> </dd> <dt> <code class="parameter">command</code> (<a href="class.mongodb-driver-command.html" class="classname">MongoDB\Driver\Command</a>)</dt> <dd> <p class="para"> The command to execute. </p> </dd> <dt> <code class="parameter">options</code></dt> <dd> <p class="para"> <table class="doctable table"> <caption><strong>options</strong></caption> <thead> <tr> <th>Option</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>readConcern</td> <td><a href="class.mongodb-driver-readconcern.html" class="classname">MongoDB\Driver\ReadConcern</a></td> <td> <p class="para"> A read concern to apply to the operation. </p> <p class="para"> This option is available in MongoDB 3.2+ and will result in an exception at execution time if specified for an older server version. </p> </td> </tr> <tr> <td>readPreference</td> <td><a href="class.mongodb-driver-readpreference.html" class="classname">MongoDB\Driver\ReadPreference</a></td> <td> <p class="para"> A read preference to use for selecting a server for the operation. </p> </td> </tr> <tr> <td>session</td> <td><a href="class.mongodb-driver-session.html" class="classname">MongoDB\Driver\Session</a></td> <td> <p class="para"> A session to associate with the operation. </p> </td> </tr> <tr> <td>writeConcern</td> <td><a href="class.mongodb-driver-writeconcern.html" class="classname">MongoDB\Driver\WriteConcern</a></td> <td> <p class="para"> A write concern to apply to the operation. </p> </td> </tr> </tbody> </table> </p> <div class="warning"><strong class="warning">Warning</strong> <p class="para"> If you are using a <em>"session"</em> which has a transaction in progress, you cannot specify a <em>"readConcern"</em> or <em>"writeConcern"</em> option. This will result in an <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> being thrown. Instead, you should set these two options when you create the transaction with <span class="methodname"><a href="mongodb-driver-session.starttransaction.html" class="methodname">MongoDB\Driver\Session::startTransaction()</a></span>. </p> </div> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-mongodb-driver-manager.executecommand-returnvalues"> <h3 class="title">Return Values</h3> <p class="para">Returns <a href="class.mongodb-driver-cursor.html" class="classname">MongoDB\Driver\Cursor</a> on success.</p> </div> <div class="refsect1 errors" id="refsect1-mongodb-driver-manager.executecommand-errors"> <h3 class="title">Errors/Exceptions</h3> <ul class="simplelist"> <li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> if the <em>"session"</em> option is used with an associated transaction in combination with a <em>"readConcern"</em> or <em>"writeConcern"</em> option.</li> <li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> if the <em>"session"</em> option is used in combination with an unacknowledged write concern.</li> <li class="member">Throws <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> on argument parsing errors.</li><li class="member">Throws <a href="class.mongodb-driver-exception-connectionexception.html" class="classname">MongoDB\Driver\Exception\ConnectionException</a> if connection to the server fails (for reasons other than authentication).</li><li class="member">Throws <a href="class.mongodb-driver-exception-authenticationexception.html" class="classname">MongoDB\Driver\Exception\AuthenticationException</a> if authentication is needed and fails.</li> <li class="member">Throws <a href="class.mongodb-driver-exception-runtimeexception.html" class="classname">MongoDB\Driver\Exception\RuntimeException</a> on other errors (e.g. invalid command, issuing a write command to a secondary).</li> </ul> </div> <div class="refsect1 changelog" id="refsect1-mongodb-driver-manager.executecommand-changelog"> <h3 class="title">Changelog</h3> <p class="para"> <table class="doctable informaltable"> <thead> <tr> <th>Version</th> <th>Description</th> </tr> </thead> <tbody class="tbody"> <tr> <td>1.4.4</td> <td> <a href="class.mongodb-driver-exception-invalidargumentexception.html" class="classname">MongoDB\Driver\Exception\InvalidArgumentException</a> will be thrown if the <em>"session"</em> option is used in combination with an unacknowledged write concern. </td> </tr> <tr> <td>1.4.0</td> <td> The third parameter is now an <code class="parameter">options</code> array. For backwards compatibility, this paramater will still accept a <a href="class.mongodb-driver-readpreference.html" class="classname">MongoDB\Driver\ReadPreference</a> object. </td> </tr> </tbody> </table> </p> </div> <div class="refsect1 examples" id="refsect1-mongodb-driver-manager.executecommand-examples"> <h3 class="title">Examples</h3> <div class="example" id="mongowritebatch.add.example.delete"> <p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\Manager::executeCommand()</strong></span> with a command returning a single result document</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$manager </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Manager</span><span style="color: #007700">(</span><span style="color: #DD0000">'mongodb://localhost:27017'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$command </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Command</span><span style="color: #007700">([</span><span style="color: #DD0000">'ping' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">]);<br /><br />try {<br /> </span><span style="color: #0000BB">$cursor </span><span style="color: #007700">= </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">executeCommand</span><span style="color: #007700">(</span><span style="color: #DD0000">'admin'</span><span style="color: #007700">, </span><span style="color: #0000BB">$command</span><span style="color: #007700">);<br />} catch(</span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Exception $e</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">$e</span><span style="color: #007700">-></span><span style="color: #0000BB">getMessage</span><span style="color: #007700">(), </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br /> exit;<br />}<br /><br /></span><span style="color: #FF8000">/* The ping command returns a single result document, so we need to access the<br /> * first result in the cursor. */<br /></span><span style="color: #0000BB">$response </span><span style="color: #007700">= </span><span style="color: #0000BB">$cursor</span><span style="color: #007700">-></span><span style="color: #0000BB">toArray</span><span style="color: #007700">()[</span><span style="color: #0000BB">0</span><span style="color: #007700">];<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$response</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> array(1) { ["ok"]=> float(1) } </pre></div> </div> </div> <div class="example" id="mongowritebatch.execute.example.insert"> <p><strong>Example #2 <span class="function"><strong>MongoDB\Driver\Manager::executeCommand()</strong></span> with a command returning a cursor</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$manager </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Manager</span><span style="color: #007700">(</span><span style="color: #DD0000">"mongodb://localhost:27017"</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$bulk </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">BulkWrite</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">([</span><span style="color: #DD0000">'x' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #DD0000">'y' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'foo'</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">([</span><span style="color: #DD0000">'x' </span><span style="color: #007700">=> </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #DD0000">'y' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'bar'</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$bulk</span><span style="color: #007700">-></span><span style="color: #0000BB">insert</span><span style="color: #007700">([</span><span style="color: #DD0000">'x' </span><span style="color: #007700">=> </span><span style="color: #0000BB">3</span><span style="color: #007700">, </span><span style="color: #DD0000">'y' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'bar'</span><span style="color: #007700">]);<br /></span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">executeBulkWrite</span><span style="color: #007700">(</span><span style="color: #DD0000">'db.collection'</span><span style="color: #007700">, </span><span style="color: #0000BB">$bulk</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$command </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Command</span><span style="color: #007700">([<br /> </span><span style="color: #DD0000">'aggregate' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'collection'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'pipeline' </span><span style="color: #007700">=> [<br /> [</span><span style="color: #DD0000">'$group' </span><span style="color: #007700">=> [</span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'$y'</span><span style="color: #007700">, </span><span style="color: #DD0000">'sum' </span><span style="color: #007700">=> [</span><span style="color: #DD0000">'$sum' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'$x'</span><span style="color: #007700">]]],<br /> ],<br /> </span><span style="color: #DD0000">'cursor' </span><span style="color: #007700">=> new </span><span style="color: #0000BB">stdClass</span><span style="color: #007700">,<br />]);<br /></span><span style="color: #0000BB">$cursor </span><span style="color: #007700">= </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">executeCommand</span><span style="color: #007700">(</span><span style="color: #DD0000">'db'</span><span style="color: #007700">, </span><span style="color: #0000BB">$command</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">/* The aggregate command can optionally return its results in a cursor instead<br /> * of a single result document. In this case, we can iterate on the cursor<br /> * directly to access those results. */<br /></span><span style="color: #007700">foreach (</span><span style="color: #0000BB">$cursor </span><span style="color: #007700">as </span><span style="color: #0000BB">$document</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$document</span><span style="color: #007700">);<br />}<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p>The above example will output:</p></div> <div class="example-contents screen"> <div class="cdata"><pre> object(stdClass)#6 (2) { ["_id"]=> string(3) "bar" ["sum"]=> int(10) } object(stdClass)#7 (2) { ["_id"]=> string(3) "foo" ["sum"]=> int(2) } </pre></div> </div> </div> <div class="example" id="mongowritebatch.execute.example.update"> <p><strong>Example #3 Limiting execution time for a command</strong></p> <div class="example-contents"><p> The execution time of a command may be limited by specifying a value for <em>"maxTimeMS"</em> in the <a href="class.mongodb-driver-command.html" class="classname">MongoDB\Driver\Command</a> document. Note that this time limit is enforced on the server side and does not take network latency into account. See <a href="https://docs.mongodb.com/manual/tutorial/terminate-running-operations/#maxtimems" class="link external">» Terminate Running Operations</a> in the MongoDB manual for more information. </p></div> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br /><br />$manager </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Manager</span><span style="color: #007700">(</span><span style="color: #DD0000">'mongodb://localhost:27017'</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">$command </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoDB</span><span style="color: #007700">\</span><span style="color: #0000BB">Driver</span><span style="color: #007700">\</span><span style="color: #0000BB">Command</span><span style="color: #007700">([<br /> </span><span style="color: #DD0000">'count' </span><span style="color: #007700">=> </span><span style="color: #DD0000">'collection'</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">'query' </span><span style="color: #007700">=> [</span><span style="color: #DD0000">'x' </span><span style="color: #007700">=> [</span><span style="color: #DD0000">'$gt' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1</span><span style="color: #007700">]],<br /> </span><span style="color: #DD0000">'maxTimeMS' </span><span style="color: #007700">=> </span><span style="color: #0000BB">1000</span><span style="color: #007700">,<br />]);<br /><br /></span><span style="color: #0000BB">$cursor </span><span style="color: #007700">= </span><span style="color: #0000BB">$manager</span><span style="color: #007700">-></span><span style="color: #0000BB">executeCommand</span><span style="color: #007700">(</span><span style="color: #DD0000">'db'</span><span style="color: #007700">, </span><span style="color: #0000BB">$command</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$cursor</span><span style="color: #007700">-></span><span style="color: #0000BB">toArray</span><span style="color: #007700">()[</span><span style="color: #0000BB">0</span><span style="color: #007700">]);<br /><br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> <div class="example-contents"><p> If the command fails to complete after one second of execution time on the server, a <a href="class.mongodb-driver-exception-executiontimeoutexception.html" class="classname">MongoDB\Driver\Exception\ExecutionTimeoutException</a> will be thrown. </p></div> </div> </div> <div class="refsect1 notes" id="refsect1-mongodb-driver-manager.executecommand-notes"> <h3 class="title">Notes</h3> <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara"> If a secondary <code class="parameter">readPreference</code> is used, it is the caller's responsibility to ensure that the <code class="parameter">command</code> can be executed on a secondary. No validation is done by the driver. </span> </p></blockquote> </div> <div class="refsect1 seealso" id="refsect1-mongodb-driver-manager.executecommand-seealso"> <h3 class="title">See Also</h3> <ul class="simplelist"> <li class="member"><a href="class.mongodb-driver-command.html" class="classname">MongoDB\Driver\Command</a></li> <li class="member"><a href="class.mongodb-driver-cursor.html" class="classname">MongoDB\Driver\Cursor</a></li> <li class="member"><span class="function"><a href="mongodb-driver-manager.executereadcommand.html" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Manager::executeReadCommand()</a> - Execute a database command that reads</span></li> <li class="member"><span class="function"><a href="mongodb-driver-manager.executereadwritecommand.html" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Manager::executeReadWriteCommand()</a> - Execute a database command that reads and writes</span></li> <li class="member"><span class="function"><a href="mongodb-driver-manager.executewritecommand.html" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Manager::executeWriteCommand()</a> - Execute a database command that writes</span></li> <li class="member"><span class="function"><a href="mongodb-driver-server.executecommand.html" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Server::executeCommand()</a> - Execute a database command on this server</span></li> </ul> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-manager.executebulkwrite.html">MongoDB\Driver\Manager::executeBulkWrite</a></div> <div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-manager.executequery.html">MongoDB\Driver\Manager::executeQuery</a></div> <div class="up"><a href="class.mongodb-driver-manager.html">MongoDB\Driver\Manager</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>