PHP Conference Nagoya 2025

    The MongoDB\Driver\Server class

    (mongodb >=1.0.0)

    Introduction

    Class synopsis

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

    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

    Found A Problem?

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top