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 and clear view snapshots 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.

	getChronologyProtectorClientId ()
	Get the client ID of the ChronologyProtector instance.

	getChronologyProtectorTouched ( $dbName)

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

	getLocalDomainID ()
	Get the local (and default) database domain ID of connection handles.

	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 an explicit transaction round is active.

	isReadyForRoundOperations ()
	Check if transaction rounds can be started, committed, or rolled back right now.

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

	redefineLocalDomain ( $domain)
	Close all connection and redefine the local domain for testing or schema creation.

	resolveDomainID ( $domain)

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

	setAgentName ( $agent)

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

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

	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, &$cpClientId=null)
	Prepare all currently tracked (instantiated) 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 currently tracked (instantiated) load balancer.

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

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

	getExternalLB ( $cluster)
	Get a cached (tracked) load balancer for external storage.

	getMainLB ( $domain=false)
	Get a cached (tracked) load balancer object.

	newExternalLB ( $cluster, $owner=null)
	Create a new load balancer for external storage.

	newMainLB ( $domain=false, $owner=null)
	Create a new load balancer object.

Static Public Member Functions
static	getCPInfoFromCookieValue ( $value, $minTimestamp)

static	makeCookieValueFromCPIndex ( $index, $time, $clientId)

Public Attributes
const	ROUND_BEGINNING = 'within-begin'

const	ROUND_COMMIT_CALLBACKS = 'within-commit-callbacks'

const	ROUND_COMMITTING = 'within-commit'

const	ROUND_CURSORY = 'cursory'

const	ROUND_ROLLBACK_CALLBACKS = 'within-rollback-callbacks'

const	ROUND_ROLLING_BACK = 'within-rollback'

Protected Member Functions
	baseLoadBalancerParams ( $owner)
	Get parameters to ILoadBalancer::__construct()

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

	getChronologyProtector ()

	getOwnershipId ()

	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
DatabaseDomain	$localDomain
	Local domain.

int null	$maxLag

BagOStuff	$memStash

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

BagOStuff	$srvCache

WANObjectCache	$wanCache

Private Member Functions
	assertTransactionRoundStage ( $stage)

	executePostTransactionCallbacks ()

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

Private Attributes
string	$agent
	Agent name for query profiling.

ChronologyProtector	$chronProt

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

LoggerInterface	$connLogger

string null	$defaultGroup = null

callable	$deprecationLogger
	Deprecation logger.

callable	$errorLogger
	Error logger.

string	$hostname
	Local hostname of the app server.

	$id
	var int An identifier for this class instance

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

LoggerInterface	$perfLogger

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

LoggerInterface	$queryLogger

callable[]	$replicationWaitCallbacks = []

LoggerInterface	$replLogger

array	$requestInfo
	Web request information about the client.

string	$secret
	Secret string for HMAC hashing.

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

int null	$ticket
	Ticket used to delegate transaction ownership.

TransactionProfiler	$trxProfiler

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

string	$trxRoundStage = self::ROUND_CURSORY
	One of the ROUND_* class constants.

Static Private Attributes
static	$loggerFields

Detailed Description

An interface for generating database load balancers.

Definition at line 40 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]
maxLag: Try to avoid DB replicas with lag above this many seconds [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]
secret: Secret string to use for HMAC hashing [optional]

Exceptions

InvalidArgumentException

Implements Wikimedia\Rdbms\ILBFactory.

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

Definition at line 116 of file LBFactory.php.

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

◆ __destruct()

Wikimedia\Rdbms\LBFactory::__destruct ( )

Definition at line 755 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\destroy().

Member Function Documentation

◆ appendShutdownCPIndexAsQuery()

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

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

Note that unlike cookies, this works across domains

Parameters

string	$url
int	$index	Write counter index

Returns: string

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 674 of file LBFactory.php.

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

◆ assertTransactionRoundStage()

Wikimedia\Rdbms\LBFactory::assertTransactionRoundStage ( $stage )

private

Parameters

string $stage

Definition at line 746 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\beginMasterChanges(), and Wikimedia\Rdbms\LBFactory\commitMasterChanges().

◆ baseLoadBalancerParams()

Wikimedia\Rdbms\LBFactory::baseLoadBalancerParams ( $owner )

finalprotected

Get parameters to ILoadBalancer::__construct()

Parameters

int | null $owner Use getOwnershipId() if this is for getMainLB()/getExternalLB()

Returns: array

Definition at line 585 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__ )

final

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 230 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\assertTransactionRoundStage(), Wikimedia\Rdbms\LBFactory\forEachLBCallMethod(), Wikimedia\Rdbms\LBFactory\ROUND_BEGINNING, and Wikimedia\Rdbms\LBFactory\ROUND_CURSORY.

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

◆ closeAll()

Wikimedia\Rdbms\LBFactory::closeAll ( )

Close all open database connections on all open load balancers.

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 663 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

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

◆ commitAll()

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

final

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 224 of file LBFactory.php.

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

◆ commitAndWaitForReplication()

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

final

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()

Returns: bool True if the wait was successful, false on timeout

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 467 of file LBFactory.php.

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

Referenced by CategoryMembershipChangeJob\notifyUpdatesForRevision().

◆ commitMasterChanges()

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

final

Commit changes and clear view snapshots 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 248 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\assertTransactionRoundStage(), Wikimedia\Rdbms\LBFactory\executePostTransactionCallbacks(), Wikimedia\Rdbms\ILoadBalancer\finalizeMasterChanges(), Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\LBFactory\forEachLBCallMethod(), Wikimedia\Rdbms\LBFactory\logIfMultiDbTransaction(), Wikimedia\Rdbms\LBFactory\ROUND_COMMIT_CALLBACKS, Wikimedia\Rdbms\LBFactory\ROUND_COMMITTING, and Wikimedia\Rdbms\LBFactory\ROUND_CURSORY.

Referenced by Wikimedia\Rdbms\LBFactory\commitAll(), Wikimedia\Rdbms\LBFactory\commitAndWaitForReplication(), JobRunner\commitMasterChanges(), JobRunner\executeJob(), 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 163 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

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 501 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\getChronologyProtector().

◆ executePostTransactionCallbacks()

Wikimedia\Rdbms\LBFactory::executePostTransactionCallbacks ( )

private

Returns: Exception|null

Definition at line 301 of file LBFactory.php.

References Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\LBFactory\hasMasterChanges(), Wikimedia\Rdbms\ILoadBalancer\runMasterTransactionIdleCallbacks(), and Wikimedia\Rdbms\ILoadBalancer\runMasterTransactionListenerCallbacks().

Referenced by Wikimedia\Rdbms\LBFactory\commitMasterChanges(), and Wikimedia\Rdbms\LBFactory\rollbackMasterChanges().

◆ flushReplicaSnapshots()

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

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

This is useful for getting rid of stale data from an implicit transaction round

Parameters

string $fname Caller name

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 214 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

Referenced by JobRunner\executeJob().

◆ 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 205 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 508 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$chronProt, Wikimedia\Rdbms\LBFactory\$secret, and Wikimedia\Rdbms\ChronologyProtector\setLogger().

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

◆ getChronologyProtectorClientId()

Wikimedia\Rdbms\LBFactory::getChronologyProtectorClientId ( )

Get the client ID of the ChronologyProtector instance.

Returns: string Client ID

Since: 1.34

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 687 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\getChronologyProtector().

◆ 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 497 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\getChronologyProtector().

◆ getCPInfoFromCookieValue()

static Wikimedia\Rdbms\LBFactory::getCPInfoFromCookieValue	(	$value,
		$minTimestamp
	)

static

Parameters

string	$value	Possible result of LBFactory::makeCookieValueFromCPIndex()
int	$minTimestamp	Lowest UNIX timestamp that a non-expired value can have

Returns: array (index: int or null, clientId: string or null)

Since: 1.32

Definition at line 708 of file LBFactory.php.

◆ 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 454 of file LBFactory.php.

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

◆ getLocalDomainID()

Wikimedia\Rdbms\LBFactory::getLocalDomainID ( )

Get the local (and default) database domain ID of connection handles.

See also: DatabaseDomain

Returns: string Database domain ID; this specifies DB name, schema, and table prefix

Since: 1.32

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 170 of file LBFactory.php.

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

◆ getOwnershipId()

Wikimedia\Rdbms\LBFactory::getOwnershipId ( )

finalprotected

Returns: int Internal instance ID used to assert ownership of ILoadBalancer instances

Since: 1.34

Definition at line 739 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$id.

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

◆ hasMasterChanges()

Wikimedia\Rdbms\LBFactory::hasMasterChanges ( )

Determine if any master connection has pending changes.

Returns: bool

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 351 of file LBFactory.php.

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

Referenced by Wikimedia\Rdbms\LBFactory\executePostTransactionCallbacks(), and 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 | null $age How many seconds ago is "recent" [defaults to LB lag wait timeout]

Returns: bool

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 369 of file LBFactory.php.

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

◆ hasTransactionRound()

Wikimedia\Rdbms\LBFactory::hasTransactionRound ( )

Check if an explicit transaction round is active.

Returns: bool

Since: 1.29

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 320 of file LBFactory.php.

◆ initLoadBalancer()

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

protected

Parameters

ILoadBalancer $lb

Definition at line 624 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().

◆ isReadyForRoundOperations()

Wikimedia\Rdbms\LBFactory::isReadyForRoundOperations ( )

Check if transaction rounds can be started, committed, or rolled back right now.

This can be used as a recusion guard to avoid exceptions in transaction callbacks

Returns: bool

Since: 1.32

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 324 of file LBFactory.php.

◆ laggedReplicaUsed()

Wikimedia\Rdbms\LBFactory::laggedReplicaUsed ( )

Detemine if any lagged replica DB connection was used.

Returns: bool

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 360 of file LBFactory.php.

References 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 331 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().

◆ makeCookieValueFromCPIndex()

static Wikimedia\Rdbms\LBFactory::makeCookieValueFromCPIndex	(	$index,
		$time,
		$clientId
	)

static

Parameters

int	$index	Write index
int	$time	UNIX timestamp; can be used to detect stale cookies (T190082)
string	$clientId	Agent ID hash from ILBFactory::shutdown()

Returns: string Timestamp-qualified write index of the form "<index>@<timestamp>#<hash>"

Since: 1.32

Definition at line 698 of file LBFactory.php.

◆ redefineLocalDomain()

Wikimedia\Rdbms\LBFactory::redefineLocalDomain ( $domain )

Close all connection and redefine the local domain for testing or schema creation.

Parameters

DatabaseDomain | string $domain

Since: 1.33

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 653 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\closeAll(), Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\DatabaseDomain\newFromId(), and Wikimedia\Rdbms\ILoadBalancer\redefineLocalDomain().

◆ resolveDomainID()

Wikimedia\Rdbms\LBFactory::resolveDomainID ( $domain )

Parameters

DatabaseDomain | string | bool $domain Database domain

Returns: string Value of $domain if provided or the local domain otherwise

Since: 1.32

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 174 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\getLocalDomainID().

◆ rollbackMasterChanges()

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

final

Rollback changes on all master connections.

Parameters

string $fname Caller name

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 284 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\executePostTransactionCallbacks(), Wikimedia\Rdbms\LBFactory\forEachLBCallMethod(), Wikimedia\Rdbms\LBFactory\ROUND_CURSORY, Wikimedia\Rdbms\LBFactory\ROUND_ROLLBACK_CALLBACKS, and Wikimedia\Rdbms\LBFactory\ROUND_ROLLING_BACK.

Referenced by DeferredUpdates\jobify(), and DeferredUpdates\run().

◆ setAgentName()

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

Parameters

string $agent Agent name for query profiling

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 670 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$agent.

◆ 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

Since: 1.31

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 637 of file LBFactory.php.

◆ setLocalDomainPrefix()

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

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

Parameters

string $prefix

Since: 1.33

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 641 of file LBFactory.php.

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

◆ 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 727 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 633 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 446 of file LBFactory.php.

◆ shutdown()

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

Prepare all currently tracked (instantiated) 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
string \| null	&$cpClientId	Client ID hash for ChronologyProtector

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 178 of file LBFactory.php.

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

◆ 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 553 of file LBFactory.php.

References Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\ILoadBalancer\getServerName(), Wikimedia\Rdbms\ILoadBalancer\getWriterIndex(), Wikimedia\Rdbms\ChronologyProtector\shutdown(), Wikimedia\Rdbms\ChronologyProtector\storeSessionReplicationPosition(), 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 for CLI, 1 second for web.
ifWritesSince: Only wait if writes were done since this UNIX timestamp

Returns: bool True on success, false if a timeout or error occurred while waiting

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 377 of file LBFactory.php.

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

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

Member Data Documentation

◆ $agent

string Wikimedia\Rdbms\LBFactory::$agent

private

Agent name for query profiling.

Definition at line 77 of file LBFactory.php.

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

◆ $chronProt

ChronologyProtector Wikimedia\Rdbms\LBFactory::$chronProt

private

Definition at line 42 of file LBFactory.php.

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

◆ $cliMode

bool Wikimedia\Rdbms\LBFactory::$cliMode

private

Whether this PHP instance is for a CLI script.

Definition at line 75 of file LBFactory.php.

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

◆ $connLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$connLogger

private

Definition at line 50 of file LBFactory.php.

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

◆ $defaultGroup

string null Wikimedia\Rdbms\LBFactory::$defaultGroup = null

private

Definition at line 101 of file LBFactory.php.

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

◆ $deprecationLogger

callable Wikimedia\Rdbms\LBFactory::$deprecationLogger

private

Deprecation logger.

Definition at line 58 of file LBFactory.php.

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

◆ $errorLogger

callable Wikimedia\Rdbms\LBFactory::$errorLogger

private

Error logger.

Definition at line 56 of file LBFactory.php.

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

◆ $hostname

string Wikimedia\Rdbms\LBFactory::$hostname

private

Local hostname of the app server.

Definition at line 71 of file LBFactory.php.

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

◆ $id

Wikimedia\Rdbms\LBFactory::$id

private

var int An identifier for this class instance

Definition at line 89 of file LBFactory.php.

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

◆ $indexAliases

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

private

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 68 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 113 of file LBFactory.php.

◆ $maxLag

int null Wikimedia\Rdbms\LBFactory::$maxLag

protected

Definition at line 104 of file LBFactory.php.

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

◆ $memStash

BagOStuff Wikimedia\Rdbms\LBFactory::$memStash

protected

Definition at line 63 of file LBFactory.php.

◆ $perfLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$perfLogger

private

Definition at line 54 of file LBFactory.php.

◆ $profiler

object string Wikimedia\Rdbms\LBFactory::$profiler

private

Class name or object With profileIn/profileOut methods.

Definition at line 44 of file LBFactory.php.

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

◆ $queryLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$queryLogger

private

Definition at line 52 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 98 of file LBFactory.php.

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

◆ $replicationWaitCallbacks

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

private

Definition at line 86 of file LBFactory.php.

◆ $replLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$replLogger

private

Definition at line 48 of file LBFactory.php.

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

◆ $requestInfo

array Wikimedia\Rdbms\LBFactory::$requestInfo

private

Web request information about the client.

Definition at line 73 of file LBFactory.php.

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

◆ $secret

string Wikimedia\Rdbms\LBFactory::$secret

private

Secret string for HMAC hashing.

Definition at line 79 of file LBFactory.php.

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

◆ $srvCache

BagOStuff Wikimedia\Rdbms\LBFactory::$srvCache

protected

Definition at line 61 of file LBFactory.php.

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

◆ $tableAliases

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

private

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

Definition at line 82 of file LBFactory.php.

◆ $ticket

int null Wikimedia\Rdbms\LBFactory::$ticket

private

Ticket used to delegate transaction ownership.

Definition at line 91 of file LBFactory.php.

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

◆ $trxProfiler

TransactionProfiler Wikimedia\Rdbms\LBFactory::$trxProfiler

private

Definition at line 46 of file LBFactory.php.

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

◆ $trxRoundId

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

private

String if a requested DBO_TRX transaction round is active.

Definition at line 93 of file LBFactory.php.

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

◆ $trxRoundStage

string Wikimedia\Rdbms\LBFactory::$trxRoundStage = self::ROUND_CURSORY

private

One of the ROUND_* class constants.

Definition at line 95 of file LBFactory.php.

◆ $wanCache

WANObjectCache Wikimedia\Rdbms\LBFactory::$wanCache

protected

Definition at line 65 of file LBFactory.php.

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

◆ ROUND_BEGINNING

const Wikimedia\Rdbms\LBFactory::ROUND_BEGINNING = 'within-begin'

Definition at line 107 of file LBFactory.php.

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

◆ ROUND_COMMIT_CALLBACKS

const Wikimedia\Rdbms\LBFactory::ROUND_COMMIT_CALLBACKS = 'within-commit-callbacks'

Definition at line 110 of file LBFactory.php.

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

◆ ROUND_COMMITTING

const Wikimedia\Rdbms\LBFactory::ROUND_COMMITTING = 'within-commit'

Definition at line 108 of file LBFactory.php.

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

◆ ROUND_CURSORY

const Wikimedia\Rdbms\LBFactory::ROUND_CURSORY = 'cursory'

Definition at line 106 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\beginMasterChanges(), Wikimedia\Rdbms\LBFactory\commitMasterChanges(), and Wikimedia\Rdbms\LBFactory\rollbackMasterChanges().

◆ ROUND_ROLLBACK_CALLBACKS

const Wikimedia\Rdbms\LBFactory::ROUND_ROLLBACK_CALLBACKS = 'within-rollback-callbacks'

Definition at line 111 of file LBFactory.php.

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

◆ ROUND_ROLLING_BACK

const Wikimedia\Rdbms\LBFactory::ROUND_ROLLING_BACK = 'within-rollback'

Definition at line 109 of file LBFactory.php.

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

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

includes/libs/rdbms/lbfactory/LBFactory.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ appendShutdownCPIndexAsQuery()

◆ assertTransactionRoundStage()

◆ baseLoadBalancerParams()

◆ beginMasterChanges()

◆ closeAll()

◆ commitAll()

◆ commitAndWaitForReplication()

◆ commitMasterChanges()

◆ destroy()

◆ disableChronologyProtection()

◆ executePostTransactionCallbacks()

◆ flushReplicaSnapshots()

◆ forEachLBCallMethod()

◆ getChronologyProtector()

◆ getChronologyProtectorClientId()

◆ getChronologyProtectorTouched()

◆ getCPInfoFromCookieValue()

◆ getEmptyTransactionTicket()

◆ getLocalDomainID()

◆ getOwnershipId()

◆ hasMasterChanges()

◆ hasOrMadeRecentMasterChanges()

◆ hasTransactionRound()

◆ initLoadBalancer()

◆ isReadyForRoundOperations()

◆ laggedReplicaUsed()

◆ logIfMultiDbTransaction()

◆ makeCookieValueFromCPIndex()

◆ redefineLocalDomain()

◆ resolveDomainID()

◆ rollbackMasterChanges()

◆ setAgentName()

◆ setIndexAliases()

◆ setLocalDomainPrefix()

◆ setRequestInfo()

◆ setTableAliases()

◆ setWaitForReplicationListener()

◆ shutdown()

◆ shutdownChronologyProtector()

◆ waitForReplication()

Member Data Documentation

◆ $agent

◆ $chronProt

◆ $cliMode

◆ $connLogger

◆ $defaultGroup

◆ $deprecationLogger

◆ $errorLogger

◆ $hostname

◆ $id

◆ $indexAliases

◆ $localDomain

◆ $loggerFields

◆ $maxLag

◆ $memStash

◆ $perfLogger

◆ $profiler

◆ $queryLogger

◆ $readOnlyReason

◆ $replicationWaitCallbacks

◆ $replLogger

◆ $requestInfo

◆ $secret

◆ $srvCache

◆ $tableAliases

◆ $ticket

◆ $trxProfiler