IDatabase.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Rdbms;
 
use Exception;
use InvalidArgumentException;
use stdClass;
use Wikimedia\ScopedCallback;
 
interface IDatabase {
    public const TRIGGER_IDLE = 1;
    public const TRIGGER_COMMIT = 2;
    public const TRIGGER_ROLLBACK = 3;
    public const TRIGGER_CANCEL = 4;
 
    public const TRANSACTION_EXPLICIT = '';
    public const TRANSACTION_INTERNAL = 'implicit';
 
    public const ATOMIC_NOT_CANCELABLE = '';
    public const ATOMIC_CANCELABLE = 'cancelable';
 
    public const FLUSHING_ONE = '';
    public const FLUSHING_ALL_PEERS = 'flush';
    public const FLUSHING_INTERNAL = 'flush-internal';
 
    public const REMEMBER_NOTHING = '';
    public const REMEMBER_PRIOR = 'remember';
    public const RESTORE_PRIOR = 'prior';
    public const RESTORE_INITIAL = 'initial';
 
    public const ESTIMATE_TOTAL = 'total';
    public const ESTIMATE_DB_APPLY = 'apply';
 
    public const LIST_COMMA = 0;
    public const LIST_AND = 1;
    public const LIST_SET = 2;
    public const LIST_NAMES = 3;
    public const LIST_OR = 4;
 
    public const DBO_DEBUG = 1;
    public const DBO_NOBUFFER = 2;
    public const DBO_IGNORE = 4;
    public const DBO_TRX = 8;
    public const DBO_DEFAULT = 16;
    public const DBO_PERSISTENT = 32;
    public const DBO_SYSDBA = 64;
    public const DBO_DDLMODE = 128;
    public const DBO_SSL = 256;
    public const DBO_COMPRESS = 512;
 
    public const QUERY_NORMAL = 0;
    public const QUERY_SILENCE_ERRORS = 1; // b/c for 1.32 query() argument; (int)true = 1
    public const QUERY_PSEUDO_PERMANENT = 2;
    public const QUERY_REPLICA_ROLE = 4;
    public const QUERY_IGNORE_DBO_TRX = 8;
    public const QUERY_NO_RETRY = 16;
    public const QUERY_CHANGE_NONE = 32;
    public const QUERY_CHANGE_TRX = 64 | self::QUERY_IGNORE_DBO_TRX;
    public const QUERY_CHANGE_ROWS = 128;
    public const QUERY_CHANGE_SCHEMA = 256 | self::QUERY_IGNORE_DBO_TRX;
 
    public const LOCK_TIMESTAMP = 1;
 
    public const UNION_ALL = true;
    public const UNION_DISTINCT = false;
 
    public const LB_TRX_ROUND_ID = 'trxRoundId';
    public const LB_READ_ONLY_REASON = 'readOnlyReason';
 
    public const ROLE_STREAMING_MASTER = 'streaming-master';
    public const ROLE_STREAMING_REPLICA = 'streaming-replica';
    public const ROLE_STATIC_CLONE = 'static-clone';
    public const ROLE_UNKNOWN = 'unknown';
 
    public const ALL_ROWS = '*';
 
    public function getServerInfo();
 
    public function getTopologyBasedServerId();
 
    public function getTopologyRole();
 
    public function getTopologyRootPrimary();
 
    public function trxLevel();
 
    public function trxTimestamp();
 
    public function explicitTrxActive();
 
    public function tablePrefix( $prefix = null );
 
    public function dbSchema( $schema = null );
 
    public function getLBInfo( $name = null );
 
    public function setLBInfo( $nameOrArray, $value = null );
 
    public function implicitOrderby();
 
    public function lastQuery();
 
    public function lastDoneWrites();
 
    public function writesPending();
 
    public function writesOrCallbacksPending();
 
    public function pendingWriteQueryDuration( $type = self::ESTIMATE_TOTAL );
 
    public function pendingWriteCallers();
 
    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();
 
    /***************************************************************************/
    // region  Deprecated IResultWrapper accessors
 
    public function fetchObject( IResultWrapper $res );
 
    public function fetchRow( IResultWrapper $res );
 
    public function numRows( $res );
 
    public function freeResult( IResultWrapper $res );
 
    // endregion -- Deprecated IResultWrapper accessors
    /***************************************************************************/
 
    public function insertId();
 
    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 newSelectQueryBuilder(): SelectQueryBuilder;
 
    public function selectField(
        $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
    );
 
    public function selectFieldValues(
        $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
    ): array;
 
    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(
        $tables, $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, $rows, $fname = __METHOD__, $options = [] );
 
    public function update( $table, $set, $conds, $fname = __METHOD__, $options = [] );
 
    public function makeList( array $a, $mode = self::LIST_COMMA );
 
    public function makeWhereFrom2d( $data, $baseKey, $subKey );
 
    public function factorConds( $condsArray );
 
    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 buildGreatest( $fields, $values );
 
    public function buildLeast( $fields, $values );
 
    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 getServerName();
 
    public function addQuotes( $s );
 
    public function addIdentifierQuotes( $s );
 
    public function buildLike( $param, ...$params );
 
    public function anyChar();
 
    public function anyString();
 
    public function nextSequenceValue( $seqName );
 
    public function replace( $table, $uniqueKeys, $rows, $fname = __METHOD__ );
 
    public function upsert(
        $table, array $rows, $uniqueKeys, 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, $caseTrueExpression, $caseFalseExpression );
 
    public function strreplace( $orig, $old, $new );
 
    public function wasDeadlock();
 
    public function wasLockTimeout();
 
    public function wasConnectionLoss();
 
    public function wasReadOnlyError();
 
    public function wasErrorReissuable();
 
    public function primaryPosWait( DBPrimaryPos $pos, $timeout );
 
    public function getReplicaPos();
 
    public function getPrimaryPos();
 
    public function serverIsReadOnly();
 
    public function onTransactionResolution( callable $callback, $fname = __METHOD__ );
 
    public function onTransactionCommitOrIdle( 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 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, $flags = 0 );
 
    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' );