MongoDB\Driver
PHP Manual

The MongoDB\Driver\TopologyDescription class

Introduction

The MongoDB\Driver\TopologyDescription class is a value object that represents a topology to which the driver is connected. Instances of this class are returned by MongoDB\Driver\Monitoring\TopologyChangedEvent methods.

Class synopsis

MongoDB\Driver\TopologyDescription
final class MongoDB\Driver\TopologyDescription {
/* Constants */
const string MongoDB\Driver\TopologyDescription::TYPE_UNKNOWN = "Unknown";
const string MongoDB\Driver\TopologyDescription::TYPE_SINGLE = "Single";
const string MongoDB\Driver\TopologyDescription::TYPE_SHARDED = "Sharded";
const string MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_NO_PRIMARY = "ReplicaSetNoPrimary";
const string MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_WITH_PRIMARY = "ReplicaSetWithPrimary";
const string MongoDB\Driver\TopologyDescription::TYPE_LOAD_BALANCED = "LoadBalanced";
/* Methods */
final public array getServers()
final public string getType()
final public bool hasReadableServer(MongoDB\Driver\ReadPreferencenull $readPreference = null)
final public bool hasWritableServer()
}

Predefined Constants

MongoDB\Driver\TopologyDescription::TYPE_UNKNOWN

Unknown topology type, returned by MongoDB\Driver\TopologyDescription::getType.

MongoDB\Driver\TopologyDescription::TYPE_SINGLE

Single server (i.e. direct connection), returned by MongoDB\Driver\TopologyDescription::getType.

MongoDB\Driver\TopologyDescription::TYPE_SHARDED

Sharded cluster, returned by MongoDB\Driver\TopologyDescription::getType.

MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_NO_PRIMARY

Replica set with no primary server, returned by MongoDB\Driver\TopologyDescription::getType.

MongoDB\Driver\TopologyDescription::TYPE_REPLICA_SET_WITH_PRIMARY

Replica set with a primary server, returned by MongoDB\Driver\TopologyDescription::getType.

MongoDB\Driver\TopologyDescription::TYPE_LOAD_BALANCED

Load balanced topology, returned by MongoDB\Driver\TopologyDescription::getType.

Table of Contents