<!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 MongoClient class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongo.core.html">Core Classes</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongoclient.close.html">MongoClient::close</a></div>
<div class="up"><a href="mongo.core.html">Core Classes</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.mongoclient" class="reference">
<h1 class="title">The MongoClient class</h1>
<div class="partintro"><p class="verinfo">(PECL mongoclient >=1.3.0)</p>
<div class="section" id="mongoclient.intro">
<h2 class="title">Introduction</h2>
<p class="para">
A connection manager for PHP and MongoDB.
</p>
<p class="para">
This class is used to create and manage connections. A typical use is:
<div class="example" id="mongoclient.intro-example">
<p><strong>Example #1 <strong class="classname">MongoClient</strong> basic usage</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br />$m </span><span style="color: #007700">= new </span><span style="color: #0000BB">MongoClient</span><span style="color: #007700">(); </span><span style="color: #FF8000">// connect<br /></span><span style="color: #0000BB">$db </span><span style="color: #007700">= </span><span style="color: #0000BB">$m</span><span style="color: #007700">-></span><span style="color: #0000BB">foo</span><span style="color: #007700">; </span><span style="color: #FF8000">// get the database named "foo"<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
<p class="para">
See <span class="function"><a href="mongoclient.construct.html" class="function">MongoClient::__construct()</a></span> and the section on
<a href="mongo.connecting.html" class="link">connecting</a> for more information
about creating connections.
</p>
</div>
<div class="section" id="mongoclient.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="ooclass">
<strong class="classname">MongoClient</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Constants */</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">string</span>
<var class="fieldsynopsis_varname"><a href="class.mongoclient.html#mongoclient.constants.version"><var class="varname">VERSION</var></a></var>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">string</span>
<var class="fieldsynopsis_varname"><a href="class.mongoclient.html#mongoclient.constants.defaulthost"><var class="varname">DEFAULT_HOST</var></a></var>
<span class="initializer"> = "localhost"</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">int</span>
<var class="fieldsynopsis_varname"><a href="class.mongoclient.html#mongoclient.constants.defaultport"><var class="varname">DEFAULT_PORT</var></a></var>
<span class="initializer"> = 27017</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">string</span>
<var class="fieldsynopsis_varname"><a href="class.mongoclient.html#mongoclient.constants.rpprimary"><var class="varname">RP_PRIMARY</var></a></var>
<span class="initializer"> = "primary"</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">string</span>
<var class="fieldsynopsis_varname"><a href="class.mongoclient.html#mongoclient.constants.rpprimarypreferred"><var class="varname">RP_PRIMARY_PREFERRED</var></a></var>
<span class="initializer"> = "primaryPreferred"</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">string</span>
<var class="fieldsynopsis_varname"><a href="class.mongoclient.html#mongoclient.constants.rpsecondary"><var class="varname">RP_SECONDARY</var></a></var>
<span class="initializer"> = "secondary"</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">string</span>
<var class="fieldsynopsis_varname"><a href="class.mongoclient.html#mongoclient.constants.rpsecondary"><var class="varname">RP_SECONDARY_PREFERRED</var></a></var>
<span class="initializer"> = "secondaryPreferred"</span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">const</span>
<span class="type">string</span>
<var class="fieldsynopsis_varname"><a href="class.mongoclient.html#mongoclient.constants.rpsecondary"><var class="varname">RP_NEAREST</var></a></var>
<span class="initializer"> = "nearest"</span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Properties */</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<span class="type">boolean</span>
<var class="varname"><a href="class.mongoclient.html#mongoclient.props.connected">$<var class="varname">connected</var></a></var>
<span class="initializer"> = <strong><code>FALSE</code></strong></span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">public</span>
<span class="type">string</span>
<var class="varname"><a href="class.mongoclient.html#mongoclient.props.status">$<var class="varname">status</var></a></var>
<span class="initializer"> = <strong><code>NULL</code></strong></span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<span class="type">string</span>
<var class="varname">$<var class="varname">server</var></var>
<span class="initializer"> = <strong><code>NULL</code></strong></span>
;</div>
<div class="fieldsynopsis">
<span class="modifier">protected</span>
<span class="type">boolean</span>
<var class="varname">$<var class="varname">persistent</var></var>
<span class="initializer"> = <strong><code>NULL</code></strong></span>
;</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="constructorsynopsis dc-description">
<span class="modifier">public</span> <span class="methodname"><a href="mongoclient.construct.html" class="methodname">__construct</a></span>
([ <span class="methodparam"><span class="type">string</span> <code class="parameter">$server</code><span class="initializer"> = "mongodb://localhost:27017"</span></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$options</code><span class="initializer"> = array("connect" => <strong><code>TRUE</code></strong>)</span></span>
]] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="mongoclient.close.html" class="methodname">close</a></span>
([ <span class="methodparam"><span class="type"><span class="type boolean|string">boolean|string</span></span> <code class="parameter">$connection</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="mongoclient.connect.html" class="methodname">connect</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="mongoclient.dropdb.html" class="methodname">dropDB</a></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$db</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">MongoDB</span> <span class="methodname"><a href="mongoclient.get.html" class="methodname">__get</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$dbname</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">array</span> <span class="methodname"><a href="mongoclient.getconnections.html" class="methodname">getConnections</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="mongoclient.gethosts.html" class="methodname">getHosts</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="mongoclient.getreadpreference.html" class="methodname">getReadPreference</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="mongoclient.killcursor.html" class="methodname">killCursor</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$server_hash</code></span>
, <span class="methodparam"><span class="type"><span class="type int|MongoInt64">int|MongoInt64</span></span> <code class="parameter">$id</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">array</span> <span class="methodname"><a href="mongoclient.listdbs.html" class="methodname">listDBs</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">MongoCollection</span> <span class="methodname"><a href="mongoclient.selectcollection.html" class="methodname">selectCollection</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$db</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$collection</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">MongoDB</span> <span class="methodname"><a href="mongoclient.selectdb.html" class="methodname">selectDB</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><a href="mongoclient.setreadpreference.html" class="methodname">setReadPreference</a></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$read_preference</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$tags</code></span>
] )</div>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type">string</span> <span class="methodname"><a href="mongoclient.tostring.html" class="methodname">__toString</a></span>
( <span class="methodparam">void</span>
)</div>
}</div>
</div>
<div class="section" id="mongoclient.constants">
<h2 class="title">Predefined Constants</h2>
<div class="section" id="mongoclient.constants.types">
<h2 class="title">MongoClient Constants</h2>
<dl>
<dt id="mongoclient.constants.version">
<span class="term"><strong><code>MongoClient::VERSION</code></strong></span>
<dd>
<span class="simpara">
PHP driver version. May be suffixed with "dev", "+" or "-" if it is
in-between versions.
</span>
</dd>
</dt>
<dt id="mongoclient.constants.defaulthost">
<span class="term"><strong><code>MongoClient::DEFAULT_HOST</code></strong></span>
<br /><span class="term"><strong><code>"localhost"</code></strong></span>
<dd>
<span class="simpara">
Host to connect to if no host is given.
</span>
</dd>
</dt>
<dt id="mongoclient.constants.defaultport">
<span class="term"><strong><code>MongoClient::DEFAULT_PORT</code></strong></span>
<br /><span class="term"><strong><code>27017</code></strong></span>
<dd>
<span class="simpara">
Port to connect to if no port is given.
</span>
</dd>
</dt>
<dt id="mongoclient.constants.rpprimary">
<span class="term"><strong><code>MongoClient::RP_PRIMARY</code></strong></span>
<br /><span class="term"><strong><code>"primary"</code></strong></span>
<dd>
<span class="simpara">
<a href="mongo.readpreferences.html" class="link">Read preference</a> for the
primary replica set member.
</span>
</dd>
</dt>
<dt id="mongoclient.constants.rpprimarypreferred">
<span class="term"><strong><code>MongoClient::RP_PRIMARY_PREFERRED</code></strong></span>
<br /><span class="term"><strong><code>"primaryPreferred"</code></strong></span>
<dd>
<span class="simpara">
<a href="mongo.readpreferences.html" class="link">Read preference</a> for
preferring the primary replica set member.
</span>
</dd>
</dt>
<dt id="mongoclient.constants.rpsecondary">
<span class="term"><strong><code>MongoClient::RP_SECONDARY</code></strong></span>
<br /><span class="term"><strong><code>"secondary"</code></strong></span>
<dd>
<span class="simpara">
<a href="mongo.readpreferences.html" class="link">Read preference</a> for a
secondary replica set member.
</span>
</dd>
</dt>
<dt id="mongoclient.constants.rpsecondarypreferred">
<span class="term"><strong><code>MongoClient::RP_SECONDARY_PREFERRED</code></strong></span>
<br /><span class="term"><strong><code>"secondaryPreferred"</code></strong></span>
<dd>
<span class="simpara">
<a href="mongo.readpreferences.html" class="link">Read preference</a> for
preferring a secondary replica set member.
</span>
</dd>
</dt>
<dt id="mongoclient.constants.rpnearest">
<span class="term"><strong><code>MongoClient::RP_NEAREST</code></strong></span>
<br /><span class="term"><strong><code>"nearest"</code></strong></span>
<dd>
<span class="simpara">
<a href="mongo.readpreferences.html" class="link">Read preference</a> for the
nearest replica set member.
</span>
</dd>
</dt>
</dl>
</div>
</div>
<div class="section" id="mongoclient.fields">
<h2 class="title">Fields</h2>
<dl>
<dt id="mongoclient.props.connected">
<span class="term"><var class="varname"><var class="varname">connected</var></var></span>
<dd>
<span class="simpara">
This property will be set to <strong><code>TRUE</code></strong> if we have a open connection
the database based on the ReadPreference and tagsets (for ReplicaSet
connections), <strong><code>FALSE</code></strong> otherwise. This property does not take
authentication into account.
</span>
</dd>
</dt>
<dt id="mongoclient.props.status">
<span class="term"><var class="varname"><var class="varname">status</var></var></span>
<dd>
<span class="simpara">
This property is no longer used and will be set to <strong><code>NULL</code></strong> In driver
versions 1.1.x and earlier, this may be set to a string value (e.g.
<em>"recycled"</em>, <em>"new"</em>) when persistent
connections are used.
</span>
</dd>
</dt>
</dl>
</div>
<div class="section" id="mongoclient.seealso">
<h2 class="title">See Also</h2>
<ul class="simplelist">
<li class="member"><a href="mongo.readpreferences.html" class="xref">Read Preferences</a></li>
<li class="member"><a href="mongo.writeconcerns.html" class="xref">Write Concerns</a></li>
<li class="member"><a href="mongo.connecting.html" class="xref">Connecting</a></li>
<li class="member">MongoDB core docs on <a href="http://docs.mongodb.org/manual/reference/connection-string/" class="link external">» connecting</a></li>
</ul>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongoclient.close.html">MongoClient::close</a> — Closes this connection</li><li><a href="mongoclient.connect.html">MongoClient::connect</a> — Connects to a database server</li><li><a href="mongoclient.construct.html">MongoClient::__construct</a> — Creates a new database connection object</li><li><a href="mongoclient.dropdb.html">MongoClient::dropDB</a> — Drops a database [deprecated]</li><li><a href="mongoclient.get.html">MongoClient::__get</a> — Gets a database</li><li><a href="mongoclient.getconnections.html">MongoClient::getConnections</a> — Return info about all open connections</li><li><a href="mongoclient.gethosts.html">MongoClient::getHosts</a> — Updates status for all associated hosts</li><li><a href="mongoclient.getreadpreference.html">MongoClient::getReadPreference</a> — Get the read preference for this connection</li><li><a href="mongoclient.killcursor.html">MongoClient::killCursor</a> — Kills a specific cursor on the server</li><li><a href="mongoclient.listdbs.html">MongoClient::listDBs</a> — Lists all of the databases available.</li><li><a href="mongoclient.selectcollection.html">MongoClient::selectCollection</a> — Gets a database collection</li><li><a href="mongoclient.selectdb.html">MongoClient::selectDB</a> — Gets a database</li><li><a href="mongoclient.setreadpreference.html">MongoClient::setReadPreference</a> — Set the read preference for this connection</li><li><a href="mongoclient.tostring.html">MongoClient::__toString</a> — String representation of this connection</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongo.core.html">Core Classes</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongoclient.close.html">MongoClient::close</a></div>
<div class="up"><a href="mongo.core.html">Core Classes</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
