PHP Velho Oeste 2024
    Edit Report a Bug

    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:

    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 boolean connected = FALSE ;
    public string status = NULL ;
    protected string server = NULL ;
    protected boolean persistent = NULL ;
    /* Methods */
    public __construct ([ string $server = "mongodb://localhost:27017" [, array $options = array("connect" => TRUE) [, array $driver_options ]]] )
    public close ([ boolean|string $connection ] ) : bool
    public connect ( void ) : bool
    public dropDB ( mixed $db ) : array
    public __get ( string $dbname ) : MongoDB
    public static getConnections ( void ) : array
    public getHosts ( void ) : array
    public getReadPreference ( void ) : array
    public getWriteConcern ( void ) : array
    public killCursor ( string $server_hash , int|MongoInt64 $id ) : bool
    public listDBs ( void ) : 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 ( void ) : 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.

    This property is deprecated since version 1.5.0.

    Table of Contents

    add a note add a note

    User Contributed Notes 5 notes

    up
    8
    mike at eastghost dot com
    11 years ago
    This will help maintain sanity while debugging replicaSet connectivity problems:

    error_reporting( E_ALL )
    // print every log message possible
    \MongoLog::setLevel(\MongoLog::ALL); // all log levels
    \MongoLog::setModule(\MongoLog::ALL); // all parts of the driver
    up
    5
    mike at eastghost dot com
    11 years ago
    php monogo driver 1.3.4
    feb 2013

    After demoting old replicaset primary to secondary, and promoting old replicaset second into primary, we began seeing "No candidate servers found" MongoException at initial attempt to connect to (new) replicaset primary (via this hint in the /etc/mongo.conf: replSet = rs1/pri.eastghost.com)

    Fix seems to be

    1. NEVER list "localhost" in the bind= line of /etc/mongo.conf

    2. ALWAYS list every replica set member in every member's /etc/hosts file -- there seems to be something wrong with DNS lookup timing.
    up
    -1
    East Ghost Com
    7 years ago
    One MongoClient is required per every MongoDB.

    So, if you have a website-specific database but also a shared database (like maybe one holding ZipCodes and State names), then each needs its own MongoClient.  One MongoClient can not be shared amongst multiple MongoDB's.
    up
    -3
    bennettsst at NOSPAM dot gmail dot com
    9 years ago
    Using the 1.2.5-5.5 vc11 driver the connected attribute is depracted.
    up
    -29
    jazz at funkynerd dot com
    11 years ago
    Seeing as the Mongo class has been deprecated, I'm using the following code to allow compatibility with the pre 1.3.0 driver successfully.

    <?php
    $class     = 'MongoClient';

    if(!    class_exists($class)){
               
            $class = 'Mongo';
               
    }
           
    $conn = new $class($hosts, $args);
    ?>
    add a note add a note
    To Top