php8.5
Home/ Manual/ mongodb / driver/ The MongoDB\Driver\Server class

The MongoDB\Driver\Server class

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

Intro

Class synopsis

class MongoDB\Driver\Server { }

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 member 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

VersionDescription
PECL mongodb 1.11.0Added the MongoDB\Driver\Server::TYPE_LOAD_BALANCER constant.

Server

In this section

MongoDB\Driver\Server::__construct

Create a new Server (not used)

MongoDB\Driver\Server::executeBulkWrite

Execute one or more write operations on this server

MongoDB\Driver\Server::executeBulkWriteCommand

Execute write operations on this server using the bulkWrite command

MongoDB\Driver\Server::executeCommand

Execute a database command on this server

MongoDB\Driver\Server::executeQuery

Execute a database query on this server

MongoDB\Driver\Server::executeReadCommand

Execute a database command that reads on this server

MongoDB\Driver\Server::executeReadWriteCommand

Execute a database command that reads and writes on this server

MongoDB\Driver\Server::executeWriteCommand

Execute a database command that writes on this server

MongoDB\Driver\Server::getHost

Returns the hostname of this server

MongoDB\Driver\Server::getInfo

Returns an array of information describing this server

MongoDB\Driver\Server::getLatency

Returns the latency of this server in milliseconds

MongoDB\Driver\Server::getPort

Returns the port on which this server is listening

MongoDB\Driver\Server::getServerDescription

Returns a ServerDescription for this server

MongoDB\Driver\Server::getTags

Returns an array of tags describing this server in a replica set

MongoDB\Driver\Server::getType

Returns an integer denoting the type of this server

MongoDB\Driver\Server::isArbiter

Checks if this server is an arbiter member of a replica set

MongoDB\Driver\Server::isHidden

Checks if this server is a hidden member of a replica set

MongoDB\Driver\Server::isPassive

Checks if this server is a passive member of a replica set

MongoDB\Driver\Server::isPrimary

Checks if this server is a primary member of a replica set

MongoDB\Driver\Server::isSecondary

Checks if this server is a secondary member of a replica set

Source: reference/mongodb/mongodb/driver/server.xml · from the official PHP manual (php/doc-en)