MediaWiki master
Wikimedia\Rdbms\ServerInfo Class Reference

Information about an individual database host. More...

Public Member Functions

 addServer ( $i, $server)
 
 getLagTimes ()
 
 getPrimaryServerName ()
 
 getServerCount ()
 
 getServerDriver ( $i)
 
 getServerInfo ( $i)
 
 getServerInfoStrict ( $i, $field=null)
 
 getServerMaxLag ( $i)
 
 getServerName ( $i)
 
 getServerType ( $i)
 
 getStreamingReplicaIndexes ()
 
 hasReplicaServers ()
 
 hasServerIndex ( $i)
 
 hasStreamingReplicaServers ()
 
 normalizeServerMaps (array $servers, array &$indexBySrvName=null)
 
 reconfigureServers ( $paramServers)
 

Public Attributes

const MAX_LAG_DEFAULT = 6
 Default 'maxLag' when unspecified.
 
const WRITER_INDEX = 0
 

Detailed Description

Information about an individual database host.

Access: internal

Definition at line 14 of file ServerInfo.php.

Member Function Documentation

◆ addServer()

Wikimedia\Rdbms\ServerInfo::addServer (   $i,
  $server 
)

Definition at line 26 of file ServerInfo.php.

◆ getLagTimes()

Wikimedia\Rdbms\ServerInfo::getLagTimes ( )

Definition at line 58 of file ServerInfo.php.

◆ getPrimaryServerName()

Wikimedia\Rdbms\ServerInfo::getPrimaryServerName ( )
Returns
string Name of the primary DB server of the relevant DB cluster (e.g. "db1052")

Definition at line 166 of file ServerInfo.php.

◆ getServerCount()

Wikimedia\Rdbms\ServerInfo::getServerCount ( )

Definition at line 50 of file ServerInfo.php.

◆ getServerDriver()

Wikimedia\Rdbms\ServerInfo::getServerDriver (   $i)

Definition at line 34 of file ServerInfo.php.

◆ getServerInfo()

Wikimedia\Rdbms\ServerInfo::getServerInfo (   $i)

Definition at line 46 of file ServerInfo.php.

◆ getServerInfoStrict()

Wikimedia\Rdbms\ServerInfo::getServerInfoStrict (   $i,
  $field = null 
)
Parameters
int$iServer index
string | null$fieldServer index field [optional]
Returns
mixed
Exceptions
InvalidArgumentException

Definition at line 78 of file ServerInfo.php.

◆ getServerMaxLag()

Wikimedia\Rdbms\ServerInfo::getServerMaxLag (   $i)

Definition at line 30 of file ServerInfo.php.

References Wikimedia\Rdbms\ServerInfo\MAX_LAG_DEFAULT.

◆ getServerName()

Wikimedia\Rdbms\ServerInfo::getServerName (   $i)

Definition at line 42 of file ServerInfo.php.

◆ getServerType()

Wikimedia\Rdbms\ServerInfo::getServerType (   $i)

Definition at line 38 of file ServerInfo.php.

◆ getStreamingReplicaIndexes()

Wikimedia\Rdbms\ServerInfo::getStreamingReplicaIndexes ( )
Returns
int[] List of replica server indexes

Definition at line 97 of file ServerInfo.php.

◆ hasReplicaServers()

Wikimedia\Rdbms\ServerInfo::hasReplicaServers ( )

Definition at line 170 of file ServerInfo.php.

◆ hasServerIndex()

Wikimedia\Rdbms\ServerInfo::hasServerIndex (   $i)

Definition at line 54 of file ServerInfo.php.

◆ hasStreamingReplicaServers()

Wikimedia\Rdbms\ServerInfo::hasStreamingReplicaServers ( )

Definition at line 108 of file ServerInfo.php.

◆ normalizeServerMaps()

Wikimedia\Rdbms\ServerInfo::normalizeServerMaps ( array  $servers,
array &  $indexBySrvName = null 
)

Definition at line 139 of file ServerInfo.php.

◆ reconfigureServers()

Wikimedia\Rdbms\ServerInfo::reconfigureServers (   $paramServers)

Definition at line 112 of file ServerInfo.php.

Member Data Documentation

◆ MAX_LAG_DEFAULT

const Wikimedia\Rdbms\ServerInfo::MAX_LAG_DEFAULT = 6

Default 'maxLag' when unspecified.

Access: internal
Only for use within LoadBalancer/LoadMonitor

Definition at line 19 of file ServerInfo.php.

Referenced by Wikimedia\Rdbms\ServerInfo\getServerMaxLag().

◆ WRITER_INDEX

const Wikimedia\Rdbms\ServerInfo::WRITER_INDEX = 0

Definition at line 21 of file ServerInfo.php.


The documentation for this class was generated from the following file: