ILoadBalancer.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Rdbms;
 
use Exception;
use InvalidArgumentException;
use LogicException;
 
interface ILoadBalancer {
    public const DB_REPLICA = -1;
    public const DB_PRIMARY = -2;
 
    // phpcs:disable MediaWiki.Usage.DeprecatedConstantUsage.DB_MASTER
    public const DB_MASTER = self::DB_PRIMARY;
    // phpcs:enable MediaWiki.Usage.DeprecatedConstantUsage.DB_MASTER
 
    public const DOMAIN_ANY = '';
    public const GROUP_GENERIC = '';
 
    public const CONN_TRX_AUTOCOMMIT = 1;
    public const CONN_SILENCE_ERRORS = 2;
    public const CONN_INTENT_WRITABLE = 4;
    public const CONN_REFRESH_READ_ONLY = 8;
 
    public const STAGE_POSTCOMMIT_CALLBACKS = 'stage-postcommit-callbacks';
    public const STAGE_POSTROLLBACK_CALLBACKS = 'stage-postrollback-callbacks';
 
    public function __construct( array $params );
 
    public function getClusterName(): string;
 
    public function getLocalDomainID(): string;
 
    public function resolveDomainID( $domain ): string;
 
    public function redefineLocalDomain( $domain );
 
    public function setTempTablesOnlyMode( $value, $domain );
 
    public function getReaderIndex( $group = false, $domain = false );
 
    public function waitFor( $pos );
 
    public function waitForOne( $pos, $timeout = null );
 
    public function waitForAll( $pos, $timeout = null );
 
    public function getAnyOpenConnection( $i, $flags = 0 );
 
    public function getConnection( $i, $groups = [], $domain = false, $flags = 0 );
 
    public function getServerConnection( $i, $domain, $flags = 0 );
 
    public function reuseConnection( IDatabase $conn );
 
    public function getConnectionRef( $i, $groups = [], $domain = false, $flags = 0 ): IDatabase;
 
    public function getLazyConnectionRef( $i, $groups = [], $domain = false, $flags = 0 ): DBConnRef;
 
    public function getMaintenanceConnectionRef( $i, $groups = [], $domain = false, $flags = 0 ): MaintainableDBConnRef;
 
    public function getWriterIndex();
 
    public function getServerCount();
 
    public function hasReplicaServers();
 
    public function hasStreamingReplicaServers();
 
    public function getServerName( $i ): string;
 
    public function getServerInfo( $i );
 
    public function getServerType( $i );
 
    public function getServerAttributes( $i );
 
    public function getPrimaryPos();
 
    public function getMasterPos();
 
    public function getReplicaResumePos();
 
    public function disable( $fname = __METHOD__, $owner = null );
 
    public function closeAll( $fname = __METHOD__, $owner = null );
 
    public function closeConnection( IDatabase $conn );
 
    public function commitAll( $fname = __METHOD__, $owner = null );
 
    public function finalizePrimaryChanges( $fname = __METHOD__, $owner = null );
 
    public function finalizeMasterChanges( $fname = __METHOD__, $owner = null );
 
    public function approvePrimaryChanges( array $options, $fname = __METHOD__, $owner = null );
 
    public function approveMasterChanges( array $options, $fname = __METHOD__, $owner = null );
 
    public function beginPrimaryChanges( $fname = __METHOD__, $owner = null );
 
    public function beginMasterChanges( $fname = __METHOD__, $owner = null );
 
    public function commitPrimaryChanges( $fname = __METHOD__, $owner = null );
 
    public function commitMasterChanges( $fname = __METHOD__, $owner = null );
 
    public function runPrimaryTransactionIdleCallbacks( $fname = __METHOD__, $owner = null );
 
    public function runMasterTransactionIdleCallbacks( $fname = __METHOD__, $owner = null );
 
    public function runPrimaryTransactionListenerCallbacks( $fname = __METHOD__, $owner = null );
 
    public function runMasterTransactionListenerCallbacks( $fname = __METHOD__, $owner = null );
 
    public function rollbackPrimaryChanges( $fname = __METHOD__, $owner = null );
 
    public function rollbackMasterChanges( $fname = __METHOD__, $owner = null );
 
    public function flushReplicaSnapshots( $fname = __METHOD__, $owner = null );
 
    public function flushPrimarySnapshots( $fname = __METHOD__, $owner = null );
 
    public function flushMasterSnapshots( $fname = __METHOD__, $owner = null );
 
    public function hasPrimaryConnection();
 
    public function hasMasterConnection();
 
    public function hasPrimaryChanges();
 
    public function hasMasterChanges();
 
    public function lastPrimaryChangeTimestamp();
 
    public function lastMasterChangeTimestamp();
 
    public function hasOrMadeRecentPrimaryChanges( $age = null );
 
    public function hasOrMadeRecentMasterChanges( $age = null );
 
    public function pendingPrimaryChangeCallers();
 
    public function pendingMasterChangeCallers();
 
    public function getLaggedReplicaMode( $domain = false );
 
    public function laggedReplicaUsed();
 
    public function getReadOnlyReason( $domain = false );
 
    public function allowLagged( $mode = null );
 
    public function pingAll();
 
    public function forEachOpenConnection( $callback, array $params = [] );
 
    public function forEachOpenPrimaryConnection( $callback, array $params = [] );
 
    public function forEachOpenMasterConnection( $callback, array $params = [] );
 
    public function forEachOpenReplicaConnection( $callback, array $params = [] );
 
    public function getMaxLag( $domain = false );
 
    public function getLagTimes( $domain = false );
 
    public function waitForPrimaryPos( IDatabase $conn, $pos = false, $timeout = 10 );
 
    public function waitForMasterPos( IDatabase $conn, $pos = false, $timeout = 10 );
 
    public function setTransactionListener( $name, callable $callback = null );
 
    public function setLocalDomainPrefix( $prefix );
 
    public function setTableAliases( array $aliases );
 
    public function setIndexAliases( array $aliases );
 
    public function setDomainAliases( array $aliases );
}