ISQLPlatform.php

Go to the documentation of this file.

<?php
namespace Wikimedia\Rdbms\Platform;
 
use Wikimedia\Rdbms\DBError;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\LikeMatch;
use Wikimedia\Rdbms\RawSQLValue;
use Wikimedia\Rdbms\Subquery;
 
// Very long type annotations :(
// phpcs:disable Generic.Files.LineLength
 
interface ISQLPlatform {
 
    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 ALL_ROWS = '*';
 
    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;
    public const QUERY_CHANGE_ROWS = 128;
    public const QUERY_CHANGE_SCHEMA = 256;
    public const QUERY_CHANGE_LOCKS = 512;
 
    public const CALLER_SUBQUERY = 'subquery';
 
    public const CALLER_UNKNOWN = 'unknown';
 
    public function bitNot( $field );
 
    public function bitAnd( $fieldLeft, $fieldRight );
 
    public function bitOr( $fieldLeft, $fieldRight );
 
    public function addIdentifierQuotes( $s );
 
    public function buildGreatest( $fields, $values );
 
    public function buildLeast( $fields, $values );
 
    public function buildComparison( string $op, array $conds ): string;
 
    public function makeList( array $a, $mode = self::LIST_COMMA );
 
    public function makeWhereFrom2d( $data, $baseKey, $subKey );
 
    public function factorConds( $condsArray );
 
    public function buildConcat( $stringList );
 
    public function limitResult( $sql, $limit, $offset = false );
 
    public function buildLike( $param, ...$params );
 
    public function anyChar();
 
    public function anyString();
 
    public function unionSupportsOrderAndLimit();
 
    public function unionQueries( $sqls, $all, $options = [] );
 
    public function timestamp( $ts = 0 );
 
    public function timestampOrNull( $ts = null );
 
    public function getInfinity();
 
    public function encodeExpiry( $expiry );
 
    public function decodeExpiry( $expiry, $format = TS_MW );
 
    public function conditional( $cond, $caseTrueExpression, $caseFalseExpression );
 
    public function strreplace( $orig, $old, $new );
 
    public function buildSubString( $input, $startPosition, $length = null );
 
    public function buildStringCast( $field );
 
    public function buildIntegerCast( $field );
 
    public function implicitOrderby();
 
    public function setTableAliases( array $aliases );
 
    public function setIndexAliases( array $aliases );
 
    public function getTableAliases();
 
    public function selectSQLText(
        $tables,
        $vars,
        $conds = '',
        $fname = __METHOD__,
        $options = [],
        $join_conds = []
    );
 
    public function tableName( string $name, $format = 'quoted' );
 
    public function tableNames( ...$tables );
 
    public function tableNamesN( ...$tables );
 
    public function buildGroupConcatField(
        $delim, $tables, $field, $conds = '', $join_conds = []
    );
 
    public function buildSelectSubquery(
        $tables,
        $vars,
        $conds = '',
        $fname = __METHOD__,
        $options = [],
        $join_conds = []
    );
 
    public function buildExcludedValue( $column );
 
    public function setSchemaVars( $vars );
}