MediaWiki
master
ILoadBalancerForOwner.php
Go to the documentation of this file.
1
<?php
20
namespace
Wikimedia\Rdbms
;
21
22
use Exception;
23
34
interface
ILoadBalancerForOwner
extends
ILoadBalancer
{
36
public
const
STAGE_POSTCOMMIT_CALLBACKS
=
'stage-postcommit-callbacks'
;
38
public
const
STAGE_POSTROLLBACK_CALLBACKS
=
'stage-postrollback-callbacks'
;
39
72
public
function
__construct
( array
$params
);
73
81
public
function
disable
( $fname = __METHOD__ );
82
89
public
function
closeAll
( $fname = __METHOD__ );
90
100
public
function
finalizePrimaryChanges
( $fname = __METHOD__ );
101
112
public
function
approvePrimaryChanges
(
int
$maxWriteDuration, $fname = __METHOD__ );
113
126
public
function
beginPrimaryChanges
( $fname = __METHOD__ );
127
134
public
function
commitPrimaryChanges
( $fname = __METHOD__ );
135
143
public
function
runPrimaryTransactionIdleCallbacks
( $fname = __METHOD__ );
144
152
public
function
runPrimaryTransactionListenerCallbacks
( $fname = __METHOD__ );
153
161
public
function
rollbackPrimaryChanges
( $fname = __METHOD__ );
162
172
public
function
flushPrimarySessions
( $fname = __METHOD__ );
173
179
public
function
flushReplicaSnapshots
( $fname = __METHOD__ );
180
189
public
function
flushPrimarySnapshots
( $fname = __METHOD__ );
190
197
public
function
pendingPrimaryChangeCallers
();
198
205
public
function
setLocalDomainPrefix
( $prefix );
206
219
public
function
reconfigure
( array
$params
);
220
227
public
function
redefineLocalDomain
( $domain );
228
233
public
function
hasPrimaryConnection
();
234
247
public
function
setIndexAliases
( array $aliases );
248
257
public
function
lastPrimaryChangeTimestamp
();
258
269
public
function
waitForAll
(
DBPrimaryPos
$pos, $timeout =
null
);
270
277
public
function
laggedReplicaUsed
();
278
}
$params
array $params
The job parameters.
Definition
UploadJobTrait.php:46
Wikimedia\Rdbms\DBPrimaryPos
An object representing a primary or replica DB position in a replicated setup.
Definition
DBPrimaryPos.php:14
Wikimedia\Rdbms\ILoadBalancerForOwner
Internal interface for load balancer instances exposed to their owner.
Definition
ILoadBalancerForOwner.php:34
Wikimedia\Rdbms\ILoadBalancerForOwner\flushPrimarySnapshots
flushPrimarySnapshots( $fname=__METHOD__)
Commit all primary DB transactions so as to flush any REPEATABLE-READ or SSI snapshots.
Wikimedia\Rdbms\ILoadBalancerForOwner\beginPrimaryChanges
beginPrimaryChanges( $fname=__METHOD__)
Flush any primary transaction snapshots and set DBO_TRX (if DBO_DEFAULT is set)
Wikimedia\Rdbms\ILoadBalancerForOwner\setIndexAliases
setIndexAliases(array $aliases)
Convert certain index names to alternative names before querying the DB.
Wikimedia\Rdbms\ILoadBalancerForOwner\pendingPrimaryChangeCallers
pendingPrimaryChangeCallers()
Get the list of callers that have pending primary changes.
Wikimedia\Rdbms\ILoadBalancerForOwner\setLocalDomainPrefix
setLocalDomainPrefix( $prefix)
Set a new table prefix for the existing local domain ID for testing.
Wikimedia\Rdbms\ILoadBalancerForOwner\flushPrimarySessions
flushPrimarySessions( $fname=__METHOD__)
Release/destroy session-level named locks, table locks, and temp tables.
Wikimedia\Rdbms\ILoadBalancerForOwner\laggedReplicaUsed
laggedReplicaUsed()
Whether a highly "lagged" replica database connection was queried.
Wikimedia\Rdbms\ILoadBalancerForOwner\commitPrimaryChanges
commitPrimaryChanges( $fname=__METHOD__)
Issue COMMIT on all open primary connections to flush changes and view snapshots.
Wikimedia\Rdbms\ILoadBalancerForOwner\finalizePrimaryChanges
finalizePrimaryChanges( $fname=__METHOD__)
Run pre-commit callbacks and defer execution of post-commit callbacks.
Wikimedia\Rdbms\ILoadBalancerForOwner\waitForAll
waitForAll(DBPrimaryPos $pos, $timeout=null)
Set the primary wait position and wait for ALL replica DBs to catch up to it.
Wikimedia\Rdbms\ILoadBalancerForOwner\lastPrimaryChangeTimestamp
lastPrimaryChangeTimestamp()
Get the last time that a tracked connection was used to commit a write.
Wikimedia\Rdbms\ILoadBalancerForOwner\STAGE_POSTROLLBACK_CALLBACKS
const STAGE_POSTROLLBACK_CALLBACKS
Manager of ILoadBalancer instances is running post-rollback callbacks.
Definition
ILoadBalancerForOwner.php:38
Wikimedia\Rdbms\ILoadBalancerForOwner\reconfigure
reconfigure(array $params)
Reconfigure using the given config array.
Wikimedia\Rdbms\ILoadBalancerForOwner\hasPrimaryConnection
hasPrimaryConnection()
Wikimedia\Rdbms\ILoadBalancerForOwner\runPrimaryTransactionListenerCallbacks
runPrimaryTransactionListenerCallbacks( $fname=__METHOD__)
Run all recurring post-COMMIT/ROLLBACK listener callbacks.
Wikimedia\Rdbms\ILoadBalancerForOwner\redefineLocalDomain
redefineLocalDomain( $domain)
Close all connection and redefine the local domain for testing or schema creation.
Wikimedia\Rdbms\ILoadBalancerForOwner\closeAll
closeAll( $fname=__METHOD__)
Close all open connections.
Wikimedia\Rdbms\ILoadBalancerForOwner\__construct
__construct(array $params)
Wikimedia\Rdbms\ILoadBalancerForOwner\approvePrimaryChanges
approvePrimaryChanges(int $maxWriteDuration, $fname=__METHOD__)
Perform all pre-commit checks for things like replication safety.
Wikimedia\Rdbms\ILoadBalancerForOwner\rollbackPrimaryChanges
rollbackPrimaryChanges( $fname=__METHOD__)
Issue ROLLBACK only on primary, only if queries were done on connection.
Wikimedia\Rdbms\ILoadBalancerForOwner\disable
disable( $fname=__METHOD__)
Close all connections and disable this load balancer.
Wikimedia\Rdbms\ILoadBalancerForOwner\flushReplicaSnapshots
flushReplicaSnapshots( $fname=__METHOD__)
Commit all replica DB transactions so as to flush any REPEATABLE-READ or SSI snapshots.
Wikimedia\Rdbms\ILoadBalancerForOwner\STAGE_POSTCOMMIT_CALLBACKS
const STAGE_POSTCOMMIT_CALLBACKS
Manager of ILoadBalancer instances is running post-commit callbacks.
Definition
ILoadBalancerForOwner.php:36
Wikimedia\Rdbms\ILoadBalancerForOwner\runPrimaryTransactionIdleCallbacks
runPrimaryTransactionIdleCallbacks( $fname=__METHOD__)
Consume and run all pending post-COMMIT/ROLLBACK callbacks and commit dangling transactions.
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
loadbalancer
ILoadBalancerForOwner.php
Generated on Tue Jan 14 2025 10:24:45 for MediaWiki by
1.10.0