Core Classes
MongoClient::close
Core Classes
PHP Manual

# The MongoClient class

(PECL mongoclient >=1.3.0)

## 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`) ]] )
public bool close ([ boolean|string `$connection` ] )
public bool connect ( void )
public array dropDB ( mixed `$db` )
public MongoDB __get ( string `$dbname` )
public static array getConnections ( void )
public array getHosts ( void )
public array getReadPreference ( void )
public bool killCursor ( string `$server_hash` , int|MongoInt64 `$id` )
public array listDBs ( void )
public MongoCollection selectCollection ( string `$db` , string `$collection` )
public MongoDB selectDB ( string `$name` )
public bool setReadPreference ( string `$read_preference` [, array `$tags` ] )
public string __toString ( void )
}

## Predefined Constants

## MongoClient Constants

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

## Fields

connected
  This property will be set to `TRUE` if we have a open connection the database based on the ReadPreference and tagsets (for ReplicaSet connections), `FALSE` otherwise. This property does not take authentication into account.
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.

## See Also

- Read Preferences
- Write Concerns
- Connecting
- MongoDB core docs on » connecting

## Table of Contents

- MongoClient::close — Closes this connection
- MongoClient::connect — Connects to a database server
- MongoClient::__construct — Creates a new database connection object
- MongoClient::dropDB — Drops a database [deprecated]
- MongoClient::__get — Gets a database
- MongoClient::getConnections — Return info about all open connections
- MongoClient::getHosts — Updates status for all associated hosts
- MongoClient::getReadPreference — Get the read preference for this connection
- MongoClient::killCursor — Kills a specific cursor on the server
- MongoClient::listDBs — Lists all of the databases available.
- MongoClient::selectCollection — Gets a database collection
- MongoClient::selectDB — Gets a database
- MongoClient::setReadPreference — Set the read preference for this connection
- MongoClient::__toString — String representation of this connection

Core Classes
MongoClient::close
Core Classes
PHP Manual