MediaWiki  master
Wikimedia\Rdbms\LBFactory Class Reference
Inheritance diagram for Wikimedia\Rdbms\LBFactory:
Collaboration diagram for Wikimedia\Rdbms\LBFactory:

Public Member Functions

 __construct (array $conf)
 Sub-classes may extend the required keys in $conf with additional parameters. More...
 
 appendShutdownCPIndexAsQuery ( $url, $index)
 Append ?cpPosIndex parameter to a URL for ChronologyProtector purposes if needed. More...
 
 autoReconfigure ()
 Reload config using the callback passed defined $config['configCallback']. More...
 
 beginPrimaryChanges ( $fname=__METHOD__)
 Flush any primary transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set) More...
 
 closeAll ( $fname=__METHOD__)
 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 commitPrimaryChanges() and waitForReplication() if $ticket indicates it is safe. More...
 
 commitPrimaryChanges ( $fname=__METHOD__, array $options=[])
 Commit changes and clear view snapshots on all primary 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...
 
 flushPrimarySessions ( $fname=__METHOD__)
 Release important session-level state (named lock, table locks) as post-rollback cleanup. More...
 
 flushReplicaSnapshots ( $fname=__METHOD__)
 Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot. More...
 
 getAllLBs ()
 Get all tracked load balancer instances (generator) 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...
 
 hasOrMadeRecentPrimaryChanges ( $age=null)
 Determine if any primary connection has pending/written changes from this request. More...
 
 hasPrimaryChanges ()
 Determine if any primary connection has pending changes. 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 ()
 Determine if any lagged replica DB connection was used. More...
 
 reconfigure (array $conf)
 Reconfigure using the given config array. More...
 
 redefineLocalDomain ( $domain)
 Close all connections and redefine the local database domain. More...
 
 resolveDomainID ( $domain)
 
 rollbackPrimaryChanges ( $fname=__METHOD__)
 Rollback changes on all primary 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 primary 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 the main cluster that handles the given domain. More...
 
 newExternalLB ( $cluster)
 Create a new load balancer instance for an external cluster. More...
 
 newMainLB ( $domain=false)
 Create a new load balancer instance for the main cluster that handles the given domain. 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 ()
 Get parameters to ILoadBalancer::__construct() More...
 
 configure (array $conf)
 
 getChronologyProtector ()
 
 getLBsForOwner ()
 Get all tracked load balancers with the internal "for owner" interface. More...
 
 initLoadBalancer (ILoadBalancerForOwner $lb)
 
 resolveDomainInstance ( $domain)
 
 shutdownChronologyProtector (ChronologyProtector $cp, &$cpIndex=null)
 Get and record all of the staged DB positions into persistent memory storage. More...
 

Protected Attributes

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

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
 Idiom for "no special shutdown flags". More...
 

Detailed Description

See also
ILBFactory

Definition at line 41 of file LBFactory.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

Parameters
array$confArray with keys:
  • localDomain: A DatabaseDomain or database domain ID string.
  • readOnlyReason: Reason the primary server 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]
  • databaseFactory: DatabaseFactory 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: Callback that takes a profile section name and returns a ScopedCallback that ends the profile section in its destructor [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]

Implements Wikimedia\Rdbms\ILBFactory.

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

Definition at line 139 of file LBFactory.php.

References Wikimedia\Rdbms\LBFactory\configure().

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

◆ autoReconfigure()

Wikimedia\Rdbms\LBFactory::autoReconfigure ( )

Reload config using the callback passed defined $config['configCallback'].

If the config returned by the callback is different from the existing config, this calls reconfigure() on all load balancers, which causes them to invalidate any existing connections and re-connect using the new configuration.

Note
This invalidates the current transaction ticket.
Warning
This must only be called in top level code such as the execute() method of a maintenance script. Any database connection in use when this method is called will become defunct.
Returns
bool true if the config changed.

Definition at line 228 of file LBFactory.php.

◆ baseLoadBalancerParams()

Wikimedia\Rdbms\LBFactory::baseLoadBalancerParams ( )
finalprotected

Get parameters to ILoadBalancer::__construct()

Returns
array

Definition at line 730 of file LBFactory.php.

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

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

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

◆ closeAll()

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

Close all connections on instantiated tracked load balancer instances.

Parameters
string$fnameCaller name (e.g. METHOD)

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 819 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$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 362 of file LBFactory.php.

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

Referenced by CategoryMembershipChangeJob\notifyUpdatesForRevision().

◆ 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$fnameCaller name
array$optionsOptions 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 392 of file LBFactory.php.

◆ configure()

Wikimedia\Rdbms\LBFactory::configure ( array  $conf)
protected
Parameters
array$conf
Returns
void

Definition at line 160 of file LBFactory.php.

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

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

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

◆ flushPrimarySessions()

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

Release important session-level state (named lock, table locks) as post-rollback cleanup.

This only applies to the instantiated tracked load balancer instances.

This should only be called by application entry point functions, since there must be no chance that a future caller will still be expecting some of the lost session state.

Parameters
string$fnameCaller name
Since
1.38

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 448 of file LBFactory.php.

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

◆ getAllLBs()

Wikimedia\Rdbms\LBFactory::getAllLBs ( )

Get all tracked load balancer instances (generator)

Returns
Generator|ILoadBalancer[]
Since
1.39

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 335 of file LBFactory.php.

◆ getChronologyProtector()

Wikimedia\Rdbms\LBFactory::getChronologyProtector ( )
protected
Returns
ChronologyProtector

Definition at line 671 of file LBFactory.php.

◆ 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 842 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 | false$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 660 of file LBFactory.php.

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

◆ getLBsForOwner()

Wikimedia\Rdbms\LBFactory::getLBsForOwner ( )
abstractprotected

Get all tracked load balancers with the internal "for owner" interface.

Most subclasses override this, we just provide an implementation here for the benefit of Wikibase's FakeLBFactory.

Returns
Generator|ILoadBalancerForOwner[]

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

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

◆ getTransactionProfiler()

Wikimedia\Rdbms\LBFactory::getTransactionProfiler ( )

Get the TransactionProfiler used by this instance.

Returns
TransactionProfiler
Since
1.35

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 793 of file LBFactory.php.

◆ 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$ageHow many seconds ago is "recent" [defaults to LB lag wait timeout]
Returns
bool

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 531 of file LBFactory.php.

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

◆ 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 482 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 recursion guard to avoid exceptions in transaction callbacks.

Returns
bool
Since
1.32

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 486 of file LBFactory.php.

◆ laggedReplicaUsed()

Wikimedia\Rdbms\LBFactory::laggedReplicaUsed ( )

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

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

◆ reconfigure()

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

Reconfigure using the given config array.

Any fields omitted from $conf will be taken from the current config.

If the config changed, this calls reconfigure() on all load balancers, which causes them to close all existing connections.

Note
This invalidates the current transaction ticket.
Warning
This must only be called in top level code such as the execute() method of a maintenance script. Any database connection in use when this method is called will become defunct.
Since
1.39
Parameters
array$confA configuration array, using the same structure as the one passed to the constructor (see also $wgLBFactoryConf).
Returns
bool true if the config changed.

Definition at line 261 of file LBFactory.php.

◆ redefineLocalDomain()

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

Close all connections and redefine the local database domain.

This only applies to the tracked load balancer instances.

This method is only intended for use with schema creation or integration testing

Parameters
DatabaseDomain | string$domain
Since
1.33

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 809 of file LBFactory.php.

◆ resolveDomainID()

Wikimedia\Rdbms\LBFactory::resolveDomainID (   $domain)
Parameters
DatabaseDomain | string | false$domainDatabase domain
Returns
string Value of $domain if provided or the local domain otherwise
Since
1.32

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 283 of file LBFactory.php.

◆ resolveDomainInstance()

Wikimedia\Rdbms\LBFactory::resolveDomainInstance (   $domain)
finalprotected
Parameters
DatabaseDomain | string | false$domain
Returns
DatabaseDomain

Definition at line 291 of file LBFactory.php.

◆ 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$fnameCaller name
Since
1.37

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 432 of file LBFactory.php.

◆ setAgentName()

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

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 828 of file LBFactory.php.

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

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 789 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 785 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 797 of file LBFactory.php.

◆ setMockTime()

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

Definition at line 927 of file LBFactory.php.

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

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 781 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 609 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 314 of file LBFactory.php.

References Wikimedia\Rdbms\ChronologyProtector\getClientId().

◆ shutdownChronologyProtector()

Wikimedia\Rdbms\LBFactory::shutdownChronologyProtector ( ChronologyProtector  $cp,
$cpIndex = null 
)
protected

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

Parameters
ChronologyProtector$cp
int | null&$cpIndexDB position key write counter; incremented on update [returned]

Definition at line 714 of file LBFactory.php.

References Wikimedia\Rdbms\ChronologyProtector\persistSessionReplicationPositions(), and Wikimedia\Rdbms\ChronologyProtector\stageSessionReplicationPosition().

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

Member Data Documentation

◆ $cpStash

BagOStuff Wikimedia\Rdbms\LBFactory::$cpStash
protected

Definition at line 69 of file LBFactory.php.

◆ $databaseFactory

DatabaseFactory Wikimedia\Rdbms\LBFactory::$databaseFactory
protected

Definition at line 75 of file LBFactory.php.

◆ $localDomain

DatabaseDomain Wikimedia\Rdbms\LBFactory::$localDomain
protected

Local domain.

Definition at line 77 of file LBFactory.php.

◆ $maxLag

int null Wikimedia\Rdbms\LBFactory::$maxLag
protected

Definition at line 113 of file LBFactory.php.

◆ $readOnlyReason

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

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

Definition at line 107 of file LBFactory.php.

◆ $srvCache

BagOStuff Wikimedia\Rdbms\LBFactory::$srvCache
protected

Definition at line 71 of file LBFactory.php.

◆ $wanCache

WANObjectCache Wikimedia\Rdbms\LBFactory::$wanCache
protected

Definition at line 73 of file LBFactory.php.


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