Database load balancing object. More...

Inheritance diagram for LoadBalancer:

Public Member Functions
	__construct ($params)
	allowLagged ($mode=null)
	Disables/enables lag checks.
	clearLagTimeCache ()
	Clear the cache for getLagTimes.
	closeAll ()
	Close all open connections.
	closeConnection ($conn)
	Close a connection Using this function makes sure the LoadBalancer knows the connection is closed.
	closeConnecton ($conn)
	Deprecated function, typo in function name.
	commitAll ()
	Commit transactions on all open connections.
	commitMasterChanges ()
	Issue COMMIT only on master, only if queries were done on connection.
	doWait ($index, $open=false)
	Wait for a given slave to catch up to the master pos stored in $this.
	forEachOpenConnection ($callback, $params=array())
	Call a function with each open connection object.
	getAnyOpenConnection ($i)
	Get any open connection to a given server index, local or foreign Returns false if there is no connection open.
&	getConnection ($i, $groups=array(), $wiki=false)
	Get a connection by index This is the main entry point for this class.
	getLaggedSlaveMode ()
	getLagTimes ($wiki=false)
	Get lag time for each server Results are cached for a short time in memcached, and indefinitely in the process cache.
	getLoadMonitor ()
	Get a LoadMonitor instance.
	getMasterPos ()
	Get the current master position for chronology control purposes.
	getMaxLag ($wiki=false)
	Get the hostname and lag time of the most-lagged slave.
	getRandomNonLagged ($loads, $wiki=false)
	getReaderIndex ($group=false, $wiki=false)
	Get the index of the reader connection, which may be a slave This takes into account load ratios and lag times.
	getServerCount ()
	Get the number of defined servers (not the number of open connections)
	getServerInfo ($i)
	Return the server info structure for a given index, or false if the index is invalid.
	getServerName ($i)
	Get the host name or IP address of the server with the specified index Prefer a readable name if available.
	getWriterIndex ()
	haveIndex ($i)
	Returns true if the specified index is a valid server index.
	isNonZeroLoad ($i)
	Returns true if the specified index is valid and has non-zero load.
	isOpen ($index)
	Test if the specified index represents an open connection.
	openConnection ($i, $wiki=false)
	Open a connection to the server given by the specified index Index must be an actual index into the array.
	openForeignConnection ($i, $wiki)
	Open a connection to a foreign DB, or return one if it is already open.
	parentInfo ($x=null)
	Get or set arbitrary data used by the parent object, usually an LBFactory.
	pickRandom ($weights)
	Given an array of non-normalised probabilities, this function will select an element and return the appropriate key.
	pingAll ()
	reallyOpenConnection ($server, $dbNameOverride=false)
	Really opens a connection.
	reuseConnection ($conn)
	Mark a foreign connection as being available for reuse under a different DB name or prefix.
	safeGetLag ($conn)
	Get the lag in seconds for a given connection, or zero if this load balancer does not have replication enabled.
	setServerInfo ($i, $serverInfo)
	Sets the server info structure for the given index.
	sleep ($t)
	Wait for a specified number of microseconds, and return the period waited.
	waitFor ($pos)
	Set the master wait position If a DB_SLAVE connection has been opened already, waits Otherwise sets a variable telling it to wait if such a connection is opened.
	waitForAll ($pos)
	Set the master wait position and wait for ALL slaves to catch up to it.
	waitTimeout ($value=null)
Public Attributes
	$mAllowLagged
	$mConns
	$mGroupLoads
	$mLagTimes
	$mLastError = 'Unknown error'
	$mLoadMonitor
	$mLoads
	$mWaitTimeout
Private Member Functions
	reportConnectionError ()
Private Attributes
	$mErrorConnection
	$mLaggedSlaveMode
	$mLoadMonitorClass
	$mParentInfo
	$mReadIndex
	$mServers
	$mWaitForPos

Detailed Description

Database load balancing object.

Todo:: document

Definition at line 30 of file LoadBalancer.php.

Constructor & Destructor Documentation

LoadBalancer::__construct ( $ params )

Parameters:

array $params with keys: servers Required. Array of server info structures. masterWaitTimeout Replication lag wait timeout loadMonitor Name of a class used to fetch server lag and load.

Exceptions:

MWException

Reimplemented in LoadBalancer_Single.

Definition at line 46 of file LoadBalancer.php.

References $params, array(), and as.

Member Function Documentation

LoadBalancer::allowLagged ( $ mode = null )

Disables/enables lag checks.

Parameters:

$mode null

Returns:: bool

Definition at line 935 of file LoadBalancer.php.

LoadBalancer::clearLagTimeCache ( )

Clear the cache for getLagTimes.

Definition at line 1063 of file LoadBalancer.php.

LoadBalancer::closeAll ( )

Close all open connections.

Definition at line 831 of file LoadBalancer.php.

References array(), and as.

LoadBalancer::closeConnection ( $ conn )

Close a connection Using this function makes sure the LoadBalancer knows the connection is closed.

If you use $conn->close() directly, the load balancer won't update its state.

Parameters:

$conn DatabaseBase

Definition at line 863 of file LoadBalancer.php.

References as.

Referenced by closeConnecton().

LoadBalancer::closeConnecton ( $ conn )

Deprecated function, typo in function name.

Deprecated:: in 1.18

Parameters:

$conn

Definition at line 852 of file LoadBalancer.php.

References closeConnection(), and wfDeprecated().

LoadBalancer::commitAll ( )

Commit transactions on all open connections.

Definition at line 885 of file LoadBalancer.php.

References as.

LoadBalancer::commitMasterChanges ( )

Issue COMMIT only on master, only if queries were done on connection.

Definition at line 900 of file LoadBalancer.php.

References as, empty, and getWriterIndex().

LoadBalancer::doWait	(	$	index,
		$	open = `false`
	)

Wait for a given slave to catch up to the master pos stored in $this.

Parameters:

$index
$open	bool

Returns:: bool

Definition at line 402 of file LoadBalancer.php.

References $result, getAnyOpenConnection(), openConnection(), and wfDebug().

Referenced by getReaderIndex(), waitFor(), and waitForAll().

LoadBalancer::forEachOpenConnection	(	$	callback,
		$	params = `array()`
	)

Call a function with each open connection object.

Parameters:

	$callback
array	$params

Definition at line 965 of file LoadBalancer.php.

References $params, array(), and as.

LoadBalancer::getAnyOpenConnection ( $ i )

Get any open connection to a given server index, local or foreign Returns false if there is no connection open.

Parameters:

$i int

Returns:: DatabaseBase|bool False on failure

Definition at line 387 of file LoadBalancer.php.

References as, and empty.

Referenced by doWait(), getMasterPos(), getMaxLag(), isOpen(), and waitFor().

& LoadBalancer::getConnection	(	$	i,
		$	groups = `array()`,
		$	wiki = `false`
	)

Get a connection by index This is the main entry point for this class.

Parameters:

	$i	Integer: server index
array	$groups	query groups
bool \| string	$wiki	Wiki ID

Exceptions:

MWException

Returns:: DatabaseBase

Definition at line 442 of file LoadBalancer.php.

References as, getReaderIndex(), getServerName(), getWriterIndex(), openConnection(), reportConnectionError(), wfDebug(), wfProfileIn(), wfProfileOut(), and wfWikiID().

LoadBalancer::getLaggedSlaveMode ( )

Returns:: bool

Definition at line 926 of file LoadBalancer.php.

LoadBalancer::getLagTimes ( $ wiki = false )

Get lag time for each server Results are cached for a short time in memcached, and indefinitely in the process cache.

Parameters:

$wiki

Returns:: array

Definition at line 1021 of file LoadBalancer.php.

References array(), getLoadMonitor(), and getServerCount().

Referenced by getRandomNonLagged().

LoadBalancer::getLoadMonitor ( )

Get a LoadMonitor instance.

Returns:: LoadMonitor

Definition at line 99 of file LoadBalancer.php.

Referenced by getLagTimes(), and getReaderIndex().

LoadBalancer::getMasterPos ( )

Get the current master position for chronology control purposes.

Returns:: mixed

Definition at line 809 of file LoadBalancer.php.

References getAnyOpenConnection(), and wfDebug().

LoadBalancer::getMaxLag ( $ wiki = false )

Get the hostname and lag time of the most-lagged slave.

This is useful for maintenance scripts that need to throttle their updates. May attempt to open connections to slaves on the default DB. If there is no lag, the maximum lag will be reported as -1.

Parameters:

string $wiki Wiki ID, or false for the default database

Returns:: array ( host, max lag, index of max lagged host )

Definition at line 986 of file LoadBalancer.php.

References array(), as, getAnyOpenConnection(), getServerCount(), and openConnection().

LoadBalancer::getRandomNonLagged	(	$	loads,
		$	wiki = `false`
	)

Parameters:

$loads	array
$wiki	bool

Returns:: bool|int|string

Definition at line 135 of file LoadBalancer.php.

References as, getLagTimes(), pickRandom(), and wfDebugLog().

Referenced by getReaderIndex().

LoadBalancer::getReaderIndex	(	$	group = `false`,
		$	wiki = `false`
	)

Get the index of the reader connection, which may be a slave This takes into account load ratios and lag times.

It should always return a consistent index during a given invocation

Side effect: opens connections to databases

Parameters:

$group	bool
$wiki	bool

Exceptions:

MWException

Returns:: bool|int|string

Definition at line 184 of file LoadBalancer.php.

References doWait(), getLoadMonitor(), getRandomNonLagged(), getWriterIndex(), global, openConnection(), pickRandom(), reuseConnection(), sleep(), wfDebug(), wfDebugLog(), wfProfileIn(), and wfProfileOut().

Referenced by getConnection().

LoadBalancer::getServerCount ( )

Get the number of defined servers (not the number of open connections)

Returns:: int

Definition at line 763 of file LoadBalancer.php.

Referenced by getLagTimes(), getMaxLag(), and safeGetLag().

LoadBalancer::getServerInfo ( $ i )

Return the server info structure for a given index, or false if the index is invalid.

Parameters:

$i

Returns:: bool

Definition at line 788 of file LoadBalancer.php.

LoadBalancer::getServerName ( $ i )

Get the host name or IP address of the server with the specified index Prefer a readable name if available.

Parameters:

$i

Returns:: string

Definition at line 773 of file LoadBalancer.php.

Referenced by getConnection().

LoadBalancer::getWriterIndex ( )

Returns:: int

Definition at line 734 of file LoadBalancer.php.

Referenced by commitMasterChanges(), getConnection(), and getReaderIndex().

LoadBalancer::haveIndex ( $ i )

Returns true if the specified index is a valid server index.

Parameters:

$i

Returns:: bool

Definition at line 744 of file LoadBalancer.php.

LoadBalancer::isNonZeroLoad ( $ i )

Returns true if the specified index is valid and has non-zero load.

Parameters:

$i

Returns:: bool

Definition at line 754 of file LoadBalancer.php.

LoadBalancer::isOpen ( $ index )

Test if the specified index represents an open connection.

Parameters:

$index Integer: server index private

Returns:: bool

Definition at line 664 of file LoadBalancer.php.

References getAnyOpenConnection().

LoadBalancer::openConnection	(	$	i,
		$	wiki = `false`
	)

Open a connection to the server given by the specified index Index must be an actual index into the array.

If the server is already open, returns it.

On error, returns false, and the connection which caused the error will be available via $this->mErrorConnection.

Parameters:

	$i	Integer server index
string	$wiki	wiki ID to open

Returns:: DatabaseBase

private

Definition at line 558 of file LoadBalancer.php.

References openForeignConnection(), reallyOpenConnection(), wfDebug(), wfProfileIn(), and wfProfileOut().

Referenced by doWait(), getConnection(), getMaxLag(), and getReaderIndex().

LoadBalancer::openForeignConnection	(	$	i,
		$	wiki
	)

Open a connection to a foreign DB, or return one if it is already open.

Increments a reference count on the returned connection which locks the connection to the requested wiki. This reference count can be decremented by calling reuseConnection().

If a connection is open to the appropriate server already, but with the wrong database, it will be switched to the right database and returned, as long as it has been freed first with reuseConnection().

On error, returns false, and the connection which caused the error will be available via $this->mErrorConnection.

Parameters:

	$i	Integer: server index
string	$wiki	wiki ID to open

Returns:: DatabaseBase

Definition at line 602 of file LoadBalancer.php.

References empty, key, list, reallyOpenConnection(), wfDebug(), wfHostname(), wfProfileIn(), wfProfileOut(), and wfSplitWikiID().

Referenced by openConnection().

LoadBalancer::parentInfo ( $ x = null )

Get or set arbitrary data used by the parent object, usually an LBFactory.

Parameters:

$x

Returns:: Mixed

Definition at line 112 of file LoadBalancer.php.

References wfSetVar().

LoadBalancer::pickRandom ( $ weights )

Given an array of non-normalised probabilities, this function will select an element and return the appropriate key.

Deprecated:: 1.21, use ArrayUtils::pickRandom()

Parameters:

$weights array

Returns:: bool|int|string

Definition at line 126 of file LoadBalancer.php.

Referenced by getRandomNonLagged(), and getReaderIndex().

LoadBalancer::pingAll ( )

Returns:: bool

Definition at line 946 of file LoadBalancer.php.

References $success, and as.

LoadBalancer::reallyOpenConnection	(	$	server,
		$	dbNameOverride = `false`
	)

Really opens a connection.

Uncached. Returns a Database object whether or not the connection was successful. private

Parameters:

$server
$dbNameOverride	bool

Exceptions:

MWException

Returns:: DatabaseBase

Reimplemented in LoadBalancer_Single.

Definition at line 681 of file LoadBalancer.php.

References DatabaseBase\factory().

Referenced by openConnection(), and openForeignConnection().

LoadBalancer::reportConnectionError ( ) [private]

Exceptions:

DBConnectionError

Returns:: bool

Definition at line 714 of file LoadBalancer.php.

References wfLogDBError().

Referenced by getConnection().

LoadBalancer::reuseConnection ( $ conn )

Mark a foreign connection as being available for reuse under a different DB name or prefix.

This mechanism is reference-counted, and must be called the same number of times as getConnection() to work.

Parameters:

DatabaseBase $conn

Exceptions:

MWException

Definition at line 507 of file LoadBalancer.php.

References wfDebug().

Referenced by getReaderIndex().

LoadBalancer::safeGetLag ( $ conn )

Get the lag in seconds for a given connection, or zero if this load balancer does not have replication enabled.

This should be used in preference to Database::getLag() in cases where replication may not be in use, since there is no way to determine if replication is in use at the connection level without running potentially restricted queries such as SHOW SLAVE STATUS. Using this function instead of Database::getLag() avoids a fatal error in this case on many installations.

Parameters:

$conn DatabaseBase

Returns:: int

Definition at line 1052 of file LoadBalancer.php.

References getServerCount().

LoadBalancer::setServerInfo	(	$	i,
		$	serverInfo
	)

Sets the server info structure for the given index.

Entry at index $i is created if it doesn't exist

Parameters:

$i
$serverInfo

Definition at line 801 of file LoadBalancer.php.

LoadBalancer::sleep ( $ t )

Wait for a specified number of microseconds, and return the period waited.

Parameters:

$t int

Returns:: int

Definition at line 339 of file LoadBalancer.php.

References $t, wfDebug(), wfProfileIn(), and wfProfileOut().

Referenced by getReaderIndex().

LoadBalancer::waitFor ( $ pos )

Set the master wait position If a DB_SLAVE connection has been opened already, waits Otherwise sets a variable telling it to wait if such a connection is opened.

Parameters:

$pos int

Definition at line 353 of file LoadBalancer.php.

References doWait(), getAnyOpenConnection(), wfProfileIn(), and wfProfileOut().

LoadBalancer::waitForAll ( $ pos )

Set the master wait position and wait for ALL slaves to catch up to it.

Parameters:

$pos int

Definition at line 371 of file LoadBalancer.php.

References doWait(), wfProfileIn(), and wfProfileOut().

LoadBalancer::waitTimeout ( $ value = null )

Parameters:

$value null

Returns:: Mixed

Definition at line 919 of file LoadBalancer.php.

References $value, and wfSetVar().

Member Data Documentation

LoadBalancer::$mAllowLagged

Definition at line 33 of file LoadBalancer.php.

LoadBalancer::$mConns

Definition at line 31 of file LoadBalancer.php.

LoadBalancer::$mErrorConnection [private]

Definition at line 32 of file LoadBalancer.php.

LoadBalancer::$mGroupLoads

Definition at line 31 of file LoadBalancer.php.

LoadBalancer::$mLaggedSlaveMode [private]

Definition at line 35 of file LoadBalancer.php.

LoadBalancer::$mLagTimes

Definition at line 36 of file LoadBalancer.php.

LoadBalancer::$mLastError = 'Unknown error'

Definition at line 35 of file LoadBalancer.php.

LoadBalancer::$mLoadMonitor

Definition at line 37 of file LoadBalancer.php.

LoadBalancer::$mLoadMonitorClass [private]

Definition at line 37 of file LoadBalancer.php.

LoadBalancer::$mLoads

Definition at line 31 of file LoadBalancer.php.

LoadBalancer::$mParentInfo [private]

Definition at line 36 of file LoadBalancer.php.

LoadBalancer::$mReadIndex [private]

Definition at line 33 of file LoadBalancer.php.

LoadBalancer::$mServers [private]

Definition at line 31 of file LoadBalancer.php.

LoadBalancer::$mWaitForPos [private]

Definition at line 34 of file LoadBalancer.php.

LoadBalancer::$mWaitTimeout

Definition at line 34 of file LoadBalancer.php.

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

includes/db/LoadBalancer.php

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation