MediaWiki
master
ILBFactory.php
Go to the documentation of this file.
1
<?php
20
namespace
Wikimedia\Rdbms
;
21
22
use Generator;
23
use InvalidArgumentException;
24
46
interface
ILBFactory
extends
IConnectionProvider
{
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
411
public
function
disableChronologyProtection
();
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
481
public
function
getTransactionProfiler
():
TransactionProfiler
;
482
497
public
function
getAutoCommitPrimaryConnection
( $domain =
false
):
IDatabase
;
498
}
Wikimedia\Rdbms\TransactionProfiler
Detect high-contention DB queries via profiling calls.
Definition
TransactionProfiler.php:40
Wikimedia\Rdbms\IConnectionProvider
Provide primary and replica IDatabase connections.
Definition
IConnectionProvider.php:35
Wikimedia\Rdbms\IDatabase
Interface to a relational database.
Definition
IDatabase.php:45
Wikimedia\Rdbms\ILBFactory
Manager of ILoadBalancer objects and, indirectly, IDatabase connections.
Definition
ILBFactory.php:46
Wikimedia\Rdbms\ILBFactory\getLocalDomainID
getLocalDomainID()
Get the local (and default) database domain ID of connection handles.
Wikimedia\Rdbms\ILBFactory\autoReconfigure
autoReconfigure()
Reload the configuration if necessary.
Wikimedia\Rdbms\ILBFactory\redefineLocalDomain
redefineLocalDomain( $domain)
Close all connections and redefine the local database domain.
Wikimedia\Rdbms\ILBFactory\beginPrimaryChanges
beginPrimaryChanges( $fname=__METHOD__)
Wrap subsequent queries for all transaction round aware primary connections in a transaction.
Wikimedia\Rdbms\ILBFactory\getAllExternalLBs
getAllExternalLBs()
Get the tracked load balancer instances for all external clusters.
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\newMainLB
newMainLB( $domain=false)
Create a new load balancer instance for the main cluster that handles the given domain.
Wikimedia\Rdbms\ILBFactory\setLocalDomainPrefix
setLocalDomainPrefix( $prefix)
Set a new table prefix for the existing local domain ID for testing.
Wikimedia\Rdbms\ILBFactory\commitPrimaryChanges
commitPrimaryChanges( $fname=__METHOD__, int $maxWriteDuration=0)
Commit all primary connection transactions and flush all replica connection transactions.
Wikimedia\Rdbms\ILBFactory\hasPrimaryChanges
hasPrimaryChanges()
Determine if any primary connection has pending changes.
Wikimedia\Rdbms\ILBFactory\getLoadBalancer
getLoadBalancer( $domain=false)
Get the tracked load balancer instance for a given domain.
Wikimedia\Rdbms\ILBFactory\waitForReplication
waitForReplication(array $opts=[])
Waits for the replica database server to catch up to the current primary position.
Wikimedia\Rdbms\ILBFactory\rollbackPrimaryChanges
rollbackPrimaryChanges( $fname=__METHOD__)
Rollback all primary connection transactions and flush all replica connection transactions.
Wikimedia\Rdbms\ILBFactory\closeAll
closeAll( $fname=__METHOD__)
Close all connections on instantiated tracked load balancer instances.
Wikimedia\Rdbms\ILBFactory\flushPrimarySessions
flushPrimarySessions( $fname=__METHOD__)
Release important session-level state (named lock, table locks) as post-rollback cleanup.
Wikimedia\Rdbms\ILBFactory\__construct
__construct(array $conf)
Sub-classes may extend the required keys in $conf with additional parameters.
Wikimedia\Rdbms\ILBFactory\destroy
destroy()
Close all connections and make further attempts to open connections result in DBAccessError.
Wikimedia\Rdbms\ILBFactory\laggedReplicaUsed
laggedReplicaUsed()
Determine if any lagged replica database server connection was used.
Wikimedia\Rdbms\ILBFactory\getAllLBs
getAllLBs()
Get all tracked load balancer instances (generator)
Wikimedia\Rdbms\ILBFactory\setDomainAliases
setDomainAliases(array $aliases)
Convert certain database domains to alternative ones.
Wikimedia\Rdbms\ILBFactory\getExternalLB
getExternalLB( $cluster)
Get the tracked load balancer instance for an external cluster.
Wikimedia\Rdbms\ILBFactory\getMainLB
getMainLB( $domain=false)
Get the tracked load balancer instance for the main cluster that handles the given domain.
Wikimedia\Rdbms\ILBFactory\disableChronologyProtection
disableChronologyProtection()
Disable the ChronologyProtector on all instantiated tracked load balancer instances.
Wikimedia\Rdbms\ILBFactory\setDefaultReplicationWaitTimeout
setDefaultReplicationWaitTimeout( $seconds)
Set the default timeout for replication wait checks.
Wikimedia\Rdbms\ILBFactory\getAutoCommitPrimaryConnection
getAutoCommitPrimaryConnection( $domain=false)
Like IConnectionProvider::getPrimaryDatabase() but with AUTOCOMMIT mode.
Wikimedia\Rdbms\ILBFactory\SHUTDOWN_NO_CHRONPROT
const SHUTDOWN_NO_CHRONPROT
Do not save "session consistency" DB replication positions.
Definition
ILBFactory.php:50
Wikimedia\Rdbms\ILBFactory\hasTransactionRound
hasTransactionRound()
Check if an explicit transaction round is active.
Wikimedia\Rdbms\ILBFactory\SHUTDOWN_NORMAL
const SHUTDOWN_NORMAL
Idiom for "no special shutdown flags".
Definition
ILBFactory.php:48
Wikimedia\Rdbms\ILBFactory\hasStreamingReplicaServers
hasStreamingReplicaServers()
Whether it has streaming replica servers.
Wikimedia\Rdbms\ILBFactory\getAllMainLBs
getAllMainLBs()
Get the tracked load balancer instances for all main clusters.
Wikimedia\Rdbms\ILBFactory\shutdown
shutdown( $flags=self::SHUTDOWN_NORMAL, ?callable $workCallback=null, &$cpIndex=null, &$cpClientId=null)
Prepare all instantiated tracked load balancer instances for shutdown.
Wikimedia\Rdbms\ILBFactory\setAgentName
setAgentName( $agent)
Wikimedia\Rdbms\ILBFactory\setWaitForReplicationListener
setWaitForReplicationListener( $name, ?callable $callback=null)
Add a callback to be run in every call to waitForReplication() prior to any waiting.
Wikimedia\Rdbms\ILBFactory\CLUSTER_MAIN_DEFAULT
const CLUSTER_MAIN_DEFAULT
Default main cluster name (do not change this)
Definition
ILBFactory.php:53
Wikimedia\Rdbms\ILBFactory\getTransactionProfiler
getTransactionProfiler()
Get the TransactionProfiler used by this instance.
Wikimedia\Rdbms\ILBFactory\hasOrMadeRecentPrimaryChanges
hasOrMadeRecentPrimaryChanges( $age=null)
Determine if any primary connection has pending/written changes from this request.
Wikimedia\Rdbms\ILBFactory\newExternalLB
newExternalLB( $cluster)
Create a new load balancer instance for an external cluster.
Wikimedia\Rdbms\ILBFactory\isReadyForRoundOperations
isReadyForRoundOperations()
Check if transaction rounds can be started, committed, or rolled back right now.
Wikimedia\Rdbms\ILBFactory\flushReplicaSnapshots
flushReplicaSnapshots( $fname=__METHOD__)
Commit all replica database server transactions, clearing any point-in-time view snapshots.
Wikimedia\Rdbms\ILoadBalancerForOwner
Internal interface for load balancer instances exposed to their owner.
Definition
ILoadBalancerForOwner.php:34
Wikimedia\Rdbms\ILoadBalancer
This class is a delegate to ILBFactory for a given database cluster.
Definition
ILoadBalancer.php:113
Wikimedia\Rdbms
Definition
ChangedTablesTracker.php:3
includes
libs
rdbms
lbfactory
ILBFactory.php
Generated on Wed Jun 25 2025 02:25:03 for MediaWiki by
1.10.0