MediaWiki
master
|
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... | |
commitAndWaitForReplication ( $fname, $ticket, array $opts=[]) | |
Commit primary DB transactions and wait for replication (if $ticket indicates it is safe). More... | |
commitPrimaryChanges ( $fname=__METHOD__, int $maxWriteDuration=0) | |
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 database server transactions, clearing any REPEATABLE-READ/SSI snapshots. More... | |
getAllLBs () | |
Get all tracked load balancer instances (generator) 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 write transactions are active on tracked connections. More... | |
getLocalDomainID () | |
Get the local (and default) database domain ID of connection handles. More... | |
getPrimaryDatabase ( $domain=false) | |
Get connection to the primary database. More... | |
getReplicaDatabase ( $domain=false, $group=null) | |
Get connection to a replica database. 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 database server 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 database server to catch up to the current primary position. 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 |
DatabaseDomain | $localDomain |
Local domain. More... | |
string false | $readOnlyReason = false |
Reason all LBs are read-only or false if not. More... | |
BagOStuff | $srvCache |
WANObjectCache | $wanCache |
Additional Inherited Members | |
![]() | |
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... | |
Definition at line 41 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::__construct | ( | array | $conf | ) |
Sub-classes may extend the required keys in $conf with additional parameters.
array | $conf | Array with keys:
|
Implements Wikimedia\Rdbms\ILBFactory.
Reimplemented in Wikimedia\Rdbms\LBFactorySingle, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactoryMulti.
Definition at line 120 of file LBFactory.php.
References Wikimedia\Rdbms\LBFactory\configure().
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.
string | $url | |
int | $index | Write counter index |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 790 of file LBFactory.php.
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.
Long-running processes should call this from time to time (but not too often, because it is somewhat expensive), preferably after each batch. Maintenance scripts can do that by calling $this->waitForReplication(), which calls this method.
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 200 of file LBFactory.php.
|
finalprotected |
Get parameters to ILoadBalancer::__construct()
Definition at line 693 of file LBFactory.php.
Referenced by Wikimedia\Rdbms\LBFactorySingle\__construct().
|
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.
string | $fname |
DBTransactionError |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 324 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::closeAll | ( | $fname = __METHOD__ | ) |
Close all connections on instantiated tracked load balancer instances.
string | $fname | Caller name (e.g. METHOD) |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 777 of file LBFactory.php.
|
final |
Commit primary DB transactions and wait for replication (if $ticket indicates it is safe).
This is mostly used in jobs or deferred updates dealing with batching.
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.
string | $fname | Caller name (e.g. METHOD) |
mixed | $ticket | Result of getEmptyTransactionTicket() |
array | $opts | Options to waitForReplication() |
Implements Wikimedia\Rdbms\IConnectionProvider.
Definition at line 593 of file LBFactory.php.
Referenced by CategoryMembershipChangeJob\notifyUpdatesForRevision().
|
final |
Commit changes and clear view snapshots on all primary connections.
This only applies to the instantiated tracked load balancer instances.
string | $fname | Caller name |
int | $maxWriteDuration | abort if more than this much time was spent in write queries |
DBTransactionError |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 344 of file LBFactory.php.
|
protected |
array | $conf |
Definition at line 141 of file LBFactory.php.
Referenced by Wikimedia\Rdbms\LBFactory\__construct().
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.
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 178 of file LBFactory.php.
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 627 of file LBFactory.php.
|
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.
string | $fname | Caller name |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 396 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::flushReplicaSnapshots | ( | $fname = __METHOD__ | ) |
Commit all replica database server transactions, clearing any REPEATABLE-READ/SSI snapshots.
This only applies to the instantiated tracked load balancer instances.
This is useful for getting rid of stale data from an implicit transaction round
string | $fname | Caller name |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 312 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::getAllLBs | ( | ) |
Get all tracked load balancer instances (generator)
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 297 of file LBFactory.php.
|
protected |
Definition at line 634 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::getChronologyProtectorTouched | ( | $domain = false | ) |
Get the UNIX timestamp when the client last touched the DB, if they did so recently.
DatabaseDomain | string | false | $domain | Domain ID, or false for the current domain |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 623 of file LBFactory.php.
|
static |
Parse a string conveying the client and write index of the chronology protector data.
string | null | $value | Value of "cpPosIndex" cookie |
int | $minTimestamp | Lowest UNIX timestamp that a non-expired value can have |
Definition at line 826 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::getEmptyTransactionTicket | ( | $fname | ) |
Get a token asserting that no write transactions are active on tracked connections.
This is mostly used in jobs or deferred updates dealing with batching.
string | $fname | Caller name (e.g. METHOD) |
Implements Wikimedia\Rdbms\IConnectionProvider.
Definition at line 567 of file LBFactory.php.
|
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.
Reimplemented in Wikimedia\Rdbms\LBFactorySingle, Wikimedia\Rdbms\LBFactorySimple, and Wikimedia\Rdbms\LBFactoryMulti.
Wikimedia\Rdbms\LBFactory::getLocalDomainID | ( | ) |
Get the local (and default) database domain ID of connection handles.
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 241 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::getPrimaryDatabase | ( | $domain = false | ) |
Get connection to the primary database.
This should be used when there the code needs to write to the database.
string | false | $domain | Domain ID, or false for the current domain |
Implements Wikimedia\Rdbms\IConnectionProvider.
Definition at line 580 of file LBFactory.php.
Referenced by MediaWiki\Deferred\LinksUpdate\LinksTable\injectBaseDependencies().
Wikimedia\Rdbms\LBFactory::getReplicaDatabase | ( | $domain = false , |
|
$group = null |
|||
) |
Get connection to a replica database.
Note that a read can have replication lag.
string | false | $domain | Domain ID, or false for the current domain |
string | null | $group | Query group; null for the default group |
Implements Wikimedia\Rdbms\IConnectionProvider.
Definition at line 584 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::getTransactionProfiler | ( | ) |
Get the TransactionProfiler used by this instance.
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 751 of file LBFactory.php.
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.
float | null | $age | How many seconds ago is "recent" [defaults to LB lag wait timeout] |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 481 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::hasPrimaryChanges | ( | ) |
Determine if any primary connection has pending changes.
This only applies to the instantiated tracked load balancer instances.
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 463 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::hasTransactionRound | ( | ) |
Check if an explicit transaction round is active.
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 432 of file LBFactory.php.
|
protected |
ILoadBalancerForOwner | $lb |
Definition at line 729 of file LBFactory.php.
References Wikimedia\Rdbms\ILoadBalancerForOwner\beginPrimaryChanges(), Wikimedia\Rdbms\ILoadBalancer\setDomainAliases(), Wikimedia\Rdbms\ILoadBalancer\setIndexAliases(), and Wikimedia\Rdbms\ILoadBalancer\setTableAliases().
Referenced by Wikimedia\Rdbms\LBFactorySingle\__construct().
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.
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 436 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::laggedReplicaUsed | ( | ) |
Determine if any lagged replica database server connection was used.
This only applies to the instantiated tracked load balancer instances.
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 472 of file LBFactory.php.
|
static |
Build a string conveying the client and write index of the chronology protector data.
int | $writeIndex | |
int | $time | UNIX timestamp; can be used to detect stale cookies (T190082) |
string | $clientId | Client ID hash from ILBFactory::shutdown() |
Definition at line 809 of file LBFactory.php.
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.
array | $conf | A configuration array, using the same structure as the one passed to the constructor (see also $wgLBFactoryConf). |
Reimplemented in Wikimedia\Rdbms\LBFactoryMulti.
Definition at line 231 of file LBFactory.php.
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
DatabaseDomain | string | $domain |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 767 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::resolveDomainID | ( | $domain | ) |
DatabaseDomain | string | false | $domain | Database domain |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 245 of file LBFactory.php.
|
finalprotected |
DatabaseDomain | string | false | $domain |
Definition at line 253 of file LBFactory.php.
|
final |
Rollback changes on all primary connections.
This only applies to the instantiated tracked load balancer instances.
string | $fname | Caller name |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 382 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::setAgentName | ( | $agent | ) |
string | $agent | Agent name for query profiling |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 786 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::setDefaultReplicationWaitTimeout | ( | $seconds | ) |
Set the default timeout for replication wait checks.
int | $seconds | Timeout, in seconds |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 858 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::setDomainAliases | ( | array | $aliases | ) |
Convert certain database domains to alternative ones.
This can be used for backwards compatibility logic.
DatabaseDomain[] | string[] | $aliases | Map of (domain alias => domain) |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 747 of file LBFactory.php.
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.
string[] | $aliases | Map of (index alias => index name) |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 743 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::setLocalDomainPrefix | ( | $prefix | ) |
Set a new table prefix for the existing local domain ID for testing.
string | $prefix |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 755 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::setMockTime | ( | & | $time | ) |
float | null | &$time | Mock UNIX timestamp for testing |
Definition at line 881 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::setRequestInfo | ( | array | $info | ) |
Inject HTTP request header/cookie information during setup of this instance.
array | $info | Map of fields, including:
|
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 850 of file LBFactory.php.
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.
array[] | $aliases | Map of (table => (dbname, schema, prefix) map) |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 739 of file LBFactory.php.
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.
string | $name | Callback name |
callable | null | $callback | Use null to unset a callback |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 559 of file LBFactory.php.
Wikimedia\Rdbms\LBFactory::shutdown | ( | $flags = self::SHUTDOWN_NORMAL , |
|
callable | $workCallback = null , |
||
& | $cpIndex = null , |
||
& | $cpClientId = null |
||
) |
Prepare all instantiated tracked load balancer instances for shutdown.
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 276 of file LBFactory.php.
References Wikimedia\Rdbms\ChronologyProtector\getClientId().
|
protected |
Get and record all of the staged DB positions into persistent memory storage.
ChronologyProtector | $cp | |
int | null | &$cpIndex | DB position key write counter; incremented on update [returned] |
Definition at line 677 of file LBFactory.php.
References Wikimedia\Rdbms\ChronologyProtector\persistSessionReplicationPositions(), and Wikimedia\Rdbms\ChronologyProtector\stageSessionPrimaryPos().
Wikimedia\Rdbms\LBFactory::waitForReplication | ( | array | $opts = [] | ) |
Waits for the replica database server 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. This is a no-op if there are no replica database servers.
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.
array | $opts | Optional fields that include:
|
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 490 of file LBFactory.php.
|
protected |
Definition at line 63 of file LBFactory.php.
|
protected |
Local domain.
Definition at line 69 of file LBFactory.php.
|
protected |
Reason all LBs are read-only or false if not.
Definition at line 99 of file LBFactory.php.
|
protected |
Definition at line 65 of file LBFactory.php.
|
protected |
Definition at line 67 of file LBFactory.php.