An interface for generating database load balancers. More...

Inheritance diagram for Wikimedia\Rdbms\LBFactory:

[legend]

Collaboration diagram for Wikimedia\Rdbms\LBFactory:

[legend]

Public Member Functions
	__construct (array $conf)
	Construct a manager of ILoadBalancer objects.

	__destruct ()

	appendShutdownCPIndexAsQuery ( $url, $index)
	Append ?cpPosIndex parameter to a URL for ChronologyProtector purposes if needed.

	beginMasterChanges ( $fname=__METHOD__)
	Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set)

	closeAll ()
	Close all open database connections on all open load balancers.

	commitAll ( $fname=__METHOD__, array $options=[])
	Commit open transactions on all connections.

	commitAndWaitForReplication ( $fname, $ticket, array $opts=[])
	Convenience method for safely running commitMasterChanges()/waitForReplication()

	commitMasterChanges ( $fname=__METHOD__, array $options=[])
	Commit changes on all master connections.

	destroy ()
	Disables all load balancers.

	disableChronologyProtection ()
	Disable the ChronologyProtector for all load balancers.

	flushReplicaSnapshots ( $fname=__METHOD__)
	Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot.

	getChronologyProtectorTouched ( $dbName)

	getEmptyTransactionTicket ( $fname)
	Get a token asserting that no transaction writes are active.

	getExternalLB ( $cluster)

	getMainLB ( $domain=false)

	hasMasterChanges ()
	Determine if any master connection has pending changes.

	hasOrMadeRecentMasterChanges ( $age=null)
	Determine if any master connection has pending/written changes from this request.

	hasTransactionRound ()
	Check if a transaction round is active.

	laggedReplicaUsed ()
	Detemine if any lagged replica DB connection was used.

	newExternalLB ( $cluster)

	newMainLB ( $domain=false)

	rollbackMasterChanges ( $fname=__METHOD__)
	Rollback changes on all master connections.

	setAgentName ( $agent)

	setDomainPrefix ( $prefix)
	Set a new table prefix for the existing local domain ID for testing.

	setIndexAliases (array $aliases)
	Convert certain index names to alternative names before querying the DB.

	setRequestInfo (array $info)

	setTableAliases (array $aliases)
	Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.

	setWaitForReplicationListener ( $name, callable $callback=null)
	Add a callback to be run in every call to waitForReplication() before waiting.

	shutdown ( $mode=self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback=null, &$cpIndex=null)
	Prepare all tracked load balancers for shutdown.

	waitForReplication (array $opts=[])
	Waits for the replica DBs to catch up to the current master position.

Public Member Functions inherited from Wikimedia\Rdbms\ILBFactory
	forEachLB ( $callback, array $params=[])
	Execute a function for each tracked load balancer The callback is called with the load balancer as the first parameter, and $params passed as the subsequent parameters.

	getAllExternalLBs ()
	Get cached (tracked) load balancers for all external database clusters.

	getAllMainLBs ()
	Get cached (tracked) load balancers for all main database clusters.

Protected Member Functions
	baseLoadBalancerParams ()
	Base parameters to LoadBalancer::__construct()

	forEachLBCallMethod ( $methodName, array $args=[])
	Call a method of each tracked load balancer.

	getChronologyProtector ()

	getScopedPHPBehaviorForCommit ()
	Make PHP ignore user aborts/disconnects until the returned value leaves scope.

	initLoadBalancer (ILoadBalancer $lb)

	shutdownChronologyProtector (ChronologyProtector $cp, $workCallback, $mode, &$cpIndex=null)
	Get and record all of the staged DB positions into persistent memory storage.

Protected Attributes
string	$agent
	Agent name for query profiling.

ChronologyProtector	$chronProt

bool	$cliMode
	Whether this PHP instance is for a CLI script.

LoggerInterface	$connLogger

callable	$deprecationLogger
	Deprecation logger.

callable	$errorLogger
	Error logger.

string	$hostname
	Local hostname of the app server.

string[]	$indexAliases = []
	Map of (index alias => index)

DatabaseDomain	$localDomain
	Local domain.

BagOStuff	$memStash

LoggerInterface	$perfLogger

object string	$profiler
	Class name or object With profileIn/profileOut methods.

LoggerInterface	$queryLogger

string bool	$readOnlyReason = false
	Reason all LBs are read-only or false if not.

callable[]	$replicationWaitCallbacks = []

LoggerInterface	$replLogger

array	$requestInfo
	Web request information about the client.

BagOStuff	$srvCache

	$tableAliases = []

mixed	$ticket

TransactionProfiler	$trxProfiler

string bool	$trxRoundId = false
	String if a requested DBO_TRX transaction round is active.

WANObjectCache	$wanCache

Private Member Functions
	logIfMultiDbTransaction ()
	Log query info if multi DB transactions are going to be committed now.

Static Private Attributes
static	$loggerFields

Additional Inherited Members
Public Attributes inherited from Wikimedia\Rdbms\ILBFactory
const	SHUTDOWN_CHRONPROT_ASYNC = 1

const	SHUTDOWN_CHRONPROT_SYNC = 2

const	SHUTDOWN_NO_CHRONPROT = 0

Detailed Description

An interface for generating database load balancers.

Definition at line 39 of file LBFactory.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\LBFactory::__construct ( array $conf )

Construct a manager of ILoadBalancer objects.

Sub-classes will extend the required keys in $conf with additional parameters

Parameters

array

$conf

Array with keys:

localDomain: A DatabaseDomain or domain ID string.
readOnlyReason: Reason the master DB is read-only if so [optional]
srvCache: BagOStuff object for server cache [optional]
memStash: BagOStuff object for cross-datacenter memory storage [optional]
wanCache: WANObjectCache object [optional]
hostname: The name of the current server [optional]
cliMode: Whether the execution context is a CLI script. [optional]
profiler: Class name or instance with profileIn()/profileOut() methods. [optional]
trxProfiler: TransactionProfiler instance. [optional]
replLogger: PSR-3 logger instance. [optional]
connLogger: PSR-3 logger instance. [optional]
queryLogger: PSR-3 logger instance. [optional]
perfLogger: PSR-3 logger instance. [optional]
errorLogger: Callback that takes an Exception and logs it. [optional]
deprecationLogger: Callback to log a deprecation warning. [optional]

Exceptions

InvalidArgumentException

Implements Wikimedia\Rdbms\ILBFactory.

Reimplemented in Wikimedia\Rdbms\LBFactoryMulti, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactorySingle.

Definition at line 94 of file LBFactory.php.

References $e, Wikimedia\Rdbms\DatabaseDomain\newFromId(), and Wikimedia\Rdbms\DatabaseDomain\newUnspecified().

◆ __destruct()

Wikimedia\Rdbms\LBFactory::__destruct ( )

Definition at line 621 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\destroy().

Member Function Documentation

◆ appendShutdownCPIndexAsQuery()

Wikimedia\Rdbms\LBFactory::appendShutdownCPIndexAsQuery	(		$url,
			$time )

Append ?cpPosIndex parameter to a URL for ChronologyProtector purposes if needed.

Note that unlike cookies, this works accross domains

Parameters

string	$url
float	$time	UNIX timestamp just before shutdown() was called

Returns: string

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 583 of file LBFactory.php.

References Wikimedia\Rdbms\ILBFactory\forEachLB(), and Wikimedia\Rdbms\ILoadBalancer\getServerCount().

◆ baseLoadBalancerParams()

Wikimedia\Rdbms\LBFactory::baseLoadBalancerParams ( )

finalprotected

Base parameters to LoadBalancer::__construct()

Returns: array

Definition at line 519 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactorySingle\__construct(), Wikimedia\Rdbms\LBFactoryMulti\newLoadBalancer(), and Wikimedia\Rdbms\LBFactorySimple\newLoadBalancer().

◆ beginMasterChanges()

Wikimedia\Rdbms\LBFactory::beginMasterChanges ( $fname = __METHOD__ )

Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set)

The DBO_TRX setting will be reverted to the default in each of these methods:

commitMasterChanges()
rollbackMasterChanges()
commitAll()

This allows for custom transaction rounds from any outer transaction scope.

Parameters

string $fname

Exceptions

DBTransactionError

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 214 of file LBFactory.php.

References $fname, and Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

Referenced by Wikimedia\Rdbms\LBFactory\commitAndWaitForReplication().

◆ closeAll()

Wikimedia\Rdbms\LBFactory::closeAll ( )

Close all open database connections on all open load balancers.

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 575 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

◆ commitAll()

Wikimedia\Rdbms\LBFactory::commitAll	(		$fname = __METHOD__,
		array	$options = [] )

Commit open transactions on all connections.

This is useful for two main cases:

a) To commit changes to the masters.
b) To release the snapshot on all connections, master and replica DBs.
Parameters

string $fname Caller name

array $options Options map:
maxWriteDuration: abort if more than this much time was spent in write queries

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 209 of file LBFactory.php.

References $fname, $options, Wikimedia\Rdbms\LBFactory\commitMasterChanges(), and Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

◆ commitAndWaitForReplication()

Wikimedia\Rdbms\LBFactory::commitAndWaitForReplication	(		$fname,
			$ticket,
		array	$opts = [] )

Convenience method for safely running commitMasterChanges()/waitForReplication()

This will commit and wait unless $ticket indicates it is unsafe to do so

Parameters

string	$fname	Caller name (e.g. METHOD)
mixed	$ticket	Result of getEmptyTransactionTicket()
array	$opts	Options to waitForReplication()

Exceptions

DBReplicationWaitError

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 411 of file LBFactory.php.

References $fname, Wikimedia\Rdbms\LBFactory\$ticket, Wikimedia\Rdbms\LBFactory\$trxRoundId, Wikimedia\Rdbms\LBFactory\beginMasterChanges(), Wikimedia\Rdbms\LBFactory\commitMasterChanges(), and Wikimedia\Rdbms\LBFactory\waitForReplication().

◆ commitMasterChanges()

Wikimedia\Rdbms\LBFactory::commitMasterChanges	(		$fname = __METHOD__,
		array	$options = [] )

Commit changes on all master connections.

Parameters

string	$fname	Caller name
array	$options	Options map: maxWriteDuration: abort if more than this much time was spent in write queries

Exceptions

DBTransactionError

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 226 of file LBFactory.php.

References $e, $fname, $options, Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\LBFactory\forEachLBCallMethod(), Wikimedia\Rdbms\LBFactory\getScopedPHPBehaviorForCommit(), Wikimedia\Rdbms\LBFactory\logIfMultiDbTransaction(), and Wikimedia\Rdbms\ILoadBalancer\runMasterPostTrxCallbacks().

Referenced by Wikimedia\Rdbms\LBFactory\commitAll(), Wikimedia\Rdbms\LBFactory\commitAndWaitForReplication(), and Wikimedia\Rdbms\LBFactory\shutdown().

◆ destroy()

Wikimedia\Rdbms\LBFactory::destroy ( )

Disables all load balancers.

All connections are closed, and any attempt to open a new connection will result in a DBAccessError.

See also: ILoadBalancer::disable()

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 144 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\forEachLBCallMethod(), and Wikimedia\Rdbms\LBFactory\shutdown().

Referenced by Wikimedia\Rdbms\LBFactory\__destruct().

◆ disableChronologyProtection()

Wikimedia\Rdbms\LBFactory::disableChronologyProtection ( )

Disable the ChronologyProtector for all load balancers.

This can be called at the start of special API entry points

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 441 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\getChronologyProtector().

◆ flushReplicaSnapshots()

Wikimedia\Rdbms\LBFactory::flushReplicaSnapshots ( $fname = __METHOD__ )

Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot.

Parameters

string $fname Caller name

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 205 of file LBFactory.php.

References $fname, and Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

◆ forEachLBCallMethod()

Wikimedia\Rdbms\LBFactory::forEachLBCallMethod	(		$methodName,
		array	$args = [] )

protected

Call a method of each tracked load balancer.

Parameters

string	$methodName
array	$args

Definition at line 196 of file LBFactory.php.

References $args, and Wikimedia\Rdbms\ILBFactory\forEachLB().

Referenced by Wikimedia\Rdbms\LBFactory\beginMasterChanges(), Wikimedia\Rdbms\LBFactory\closeAll(), Wikimedia\Rdbms\LBFactory\commitAll(), Wikimedia\Rdbms\LBFactory\commitMasterChanges(), Wikimedia\Rdbms\LBFactory\destroy(), Wikimedia\Rdbms\LBFactory\flushReplicaSnapshots(), and Wikimedia\Rdbms\LBFactory\rollbackMasterChanges().

◆ getChronologyProtector()

Wikimedia\Rdbms\LBFactory::getChronologyProtector ( )

protected

Returns: ChronologyProtector

Definition at line 448 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$chronProt.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams(), Wikimedia\Rdbms\LBFactory\disableChronologyProtection(), Wikimedia\Rdbms\LBFactory\getChronologyProtectorTouched(), and Wikimedia\Rdbms\LBFactory\shutdown().

◆ getChronologyProtectorTouched()

Wikimedia\Rdbms\LBFactory::getChronologyProtectorTouched ( $dbName )

Parameters

string $dbName DB master name (e.g. "db1052")

Returns: float|bool UNIX timestamp when client last touched the DB or false if not recent

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 437 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\getChronologyProtector().

◆ getEmptyTransactionTicket()

Wikimedia\Rdbms\LBFactory::getEmptyTransactionTicket ( $fname )

Get a token asserting that no transaction writes are active.

Parameters

string $fname Caller name (e.g. METHOD)

Returns: mixed A value to pass to commitAndWaitForReplication()

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 400 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$ticket, and Wikimedia\Rdbms\LBFactory\hasMasterChanges().

◆ getExternalLB()

Wikimedia\Rdbms\LBFactory::getExternalLB ( $cluster )

abstract

See also: ILBFactory::getExternalLB()

Parameters

string $cluster

Returns: LoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Reimplemented in Wikimedia\Rdbms\LBFactoryMulti, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactorySingle.

Referenced by Wikimedia\Rdbms\LBFactory\waitForReplication().

◆ getMainLB()

Wikimedia\Rdbms\LBFactory::getMainLB ( $domain = false )

abstract

See also: ILBFactory::getMainLB()

Parameters

bool $domain

Returns: LoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Reimplemented in Wikimedia\Rdbms\LBFactoryMulti, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactorySingle.

Referenced by Wikimedia\Rdbms\LBFactory\waitForReplication().

◆ getScopedPHPBehaviorForCommit()

Wikimedia\Rdbms\LBFactory::getScopedPHPBehaviorForCommit ( )

finalprotected

Make PHP ignore user aborts/disconnects until the returned value leaves scope.

This returns null and does nothing in CLI mode.

Returns: ScopedCallback|null

Definition at line 610 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\commitMasterChanges().

◆ hasMasterChanges()

Wikimedia\Rdbms\LBFactory::hasMasterChanges ( )

Determine if any master connection has pending changes.

Returns: bool

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 296 of file LBFactory.php.

References $ret, Wikimedia\Rdbms\ILBFactory\forEachLB(), and Wikimedia\Rdbms\ILoadBalancer\hasMasterChanges().

Referenced by Wikimedia\Rdbms\LBFactory\getEmptyTransactionTicket().

◆ hasOrMadeRecentMasterChanges()

Wikimedia\Rdbms\LBFactory::hasOrMadeRecentMasterChanges ( $age = null )

Determine if any master connection has pending/written changes from this request.

Parameters

float $age How many seconds ago is "recent" [defaults to LB lag wait timeout]

Returns: bool

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 314 of file LBFactory.php.

References $ret, Wikimedia\Rdbms\ILBFactory\forEachLB(), and Wikimedia\Rdbms\ILoadBalancer\hasOrMadeRecentMasterChanges().

◆ hasTransactionRound()

Wikimedia\Rdbms\LBFactory::hasTransactionRound ( )

Check if a transaction round is active.

Returns: bool

Since: 1.29

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 269 of file LBFactory.php.

◆ initLoadBalancer()

Wikimedia\Rdbms\LBFactory::initLoadBalancer ( ILoadBalancer $lb )

protected

Parameters

ILoadBalancer $lb

Definition at line 546 of file LBFactory.php.

References Wikimedia\Rdbms\ILoadBalancer\beginMasterChanges(), Wikimedia\Rdbms\ILoadBalancer\setIndexAliases(), and Wikimedia\Rdbms\ILoadBalancer\setTableAliases().

Referenced by Wikimedia\Rdbms\LBFactorySingle\__construct(), Wikimedia\Rdbms\LBFactoryMulti\newLoadBalancer(), and Wikimedia\Rdbms\LBFactorySimple\newLoadBalancer().

◆ laggedReplicaUsed()

Wikimedia\Rdbms\LBFactory::laggedReplicaUsed ( )

Detemine if any lagged replica DB connection was used.

Returns: bool

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 305 of file LBFactory.php.

References $ret, Wikimedia\Rdbms\ILBFactory\forEachLB(), and Wikimedia\Rdbms\ILoadBalancer\laggedReplicaUsed().

◆ logIfMultiDbTransaction()

Wikimedia\Rdbms\LBFactory::logIfMultiDbTransaction ( )

private

Log query info if multi DB transactions are going to be committed now.

Definition at line 276 of file LBFactory.php.

References Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\ILoadBalancer\getServerName(), Wikimedia\Rdbms\ILoadBalancer\getWriterIndex(), and Wikimedia\Rdbms\ILoadBalancer\pendingMasterChangeCallers().

Referenced by Wikimedia\Rdbms\LBFactory\commitMasterChanges().

◆ newExternalLB()

Wikimedia\Rdbms\LBFactory::newExternalLB ( $cluster )

abstract

See also: ILBFactory::newExternalLB()

Parameters

string $cluster

Returns: LoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Reimplemented in Wikimedia\Rdbms\LBFactoryMulti, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactorySingle.

◆ newMainLB()

Wikimedia\Rdbms\LBFactory::newMainLB ( $domain = false )

abstract

See also: ILBFactory::newMainLB()

Parameters

bool $domain

Returns: LoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Reimplemented in Wikimedia\Rdbms\LBFactoryMulti, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactorySingle.

◆ rollbackMasterChanges()

Wikimedia\Rdbms\LBFactory::rollbackMasterChanges ( $fname = __METHOD__ )

Rollback changes on all master connections.

Parameters

string $fname Caller name

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 259 of file LBFactory.php.

References $fname, Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\LBFactory\forEachLBCallMethod(), and Wikimedia\Rdbms\ILoadBalancer\runMasterPostTrxCallbacks().

◆ setAgentName()

Wikimedia\Rdbms\LBFactory::setAgentName ( $agent )

Parameters

string $agent Agent name for query profiling

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 579 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$agent.

◆ setDomainPrefix()

Wikimedia\Rdbms\LBFactory::setDomainPrefix ( $prefix )

Set a new table prefix for the existing local domain ID for testing.

Parameters

string $prefix

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 563 of file LBFactory.php.

References Wikimedia\Rdbms\ILBFactory\forEachLB(), and Wikimedia\Rdbms\ILoadBalancer\setDomainPrefix().

◆ setIndexAliases()

Wikimedia\Rdbms\LBFactory::setIndexAliases ( array $aliases )

Convert certain index names to alternative names before querying the DB.

Note that this applies to indexes regardless of the table they belong to.

This can be employed when an index was renamed X => Y in code, but the new Y-named indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA, the aliases can be removed, and then the old X-named indexes dropped.

Parameters

string[] $aliases

Returns: mixed

Since: 1.31

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 559 of file LBFactory.php.

◆ setRequestInfo()

Wikimedia\Rdbms\LBFactory::setRequestInfo ( array $info )

Parameters

array

$info

Map of fields, including:

IPAddress : IP address
UserAgent : User-Agent HTTP header
ChronologyProtection : cookie/header value specifying ChronologyProtector usage
ChronologyPositionIndex: timestamp used to get up-to-date DB positions for the agent

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 596 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$requestInfo.

◆ setTableAliases()

Wikimedia\Rdbms\LBFactory::setTableAliases ( array $aliases )

Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.

For example, "user" can be converted to "myschema.mydbname.user" for convenience. Appearances like user, somedb.user, somedb.someschema.user will used literally.

Calling this twice will completely clear any old table aliases. Also, note that callers are responsible for making sure the schemas and databases actually exist.

Parameters

array[] $aliases Map of (table => (dbname, schema, prefix) map)

Since: 1.31

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 555 of file LBFactory.php.

◆ setWaitForReplicationListener()

Wikimedia\Rdbms\LBFactory::setWaitForReplicationListener	(		$name,
		callable	$callback = null )

Add a callback to be run in every call to waitForReplication() before waiting.

Callbacks must clear any transactions that they start

Parameters

string	$name	Callback name
callable \| null	$callback	Use null to unset a callback

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 392 of file LBFactory.php.

References $name.

◆ shutdown()

Wikimedia\Rdbms\LBFactory::shutdown	(		$mode = self::SHUTDOWN_CHRONPROT_SYNC,
		callable	$workCallback = null,
		&	$cpIndex = null )

Prepare all tracked load balancers for shutdown.

Parameters

int	$mode	One of the class SHUTDOWN_* constants
callable \| null	$workCallback	Work to mask ChronologyProtector writes
int \| null	&$cpIndex	Position key write counter for ChronologyProtector

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 149 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$chronProt, Wikimedia\Rdbms\LBFactory\commitMasterChanges(), Wikimedia\Rdbms\LBFactory\getChronologyProtector(), and Wikimedia\Rdbms\LBFactory\shutdownChronologyProtector().

Referenced by Wikimedia\Rdbms\LBFactory\destroy().

◆ shutdownChronologyProtector()

Wikimedia\Rdbms\LBFactory::shutdownChronologyProtector	(	ChronologyProtector	$cp,
			$workCallback,
			$mode,
		&	$cpIndex = null )

protected

Get and record all of the staged DB positions into persistent memory storage.

Parameters

ChronologyProtector	$cp
callable \| null	$workCallback	Work to do instead of waiting on syncing positions
string	$mode	One of (sync, async); whether to wait on remote datacenters
int \| null	&$cpIndex	DB position key write counter; incremented on update

Definition at line 489 of file LBFactory.php.

References Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\ILoadBalancer\getServerName(), Wikimedia\Rdbms\ILoadBalancer\getWriterIndex(), and Wikimedia\Rdbms\ILoadBalancer\waitForAll().

Referenced by Wikimedia\Rdbms\LBFactory\shutdown().

◆ waitForReplication()

Wikimedia\Rdbms\LBFactory::waitForReplication ( array $opts = [] )

Waits for the replica DBs to catch up to the current master position.

Use this when updating very large numbers of rows, as in maintenance scripts, to avoid causing too much lag. Of course, this is a no-op if there are no replica DBs.

By default this waits on all DB clusters actually used in this request. This makes sense when lag being waiting on is caused by the code that does this check. In that case, setting "ifWritesSince" can avoid the overhead of waiting for clusters that were not changed since the last wait check. To forcefully wait on a specific cluster for a given domain, use the 'domain' parameter. To forcefully wait on an "external" cluster, use the "cluster" parameter.

Never call this function after a large DB write that is still in a transaction. It only makes sense to call this after the possible lag inducing changes were committed.

Parameters

array

$opts

Optional fields that include:

domain : wait on the load balancer DBs that handles the given domain ID
cluster : wait on the given external load balancer DBs
timeout : Max wait time. Default: ~60 seconds
ifWritesSince: Only wait if writes were done since this UNIX timestamp

Exceptions

DBReplicationWaitError If a timeout or error occurred waiting on a DB cluster

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 322 of file LBFactory.php.

References Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\LBFactory\getExternalLB(), and Wikimedia\Rdbms\LBFactory\getMainLB().

Referenced by Wikimedia\Rdbms\LBFactory\commitAndWaitForReplication().

Member Data Documentation

◆ $agent

string Wikimedia\Rdbms\LBFactory::$agent

protected

Agent name for query profiling.

Definition at line 89 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams(), and Wikimedia\Rdbms\LBFactory\setAgentName().

◆ $chronProt

ChronologyProtector Wikimedia\Rdbms\LBFactory::$chronProt

protected

Definition at line 41 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\getChronologyProtector(), and Wikimedia\Rdbms\LBFactory\shutdown().

◆ $cliMode

bool Wikimedia\Rdbms\LBFactory::$cliMode

protected

Whether this PHP instance is for a CLI script.

Definition at line 87 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $connLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$connLogger

protected

Definition at line 49 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $deprecationLogger

callable Wikimedia\Rdbms\LBFactory::$deprecationLogger

protected

Deprecation logger.

Definition at line 57 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $errorLogger

callable Wikimedia\Rdbms\LBFactory::$errorLogger

protected

Error logger.

Definition at line 55 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $hostname

string Wikimedia\Rdbms\LBFactory::$hostname

protected

Local hostname of the app server.

Definition at line 68 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $indexAliases

string [] Wikimedia\Rdbms\LBFactory::$indexAliases = []

protected

Map of (index alias => index)

Definition at line 84 of file LBFactory.php.

◆ $localDomain

DatabaseDomain Wikimedia\Rdbms\LBFactory::$localDomain

protected

Local domain.

Definition at line 66 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $loggerFields

Wikimedia\Rdbms\LBFactory::$loggerFields

staticprivate

Initial value:

=

[ 'replLogger', 'connLogger', 'queryLogger', 'perfLogger' ]

Definition at line 91 of file LBFactory.php.

◆ $memStash

BagOStuff Wikimedia\Rdbms\LBFactory::$memStash

protected

Definition at line 61 of file LBFactory.php.

◆ $perfLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$perfLogger

protected

Definition at line 53 of file LBFactory.php.

◆ $profiler

object string Wikimedia\Rdbms\LBFactory::$profiler

protected

Class name or object With profileIn/profileOut methods.

Definition at line 43 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $queryLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$queryLogger

protected

Definition at line 51 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $readOnlyReason

string bool Wikimedia\Rdbms\LBFactory::$readOnlyReason = false

protected

Reason all LBs are read-only or false if not.

Definition at line 77 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams(), Wikimedia\Rdbms\LBFactoryMulti\newLoadBalancer(), and Wikimedia\Rdbms\LBFactoryMulti\newMainLB().

◆ $replicationWaitCallbacks

callable [] Wikimedia\Rdbms\LBFactory::$replicationWaitCallbacks = []

protected

Definition at line 79 of file LBFactory.php.

◆ $replLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$replLogger

protected

Definition at line 47 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $requestInfo

array Wikimedia\Rdbms\LBFactory::$requestInfo

protected

Web request information about the client.

Definition at line 70 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\setRequestInfo().

◆ $srvCache

BagOStuff Wikimedia\Rdbms\LBFactory::$srvCache

protected

Definition at line 59 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $tableAliases

Wikimedia\Rdbms\LBFactory::$tableAliases = []

protected

Definition at line 82 of file LBFactory.php.

◆ $ticket

mixed Wikimedia\Rdbms\LBFactory::$ticket

protected

Definition at line 73 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\commitAndWaitForReplication(), and Wikimedia\Rdbms\LBFactory\getEmptyTransactionTicket().

◆ $trxProfiler

TransactionProfiler Wikimedia\Rdbms\LBFactory::$trxProfiler

protected

Definition at line 45 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

◆ $trxRoundId

string bool Wikimedia\Rdbms\LBFactory::$trxRoundId = false

protected

String if a requested DBO_TRX transaction round is active.

Definition at line 75 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\commitAndWaitForReplication().

◆ $wanCache

WANObjectCache Wikimedia\Rdbms\LBFactory::$wanCache

protected

Definition at line 63 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams().

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

includes/libs/rdbms/lbfactory/LBFactory.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ appendShutdownCPIndexAsQuery()

◆ baseLoadBalancerParams()

◆ beginMasterChanges()

◆ closeAll()

◆ commitAll()

◆ commitAndWaitForReplication()

◆ commitMasterChanges()

◆ destroy()

◆ disableChronologyProtection()

◆ flushReplicaSnapshots()

◆ forEachLBCallMethod()

◆ getChronologyProtector()

◆ getChronologyProtectorTouched()

◆ getEmptyTransactionTicket()

◆ getExternalLB()

◆ getMainLB()

◆ getScopedPHPBehaviorForCommit()

◆ hasMasterChanges()

◆ hasOrMadeRecentMasterChanges()

◆ hasTransactionRound()

◆ initLoadBalancer()

◆ laggedReplicaUsed()

◆ logIfMultiDbTransaction()

◆ newExternalLB()

◆ newMainLB()

◆ rollbackMasterChanges()

◆ setAgentName()

◆ setDomainPrefix()

◆ setIndexAliases()

◆ setRequestInfo()

◆ setTableAliases()

◆ setWaitForReplicationListener()

◆ shutdown()

◆ shutdownChronologyProtector()

◆ waitForReplication()

Member Data Documentation

◆ $agent

◆ $chronProt

◆ $cliMode

◆ $connLogger

◆ $deprecationLogger

◆ $errorLogger

◆ $hostname

◆ $indexAliases

◆ $localDomain

◆ $loggerFields

◆ $memStash

◆ $perfLogger

◆ $profiler

◆ $queryLogger

◆ $readOnlyReason

◆ $replicationWaitCallbacks

◆ $replLogger

◆ $requestInfo

◆ $srvCache

◆ $tableAliases

◆ $ticket

◆ $trxProfiler

◆ $trxRoundId

◆ $wanCache