1. class
  2. MongoDB
  3. \
  4. Driver
  5. \
  6. Server

Server

final class Server (View source)

Constants

TYPE_UNKNOWN

TYPE_STANDALONE

TYPE_MONGOS

TYPE_POSSIBLE_PRIMARY

TYPE_RS_PRIMARY

TYPE_RS_SECONDARY

TYPE_RS_ARBITER

TYPE_RS_OTHER

TYPE_RS_GHOST

TYPE_LOAD_BALANCER Since: 1.11.0

Methods

__wakeup()

No description

WriteResult
executeBulkWrite(string $namespace, BulkWrite $bulkWrite, array|null $options = null)

Execute one or more write operations on this server

BulkWriteCommandResult
executeBulkWriteCommand(BulkWriteCommand $bulkWriteCommand, array|null $options = null)

Execute write operations on this server using the bulkWrite command

CursorInterface
executeCommand(string $db, Command $command, array|null $options = null)

Execute a database command on this server

CursorInterface
executeReadCommand(string $db, Command $command, array|null $options = null)

Execute a database command that reads on this server

CursorInterface
executeReadWriteCommand(string $db, Command $command, array|null $options = null)

Execute a database command that reads and writes on this server

CursorInterface
executeWriteCommand(string $db, Command $command, array|null $options = null)

Execute a database command that writes on this server

CursorInterface
executeQuery(string $namespace, Query $query, array|ReadPreference|null $options = null)

Execute a database query on this server

string
getHost()

Returns the hostname of this server

array
getInfo()

Returns an array of information about this server

int
getLatency()

Returns the latency of this server

int
getPort()

Returns the port on which this server is listening

ServerDescription
getServerDescription()

Returns a ServerDescription for this server https://www.php.net/manual/en/mongodb-driver-server.getserverdescription.php

array
getTags()

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

int
getType()

Returns an integer denoting the type of this server

bool
isArbiter()

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

bool
isHidden()

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

bool
isPassive()

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

bool
isPrimary()

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

bool
isSecondary()

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

Details

at line 39
final __wakeup()

No description

at line 57
final WriteResult executeBulkWrite(string $namespace, BulkWrite $bulkWrite, array|null $options = null)

Since: 1.0.0

Execute one or more write operations on this server

Parameters

string $namespace

A fully qualified namespace (e.g. "databaseName.collectionName").
BulkWrite $bulkWrite

The MongoDB\Driver\BulkWrite to execute.
array|null $options

options Option Type Description session MongoDB\Driver\Session A session to associate with the operation. writeConcern MongoDB\Driver\WriteConcern A write concern to apply to the operation.

Return Value

WriteResult

Returns MongoDB\Driver\WriteResult on success.

Exceptions

BulkWriteException
InvalidArgumentException
ConnectionException
AuthenticationException
RuntimeException

at line 74
final BulkWriteCommandResult executeBulkWriteCommand(BulkWriteCommand $bulkWriteCommand, array|null $options = null)

Since: 2.1.0

Execute write operations on this server using the bulkWrite command

Parameters

BulkWriteCommand $bulkWriteCommand

The write(s) to execute.
array|null $options

options Option Type Description session MongoDB\Driver\Session A session to associate with the operation. writeConcern MongoDB\Driver\WriteConcern A write concern to apply to the operation.

Return Value

BulkWriteCommandResult

Returns MongoDB\Driver\BulkWriteCommandResult on success.

Exceptions

BulkWriteCommandException
InvalidArgumentException
ConnectionException
AuthenticationException
RuntimeException

at line 89
final CursorInterface executeCommand(string $db, Command $command, array|null $options = null)

Since: 1.0.0

Execute a database command on this server

Parameters

string $db

The name of the database on which to execute the command.
Command $command

The MongoDB\Driver\Command to execute.
array|null $options

Optionally, a MongoDB\Driver\ReadPreference to select the server for this operation. If none is given, the read preference from the MongoDB Connection URI will be used.

Return Value

CursorInterface

Returns MongoDB\Driver\Cursor on success.

Exceptions

InvalidArgumentException
ConnectionException
AuthenticationException
RuntimeException

at line 111
final CursorInterface executeReadCommand(string $db, Command $command, array|null $options = null)

Since: 1.4.0

Execute a database command that reads on this server

Parameters

string $db

The name of the database on which to execute the command.
Command $command

The command to execute.
array|null $options

options Option Type Description readConcern MongoDB\Driver\ReadConcern A read concern to apply to the operation. This option is available in MongoDB 3.2+ and will result in an exception at execution time if specified for an older server version. readPreference MongoDB\Driver\ReadPreference A read preference to use for selecting a server for the operation. session MongoDB\Driver\Session A session to associate with the operation. If you are using a "session" which has a transaction in progress, you cannot specify a "readConcern" or "writeConcern" option. This will result in an MongoDB\Driver\Exception\InvalidArgumentException being thrown. Instead, you should set these two options when you create the transaction with MongoDB\Driver\Session::startTransaction.

Return Value

CursorInterface

Exceptions

InvalidArgumentException
ConnectionException
AuthenticationException
RuntimeException

at line 133
final CursorInterface executeReadWriteCommand(string $db, Command $command, array|null $options = null)

Since: 1.4.0

Execute a database command that reads and writes on this server

Parameters

string $db

The name of the database on which to execute the command.
Command $command

The command to execute.
array|null $options

options Option Type Description readConcern MongoDB\Driver\ReadConcern A read concern to apply to the operation. This option is available in MongoDB 3.2+ and will result in an exception at execution time if specified for an older server version. session MongoDB\Driver\Session A session to associate with the operation. writeConcern MongoDB\Driver\WriteConcern A write concern to apply to the operation. If you are using a "session" which has a transaction in progress, you cannot specify a "readConcern" or "writeConcern" option. This will result in an MongoDB\Driver\Exception\InvalidArgumentException being thrown. Instead, you should set these two options when you create the transaction with MongoDB\Driver\Session::startTransaction.

Return Value

CursorInterface

Exceptions

InvalidArgumentException
ConnectionException
AuthenticationException
RuntimeException

at line 153
final CursorInterface executeWriteCommand(string $db, Command $command, array|null $options = null)

Since: 1.4.0

Execute a database command that writes on this server

Parameters

string $db

The name of the database on which to execute the command.
Command $command

The command to execute.
array|null $options

options Option Type Description session MongoDB\Driver\Session A session to associate with the operation. writeConcern MongoDB\Driver\WriteConcern A write concern to apply to the operation. If you are using a "session" which has a transaction in progress, you cannot specify a "readConcern" or "writeConcern" option. This will result in an MongoDB\Driver\Exception\InvalidArgumentException being thrown. Instead, you should set these two options when you create the transaction with MongoDB\Driver\Session::startTransaction.

Return Value

CursorInterface

Exceptions

InvalidArgumentException
ConnectionException
AuthenticationException
RuntimeException

at line 169
final CursorInterface executeQuery(string $namespace, Query $query, array|ReadPreference|null $options = null)

Execute a database query on this server

Parameters

string $namespace

A fully qualified namespace (e.g. "databaseName.collectionName").
Query $query

The MongoDB\Driver\Query to execute.
array|ReadPreference|null $options

options Option Type Description readPreference MongoDB\Driver\ReadPreference A read preference to use for selecting a server for the operation. session MongoDB\Driver\Session A session to associate with the operation.

Return Value

CursorInterface

Returns MongoDB\Driver\Cursor on success.

Exceptions

InvalidArgumentException
ConnectionException
AuthenticationException
RuntimeException

at line 176
final string getHost()

Returns the hostname of this server

Return Value

string

Exceptions

InvalidArgumentException

at line 183
final array getInfo()

Returns an array of information about this server

Return Value

array

Exceptions

InvalidArgumentException

at line 190
final int getLatency()

Returns the latency of this server

Return Value

int

Exceptions

InvalidArgumentException

at line 197
final int getPort()

Returns the port on which this server is listening

Return Value

int

Exceptions

InvalidArgumentException

at line 204
final ServerDescription getServerDescription()

Since: 1.13.0

Returns a ServerDescription for this server https://www.php.net/manual/en/mongodb-driver-server.getserverdescription.php

Return Value

ServerDescription

at line 212
final array getTags()

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

Return Value

array

An array of tags used to describe this server in a replica set. The array will contain zero or more string key and value pairs.

Exceptions

InvalidArgumentException

at line 220
final int getType()

Returns an integer denoting the type of this server

Return Value

int

denoting the type of this server

Exceptions

InvalidArgumentException

at line 227
final bool isArbiter()

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

Return Value

bool

Exceptions

InvalidArgumentException

at line 234
final bool isHidden()

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

Return Value

bool

Exceptions

InvalidArgumentException

at line 241
final bool isPassive()

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

Return Value

bool

Exceptions

InvalidArgumentException

at line 248
final bool isPrimary()

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

Return Value

bool

Exceptions

InvalidArgumentException

at line 255
final bool isSecondary()

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

Return Value

bool

Exceptions

InvalidArgumentException