IDatabase.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Rdbms;

use InvalidArgumentException;
use Wikimedia\ScopedCallback;
use Exception;
use stdClass;

interface IDatabase {
    const TRIGGER_IDLE = 1;
    const TRIGGER_COMMIT = 2;
    const TRIGGER_ROLLBACK = 3;
    const TRIGGER_CANCEL = 4;

    const TRANSACTION_EXPLICIT = '';
    const TRANSACTION_INTERNAL = 'implicit';

    const ATOMIC_NOT_CANCELABLE = '';
    const ATOMIC_CANCELABLE = 'cancelable';

    const FLUSHING_ONE = '';
    const FLUSHING_ALL_PEERS = 'flush';
    const FLUSHING_INTERNAL = 'flush-internal';

    const REMEMBER_NOTHING = '';
    const REMEMBER_PRIOR = 'remember';
    const RESTORE_PRIOR = 'prior';
    const RESTORE_INITIAL = 'initial';

    const ESTIMATE_TOTAL = 'total';
    const ESTIMATE_DB_APPLY = 'apply';

    const LIST_COMMA = 0;
    const LIST_AND = 1;
    const LIST_SET = 2;
    const LIST_NAMES = 3;
    const LIST_OR = 4;

    const DBO_DEBUG = 1;
    const DBO_NOBUFFER = 2;
    const DBO_IGNORE = 4;
    const DBO_TRX = 8;
    const DBO_DEFAULT = 16;
    const DBO_PERSISTENT = 32;
    const DBO_SYSDBA = 64;
    const DBO_DDLMODE = 128;
    const DBO_SSL = 256;
    const DBO_COMPRESS = 512;

    const QUERY_NORMAL = 0;
    const QUERY_SILENCE_ERRORS = 1; // b/c for 1.32 query() argument; note that (int)true = 1
    const QUERY_PSEUDO_PERMANENT = 2;
    const QUERY_REPLICA_ROLE = 4;
    const QUERY_IGNORE_DBO_TRX = 8;
    const QUERY_NO_RETRY = 16;

    const UNION_ALL = true;
    const UNION_DISTINCT = false;

    public function getServerInfo();

    public function trxLevel();

    public function trxTimestamp();

    public function explicitTrxActive();

    public function assertNoOpenTransactions();

    public function tablePrefix( $prefix = null );

    public function dbSchema( $schema = null );

    public function getLBInfo( $name = null );

    public function setLBInfo( $nameOrArray, $value = null );

    public function setLazyMasterHandle( IDatabase $conn );

    public function implicitOrderby();

    public function lastQuery();

    public function lastDoneWrites();

    public function writesPending();

    public function preCommitCallbacksPending();

    public function writesOrCallbacksPending();

    public function pendingWriteQueryDuration( $type = self::ESTIMATE_TOTAL );

    public function pendingWriteCallers();

    public function pendingWriteRowsAffected();

    public function isOpen();

    public function setFlag( $flag, $remember = self::REMEMBER_NOTHING );

    public function clearFlag( $flag, $remember = self::REMEMBER_NOTHING );

    public function restoreFlags( $state = self::RESTORE_PRIOR );

    public function getFlag( $flag );

    public function getDomainID();

    public function getType();

    public function fetchObject( $res );

    public function fetchRow( $res );

    public function numRows( $res );

    public function numFields( $res );

    public function fieldName( $res, $n );

    public function insertId();

    public function dataSeek( $res, $row );

    public function lastErrno();

    public function lastError();

    public function affectedRows();

    public function getSoftwareLink();

    public function getServerVersion();

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

    public function query( $sql, $fname = __METHOD__, $flags = 0 );

    public function freeResult( $res );

    public function selectField(
        $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
    );

    public function selectFieldValues(
        $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
    );

    public function select(
        $table,
        $vars,
        $conds = '',
        $fname = __METHOD__,
        $options = [],
        $join_conds = []
    );

    public function selectSQLText(
        $table,
        $vars,
        $conds = '',
        $fname = __METHOD__,
        $options = [],
        $join_conds = []
    );

    public function selectRow(
        $table,
        $vars,
        $conds,
        $fname = __METHOD__,
        $options = [],
        $join_conds = []
    );

    public function estimateRowCount(
        $table, $var = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
    );

    public function selectRowCount(
        $tables, $var = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
    );

    public function lockForUpdate(
        $table, $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
    );

    public function fieldExists( $table, $field, $fname = __METHOD__ );

    public function indexExists( $table, $index, $fname = __METHOD__ );

    public function tableExists( $table, $fname = __METHOD__ );

    public function insert( $table, $a, $fname = __METHOD__, $options = [] );

    public function update( $table, $values, $conds, $fname = __METHOD__, $options = [] );

    public function makeList( $a, $mode = self::LIST_COMMA );

    public function makeWhereFrom2d( $data, $baseKey, $subKey );

    public function aggregateValue( $valuedata, $valuename = 'value' );

    public function bitNot( $field );

    public function bitAnd( $fieldLeft, $fieldRight );

    public function bitOr( $fieldLeft, $fieldRight );

    public function buildConcat( $stringList );

    public function buildGroupConcatField(
        $delim, $table, $field, $conds = '', $join_conds = []
    );

    public function buildSubString( $input, $startPosition, $length = null );

    public function buildStringCast( $field );

    public function buildIntegerCast( $field );

    public function buildSelectSubquery(
        $table,
        $vars,
        $conds = '',
        $fname = __METHOD__,
        $options = [],
        $join_conds = []
    );

    public function limitResult( $sql, $limit, $offset = false );

    public function databasesAreIndependent();

    public function selectDB( $db );

    public function selectDomain( $domain );

    public function getDBname();

    public function getServer();

    public function addQuotes( $s );

    public function addIdentifierQuotes( $s );

    public function buildLike( $param );

    public function anyChar();

    public function anyString();

    public function nextSequenceValue( $seqName );

    public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ );

    public function upsert(
        $table, array $rows, $uniqueIndexes, array $set, $fname = __METHOD__
    );

    public function deleteJoin(
        $delTable,
        $joinTable,
        $delVar,
        $joinVar,
        $conds,
        $fname = __METHOD__
    );

    public function delete( $table, $conds, $fname = __METHOD__ );

    public function insertSelect(
        $destTable,
        $srcTable,
        $varMap,
        $conds,
        $fname = __METHOD__,
        $insertOptions = [],
        $selectOptions = [],
        $selectJoinConds = []
    );

    public function unionSupportsOrderAndLimit();

    public function unionQueries( $sqls, $all );

    public function unionConditionPermutations(
        $table,
        $vars,
        array $permute_conds,
        $extra_conds = '',
        $fname = __METHOD__,
        $options = [],
        $join_conds = []
    );

    public function conditional( $cond, $trueVal, $falseVal );

    public function strreplace( $orig, $old, $new );

    public function getServerUptime();

    public function wasDeadlock();

    public function wasLockTimeout();

    public function wasConnectionLoss();

    public function wasReadOnlyError();

    public function wasErrorReissuable();

    public function masterPosWait( DBMasterPos $pos, $timeout );

    public function getReplicaPos();

    public function getMasterPos();

    public function serverIsReadOnly();

    public function onTransactionResolution( callable $callback, $fname = __METHOD__ );

    public function onTransactionCommitOrIdle( callable $callback, $fname = __METHOD__ );

    public function onTransactionIdle( callable $callback, $fname = __METHOD__ );

    public function onTransactionPreCommitOrIdle( callable $callback, $fname = __METHOD__ );

    public function onAtomicSectionCancel( callable $callback, $fname = __METHOD__ );

    public function setTransactionListener( $name, callable $callback = null );

    public function startAtomic( $fname = __METHOD__, $cancelable = self::ATOMIC_NOT_CANCELABLE );

    public function endAtomic( $fname = __METHOD__ );

    public function cancelAtomic( $fname = __METHOD__, AtomicSectionIdentifier $sectionId = null );

    public function doAtomicSection(
        $fname, callable $callback, $cancelable = self::ATOMIC_NOT_CANCELABLE
    );

    public function begin( $fname = __METHOD__, $mode = self::TRANSACTION_EXPLICIT );

    public function commit( $fname = __METHOD__, $flush = self::FLUSHING_ONE );

    public function rollback( $fname = __METHOD__, $flush = self::FLUSHING_ONE );

    public function flushSnapshot( $fname = __METHOD__, $flush = self::FLUSHING_ONE );

    public function timestamp( $ts = 0 );

    public function timestampOrNull( $ts = null );

    public function ping( &$rtt = null );

    public function getLag();

    public function getSessionLagStatus();

    public function maxListLen();

    public function encodeBlob( $b );

    public function decodeBlob( $b );

    public function setSessionOptions( array $options );

    public function setSchemaVars( $vars );

    public function lockIsFree( $lockName, $method );

    public function lock( $lockName, $method, $timeout = 5 );

    public function unlock( $lockName, $method );

    public function getScopedLockAndFlush( $lockKey, $fname, $timeout );

    public function namedLocksEnqueue();

    public function getInfinity();

    public function encodeExpiry( $expiry );

    public function decodeExpiry( $expiry, $format = TS_MW );

    public function setBigSelects( $value = true );

    public function isReadOnly();

    public function setTableAliases( array $aliases );

    public function setIndexAliases( array $aliases );

    public function __toString();
}

class_alias( IDatabase::class, 'IDatabase' );