MediaWiki  master
Wikimedia\Rdbms\LBFactorySingle Class Reference

An LBFactory class that always returns a single database object. More...

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

Public Member Functions

 __construct (array $conf)
 You probably want to use newFromConnection instead. More...
 
 __destruct ()
 
 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...
 
- Public Member Functions inherited from Wikimedia\Rdbms\LBFactory
 appendShutdownCPIndexAsQuery ( $url, $index)
 Append ?cpPosIndex parameter to a URL for ChronologyProtector purposes if needed. 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...
 
 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...
 

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

 getLBsForOwner ()
 Get all tracked load balancers with the internal "for owner" interface. More...
 
- Protected Member Functions inherited from Wikimedia\Rdbms\LBFactory
 baseLoadBalancerParams ()
 Get parameters to ILoadBalancer::__construct() More...
 
 getChronologyProtector ()
 
 initLoadBalancer (ILoadBalancerForOwner $lb)
 
 resolveDomainInstance ( $domain)
 
 shutdownChronologyProtector (ChronologyProtector $cp, $workCallback, &$cpIndex=null)
 Get and record all of the staged DB positions into persistent memory storage. More...
 

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. More...
 
const SHUTDOWN_NORMAL = 0
 Idiom for "no special shutdown flags". More...
 
- Protected Attributes inherited from Wikimedia\Rdbms\LBFactory
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
 

Detailed Description

An LBFactory class that always returns a single database object.

Definition at line 32 of file LBFactorySingle.php.

Constructor & Destructor Documentation

◆ __construct()

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

You probably want to use newFromConnection instead.

Parameters
array$confAn associative array with one member:
  • connection: The IDatabase connection object

Reimplemented from Wikimedia\Rdbms\LBFactory.

Definition at line 42 of file LBFactorySingle.php.

References Wikimedia\Rdbms\LBFactorySingle\$lb, Wikimedia\Rdbms\LBFactory\baseLoadBalancerParams(), and Wikimedia\Rdbms\LBFactory\initLoadBalancer().

◆ __destruct()

Wikimedia\Rdbms\LBFactorySingle::__destruct ( )

Reimplemented from Wikimedia\Rdbms\LBFactory.

Definition at line 112 of file LBFactorySingle.php.

Member Function Documentation

◆ forEachLB()

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.

Deprecated:
since 1.39 use getAllLBs()
Parameters
callable$callback
array$params

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 99 of file LBFactorySingle.php.

References wfDeprecated().

◆ getAllExternalLBs()

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

Returns
ILoadBalancer[] Map of (cluster name => ILoadBalancer)
Since
1.29

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 95 of file LBFactorySingle.php.

◆ getAllMainLBs()

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

Returns
ILoadBalancer[] Map of (cluster name => ILoadBalancer)
Since
1.29

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 91 of file LBFactorySingle.php.

◆ getExternalLB()

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

Parameters
string$clusterExternal cluster name
Exceptions
InvalidArgumentExceptionIf $cluster is not recognized
Returns
ILoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 86 of file LBFactorySingle.php.

◆ getLBsForOwner()

Wikimedia\Rdbms\LBFactorySingle::getLBsForOwner ( )
protected

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 from Wikimedia\Rdbms\LBFactory.

Definition at line 106 of file LBFactorySingle.php.

◆ getMainLB()

Wikimedia\Rdbms\LBFactorySingle::getMainLB (   $domain = false)

Get the tracked load balancer instance for the main cluster that handles the given domain.

If no tracked instances exists, then one will be instantiated

Note
The local/default database domain used by the load balancer instance will still inherit from this ILBFactory instance, regardless of the $domain parameter.
Parameters
bool | string$domainDomain ID, or false for the current domain
Returns
ILoadBalancer

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 77 of file LBFactorySingle.php.

◆ newExternalLB()

Wikimedia\Rdbms\LBFactorySingle::newExternalLB (   $cluster)

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.

Parameters
string$clusterExternal cluster name
Exceptions
InvalidArgumentExceptionIf $cluster is not recognized
Returns
ILoadBalancerForOwner

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 81 of file LBFactorySingle.php.

◆ newFromConnection()

static Wikimedia\Rdbms\LBFactorySingle::newFromConnection ( IDatabase  $db,
array  $params = [] 
)
static
Parameters
IDatabase$dbLive connection handle
array$paramsParameter map to LBFactorySingle::__constructs()
Returns
LBFactorySingle
Since
1.28

Definition at line 64 of file LBFactorySingle.php.

References Wikimedia\Rdbms\IDatabase\getDomainID().

◆ newMainLB()

Wikimedia\Rdbms\LBFactorySingle::newMainLB (   $domain = false)

Create a new load balancer instance for the main cluster that handles the given domain.

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.

Note
The local/default database domain used by the load balancer instance will still inherit from this ILBFactory instance, regardless of the $domain parameter.
Parameters
bool | string$domainDomain ID, or false for the current domain
Returns
ILoadBalancerForOwner

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 72 of file LBFactorySingle.php.

Member Data Documentation

◆ $lb

LoadBalancerSingle Wikimedia\Rdbms\LBFactorySingle::$lb
private

Definition at line 34 of file LBFactorySingle.php.

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


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