MediaWiki  1.29.2
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 
60  public function __construct( array $conf );
61 
67  public function destroy();
68 
81  public function newMainLB( $domain = false );
82 
89  public function getMainLB( $domain = false );
90 
103  public function newExternalLB( $cluster );
104 
111  public function getExternalLB( $cluster );
112 
119  public function getAllMainLBs();
120 
127  public function getAllExternalLBs();
128 
137  public function forEachLB( $callback, array $params = [] );
138 
144  public function shutdown(
145  $mode = self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback = null
146  );
147 
153  public function flushReplicaSnapshots( $fname = __METHOD__ );
154 
163  public function commitAll( $fname = __METHOD__, array $options = [] );
164 
178  public function beginMasterChanges( $fname = __METHOD__ );
179 
187  public function commitMasterChanges( $fname = __METHOD__, array $options = [] );
188 
193  public function rollbackMasterChanges( $fname = __METHOD__ );
194 
200  public function hasTransactionRound();
201 
206  public function hasMasterChanges();
207 
212  public function laggedReplicaUsed();
213 
219  public function hasOrMadeRecentMasterChanges( $age = null );
220 
244  public function waitForReplication( array $opts = [] );
245 
254  public function setWaitForReplicationListener( $name, callable $callback = null );
255 
262  public function getEmptyTransactionTicket( $fname );
263 
274  public function commitAndWaitForReplication( $fname, $ticket, array $opts = [] );
275 
280  public function getChronologyProtectorTouched( $dbName );
281 
287  public function disableChronologyProtection();
288 
294  public function setDomainPrefix( $prefix );
295 
299  public function closeAll();
300 
304  public function setAgentName( $agent );
305 
315  public function appendPreShutdownTimeAsQuery( $url, $time );
316 
323  public function setRequestInfo( array $info );
324 }
Wikimedia\Rdbms\ILBFactory\setRequestInfo
setRequestInfo(array $info)
Wikimedia\Rdbms\ILBFactory\SHUTDOWN_CHRONPROT_SYNC
const SHUTDOWN_CHRONPROT_SYNC
Definition: ILBFactory.php:36
Wikimedia\Rdbms\ILBFactory\__construct
__construct(array $conf)
Construct a manager of ILoadBalancer objects.
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.
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
Wikimedia\Rdbms
Definition: ChronologyProtector.php:24
$fname
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined.
Definition: Setup.php:36
$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.
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:304
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:35
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.
$time
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1769
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.
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\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)
Wikimedia\Rdbms\ILBFactory\SHUTDOWN_NO_CHRONPROT
const SHUTDOWN_NO_CHRONPROT
Definition: ILBFactory.php:34
Wikimedia\Rdbms\ILBFactory\appendPreShutdownTimeAsQuery
appendPreShutdownTimeAsQuery( $url, $time)
Append ?cpPosTime parameter to a URL for ChronologyProtector purposes if needed.
Wikimedia\Rdbms\ILBFactory\commitMasterChanges
commitMasterChanges( $fname=__METHOD__, array $options=[])
Commit changes on all master connections.
Wikimedia\Rdbms\ILBFactory\shutdown
shutdown( $mode=self::SHUTDOWN_CHRONPROT_SYNC, callable $workCallback=null)
Prepare all tracked load balancers for shutdown.
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.
$options
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context $options
Definition: hooks.txt:1049
array
the array() calling protocol came about after MediaWiki 1.4rc1.
Wikimedia\Rdbms\ILBFactory
An interface for generating database load balancers.
Definition: ILBFactory.php:33
Wikimedia\Rdbms\ILBFactory\setAgentName
setAgentName( $agent)
Wikimedia\Rdbms\ILBFactory\SHUTDOWN_CHRONPROT_ASYNC
const SHUTDOWN_CHRONPROT_ASYNC
Definition: ILBFactory.php:35