MediaWiki  master
IDatabase.php
Go to the documentation of this file.
1 <?php
20 namespace Wikimedia\Rdbms;
21 
22 use Exception;
23 use InvalidArgumentException;
24 use stdClass;
25 use Wikimedia\ScopedCallback;
26 
38 interface IDatabase {
40  const TRIGGER_IDLE = 1;
42  const TRIGGER_COMMIT = 2;
44  const TRIGGER_ROLLBACK = 3;
46  const TRIGGER_CANCEL = 4;
47 
49  const TRANSACTION_EXPLICIT = '';
51  const TRANSACTION_INTERNAL = 'implicit';
52 
54  const ATOMIC_NOT_CANCELABLE = '';
56  const ATOMIC_CANCELABLE = 'cancelable';
57 
59  const FLUSHING_ONE = '';
61  const FLUSHING_ALL_PEERS = 'flush';
63  const FLUSHING_INTERNAL = 'flush-internal';
64 
66  const REMEMBER_NOTHING = '';
68  const REMEMBER_PRIOR = 'remember';
70  const RESTORE_PRIOR = 'prior';
72  const RESTORE_INITIAL = 'initial';
73 
75  const ESTIMATE_TOTAL = 'total';
77  const ESTIMATE_DB_APPLY = 'apply';
78 
80  const LIST_COMMA = 0;
82  const LIST_AND = 1;
84  const LIST_SET = 2;
86  const LIST_NAMES = 3;
88  const LIST_OR = 4;
89 
91  const DBO_DEBUG = 1;
93  const DBO_NOBUFFER = 2;
95  const DBO_IGNORE = 4;
97  const DBO_TRX = 8;
99  const DBO_DEFAULT = 16;
101  const DBO_PERSISTENT = 32;
103  const DBO_SYSDBA = 64;
105  const DBO_DDLMODE = 128;
107  const DBO_SSL = 256;
109  const DBO_COMPRESS = 512;
110 
112  const QUERY_NORMAL = 0;
114  const QUERY_SILENCE_ERRORS = 1; // b/c for 1.32 query() argument; note that (int)true = 1
119  const QUERY_PSEUDO_PERMANENT = 2;
121  const QUERY_REPLICA_ROLE = 4;
123  const QUERY_IGNORE_DBO_TRX = 8;
125  const QUERY_NO_RETRY = 16;
126 
128  const UNION_ALL = true;
130  const UNION_DISTINCT = false;
131 
133  const LB_TRX_ROUND_ID = 'trxRoundId';
135  const LB_READ_ONLY_REASON = 'readOnlyReason';
136 
138  const ROLE_STREAMING_MASTER = 'streaming-master';
140  const ROLE_STREAMING_REPLICA = 'streaming-replica';
142  const ROLE_STATIC_CLONE = 'static-clone';
144  const ROLE_UNKNOWN = 'unknown';
145 
153  public function getServerInfo();
154 
161  public function getTopologyRole();
162 
169  public function getTopologyRootMaster();
170 
179  public function trxLevel();
180 
192  public function trxTimestamp();
193 
198  public function explicitTrxActive();
199 
206  public function assertNoOpenTransactions();
207 
214  public function tablePrefix( $prefix = null );
215 
222  public function dbSchema( $schema = null );
223 
230  public function getLBInfo( $name = null );
231 
240  public function setLBInfo( $nameOrArray, $value = null );
241 
248  public function implicitOrderby();
249 
255  public function lastQuery();
256 
263  public function lastDoneWrites();
264 
269  public function writesPending();
270 
275  public function preCommitCallbacksPending();
276 
285  public function writesOrCallbacksPending();
286 
296  public function pendingWriteQueryDuration( $type = self::ESTIMATE_TOTAL );
297 
304  public function pendingWriteCallers();
305 
312  public function pendingWriteRowsAffected();
313 
317  public function isOpen();
318 
325  public function setFlag( $flag, $remember = self::REMEMBER_NOTHING );
326 
333  public function clearFlag( $flag, $remember = self::REMEMBER_NOTHING );
334 
341  public function restoreFlags( $state = self::RESTORE_PRIOR );
342 
349  public function getFlag( $flag );
350 
358  public function getDomainID();
359 
365  public function getType();
366 
376  public function fetchObject( $res );
377 
387  public function fetchRow( $res );
388 
397  public function numRows( $res );
398 
406  public function numFields( $res );
407 
416  public function fieldName( $res, $n );
417 
427  public function insertId();
428 
436  public function dataSeek( $res, $row );
437 
444  public function lastErrno();
445 
452  public function lastError();
453 
462  public function affectedRows();
463 
471  public function getSoftwareLink();
472 
478  public function getServerVersion();
479 
492  public function close( $fname = __METHOD__, $owner = null );
493 
521  public function query( $sql, $fname = __METHOD__, $flags = 0 );
522 
531  public function freeResult( $res );
532 
539  public function newSelectQueryBuilder();
540 
556  public function selectField(
557  $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
558  );
559 
577  public function selectFieldValues(
578  $table, $var, $cond = '', $fname = __METHOD__, $options = [], $join_conds = []
579  );
580 
747  public function select(
748  $table,
749  $vars,
750  $conds = '',
751  $fname = __METHOD__,
752  $options = [],
753  $join_conds = []
754  );
755 
773  public function selectSQLText(
774  $table,
775  $vars,
776  $conds = '',
777  $fname = __METHOD__,
778  $options = [],
779  $join_conds = []
780  );
781 
798  public function selectRow(
799  $table,
800  $vars,
801  $conds,
802  $fname = __METHOD__,
803  $options = [],
804  $join_conds = []
805  );
806 
829  public function estimateRowCount(
830  $tables, $var = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
831  );
832 
851  public function selectRowCount(
852  $tables, $var = '*', $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
853  );
854 
867  public function lockForUpdate(
868  $table, $conds = '', $fname = __METHOD__, $options = [], $join_conds = []
869  );
870 
880  public function fieldExists( $table, $field, $fname = __METHOD__ );
881 
891  public function indexExists( $table, $index, $fname = __METHOD__ );
892 
901  public function tableExists( $table, $fname = __METHOD__ );
902 
922  public function insert( $table, $rows, $fname = __METHOD__, $options = [] );
923 
945  public function update( $table, $set, $conds, $fname = __METHOD__, $options = [] );
946 
972  public function makeList( array $a, $mode = self::LIST_COMMA );
973 
990  public function makeWhereFrom2d( $data, $baseKey, $subKey );
991 
1001  public function aggregateValue( $valuedata, $valuename = 'value' );
1002 
1007  public function bitNot( $field );
1008 
1014  public function bitAnd( $fieldLeft, $fieldRight );
1015 
1021  public function bitOr( $fieldLeft, $fieldRight );
1022 
1028  public function buildConcat( $stringList );
1029 
1046  public function buildGroupConcatField(
1047  $delim, $table, $field, $conds = '', $join_conds = []
1048  );
1049 
1064  public function buildGreatest( $fields, $values );
1065 
1080  public function buildLeast( $fields, $values );
1081 
1094  public function buildSubString( $input, $startPosition, $length = null );
1095 
1101  public function buildStringCast( $field );
1102 
1108  public function buildIntegerCast( $field );
1109 
1124  public function buildSelectSubquery(
1125  $table,
1126  $vars,
1127  $conds = '',
1128  $fname = __METHOD__,
1129  $options = [],
1130  $join_conds = []
1131  );
1132 
1150  public function limitResult( $sql, $limit, $offset = false );
1151 
1164  public function databasesAreIndependent();
1165 
1177  public function selectDB( $db );
1178 
1191  public function selectDomain( $domain );
1192 
1197  public function getDBname();
1198 
1203  public function getServer();
1204 
1211  public function addQuotes( $s );
1212 
1222  public function addIdentifierQuotes( $s );
1223 
1243  public function buildLike( $param, ...$params );
1244 
1250  public function anyChar();
1251 
1257  public function anyString();
1258 
1275  public function nextSequenceValue( $seqName );
1276 
1304  public function replace( $table, $uniqueKeys, $rows, $fname = __METHOD__ );
1305 
1338  public function upsert(
1339  $table, array $rows, $uniqueKeys, array $set, $fname = __METHOD__
1340  );
1341 
1362  public function deleteJoin(
1363  $delTable,
1364  $joinTable,
1365  $delVar,
1366  $joinVar,
1367  $conds,
1368  $fname = __METHOD__
1369  );
1370 
1381  public function delete( $table, $conds, $fname = __METHOD__ );
1382 
1413  public function insertSelect(
1414  $destTable,
1415  $srcTable,
1416  $varMap,
1417  $conds,
1418  $fname = __METHOD__,
1419  $insertOptions = [],
1420  $selectOptions = [],
1421  $selectJoinConds = []
1422  );
1423 
1429  public function unionSupportsOrderAndLimit();
1430 
1440  public function unionQueries( $sqls, $all );
1441 
1468  public function unionConditionPermutations(
1469  $table,
1470  $vars,
1471  array $permute_conds,
1472  $extra_conds = '',
1473  $fname = __METHOD__,
1474  $options = [],
1475  $join_conds = []
1476  );
1477 
1488  public function conditional( $cond, $trueVal, $falseVal );
1489 
1498  public function strreplace( $orig, $old, $new );
1499 
1506  public function getServerUptime();
1507 
1515  public function wasDeadlock();
1516 
1524  public function wasLockTimeout();
1525 
1534  public function wasConnectionLoss();
1535 
1541  public function wasReadOnlyError();
1542 
1550  public function wasErrorReissuable();
1551 
1566  public function masterPosWait( DBMasterPos $pos, $timeout );
1567 
1574  public function getReplicaPos();
1575 
1582  public function getMasterPos();
1583 
1588  public function serverIsReadOnly();
1589 
1614  public function onTransactionResolution( callable $callback, $fname = __METHOD__ );
1615 
1651  public function onTransactionCommitOrIdle( callable $callback, $fname = __METHOD__ );
1652 
1661  public function onTransactionIdle( callable $callback, $fname = __METHOD__ );
1662 
1689  public function onTransactionPreCommitOrIdle( callable $callback, $fname = __METHOD__ );
1690 
1714  public function onAtomicSectionCancel( callable $callback, $fname = __METHOD__ );
1715 
1733  public function setTransactionListener( $name, callable $callback = null );
1734 
1809  public function startAtomic( $fname = __METHOD__, $cancelable = self::ATOMIC_NOT_CANCELABLE );
1810 
1822  public function endAtomic( $fname = __METHOD__ );
1823 
1849  public function cancelAtomic( $fname = __METHOD__, AtomicSectionIdentifier $sectionId = null );
1850 
1923  public function doAtomicSection(
1924  $fname, callable $callback, $cancelable = self::ATOMIC_NOT_CANCELABLE
1925  );
1926 
1946  public function begin( $fname = __METHOD__, $mode = self::TRANSACTION_EXPLICIT );
1947 
1966  public function commit( $fname = __METHOD__, $flush = self::FLUSHING_ONE );
1967 
1987  public function rollback( $fname = __METHOD__, $flush = self::FLUSHING_ONE );
1988 
2008  public function flushSnapshot( $fname = __METHOD__, $flush = self::FLUSHING_ONE );
2009 
2021  public function timestamp( $ts = 0 );
2022 
2037  public function timestampOrNull( $ts = null );
2038 
2045  public function ping( &$rtt = null );
2046 
2055  public function getLag();
2056 
2071  public function getSessionLagStatus();
2072 
2078  public function maxListLen();
2079 
2090  public function encodeBlob( $b );
2091 
2101  public function decodeBlob( $b );
2102 
2114  public function setSessionOptions( array $options );
2115 
2123  public function setSchemaVars( $vars );
2124 
2134  public function lockIsFree( $lockName, $method );
2135 
2147  public function lock( $lockName, $method, $timeout = 5 );
2148 
2159  public function unlock( $lockName, $method );
2160 
2182  public function getScopedLockAndFlush( $lockKey, $fname, $timeout );
2183 
2190  public function namedLocksEnqueue();
2191 
2199  public function getInfinity();
2200 
2207  public function encodeExpiry( $expiry );
2208 
2216  public function decodeExpiry( $expiry, $format = TS_MW );
2217 
2227  public function setBigSelects( $value = true );
2228 
2233  public function isReadOnly();
2234 
2248  public function setTableAliases( array $aliases );
2249 
2262  public function setIndexAliases( array $aliases );
2263 
2271  public function __toString();
2272 }
2273 
2277 class_alias( IDatabase::class, 'IDatabase' );
DBO_PERSISTENT
const DBO_PERSISTENT
Definition: defines.php:14
Wikimedia\Rdbms\IDatabase\isOpen
isOpen()
Wikimedia\Rdbms\IDatabase\affectedRows
affectedRows()
Get the number of rows affected by the last write query.
Wikimedia\Rdbms\IDatabase\setBigSelects
setBigSelects( $value=true)
Allow or deny "big selects" for this session only.
Wikimedia\Rdbms\IDatabase\getServer
getServer()
Get the server hostname or IP address.
Wikimedia\Rdbms\IDatabase\getServerVersion
getServerVersion()
A string describing the current software version, like from mysql_get_server_info()
Wikimedia\Rdbms\IDatabase\onAtomicSectionCancel
onAtomicSectionCancel(callable $callback, $fname=__METHOD__)
Run a callback when the atomic section is cancelled.
Wikimedia\Rdbms\IDatabase\maxListLen
maxListLen()
Return the maximum number of items allowed in a list, or 0 for unlimited.
Wikimedia\Rdbms\IDatabase\getInfinity
getInfinity()
Find out when 'infinity' is.
Wikimedia\Rdbms\IDatabase\insertSelect
insertSelect( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
INSERT SELECT wrapper.
Wikimedia\Rdbms\IDatabase\unionQueries
unionQueries( $sqls, $all)
Construct a UNION query.
Wikimedia\Rdbms\IDatabase\pendingWriteQueryDuration
pendingWriteQueryDuration( $type=self::ESTIMATE_TOTAL)
Get the time spend running write queries for this transaction.
Wikimedia\Rdbms\IDatabase\tablePrefix
tablePrefix( $prefix=null)
Get/set the table prefix.
Wikimedia\Rdbms\IDatabase\writesPending
writesPending()
Wikimedia\Rdbms\IDatabase\rollback
rollback( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
Rollback a transaction previously started using begin()
Wikimedia\Rdbms\IDatabase\replace
replace( $table, $uniqueKeys, $rows, $fname=__METHOD__)
Insert row(s) into a table, deleting all conflicting rows beforehand.
Wikimedia\Rdbms\IDatabase\numRows
numRows( $res)
Get the number of rows in a query result.
Wikimedia\Rdbms\IDatabase\setLBInfo
setLBInfo( $nameOrArray, $value=null)
Set the entire array or a particular key of the managing load balancer info array.
Wikimedia\Rdbms\IDatabase\cancelAtomic
cancelAtomic( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
Cancel an atomic section of SQL statements.
Wikimedia\Rdbms\IDatabase\ping
ping(&$rtt=null)
Ping the server and try to reconnect if it there is no connection.
Wikimedia\Rdbms\IDatabase\numFields
numFields( $res)
Get the number of fields in a result object.
Wikimedia\Rdbms\IDatabase\bitNot
bitNot( $field)
Wikimedia\Rdbms\IDatabase\getMasterPos
getMasterPos()
Get the position of this master.
Wikimedia\Rdbms\IDatabase\wasErrorReissuable
wasErrorReissuable()
Determines if the last query error was due to something outside of the query itself.
Wikimedia\Rdbms\IDatabase\encodeExpiry
encodeExpiry( $expiry)
Encode an expiry time into the DBMS dependent format.
Wikimedia\Rdbms\IDatabase\upsert
upsert( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__)
Upsert the given row(s) into a table.
Wikimedia\Rdbms\IDatabase\lastError
lastError()
Get a description of the last error.
DBO_DEBUG
const DBO_DEBUG
Definition: defines.php:9
Wikimedia\Rdbms\IDatabase\endAtomic
endAtomic( $fname=__METHOD__)
Ends an atomic section of SQL statements.
Wikimedia\Rdbms\IDatabase\trxLevel
trxLevel()
Gets the current transaction level.
Wikimedia\Rdbms\IDatabase\implicitOrderby
implicitOrderby()
Returns true if this database does an implicit order by when the column has an index For example: SEL...
Wikimedia\Rdbms
Definition: ChronologyProtector.php:24
Wikimedia\Rdbms\IDatabase\getServerInfo
getServerInfo()
Get a human-readable string describing the current software version.
Wikimedia\Rdbms\DBMasterPos
An object representing a master or replica DB position in a replicated setup.
Definition: DBMasterPos.php:12
Wikimedia\Rdbms\IDatabase\trxTimestamp
trxTimestamp()
Get the UNIX timestamp of the time that the transaction was established.
$s
$s
Definition: mergeMessageFileList.php:185
DBO_SSL
const DBO_SSL
Definition: defines.php:17
DBO_IGNORE
const DBO_IGNORE
Definition: defines.php:11
Wikimedia\Rdbms\IDatabase\decodeBlob
decodeBlob( $b)
Some DBMSs return a special placeholder object representing blob fields in result objects.
Wikimedia\Rdbms\IDatabase\getSessionLagStatus
getSessionLagStatus()
Get the replica DB lag when the current transaction started or a general lag estimate if not transact...
Wikimedia\Rdbms\IDatabase\selectField
selectField( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
A SELECT wrapper which returns a single field from a single result row.
Wikimedia\Rdbms\IDatabase\getLag
getLag()
Get the amount of replication lag for this database server.
Wikimedia\Rdbms\IDatabase\buildGreatest
buildGreatest( $fields, $values)
Build a GREATEST function statement comparing columns/values.
Wikimedia\Rdbms\IDatabase\onTransactionCommitOrIdle
onTransactionCommitOrIdle(callable $callback, $fname=__METHOD__)
Run a callback as soon as there is no transaction pending.
Wikimedia\Rdbms\IDatabase\isReadOnly
isReadOnly()
$res
$res
Definition: testCompression.php:57
DBO_TRX
const DBO_TRX
Definition: defines.php:12
Wikimedia\Rdbms\IDatabase\dbSchema
dbSchema( $schema=null)
Get/set the db schema.
Wikimedia\Rdbms\IDatabase\tableExists
tableExists( $table, $fname=__METHOD__)
Query whether a given table exists.
LIST_AND
const LIST_AND
Definition: Defines.php:48
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
Wikimedia\Rdbms\IDatabase\fieldName
fieldName( $res, $n)
Get a field name in a result object.
Wikimedia\Rdbms\IDatabase\lastDoneWrites
lastDoneWrites()
Get the last time the connection may have been used for a write query.
DBO_NOBUFFER
const DBO_NOBUFFER
Definition: defines.php:10
Wikimedia\Rdbms\IDatabase\update
update( $table, $set, $conds, $fname=__METHOD__, $options=[])
Update all rows in a table that match a given condition.
Wikimedia\Rdbms\IDatabase\fetchObject
fetchObject( $res)
Fetch the next row from the given result object, in object form.
Wikimedia\Rdbms\IDatabase\getServerUptime
getServerUptime()
Determines how long the server has been up.
Wikimedia\Rdbms\IDatabase\lock
lock( $lockName, $method, $timeout=5)
Acquire a named lock.
Wikimedia\Rdbms\IDatabase\buildSelectSubquery
buildSelectSubquery( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery.
Wikimedia\Rdbms\IDatabase\unionSupportsOrderAndLimit
unionSupportsOrderAndLimit()
Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.
Wikimedia\Rdbms\IDatabase\getSoftwareLink
getSoftwareLink()
Returns a wikitext style link to the DB's website (e.g.
Wikimedia\Rdbms\IDatabase\timestamp
timestamp( $ts=0)
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for ins...
LIST_OR
const LIST_OR
Definition: Defines.php:51
Wikimedia\Rdbms\IDatabase\freeResult
freeResult( $res)
Free a result object returned by query() or select()
Wikimedia\Rdbms\IDatabase\encodeBlob
encodeBlob( $b)
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strin...
Wikimedia\Rdbms\IDatabase\deleteJoin
deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
DELETE where the condition is a join.
Wikimedia\Rdbms\IDatabase\__toString
__toString()
Get a debugging string that mentions the database type, the ID of this instance, and the ID of any un...
Wikimedia\Rdbms\IDatabase\getTopologyRole
getTopologyRole()
Get the replication topology role of this server.
Wikimedia\Rdbms\IDatabase\lockForUpdate
lockForUpdate( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
Lock all rows meeting the given conditions/options FOR UPDATE.
LIST_SET
const LIST_SET
Definition: Defines.php:49
Wikimedia\Rdbms\IDatabase\databasesAreIndependent
databasesAreIndependent()
Returns true if DBs are assumed to be on potentially different servers.
Wikimedia\Rdbms\IDatabase\close
close( $fname=__METHOD__, $owner=null)
Close the database connection.
Wikimedia\Rdbms\IDatabase\limitResult
limitResult( $sql, $limit, $offset=false)
Construct a LIMIT query with optional offset.
Wikimedia\Rdbms\IDatabase\wasDeadlock
wasDeadlock()
Determines if the last failure was due to a deadlock.
Wikimedia\Rdbms\IDatabase\anyChar
anyChar()
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.
Wikimedia\Rdbms\IDatabase\preCommitCallbacksPending
preCommitCallbacksPending()
Wikimedia\Rdbms\IDatabase\query
query( $sql, $fname=__METHOD__, $flags=0)
Run an SQL query and return the result.
Wikimedia\Rdbms\IDatabase\decodeExpiry
decodeExpiry( $expiry, $format=TS_MW)
Decode an expiry time into a DBMS independent format.
Wikimedia\Rdbms\IDatabase\setIndexAliases
setIndexAliases(array $aliases)
Convert certain index names to alternative names before querying the DB.
Wikimedia\Rdbms\IDatabase\wasLockTimeout
wasLockTimeout()
Determines if the last failure was due to a lock timeout.
Wikimedia\Rdbms\IDatabase\buildLeast
buildLeast( $fields, $values)
Build a LEAST function statement comparing columns/values.
Wikimedia\Rdbms\IDatabase\assertNoOpenTransactions
assertNoOpenTransactions()
Assert that all explicit transactions or atomic sections have been closed.
LIST_COMMA
const LIST_COMMA
Definition: Defines.php:47
Wikimedia\Rdbms\IDatabase\setTableAliases
setTableAliases(array $aliases)
Make certain table names use their own database, schema, and table prefix when passed into SQL querie...
Wikimedia\Rdbms\IDatabase\buildSubString
buildSubString( $input, $startPosition, $length=null)
Build a SUBSTRING function.
DBO_COMPRESS
const DBO_COMPRESS
Definition: defines.php:18
Wikimedia\Rdbms\IDatabase\unlock
unlock( $lockName, $method)
Release a lock.
Wikimedia\Rdbms\IDatabase\lastQuery
lastQuery()
Get the last query that sent on account of IDatabase::query()
Wikimedia\Rdbms\IDatabase\selectRow
selectRow( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
Wrapper to IDatabase::select() that only fetches one row (via LIMIT)
DBO_DDLMODE
const DBO_DDLMODE
Definition: defines.php:16
Wikimedia\Rdbms\IDatabase\getScopedLockAndFlush
getScopedLockAndFlush( $lockKey, $fname, $timeout)
Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
Wikimedia\Rdbms\IDatabase\selectRowCount
selectRowCount( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
Get the number of rows in dataset.
Wikimedia\Rdbms\IDatabase\explicitTrxActive
explicitTrxActive()
Wikimedia\Rdbms\IDatabase\buildStringCast
buildStringCast( $field)
Wikimedia\Rdbms\IDatabase\getDomainID
getDomainID()
Return the currently selected domain ID.
Wikimedia\Rdbms\IDatabase\buildConcat
buildConcat( $stringList)
Build a concatenation list to feed into a SQL query.
Wikimedia\Rdbms\IDatabase\wasConnectionLoss
wasConnectionLoss()
Determines if the last query error was due to a dropped connection.
Wikimedia\Rdbms\IDatabase\setTransactionListener
setTransactionListener( $name, callable $callback=null)
Run a callback after each time any transaction commits or rolls back.
Wikimedia\Rdbms\AtomicSectionIdentifier
Class used for token representing identifiers for atomic sections from IDatabase instances.
Definition: AtomicSectionIdentifier.php:26
Wikimedia\Rdbms\IDatabase\getDBname
getDBname()
Get the current DB name.
Wikimedia\Rdbms\IDatabase\wasReadOnlyError
wasReadOnlyError()
Determines if the last failure was due to the database being read-only.
Wikimedia\Rdbms\IDatabase\strreplace
strreplace( $orig, $old, $new)
Returns a SQL expression for simple string replacement (e.g.
Wikimedia\Rdbms\IDatabase\bitOr
bitOr( $fieldLeft, $fieldRight)
Wikimedia\Rdbms\IDatabase\pendingWriteCallers
pendingWriteCallers()
Get the list of method names that did write queries for this transaction.
Wikimedia\Rdbms\IDatabase\fetchRow
fetchRow( $res)
Fetch the next row from the given result object, in associative array form.
DBO_SYSDBA
const DBO_SYSDBA
Definition: defines.php:15
Wikimedia\Rdbms\IDatabase\anyString
anyString()
Returns a token for buildLike() that denotes a '' to be used in a LIKE query.
Wikimedia\Rdbms\IDatabase\getReplicaPos
getReplicaPos()
Get the replication position of this replica DB.
Wikimedia\Rdbms\IDatabase\getFlag
getFlag( $flag)
Returns a boolean whether the flag $flag is set for this connection.
Wikimedia\Rdbms\IDatabase\masterPosWait
masterPosWait(DBMasterPos $pos, $timeout)
Wait for the replica DB to catch up to a given master position.
Wikimedia\Rdbms\IDatabase\insert
insert( $table, $rows, $fname=__METHOD__, $options=[])
Insert the given row(s) into a table.
Wikimedia\Rdbms\IDatabase\onTransactionIdle
onTransactionIdle(callable $callback, $fname=__METHOD__)
Alias for onTransactionCommitOrIdle() for backwards-compatibility.
Wikimedia\Rdbms\IDatabase\bitAnd
bitAnd( $fieldLeft, $fieldRight)
Wikimedia\Rdbms\IDatabase\lockIsFree
lockIsFree( $lockName, $method)
Check to see if a named lock is not locked by any thread (non-blocking)
Wikimedia\Rdbms\IDatabase\selectDB
selectDB( $db)
Change the current database.
Wikimedia\Rdbms\IDatabase\doAtomicSection
doAtomicSection( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
Perform an atomic section of reversable SQL statements from a callback.
Wikimedia\Rdbms\IDatabase\lastErrno
lastErrno()
Get the last error number.
Wikimedia\Rdbms\IDatabase\fieldExists
fieldExists( $table, $field, $fname=__METHOD__)
Determines whether a field exists in a table.
Wikimedia\Rdbms\IDatabase\aggregateValue
aggregateValue( $valuedata, $valuename='value')
Return aggregated value alias.
Wikimedia\Rdbms\IDatabase\selectSQLText
selectSQLText( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
Take the same arguments as IDatabase::select() and return the SQL it would use.
Wikimedia\Rdbms\IDatabase\setSchemaVars
setSchemaVars( $vars)
Set schema variables to be used when streaming commands from SQL files or stdin.
Wikimedia\Rdbms\IDatabase\addQuotes
addQuotes( $s)
Escape and quote a raw value string for use in a SQL query.
Wikimedia\Rdbms\IDatabase\unionConditionPermutations
unionConditionPermutations( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])
Construct a UNION query for permutations of conditions.
Wikimedia\Rdbms\IDatabase\selectDomain
selectDomain( $domain)
Set the current domain (database, schema, and table prefix)
Wikimedia\Rdbms\IDatabase\onTransactionPreCommitOrIdle
onTransactionPreCommitOrIdle(callable $callback, $fname=__METHOD__)
Run a callback before the current transaction commits or now if there is none.
Wikimedia\Rdbms\IDatabase\makeWhereFrom2d
makeWhereFrom2d( $data, $baseKey, $subKey)
Build a partial where clause from a 2-d array such as used for LinkBatch.
Wikimedia\Rdbms\IDatabase\selectFieldValues
selectFieldValues( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
A SELECT wrapper which returns a list of single field values from result rows.
Wikimedia\Rdbms\IDatabase\getType
getType()
Get the type of the DBMS (e.g.
Wikimedia\Rdbms\IDatabase\getTopologyRootMaster
getTopologyRootMaster()
Get the host (or address) of the root master server for the replication topology.
Wikimedia\Rdbms\IDatabase\select
select( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
Execute a SELECT query constructed using the various parameters provided.
Wikimedia\Rdbms\IDatabase\getLBInfo
getLBInfo( $name=null)
Get properties passed down from the server info array of the load balancer.
Wikimedia\Rdbms\IDatabase\newSelectQueryBuilder
newSelectQueryBuilder()
Create an empty SelectQueryBuilder which can be used to run queries against this connection.
Wikimedia\Rdbms\IDatabase\timestampOrNull
timestampOrNull( $ts=null)
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for ins...
Wikimedia\Rdbms\IDatabase\buildGroupConcatField
buildGroupConcatField( $delim, $table, $field, $conds='', $join_conds=[])
Build a GROUP_CONCAT or equivalent statement for a query.
Wikimedia\Rdbms\IDatabase\serverIsReadOnly
serverIsReadOnly()
Wikimedia\Rdbms\IDatabase\estimateRowCount
estimateRowCount( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
Estimate the number of rows in dataset.
Wikimedia\Rdbms\IDatabase\dataSeek
dataSeek( $res, $row)
Change the position of the cursor in a result object.
Wikimedia\Rdbms\IDatabase\buildIntegerCast
buildIntegerCast( $field)
LIST_NAMES
const LIST_NAMES
Definition: Defines.php:50
Wikimedia\Rdbms\IDatabase\insertId
insertId()
Get the inserted value of an auto-increment row.
Wikimedia\Rdbms\IDatabase\onTransactionResolution
onTransactionResolution(callable $callback, $fname=__METHOD__)
Run a callback as soon as the current transaction commits or rolls back.
Wikimedia\Rdbms\IDatabase\addIdentifierQuotes
addIdentifierQuotes( $s)
Escape a SQL identifier (e.g.
Wikimedia\Rdbms\IDatabase\setSessionOptions
setSessionOptions(array $options)
Override database's default behavior.
Wikimedia\Rdbms\IDatabase\conditional
conditional( $cond, $trueVal, $falseVal)
Returns an SQL expression for a simple conditional.
Wikimedia\Rdbms\IDatabase\buildLike
buildLike( $param,... $params)
LIKE statement wrapper.
DBO_DEFAULT
const DBO_DEFAULT
Definition: defines.php:13
Wikimedia\Rdbms\IDatabase\setFlag
setFlag( $flag, $remember=self::REMEMBER_NOTHING)
Set a flag for this connection.
Wikimedia\Rdbms\IDatabase\nextSequenceValue
nextSequenceValue( $seqName)
Deprecated method, calls should be removed.
Wikimedia\Rdbms\IDatabase\makeList
makeList(array $a, $mode=self::LIST_COMMA)
Makes an encoded list of strings from an array.
Wikimedia\Rdbms\IDatabase\restoreFlags
restoreFlags( $state=self::RESTORE_PRIOR)
Restore the flags to their prior state before the last setFlag/clearFlag call.
Wikimedia\Rdbms\IDatabase\begin
begin( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
Begin a transaction.
Wikimedia\Rdbms\IDatabase\commit
commit( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
Commits a transaction previously started using begin()
Wikimedia\Rdbms\IDatabase\indexExists
indexExists( $table, $index, $fname=__METHOD__)
Determines whether an index exists.
Wikimedia\Rdbms\IDatabase\flushSnapshot
flushSnapshot( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
Commit any transaction but error out if writes or callbacks are pending.
Wikimedia\Rdbms\IDatabase\clearFlag
clearFlag( $flag, $remember=self::REMEMBER_NOTHING)
Clear a flag for this connection.
Wikimedia\Rdbms\IDatabase\pendingWriteRowsAffected
pendingWriteRowsAffected()
Get the number of affected rows from pending write queries.
Wikimedia\Rdbms\IDatabase\namedLocksEnqueue
namedLocksEnqueue()
Check to see if a named lock used by lock() use blocking queues.
$type
$type
Definition: testCompression.php:52
Wikimedia\Rdbms\IDatabase\startAtomic
startAtomic( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
Begin an atomic section of SQL statements.
Wikimedia\Rdbms\IDatabase\writesOrCallbacksPending
writesOrCallbacksPending()
Whether there is a transaction open with either possible write queries or unresolved pre-commit/commi...