MediaWiki master
ILBFactory.php
Go to the documentation of this file.
1<?php
20namespace Wikimedia\Rdbms;
21
22use Generator;
23use InvalidArgumentException;
24
48 public const SHUTDOWN_NORMAL = 0;
50 public const SHUTDOWN_NO_CHRONPROT = 1;
51
53 public const CLUSTER_MAIN_DEFAULT = 'DEFAULT';
54
88 public function __construct( array $conf );
89
97 public function destroy();
98
103 public function autoReconfigure(): void;
104
112 public function getLocalDomainID(): string;
113
124 public function redefineLocalDomain( $domain );
125
138 public function getLoadBalancer( $domain = false ): ILoadBalancer;
139
158 public function newMainLB( $domain = false ): ILoadBalancerForOwner;
159
171 public function getMainLB( $domain = false ): ILoadBalancer;
172
188 public function newExternalLB( $cluster ): ILoadBalancerForOwner;
189
199 public function getExternalLB( $cluster ): ILoadBalancer;
200
211 public function getAllMainLBs(): array;
212
221 public function getAllExternalLBs(): array;
222
229 public function getAllLBs();
230
239 public function shutdown(
240 $flags = self::SHUTDOWN_NORMAL,
241 ?callable $workCallback = null,
242 &$cpIndex = null,
243 &$cpClientId = null
244 );
245
256 public function flushReplicaSnapshots( $fname = __METHOD__ );
257
283 public function beginPrimaryChanges( $fname = __METHOD__ );
284
300 public function commitPrimaryChanges( $fname = __METHOD__, int $maxWriteDuration = 0 );
301
310 public function rollbackPrimaryChanges( $fname = __METHOD__ );
311
323 public function flushPrimarySessions( $fname = __METHOD__ );
324
331 public function hasTransactionRound();
332
341 public function isReadyForRoundOperations();
342
351 public function hasPrimaryChanges();
352
360 public function laggedReplicaUsed();
361
370 public function hasOrMadeRecentPrimaryChanges( $age = null );
371
393 public function waitForReplication( array $opts = [] );
394
404 public function setWaitForReplicationListener( $name, ?callable $callback = null );
405
412
419 public function setLocalDomainPrefix( $prefix );
420
426 public function closeAll( $fname = __METHOD__ );
427
431 public function setAgentName( $agent );
432
439 public function hasStreamingReplicaServers();
440
448 public function setDefaultReplicationWaitTimeout( $seconds );
449
463 public function setTableAliases( array $aliases );
464
473 public function setDomainAliases( array $aliases );
474
482
497 public function getAutoCommitPrimaryConnection( $domain = false ): IDatabase;
498}
Detect high-contention DB queries via profiling calls.
Provide primary and replica IDatabase connections.
Interface to a relational database.
Definition IDatabase.php:45
Manager of ILoadBalancer objects and, indirectly, IDatabase connections.
getLocalDomainID()
Get the local (and default) database domain ID of connection handles.
autoReconfigure()
Reload the configuration if necessary.
redefineLocalDomain( $domain)
Close all connections and redefine the local database domain.
beginPrimaryChanges( $fname=__METHOD__)
Wrap subsequent queries for all transaction round aware primary connections in a transaction.
getAllExternalLBs()
Get the tracked load balancer instances for all external clusters.
setTableAliases(array $aliases)
Make certain table names use their own database, schema, and table prefix when passed into SQL querie...
newMainLB( $domain=false)
Create a new load balancer instance for the main cluster that handles the given domain.
setLocalDomainPrefix( $prefix)
Set a new table prefix for the existing local domain ID for testing.
commitPrimaryChanges( $fname=__METHOD__, int $maxWriteDuration=0)
Commit all primary connection transactions and flush all replica connection transactions.
hasPrimaryChanges()
Determine if any primary connection has pending changes.
getLoadBalancer( $domain=false)
Get the tracked load balancer instance for a given domain.
waitForReplication(array $opts=[])
Waits for the replica database server to catch up to the current primary position.
rollbackPrimaryChanges( $fname=__METHOD__)
Rollback all primary connection transactions and flush all replica connection transactions.
closeAll( $fname=__METHOD__)
Close all connections on instantiated tracked load balancer instances.
flushPrimarySessions( $fname=__METHOD__)
Release important session-level state (named lock, table locks) as post-rollback cleanup.
__construct(array $conf)
Sub-classes may extend the required keys in $conf with additional parameters.
destroy()
Close all connections and make further attempts to open connections result in DBAccessError.
laggedReplicaUsed()
Determine if any lagged replica database server connection was used.
getAllLBs()
Get all tracked load balancer instances (generator)
setDomainAliases(array $aliases)
Convert certain database domains to alternative ones.
getExternalLB( $cluster)
Get the tracked load balancer instance for an external cluster.
getMainLB( $domain=false)
Get the tracked load balancer instance for the main cluster that handles the given domain.
disableChronologyProtection()
Disable the ChronologyProtector on all instantiated tracked load balancer instances.
setDefaultReplicationWaitTimeout( $seconds)
Set the default timeout for replication wait checks.
getAutoCommitPrimaryConnection( $domain=false)
Like IConnectionProvider::getPrimaryDatabase() but with AUTOCOMMIT mode.
const SHUTDOWN_NO_CHRONPROT
Do not save "session consistency" DB replication positions.
hasTransactionRound()
Check if an explicit transaction round is active.
const SHUTDOWN_NORMAL
Idiom for "no special shutdown flags".
hasStreamingReplicaServers()
Whether it has streaming replica servers.
getAllMainLBs()
Get the tracked load balancer instances for all main clusters.
shutdown( $flags=self::SHUTDOWN_NORMAL, ?callable $workCallback=null, &$cpIndex=null, &$cpClientId=null)
Prepare all instantiated tracked load balancer instances for shutdown.
setWaitForReplicationListener( $name, ?callable $callback=null)
Add a callback to be run in every call to waitForReplication() prior to any waiting.
const CLUSTER_MAIN_DEFAULT
Default main cluster name (do not change this)
getTransactionProfiler()
Get the TransactionProfiler used by this instance.
hasOrMadeRecentPrimaryChanges( $age=null)
Determine if any primary connection has pending/written changes from this request.
newExternalLB( $cluster)
Create a new load balancer instance for an external cluster.
isReadyForRoundOperations()
Check if transaction rounds can be started, committed, or rolled back right now.
flushReplicaSnapshots( $fname=__METHOD__)
Commit all replica database server transactions, clearing any point-in-time view snapshots.
Internal interface for load balancer instances exposed to their owner.
This class is a delegate to ILBFactory for a given database cluster.