Sophie: php-manual-en-7.2.11-1.mga7 noarch

php-manual-en-7.2.11-1.mga7.noarch.rpm

<!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>The MongoDB\Driver\Manager class</title>

 </head>
 <body><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="book.mongodb.html">MongoDB\Driver</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-manager.construct.html">MongoDB\Driver\Manager::__construct</a></div>
 <div class="up"><a href="book.mongodb.html">MongoDB\Driver</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.mongodb-driver-manager" class="reference">

 <h1 class="title">The MongoDB\Driver\Manager class</h1>
 

 <div class="partintro"><p class="verinfo">(mongodb &gt;=1.0.0)</p>


  <div class="section" id="mongodb-driver-manager.intro">
   <h2 class="title">Introduction</h2>
   <p class="para">
    The <strong class="classname">MongoDB\Driver\Manager</strong> is the main entry point
    to the extension. It is responsible for maintaining connections to MongoDB
    (be it standalone server, replica set, or sharded cluster).
   </p>
   <p class="para">
    No connection to MongoDB is made upon instantiating the Manager.
    This means the <strong class="classname">MongoDB\Driver\Manager</strong> can always be
    constructed, even though one or more MongoDB servers are down.
   </p>
   <p class="para">
    Any write or query can throw connection exceptions as connections are created lazily.
    A MongoDB server may also become unavailable during the life time of the script.
    It is therefore important that all actions on the Manager to be wrapped in try/catch statements.
   </p>
  </div>


  <div class="section" id="mongodb-driver-manager.synopsis">
   <h2 class="title">Class synopsis</h2>


   <div class="classsynopsis">
    <div class="ooclass"></div>


    <div class="classsynopsisinfo">
     <span class="modifier">final</span>
     <span class="ooclass">
      <strong class="classname">MongoDB\Driver\Manager</strong>
     </span>
     {</div>

    
    <div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="methodname"><a href="mongodb-driver-manager.construct.html" class="methodname">__construct</a></span>
    ([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$uri</code><span class="initializer"> = &quot;mongodb://127.0.0.1/&quot;</span></span>
   [, <span class="methodparam"><span class="type">array</span> <code class="parameter">$uriOptions</code><span class="initializer"> = array()</span></span>
   [, <span class="methodparam"><span class="type">array</span> <code class="parameter">$driverOptions</code><span class="initializer"> = array()</span></span>
  ]]] )</div>
<div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">MongoDB\Driver\WriteResult</span> <span class="methodname"><a href="mongodb-driver-manager.executebulkwrite.html" class="methodname">executeBulkWrite</a></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\BulkWrite">MongoDB\Driver\BulkWrite</span></span> <code class="parameter">$bulk</code></span>
   [, <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code><span class="initializer"> = array()</span></span>
  ] )</div>
<div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">MongoDB\Driver\Cursor</span> <span class="methodname"><a href="mongodb-driver-manager.executecommand.html" class="methodname">executeCommand</a></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>
<div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">MongoDB\Driver\Cursor</span> <span class="methodname"><a href="mongodb-driver-manager.executequery.html" class="methodname">executeQuery</a></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>
<div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">MongoDB\Driver\Cursor</span> <span class="methodname"><a href="mongodb-driver-manager.executereadcommand.html" class="methodname">executeReadCommand</a></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>
<div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">MongoDB\Driver\Cursor</span> <span class="methodname"><a href="mongodb-driver-manager.executereadwritecommand.html" class="methodname">executeReadWriteCommand</a></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>
<div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">MongoDB\Driver\Cursor</span> <span class="methodname"><a href="mongodb-driver-manager.executewritecommand.html" class="methodname">executeWriteCommand</a></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>
<div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">MongoDB\Driver\ReadConcern</span> <span class="methodname"><a href="mongodb-driver-manager.getreadconcern.html" class="methodname">getReadConcern</a></span>
    ( <span class="methodparam">void</span>
   )</div>
<div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">MongoDB\Driver\ReadPreference</span> <span class="methodname"><a href="mongodb-driver-manager.getreadpreference.html" class="methodname">getReadPreference</a></span>
    ( <span class="methodparam">void</span>
   )</div>
<div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="mongodb-driver-manager.getservers.html" class="methodname">getServers</a></span>
    ( <span class="methodparam">void</span>
   )</div>
<div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">MongoDB\Driver\WriteConcern</span> <span class="methodname"><a href="mongodb-driver-manager.getwriteconcern.html" class="methodname">getWriteConcern</a></span>
    ( <span class="methodparam">void</span>
   )</div>
<div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">MongoDB\Driver\Server</span> <span class="methodname"><a href="mongodb-driver-manager.selectserver.html" class="methodname">selectServer</a></span>
    ( <span class="methodparam"><span class="type"><span class="type MongoDB\Driver\ReadPreference">MongoDB\Driver\ReadPreference</span></span> <code class="parameter">$readPreference</code></span>
   )</div>
<div class="methodsynopsis dc-description">
   <span class="modifier">final</span> <span class="modifier">public</span> <span class="type">MongoDB\Driver\Session</span> <span class="methodname"><a href="mongodb-driver-manager.startsession.html" class="methodname">startSession</a></span>
    ([ <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code></span>
  ] )</div>

   }</div>


  </div>

  <div class="section" id="mongodb-driver-manager.examples">
   <h2 class="title">Examples</h2>

   <div class="example" id="mongowritebatch.example.basic">
    <p><strong>Example #1 <span class="function"><a href="mongodb-driver-manager.construct.html" class="function">MongoDB\Driver\Manager::__construct()</a></span> basic example</strong></p>
    <div class="example-contents"><p>
     <span class="function"><a href="function.var-dump.html" class="function">var_dump()</a></span>ing a
     <strong class="classname">MongoDB\Driver\Manager</strong> will print out various
     details about the manager that are otherwise not normally exposed.
     This can be useful to debug how the driver views your MongoDB setup, and 
     which options are used.
    </p></div>
   <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB">&lt;?php<br /><br />$manager&nbsp;</span><span style="color: #007700">=&nbsp;new&nbsp;</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">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$manager</span><span style="color: #007700">);<br /><br /></span><span style="color: #0000BB">?&gt;</span>
</span>
</code></div>
   </div>

   <div class="example-contents"><p>The above example will output
something similar to:</p></div>
   <div class="example-contents screen">
<div class="cdata"><pre>
object(MongoDB\Driver\Manager)#1 (3) {
  [&quot;request_id&quot;]=&gt;
  int(1714636915)
  [&quot;uri&quot;]=&gt;
  string(25) &quot;mongodb://localhost:27017&quot;
  [&quot;cluster&quot;]=&gt;
  array(13) {
    [&quot;mode&quot;]=&gt;
    string(6) &quot;direct&quot;
    [&quot;state&quot;]=&gt;
    string(4) &quot;born&quot;
    [&quot;request_id&quot;]=&gt;
    int(0)
    [&quot;sockettimeoutms&quot;]=&gt;
    int(300000)
    [&quot;last_reconnect&quot;]=&gt;
    int(0)
    [&quot;uri&quot;]=&gt;
    string(25) &quot;mongodb://localhost:27017&quot;
    [&quot;requires_auth&quot;]=&gt;
    int(0)
    [&quot;nodes&quot;]=&gt;
    array(...)
    [&quot;max_bson_size&quot;]=&gt;
    int(16777216)
    [&quot;max_msg_size&quot;]=&gt;
    int(50331648)
    [&quot;sec_latency_ms&quot;]=&gt;
    int(15)
    [&quot;peers&quot;]=&gt;
    array(0) {
    }
    [&quot;replSet&quot;]=&gt;
    NULL
  }
}
</pre></div>
    </div>
   </div>
  </div>
 </div>

 
 






 






 






 






 






 






 






 






 






 






 





















<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongodb-driver-manager.construct.html">MongoDB\Driver\Manager::__construct</a> — Create new MongoDB Manager</li><li><a href="mongodb-driver-manager.executebulkwrite.html">MongoDB\Driver\Manager::executeBulkWrite</a> — Execute one or more write operations</li><li><a href="mongodb-driver-manager.executecommand.html">MongoDB\Driver\Manager::executeCommand</a> — Execute a database command</li><li><a href="mongodb-driver-manager.executequery.html">MongoDB\Driver\Manager::executeQuery</a> — Execute a database query</li><li><a href="mongodb-driver-manager.executereadcommand.html">MongoDB\Driver\Manager::executeReadCommand</a> — Execute a database command that reads</li><li><a href="mongodb-driver-manager.executereadwritecommand.html">MongoDB\Driver\Manager::executeReadWriteCommand</a> — Execute a database command that reads and writes</li><li><a href="mongodb-driver-manager.executewritecommand.html">MongoDB\Driver\Manager::executeWriteCommand</a> — Execute a database command that writes</li><li><a href="mongodb-driver-manager.getreadconcern.html">MongoDB\Driver\Manager::getReadConcern</a> — Return the ReadConcern for the Manager</li><li><a href="mongodb-driver-manager.getreadpreference.html">MongoDB\Driver\Manager::getReadPreference</a> — Return the ReadPreference for the Manager</li><li><a href="mongodb-driver-manager.getservers.html">MongoDB\Driver\Manager::getServers</a> — Return the servers to which this manager is connected</li><li><a href="mongodb-driver-manager.getwriteconcern.html">MongoDB\Driver\Manager::getWriteConcern</a> — Return the WriteConcern for the Manager</li><li><a href="mongodb-driver-manager.selectserver.html">MongoDB\Driver\Manager::selectServer</a> — Select a server matching a read preference</li><li><a href="mongodb-driver-manager.startsession.html">MongoDB\Driver\Manager::startSession</a> — Start a new client session for use with this client</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
 <div class="prev" style="text-align: left; float: left;"><a href="book.mongodb.html">MongoDB\Driver</a></div>
 <div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-manager.construct.html">MongoDB\Driver\Manager::__construct</a></div>
 <div class="up"><a href="book.mongodb.html">MongoDB\Driver</a></div>
 <div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>