MediaWiki REL1_28
|
An interface for generating database load balancers. More...
Public Member Functions | |
__construct (array $conf) | |
Construct a manager of ILoadBalancer objects. | |
__destruct () | |
appendPreShutdownTimeAsQuery ( $url, $time) | |
Append ?cpPosTime parameter to a URL for ChronologyProtector purposes if needed. | |
beginMasterChanges ( $fname=__METHOD__) | |
Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set) | |
closeAll () | |
Close all open database connections on all open load balancers. | |
commitAll ( $fname=__METHOD__, array $options=[]) | |
Commit open transactions on all connections. | |
commitAndWaitForReplication ( $fname, $ticket, array $opts=[]) | |
Convenience method for safely running commitMasterChanges()/waitForReplication() | |
commitMasterChanges ( $fname=__METHOD__, array $options=[]) | |
Commit changes on all master connections. | |
destroy () | |
Disables all load balancers. | |
disableChronologyProtection () | |
Disable the ChronologyProtector for all load balancers. | |
flushReplicaSnapshots ( $fname=__METHOD__) | |
Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot. | |
getChronologyProtectorTouched ( $dbName) | |
getEmptyTransactionTicket ( $fname) | |
Get a token asserting that no transaction writes are active. | |
getExternalLB ( $cluster) | |
getMainLB ( $domain=false) | |
hasMasterChanges () | |
Determine if any master connection has pending changes. | |
hasOrMadeRecentMasterChanges ( $age=null) | |
Determine if any master connection has pending/written changes from this request. | |
hasTransactionRound () | |
Check if a transaction round is active. | |
laggedReplicaUsed () | |
Detemine if any lagged replica DB connection was used. | |
newExternalLB ( $cluster) | |
newMainLB ( $domain=false) | |
rollbackMasterChanges ( $fname=__METHOD__) | |
Rollback changes on all master connections. | |
setAgentName ( $agent) | |
setDomainPrefix ( $prefix) | |
Set a new table prefix for the existing local domain ID for testing. | |
setRequestInfo (array $info) | |
setWaitForReplicationListener ( $name, callable $callback=null) | |
Add a callback to be run in every call to waitForReplication() before waiting. | |
shutdown ( $mode=self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback=null) | |
Prepare all tracked load balancers for shutdown. | |
waitForReplication (array $opts=[]) | |
Waits for the replica DBs to catch up to the current master position. | |
Public Member Functions inherited from ILBFactory | |
forEachLB ( $callback, array $params=[]) | |
Execute a function for each tracked load balancer The callback is called with the load balancer as the first parameter, and $params passed as the subsequent parameters. | |
Protected Member Functions | |
baseLoadBalancerParams () | |
Base parameters to LoadBalancer::__construct() | |
forEachLBCallMethod ( $methodName, array $args=[]) | |
Call a method of each tracked load balancer. | |
getChronologyProtector () | |
getScopedPHPBehaviorForCommit () | |
Make PHP ignore user aborts/disconnects until the returned value leaves scope. | |
initLoadBalancer (ILoadBalancer $lb) | |
shutdownChronologyProtector (ChronologyProtector $cp, $workCallback, $mode) | |
Get and record all of the staged DB positions into persistent memory storage. | |
Protected Attributes | |
string | $agent |
Agent name for query profiling. | |
ChronologyProtector | $chronProt |
bool | $cliMode |
Whether this PHP instance is for a CLI script. | |
LoggerInterface | $connLogger |
callable | $errorLogger |
Error logger. | |
string | $hostname |
Local hostname of the app server. | |
DatabaseDomain | $localDomain |
Local domain. | |
BagOStuff | $memCache |
LoggerInterface | $perfLogger |
object string | $profiler |
Class name or object With profileIn/profileOut methods. | |
LoggerInterface | $queryLogger |
string bool | $readOnlyReason = false |
Reason all LBs are read-only or false if not. | |
callable[] | $replicationWaitCallbacks = [] |
LoggerInterface | $replLogger |
array | $requestInfo |
Web request information about the client. | |
BagOStuff | $srvCache |
mixed | $ticket |
TransactionProfiler | $trxProfiler |
string bool | $trxRoundId = false |
String if a requested DBO_TRX transaction round is active. | |
WANObjectCache | $wanCache |
Private Member Functions | |
logIfMultiDbTransaction () | |
Log query info if multi DB transactions are going to be committed now. | |
Static Private Attributes | |
static | $loggerFields |
Additional Inherited Members | |
Public Attributes inherited from ILBFactory | |
const | SHUTDOWN_CHRONPROT_ASYNC = 1 |
const | SHUTDOWN_CHRONPROT_SYNC = 2 |
const | SHUTDOWN_NO_CHRONPROT = 0 |
An interface for generating database load balancers.
Definition at line 31 of file LBFactory.php.
LBFactory::__construct | ( | array | $conf | ) |
Construct a manager of ILoadBalancer objects.
Sub-classes will extend the required keys in $conf with additional parameters
$conf | $params Array with keys:
|
InvalidArgumentException |
Implements ILBFactory.
Reimplemented in LBFactoryMulti, LBFactorySimple, and LBFactorySingle.
Definition at line 79 of file LBFactory.php.
References $e, $params, as, DatabaseDomain\newFromId(), and DatabaseDomain\newUnspecified().
LBFactory::__destruct | ( | ) |
Definition at line 571 of file LBFactory.php.
References destroy().
LBFactory::appendPreShutdownTimeAsQuery | ( | $url, | |
$time | |||
) |
Append ?cpPosTime parameter to a URL for ChronologyProtector purposes if needed.
Note that unlike cookies, this works accross domains
string | $url | |
float | $time | UNIX timestamp just before shutdown() was called |
Implements ILBFactory.
Definition at line 537 of file LBFactory.php.
References ILBFactory\forEachLB(), ILoadBalancer\getServerCount(), and use.
|
finalprotected |
Base parameters to LoadBalancer::__construct()
Definition at line 490 of file LBFactory.php.
Referenced by LBFactorySingle\__construct(), LBFactoryMulti\newLoadBalancer(), and LBFactorySimple\newLoadBalancer().
LBFactory::beginMasterChanges | ( | $fname = __METHOD__ | ) |
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 allows for custom transaction rounds from any outer transaction scope.
string | $fname |
DBTransactionError |
Implements ILBFactory.
Definition at line 191 of file LBFactory.php.
References $fname, and forEachLBCallMethod().
Referenced by commitAndWaitForReplication().
LBFactory::closeAll | ( | ) |
Close all open database connections on all open load balancers.
Implements ILBFactory.
Definition at line 529 of file LBFactory.php.
References forEachLBCallMethod().
LBFactory::commitAll | ( | $fname = __METHOD__ , |
|
array | $options = [] |
||
) |
Commit open transactions on all connections.
This is useful for two main cases:
string | $fname | Caller name |
array | $options | Options map: |
Implements ILBFactory.
Definition at line 186 of file LBFactory.php.
References $fname, $options, commitMasterChanges(), and forEachLBCallMethod().
LBFactory::commitAndWaitForReplication | ( | $fname, | |
$ticket, | |||
array | $opts = [] |
||
) |
Convenience method for safely running commitMasterChanges()/waitForReplication()
This will commit and wait unless $ticket indicates it is unsafe to do so
string | $fname | Caller name (e.g. METHOD) |
mixed | $ticket | Result of getEmptyTransactionTicket() |
array | $opts | Options to waitForReplication() |
DBReplicationWaitError |
Implements ILBFactory.
Definition at line 387 of file LBFactory.php.
References $fname, beginMasterChanges(), commitMasterChanges(), and waitForReplication().
LBFactory::commitMasterChanges | ( | $fname = __METHOD__ , |
|
array | $options = [] |
||
) |
Commit changes on all master connections.
string | $fname | Caller name |
array | $options | Options map:
|
Exception |
Implements ILBFactory.
Definition at line 203 of file LBFactory.php.
References $e, $fname, $options, ILBFactory\forEachLB(), forEachLBCallMethod(), getScopedPHPBehaviorForCommit(), logIfMultiDbTransaction(), ILoadBalancer\runMasterPostTrxCallbacks(), and use.
Referenced by commitAll(), commitAndWaitForReplication(), and shutdown().
LBFactory::destroy | ( | ) |
Disables all load balancers.
All connections are closed, and any attempt to open a new connection will result in a DBAccessError.
Implements ILBFactory.
Definition at line 121 of file LBFactory.php.
References forEachLBCallMethod(), and shutdown().
Referenced by __destruct().
LBFactory::disableChronologyProtection | ( | ) |
Disable the ChronologyProtector for all load balancers.
This can be called at the start of special API entry points
Implements ILBFactory.
Definition at line 417 of file LBFactory.php.
References getChronologyProtector().
LBFactory::flushReplicaSnapshots | ( | $fname = __METHOD__ | ) |
Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot.
string | $fname | Caller name |
Implements ILBFactory.
Definition at line 182 of file LBFactory.php.
References $fname, and forEachLBCallMethod().
|
protected |
Call a method of each tracked load balancer.
string | $methodName | |
array | $args |
Definition at line 173 of file LBFactory.php.
References $args, array(), and ILBFactory\forEachLB().
Referenced by beginMasterChanges(), closeAll(), commitAll(), commitMasterChanges(), destroy(), flushReplicaSnapshots(), and rollbackMasterChanges().
|
protected |
Definition at line 424 of file LBFactory.php.
References ChronologyProtector\setLogger().
Referenced by disableChronologyProtection(), getChronologyProtectorTouched(), LBFactoryMulti\getExternalLB(), LBFactorySimple\getExternalLB(), LBFactoryMulti\getMainLB(), LBFactorySimple\getMainLB(), and shutdown().
LBFactory::getChronologyProtectorTouched | ( | $dbName | ) |
string | $dbName | DB master name (e.g. "db1052") |
Implements ILBFactory.
Definition at line 413 of file LBFactory.php.
References getChronologyProtector().
LBFactory::getEmptyTransactionTicket | ( | $fname | ) |
Get a token asserting that no transaction writes are active.
string | $fname | Caller name (e.g. METHOD) |
Implements ILBFactory.
Definition at line 376 of file LBFactory.php.
References hasMasterChanges().
|
abstract |
string | $cluster |
Implements ILBFactory.
Reimplemented in LBFactoryMulti, LBFactorySimple, and LBFactorySingle.
Referenced by waitForReplication().
|
abstract |
bool | $domain |
Implements ILBFactory.
Reimplemented in LBFactoryMulti, LBFactorySimple, and LBFactorySingle.
Referenced by waitForReplication().
|
finalprotected |
Make PHP ignore user aborts/disconnects until the returned value leaves scope.
This returns null and does nothing in CLI mode.
Definition at line 560 of file LBFactory.php.
References use.
Referenced by commitMasterChanges().
LBFactory::hasMasterChanges | ( | ) |
Determine if any master connection has pending changes.
Implements ILBFactory.
Definition at line 273 of file LBFactory.php.
References $ret, ILBFactory\forEachLB(), ILoadBalancer\hasMasterChanges(), and use.
Referenced by getEmptyTransactionTicket().
LBFactory::hasOrMadeRecentMasterChanges | ( | $age = null | ) |
Determine if any master connection has pending/written changes from this request.
float | $age | How many seconds ago is "recent" [defaults to LB lag wait timeout] |
Implements ILBFactory.
Definition at line 291 of file LBFactory.php.
References $ret, ILBFactory\forEachLB(), ILoadBalancer\hasOrMadeRecentMasterChanges(), and use.
LBFactory::hasTransactionRound | ( | ) |
Check if a transaction round is active.
Implements ILBFactory.
Definition at line 246 of file LBFactory.php.
|
protected |
ILoadBalancer | $lb |
Definition at line 511 of file LBFactory.php.
References ILoadBalancer\beginMasterChanges().
Referenced by LBFactorySingle\__construct(), LBFactoryMulti\newLoadBalancer(), and LBFactorySimple\newLoadBalancer().
LBFactory::laggedReplicaUsed | ( | ) |
Detemine if any lagged replica DB connection was used.
Implements ILBFactory.
Definition at line 282 of file LBFactory.php.
References $ret, ILBFactory\forEachLB(), ILoadBalancer\laggedReplicaUsed(), and use.
|
private |
Log query info if multi DB transactions are going to be committed now.
Definition at line 253 of file LBFactory.php.
References as, ILBFactory\forEachLB(), ILoadBalancer\getServerName(), ILoadBalancer\getWriterIndex(), ILoadBalancer\pendingMasterChangeCallers(), and use.
Referenced by commitMasterChanges().
|
abstract |
string | $cluster |
Implements ILBFactory.
Reimplemented in LBFactoryMulti, LBFactorySimple, and LBFactorySingle.
|
abstract |
bool | $domain |
Implements ILBFactory.
Reimplemented in LBFactoryMulti, LBFactorySimple, and LBFactorySingle.
LBFactory::rollbackMasterChanges | ( | $fname = __METHOD__ | ) |
Rollback changes on all master connections.
string | $fname | Caller name |
Implements ILBFactory.
Definition at line 236 of file LBFactory.php.
References $fname, ILBFactory\forEachLB(), forEachLBCallMethod(), and ILoadBalancer\runMasterPostTrxCallbacks().
LBFactory::setAgentName | ( | $agent | ) |
string | $agent | Agent name for query profiling |
Implements ILBFactory.
Definition at line 533 of file LBFactory.php.
LBFactory::setDomainPrefix | ( | $prefix | ) |
Set a new table prefix for the existing local domain ID for testing.
string | $prefix |
Implements ILBFactory.
Definition at line 517 of file LBFactory.php.
References ILBFactory\forEachLB(), ILoadBalancer\setDomainPrefix(), and use.
LBFactory::setRequestInfo | ( | array | $info | ) |
array | $info | Map of fields, including:
|
Implements ILBFactory.
Definition at line 550 of file LBFactory.php.
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 ILBFactory.
Definition at line 368 of file LBFactory.php.
References $name.
LBFactory::shutdown | ( | $mode = self::SHUTDOWN_CHRONPROT_SYNC , |
|
callable | $workCallback = null |
||
) |
Prepare all tracked load balancers for shutdown.
integer | $mode | One of the class SHUTDOWN_* constants |
callable | null | $workCallback | Work to mask ChronologyProtector writes |
Implements ILBFactory.
Definition at line 126 of file LBFactory.php.
References commitMasterChanges(), getChronologyProtector(), and shutdownChronologyProtector().
Referenced by destroy().
|
protected |
Get and record all of the staged DB positions into persistent memory storage.
ChronologyProtector | $cp | |
callable | null | $workCallback | Work to do instead of waiting on syncing positions |
string | $mode | One of (sync, async); whether to wait on remote datacenters |
Definition at line 460 of file LBFactory.php.
References ILBFactory\forEachLB(), ILoadBalancer\getServerName(), ILoadBalancer\getWriterIndex(), ChronologyProtector\shutdown(), ChronologyProtector\shutdownLB(), use, and ILoadBalancer\waitForAll().
Referenced by shutdown().
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.
array | $opts | Optional fields that include:
|
DBReplicationWaitError | If a timeout or error occured waiting on a DB cluster |
Implements ILBFactory.
Definition at line 299 of file LBFactory.php.
References as, ILBFactory\forEachLB(), getExternalLB(), getMainLB(), and use.
Referenced by commitAndWaitForReplication().
|
protected |
Agent name for query profiling.
Definition at line 74 of file LBFactory.php.
|
protected |
Definition at line 33 of file LBFactory.php.
|
protected |
Whether this PHP instance is for a CLI script.
Definition at line 72 of file LBFactory.php.
|
protected |
Definition at line 41 of file LBFactory.php.
|
protected |
Error logger.
Definition at line 47 of file LBFactory.php.
|
protected |
Local hostname of the app server.
Definition at line 58 of file LBFactory.php.
|
protected |
Local domain.
Definition at line 56 of file LBFactory.php.
|
staticprivate |
Definition at line 76 of file LBFactory.php.
|
protected |
Definition at line 51 of file LBFactory.php.
|
protected |
Definition at line 45 of file LBFactory.php.
|
protected |
Class name or object With profileIn/profileOut methods.
Definition at line 35 of file LBFactory.php.
|
protected |
Definition at line 43 of file LBFactory.php.
|
protected |
Reason all LBs are read-only or false if not.
Definition at line 67 of file LBFactory.php.
Referenced by LBFactoryMulti\newLoadBalancer(), and LBFactoryMulti\newMainLB().
|
protected |
Definition at line 69 of file LBFactory.php.
|
protected |
Definition at line 39 of file LBFactory.php.
|
protected |
Web request information about the client.
Definition at line 60 of file LBFactory.php.
|
protected |
Definition at line 49 of file LBFactory.php.
|
protected |
Definition at line 63 of file LBFactory.php.
|
protected |
Definition at line 37 of file LBFactory.php.
|
protected |
String if a requested DBO_TRX transaction round is active.
Definition at line 65 of file LBFactory.php.
|
protected |
Definition at line 53 of file LBFactory.php.