MongoDB\Driver
PHP Manual

The MongoDB\Driver\Server class

Introduction

Class synopsis

MongoDB\Driver\Server
final class MongoDB\Driver\Server {
/* Constants */
const int MongoDB\Driver\Server::TYPE_UNKNOWN = 0;
const int MongoDB\Driver\Server::TYPE_STANDALONE = 1;
const int MongoDB\Driver\Server::TYPE_MONGOS = 2;
const int MongoDB\Driver\Server::TYPE_POSSIBLE_PRIMARY = 3;
const int MongoDB\Driver\Server::TYPE_RS_PRIMARY = 4;
const int MongoDB\Driver\Server::TYPE_RS_SECONDARY = 5;
const int MongoDB\Driver\Server::TYPE_RS_ARBITER = 6;
const int MongoDB\Driver\Server::TYPE_RS_OTHER = 7;
const int MongoDB\Driver\Server::TYPE_RS_GHOST = 8;
const int MongoDB\Driver\Server::TYPE_LOAD_BALANCER = 9;
/* Methods */
final private __construct()
final public MongoDB\Driver\WriteResult executeBulkWrite(string $namespace, MongoDB\Driver\BulkWrite $bulk, arrayMongoDB\Driver\WriteConcernnull $options = null)
final public MongoDB\Driver\Cursor executeCommand(string $db, MongoDB\Driver\Command $command, arrayMongoDB\Driver\ReadPreferencenull $options = null)
final public MongoDB\Driver\Cursor executeQuery(string $namespace, MongoDB\Driver\Query $query, arrayMongoDB\Driver\ReadPreferencenull $options = null)
final public MongoDB\Driver\Cursor executeReadCommand(string $db, MongoDB\Driver\Command $command, arraynull $options = null)
final public MongoDB\Driver\Cursor executeReadWriteCommand(string $db, MongoDB\Driver\Command $command, arraynull $options = null)
final public MongoDB\Driver\Cursor executeWriteCommand(string $db, MongoDB\Driver\Command $command, arraynull $options = null)
final public string getHost()
final public array getInfo()
final public integernull getLatency()
final public int getPort()
final public MongoDB\Driver\ServerDescription getServerDescription()
final public array getTags()
final public int getType()
final public bool isArbiter()
final public bool isHidden()
final public bool isPassive()
final public bool isPrimary()
final public bool isSecondary()
}

Predefined Constants

MongoDB\Driver\Server::TYPE_UNKNOWN

Unknown server type, returned by MongoDB\Driver\Server::getType.

MongoDB\Driver\Server::TYPE_STANDALONE

Standalone server type, returned by MongoDB\Driver\Server::getType.

MongoDB\Driver\Server::TYPE_MONGOS

Mongos server type, returned by MongoDB\Driver\Server::getType.

MongoDB\Driver\Server::TYPE_POSSIBLE_PRIMARY

Replica set possible primary server type, returned by MongoDB\Driver\Server::getType.

A server may be identified as a possible primary if it has not yet been checked but another memory of the replica set thinks it is the primary.

MongoDB\Driver\Server::TYPE_RS_PRIMARY

Replica set primary server type, returned by MongoDB\Driver\Server::getType.

MongoDB\Driver\Server::TYPE_RS_SECONDARY

Replica set secondary server type, returned by MongoDB\Driver\Server::getType.

MongoDB\Driver\Server::TYPE_RS_ARBITER

Replica set arbiter server type, returned by MongoDB\Driver\Server::getType.

MongoDB\Driver\Server::TYPE_RS_OTHER

Replica set other server type, returned by MongoDB\Driver\Server::getType.

Such servers may be hidden, starting up, or recovering. They cannot be queried, but their hosts lists are useful for discovering the current replica set configuration.

MongoDB\Driver\Server::TYPE_RS_GHOST

Replica set ghost server type, returned by MongoDB\Driver\Server::getType.

Servers may be identified as such in at least three situations: briefly during server startup; in an uninitialized replica set; or when the server is shunned (i.e. removed from the replica set config). They cannot be queried, nor can their host list be used to discover the current replica set configuration; however, the client may monitor this server in hope that it transitions to a more useful state.

MongoDB\Driver\Server::TYPE_LOAD_BALANCER

Load balancer server type, returned by MongoDB\Driver\Server::getType.

Changelog

Version Description
PECL mongodb 1.11.0

Added the MongoDB\Driver\Server::TYPE_LOAD_BALANCER constant.

Table of Contents