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

TopologyDescription

Since: 1.13.0

class TopologyDescription (View source)

Constants

TYPE_UNKNOWN

TYPE_SINGLE

TYPE_SHARDED

TYPE_REPLICA_SET_NO_PRIMARY

TYPE_REPLICA_SET_WITH_PRIMARY

TYPE_LOAD_BALANCED

Methods

array
getServers()

Returns the servers in the topology

string
getType()

Returns a string denoting the type of this topology

bool
hasReadableServer(ReadPreference|null $readPreference = null)

Returns whether the topology has a readable server

bool
hasWritableServer()

Returns whether the topology has a writable server

void
__wakeup()

No description

Details

at line 25
final array getServers()

Returns the servers in the topology

Return Value

array

Returns an array of MongoDB\Driver\ServerDescription objects corresponding to the known servers in the topology.

at line 31
final string getType()

Returns a string denoting the type of this topology

Return Value

string

at line 37
final bool hasReadableServer(ReadPreference|null $readPreference = null)

Returns whether the topology has a readable server

Parameters

ReadPreference|null $readPreference

Return Value

bool

at line 43
final bool hasWritableServer()

Returns whether the topology has a writable server

Return Value

bool

at line 45
final void __wakeup()

No description

Return Value

void