MediaWiki REL1_37
|
An LBFactory class that always returns a single database object. More...
Public Member Functions | |
__construct (array $conf) | |
You probably want to use newFromConnection instead. | |
__destruct () | |
forEachLB ( $callback, array $params=[]) | |
Execute a function for each instantiated tracked load balancer instance. | |
getAllExternalLBs () | |
Get the tracked load balancer instances for all external clusters. | |
getAllMainLBs () | |
Get the tracked load balancer instances for all main clusters. | |
getExternalLB ( $cluster) | |
Get the tracked load balancer instance for an external cluster. | |
getMainLB ( $domain=false) | |
Get the tracked load balancer instance for a main cluster. | |
newExternalLB ( $cluster, $owner=null) | |
Create a new load balancer instance for an external cluster. | |
newMainLB ( $domain=false, $owner=null) | |
Create a new load balancer instance for a main cluster. | |
Public Member Functions inherited from Wikimedia\Rdbms\LBFactory | |
appendShutdownCPIndexAsQuery ( $url, $index) | |
Append ?cpPosIndex parameter to a URL for ChronologyProtector purposes if needed. | |
beginMasterChanges ( $fname=__METHOD__) | |
beginPrimaryChanges ( $fname=__METHOD__) | |
Flush any primary transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set) | |
closeAll () | |
Close all connections on instantiated tracked load balancer instances. | |
commitAll ( $fname=__METHOD__, array $options=[]) | |
Commit open transactions on all connections. | |
commitAndWaitForReplication ( $fname, $ticket, array $opts=[]) | |
Call commitPrimaryChanges() and waitForReplication() if $ticket indicates it is safe. | |
commitMasterChanges ( $fname=__METHOD__, array $options=[]) | |
commitPrimaryChanges ( $fname=__METHOD__, array $options=[]) | |
Commit changes and clear view snapshots on all primary connections. | |
destroy () | |
Close all connections and make further attempts to open connections result in DBAccessError. | |
disableChronologyProtection () | |
Disable the ChronologyProtector on all instantiated tracked load balancer instances. | |
flushReplicaSnapshots ( $fname=__METHOD__) | |
Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot. | |
getChronologyProtectorClientId () | |
Get the client ID of the ChronologyProtector instance. | |
getChronologyProtectorTouched ( $domain=false) | |
Get the UNIX timestamp when the client last touched the DB, if they did so recently. | |
getEmptyTransactionTicket ( $fname) | |
Get a token asserting that no transaction writes are active on tracked load balancers. | |
getLocalDomainID () | |
Get the local (and default) database domain ID of connection handles. | |
getTransactionProfiler () | |
Get the TransactionProfiler used by this instance. | |
hasMasterChanges () | |
hasOrMadeRecentMasterChanges ( $age=null) | |
hasOrMadeRecentPrimaryChanges ( $age=null) | |
Determine if any primary connection has pending/written changes from this request. | |
hasPrimaryChanges () | |
Determine if any primary connection has pending changes. | |
hasTransactionRound () | |
Check if an explicit transaction round is active. | |
isReadyForRoundOperations () | |
Check if transaction rounds can be started, committed, or rolled back right now. | |
laggedReplicaUsed () | |
Detemine if any lagged replica DB connection was used. | |
redefineLocalDomain ( $domain) | |
Close all connections and redefine the local domain for testing or schema creation. | |
resolveDomainID ( $domain) | |
rollbackMasterChanges ( $fname=__METHOD__) | |
rollbackPrimaryChanges ( $fname=__METHOD__) | |
Rollback changes on all primary connections. | |
setAgentName ( $agent) | |
setDefaultReplicationWaitTimeout ( $seconds) | |
Set the default timeout for replication wait checks. | |
setDomainAliases (array $aliases) | |
Convert certain database domains to alternative ones. | |
setIndexAliases (array $aliases) | |
Convert certain index names to alternative names before querying the DB. | |
setLocalDomainPrefix ( $prefix) | |
Set a new table prefix for the existing local domain ID for testing. | |
setMockTime (&$time) | |
setRequestInfo (array $info) | |
Inject HTTP request header/cookie information during setup of this instance. | |
setTableAliases (array $aliases) | |
Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. | |
setWaitForReplicationListener ( $name, callable $callback=null) | |
Add a callback to be run in every call to waitForReplication() before waiting. | |
shutdown ( $flags=self::SHUTDOWN_NORMAL, callable $workCallback=null, &$cpIndex=null, &$cpClientId=null) | |
Prepare all instantiated tracked load balancer instances for shutdown. | |
waitForReplication (array $opts=[]) | |
Waits for the replica DBs to catch up to the current primary position. | |
Static Public Member Functions | |
static | newFromConnection (IDatabase $db, array $params=[]) |
Static Public Member Functions inherited from Wikimedia\Rdbms\LBFactory | |
static | getCPInfoFromCookieValue (?string $value, int $minTimestamp) |
Parse a string conveying the client and write index of the chronology protector data. | |
static | makeCookieValueFromCPIndex (int $writeIndex, int $time, string $clientId) |
Build a string conveying the client and write index of the chronology protector data. | |
Private Attributes | |
LoadBalancerSingle | $lb |
Additional Inherited Members | |
Public Attributes inherited from Wikimedia\Rdbms\ILBFactory | |
const | SHUTDOWN_NO_CHRONPROT = 1 |
Do not save "session consistency" DB replication positions. | |
const | SHUTDOWN_NORMAL = 0 |
Idion for "no special shutdown flags". | |
Protected Member Functions inherited from Wikimedia\Rdbms\LBFactory | |
baseLoadBalancerParams ( $owner) | |
Get parameters to ILoadBalancer::__construct() | |
forEachLBCallMethod ( $methodName, array $args=[]) | |
Call a method on each tracked (instantiated) load balancer instance. | |
getChronologyProtector () | |
getOwnershipId () | |
initLoadBalancer (ILoadBalancer $lb) | |
resolveDomainInstance ( $domain) | |
shutdownChronologyProtector (ChronologyProtector $cp, $workCallback, &$cpIndex=null) | |
Get and record all of the staged DB positions into persistent memory storage. | |
Protected Attributes inherited from Wikimedia\Rdbms\LBFactory | |
BagOStuff | $cpStash |
DatabaseDomain | $localDomain |
Local domain. | |
int null | $maxLag |
string bool | $readOnlyReason = false |
Reason all LBs are read-only or false if not. | |
BagOStuff | $srvCache |
WANObjectCache | $wanCache |
An LBFactory class that always returns a single database object.
Definition at line 32 of file LBFactorySingle.php.
Wikimedia\Rdbms\LBFactorySingle::__construct | ( | array | $conf | ) |
You probably want to use newFromConnection
instead.
array | $conf | An associative array with one member:
|
Reimplemented from Wikimedia\Rdbms\LBFactory.
Definition at line 42 of file LBFactorySingle.php.
References Wikimedia\Rdbms\LBFactorySingle\$lb, Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams(), Wikimedia\Rdbms\LBFactory\getOwnershipId(), and Wikimedia\Rdbms\LBFactory\initLoadBalancer().
Wikimedia\Rdbms\LBFactorySingle::__destruct | ( | ) |
Reimplemented from Wikimedia\Rdbms\LBFactory.
Definition at line 105 of file LBFactorySingle.php.
Wikimedia\Rdbms\LBFactorySingle::forEachLB | ( | $callback, | |
array | $params = [] |
||
) |
Execute a function for each instantiated tracked load balancer instance.
The callback is called with the load balancer as the first parameter, and $params passed as the subsequent parameters.
callable | $callback | |
array | $params |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 99 of file LBFactorySingle.php.
Wikimedia\Rdbms\LBFactorySingle::getAllExternalLBs | ( | ) |
Get the tracked load balancer instances for all external clusters.
If no tracked instance exists for a cluster, then one will be instantiated
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 95 of file LBFactorySingle.php.
Wikimedia\Rdbms\LBFactorySingle::getAllMainLBs | ( | ) |
Get the tracked load balancer instances for all main clusters.
If no tracked instance exists for a cluster, then one will be instantiated
Note that default main cluster name is ILoadBalancer::CLUSTER_MAIN_DEFAULT
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 91 of file LBFactorySingle.php.
Wikimedia\Rdbms\LBFactorySingle::getExternalLB | ( | $cluster | ) |
Get the tracked load balancer instance for an external cluster.
If no tracked instances exists, then one will be instantiated
string | $cluster | External cluster name |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 86 of file LBFactorySingle.php.
Wikimedia\Rdbms\LBFactorySingle::getMainLB | ( | $domain = false | ) |
Get the tracked load balancer instance for a main cluster.
If no tracked instances exists, then one will be instantiated
bool | string | $domain | Domain ID, or false for the current domain |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 77 of file LBFactorySingle.php.
Wikimedia\Rdbms\LBFactorySingle::newExternalLB | ( | $cluster, | |
$owner = null |
|||
) |
Create a new load balancer instance for an external cluster.
The resulting object will be untracked and the caller is responsible for cleaning it up. Database replication positions will not be saved by ChronologyProtector.
This method is for only advanced usage and callers should almost always use getExternalLB() instead. This method can be useful when a table is used as a key/value store. In that cases, one might want to query it in autocommit mode (DBO_TRX off) but still use DBO_TRX transaction rounds on other tables.
string | $cluster | External cluster name |
int | null | $owner | Owner ID of the new instance (e.g. this LBFactory ID) |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 81 of file LBFactorySingle.php.
|
static |
IDatabase | $db | Live connection handle |
array | $params | Parameter map to LBFactorySingle::__constructs() |
Definition at line 64 of file LBFactorySingle.php.
References Wikimedia\Rdbms\IDatabase\getDomainID().
Wikimedia\Rdbms\LBFactorySingle::newMainLB | ( | $domain = false , |
|
$owner = null |
|||
) |
Create a new load balancer instance for a main cluster.
The resulting object will be untracked and the caller is responsible for cleaning it up. Database replication positions will not be saved by ChronologyProtector.
This method is for only advanced usage and callers should almost always use getMainLB() instead. This method can be useful when a table is used as a key/value store. In that cases, one might want to query it in autocommit mode (DBO_TRX off) but still use DBO_TRX transaction rounds on other tables.
bool | string | $domain | Domain ID, or false for the current domain |
int | null | $owner | Owner ID of the new instance (e.g. this LBFactory ID) |
Implements Wikimedia\Rdbms\ILBFactory.
Definition at line 72 of file LBFactorySingle.php.
|
private |
Definition at line 34 of file LBFactorySingle.php.
Referenced by Wikimedia\Rdbms\LBFactorySingle\__construct().