MediaWiki  REL1_31
Wikimedia\Rdbms\LBFactorySimple Class Reference

A simple single-master LBFactory that gets its configuration from the b/c globals. More...

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

Public Member Functions

 __construct (array $conf)
 
 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. More...
 
 getAllExternalLBs ()
 Get cached (tracked) load balancers for all external database clusters. More...
 
 getAllMainLBs ()
 Get cached (tracked) load balancers for all main database clusters. More...
 
 getExternalLB ( $cluster)
 
 getMainLB ( $domain=false)
 
 newExternalLB ( $cluster)
 
 newMainLB ( $domain=false)
 
- Public Member Functions inherited from Wikimedia\Rdbms\LBFactory
 __destruct ()
 
 appendShutdownCPIndexAsQuery ( $url, $index)
 Append ?cpPosIndex parameter to a URL for ChronologyProtector purposes if needed. More...
 
 beginMasterChanges ( $fname=__METHOD__)
 Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set) More...
 
 closeAll ()
 Close all open database connections on all open load balancers. More...
 
 commitAll ( $fname=__METHOD__, array $options=[])
 Commit open transactions on all connections. More...
 
 commitAndWaitForReplication ( $fname, $ticket, array $opts=[])
 Convenience method for safely running commitMasterChanges()/waitForReplication() More...
 
 commitMasterChanges ( $fname=__METHOD__, array $options=[])
 Commit changes on all master connections. More...
 
 destroy ()
 Disables all load balancers. More...
 
 disableChronologyProtection ()
 Disable the ChronologyProtector for all load balancers. More...
 
 flushReplicaSnapshots ( $fname=__METHOD__)
 Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot. More...
 
 getChronologyProtectorTouched ( $dbName)
 
 getEmptyTransactionTicket ( $fname)
 Get a token asserting that no transaction writes are active. More...
 
 hasMasterChanges ()
 Determine if any master connection has pending changes. More...
 
 hasOrMadeRecentMasterChanges ( $age=null)
 Determine if any master connection has pending/written changes from this request. More...
 
 hasTransactionRound ()
 Check if a transaction round is active. More...
 
 laggedReplicaUsed ()
 Detemine if any lagged replica DB connection was used. More...
 
 rollbackMasterChanges ( $fname=__METHOD__)
 Rollback changes on all master connections. More...
 
 setAgentName ( $agent)
 
 setDomainPrefix ( $prefix)
 Set a new table prefix for the existing local domain ID for testing. More...
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB. More...
 
 setRequestInfo (array $info)
 
 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 ( $mode=self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback=null, &$cpIndex=null)
 Prepare all tracked load balancers for shutdown. More...
 
 waitForReplication (array $opts=[])
 Waits for the replica DBs to catch up to the current master position. More...
 

Private Member Functions

 newLoadBalancer (array $servers)
 

Private Attributes

array[] $externalClusters = []
 Map of (cluster => (server index => server config)) More...
 
LoadBalancer[] $extLBs = []
 
string $loadMonitorClass
 
LoadBalancer $mainLB
 
int $maxLag
 
array[] $servers = []
 Map of (server index => server config) More...
 

Additional Inherited Members

- Public Attributes inherited from Wikimedia\Rdbms\ILBFactory
const SHUTDOWN_CHRONPROT_ASYNC = 1
 
const SHUTDOWN_CHRONPROT_SYNC = 2
 
const SHUTDOWN_NO_CHRONPROT = 0
 
- Protected Member Functions inherited from Wikimedia\Rdbms\LBFactory
 baseLoadBalancerParams ()
 Base parameters to LoadBalancer::__construct() More...
 
 forEachLBCallMethod ( $methodName, array $args=[])
 Call a method of each tracked load balancer. More...
 
 getChronologyProtector ()
 
 getScopedPHPBehaviorForCommit ()
 Make PHP ignore user aborts/disconnects until the returned value leaves scope. More...
 
 initLoadBalancer (ILoadBalancer $lb)
 
 shutdownChronologyProtector (ChronologyProtector $cp, $workCallback, $mode, &$cpIndex=null)
 Get and record all of the staged DB positions into persistent memory storage. More...
 
- Protected Attributes inherited from Wikimedia\Rdbms\LBFactory
string $agent
 Agent name for query profiling. More...
 
ChronologyProtector $chronProt
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
LoggerInterface $connLogger
 
callable $deprecationLogger
 Deprecation logger. More...
 
callable $errorLogger
 Error logger. More...
 
string $hostname
 Local hostname of the app server. More...
 
string[] $indexAliases = []
 Map of (index alias => index) More...
 
DatabaseDomain $localDomain
 Local domain. More...
 
BagOStuff $memStash
 
LoggerInterface $perfLogger
 
object string $profiler
 Class name or object With profileIn/profileOut methods. More...
 
LoggerInterface $queryLogger
 
string bool $readOnlyReason = false
 Reason all LBs are read-only or false if not. More...
 
callable[] $replicationWaitCallbacks = []
 
LoggerInterface $replLogger
 
array $requestInfo
 Web request information about the client. More...
 
BagOStuff $srvCache
 
 $tableAliases = []
 
mixed $ticket
 
TransactionProfiler $trxProfiler
 
string bool $trxRoundId = false
 String if a requested DBO_TRX transaction round is active. More...
 
WANObjectCache $wanCache
 

Detailed Description

A simple single-master LBFactory that gets its configuration from the b/c globals.

Definition at line 31 of file LBFactorySimple.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\LBFactorySimple::__construct ( array  $conf)
See also
LBFactory::__construct()
Parameters
array$confParameters of LBFactory::__construct() as well as:
  • servers : list of server configuration maps to Database::factory(). Additionally, the server maps should have a 'load' key, which is used to decide how often clients connect to one server verses the others. A 'max lag' key should also be set on server maps, indicating how stale the data can be before the load balancer tries to avoid using it. The map can have 'is static' set to disable blocking replication sync checks (intended for archive servers with unchanging data).
  • externalClusters : map of cluster names to server arrays. The servers arrays have the same format as "servers" above.

Reimplemented from Wikimedia\Rdbms\LBFactory.

Definition at line 62 of file LBFactorySimple.php.

References as, and servers.

Member Function Documentation

◆ forEachLB()

Wikimedia\Rdbms\LBFactorySimple::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.

Parameters
callable$callback
array$params

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 154 of file LBFactorySimple.php.

References $params, and as.

◆ getAllExternalLBs()

Wikimedia\Rdbms\LBFactorySimple::getAllExternalLBs ( )

Get cached (tracked) load balancers for all external database clusters.

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

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 123 of file LBFactorySimple.php.

References as, and Wikimedia\Rdbms\LBFactorySimple\getExternalLB().

◆ getAllMainLBs()

Wikimedia\Rdbms\LBFactorySimple::getAllMainLBs ( )

Get cached (tracked) load balancers for all main database clusters.

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

Implements Wikimedia\Rdbms\ILBFactory.

Definition at line 119 of file LBFactorySimple.php.

References Wikimedia\Rdbms\LBFactorySimple\getMainLB().

◆ getExternalLB()

Wikimedia\Rdbms\LBFactorySimple::getExternalLB (   $cluster)
See also
ILBFactory::getExternalLB()
Parameters
string$cluster
Returns
LoadBalancer

Reimplemented from Wikimedia\Rdbms\LBFactory.

Definition at line 111 of file LBFactorySimple.php.

References Wikimedia\Rdbms\LBFactorySimple\newExternalLB().

Referenced by Wikimedia\Rdbms\LBFactorySimple\getAllExternalLBs().

◆ getMainLB()

Wikimedia\Rdbms\LBFactorySimple::getMainLB (   $domain = false)
Parameters
bool | string$domain
Returns
LoadBalancer

Reimplemented from Wikimedia\Rdbms\LBFactory.

Definition at line 95 of file LBFactorySimple.php.

References Wikimedia\Rdbms\LBFactorySimple\$mainLB, and Wikimedia\Rdbms\LBFactorySimple\newMainLB().

Referenced by Wikimedia\Rdbms\LBFactorySimple\getAllMainLBs().

◆ newExternalLB()

Wikimedia\Rdbms\LBFactorySimple::newExternalLB (   $cluster)
See also
ILBFactory::newExternalLB()
Parameters
string$cluster
Returns
LoadBalancer

Reimplemented from Wikimedia\Rdbms\LBFactory.

Definition at line 103 of file LBFactorySimple.php.

References Wikimedia\Rdbms\LBFactorySimple\newLoadBalancer().

Referenced by Wikimedia\Rdbms\LBFactorySimple\getExternalLB().

◆ newLoadBalancer()

Wikimedia\Rdbms\LBFactorySimple::newLoadBalancer ( array  $servers)
private

◆ newMainLB()

Wikimedia\Rdbms\LBFactorySimple::newMainLB (   $domain = false)
Parameters
bool | string$domain
Returns
LoadBalancer

Reimplemented from Wikimedia\Rdbms\LBFactory.

Definition at line 87 of file LBFactorySimple.php.

References Wikimedia\Rdbms\LBFactorySimple\newLoadBalancer(), and servers.

Referenced by Wikimedia\Rdbms\LBFactorySimple\getMainLB().

Member Data Documentation

◆ $externalClusters

array [] Wikimedia\Rdbms\LBFactorySimple::$externalClusters = []
private

Map of (cluster => (server index => server config))

Definition at line 40 of file LBFactorySimple.php.

◆ $extLBs

LoadBalancer [] Wikimedia\Rdbms\LBFactorySimple::$extLBs = []
private

Definition at line 35 of file LBFactorySimple.php.

◆ $loadMonitorClass

string Wikimedia\Rdbms\LBFactorySimple::$loadMonitorClass
private

Definition at line 43 of file LBFactorySimple.php.

◆ $mainLB

LoadBalancer Wikimedia\Rdbms\LBFactorySimple::$mainLB
private

Definition at line 33 of file LBFactorySimple.php.

Referenced by Wikimedia\Rdbms\LBFactorySimple\getMainLB().

◆ $maxLag

int Wikimedia\Rdbms\LBFactorySimple::$maxLag
private

Definition at line 45 of file LBFactorySimple.php.

◆ $servers

array [] Wikimedia\Rdbms\LBFactorySimple::$servers = []
private

Map of (server index => server config)

Definition at line 38 of file LBFactorySimple.php.


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