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 instances.

	__destruct ()

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

	beginMasterChanges ( $fname=__METHOD__)

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

	closeAll ()
	Close all connections on instantiated tracked load balancer instances.

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

	commitAndWaitForReplication ( $fname, $ticket, array $opts=[])
	Call commitPrimaryChanges() and waitForReplication() if $ticket indicates it is safe.

	commitMasterChanges ( $fname=__METHOD__, array $options=[])

	commitPrimaryChanges ( $fname=__METHOD__, array $options=[])
	Commit changes and clear view snapshots on all primary connections.

	destroy ()
	Close all connections and make further attempts to open connections result in DBAccessError.

	disableChronologyProtection ()
	Disable the ChronologyProtector on all instantiated tracked load balancer instances.

	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 ( $domain=false)
	Get the UNIX timestamp when the client last touched the DB, if they did so recently.

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

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

	getTransactionProfiler ()
	Get the TransactionProfiler used by this instance.

	hasMasterChanges ()

	hasOrMadeRecentMasterChanges ( $age=null)

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

	hasPrimaryChanges ()
	Determine if any primary connection has pending changes.

	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 connections and redefine the local domain for testing or schema creation.

	resolveDomainID ( $domain)

	rollbackMasterChanges ( $fname=__METHOD__)

	rollbackPrimaryChanges ( $fname=__METHOD__)
	Rollback changes on all primary connections.

	setAgentName ( $agent)

	setDefaultReplicationWaitTimeout ( $seconds)
	Set the default timeout for replication wait checks.

	setDomainAliases (array $aliases)
	Convert certain database domains to alternative ones.

	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.

	setMockTime (&$time)

	setRequestInfo (array $info)
	Inject HTTP request header/cookie information during setup of this instance.

	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 ( $flags=self::SHUTDOWN_NORMAL, callable $workCallback=null, &$cpIndex=null, &$cpClientId=null)
	Prepare all instantiated tracked load balancer instances for shutdown.

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

Public Member Functions inherited from Wikimedia\Rdbms\ILBFactory
	forEachLB ( $callback, array $params=[])
	Execute a function for each instantiated tracked load balancer instance.

	getAllExternalLBs ()
	Get the tracked load balancer instances for all external clusters.

	getAllMainLBs ()
	Get the tracked load balancer instances for all main clusters.

	getExternalLB ( $cluster)
	Get the tracked load balancer instance for an external cluster.

	getMainLB ( $domain=false)
	Get the tracked load balancer instance for a main cluster.

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

	newMainLB ( $domain=false, $owner=null)
	Create a new load balancer instance for a main cluster.

Static Public Member Functions
static	getCPInfoFromCookieValue (?string $value, int $minTimestamp)
	Parse a string conveying the client and write index of the chronology protector data.

static	makeCookieValueFromCPIndex (int $writeIndex, int $time, string $clientId)
	Build a string conveying the client and write index of the chronology protector data.

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

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

	getChronologyProtector ()

	getOwnershipId ()

	initLoadBalancer (ILoadBalancer $lb)

	resolveDomainInstance ( $domain)

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

Protected Attributes
BagOStuff	$cpStash

DatabaseDomain	$localDomain
	Local domain.

int null	$maxLag

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

CriticalSectionProvider null	$csProvider

string null	$defaultGroup = null

callable	$deprecationLogger
	Deprecation logger.

DatabaseDomain[] string[]	$domainAliases = []
	Map of (domain alias => DB domain)

callable	$errorLogger
	Error logger.

	$id
	var int An identifier for this class instance

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

DatabaseDomain[]	$nonLocalDomainCache = []
	Map of (domain ID => domain instance)

LoggerInterface	$perfLogger

callable null	$profiler
	An optional callback that returns a ScopedCallback instance, meant to profile the actual query execution in {.

LoggerInterface	$queryLogger

callable[]	$replicationWaitCallbacks = []

int	$replicationWaitTimeout
	Default replication wait timeout.

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.

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'

Static Private Attributes
static	$loggerFields

Additional Inherited Members
Public Attributes inherited from Wikimedia\Rdbms\ILBFactory
const	SHUTDOWN_NO_CHRONPROT = 1
	Do not save "session consistency" DB replication positions.

const	SHUTDOWN_NORMAL = 0
	Idion for "no special shutdown flags".

Detailed Description

An interface for generating database load balancers.

Definition at line 42 of file LBFactory.php.

Constructor & Destructor Documentation

◆ __construct()

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

Construct a manager of ILoadBalancer instances.

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 primary DB is read-only if so [optional]
srvCache: BagOStuff instance for server cache [optional]
cpStash: BagOStuff instance for ChronologyProtector store [optional] See ChronologyProtector requirements.
wanCache: WANObjectCache instance [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]
criticalSectionProvider: CriticalSectionProvider instance [optional]

Exceptions

InvalidArgumentException

Implements Wikimedia\Rdbms\ILBFactory.

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

Definition at line 128 of file LBFactory.php.

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

◆ __destruct()

Wikimedia\Rdbms\LBFactory::__destruct ( )

Reimplemented in Wikimedia\Rdbms\LBFactorySingle.

Definition at line 850 of file LBFactory.php.

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

References Wikimedia\Rdbms\ILoadBalancer\hasStreamingReplicaServers().

◆ assertTransactionRoundStage()

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

private

Parameters

string $stage

Definition at line 841 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\beginPrimaryChanges(), and Wikimedia\Rdbms\LBFactory\commitPrimaryChanges().

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

Referenced by Wikimedia\Rdbms\LBFactorySingle\__construct().

◆ beginMasterChanges()

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

Deprecated:: since 1.37 Use beginPrimaryChanges() instead.

Parameters

string $fname

Exceptions

DBTransactionError

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 289 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\beginPrimaryChanges(), and wfDeprecated().

◆ beginPrimaryChanges()

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

final

Flush any primary 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:

commitPrimaryChanges()
rollbackPrimaryChanges()
commitAll()

This only applies to the tracked load balancer instances.

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

Parameters

string $fname

Exceptions

DBTransactionError

Since: 1.37

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 271 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\beginMasterChanges(), and Wikimedia\Rdbms\LBFactory\commitAndWaitForReplication().

◆ closeAll()

Wikimedia\Rdbms\LBFactory::closeAll ( )

Close all connections on instantiated tracked load balancer instances.

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 737 of file LBFactory.php.

◆ commitAll()

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

final

Commit open transactions on all connections.

This only applies to the instantiated tracked load balancer instances.

This is useful for two main cases:

a) Committing changes to the masters
b) Releasing the snapshot on all connections, primary 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 265 of file LBFactory.php.

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

◆ commitAndWaitForReplication()

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

final

Call commitPrimaryChanges() and waitForReplication() if $ticket indicates it is safe.

The ticket is used to check that the caller owns the transaction round or can act on behalf of the caller that owns the transaction round.

See also: commitPrimaryChanges(); waitForReplication()

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

References Wikimedia\Rdbms\LBFactory\$ticket, Wikimedia\Rdbms\LBFactory\$trxRoundId, Wikimedia\Rdbms\LBFactory\beginPrimaryChanges(), Wikimedia\Rdbms\LBFactory\commitPrimaryChanges(), and Wikimedia\Rdbms\LBFactory\waitForReplication().

Referenced by CategoryMembershipChangeJob\notifyUpdatesForRevision().

◆ commitMasterChanges()

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

final

Deprecated:: since 1.37; please use commitPrimaryChanges() instead.

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

References Wikimedia\Rdbms\LBFactory\commitPrimaryChanges(), and wfDeprecated().

◆ commitPrimaryChanges()

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

final

Commit changes and clear view snapshots on all primary connections.

This only applies to the instantiated tracked load balancer instances.

Parameters

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

Exceptions

DBTransactionError

Since: 1.37

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 294 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\assertTransactionRoundStage(), Wikimedia\Rdbms\LBFactory\executePostTransactionCallbacks(), Wikimedia\Rdbms\ILoadBalancer\finalizePrimaryChanges(), 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(), Wikimedia\Rdbms\LBFactory\commitMasterChanges(), and Wikimedia\Rdbms\LBFactory\shutdown().

◆ destroy()

Wikimedia\Rdbms\LBFactory::destroy ( )

Close all connections and make further attempts to open connections result in DBAccessError.

This only applies to the tracked load balancer instances.

See also: ILoadBalancer::disable()

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 177 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

◆ disableChronologyProtection()

Wikimedia\Rdbms\LBFactory::disableChronologyProtection ( )

Disable the ChronologyProtector on all instantiated tracked load balancer instances.

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

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 567 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\getChronologyProtector().

◆ executePostTransactionCallbacks()

Wikimedia\Rdbms\LBFactory::executePostTransactionCallbacks ( )

private

Returns: Exception|null

Definition at line 357 of file LBFactory.php.

References Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\LBFactory\hasPrimaryChanges(), Wikimedia\Rdbms\ILoadBalancer\runPrimaryTransactionIdleCallbacks(), and Wikimedia\Rdbms\ILoadBalancer\runPrimaryTransactionListenerCallbacks().

Referenced by Wikimedia\Rdbms\LBFactory\commitPrimaryChanges(), and Wikimedia\Rdbms\LBFactory\rollbackPrimaryChanges().

◆ flushReplicaSnapshots()

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

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

This only applies to the instantiated tracked load balancer instances.

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

References Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

◆ forEachLBCallMethod()

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

protected

Call a method on each tracked (instantiated) load balancer instance.

Parameters

string	$methodName
array	$args

Definition at line 246 of file LBFactory.php.

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

Referenced by Wikimedia\Rdbms\LBFactory\beginPrimaryChanges(), Wikimedia\Rdbms\LBFactory\commitAll(), Wikimedia\Rdbms\LBFactory\commitPrimaryChanges(), Wikimedia\Rdbms\LBFactory\destroy(), Wikimedia\Rdbms\LBFactory\flushReplicaSnapshots(), and Wikimedia\Rdbms\LBFactory\rollbackPrimaryChanges().

◆ getChronologyProtector()

Wikimedia\Rdbms\LBFactory::getChronologyProtector ( )

protected

Returns: ChronologyProtector

Definition at line 574 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\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 761 of file LBFactory.php.

◆ getChronologyProtectorTouched()

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

Get the UNIX timestamp when the client last touched the DB, if they did so recently.

Parameters

DatabaseDomain | string | bool $domain Domain ID, or false for the current domain

Returns: float|false UNIX timestamp; false if not recent or on record

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 563 of file LBFactory.php.

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

◆ getCPInfoFromCookieValue()

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

static

Parse a string conveying the client and write index of the chronology protector data.

Parameters

string \| null	$value	Value of "cpPosIndex" cookie
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 791 of file LBFactory.php.

◆ getEmptyTransactionTicket()

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

Get a token asserting that no transaction writes are active on tracked load balancers.

Parameters

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

Returns: mixed A value to pass to commitAndWaitForReplication()

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 520 of file LBFactory.php.

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

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

◆ getOwnershipId()

Wikimedia\Rdbms\LBFactory::getOwnershipId ( )

finalprotected

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

Since: 1.34

Definition at line 834 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactorySingle\__construct().

◆ getTransactionProfiler()

Wikimedia\Rdbms\LBFactory::getTransactionProfiler ( )

Get the TransactionProfiler used by this instance.

Returns: TransactionProfiler

Since: 1.35

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 711 of file LBFactory.php.

◆ hasMasterChanges()

Wikimedia\Rdbms\LBFactory::hasMasterChanges ( )

Deprecated:: since 1.37; please use hasPrimaryChanges() instead.

Returns: bool

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 416 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\hasPrimaryChanges(), and wfDeprecated().

◆ hasOrMadeRecentMasterChanges()

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

Deprecated:: since 1.37; please use hasOrMadeRecentPrimaryChanges() instead.

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

References Wikimedia\Rdbms\LBFactory\hasOrMadeRecentPrimaryChanges(), and wfDeprecated().

◆ hasOrMadeRecentPrimaryChanges()

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

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

This only applies to the instantiated tracked load balancer instances.

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

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

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

◆ hasPrimaryChanges()

Wikimedia\Rdbms\LBFactory::hasPrimaryChanges ( )

Determine if any primary connection has pending changes.

This only applies to the instantiated tracked load balancer instances.

Returns: bool

Since: 1.37

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 407 of file LBFactory.php.

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

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

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

◆ initLoadBalancer()

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

protected

Parameters

ILoadBalancer $lb

Definition at line 689 of file LBFactory.php.

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

Referenced by Wikimedia\Rdbms\LBFactorySingle\__construct().

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

◆ laggedReplicaUsed()

Wikimedia\Rdbms\LBFactory::laggedReplicaUsed ( )

Detemine if any lagged replica DB connection was used.

This only applies to the instantiated tracked load balancer instances.

Returns: bool

Implements Wikimedia\Rdbms\ILBFactory.

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

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

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

◆ makeCookieValueFromCPIndex()

static Wikimedia\Rdbms\LBFactory::makeCookieValueFromCPIndex	(	int	$writeIndex,
		int	$time,
		string	$clientId
	)

static

Build a string conveying the client and write index of the chronology protector data.

Parameters

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

Returns: string Value to use for "cpPosIndex" cookie

Since: 1.32

Definition at line 774 of file LBFactory.php.

◆ redefineLocalDomain()

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

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

This only applies to the tracked load balancer instances.

Parameters

DatabaseDomain | string $domain

Since: 1.33

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 727 of file LBFactory.php.

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

References Wikimedia\Rdbms\LBFactory\resolveDomainInstance().

◆ resolveDomainInstance()

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

finalprotected

Parameters

DatabaseDomain | string | bool $domain

Returns: DatabaseDomain

Definition at line 196 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$localDomain, and Wikimedia\Rdbms\DatabaseDomain\newFromId().

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

◆ rollbackMasterChanges()

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

final

Deprecated:: since 1.37; please use rollbackPrimaryChanges() instead.

Parameters

string $fname Caller name

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 349 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\rollbackPrimaryChanges(), and wfDeprecated().

◆ rollbackPrimaryChanges()

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

final

Rollback changes on all primary connections.

This only applies to the instantiated tracked load balancer instances.

Parameters

string $fname Caller name

Since: 1.37

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 335 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 Wikimedia\Rdbms\LBFactory\rollbackMasterChanges().

◆ setAgentName()

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

Parameters

string $agent Agent name for query profiling

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 744 of file LBFactory.php.

◆ setDefaultReplicationWaitTimeout()

Wikimedia\Rdbms\LBFactory::setDefaultReplicationWaitTimeout ( $seconds )

Set the default timeout for replication wait checks.

Parameters

int $seconds Timeout, in seconds

Returns: int The previous default timeout

Since: 1.35

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 823 of file LBFactory.php.

◆ setDomainAliases()

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

Convert certain database domains to alternative ones.

This can be used for backwards compatibility logic.

Parameters

DatabaseDomain[] | string[] $aliases Map of (domain alias => domain)

Since: 1.35

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 707 of file LBFactory.php.

◆ 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 Map of (index alias => index name)

Since: 1.31

Implements Wikimedia\Rdbms\ILBFactory.

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

References Wikimedia\Rdbms\ILoadBalancer\setLocalDomainPrefix().

◆ setMockTime()

Wikimedia\Rdbms\LBFactory::setMockTime ( & $time )

Parameters

float | null &$time Mock UNIX timestamp for testing

Definition at line 858 of file LBFactory.php.

◆ setRequestInfo()

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

Inject HTTP request header/cookie information during setup of this instance.

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

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

◆ shutdown()

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

Prepare all instantiated tracked load balancer instances for shutdown.

Parameters

int	$flags	Bit field of ILBFactory::SHUTDOWN_* constants
callable \| null	$workCallback	Work to mask ChronologyProtector writes
int \| null	&$cpIndex	Position key write counter for ChronologyProtector [returned]
string \| null	&$cpClientId	Client ID hash for ChronologyProtector [returned]

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 219 of file LBFactory.php.

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

◆ shutdownChronologyProtector()

Wikimedia\Rdbms\LBFactory::shutdownChronologyProtector	(	ChronologyProtector	$cp,
			$workCallback,
		&	$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
int \| null	&$cpIndex	DB position key write counter; incremented on update [returned]

Definition at line 618 of file LBFactory.php.

References Wikimedia\Rdbms\ILBFactory\forEachLB(), Wikimedia\Rdbms\ILoadBalancer\getServerName(), Wikimedia\Rdbms\ILoadBalancer\getWriterIndex(), Wikimedia\Rdbms\ChronologyProtector\persistSessionReplicationPositions(), Wikimedia\Rdbms\ChronologyProtector\stageSessionReplicationPosition(), 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 primary 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.

This only applies to the instantiated tracked load balancer instances.

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

References Wikimedia\Rdbms\LBFactory\$replicationWaitTimeout, 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 82 of file LBFactory.php.

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

◆ $chronProt

ChronologyProtector Wikimedia\Rdbms\LBFactory::$chronProt

private

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

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

◆ $connLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$connLogger

private

Definition at line 57 of file LBFactory.php.

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

◆ $cpStash

BagOStuff Wikimedia\Rdbms\LBFactory::$cpStash

protected

Definition at line 68 of file LBFactory.php.

◆ $csProvider

CriticalSectionProvider null Wikimedia\Rdbms\LBFactory::$csProvider

private

Definition at line 46 of file LBFactory.php.

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

◆ $defaultGroup

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

private

Definition at line 110 of file LBFactory.php.

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

◆ $deprecationLogger

callable Wikimedia\Rdbms\LBFactory::$deprecationLogger

private

Deprecation logger.

Definition at line 65 of file LBFactory.php.

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

◆ $domainAliases

DatabaseDomain [] string [] Wikimedia\Rdbms\LBFactory::$domainAliases = []

private

Map of (domain alias => DB domain)

Definition at line 91 of file LBFactory.php.

◆ $errorLogger

callable Wikimedia\Rdbms\LBFactory::$errorLogger

private

Error logger.

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

◆ $indexAliases

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

private

Map of (index alias => index)

Definition at line 89 of file LBFactory.php.

◆ $localDomain

DatabaseDomain Wikimedia\Rdbms\LBFactory::$localDomain

protected

Local domain.

Definition at line 75 of file LBFactory.php.

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

◆ $loggerFields

Wikimedia\Rdbms\LBFactory::$loggerFields

staticprivate

Initial value:

=

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

Definition at line 125 of file LBFactory.php.

◆ $maxLag

int null Wikimedia\Rdbms\LBFactory::$maxLag

protected

Definition at line 113 of file LBFactory.php.

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

◆ $nonLocalDomainCache

DatabaseDomain [] Wikimedia\Rdbms\LBFactory::$nonLocalDomainCache = []

private

Map of (domain ID => domain instance)

Definition at line 116 of file LBFactory.php.

◆ $perfLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$perfLogger

private

Definition at line 61 of file LBFactory.php.

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

◆ $profiler

callable null Wikimedia\Rdbms\LBFactory::$profiler

private

An optional callback that returns a ScopedCallback instance, meant to profile the actual query execution in {.

See also: Database::doQuery}

Definition at line 51 of file LBFactory.php.

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

◆ $queryLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$queryLogger

private

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

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

◆ $replicationWaitCallbacks

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

private

Definition at line 93 of file LBFactory.php.

◆ $replicationWaitTimeout

int Wikimedia\Rdbms\LBFactory::$replicationWaitTimeout

private

Default replication wait timeout.

Definition at line 104 of file LBFactory.php.

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

◆ $replLogger

LoggerInterface Wikimedia\Rdbms\LBFactory::$replLogger

private

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

◆ $secret

string Wikimedia\Rdbms\LBFactory::$secret

private

Secret string for HMAC hashing.

Definition at line 84 of file LBFactory.php.

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

◆ $srvCache

BagOStuff Wikimedia\Rdbms\LBFactory::$srvCache

protected

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

◆ $ticket

int null Wikimedia\Rdbms\LBFactory::$ticket

private

Ticket used to delegate transaction ownership.

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

◆ $wanCache

WANObjectCache Wikimedia\Rdbms\LBFactory::$wanCache

protected

Definition at line 72 of file LBFactory.php.

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

◆ ROUND_BEGINNING

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

private

Definition at line 119 of file LBFactory.php.

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

◆ ROUND_COMMIT_CALLBACKS

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

private

Definition at line 122 of file LBFactory.php.

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

◆ ROUND_COMMITTING

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

private

Definition at line 120 of file LBFactory.php.

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

◆ ROUND_CURSORY

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

private

Definition at line 118 of file LBFactory.php.

Referenced by Wikimedia\Rdbms\LBFactory\beginPrimaryChanges(), Wikimedia\Rdbms\LBFactory\commitPrimaryChanges(), and Wikimedia\Rdbms\LBFactory\rollbackPrimaryChanges().

◆ ROUND_ROLLBACK_CALLBACKS

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

private

Definition at line 123 of file LBFactory.php.

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

◆ ROUND_ROLLING_BACK

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

private

Definition at line 121 of file LBFactory.php.

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

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

includes/libs/rdbms/lbfactory/LBFactory.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ appendShutdownCPIndexAsQuery()

◆ assertTransactionRoundStage()

◆ baseLoadBalancerParams()

◆ beginMasterChanges()

◆ beginPrimaryChanges()

◆ closeAll()

◆ commitAll()

◆ commitAndWaitForReplication()

◆ commitMasterChanges()

◆ commitPrimaryChanges()

◆ destroy()

◆ disableChronologyProtection()

◆ executePostTransactionCallbacks()

◆ flushReplicaSnapshots()

◆ forEachLBCallMethod()

◆ getChronologyProtector()

◆ getChronologyProtectorClientId()

◆ getChronologyProtectorTouched()

◆ getCPInfoFromCookieValue()

◆ getEmptyTransactionTicket()

◆ getLocalDomainID()

◆ getOwnershipId()

◆ getTransactionProfiler()

◆ hasMasterChanges()

◆ hasOrMadeRecentMasterChanges()

◆ hasOrMadeRecentPrimaryChanges()

◆ hasPrimaryChanges()

◆ hasTransactionRound()

◆ initLoadBalancer()

◆ isReadyForRoundOperations()

◆ laggedReplicaUsed()

◆ logIfMultiDbTransaction()

◆ makeCookieValueFromCPIndex()

◆ redefineLocalDomain()

◆ resolveDomainID()

◆ resolveDomainInstance()

◆ rollbackMasterChanges()

◆ rollbackPrimaryChanges()

◆ setAgentName()

◆ setDefaultReplicationWaitTimeout()

◆ setDomainAliases()

◆ setIndexAliases()

◆ setLocalDomainPrefix()

◆ setMockTime()

◆ setRequestInfo()

◆ setTableAliases()

◆ setWaitForReplicationListener()

◆ shutdown()

◆ shutdownChronologyProtector()

◆ waitForReplication()

Member Data Documentation

◆ $agent

◆ $chronProt

◆ $cliMode

◆ $connLogger

◆ $cpStash

◆ $csProvider

◆ $defaultGroup

◆ $deprecationLogger

◆ $domainAliases

◆ $errorLogger

◆ $id

◆ $indexAliases

◆ $localDomain

◆ $loggerFields

◆ $maxLag

◆ $nonLocalDomainCache