MediaWiki  REL1_31
ILBFactory.php
Go to the documentation of this file.
1 <?php
24 namespace Wikimedia\Rdbms;
25 
26 use InvalidArgumentException;
27 
33 interface ILBFactory {
34  const SHUTDOWN_NO_CHRONPROT = 0; // don't save DB positions at all
35  const SHUTDOWN_CHRONPROT_ASYNC = 1; // save DB positions, but don't wait on remote DCs
36  const SHUTDOWN_CHRONPROT_SYNC = 2; // save DB positions, waiting on all DCs
37 
61  public function __construct( array $conf );
62 
68  public function destroy();
69 
82  public function newMainLB( $domain = false );
83 
90  public function getMainLB( $domain = false );
91 
104  public function newExternalLB( $cluster );
105 
112  public function getExternalLB( $cluster );
113 
120  public function getAllMainLBs();
121 
128  public function getAllExternalLBs();
129 
138  public function forEachLB( $callback, array $params = [] );
139 
146  public function shutdown(
147  $mode = self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback = null, &$cpIndex = null
148  );
149 
155  public function flushReplicaSnapshots( $fname = __METHOD__ );
156 
165  public function commitAll( $fname = __METHOD__, array $options = [] );
166 
180  public function beginMasterChanges( $fname = __METHOD__ );
181 
189  public function commitMasterChanges( $fname = __METHOD__, array $options = [] );
190 
195  public function rollbackMasterChanges( $fname = __METHOD__ );
196 
202  public function hasTransactionRound();
203 
208  public function hasMasterChanges();
209 
214  public function laggedReplicaUsed();
215 
221  public function hasOrMadeRecentMasterChanges( $age = null );
222 
246  public function waitForReplication( array $opts = [] );
247 
256  public function setWaitForReplicationListener( $name, callable $callback = null );
257 
264  public function getEmptyTransactionTicket( $fname );
265 
276  public function commitAndWaitForReplication( $fname, $ticket, array $opts = [] );
277 
282  public function getChronologyProtectorTouched( $dbName );
283 
289  public function disableChronologyProtection();
290 
296  public function setDomainPrefix( $prefix );
297 
301  public function closeAll();
302 
306  public function setAgentName( $agent );
307 
317  public function appendShutdownCPIndexAsQuery( $url, $time );
318 
326  public function setRequestInfo( array $info );
327 
341  public function setTableAliases( array $aliases );
342 
356  public function setIndexAliases( array $aliases );
357 }
$time
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1795
Wikimedia\Rdbms\ILBFactory\setRequestInfo
setRequestInfo(array $info)
Wikimedia\Rdbms\ILBFactory\setTableAliases
setTableAliases(array $aliases)
Make certain table names use their own database, schema, and table prefix when passed into SQL querie...
Wikimedia\Rdbms\ILBFactory\SHUTDOWN_CHRONPROT_SYNC
const SHUTDOWN_CHRONPROT_SYNC
Definition: ILBFactory.php:36
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
Wikimedia\Rdbms\ILBFactory\__construct
__construct(array $conf)
Construct a manager of ILoadBalancer objects.
array
the array() calling protocol came about after MediaWiki 1.4rc1.
Wikimedia\Rdbms\ILBFactory\waitForReplication
waitForReplication(array $opts=[])
Waits for the replica DBs to catch up to the current master position.
Wikimedia\Rdbms\ILBFactory\rollbackMasterChanges
rollbackMasterChanges( $fname=__METHOD__)
Rollback changes on all master connections.
Wikimedia\Rdbms
Definition: ChronologyProtector.php:24
$params
$params
Definition: styleTest.css.php:40
Wikimedia\Rdbms\ILBFactory\forEachLB
forEachLB( $callback, array $params=[])
Execute a function for each tracked load balancer The callback is called with the load balancer as th...
Wikimedia\Rdbms\ILBFactory\getAllExternalLBs
getAllExternalLBs()
Get cached (tracked) load balancers for all external database clusters.
Wikimedia\Rdbms\ILBFactory\getMainLB
getMainLB( $domain=false)
Get a cached (tracked) load balancer object.
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
Wikimedia\Rdbms\ILBFactory\getChronologyProtectorTouched
getChronologyProtectorTouched( $dbName)
Wikimedia\Rdbms\ILBFactory\newExternalLB
newExternalLB( $cluster)
Create a new load balancer for external storage.
Wikimedia\Rdbms\ILBFactory\getExternalLB
getExternalLB( $cluster)
Get a cached (tracked) load balancer for external storage.
Wikimedia\Rdbms\ILBFactory\disableChronologyProtection
disableChronologyProtection()
Disable the ChronologyProtector for all load balancers.
Wikimedia\Rdbms\ILBFactory\setWaitForReplicationListener
setWaitForReplicationListener( $name, callable $callback=null)
Add a callback to be run in every call to waitForReplication() before waiting.
Wikimedia\Rdbms\ILBFactory\setDomainPrefix
setDomainPrefix( $prefix)
Set a new table prefix for the existing local domain ID for testing.
Wikimedia\Rdbms\ILBFactory\getAllMainLBs
getAllMainLBs()
Get cached (tracked) load balancers for all main database clusters.
Wikimedia\Rdbms\ILBFactory\newMainLB
newMainLB( $domain=false)
Create a new load balancer object.
Wikimedia\Rdbms\ILBFactory\appendShutdownCPIndexAsQuery
appendShutdownCPIndexAsQuery( $url, $time)
Append ?cpPosIndex parameter to a URL for ChronologyProtector purposes if needed.
Wikimedia\Rdbms\ILBFactory\commitAll
commitAll( $fname=__METHOD__, array $options=[])
Commit open transactions on all connections.
Wikimedia\Rdbms\ILBFactory\closeAll
closeAll()
Close all open database connections on all open load balancers.
$fname
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings,...
Definition: Setup.php:112
$options
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped & $options
Definition: hooks.txt:2001
Wikimedia\Rdbms\ILBFactory\hasTransactionRound
hasTransactionRound()
Check if a transaction round is active.
Wikimedia\Rdbms\ILBFactory\laggedReplicaUsed
laggedReplicaUsed()
Detemine if any lagged replica DB connection was used.
Wikimedia\Rdbms\ILBFactory\shutdown
shutdown( $mode=self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback=null, &$cpIndex=null)
Prepare all tracked load balancers for shutdown.
Wikimedia\Rdbms\ILBFactory\commitAndWaitForReplication
commitAndWaitForReplication( $fname, $ticket, array $opts=[])
Convenience method for safely running commitMasterChanges()/waitForReplication()
Wikimedia\Rdbms\ILBFactory\beginMasterChanges
beginMasterChanges( $fname=__METHOD__)
Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set)
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
Wikimedia\Rdbms\ILBFactory\SHUTDOWN_NO_CHRONPROT
const SHUTDOWN_NO_CHRONPROT
Definition: ILBFactory.php:34
Wikimedia\Rdbms\ILBFactory\commitMasterChanges
commitMasterChanges( $fname=__METHOD__, array $options=[])
Commit changes on all master connections.
Wikimedia\Rdbms\ILBFactory\hasOrMadeRecentMasterChanges
hasOrMadeRecentMasterChanges( $age=null)
Determine if any master connection has pending/written changes from this request.
Wikimedia\Rdbms\ILBFactory\destroy
destroy()
Disables all load balancers.
Wikimedia\Rdbms\ILBFactory\flushReplicaSnapshots
flushReplicaSnapshots( $fname=__METHOD__)
Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot.
Wikimedia\Rdbms\ILBFactory\getEmptyTransactionTicket
getEmptyTransactionTicket( $fname)
Get a token asserting that no transaction writes are active.
Wikimedia\Rdbms\ILBFactory\hasMasterChanges
hasMasterChanges()
Determine if any master connection has pending changes.
Wikimedia\Rdbms\ILBFactory
An interface for generating database load balancers.
Definition: ILBFactory.php:33
Wikimedia\Rdbms\ILBFactory\setIndexAliases
setIndexAliases(array $aliases)
Convert certain index names to alternative names before querying the DB.
Wikimedia\Rdbms\ILBFactory\setAgentName
setAgentName( $agent)
Wikimedia\Rdbms\ILBFactory\SHUTDOWN_CHRONPROT_ASYNC
const SHUTDOWN_CHRONPROT_ASYNC
Definition: ILBFactory.php:35