Php/docs/class.mongoclient

PHP Manual
Core Classes
The MongoClient class

(PECL mongo >=1.3.0)

Warning This extension that defines this class is deprecated. Instead, the MongoDB extension should be used. Alternatives to this class include:

MongoDB\Driver\Manager

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() and the section on connecting for more information about creating connections.

Class synopsis

MongoClient {

/* Constants */

const string VERSION

const string DEFAULT_HOST = "localhost"

const int DEFAULT_PORT = 27017

const string RP_PRIMARY = "primary"

const string RP_PRIMARY_PREFERRED = "primaryPreferred"

const string RP_SECONDARY = "secondary"

const string RP_SECONDARY_PREFERRED = "secondaryPreferred"

const string RP_NEAREST = "nearest"

/* Properties */

public bool $connected = FALSE

public string $status = NULL

protected string $server = NULL

protected bool $persistent = NULL

/* Methods */

public __construct ([ string $server = "mongodb://localhost:27017" [, array $options = array("connect" => TRUE) [, array $driver_options ]]] )

public close ([ bool|string $connection ] ) : bool

public connect ( ) : bool

public dropDB ( mixed $db ) : array

public __get ( string $dbname ) : MongoDB

public static getConnections ( ) : array

public getHosts ( ) : array

public getReadPreference ( ) : array

public getWriteConcern ( ) : array

public killCursor ( string $server_hash , int|MongoInt64 $id ) : bool

public listDBs ( ) : array

public selectCollection ( string $db , string $collection ) : MongoCollection

public selectDB ( string $name ) : MongoDB

public setReadPreference ( string $read_preference [, array $tags ] ) : bool

public setWriteConcern ( mixed $w [, int $wtimeout ] ) : bool

public __toString ( ) : string

}

Predefined Constants

MongoClient Constants

MongoClient::VERSION: PHP driver version. May be suffixed with "dev", "+" or "-" if it is in-between versions.
MongoClient::DEFAULT_HOST: Host to connect to if no host is given.
MongoClient::DEFAULT_PORT: Port to connect to if no port is given.
MongoClient::RP_PRIMARY: Read preference for the primary replica set member.
MongoClient::RP_PRIMARY_PREFERRED: Read preference for preferring the primary replica set member.
MongoClient::RP_SECONDARY: Read preference for a secondary replica set member.
MongoClient::RP_SECONDARY_PREFERRED: Read preference for preferring a secondary replica set member.
MongoClient::RP_NEAREST: Read preference for the nearest replica set member.

Fields

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.

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.