MediaWiki REL1_39
|
Basic database interface for live and lazy-loaded relation database handles. More...
Public Member Functions | |
__toString () | |
Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present. | |
affectedRows () | |
Get the number of rows affected by the last write query. | |
begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT) | |
Begin a transaction. | |
cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null) | |
Cancel an atomic section of SQL statements. | |
clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Clear a flag for this connection. | |
close ( $fname=__METHOD__) | |
Close the database connection. | |
commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |
Commits a transaction previously started using begin() | |
databasesAreIndependent () | |
Returns true if DBs are assumed to be on potentially different servers. | |
dbSchema ( $schema=null) | |
Get/set the db schema. | |
decodeBlob ( $b) | |
Some DBMSs return a special placeholder object representing blob fields in result objects. | |
delete ( $table, $conds, $fname=__METHOD__) | |
Delete all rows in a table that match a condition. | |
deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__) | |
Delete all rows in a table that match a condition which includes a join. | |
doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |
Perform an atomic section of reversible SQL statements from a callback. | |
encodeBlob ( $b) | |
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. | |
endAtomic ( $fname=__METHOD__) | |
Ends an atomic section of SQL statements. | |
estimateRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Estimate the number of rows in dataset. | |
explicitTrxActive () | |
Check whether there is a transaction open at the specific request of a caller. | |
flushSession ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |
Release important session-level state (named lock, table locks) as post-rollback cleanup. | |
flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |
Commit any transaction but error out if writes or callbacks are pending. | |
getDBname () | |
Get the current database name; null if there isn't one. | |
getDomainID () | |
Return the currently selected domain ID. | |
getFlag ( $flag) | |
Returns a boolean whether the flag $flag is set for this connection. | |
getLag () | |
Get the amount of replication lag for this database server. | |
getLBInfo ( $name=null) | |
Get properties passed down from the server info array of the load balancer. | |
getPrimaryPos () | |
Get the position of this primary DB. | |
getReplicaPos () | |
Get the replication position of this replica DB. | |
getScopedLockAndFlush ( $lockKey, $fname, $timeout) | |
Acquire a named lock, flush any transaction, and return an RAII style unlocker object. | |
getServer () | |
Get the hostname or IP address of the server. | |
getServerInfo () | |
Get a human-readable string describing the current software version. | |
getServerName () | |
Get the readable name for the server. | |
getServerVersion () | |
A string describing the current software version, like from mysql_get_server_info() | |
getSessionLagStatus () | |
Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. | |
getSoftwareLink () | |
Returns a wikitext style link to the DB's website (e.g. | |
getTopologyBasedServerId () | |
Get a non-recycled ID that uniquely identifies this server within the replication topology. | |
getTopologyRole () | |
Get the replication topology role of this server. | |
getType () | |
Get the RDBMS type of the server (e.g. | |
insert ( $table, $rows, $fname=__METHOD__, $options=[]) | |
Insert row(s) into a table, in the provided order. | |
insertId () | |
Get the inserted value of an auto-increment row. | |
insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |
INSERT SELECT wrapper. | |
isOpen () | |
isReadOnly () | |
lastDoneWrites () | |
Get the last time the connection may have been used for a write query. | |
lastErrno () | |
Get the RDBMS-specific error code from the last query statement. | |
lastError () | |
Get the RDBMS-specific error description from the last query statement. | |
lastQuery () | |
Get the last query that sent on account of IDatabase::query() | |
lock ( $lockName, $method, $timeout=5, $flags=0) | |
Acquire a named lock. | |
lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Lock all rows meeting the given conditions/options FOR UPDATE. | |
lockIsFree ( $lockName, $method) | |
Check to see if a named lock is not locked by any thread (non-blocking) | |
namedLocksEnqueue () | |
Check to see if a named lock used by lock() use blocking queues. | |
newSelectQueryBuilder () | |
Create an empty SelectQueryBuilder which can be used to run queries against this connection. | |
nextSequenceValue ( $seqName) | |
Deprecated method, calls should be removed. | |
onAtomicSectionCancel (callable $callback, $fname=__METHOD__) | |
Run a callback when the atomic section is cancelled. | |
onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__) | |
Run a callback when the current transaction commits or now if there is none. | |
onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__) | |
Run a callback before the current transaction commits or now if there is none. | |
onTransactionResolution (callable $callback, $fname=__METHOD__) | |
Run a callback when the current transaction commits or rolls back. | |
pendingWriteCallers () | |
Get the list of method names that did write queries for this transaction. | |
pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL) | |
Get the time spend running write queries for this transaction. | |
ping (&$rtt=null) | |
Ping the server and try to reconnect if it there is no connection. | |
primaryPosWait (DBPrimaryPos $pos, $timeout) | |
Wait for the replica DB to catch up to a given primary DB position. | |
query ( $sql, $fname=__METHOD__, $flags=0) | |
Run an SQL query statement and return the result. | |
queryMulti (array $sqls, string $fname=__METHOD__, int $flags=0, ?string $summarySql=null) | |
Run a batch of SQL query statements and return the results. | |
replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__) | |
Insert row(s) into a table, in the provided order, while deleting conflicting rows. | |
restoreFlags ( $state=self::RESTORE_PRIOR) | |
Restore the flags to their prior state before the last setFlag/clearFlag call. | |
rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |
Rollback a transaction previously started using begin() | |
select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Execute a SELECT query constructed using the various parameters provided. | |
selectDB ( $db) | |
Change the current database. | |
selectDomain ( $domain) | |
Set the current domain (database, schema, and table prefix) | |
selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
A SELECT wrapper which returns a single field from a single result row. | |
selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
A SELECT wrapper which returns a list of single field values from result rows. | |
selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[]) | |
Wrapper to IDatabase::select() that only fetches one row (via LIMIT) | |
selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Get the number of rows in dataset. | |
serverIsReadOnly () | |
setBigSelects ( $value=true) | |
Allow or deny "big selects" for this session only. | |
setFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Set a flag for this connection. | |
setLBInfo ( $nameOrArray, $value=null) | |
Set the entire array or a particular key of the managing load balancer info array. | |
setSessionOptions (array $options) | |
Override database's default behavior. | |
setTransactionListener ( $name, callable $callback=null) | |
Run a callback after each time any transaction commits or rolls back. | |
startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |
Begin an atomic section of SQL statements. | |
tablePrefix ( $prefix=null) | |
Get/set the table prefix. | |
trxLevel () | |
Gets the current transaction level. | |
trxTimestamp () | |
Get the UNIX timestamp of the time that the transaction was established. | |
unlock ( $lockName, $method) | |
Release a lock. | |
update ( $table, $set, $conds, $fname=__METHOD__, $options=[]) | |
Update all rows in a table that match a given condition. | |
upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__) | |
Upsert row(s) into a table, in the provided order, while updating conflicting rows. | |
wasConnectionLoss () | |
Determines if the last query error was due to a dropped connection. | |
wasDeadlock () | |
Determines if the last failure was due to a deadlock. | |
wasErrorReissuable () | |
Determines if the last query error was due to something outside of the query itself. | |
wasLockTimeout () | |
Determines if the last failure was due to a lock timeout. | |
wasReadOnlyError () | |
Determines if the last failure was due to the database being read-only. | |
writesOrCallbacksPending () | |
Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. | |
writesPending () | |
Public Member Functions inherited from Wikimedia\Rdbms\Platform\ISQLPlatform | |
addIdentifierQuotes ( $s) | |
Escape a SQL identifier (e.g. | |
anyChar () | |
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. | |
anyString () | |
Returns a token for buildLike() that denotes a '' to be used in a LIKE query. | |
bitAnd ( $fieldLeft, $fieldRight) | |
bitNot ( $field) | |
bitOr ( $fieldLeft, $fieldRight) | |
buildConcat ( $stringList) | |
Build a concatenation list to feed into a SQL query. | |
buildExcludedValue ( $column) | |
Build a reference to a column value from the conflicting proposed upsert() row. | |
buildGreatest ( $fields, $values) | |
Build a GREATEST function statement comparing columns/values. | |
buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[]) | |
Build a GROUP_CONCAT or equivalent statement for a query. | |
buildIntegerCast ( $field) | |
buildLeast ( $fields, $values) | |
Build a LEAST function statement comparing columns/values. | |
buildLike ( $param,... $params) | |
LIKE statement wrapper. | |
buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery. | |
buildStringCast ( $field) | |
buildSubString ( $input, $startPosition, $length=null) | |
Build a SUBSTRING function. | |
conditional ( $cond, $caseTrueExpression, $caseFalseExpression) | |
Returns an SQL expression for a simple conditional. | |
decodeExpiry ( $expiry, $format=TS_MW) | |
Decode an expiry time into a DBMS independent format. | |
encodeExpiry ( $expiry) | |
Encode an expiry time into the DBMS dependent format. | |
factorConds ( $condsArray) | |
Given an array of condition arrays representing an OR list of AND lists, for example: | |
getInfinity () | |
Find out when 'infinity' is. | |
getTableAliases () | |
Return current table aliases. | |
implicitOrderby () | |
Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1. | |
limitResult ( $sql, $limit, $offset=false) | |
Construct a LIMIT query with optional offset. | |
makeList (array $a, $mode=self::LIST_COMMA) | |
Makes an encoded list of strings from an array. | |
makeWhereFrom2d ( $data, $baseKey, $subKey) | |
Build a partial where clause from a 2-d array such as used for LinkBatch. | |
selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Take the same arguments as IDatabase::select() and return the SQL it would use. | |
setIndexAliases (array $aliases) | |
Convert certain index names to alternative names before querying the DB. | |
setSchemaVars ( $vars) | |
Set schema variables to be used when streaming commands from SQL files or stdin. | |
setTableAliases (array $aliases) | |
Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. | |
strreplace ( $orig, $old, $new) | |
Returns a SQL expression for simple string replacement (e.g. | |
tableName ( $name, $format='quoted') | |
Format a table name ready for use in constructing an SQL query. | |
tableNames (... $tables) | |
Fetch a number of table names into an associative array. | |
tableNamesN (... $tables) | |
Fetch a number of table names into a zero-indexed numerical array. | |
timestamp ( $ts=0) | |
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. | |
timestampOrNull ( $ts=null) | |
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. | |
unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Construct a UNION query for permutations of conditions. | |
unionQueries ( $sqls, $all) | |
Construct a UNION query. | |
unionSupportsOrderAndLimit () | |
Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION. | |
Public Member Functions inherited from Wikimedia\Rdbms\Database\DbQuoter | |
addQuotes ( $s) | |
Escape and quote a raw value string for use in a SQL query. | |
Public Attributes | |
const | LOCK_TIMESTAMP = 1 |
Flag to return the lock acquisition timestamp (null if not acquired) | |
Public Attributes inherited from Wikimedia\Rdbms\Platform\ISQLPlatform | |
const | QUERY_PSEUDO_PERMANENT = 2 |
Track a TEMPORARY table CREATE as if it was for a permanent table (for testing) | |
Basic database interface for live and lazy-loaded relation database handles.
Definition at line 39 of file IDatabase.php.
Wikimedia\Rdbms\IDatabase::__toString | ( | ) |
Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::affectedRows | ( | ) |
Get the number of rows affected by the last write query.
Similar to https://www.php.net/mysql_affected_rows but includes rows matched but not changed (ie. an UPDATE which sets all fields to the same value they already have). To get the old mysql_affected_rows behavior, include non-equality of the fields in WHERE.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by User\addToDatabase(), MigrateComments\migrate(), MigrateActors\migrate(), MigrateActors\migrateLogSearch(), MigrateComments\migrateToTemp(), DeleteLocalPasswords\processUsers(), PopulateArchiveRevId\reassignArRevIds(), and User\saveSettings().
Wikimedia\Rdbms\IDatabase::begin | ( | $fname = __METHOD__, | |
$mode = self::TRANSACTION_EXPLICIT ) |
Begin a transaction.
Only call this from code with outer transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.
Note that when the DBO_TRX flag is set (which is usually the case for web requests, but not for maintenance scripts), any previous database query will have started a transaction automatically.
Nesting of transactions is not supported. Attempts to nest transactions will cause a warning, unless the current transaction was started automatically because of the DBO_TRX flag.
string | $fname | Calling function name |
string | $mode | A situationally valid IDatabase::TRANSACTION_* constant [optional] |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\DBConnRef, and Wikimedia\Rdbms\Database.
Referenced by Maintenance\beginTransaction().
Wikimedia\Rdbms\IDatabase::cancelAtomic | ( | $fname = __METHOD__, | |
AtomicSectionIdentifier | $sectionId = null ) |
Cancel an atomic section of SQL statements.
This will roll back only the statements executed since the start of the most recent atomic section, and close that section. If a transaction was open before the corresponding startAtomic() call, any statements before that call are not rolled back and the transaction remains open. If the corresponding startAtomic() implicitly started a transaction, that transaction is rolled back.
Note that a call to IDatabase::rollback() will also roll back any open atomic sections.
string | $fname | |
AtomicSectionIdentifier | null | $sectionId | Section ID from startAtomic(); passing this enables cancellation of unclosed nested sections [optional] |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::clearFlag | ( | $flag, | |
$remember = self::REMEMBER_NOTHING ) |
Clear a flag for this connection.
int | $flag | One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX) |
string | $remember | IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING] |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::close | ( | $fname = __METHOD__ | ) |
Close the database connection.
This should only be called after any transactions have been resolved, aside from read-only automatic transactions (assuming no callbacks are registered). If a transaction is still open anyway, it will be rolled back.
string | $fname | Caller name |
DBError |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\closeConnection().
Wikimedia\Rdbms\IDatabase::commit | ( | $fname = __METHOD__, | |
$flush = self::FLUSHING_ONE ) |
Commits a transaction previously started using begin()
If no transaction is in progress, a warning is issued.
Only call this from code with outer transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.
string | $fname | |
string | $flush | Flush flag, set to situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly committing implicit transactions, or calling commit when no transaction is in progress. This will trigger an exception if there is an ongoing explicit transaction. Only set the flush flag if you are sure that these warnings are not applicable, and no explicit transactions are open. |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Maintenance\commitTransaction().
Wikimedia\Rdbms\IDatabase::databasesAreIndependent | ( | ) |
Returns true if DBs are assumed to be on potentially different servers.
In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::dbSchema | ( | $schema = null | ) |
Get/set the db schema.
string | null | $schema | The database schema to set, or omitted to leave it unchanged |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::decodeBlob | ( | $b | ) |
Some DBMSs return a special placeholder object representing blob fields in result objects.
Pass the object through this function to return the original string.
string | Blob | $b |
DBError |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by ArchivedFile\loadMetadataFromDbFieldValue(), and LocalFile\loadMetadataFromDbFieldValue().
Wikimedia\Rdbms\IDatabase::delete | ( | $table, | |
$conds, | |||
$fname = __METHOD__ ) |
Delete all rows in a table that match a condition.
string | $table | Table name |
string | array | $conds | Array of conditions. See $conds in IDatabase::select() In order to prevent possible performance or replication issues or damaging a data accidentally, an empty condition for 'delete' queries isn't allowed. IDatabase::ALL_ROWS should be passed explicitly in order to delete all rows. |
string | $fname | Name of the calling function |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by PopulateArchiveRevId\checkMysqlAutoIncrementBug(), SqlBagOStuff\deleteAll(), MediaWiki\Deferred\LinksUpdate\LinksTable\doWrites(), LCStoreDB\finishWrite(), MigrateActors\migrateLogSearch(), MediaWiki\Block\DatabaseBlockStore\purgeExpiredBlocks(), Title\purgeExpiredRestrictions(), PopulateArchiveRevId\reassignArRevIds(), and QueryPage\recache().
Wikimedia\Rdbms\IDatabase::deleteJoin | ( | $delTable, | |
$joinTable, | |||
$delVar, | |||
$joinVar, | |||
$conds, | |||
$fname = __METHOD__ ) |
Delete all rows in a table that match a condition which includes a join.
For safety, an empty $conds will not delete everything. If you want to delete all rows where the join condition matches, set $conds=IDatabase::ALL_ROWS.
DO NOT put the join condition in $conds.
string | $delTable | The table to delete from. |
string | $joinTable | The other table. |
string | $delVar | The variable to join on, in the first table. |
string | $joinVar | The variable to join on, in the second table. |
array | string | $conds | Condition array of field names mapped to variables, ANDed together in the WHERE clause |
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::doAtomicSection | ( | $fname, | |
callable | $callback, | ||
$cancelable = self::ATOMIC_NOT_CANCELABLE ) |
Perform an atomic section of reversible SQL statements from a callback.
The $callback takes the following arguments:
This will execute the callback inside a pair of startAtomic()/endAtomic() calls. If any exception occurs during execution of the callback, it will be handled as follows:
This method is convenient for letting calls to the caller of this method be wrapped in a try/catch blocks for exception types that imply that the caller failed but was able to properly discard the changes it made in the transaction. This method can be an alternative to explicit calls to startAtomic()/endAtomic()/cancelAtomic().
Example usage, "RecordStore::save" method:
Example usage, caller of the "RecordStore::save" method:
string | $fname | Caller name (usually METHOD) |
callable | $callback | Callback that issues DB updates |
string | $cancelable | Pass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section. |
DBError | If an error occurs, { |
Exception | If an error occurs in the callback |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by User\addToDatabase(), PopulateArchiveRevId\checkMysqlAutoIncrementBug(), MediaWiki\Revision\RevisionStore\insertRevisionOn(), and PopulateArchiveRevId\reassignArRevIds().
Wikimedia\Rdbms\IDatabase::encodeBlob | ( | $b | ) |
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.
To insert into such a field, pass the data through this function before passing it to IDatabase::insert().
string | $b |
DBError |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by ArchivedFile\getMetadataForDb(), LocalFile\getMetadataForDb(), and LCStoreDB\set().
Wikimedia\Rdbms\IDatabase::endAtomic | ( | $fname = __METHOD__ | ) |
Ends an atomic section of SQL statements.
Ends the next section of atomic SQL statements and commits the transaction if necessary.
string | $fname |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by JobQueueDB\doBatchPushInternal(), and LCStoreDB\finishWrite().
Wikimedia\Rdbms\IDatabase::estimateRowCount | ( | $tables, | |
$var = ' *', | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Estimate the number of rows in dataset.
MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.
For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).
Takes the same arguments as IDatabase::select().
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::estimateRowCount
instead, which is more readable and less error-prone.
string | string[] | $tables | Table name(s) |
string | $var | Column for which NULL values are not counted [default "*"] |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select |
array | string | $join_conds | Join conditions |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::explicitTrxActive | ( | ) |
Check whether there is a transaction open at the specific request of a caller.
Explicit transactions are spawned by begin(), startAtomic(), and doAtomicSection(). Note that explicit transactions should not be confused with explicit transaction rounds.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::flushSession | ( | $fname = __METHOD__, | |
$flush = self::FLUSHING_ONE ) |
Release important session-level state (named lock, table locks) as post-rollback cleanup.
This should only be called by a load balancer or if the handle is not attached to one. Also, there must be no chance that a future caller will still be expecting some of the lost session state.
Connection and query errors will be suppressed and logged
string | $fname | Calling function name |
string | $flush | Flush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly rolling back implicit transactions. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context. |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::flushSnapshot | ( | $fname = __METHOD__, | |
$flush = self::FLUSHING_ONE ) |
Commit any transaction but error out if writes or callbacks are pending.
This is intended for clearing out REPEATABLE-READ snapshots so that callers can see a new point-in-time of the database. This is useful when one of many transaction rounds finished and significant time will pass in the script's lifetime. It is also useful to call on a replica DB after waiting on replication to catch up to the primary DB.
string | $fname | Calling function name |
string | $flush | Flush flag, set to situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly committing implicit transactions, or calling commit when no transaction is in progress. This will trigger an exception if there is an ongoing explicit transaction. Only set the flush flag if you are sure that these warnings are not applicable, and no explicit transactions are open. |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getDBname | ( | ) |
Get the current database name; null if there isn't one.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getDomainID | ( | ) |
Return the currently selected domain ID.
Null components (database/schema) might change once a connection is established
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\closeConnection(), MediaWiki\Deferred\LinksUpdate\LinksTable\doWrites(), Wikimedia\Rdbms\LoadBalancer\getConnLogContext(), ActorMigrationBase\getInsertValues(), ActorMigrationBase\getInsertValuesWithTempTable(), ActorMigrationBase\getWhere(), Title\invalidateCache(), Wikimedia\Rdbms\LBFactorySingle\newFromConnection(), Wikimedia\Rdbms\LoadBalancerSingle\newFromConnection(), MediaWiki\ResourceLoader\WikiModule\preloadTitleInfo(), Wikimedia\Rdbms\LoadBalancer\reuseConnectionInternal(), and Wikimedia\Rdbms\TransactionManager\transactionWritingOut().
Wikimedia\Rdbms\IDatabase::getFlag | ( | $flag | ) |
Returns a boolean whether the flag $flag is set for this connection.
int | $flag | One of the class IDatabase::DBO_* constants |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getLag | ( | ) |
Get the amount of replication lag for this database server.
Callers should avoid using this method while a transaction is active
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getLBInfo | ( | $name = null | ) |
Get properties passed down from the server info array of the load balancer.
string | null | $name | The entry of the info array to get, or null to get the whole array |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\closeConnection(), Wikimedia\Rdbms\LoadBalancer\reuseConnectionInternal(), and Wikimedia\Rdbms\LoadBalancer\waitForPrimaryPos().
Wikimedia\Rdbms\IDatabase::getPrimaryPos | ( | ) |
Get the position of this primary DB.
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getReplicaPos | ( | ) |
Get the replication position of this replica DB.
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getScopedLockAndFlush | ( | $lockKey, | |
$fname, | |||
$timeout ) |
Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
Only call this from outer transaction scope and when only one DB will be affected. See https://www.mediawiki.org/wiki/Database_transactions for details.
This is suitable for transactions that need to be serialized using cooperative locks, where each transaction can see each others' changes. Any transaction is flushed to clear out stale REPEATABLE-READ snapshot data. Once the returned object falls out of PHP scope, the lock will be released unless a transaction is active. If one is active, then the lock will be released when it either commits or rolls back.
If the lock acquisition failed, then no transaction flush happens, and null is returned.
string | $lockKey | Name of lock to release |
string | $fname | Name of the calling method |
int | $timeout | Acquisition timeout in seconds |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by MediaWiki\Deferred\LinksUpdate\LinksUpdate\acquirePageLock().
Wikimedia\Rdbms\IDatabase::getServer | ( | ) |
Get the hostname or IP address of the server.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getServerInfo | ( | ) |
Get a human-readable string describing the current software version.
Use getServerVersion() to get machine-friendly information.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getServerName | ( | ) |
Get the readable name for the server.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\DBQueryError\__construct(), Wikimedia\Rdbms\LoadBalancer\getConnLogContext(), and Wikimedia\Rdbms\TransactionManager\transactionWritingOut().
Wikimedia\Rdbms\IDatabase::getServerVersion | ( | ) |
A string describing the current software version, like from mysql_get_server_info()
Implemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\Database\getServerInfo(), and DatabaseInstaller\meetsMinimumRequirement().
Wikimedia\Rdbms\IDatabase::getSessionLagStatus | ( | ) |
Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active.
This is useful when transactions might use snapshot isolation (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data is this lag plus transaction duration. If they don't, it is still safe to be pessimistic. In AUTOCOMMIT mode, this still gives an indication of the staleness of subsequent reads.
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getSoftwareLink | ( | ) |
Returns a wikitext style link to the DB's website (e.g.
"[https://www.mysql.com/ MySQL]")
Should at least contain plain text, if for some reason your database has no website.
Implemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by MysqlInstaller\meetsMinimumRequirement().
Wikimedia\Rdbms\IDatabase::getTopologyBasedServerId | ( | ) |
Get a non-recycled ID that uniquely identifies this server within the replication topology.
A replication topology defines which servers can originate changes to a given dataset and how those changes propagate among database servers. It is assumed that the server only participates in the replication of a single relevant dataset.
DBQueryError |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getTopologyRole | ( | ) |
Get the replication topology role of this server.
A replication topology defines which servers can originate changes to a given dataset and how those changes propagate among database servers. It is assumed that the server only participates in the replication of a single relevant dataset.
DBQueryError |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getType | ( | ) |
Get the RDBMS type of the server (e.g.
"mysql", "sqlite")
Implemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by PopulateArchiveRevId\checkMysqlAutoIncrementBug(), Wikimedia\Rdbms\SelectQueryBuilder\connection(), SqlBagOStuff\createTables(), DatabaseUpdater\newForDB(), and DatabaseUpdater\patchPath().
Wikimedia\Rdbms\IDatabase::insert | ( | $table, | |
$rows, | |||
$fname = __METHOD__, | |||
$options = [] ) |
Insert row(s) into a table, in the provided order.
string | $table | Table name |
array | array[] | $rows | Row(s) to insert, as either:
|
string | $fname | Calling function name (use METHOD) for logs/profiling |
string | array | $options | Combination map/list where each string-keyed entry maps a non-boolean option to the option parameters and each integer-keyed value is the name of a boolean option. Supported options are:
|
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by User\addToDatabase(), PopulateArchiveRevId\checkMysqlAutoIncrementBug(), CommentStore\createComment(), JobQueueDB\doBatchPushInternal(), MediaWiki\Deferred\LinksUpdate\LinksTable\doWrites(), LCStoreDB\finishWrite(), MigrateActors\migrateLogSearch(), MigrateComments\migrateToTemp(), PopulateArchiveRevId\reassignArRevIds(), and QueryPage\recache().
Wikimedia\Rdbms\IDatabase::insertId | ( | ) |
Get the inserted value of an auto-increment row.
This should only be called after an insert that used an auto-incremented value. If no such insert was previously done in the current database session, the return value is undefined.
Implemented in Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by User\addToDatabase(), PopulateArchiveRevId\checkMysqlAutoIncrementBug(), and CommentStore\createComment().
Wikimedia\Rdbms\IDatabase::insertSelect | ( | $destTable, | |
$srcTable, | |||
$varMap, | |||
$conds, | |||
$fname = __METHOD__, | |||
$insertOptions = [], | |||
$selectOptions = [], | |||
$selectJoinConds = [] ) |
INSERT SELECT wrapper.
string | $destTable | The table name to insert into |
string | array | $srcTable | May be either a table name, or an array of table names to include in a join. |
array | $varMap | Must be an associative array of the form [ 'dest1' => 'source1', ... ]. Source items may be literals rather than field names, but strings should be quoted with IDatabase::addQuotes() |
array | $conds | Condition array. See $conds in IDatabase::select() for the details of the format of condition arrays. May be "*" to copy the whole table. |
string | $fname | The function name of the caller, from METHOD |
array | $insertOptions | Options for the INSERT part of the query, see IDatabase::insert() for details. Also, one additional option is available: pass 'NO_AUTO_COLUMNS' to hint that the query does not use an auto-increment or sequence to determine any column values. |
array | $selectOptions | Options for the SELECT part of the query, see IDatabase::select() for details. |
array | $selectJoinConds | Join conditions for the SELECT part of the query, see IDatabase::select() for details. |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::isOpen | ( | ) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::isReadOnly | ( | ) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by LCStoreDB\startWrite().
Wikimedia\Rdbms\IDatabase::lastDoneWrites | ( | ) |
Get the last time the connection may have been used for a write query.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::lastErrno | ( | ) |
Get the RDBMS-specific error code from the last query statement.
Implemented in Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\wasDeadlock(), Wikimedia\Rdbms\DatabaseMysqlBase\wasLockTimeout(), and Wikimedia\Rdbms\DatabaseMysqlBase\wasReadOnlyError().
Wikimedia\Rdbms\IDatabase::lastError | ( | ) |
Get the RDBMS-specific error description from the last query statement.
Implemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::lastQuery | ( | ) |
Get the last query that sent on account of IDatabase::query()
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::lock | ( | $lockName, | |
$method, | |||
$timeout = 5, | |||
$flags = 0 ) |
Acquire a named lock.
Named locks are not related to transactions
string | $lockName | Name of lock to acquire |
string | $method | Name of the calling method |
int | $timeout | Acquisition timeout in seconds (0 means non-blocking) |
int | $flags | Bit field of IDatabase::LOCK_* constants |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by SqlBagOStuff\doLock().
Wikimedia\Rdbms\IDatabase::lockForUpdate | ( | $table, | |
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Lock all rows meeting the given conditions/options FOR UPDATE.
string | string[] | $table | Table name(s) |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select ("FOR UPDATE" is added automatically) |
array | $join_conds | Join conditions |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by LocalFileMoveBatch\verifyDBUpdates().
Wikimedia\Rdbms\IDatabase::lockIsFree | ( | $lockName, | |
$method ) |
Check to see if a named lock is not locked by any thread (non-blocking)
string | $lockName | Name of lock to poll |
string | $method | Name of method calling us |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::namedLocksEnqueue | ( | ) |
Check to see if a named lock used by lock() use blocking queues.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::newSelectQueryBuilder | ( | ) |
Create an empty SelectQueryBuilder which can be used to run queries against this connection.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by ChangeTags\getTagsWithData().
Wikimedia\Rdbms\IDatabase::nextSequenceValue | ( | $seqName | ) |
Deprecated method, calls should be removed.
This was formerly used for PostgreSQL to handle self::insertId() auto-incrementing fields. It is no longer necessary since DatabasePostgres::insertId() has been reimplemented using lastval()
Implementations should return null if inserting NULL
into an auto-incrementing field works, otherwise it should return an instance of NextSequenceValue and filter it on calls to relevant methods.
string | $seqName |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::onAtomicSectionCancel | ( | callable | $callback, |
$fname = __METHOD__ ) |
Run a callback when the atomic section is cancelled.
The callback is run just after the current atomic section, any outer atomic section, or the whole transaction is rolled back.
An error is thrown if no atomic section is pending. The atomic section need not have been created with the ATOMIC_CANCELABLE flag.
Queries in the function may be running in the context of an outer transaction or may be running in AUTOCOMMIT mode. The callback should use atomic sections if necessary.
The callback takes the following arguments:
callable | $callback | |
string | $fname | Caller name |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::onTransactionCommitOrIdle | ( | callable | $callback, |
$fname = __METHOD__ ) |
Run a callback when the current transaction commits or now if there is none.
If there is a transaction and it is rolled back, then the callback is cancelled.
When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.
This IDatabase instance will start off in auto-commit mode when the callback starts. The use of other IDatabase handles from the callback should be avoided unless they are known to be in auto-commit mode. Callbacks that create transactions via begin() or startAtomic() must have matching calls to commit()/endAtomic().
Use this method only for the following purposes:
The callback takes the following arguments:
Callbacks will execute in the order they were enqueued.
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, { |
Exception | If the callback runs immediately and an error occurs in it |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::onTransactionPreCommitOrIdle | ( | callable | $callback, |
$fname = __METHOD__ ) |
Run a callback before the current transaction commits or now if there is none.
If there is a transaction and it is rolled back, then the callback is cancelled.
When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.
If there is no current transaction, one will be created to wrap the callback. Callbacks cannot use begin()/commit() to manage transactions. The use of other IDatabase handles from the callback should be avoided.
Use this method only for the following purposes:
The callback takes the one argument:
Callbacks will execute in the order they were enqueued.
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, { |
Exception | If the callback runs immediately and an error occurs in it |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::onTransactionResolution | ( | callable | $callback, |
$fname = __METHOD__ ) |
Run a callback when the current transaction commits or rolls back.
An error is thrown if no transaction is pending.
When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT/ROLLBACK.
This IDatabase instance will start off in auto-commit mode when the callback starts. The use of other IDatabase handles from the callback should be avoided unless they are known to be in auto-commit mode. Callbacks that create transactions via begin() or startAtomic() must have matching calls to commit()/endAtomic().
Use this method only for the following purposes:
The callback takes the following arguments:
Callbacks will execute in the order they were enqueued.
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, { |
Exception | If the callback runs immediately and an error occurs in it |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by AtomicSectionUpdate\__construct(), and AutoCommitUpdate\__construct().
Wikimedia\Rdbms\IDatabase::pendingWriteCallers | ( | ) |
Get the list of method names that did write queries for this transaction.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::pendingWriteQueryDuration | ( | $type = self::ESTIMATE_TOTAL | ) |
Get the time spend running write queries for this transaction.
High values could be due to scanning, updates, locking, and such.
string | $type | IDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL] |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::ping | ( | & | $rtt = null | ) |
Ping the server and try to reconnect if it there is no connection.
float | null | &$rtt | Value to store the estimated RTT [optional] |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\TransactionManager\pendingWriteQueryDuration().
Wikimedia\Rdbms\IDatabase::primaryPosWait | ( | DBPrimaryPos | $pos, |
$timeout ) |
Wait for the replica DB to catch up to a given primary DB position.
Note that this does not start any new transactions. If any existing transaction is flushed, and this is called, then queries will reflect the point the DB was synced up to (on success) without interference from REPEATABLE-READ snapshots.
DBPrimaryPos | $pos | |
int | $timeout | The maximum number of seconds to wait for synchronisation |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\waitForPrimaryPos().
Wikimedia\Rdbms\IDatabase::query | ( | $sql, | |
$fname = __METHOD__, | |||
$flags = 0 ) |
Run an SQL query statement and return the result.
If a connection loss is detected, then an attempt to reconnect will be made. For queries that involve no larger transactions or locks, they will be re-issued for convenience, provided the connection was re-established.
In new code, the query wrappers select(), insert(), update(), delete(), etc. should be used where possible, since they give much better DBMS independence and automatically quote or validate user input in a variety of contexts. This function is generally only useful for queries which are explicitly DBMS-dependent and are unsupported by the query wrappers, such as CREATE TABLE.
However, the query wrappers themselves should call this function.
string | $sql | Single-statement SQL query |
string | $fname | Caller name; used for profiling/SHOW PROCESSLIST comments |
int | $flags | Bit field of IDatabase::QUERY_* constants. |
DBQueryError | If the query is issued, fails, and QUERY_SILENCE_ERRORS is not set. |
DBExpectedError | If the query is not, and cannot, be issued yet (non-DBQueryError) |
DBError | If the query is inherently not allowed (non-DBExpectedError) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by SqlBagOStuff\createTables(), MySqlLockManager\initConnection(), and MwSql\sqlDoQuery().
Wikimedia\Rdbms\IDatabase::queryMulti | ( | array | $sqls, |
string | $fname = __METHOD__, | ||
int | $flags = 0, | ||
?string | $summarySql = null ) |
Run a batch of SQL query statements and return the results.
string[] | $sqls | Map of (statement ID => SQL statement) |
string | $fname | Name of the calling function |
int | $flags | Bit field of IDatabase::QUERY_* constants |
string | null | $summarySql | Virtual SQL for profiling (e.g. "UPSERT INTO TABLE 'x'") |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::replace | ( | $table, | |
$uniqueKeys, | |||
$rows, | |||
$fname = __METHOD__ ) |
Insert row(s) into a table, in the provided order, while deleting conflicting rows.
Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.
Note some important implications of the deletion semantics:
string | $table | The table name |
string | string[] | string[][] | $uniqueKeys | Column name or non-empty list of column name lists that define all applicable unique keys on the table. There must only be one such key. Each unique key on the table is "applicable" unless either:
|
array | array[] | $rows | Row(s) to insert, in the form of either:
|
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by WatchedItemStore\duplicateEntry().
Wikimedia\Rdbms\IDatabase::restoreFlags | ( | $state = self::RESTORE_PRIOR | ) |
Restore the flags to their prior state before the last setFlag/clearFlag call.
string | $state | IDatabase::RESTORE_* constant. [default: RESTORE_PRIOR] |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::rollback | ( | $fname = __METHOD__, | |
$flush = self::FLUSHING_ONE ) |
Rollback a transaction previously started using begin()
Only call this from code with outer transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported. If a serious unexpected error occurs, throwing an Exception is preferable, using a pre-installed error handler to trigger rollback (in any case, failure to issue COMMIT will cause rollback server-side).
Query, connection, and onTransaction* callback errors will be suppressed and logged.
string | $fname | Calling function name |
string | $flush | Flush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly rolling back implicit transactions. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context. |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Maintenance\rollbackTransaction().
Wikimedia\Rdbms\IDatabase::select | ( | $table, | |
$vars, | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Execute a SELECT query constructed using the various parameters provided.
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchResultSet
instead, which is more readable and less error-prone.
string | array | $table | Table name(s) |
May be either an array of table names, or a single string holding a table name. If an array is given, table aliases can be specified, for example:
[ 'a' => 'user' ]
This includes the user table in the query, with the alias "a" available for use in field names (e.g. a.user_name).
A derived table, defined by the result of selectSQLText(), requires an alias key and a Subquery instance value which wraps the SQL query, for example:
[ 'c' => new Subquery( 'SELECT ...' ) ]
Joins using parentheses for grouping (since MediaWiki 1.31) may be constructed using nested arrays. For example,
[ 'tableA', 'nestedB' => [ 'tableB', 'b2' => 'tableB2' ] ]
along with $join_conds
like
[ 'b2' => [ 'JOIN', 'b_id = b2_id' ], 'nestedB' => [ 'LEFT JOIN', 'b_a = a_id' ] ]
will produce SQL something like
FROM tableA LEFT JOIN (tableB JOIN tableB2 AS b2 ON (b_id = b2_id)) ON (b_a = a_id)
All of the table names given here are automatically run through Database::tableName(), which causes the table prefix (if any) to be added, and various other table name mappings to be performed.
Do not use untrusted user input as a table name. Alias names should not have characters outside of the Basic multilingual plane.
string | array | $vars | Field name(s) |
May be either a field name or an array of field names. The field names can be complete fragments of SQL, for direct inclusion into the SELECT query. If an array is given, field aliases can be specified, for example:
[ 'maxrev' => 'MAX(rev_id)' ]
This includes an expression with the alias "maxrev" in the query.
If an expression is given, care must be taken to ensure that it is DBMS-independent.
Untrusted user input must not be passed to this parameter.
string | array | $conds |
May be either a string containing a single condition, or an array of conditions. If an array is given, the conditions constructed from each element are combined with AND.
Array elements may take one of two forms:
Note that expressions are often DBMS-dependent in their syntax. DBMS-independent wrappers are provided for constructing several types of expression commonly used in condition queries. See:
Untrusted user input is safe in the values of string keys, however untrusted input must not be used in the array key names or in the values of numeric keys. Escaping of untrusted input used in values of numeric keys should be done via IDatabase::addQuotes()
Use an empty array, string, or IDatabase::ALL_ROWS to select all rows.
You can put simple join conditions here, but this is strongly discouraged. Instead of
// $conds... 'rev_actor = actor_id',
use (see below for $join_conds):
// $join_conds... 'actor' => [ 'JOIN', 'rev_actor = actor_id' ],
string | $fname | Caller function name |
string | array | $options | Query options |
Optional: Array of query options. Boolean options are specified by including them in the array as a string value with a numeric key, for example:
[ 'FOR UPDATE' ]
The supported options are:
And also the following boolean MySQL extensions, see the MySQL manual for documentation:
string | array | $join_conds | Join conditions |
Optional associative array of table-specific join conditions. Simple conditions can also be specified in the regular $conds, but this is strongly discouraged in favor of the more explicit syntax here.
The key of the array contains the table name or alias. The value is an array with two elements, numbered 0 and 1. The first gives the type of join, the second is the same as the $conds parameter. Thus it can be an SQL fragment, or an array where the string keys are equality and the numeric keys are SQL fragments all AND'd together. For example:
[ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by JobQueueDB\doBatchPushInternal(), RefreshImageMetadata\execute(), MediaWiki\ResourceLoader\WikiModule\fetchTitleInfo(), WANCacheReapUpdate\getTitleChangeEvents(), MigrateComments\migrate(), MigrateActors\migrate(), MigrateActors\migrateLogSearch(), MigrateComments\migrateToTemp(), and MediaWiki\Revision\RevisionStore\userWasLastToEdit().
Wikimedia\Rdbms\IDatabase::selectDB | ( | $db | ) |
Change the current database.
This should only be called by a load balancer or if the handle is not attached to one
string | $db |
DBConnectionError | If databasesAreIndependent() is true and connection change fails |
DBError | On query error or if database changes are disallowed |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::selectDomain | ( | $domain | ) |
Set the current domain (database, schema, and table prefix)
This will throw an error for some database types if the database is unspecified
This should only be called by a load balancer or if the handle is not attached to one
string | DatabaseDomain | $domain |
DBConnectionError | If databasesAreIndependent() is true and connection change fails |
DBError | On query error, if domain changes are disallowed, or the domain is invalid |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::selectField | ( | $table, | |
$var, | |||
$cond = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
A SELECT wrapper which returns a single field from a single result row.
If no result rows are returned from the query, false is returned.
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchField
instead, which is more readable and less error-prone.
string | array | $table | Table name. { |
string | array | $var | The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. Can be an array, but must contain exactly 1 element then. { |
string | array | $cond | The condition array. { |
string | $fname | The function name of the caller. |
string | array | $options | The query options. { |
string | array | $join_conds | The query join conditions. { |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by User\addToDatabase(), PopulateArchiveRevId\checkMysqlAutoIncrementBug(), CommentStore\createComment(), MediaWiki\Revision\RevisionStore\getTimestampFromId(), MigrateActors\migrateLogSearch(), and MediaWiki\Revision\RevisionStore\newNullRevision().
Wikimedia\Rdbms\IDatabase::selectFieldValues | ( | $table, | |
$var, | |||
$cond = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
A SELECT wrapper which returns a list of single field values from result rows.
If no result rows are returned from the query, an empty array is returned.
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchFieldValues
instead, which is more readable and less error-prone.
string | array | $table | Table name. { |
string | $var | The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. |
string | array | $cond | The condition array. { |
string | $fname | The function name of the caller. |
string | array | $options | The query options. { |
string | array | $join_conds | The query join conditions. { |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by PurgeJobUtils\invalidatePages(), MediaWiki\Block\DatabaseBlockStore\purgeExpiredBlocks(), Title\purgeExpiredRestrictions(), and PopulateArchiveRevId\reassignArRevIds().
Wikimedia\Rdbms\IDatabase::selectRow | ( | $table, | |
$vars, | |||
$conds, | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Wrapper to IDatabase::select() that only fetches one row (via LIMIT)
If the query returns no rows, false is returned.
This method is convenient for fetching a row based on a unique key condition.
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchRow
instead, which is more readable and less error-prone.
string | array | $table | Table name |
string | array | $vars | Field names |
string | array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
array | string | $join_conds | Join conditions |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by MediaWiki\Revision\RevisionStore\countRevisionsByPageId(), and DatabaseLogEntry\newFromId().
Wikimedia\Rdbms\IDatabase::selectRowCount | ( | $tables, | |
$var = ' *', | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Get the number of rows in dataset.
This is useful when trying to do COUNT(*) but with a LIMIT for performance.
Takes the same arguments as IDatabase::select().
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchRowCount
instead, which is more readable and less error-prone.
string | string[] | $tables | Table name(s) |
string | $var | Column for which NULL values are not counted [default "*"] |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select |
array | $join_conds | Join conditions (since 1.27) |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by PopulateArchiveRevId\isNewInstall().
Wikimedia\Rdbms\IDatabase::serverIsReadOnly | ( | ) |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::setBigSelects | ( | $value = true | ) |
Allow or deny "big selects" for this session only.
This is done by setting the sql_big_selects session variable.
This is a MySQL-specific feature.
bool | string | $value | True for allow, false for deny, or "default" to restore the initial value |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::setFlag | ( | $flag, | |
$remember = self::REMEMBER_NOTHING ) |
Set a flag for this connection.
int | $flag | One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX) |
string | $remember | IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING] |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by DatabaseUpdater\__construct().
Wikimedia\Rdbms\IDatabase::setLBInfo | ( | $nameOrArray, | |
$value = null ) |
Set the entire array or a particular key of the managing load balancer info array.
Keys matching the IDatabase::LB_* constants are also used internally by subclasses
array | string | $nameOrArray | The new array or the name of a key to set |
array | mixed | null | $value | If $nameOrArray is a string, the new key value (null to unset) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::setSessionOptions | ( | array | $options | ) |
Override database's default behavior.
$options include: 'connTimeout' : Set the connection timeout value in seconds. May be useful for very long batch queries such as full-wiki dumps, where a single query reads out over hours or days.
array | $options |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Referenced by BackupDumper\backupDb().
Wikimedia\Rdbms\IDatabase::setTransactionListener | ( | $name, | |
callable | $callback = null ) |
Run a callback after each time any transaction commits or rolls back.
The callback takes two arguments:
Registering a callback here will not affect writesOrCallbacks() pending.
Since callbacks from this or onTransactionCommitOrIdle() can start and end transactions, a single call to IDatabase::commit might trigger multiple runs of the listener callbacks.
string | $name | Callback name |
callable | null | $callback | Use null to unset a listener |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::startAtomic | ( | $fname = __METHOD__, | |
$cancelable = self::ATOMIC_NOT_CANCELABLE ) |
Begin an atomic section of SQL statements.
Start an implicit transaction if no transaction is already active, set a savepoint (if $cancelable is ATOMIC_CANCELABLE), and track the given section name to enforce that the transaction is not committed prematurely. The end of the section must be signified exactly once, either by endAtomic() or cancelAtomic(). Sections can have have layers of inner sections (sub-sections), but all sections must be ended in order of innermost to outermost. Transactions cannot be started or committed until all atomic sections are closed.
ATOMIC_CANCELABLE is useful when the caller needs to handle specific failure cases by discarding the section's writes. This should not be used for failures when:
Example usage:
Example usage (atomic changes that might have to be discarded):
string | $fname | |
string | $cancelable | Pass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section. |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\DBConnRef, and Wikimedia\Rdbms\Database.
Referenced by JobQueueDB\doBatchPushInternal(), LCStoreDB\finishWrite(), and MySqlLockManager\initConnection().
Wikimedia\Rdbms\IDatabase::tablePrefix | ( | $prefix = null | ) |
Get/set the table prefix.
string | null | $prefix | The table prefix to set, or omitted to leave it unchanged |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by CloneDatabase\__construct().
Wikimedia\Rdbms\IDatabase::trxLevel | ( | ) |
Gets the current transaction level.
Historically, transactions were allowed to be "nested". This is no longer supported, so this function really only returns a boolean.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::trxTimestamp | ( | ) |
Get the UNIX timestamp of the time that the transaction was established.
This can be used to reason about the staleness of SELECT data in REPEATABLE-READ transaction isolation level. Callers can assume that if a view-snapshot isolation is used, then the data read by SQL queries is at least up to date to that point (possibly more up-to-date since the first SELECT defines the snapshot).
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::unlock | ( | $lockName, | |
$method ) |
Release a lock.
Named locks are not related to transactions
string | $lockName | Name of lock to release |
string | $method | Name of the calling method |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by SqlBagOStuff\doUnlock().
Wikimedia\Rdbms\IDatabase::update | ( | $table, | |
$set, | |||
$conds, | |||
$fname = __METHOD__, | |||
$options = [] ) |
Update all rows in a table that match a given condition.
string | $table | Table name |
array | $set | Combination map/list where each string-keyed entry maps a column to a literal assigned value and each integer-keyed value is a SQL expression in the format of a column assignment within UPDATE...SET. The (column => value) entries are convenient due to automatic value quoting and conversion of null to NULL. The SQL assignment format is useful for updates like "column = column + X". All assignments have no defined execution order, so they should not depend on each other. Do not modify AUTOINCREMENT or UUID columns in assignments. |
array | string | $conds | Condition in the format of IDatabase::select() conditions. In order to prevent possible performance or replication issues or damaging a data accidentally, an empty condition for 'update' queries isn't allowed. IDatabase::ALL_ROWS should be passed explicitly in order to update all rows. |
string | $fname | Calling function name (use METHOD) for logs/profiling |
string | array | $options | Combination map/list where each string-keyed entry maps a non-boolean option to the option parameters and each integer-keyed value is the name of a boolean option. Supported options are:
|
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by SiteStatsUpdate\cacheUpdate(), LocalFileMoveBatch\doDBUpdates(), SiteStatsUpdate\doUpdate(), Title\invalidateCache(), PurgeJobUtils\invalidatePages(), MigrateComments\migrate(), MigrateActors\migrate(), MigrateComments\migrateToTemp(), DeleteLocalPasswords\processUsers(), PopulateArchiveRevId\reassignArRevIds(), and User\saveSettings().
Wikimedia\Rdbms\IDatabase::upsert | ( | $table, | |
array | $rows, | ||
$uniqueKeys, | |||
array | $set, | ||
$fname = __METHOD__ ) |
Upsert row(s) into a table, in the provided order, while updating conflicting rows.
Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.
string | $table | Table name |
array | array[] | $rows | Row(s) to insert, in the form of either:
|
string | string[] | string[][] | $uniqueKeys | Column name or non-empty list of column name lists that define all applicable unique keys on the table. There must only be one such key. Each unique key on the table is "applicable" unless either:
|
array | $set | Combination map/list where each string-keyed entry maps a column to a literal assigned value and each integer-keyed value is a SQL assignment expression of the form "<unquoted alphanumeric column> = <SQL expression>". The (column => value) entries are convenient due to automatic value quoting and conversion of null to NULL. The SQL assignment entries are useful for updates like "column = column + X". All of the assignments have no defined execution order, so callers should make sure that they not depend on each other. Do not modify AUTOINCREMENT or UUID columns in assignments, even if they are just "secondary" unique keys. For multi-row upserts, use buildExcludedValue() to reference the value of a column from the corresponding row in $rows that conflicts with the current row. |
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, { |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by SiteStatsUpdate\doUpdate(), ActorMigrationBase\getInsertValuesWithTempTable(), and QueryPage\recache().
Wikimedia\Rdbms\IDatabase::wasConnectionLoss | ( | ) |
Determines if the last query error was due to a dropped connection.
Note that during a connection loss, the prior transaction will have been lost
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::wasDeadlock | ( | ) |
Determines if the last failure was due to a deadlock.
Note that during a deadlock, the prior transaction will have been lost
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::wasErrorReissuable | ( | ) |
Determines if the last query error was due to something outside of the query itself.
Note that the transaction may have been lost, discarding prior writes and results
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::wasLockTimeout | ( | ) |
Determines if the last failure was due to a lock timeout.
Note that during a lock wait timeout, the prior transaction will have been lost
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::wasReadOnlyError | ( | ) |
Determines if the last failure was due to the database being read-only.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by LCStoreDB\finishWrite().
Wikimedia\Rdbms\IDatabase::writesOrCallbacksPending | ( | ) |
Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending.
This does not count recurring callbacks, e.g. from setTransactionListener().
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\TransactionManager\trxCheckBeforeClose().
Wikimedia\Rdbms\IDatabase::writesPending | ( | ) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
const Wikimedia\Rdbms\IDatabase::LOCK_TIMESTAMP = 1 |
Flag to return the lock acquisition timestamp (null if not acquired)
Definition at line 105 of file IDatabase.php.