<!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 query</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-manager.executecommand.html">MongoDB\Driver\Manager::executeCommand</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-manager.executereadcommand.html">MongoDB\Driver\Manager::executeReadCommand</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.executequery" class="refentry">
<div class="refnamediv">
<h1 class="refname">MongoDB\Driver\Manager::executeQuery</h1>
<p class="verinfo">(mongodb >=1.0.0)</p><p class="refpurpose"><span class="refname">MongoDB\Driver\Manager::executeQuery</span> — <span class="dc-title">Execute a database query</span></p>
</div>
<div class="refsect1 description" id="refsect1-mongodb-driver-manager.executequery-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::executeQuery</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$namespace</code></span>
, <span class="methodparam"><span class="type"><span class="type MongoDB\Driver\Query">MongoDB\Driver\Query</span></span> <code class="parameter">$query</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 query 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>
</div>
<div class="refsect1 parameters" id="refsect1-mongodb-driver-manager.executequery-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">namespace</code> (<span class="type"><a href="language.types.string.html" class="type string">string</a></span>)</dt>
<dd>
<p class="para">
A fully qualified namespace (e.g. <em>"databaseName.collectionName"</em>).
</p>
</dd>
<dt>
<code class="parameter">query</code> (<a href="class.mongodb-driver-query.html" class="classname">MongoDB\Driver\Query</a>)</dt>
<dd>
<p class="para">
The query 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>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>
</tbody>
</table>
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-mongodb-driver-manager.executequery-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.executequery-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> 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 query operators).</li>
</ul>
</div>
<div class="refsect1 changelog" id="refsect1-mongodb-driver-manager.executequery-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.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.executequery-examples">
<h3 class="title">Examples</h3>
<div class="example" id="mongowritebatch.execute.example.delete">
<p><strong>Example #1 <span class="function"><strong>MongoDB\Driver\Manager::executeQuery()</strong></span> example</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">]);<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">]);<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">]);<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">$filter </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: #0000BB">$options </span><span style="color: #007700">= [<br /> </span><span style="color: #DD0000">'projection' </span><span style="color: #007700">=> [</span><span style="color: #DD0000">'_id' </span><span style="color: #007700">=> </span><span style="color: #0000BB">0</span><span style="color: #007700">],<br /> </span><span style="color: #DD0000">'sort' </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">],<br />];<br /><br /></span><span style="color: #0000BB">$query </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">Query</span><span style="color: #007700">(</span><span style="color: #0000BB">$filter</span><span style="color: #007700">, </span><span style="color: #0000BB">$options</span><span style="color: #007700">);<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">executeQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'db.collection'</span><span style="color: #007700">, </span><span style="color: #0000BB">$query</span><span style="color: #007700">);<br /><br />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 (1) {
["x"]=>
int(3)
}
object(stdClass)#7 (1) {
["x"]=>
int(2)
}
</pre></div>
</div>
</div>
<div class="example" id="mongolog.setcallback.example.basic">
<p><strong>Example #2 Limiting execution time for a query</strong></p>
<div class="example-contents"><p>
The <em>"maxTimeMS"</em>
<a href="class.mongodb-driver-query.html" class="classname">MongoDB\Driver\Query</a> option may be used to limit the
execution time of a query. 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">$filter </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: #0000BB">$options </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">$query </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">Query</span><span style="color: #007700">(</span><span style="color: #0000BB">$filter</span><span style="color: #007700">, </span><span style="color: #0000BB">$options</span><span style="color: #007700">);<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">executeQuery</span><span style="color: #007700">(</span><span style="color: #DD0000">'db.collection'</span><span style="color: #007700">, </span><span style="color: #0000BB">$query</span><span style="color: #007700">);<br /><br />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>
If the query 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 seealso" id="refsect1-mongodb-driver-manager.executequery-seealso">
<h3 class="title">See Also</h3>
<ul class="simplelist">
<li class="member"><a href="class.mongodb-driver-cursor.html" class="classname">MongoDB\Driver\Cursor</a></li>
<li class="member"><a href="class.mongodb-driver-query.html" class="classname">MongoDB\Driver\Query</a></li>
<li class="member"><a href="class.mongodb-driver-readpreference.html" class="classname">MongoDB\Driver\ReadPreference</a></li>
<li class="member"><span class="function"><a href="mongodb-driver-server.executequery.html" class="function" rel="rdfs-seeAlso">MongoDB\Driver\Server::executeQuery()</a> - Execute a database query 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.executecommand.html">MongoDB\Driver\Manager::executeCommand</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-manager.executereadcommand.html">MongoDB\Driver\Manager::executeReadCommand</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>
