MediaWiki  master
ILBFactory.php
Go to the documentation of this file.
1 <?php
24 namespace Wikimedia\Rdbms;
25 
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 
63  public function __construct( array $conf );
64 
70  public function destroy();
71 
79  public function getLocalDomainID();
80 
86  public function resolveDomainID( $domain );
87 
94  public function redefineLocalDomain( $domain );
95 
108  public function newMainLB( $domain = false );
109 
116  public function getMainLB( $domain = false );
117 
130  public function newExternalLB( $cluster );
131 
138  public function getExternalLB( $cluster );
139 
146  public function getAllMainLBs();
147 
154  public function getAllExternalLBs();
155 
164  public function forEachLB( $callback, array $params = [] );
165 
173  public function shutdown(
174  $mode = self::SHUTDOWN_CHRONPROT_SYNC,
175  callable $workCallback = null,
176  &$cpIndex = null,
177  &$cpClientId = null
178  );
179 
187  public function flushReplicaSnapshots( $fname = __METHOD__ );
188 
197  public function commitAll( $fname = __METHOD__, array $options = [] );
198 
212  public function beginMasterChanges( $fname = __METHOD__ );
213 
221  public function commitMasterChanges( $fname = __METHOD__, array $options = [] );
222 
227  public function rollbackMasterChanges( $fname = __METHOD__ );
228 
234  public function hasTransactionRound();
235 
244  public function isReadyForRoundOperations();
245 
250  public function hasMasterChanges();
251 
256  public function laggedReplicaUsed();
257 
263  public function hasOrMadeRecentMasterChanges( $age = null );
264 
288  public function waitForReplication( array $opts = [] );
289 
298  public function setWaitForReplicationListener( $name, callable $callback = null );
299 
306  public function getEmptyTransactionTicket( $fname );
307 
318  public function commitAndWaitForReplication( $fname, $ticket, array $opts = [] );
319 
324  public function getChronologyProtectorTouched( $dbName );
325 
331  public function disableChronologyProtection();
332 
339  public function setLocalDomainPrefix( $prefix );
340 
344  public function closeAll();
345 
349  public function setAgentName( $agent );
350 
360  public function appendShutdownCPIndexAsQuery( $url, $index );
361 
368  public function getChronologyProtectorClientId();
369 
377  public function setRequestInfo( array $info );
378 
392  public function setTableAliases( array $aliases );
393 
406  public function setIndexAliases( array $aliases );
407 }
newExternalLB( $cluster)
Create a new load balancer for external storage.
beginMasterChanges( $fname=__METHOD__)
Flush any master transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set)
commitAll( $fname=__METHOD__, array $options=[])
Commit open transactions on all connections.
closeAll()
Close all open database connections on all open load balancers.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
rollbackMasterChanges( $fname=__METHOD__)
Rollback changes on all master connections.
disableChronologyProtection()
Disable the ChronologyProtector for all load balancers.
hasOrMadeRecentMasterChanges( $age=null)
Determine if any master connection has pending/written changes from this request. ...
getAllMainLBs()
Get cached (tracked) load balancers for all main database clusters.
waitForReplication(array $opts=[])
Waits for the replica DBs to catch up to the current master position.
newMainLB( $domain=false)
Create a new load balancer object.
getChronologyProtectorClientId()
Get the client ID of the ChronologyProtector instance.
__construct(array $conf)
Construct a manager of ILoadBalancer objects.
getEmptyTransactionTicket( $fname)
Get a token asserting that no transaction writes are active.
setTableAliases(array $aliases)
Make certain table names use their own database, schema, and table prefix when passed into SQL querie...
shutdown( $mode=self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback=null, &$cpIndex=null, &$cpClientId=null)
Prepare all tracked load balancers for shutdown.
laggedReplicaUsed()
Detemine if any lagged replica DB connection was used.
forEachLB( $callback, array $params=[])
Execute a function for each tracked load balancer The callback is called with the load balancer as th...
setIndexAliases(array $aliases)
Convert certain index names to alternative names before querying the DB.
flushReplicaSnapshots( $fname=__METHOD__)
Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshot.
getLocalDomainID()
Get the local (and default) database domain ID of connection handles.
hasTransactionRound()
Check if an explicit transaction round is active.
redefineLocalDomain( $domain)
Close all connection and redefine the local domain for testing or schema creation.
commitAndWaitForReplication( $fname, $ticket, array $opts=[])
Convenience method for safely running commitMasterChanges()/waitForReplication()
$params
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:1972
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
commitMasterChanges( $fname=__METHOD__, array $options=[])
Commit changes and clear view snapshots on all master connections.
hasMasterChanges()
Determine if any master connection has pending changes.
appendShutdownCPIndexAsQuery( $url, $index)
Append ?cpPosIndex parameter to a URL for ChronologyProtector purposes if needed. ...
setWaitForReplicationListener( $name, callable $callback=null)
Add a callback to be run in every call to waitForReplication() before waiting.
if(defined( 'MW_SETUP_CALLBACK')) $fname
Customization point after all loading (constants, functions, classes, DefaultSettings, LocalSettings).
Definition: Setup.php:131
getMainLB( $domain=false)
Get a cached (tracked) load balancer object.
isReadyForRoundOperations()
Check if transaction rounds can be started, committed, or rolled back right now.
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:35
An interface for generating database load balancers.
Definition: ILBFactory.php:33
getExternalLB( $cluster)
Get a cached (tracked) load balancer for external storage.
destroy()
Disables all load balancers.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
setLocalDomainPrefix( $prefix)
Set a new table prefix for the existing local domain ID for testing.
getAllExternalLBs()
Get cached (tracked) load balancers for all external database clusters.
getChronologyProtectorTouched( $dbName)