MONGOCLIENT(3) 1 MONGOCLIENT(3)
The MongoClient class
INTRODUCTION
A connection manager for PHP and MongoDB.
This class is used to create and manage connections. A typical use is:
Example #1
MongoClient basic usage
<?php
$m = new MongoClient(); // connect
$db = $m->foo; // get the database named "foo"
?>
See MongoClient.__construct(3) and the section on connecting for more information about creating connections.
CLASS SYNOPSIS
MongoClient
MongoClient
Constants
o const string$MongoClient::VERSION
o const string$MongoClient::DEFAULT_HOST"localhost"
o const int$MongoClient::DEFAULT_PORT27017
o const string$MongoClient::RP_PRIMARY"primary"
o const string$MongoClient::RP_PRIMARY_PREFERRED"primaryPreferred"
o const string$MongoClient::RP_SECONDARY"secondary"
o const string$MongoClient::RP_SECONDARY_PREFERRED"secondaryPreferred"
o const string$MongoClient::RP_NEAREST"nearest"
Properties
o public boolean$connected FALSE
o public string$status NULL
o protected string$server NULL
o protected boolean$persistent NULL
Methods
o public MongoClient::__construct TRUE ([string $server = "mongodb://localhost:27017"], [array $options = )], [array $driver_options])
o public bool MongoClient::close ([boolean|string $connection])
o public bool MongoClient::connect (void )
o public array MongoClient::dropDB (mixed $db)
o public MongoDB MongoClient::__get (string $dbname)
o publicstatic array MongoClient::getConnections (void )
o public array MongoClient::getHosts (void )
o public array MongoClient::getReadPreference (void )
o public array MongoClient::getWriteConcern (void )
o public bool MongoClient::killCursor (string $server_hash, int|MongoInt64 $id)
o public array MongoClient::listDBs (void )
o public MongoCollection MongoClient::selectCollection (string $db, string $collection)
o public MongoDB MongoClient::selectDB (string $name)
o public bool MongoClient::setReadPreference (string $read_preference, [array $tags])
o public bool MongoClient::setWriteConcern (mixed $w, [int $wtimeout])
o public string MongoClient::__toString (void )
PREDEFINED CONSTANTS
MONGOCLIENT CONSTANTS
o MongoClient::VERSION - PHP driver version. May be suffixed with "dev", "+" or "-" if it is in-between versions.
o MongoClient::DEFAULT_HOST - "localhost" - Host to connect to if no host is given.
o MongoClient::DEFAULT_PORT - 27017 - Port to connect to if no port is given.
o MongoClient::RP_PRIMARY - "primary" -Read preference for the primary replica set member.
o MongoClient::RP_PRIMARY_PREFERRED - "primaryPreferred" -Read preference for preferring the primary replica set member.
o MongoClient::RP_SECONDARY - "secondary" -Read preference for a secondary replica set member.
o MongoClient::RP_SECONDARY_PREFERRED - "secondaryPreferred" -Read preference for preferring a secondary replica set member.
o MongoClient::RP_NEAREST - "nearest" -Read preference for the nearest replica set member.
FIELDS
o $connected
- This property will be set to TRUE if we have a open connection to the database, FALSE otherwise. If the connection is to a
replica set, this property will only be TRUE if the driver has a connection to a node matching the current read preference. This
property does not take authentication into account. This property is deprecated since version 1.5.0.
o $status
- This property is no longer used and will be set to NULL In driver versions 1.1.x and earlier, this may be set to a string value
(e.g. "recycled", "new") when persistent connections are used. This property is deprecated since version 1.5.0.
SEE ALSO
o"Read Preferences"
o"Write Concerns"
o"Connecting"
oMongoDB core docs on connecting
PHP Documentation Group MONGOCLIENT(3)