MediaWiki  master
Wikimedia\Rdbms\LBFactory Class Reference

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

Inheritance diagram for Wikimedia\Rdbms\LBFactory:
Collaboration diagram for Wikimedia\Rdbms\LBFactory:

Public Member Functions

 __construct (array $conf)
 Construct a manager of ILoadBalancer instances. More...
 
 __destruct ()
 
 appendShutdownCPIndexAsQuery ( $url, $index)
 Append ?cpPosIndex parameter to a URL for ChronologyProtector purposes if needed. More...
 
 beginMasterChanges ( $fname=__METHOD__)
 Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set) More...
 
 closeAll ()
 Close all connections on instantiated tracked load balancer instances. More...
 
 commitAll ( $fname=__METHOD__, array $options=[])
 Commit open transactions on all connections. More...
 
 commitAndWaitForReplication ( $fname, $ticket, array $opts=[])
 Call commitMasterChanges() and waitForReplication() if $ticket indicates it is safe. More...
 
 commitMasterChanges ( $fname=__METHOD__, array $options=[])
 Commit changes and clear view snapshots on all master connections. More...
 
 destroy ()
 Close all connections and make further attempts to open connections result in DBAccessError. More...
 
 disableChronologyProtection ()
 Disable the ChronologyProtector on all instantiated tracked load balancer instances. More...
 
 flushReplicaSnapshots ( $fname=__METHOD__)
 Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot. More...
 
 getChronologyProtectorClientId ()
 Get the client ID of the ChronologyProtector instance. More...
 
 getChronologyProtectorTouched ( $domain=false)
 Get the UNIX timestamp when the client last touched the DB, if they did so recently. More...
 
 getEmptyTransactionTicket ( $fname)
 Get a token asserting that no transaction writes are active on tracked load balancers. More...
 
 getLocalDomainID ()
 Get the local (and default) database domain ID of connection handles. More...
 
 getTransactionProfiler ()
 Get the TransactionProfiler used by this instance. More...
 
 hasMasterChanges ()
 Determine if any master connection has pending changes. More...
 
 hasOrMadeRecentMasterChanges ( $age=null)
 Determine if any master connection has pending/written changes from this request. More...
 
 hasTransactionRound ()
 Check if an explicit transaction round is active. More...
 
 isReadyForRoundOperations ()
 Check if transaction rounds can be started, committed, or rolled back right now. More...
 
 laggedReplicaUsed ()
 Detemine if any lagged replica DB connection was used. More...
 
 redefineLocalDomain ( $domain)
 Close all connections and redefine the local domain for testing or schema creation. More...
 
 resolveDomainID ( $domain)
 
 rollbackMasterChanges ( $fname=__METHOD__)
 Rollback changes on all master connections. More...
 
 setAgentName ( $agent)
 
 setDefaultReplicationWaitTimeout ( $seconds)
 Set the default timeout for replication wait checks. More...
 
 setDomainAliases (array $aliases)
 Convert certain database domains to alternative ones. More...
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB. More...
 
 setLocalDomainPrefix ( $prefix)
 Set a new table prefix for the existing local domain ID for testing. More...
 
 setMockTime (&$time)
 
 setRequestInfo (array $info)
 Inject HTTP request header/cookie information during setup of this instance. More...
 
 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. More...
 
 setWaitForReplicationListener ( $name, callable $callback=null)
 Add a callback to be run in every call to waitForReplication() before waiting. More...
 
 shutdown ( $flags=self::SHUTDOWN_NORMAL, callable $workCallback=null, &$cpIndex=null, &$cpClientId=null)
 Prepare all instantiated tracked load balancer instances for shutdown. More...
 
 waitForReplication (array $opts=[])
 Waits for the replica DBs to catch up to the current master position. More...
 
- Public Member Functions inherited from Wikimedia\Rdbms\ILBFactory
 forEachLB ( $callback, array $params=[])
 Execute a function for each instantiated tracked load balancer instance. More...
 
 getAllExternalLBs ()
 Get the tracked load balancer instances for all external clusters. More...
 
 getAllMainLBs ()
 Get the tracked load balancer instances for all main clusters. More...
 
 getExternalLB ( $cluster)
 Get the tracked load balancer instance for an external cluster. More...
 
 getMainLB ( $domain=false)
 Get the tracked load balancer instance for a main cluster. More...
 
 newExternalLB ( $cluster, $owner=null)
 Create a new load balancer instance for an external cluster. More...
 
 newMainLB ( $domain=false, $owner=null)
 Create a new load balancer instance for a main cluster. More...
 

Static Public Member Functions

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

Protected Member Functions

 baseLoadBalancerParams ( $owner)
 Get parameters to ILoadBalancer::__construct() More...
 
 forEachLBCallMethod ( $methodName, array $args=[])
 Call a method on each tracked (instantiated) load balancer instance. More...
 
 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. More...
 

Protected Attributes

BagOStuff $cpStash
 
DatabaseDomain $localDomain
 Local domain. More...
 
int null $maxLag
 
string bool $readOnlyReason = false
 Reason all LBs are read-only or false if not. More...
 
BagOStuff $srvCache
 
WANObjectCache $wanCache
 

Private Member Functions

 assertTransactionRoundStage ( $stage)
 
 executePostTransactionCallbacks ()
 
 logIfMultiDbTransaction ()
 Log query info if multi DB transactions are going to be committed now. More...
 

Private Attributes

string $agent
 Agent name for query profiling. More...
 
ChronologyProtector $chronProt
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
LoggerInterface $connLogger
 
CriticalSectionProvider null $csProvider
 
string null $defaultGroup = null
 
callable $deprecationLogger
 Deprecation logger. More...
 
DatabaseDomain[] string[] $domainAliases = []
 Map of (domain alias => DB domain) More...
 
callable $errorLogger
 Error logger. More...
 
 $id
 var int An identifier for this class instance More...
 
string[] $indexAliases = []
 Map of (index alias => index) More...
 
DatabaseDomain[] $nonLocalDomainCache = []
 Map of (domain ID => domain instance) More...
 
LoggerInterface $perfLogger
 
callable null $profiler
 An optional callback that returns a ScopedCallback instance, meant to profile the actual query execution in {. More...
 
LoggerInterface $queryLogger
 
callable[] $replicationWaitCallbacks = []
 
int $replicationWaitTimeout
 Default replication wait timeout. More...
 
LoggerInterface $replLogger
 
array $requestInfo
 Web request information about the client. More...
 
string $secret
 Secret string for HMAC hashing. More...
 
array[] $tableAliases = []
 $aliases Map of (table => (dbname, schema, prefix) map) More...
 
int null $ticket
 Ticket used to delegate transaction ownership. More...
 
TransactionProfiler $trxProfiler
 
string bool $trxRoundId = false
 String if a requested DBO_TRX transaction round is active. More...
 
string $trxRoundStage = self::ROUND_CURSORY
 One of the ROUND_* class constants. More...
 
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. More...
 
const SHUTDOWN_NORMAL = 0
 Idion for "no special shutdown flags". More...
 

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$confArray with keys:
  • localDomain: A DatabaseDomain or domain ID string.
  • readOnlyReason: Reason the master 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\LBFactorySingle, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactoryMulti.

Definition at line 128 of file LBFactory.php.

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

◆ __destruct()

Wikimedia\Rdbms\LBFactory::__destruct ( )

Reimplemented in Wikimedia\Rdbms\LBFactorySingle.

Definition at line 826 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$indexWrite counter index
Returns
string

Implements Wikimedia\Rdbms\ILBFactory.

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

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

◆ baseLoadBalancerParams()

◆ 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:

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

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\commitAndWaitForReplication().

◆ closeAll()

Wikimedia\Rdbms\LBFactory::closeAll ( )

Close all connections on instantiated tracked load balancer instances.

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 713 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 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, master and replica DBs
Parameters
string$fnameCaller name
array$optionsOptions 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\commitMasterChanges(), and Wikimedia\Rdbms\LBFactory\forEachLBCallMethod().

◆ commitAndWaitForReplication()

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

Call commitMasterChanges() 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
commitMasterChanges()
waitForReplication()
Parameters
string$fnameCaller name (e.g. METHOD)
mixed$ticketResult of getEmptyTransactionTicket()
array$optsOptions to waitForReplication()
Returns
bool True if the wait was successful, false on timeout

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 510 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

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

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

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

References Wikimedia\Rdbms\LBFactory\getChronologyProtector().

◆ executePostTransactionCallbacks()

◆ 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$fnameCaller 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

◆ getChronologyProtector()

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

References Wikimedia\Rdbms\LBFactory\getChronologyProtector().

◆ 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$domainDomain 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 540 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$valueValue of "cpPosIndex" cookie
int$minTimestampLowest 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 767 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$fnameCaller name (e.g. METHOD)
Returns
mixed A value to pass to commitAndWaitForReplication()

Implements Wikimedia\Rdbms\ILBFactory.

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

◆ getOwnershipId()

Wikimedia\Rdbms\LBFactory::getOwnershipId ( )
finalprotected

◆ getTransactionProfiler()

Wikimedia\Rdbms\LBFactory::getTransactionProfiler ( )

Get the TransactionProfiler used by this instance.

Returns
TransactionProfiler
Since
1.35

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 687 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$trxProfiler.

◆ hasMasterChanges()

Wikimedia\Rdbms\LBFactory::hasMasterChanges ( )

Determine if any master connection has pending changes.

This only applies to the instantiated tracked load balancer instances.

Returns
bool

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 392 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.

This only applies to the instantiated tracked load balancer instances.

Parameters
float | null$ageHow many seconds ago is "recent" [defaults to LB lag wait timeout]
Returns
bool

Implements Wikimedia\Rdbms\ILBFactory.

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

◆ initLoadBalancer()

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

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

◆ logIfMultiDbTransaction()

Wikimedia\Rdbms\LBFactory::logIfMultiDbTransaction ( )
private

◆ 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$writeIndexWrite index
int$timeUNIX timestamp; can be used to detect stale cookies (T190082)
string$clientIdClient ID hash from ILBFactory::shutdown()
Returns
string Value to use for "cpPosIndex" cookie
Since
1.32

Definition at line 750 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 703 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$domainDatabase 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

◆ rollbackMasterChanges()

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

Rollback changes on all master connections.

This only applies to the instantiated tracked load balancer instances.

Parameters
string$fnameCaller name

Implements Wikimedia\Rdbms\ILBFactory.

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

◆ setAgentName()

Wikimedia\Rdbms\LBFactory::setAgentName (   $agent)
Parameters
string$agentAgent name for query profiling

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 720 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$agent.

◆ setDefaultReplicationWaitTimeout()

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

Set the default timeout for replication wait checks.

Parameters
int$secondsTimeout, in seconds
Returns
int The previous default timeout
Since
1.35

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 799 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\$replicationWaitTimeout.

◆ 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[]$aliasesMap of (domain alias => domain)
Since
1.35

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 683 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[]$aliasesMap of (index alias => index name)
Since
1.31

Implements Wikimedia\Rdbms\ILBFactory.

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

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

◆ setMockTime()

Wikimedia\Rdbms\LBFactory::setMockTime ( $time)
Parameters
float | null&$timeMock UNIX timestamp for testing

Definition at line 834 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\getChronologyProtector().

◆ setRequestInfo()

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

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

Parameters
array$infoMap 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 791 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[]$aliasesMap of (table => (dbname, schema, prefix) map)
Since
1.31

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 675 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$nameCallback name
callable | null$callbackUse null to unset a callback

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 489 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$flagsBit field of ILBFactory::SHUTDOWN_* constants
callable | null$workCallbackWork to mask ChronologyProtector writes
int | null&$cpIndexPosition key write counter for ChronologyProtector [returned]
string | null&$cpClientIdClient 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\commitMasterChanges(), 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$workCallbackWork to do instead of waiting on syncing positions
int | null&$cpIndexDB position key write counter; incremented on update [returned]

Definition at line 595 of file LBFactory.php.

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

This only applies to the instantiated tracked load balancer instances.

Parameters
array$optsOptional 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 418 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(), and Wikimedia\Rdbms\LBFactory\setAgentName().

◆ $chronProt

ChronologyProtector Wikimedia\Rdbms\LBFactory::$chronProt
private

◆ $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.

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

◆ $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

◆ $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.

◆ $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(), and Wikimedia\Rdbms\LBFactoryMulti\newLoadBalancer().

◆ $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\setDefaultReplicationWaitTimeout(), and 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.

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

◆ $secret

string Wikimedia\Rdbms\LBFactory::$secret
private

Secret string for HMAC hashing.

Definition at line 84 of file LBFactory.php.

◆ $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

◆ $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\beginMasterChanges().

◆ 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\commitMasterChanges().

◆ ROUND_COMMITTING

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

Definition at line 120 of file LBFactory.php.

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

◆ ROUND_CURSORY

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

◆ 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\rollbackMasterChanges().

◆ 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\rollbackMasterChanges().


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