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 
61  public function __construct( array $conf );
62 
68  public function destroy();
69 
77  public function getLocalDomainID();
78 
84  public function resolveDomainID( $domain );
85 
92  public function redefineLocalDomain( $domain );
93 
106  public function newMainLB( $domain = false );
107 
114  public function getMainLB( $domain = false );
115 
128  public function newExternalLB( $cluster );
129 
136  public function getExternalLB( $cluster );
137 
144  public function getAllMainLBs();
145 
152  public function getAllExternalLBs();
153 
162  public function forEachLB( $callback, array $params = [] );
163 
171  public function shutdown(
172  $mode = self::SHUTDOWN_CHRONPROT_SYNC,
173  callable $workCallback = null,
174  &$cpIndex = null,
175  &$cpClientId = null
176  );
177 
183  public function flushReplicaSnapshots( $fname = __METHOD__ );
184 
193  public function commitAll( $fname = __METHOD__, array $options = [] );
194 
208  public function beginMasterChanges( $fname = __METHOD__ );
209 
217  public function commitMasterChanges( $fname = __METHOD__, array $options = [] );
218 
223  public function rollbackMasterChanges( $fname = __METHOD__ );
224 
230  public function hasTransactionRound();
231 
240  public function isReadyForRoundOperations();
241 
246  public function hasMasterChanges();
247 
252  public function laggedReplicaUsed();
253 
259  public function hasOrMadeRecentMasterChanges( $age = null );
260 
284  public function waitForReplication( array $opts = [] );
285 
294  public function setWaitForReplicationListener( $name, callable $callback = null );
295 
302  public function getEmptyTransactionTicket( $fname );
303 
314  public function commitAndWaitForReplication( $fname, $ticket, array $opts = [] );
315 
320  public function getChronologyProtectorTouched( $dbName );
321 
327  public function disableChronologyProtection();
328 
335  public function setLocalDomainPrefix( $prefix );
336 
340  public function closeAll();
341 
345  public function setAgentName( $agent );
346 
356  public function appendShutdownCPIndexAsQuery( $url, $index );
357 
365  public function setRequestInfo( array $info );
366 
380  public function setTableAliases( array $aliases );
381 
395  public function setIndexAliases( array $aliases );
396 }
The wiki should then use memcached to cache various data To use multiple just add more items to the array To increase the weight of a make its entry a array("192.168.0.1:11211", 2))
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.
__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:1996
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:121
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:276
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)