ILoadBalancer.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Rdbms;

use Exception;
use LogicException;
use InvalidArgumentException;

interface ILoadBalancer {
    const DB_REPLICA = -1;
    const DB_MASTER = -2;

    const DOMAIN_ANY = '';
    const GROUP_GENERIC = '';

    const CONN_TRX_AUTOCOMMIT = 1;
    const CONN_SILENCE_ERRORS = 2;
    const CONN_INTENT_WRITABLE = 4;

    const STAGE_POSTCOMMIT_CALLBACKS = 'stage-postcommit-callbacks';
    const STAGE_POSTROLLBACK_CALLBACKS = 'stage-postrollback-callbacks';

    public function __construct( array $params );

    public function getLocalDomainID();

    public function resolveDomainID( $domain );

    public function redefineLocalDomain( $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 );

    public function getLazyConnectionRef( $i, $groups = [], $domain = false, $flags = 0 );

    public function getMaintenanceConnectionRef( $i, $groups = [], $domain = false, $flags = 0 );

    public function getWriterIndex();

    public function getServerCount();

    public function hasReplicaServers();

    public function hasStreamingReplicaServers();

    public function getServerName( $i );

    public function getServerInfo( $i );

    public function getServerType( $i );

    public function getServerAttributes( $i );

    public function getMasterPos();

    public function getReplicaResumePos();

    public function disable();

    public function closeAll();

    public function closeConnection( IDatabase $conn );

    public function commitAll( $fname = __METHOD__, $owner = null );

    public function finalizeMasterChanges( $fname = __METHOD__, $owner = null );

    public function approveMasterChanges( array $options, $fname, $owner = null );

    public function beginMasterChanges( $fname = __METHOD__, $owner = null );

    public function commitMasterChanges( $fname = __METHOD__, $owner = null );

    public function runMasterTransactionIdleCallbacks( $fname = __METHOD__, $owner = null );

    public function runMasterTransactionListenerCallbacks( $fname = __METHOD__, $owner = null );

    public function rollbackMasterChanges( $fname = __METHOD__, $owner = null );

    public function flushReplicaSnapshots( $fname = __METHOD__ );

    public function flushMasterSnapshots( $fname = __METHOD__ );

    public function hasMasterConnection();

    public function hasMasterChanges();

    public function lastMasterChangeTimestamp();

    public function hasOrMadeRecentMasterChanges( $age = null );

    public function pendingMasterChangeCallers();

    public function getLaggedReplicaMode( $domain = false );

    public function laggedReplicaUsed();

    public function getReadOnlyReason( $domain = false, IDatabase $conn = null );

    public function allowLagged( $mode = null );

    public function pingAll();

    public function forEachOpenConnection( $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 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 );
}