MediaWiki: Wikimedia\Rdbms\Database Class Reference

Definition at line 780 of file Database.php.

References Wikimedia\Rdbms\Database\isOpen().

Referenced by Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\rollback().

◆ begin()

Wikimedia\Rdbms\Database::begin	(	$fname = `__METHOD__`,
		$mode = `self::TRANSACTION_EXPLICIT`
	)

final

Begin a transaction.

If a transaction is already in progress, that transaction will be committed before the new transaction is started.

Only call this from code with outer transcation 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.

Parameters

string	$fname	Calling function name
string	$mode	A situationally valid IDatabase::TRANSACTION_* constant [optional]

Exceptions

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2871 of file Database.php.

References $fname, Wikimedia\Rdbms\Database\assertOpen(), DBO_TRX, Wikimedia\Rdbms\Database\doBegin(), Wikimedia\Rdbms\Database\getApproximateLagStatus(), and Wikimedia\Rdbms\Database\getFlag().

Referenced by Wikimedia\Rdbms\SavepointPostgres\__construct(), Wikimedia\Rdbms\Database\deadlockLoop(), Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\startAtomic(), and Wikimedia\Rdbms\Database\upsert().

◆ bitAnd()

Wikimedia\Rdbms\Database::bitAnd	(	$fieldLeft,
		$fieldRight
	)

Parameters

string	$fieldLeft
string	$fieldRight

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle.

Definition at line 1743 of file Database.php.

◆ bitNot()

Wikimedia\Rdbms\Database::bitNot ( $field )

Parameters

string $field

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle.

Definition at line 1739 of file Database.php.

◆ bitOr()

Wikimedia\Rdbms\Database::bitOr	(	$fieldLeft,
		$fieldRight
	)

Parameters

string	$fieldLeft
string	$fieldRight

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle.

Definition at line 1747 of file Database.php.

◆ bufferResults()

Wikimedia\Rdbms\Database::bufferResults ( $buffer = null )

Turns buffering of SQL result sets on (true) or off (false).

Default is "on".

Unbuffered queries are very troublesome in MySQL:

If another query is executed while the first query is being read out, the first query is killed. This means you can't call normal Database functions while you are reading an unbuffered query result from a normal Database connection.
Unbuffered queries cause the MySQL server to use large amounts of memory and to hold broad locks which block other queries.

If you want to limit client-side memory, it's almost always better to split up queries into batches using a LIMIT clause than to switch off buffering.

Parameters

null | bool $buffer

Returns: null|bool The previous value of the flag

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 438 of file Database.php.

References $buffer, $res, Wikimedia\Rdbms\Database\clearFlag(), DBO_NOBUFFER, Wikimedia\Rdbms\Database\getFlag(), and Wikimedia\Rdbms\Database\setFlag().

Referenced by Wikimedia\Rdbms\DatabaseMysql\doQuery(), and Wikimedia\Rdbms\DatabaseMysqli\doQuery().

◆ buildConcat()

Wikimedia\Rdbms\Database::buildConcat ( $stringList )

Build a concatenation list to feed into a SQL query.

Parameters

array $stringList List of raw SQL expressions; caller is responsible for any quoting

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 1751 of file Database.php.

◆ buildGroupConcatField()

Wikimedia\Rdbms\Database::buildGroupConcatField	(	$delim,
		$table,
		$field,
		$conds = `''`,
		$join_conds = `[]`
	)

Build a GROUP_CONCAT or equivalent statement for a query.

This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.

Parameters

string	$delim	Glue to bind the results together
string \| array	$table	Table name
string	$field	Field name
string \| array	$conds	Conditions
string \| array	$join_conds	Join conditions

Returns: string SQL text

Since: 1.23

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 1755 of file Database.php.

References Wikimedia\Rdbms\Database\addQuotes(), and Wikimedia\Rdbms\Database\selectSQLText().

◆ buildLike()

Wikimedia\Rdbms\Database::buildLike ( )

LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString().

Alternatively, the function could be provided with an array of aforementioned parameters.

Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches for subpages of 'My page title'. Alternatively: $pattern = [ 'My_page_title/', $dbr->anyString() ]; $query .= $dbr->buildLike( $pattern );

Since: 1.16

Returns: string Fully built LIKE statement

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2118 of file Database.php.

References $params, $s, $value, Wikimedia\Rdbms\Database\addQuotes(), as, captcha-old\count, and Wikimedia\Rdbms\Database\escapeLikeInternal().

◆ buildStringCast()

Wikimedia\Rdbms\Database::buildStringCast ( $field )

Parameters

string $field Field or column to cast

Returns: string

Since: 1.28

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 1763 of file Database.php.

◆ canRecoverFromDisconnect()

Wikimedia\Rdbms\Database::canRecoverFromDisconnect	(	$sql,
		$priorWritesPending
	)

private

Determine whether or not it is safe to retry queries after a database connection is lost.

Parameters

string	$sql	SQL query
bool	$priorWritesPending	Whether there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish.

Returns: bool True if it is safe to retry the query, false otherwise

Definition at line 1091 of file Database.php.

References Wikimedia\Rdbms\Database\explicitTrxActive().

Referenced by Wikimedia\Rdbms\Database\query().

◆ clearFlag()

Wikimedia\Rdbms\Database::clearFlag	(	$flag,
		$remember = `self::REMEMBER_NOTHING`
	)

Clear a flag for this connection.

Parameters

int	$flag	DBO_* constants from Defines.php: DBO_DEBUG: output some debug info (same as debug()) DBO_NOBUFFER: don't buffer results (inverse of bufferResults()) DBO_TRX: automatically start transactions DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode and removes it in command line mode DBO_PERSISTENT: use persistant database connection
string	$remember	IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 630 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\bufferResults(), Wikimedia\Rdbms\DatabaseMysqlBase\getHeartbeatData(), Wikimedia\Rdbms\Database\ignoreErrors(), Wikimedia\Rdbms\Database\ping(), and Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().

◆ close()

Wikimedia\Rdbms\Database::close ( )

Closes a database connection.

if it is open : commits any open transactions

Exceptions

Returns: bool Operation success. true if already closed.

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 753 of file Database.php.

References Wikimedia\Rdbms\Database\closeConnection(), Wikimedia\Rdbms\Database\commit(), and Wikimedia\Rdbms\Database\trxLevel().

Referenced by DatabaseOracle\__destruct(), Wikimedia\Rdbms\DatabaseMssql\open(), Wikimedia\Rdbms\DatabasePostgres\open(), DatabaseOracle\open(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), Wikimedia\Rdbms\DatabaseSqlite\open(), DatabaseSqliteTest\testInsertIdType(), DatabaseSqliteTest\testNumFields(), and DatabaseSqliteTest\testUpgrades().

◆ closeConnection()

Wikimedia\Rdbms\Database::closeConnection ( )

abstractprotected

Closes underlying database connection.

Since: 1.20

Returns: bool Whether connection was closed successfully

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, DatabaseOracle, Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysql, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\Database\__destruct(), Wikimedia\Rdbms\Database\close(), and Wikimedia\Rdbms\Database\reconnect().

◆ commit()

Wikimedia\Rdbms\Database::commit	(	$fname = `__METHOD__`,
		$flush = `''`
	)

final

Commits a transaction previously started using begin().

If no transaction is in progress, a warning is issued.

Only call this from code with outer transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.

Parameters

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.

Exceptions

References Wikimedia\Rdbms\Database\assertOpen(), Wikimedia\Rdbms\Database\doCommit(), Wikimedia\Rdbms\Database\pendingWriteQueryDuration(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), Wikimedia\Rdbms\Database\runOnTransactionPreCommitCallbacks(), and Wikimedia\Rdbms\Database\runTransactionListenerCallbacks().

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2932 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\deadlockLoop(), Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\flushSnapshot(), Wikimedia\Rdbms\Database\getScopedLockAndFlush(), and Wikimedia\Rdbms\Database\upsert().

◆ conditional()

Wikimedia\Rdbms\Database::conditional	(	$cond,
		$trueVal,
		$falseVal
	)

Returns an SQL expression for a simple conditional.

This doesn't need to be overridden unless CASE isn't supported in your DBMS.

Parameters

string \| array	$cond	SQL expression which will result in a boolean value
string	$trueVal	SQL expression to return if true
string	$falseVal	SQL expression to return if false

Returns: string SQL fragment

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2569 of file Database.php.

References LIST_AND, and Wikimedia\Rdbms\Database\makeList().

◆ connectionErrorLogger()

Wikimedia\Rdbms\Database::connectionErrorLogger	(	$errno,
		$errstr
	)

Error handler for logging errors during database connection This method should not be used outside of Database classes.

Parameters

int	$errno
string	$errstr

Definition at line 732 of file Database.php.

◆ databasesAreIndependent()

Wikimedia\Rdbms\Database::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 fully separate, only allowing mechanisms like postgres_fdw to effectively "mount" foreign DBs. This is true even among DBs on the same server.

Returns: bool

Since: 1.29

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres.

Definition at line 1767 of file Database.php.

◆ dbSchema()

Wikimedia\Rdbms\Database::dbSchema ( $schema = null )

Get/set the db schema.

Parameters

string $schema The database schema to set, or omitted to leave it unchanged.

Returns: string The previous db schema.

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 492 of file Database.php.

References Wikimedia\Rdbms\Database\$mSchema.

◆ deadlockLoop()

Wikimedia\Rdbms\Database::deadlockLoop ( )

Perform a deadlock-prone transaction.

This function invokes a callback function to perform a set of write queries. If a deadlock occurs during the processing, the transaction will be rolled back and the callback function will be called again.

Avoid using this method outside of Job or Maintenance classes.

Usage: $dbw->deadlockLoop( callback, ... );

Extra arguments are passed through to the specified callback function. This method requires that no transactions are already active to avoid causing premature commits or exceptions.

Returns whatever the callback function returned on its successful, iteration, or false on error, for example if the retry limit was reached.

Returns: mixed

Exceptions

DBUnexpectedError
Exception

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 2611 of file Database.php.

References $args, $e, Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\DEADLOCK_TRIES, Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\Database\wasDeadlock().

◆ decodeBlob()

Wikimedia\Rdbms\Database::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.

Parameters

string | Blob $b

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and DatabaseOracle.

Definition at line 3243 of file Database.php.

◆ decodeExpiry()

Wikimedia\Rdbms\Database::decodeExpiry	(	$expiry,
		$format = `TS_MW`
	)

Decode an expiry time into a DBMS independent format.

Parameters

string	$expiry	DB timestamp field value for expiry
int	$format	TS_* constant, defaults to TS_MW

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3571 of file Database.php.

References Wikimedia\Rdbms\Database\getInfinity().

◆ delete()

Wikimedia\Rdbms\Database::delete	(	$table,
		$conds,
		$fname = `__METHOD__`
	)

DELETE query wrapper.

Parameters

string	$table	Table name
string \| array	$conds	Array of conditions. See $conds in IDatabase::select() for the format. Use $conds == "*" to delete all rows
string	$fname	Name of the calling function

Exceptions

Returns: bool|IResultWrapper

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle, and Wikimedia\Rdbms\DatabaseMssql.

Definition at line 2355 of file Database.php.

References $fname, LIST_AND, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().

Referenced by MediaWikiTestCase\resetDB().

◆ deleteJoin()

Wikimedia\Rdbms\Database::deleteJoin	(	$delTable,
		$joinTable,
		$delVar,
		$joinVar,
		$conds,
		$fname = `__METHOD__`
	)

DELETE where the condition is a join.

MySQL overrides this to use a multi-table DELETE syntax, in other databases we use sub-selects

For safety, an empty $conds will not delete everything. If you want to delete all rows where the join condition matches, set $conds='*'.

DO NOT put the join condition in $conds.

Parameters

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	$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

Exceptions

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseMssql.

Definition at line 2320 of file Database.php.

References $fname, LIST_AND, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().

Referenced by DatabaseSqliteTest\testDeleteJoin().

◆ doAtomicSection()

Wikimedia\Rdbms\Database::doAtomicSection	(		$fname,
		callable	$callback
	)

final

Run a callback to do an atomic set of updates for this database.

The $callback takes the following arguments:

This database object
The value of $fname

If any exception occurs in the callback, then rollback() will be called and the error will be re-thrown. It may also be that the rollback itself fails with an exception before then. In any case, such errors are expected to terminate the request, without any outside caller attempting to catch errors and commit anyway. Note that any rollback undoes all prior atomic section and uncommitted updates, which trashes the current request, requiring an error to be displayed.

This can be an alternative to explicit startAtomic()/endAtomic() calls.

See also: Database::startAtomic; Database::endAtomic

Parameters

string	$fname	Caller name (usually METHOD)
callable	$callback	Callback that issues DB updates

Returns: mixed $res Result of the callback (since 1.28)

Exceptions

DBError
RuntimeException
UnexpectedValueException

Since: 1.27

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2858 of file Database.php.

References $e, $fname, $res, Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\Database\startAtomic().

◆ doBegin()

Wikimedia\Rdbms\Database::doBegin ( $fname )

protected

Issues the BEGIN command to the database server.

See also: Database::begin()

Parameters

string $fname

Reimplemented in Wikimedia\Rdbms\DatabaseMssql, DatabaseOracle, and Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 2927 of file Database.php.

References Wikimedia\Rdbms\Database\query().

Referenced by Wikimedia\Rdbms\Database\begin().

◆ doCommit()

Wikimedia\Rdbms\Database::doCommit ( $fname )

protected

Issues the COMMIT command to the database server.

See also: Database::commit()

Parameters

string $fname

Reimplemented in Wikimedia\Rdbms\DatabaseMssql, and DatabaseOracle.

Definition at line 2991 of file Database.php.

References Wikimedia\Rdbms\Database\query().

Referenced by Wikimedia\Rdbms\Database\commit().

◆ doLockTables()

Wikimedia\Rdbms\Database::doLockTables	(	array	$read,
		array	$write,
			$method
	)

protected

Helper function for lockTables() that handles the actual table locking.

Parameters

array	$read	Array of tables to lock for read access
array	$write	Array of tables to lock for write access
string	$method	Name of caller

Returns: true

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 3521 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\lockTables().

◆ doneWrites()

Wikimedia\Rdbms\Database::doneWrites ( )

Returns true if the connection may have been used for write queries.

Should return true if unsure.

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 546 of file Database.php.

References Wikimedia\Rdbms\Database\$mLastWriteTime.

◆ doProfiledQuery()

Wikimedia\Rdbms\Database::doProfiledQuery	(	$sql,
		$commentedSql,
		$isWrite,
		$fname
	)

private

Helper method for query() that handles profiling and logging and sends the query to doQuery()

Parameters

string	$sql	Original SQL query
string	$commentedSql	SQL query with debugging/trace comment
bool	$isWrite	Whether the query is a (non-temporary) write operation
string	$fname	Name of the calling function

Returns: bool|ResultWrapper True for a successful write query, ResultWrapper object for a successful read query, or false on failure

Definition at line 998 of file Database.php.

References $fname, $ret, Wikimedia\Rdbms\IDatabase\affectedRows(), Wikimedia\Rdbms\Database\doQuery(), Wikimedia\Rdbms\Database\getLBInfo(), and Wikimedia\Rdbms\Database\updateTrxWriteQueryTime().

Referenced by Wikimedia\Rdbms\Database\query().

◆ doQuery()

Wikimedia\Rdbms\Database::doQuery ( $sql )

abstractprotected

The DBMS-dependent part of query()

Parameters

string $sql SQL query.

Returns: ResultWrapper|bool Result object to feed to fetchObject, fetchRow, ...; or false on failure

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, FakeDatabaseMysqlBase, Wikimedia\Rdbms\DatabaseMysqli, and Wikimedia\Rdbms\DatabaseMysql.

Referenced by Wikimedia\Rdbms\Database\doProfiledQuery(), Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait(), and Wikimedia\Rdbms\DatabaseMysqlBase\open().

◆ doRollback()

Wikimedia\Rdbms\Database::doRollback ( $fname )

protected

Issues the ROLLBACK command to the database server.

See also: Database::rollback()

Parameters

string $fname

Reimplemented in Wikimedia\Rdbms\DatabaseMssql, and DatabaseOracle.

Definition at line 3041 of file Database.php.

References Wikimedia\Rdbms\Database\query().

Referenced by Wikimedia\Rdbms\Database\rollback().

◆ doUnlockTables()

Wikimedia\Rdbms\Database::doUnlockTables ( $method )

protected

Helper function for unlockTables() that handles the actual table unlocking.

Parameters

string $method Name of caller

Returns: true

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 3541 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\unlockTables().

◆ dropTable()

Wikimedia\Rdbms\Database::dropTable	(	$tableName,
		$fName = `__METHOD__`
	)

Delete a table.

Parameters

string	$tableName
string	$fName

Returns: bool|ResultWrapper

Since: 1.18

Reimplemented in Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and DatabaseOracle.

Definition at line 3552 of file Database.php.

References Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\tableExists(), and Wikimedia\Rdbms\Database\tableName().

◆ duplicateTableStructure()

Wikimedia\Rdbms\Database::duplicateTableStructure	(	$oldName,
		$newName,
		$temporary = `false`,
		$fname = `__METHOD__`
	)

Creates a new table with structure copied from existing table.

Note that unlike most database abstraction functions, this function does not automatically append database prefix, because it works at a lower abstraction level. The table names passed to this function shall not be quoted (this function calls addIdentifierQuotes() when needed).

Parameters

string	$oldName	Name of table whose structure should be copied
string	$newName	Name of table to be created
bool	$temporary	Whether the new table should be temporary
string	$fname	Calling function name

Returns: bool True if operation was successful

Exceptions

RuntimeException

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and DatabaseOracle.

Definition at line 3067 of file Database.php.

◆ encodeBlob()

Wikimedia\Rdbms\Database::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().

Parameters

string $b

Returns: string|Blob

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and DatabaseOracle.

Definition at line 3239 of file Database.php.

◆ encodeExpiry()

Wikimedia\Rdbms\Database::encodeExpiry ( $expiry )

Encode an expiry time into the DBMS dependent format.

Parameters

string $expiry Timestamp for expiry, or the 'infinity' string

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3565 of file Database.php.

References Wikimedia\Rdbms\Database\getInfinity(), and Wikimedia\Rdbms\Database\timestamp().

◆ endAtomic()

Wikimedia\Rdbms\Database::endAtomic ( $fname = __METHOD__ )

final

Ends an atomic section of SQL statements.

Ends the next section of atomic SQL statements and commits the transaction if necessary.

Since: 1.23

See also: IDatabase::startAtomic

Parameters

string $fname

Exceptions

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2843 of file Database.php.

References $fname, and Wikimedia\Rdbms\Database\commit().

Referenced by Wikimedia\Rdbms\Database\doAtomicSection(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), and Wikimedia\Rdbms\Database\unlockTables().

◆ escapeLikeInternal()

Wikimedia\Rdbms\Database::escapeLikeInternal	(	$s,
		$escapeChar = '`'
	)

protected

Parameters

string	$s
string	$escapeChar

Returns: string

Reimplemented in Wikimedia\Rdbms\DatabaseMssql.

Definition at line 2112 of file Database.php.

References $s.

Referenced by Wikimedia\Rdbms\Database\buildLike(), and Wikimedia\Rdbms\DatabaseMysqlBase\tableExists().

◆ estimateRowCount()

Wikimedia\Rdbms\Database::estimateRowCount	(	$table,
		$vars = `' *'`,
		$conds = `''`,
		$fname = `__METHOD__`,
		$options = `[]`
	)

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().

Parameters

string	$table	Table name
string	$vars	Unused
array \| string	$conds	Filters on the table
string	$fname	Function name for profiling
array	$options	Options for select

Returns: int Row count

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DatabasePostgres.

Definition at line 1426 of file Database.php.

References $fname, $options, $res, $rows, Wikimedia\Rdbms\IDatabase\fetchRow(), and Wikimedia\Rdbms\Database\select().

◆ explicitTrxActive()

Wikimedia\Rdbms\Database::explicitTrxActive ( )

Returns: bool Whether an explicit transaction or atomic sections are still open

Since: 1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3063 of file Database.php.

References Wikimedia\Rdbms\Database\$mTrxAutomatic.

Referenced by Wikimedia\Rdbms\Database\canRecoverFromDisconnect(), Wikimedia\Rdbms\Database\flushSnapshot(), and Wikimedia\Rdbms\Database\query().

◆ factory()

static Wikimedia\Rdbms\Database::factory	(	$dbType,
		$p = `[]`
	)

staticfinal

Construct a Database subclass instance given a database type and parameters.

This also connects to the database immediately upon object construction

Parameters

string	$dbType	A possible DB type (sqlite, mysql, postgres)
array	$p	Parameter map with keys: host : The hostname of the DB server user : The name of the database user the client operates under password : The password for the database user dbname : The name of the database to use where queries do not specify one. The database must exist or an error might be thrown. Setting this to the empty string will avoid any such errors and make the handle have no implicit database scope. This is useful for queries like SHOW STATUS, CREATE DATABASE, or DROP DATABASE. Note that a "database" in Postgres is rougly equivalent to an entire MySQL server. This the domain in which user names and such are defined, e.g. users are database-specific in Postgres. schema : The database schema to use (if supported). A "schema" in Postgres is roughly equivalent to a "database" in MySQL. Note that MySQL and SQLite do not use schemas. tablePrefix : Optional table prefix that is implicitly added on to all table names recognized in queries. This can be used in place of schemas for handle site farms. flags : Optional bitfield of DBO_* constants that define connection, protocol, buffering, and transaction behavior. It is STRONGLY adviced to leave the DBO_DEFAULT flag in place UNLESS this this database simply acts as a key/value store. driver: Optional name of a specific DB client driver. For MySQL, there is the old 'mysql' driver and the newer 'mysqli' driver. variables: Optional map of session variables to set after connecting. This can be used to adjust lock timeouts or encoding modes and the like. connLogger: Optional PSR-3 logger interface instance. queryLogger: Optional PSR-3 logger interface instance. profiler: Optional class name or object with profileIn()/profileOut() methods. These will be called in query(), using a simplified version of the SQL that also includes the agent as a SQL comment. trxProfiler: Optional TransactionProfiler instance. errorLogger: Optional callback that takes an Exception and logs it. cliMode: Whether to consider the execution context that of a CLI script. agent: Optional name used to identify the end-user in query profiling/logging. srvCache: Optional BagOStuff instance to an APC-style cache.

Returns: Database|null If the database driver or extension cannot be found

Exceptions

InvalidArgumentException If the database driver or extension cannot be found

Since: 1.18

Definition at line 338 of file Database.php.

References $e, as, and class.

Referenced by Wikimedia\Rdbms\DatabaseSqlite\newStandaloneInstance(), and Wikimedia\Rdbms\LoadBalancer\reallyOpenConnection().

◆ fieldExists()

Wikimedia\Rdbms\Database::fieldExists	(	$table,
		$field,
		$fname = `__METHOD__`
	)

Determines whether a field exists in a table.

Parameters

string	$table	Table name
string	$field	Filed to check on that table
string	$fname	Calling function name (optional)

Returns: bool Whether $table has filed $field

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMssql.

Definition at line 1488 of file Database.php.

References Wikimedia\Rdbms\IDatabase\fieldInfo().

◆ fieldNamesWithAlias()

Wikimedia\Rdbms\Database::fieldNamesWithAlias ( $fields )

protected

Gets an array of aliased field names.

Parameters

array $fields [ [alias] => field ]

Returns: string[] See fieldNameWithAlias()

Definition at line 1963 of file Database.php.

References $retval, as, and Wikimedia\Rdbms\Database\fieldNameWithAlias().

Referenced by Wikimedia\Rdbms\Database\selectSQLText().

◆ fieldNameWithAlias()

Wikimedia\Rdbms\Database::fieldNameWithAlias	(	$name,
		$alias = `false`
	)

protected

Get an aliased field name e.g.

fieldName AS newFieldName

Parameters

string	$name	Field name
string \| bool	$alias	Alias (optional)

Returns: string SQL name for aliased field. Will not alias a field to its own name

Definition at line 1949 of file Database.php.

References $name, and Wikimedia\Rdbms\Database\addIdentifierQuotes().

Referenced by Wikimedia\Rdbms\Database\fieldNamesWithAlias(), and Wikimedia\Rdbms\Database\insertSelect().

◆ flushSnapshot()

Wikimedia\Rdbms\Database::flushSnapshot ( $fname = __METHOD__ )

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 master.

Parameters

string $fname Calling function name

Exceptions

Since: 1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3050 of file Database.php.

References Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\explicitTrxActive(), Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().

Referenced by Wikimedia\Rdbms\LoadBalancer\beginMasterChanges().

◆ freeResult()

Wikimedia\Rdbms\Database::freeResult ( $res )

Free a result object returned by query() or select().

It's usually not necessary to call this, just use unset() or let the variable holding the result object go out of scope.

Parameters

mixed $res A SQL result

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, DatabaseOracle, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseMssql.

Definition at line 1153 of file Database.php.

◆ generalizeSQL()

static Wikimedia\Rdbms\Database::generalizeSQL ( $sql )

staticprotected

Removes most variables from an SQL query and replaces them with X or N for numbers.

It's only slightly flawed. Don't use for anything important.

Parameters

string $sql A SQL Query

Returns: string

Definition at line 1466 of file Database.php.

◆ getApproximateLagStatus()

Wikimedia\Rdbms\Database::getApproximateLagStatus ( )

protected

Get a replica DB lag estimate for this server.

Returns: array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)

Since: 1.27

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 3189 of file Database.php.

References Wikimedia\Rdbms\Database\getLag(), and Wikimedia\Rdbms\Database\getLBInfo().

Referenced by Wikimedia\Rdbms\Database\begin(), and Wikimedia\Rdbms\Database\getSessionLagStatus().

◆ getBindingHandle()

Wikimedia\Rdbms\Database::getBindingHandle ( )

protected

Get the underlying binding handle, mConn.

Makes sure that mConn is set (disconnects and ping() failure can unset it). This catches broken callers than catch and ignore disconnection exceptions. Unlike checking isOpen(), this is safe to call inside of open().

Returns: resource|object

Exceptions

Referenced by Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\bufferResults(), DatabaseOracle\doQuery(), Wikimedia\Rdbms\Database\ignoreErrors(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), and Wikimedia\Rdbms\Database\startAtomic().

Since: 1.26

Definition at line 3619 of file Database.php.

References Wikimedia\Rdbms\Database\$mConn.

◆ getCacheSetOptions()

static Wikimedia\Rdbms\Database::getCacheSetOptions ( IDatabase $db1 )

static

Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination.

This is information is useful for caching modules

See also: WANObjectCache::set(); WANObjectCache::getWithSetCallback()

Parameters

IDatabase	$db1
IDatabase	$dbs,...

Returns

array Map of values:

lag: highest lag of any of the DBs or false on error (e.g. replication stopped)
since: oldest UNIX timestamp of any of the DB lag estimates
pending: whether any of the DBs have uncommitted changes

Since: 1.27

Definition at line 3214 of file Database.php.

References $res, as, and false.

Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\load().

◆ getDBname()

Wikimedia\Rdbms\Database::getDBname ( )

Get the current DB name.

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle, and Wikimedia\Rdbms\DatabasePostgres.

Definition at line 1780 of file Database.php.

References Wikimedia\Rdbms\Database\$mDBname.

◆ getDefaultSchemaVars()

Wikimedia\Rdbms\Database::getDefaultSchemaVars ( )

protected

Get schema variables to use if none have been set via setSchemaVars().

Override this in derived classes to provide variables for tables.sql and SQL patch files.

Returns: array

Definition at line 3438 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\getSchemaVars().

◆ getDomainID()

Wikimedia\Rdbms\Database::getDomainID ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 663 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\getWikiID().

◆ getFlag()

Wikimedia\Rdbms\Database::getFlag ( $flag )

Returns a boolean whether the flag $flag is set for this connection.

Parameters

int

$flag

DBO_* constants from Defines.php:

DBO_DEBUG: output some debug info (same as debug())
DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
DBO_TRX: automatically start transactions
DBO_PERSISTENT: use persistant database connection

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 650 of file Database.php.

◆ getInfinity()

Wikimedia\Rdbms\Database::getInfinity ( )

Find out when 'infinity' is.

Most DBMSes support this. This is a special keyword for timestamps in PostgreSQL, and works with CHAR(14) as well because "i" sorts after all numbers.

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle.

Definition at line 3561 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\decodeExpiry(), and Wikimedia\Rdbms\Database\encodeExpiry().

◆ getLag()

Wikimedia\Rdbms\Database::getLag ( )

Get replica DB lag.

Currently supported only by MySQL.

Note that this function will generate a fatal error on many installations. Most callers should use LoadBalancer::safeGetLag() instead.

Returns: int|bool Database replication lag in seconds or false on error

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 3231 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\getApproximateLagStatus().

◆ getLastPHPError()

Wikimedia\Rdbms\Database::getLastPHPError ( )

protected

Returns: string|bool Last PHP error for this DB (typically connection errors)

Definition at line 714 of file Database.php.

Referenced by Wikimedia\Rdbms\DatabasePostgres\lastError(), and Wikimedia\Rdbms\Database\restoreErrorHandler().

◆ getLazyMasterHandle()

Wikimedia\Rdbms\Database::getLazyMasterHandle ( )

protected

Returns: IDatabase|null

See also: setLazyMasterHandle()

Since: 1.27

Definition at line 530 of file Database.php.

References Wikimedia\Rdbms\Database\$lazyMasterHandle.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo().

◆ getLBInfo()

Wikimedia\Rdbms\Database::getLBInfo ( $name = null )

Get properties passed down from the server info array of the load balancer.

Parameters

string $name The entry of the info array to get, or null to get the whole array

Returns: array|mixed|null

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 501 of file Database.php.

References Wikimedia\Rdbms\Database\$mLBInfo, and $name.

Referenced by Wikimedia\Rdbms\Database\doProfiledQuery(), Wikimedia\Rdbms\Database\getApproximateLagStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo(), Wikimedia\Rdbms\Database\getReadOnlyReason(), and Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait().

◆ getLogContext()

Wikimedia\Rdbms\Database::getLogContext ( array $extras = [] )

protected

Create a log context to pass to PSR-3 logger functions.

Parameters

array $extras Additional data to add to context

Returns: array

Definition at line 742 of file Database.php.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromPtHeartbeat(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\Database\reportQueryError().

◆ getMasterPos()

Wikimedia\Rdbms\Database::getMasterPos ( )

Get the position of this master.

Returns: DBMasterPos|bool False if this is not a master

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 2657 of file Database.php.

◆ getProperty()

Wikimedia\Rdbms\Database::getProperty ( $name )

Parameters

string $name Class field name

Returns: mixed

Deprecated:: Since 1.28

Definition at line 659 of file Database.php.

◆ getQueryVerb()

Wikimedia\Rdbms\Database::getQueryVerb ( $sql )

protected

Parameters

string $sql

Returns: string|null

Definition at line 828 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\isTransactableQuery(), and Wikimedia\Rdbms\Database\updateTrxWriteQueryTime().

◆ getReadOnlyReason()

Wikimedia\Rdbms\Database::getReadOnlyReason ( )

protected

Returns: string|bool Reason this DB is read-only or false if it is not

Definition at line 3590 of file Database.php.

References Wikimedia\Rdbms\Database\getLBInfo().

Referenced by Wikimedia\Rdbms\Database\isReadOnly(), and Wikimedia\Rdbms\Database\query().

◆ getReplicaPos()

Wikimedia\Rdbms\Database::getReplicaPos ( )

Get the replication position of this replica DB.

Returns: DBMasterPos|bool False if this is not a replica DB.

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 2652 of file Database.php.

◆ getSchemaVars()

Wikimedia\Rdbms\Database::getSchemaVars ( )

protected

Get schema variables.

If none have been set via setSchemaVars(), then use some defaults from the current object.

Returns: array

Definition at line 3422 of file Database.php.

References Wikimedia\Rdbms\Database\$mSchemaVars, and Wikimedia\Rdbms\Database\getDefaultSchemaVars().

Referenced by Wikimedia\Rdbms\Database\replaceVars().

◆ getScopedLockAndFlush()

Wikimedia\Rdbms\Database::getScopedLockAndFlush	(	$lockKey,
		$fname,
		$timeout
	)

Acquire a named lock, flush any transaction, and return an RAII style unlocker object.

Only call this from outer transcation scope and when only one DB will be affected. See https://www.mediawiki.org/wiki/Database_transactions for details.

This is suitiable 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.

Parameters

string	$lockKey	Name of lock to release
string	$fname	Name of the calling method
int	$timeout	Acquisition timeout in seconds

Returns: ScopedCallback|null

Exceptions

References $fname, Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\lock(), Wikimedia\Rdbms\Database\onTransactionResolution(), Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers(), Wikimedia\Rdbms\Database\trxLevel(), Wikimedia\Rdbms\Database\unlock(), use, and Wikimedia\Rdbms\Database\writesOrCallbacksPending().

Since: 1.27

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3458 of file Database.php.

◆ getServer()

Wikimedia\Rdbms\Database::getServer ( )

Get the server hostname or IP address.

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle, and Wikimedia\Rdbms\DatabasePostgres.

Definition at line 1784 of file Database.php.

References Wikimedia\Rdbms\Database\$mServer.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getApproximateLagStatus(), and Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo().

◆ getServerInfo()

Wikimedia\Rdbms\Database::getServerInfo ( )

A string describing the current software version, and possibly other details in a user-friendly way.

Will be listed on Special:Version, etc. Use getServerVersion() to get machine-friendly information.

Returns: string Version information from the database server

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 434 of file Database.php.

References Wikimedia\Rdbms\IDatabase\getServerVersion().

◆ getServerUptime()

Wikimedia\Rdbms\Database::getServerUptime ( )

Determines how long the server has been up.

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 2581 of file Database.php.

◆ getSessionLagStatus()

Wikimedia\Rdbms\Database::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 AUTO-COMMIT mode, this still gives an indication of the staleness of subsequent reads.

Returns: array ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)

Since: 1.27

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3162 of file Database.php.

References Wikimedia\Rdbms\Database\getApproximateLagStatus(), and Wikimedia\Rdbms\Database\getTransactionLagStatus().

◆ getTransactionLagStatus()

Wikimedia\Rdbms\Database::getTransactionLagStatus ( )

protected

Get the replica DB lag when the current transaction started.

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. This returns null if there is no transaction.

Returns: array|null ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)

Since: 1.27

Definition at line 3177 of file Database.php.

References Wikimedia\Rdbms\Database\$mTrxReplicaLag, and Wikimedia\Rdbms\Database\trxTimestamp().

Referenced by Wikimedia\Rdbms\Database\getSessionLagStatus().

◆ getWikiID()

Wikimedia\Rdbms\Database::getWikiID ( )

final

Alias for getDomainID()

Returns: string

Deprecated:: 1.30

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 667 of file Database.php.

References Wikimedia\Rdbms\Database\getDomainID().

◆ handleSessionLoss()

Wikimedia\Rdbms\Database::handleSessionLoss ( )

private

Clean things up after transaction loss due to disconnection.

Returns: null|Exception

Definition at line 1116 of file Database.php.

References $e, Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), and Wikimedia\Rdbms\Database\runTransactionListenerCallbacks().

Referenced by Wikimedia\Rdbms\Database\__clone(), and Wikimedia\Rdbms\Database\query().

◆ ignoreErrors()

Wikimedia\Rdbms\Database::ignoreErrors ( $ignoreErrors = null )

protected

Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors.

Default is on (false). When turned off, the code should use lastErrno() and lastError() to handle the situation as appropriate.

Do not use this function outside of the Database classes.

Parameters

null | bool $ignoreErrors

Returns: bool The previous value of the flag.

Definition at line 461 of file Database.php.

References $res, Wikimedia\Rdbms\Database\clearFlag(), DBO_IGNORE, Wikimedia\Rdbms\Database\getFlag(), and Wikimedia\Rdbms\Database\setFlag().

Referenced by Wikimedia\Rdbms\Database\reportQueryError().

◆ ignoreIndexClause()

Wikimedia\Rdbms\Database::ignoreIndexClause ( $index )

IGNORE INDEX clause.

Unlikely to be useful for anything but MySQL. This is only needed because a) MySQL must be as efficient as possible due to its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about which index to pick. Anyway, other databases might have different indexes on a given table. So don't bother overriding this unless you're MySQL.

Parameters

string $index

Returns: string

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 2180 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\makeSelectOptions(), and Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN().

◆ implicitGroupby()

Wikimedia\Rdbms\Database::implicitGroupby ( )

Returns true if this database does an implicit sort when doing GROUP BY.

Returns: bool

Deprecated:: Since 1.30; only use grouped or aggregated fields in the SELECT

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, DatabaseOracle, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMssql.

Definition at line 534 of file Database.php.

◆ implicitOrderby()

Wikimedia\Rdbms\Database::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.

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMssql.

Definition at line 538 of file Database.php.

◆ indexExists()

Wikimedia\Rdbms\Database::indexExists	(	$table,
		$index,
		$fname = `__METHOD__`
	)

Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure.

Parameters

string	$table
string	$index
string	$fname

Returns: bool|null

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle.

Definition at line 1494 of file Database.php.

References $fname, Wikimedia\Rdbms\Database\indexInfo(), and Wikimedia\Rdbms\Database\tableExists().

◆ indexInfo()

Wikimedia\Rdbms\Database::indexInfo	(	$table,
		$index,
		$fname = `__METHOD__`
	)

abstract

Get information about an index into an object.

Parameters

string	$table	Table name
string	$index	Index name
string	$fname	Calling function name

Returns: mixed Database-specific index description class or false if the index does not exist

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and DatabaseOracle.

Referenced by Wikimedia\Rdbms\Database\indexExists(), and Wikimedia\Rdbms\Database\indexUnique().

◆ indexName()

Wikimedia\Rdbms\Database::indexName ( $index )

protected

Allows for index remapping in queries where this is not consistent across DBMS.

Parameters

string $index

Returns: string

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 2060 of file Database.php.

Referenced by Wikimedia\Rdbms\DatabaseSqlite\indexInfo(), Wikimedia\Rdbms\DatabasePostgres\indexUnique(), Wikimedia\Rdbms\DatabaseSqlite\indexUnique(), and Wikimedia\Rdbms\Database\replaceVars().

◆ indexUnique()

Wikimedia\Rdbms\Database::indexUnique	(	$table,
		$index
	)

Determines if a given index is unique.

Parameters

string	$table
string	$index

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1520 of file Database.php.

References Wikimedia\Rdbms\Database\indexInfo().

◆ insert()

Wikimedia\Rdbms\Database::insert	(	$table,
		$a,
		$fname = `__METHOD__`,
		$options = `[]`
	)

INSERT wrapper, inserts an array into a table.

$a may be either:

A single associative array. The array keys are the field names, and the values are the values to insert. The values are treated as data and will be quoted appropriately. If NULL is inserted, this will be converted to a database NULL.
An array with numeric keys, holding a list of associative arrays. This causes a multi-row INSERT on DBMSs that support it. The keys in each subarray must be identical to each other, and in the same order.

Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns success.

$options is an array of options, with boolean options encoded as values with numeric keys, in the same style as $options in IDatabase::select(). Supported options are:

IGNORE: Boolean: if present, duplicate key errors are ignored, and any rows which cause duplicate key errors are not inserted. It's possible to determine how many rows were successfully inserted using IDatabase::affectedRows().

Parameters

string	$table	Table name. This will be passed through Database::tableName().
array	$a	Array of rows to insert
string	$fname	Calling function name (use METHOD) for logs/profiling
array	$options	Array of options

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and DatabaseOracle.

Definition at line 1540 of file Database.php.

References $fname, $keys, $options, as, captcha-old\count, Wikimedia\Rdbms\Database\makeInsertOptions(), Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().

Referenced by Wikimedia\Rdbms\Database\insertSelect(), Wikimedia\Rdbms\Database\replace(), and Wikimedia\Rdbms\Database\upsert().

◆ insertSelect()

Wikimedia\Rdbms\Database::insertSelect	(	$destTable,
		$srcTable,
		$varMap,
		$conds,
		$fname = `__METHOD__`,
		$insertOptions = `[]`,
		$selectOptions = `[]`,
		$selectJoinConds = `[]`
	)

INSERT SELECT wrapper.

Takes data from a SELECT query and inserts it into another table.

Parameters

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.
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.

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2373 of file Database.php.

References $fname, $res, $rows, array(), as, Wikimedia\Rdbms\Database\fieldNameWithAlias(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\nativeInsertSelect(), and Wikimedia\Rdbms\Database\select().

◆ installErrorHandler()

Wikimedia\Rdbms\Database::installErrorHandler ( )

protected

Set a custom error handler for logging errors during database connection.

Definition at line 691 of file Database.php.

Referenced by Wikimedia\Rdbms\DatabasePostgres\open(), and Wikimedia\Rdbms\DatabaseMysqlBase\open().

◆ isOpen()

Wikimedia\Rdbms\Database::isOpen ( )

Is a connection to the database open?

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 619 of file Database.php.

References Wikimedia\Rdbms\Database\$mOpened.

Referenced by Wikimedia\Rdbms\Database\__clone(), Wikimedia\Rdbms\DatabaseSqlite\__construct(), Wikimedia\Rdbms\Database\assertOpen(), and Wikimedia\Rdbms\Database\ping().

◆ isQuotedIdentifier()

Wikimedia\Rdbms\Database::isQuotedIdentifier ( $name )

Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers .

Note: Do not use this to determine if untrusted input is safe. A malicious user can trick this function.

Parameters

string $name

Returns: bool

Reimplemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 2103 of file Database.php.

References $name.

Referenced by Wikimedia\Rdbms\Database\prependDatabaseOrSchema(), and Wikimedia\Rdbms\Database\tableName().

◆ isReadOnly()

Wikimedia\Rdbms\Database::isReadOnly ( )

Returns: bool Whether this DB is read-only

Since: 1.27

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3583 of file Database.php.

References Wikimedia\Rdbms\Database\getReadOnlyReason().

◆ isTransactableQuery()

Wikimedia\Rdbms\Database::isTransactableQuery ( $sql )

protected

Determine whether a SQL statement is sensitive to isolation level.

A SQL statement is considered transactable if its result could vary depending on the transaction isolation level. Operational commands such as 'SET' and 'SHOW' are not considered to be transactable.

Parameters

string $sql

Returns: bool

Definition at line 841 of file Database.php.

References Wikimedia\Rdbms\Database\getQueryVerb().

Referenced by Wikimedia\Rdbms\Database\query().

◆ isWriteQuery()

Wikimedia\Rdbms\Database::isWriteQuery ( $sql )

protected

Determine whether a query writes to the DB.

Should return true if unsure.

Parameters

string $sql

Returns: bool

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 819 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\query().

◆ lastDoneWrites()

Wikimedia\Rdbms\Database::lastDoneWrites ( )

Returns the last time the connection may have been used for write queries.

Should return a timestamp if unsure.

Returns: int|float UNIX timestamp or false

Since: 1.24

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 550 of file Database.php.

◆ lastQuery()

Wikimedia\Rdbms\Database::lastQuery ( )

Return the last query that went through IDatabase::query()

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 542 of file Database.php.

References Wikimedia\Rdbms\Database\$mLastQuery.

Referenced by DatabaseSqliteMock\query().

◆ limitResult()

Wikimedia\Rdbms\Database::limitResult	(	$sql,
		$limit,
		$offset = `false`
	)

Construct a LIMIT query with optional offset.

This is used for query pages. The SQL should be adjusted so that only the first $limit rows are returned. If $offset is provided as well, then the first $offset rows should be discarded, and the next $limit rows should be returned. If the result of the query is not ordered, then the rows to be returned are theoretically arbitrary.

$sql is expected to be a SELECT, if that makes a difference.

The version provided by default works in MySQL and SQLite. It will very likely need to be overridden for most other DBMSes.

Parameters

string	$sql	SQL query we will append the limit too
int	$limit	The SQL limit
int \| bool	$offset	The SQL offset (default false)

Exceptions

Returns: string

Reimplemented in Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, and DatabaseOracle.

Definition at line 2477 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\selectSQLText(), and Wikimedia\Rdbms\Database\unionConditionPermutations().

◆ listTables()

Wikimedia\Rdbms\Database::listTables	(	$prefix = `null`,
		$fname = `__METHOD__`
	)

List all tables on the database.

Parameters

string	$prefix	Only show tables with this prefix, e.g. mw_
string	$fname	Calling function name

Exceptions

Returns: array

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and DatabaseOracle.

Definition at line 3073 of file Database.php.

Referenced by MediaWikiTestCase\listTables().

◆ listViews()

Wikimedia\Rdbms\Database::listViews	(	$prefix = `null`,
		$fname = `__METHOD__`
	)

Lists all the VIEWs in the database.

Parameters

string	$prefix	Only show VIEWs with this prefix, eg. unit_test_
string	$fname	Name of calling function

Exceptions

RuntimeException

Returns: array

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 3077 of file Database.php.

Referenced by MediaWikiTestCase\listTables().

◆ lock()

Wikimedia\Rdbms\Database::lock	(	$lockName,
		$method,
		$timeout = `5`
	)

Acquire a named lock.

Named locks are not related to transactions

Parameters

string	$lockName	Name of lock to aquire
string	$method	Name of the calling method
int	$timeout	Acquisition timeout in seconds

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 3446 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\getScopedLockAndFlush().

◆ lockIsFree()

Wikimedia\Rdbms\Database::lockIsFree	(	$lockName,
		$method
	)

Check to see if a named lock is available (non-blocking)

Parameters

string	$lockName	Name of lock to poll
string	$method	Name of method calling us

Returns: bool

Since: 1.20

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 3442 of file Database.php.

◆ lockTables()

Wikimedia\Rdbms\Database::lockTables	(	array	$read,
		array	$write,
			$method
	)

final

Lock specific tables.

Any pending transaction should be resolved before calling this method, since: a) Doing so resets any REPEATABLE-READ snapshot of the data to a fresh one. b) Previous row and table locks from the transaction or session may be released by LOCK TABLES, which may be unsafe for the changes in such a transaction. c) The main use case of lockTables() is to avoid deadlocks and timeouts by locking entire tables in order to do long-running, batched, and lag-aware, updates. Batching and replication lag checks do not work when all the updates happen in a transaction.

Always get all relevant table locks up-front in one call, since LOCK TABLES might release any prior table locks on some RDBMes (e.g MySQL).

For compatibility, callers should check tableLocksHaveTransactionScope() before using this method. If locks are scoped specifically to transactions then caller must either:

a) Start a new transaction and acquire table locks for the scope of that transaction, doing all row updates within that transaction. It will not be possible to update rows in batches; this might result in high replication lag.
b) Forgo table locks entirely and avoid calling this method. Careful use of hints like LOCK IN SHARE MODE and FOR UPDATE and the use of query batching may be preferrable to using table locks with a potentially large transaction. Use of MySQL and Postges style REPEATABLE-READ (Snapshot Isolation with or without First-Committer-Rule) can also be considered for certain tasks that require a consistent view of entire tables.

If session scoped locks are not supported, then calling lockTables() will trigger startAtomic(), with unlockTables() triggering endAtomic(). This will automatically start a transaction if one is not already present and cause the locks to be released when the transaction finishes (normally during the unlockTables() call).

In any case, avoid using begin()/commit() in code that runs while such table locks are acquired, as that breaks in case when a transaction is needed. The startAtomic() and endAtomic() methods are safe, however, since they will join any existing transaction.

Parameters

array	$read	Array of tables to lock for read access
array	$write	Array of tables to lock for write access
string	$method	Name of caller

Returns: bool

Since: 1.29

Definition at line 3501 of file Database.php.

References Wikimedia\Rdbms\Database\doLockTables(), Wikimedia\Rdbms\Database\startAtomic(), Wikimedia\Rdbms\Database\tableLocksHaveTransactionScope(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().

◆ makeGroupByWithHaving()

Wikimedia\Rdbms\Database::makeGroupByWithHaving ( $options )

protected

Returns an optional GROUP BY with an optional HAVING.

Parameters

array $options Associative array of options

Returns: string

See also: Database::select()

Since: 1.21

Definition at line 1301 of file Database.php.

References $options, LIST_AND, and Wikimedia\Rdbms\Database\makeList().

Referenced by Wikimedia\Rdbms\DatabaseMssql\makeSelectOptions(), Wikimedia\Rdbms\Database\makeSelectOptions(), and Wikimedia\Rdbms\DatabasePostgres\makeSelectOptions().

◆ makeInsertOptions()

Wikimedia\Rdbms\Database::makeInsertOptions ( $options )

protected

Helper for Database::insert().

Parameters

array $options

Returns: string

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 1536 of file Database.php.

References $options.

Referenced by Wikimedia\Rdbms\Database\insert(), and Wikimedia\Rdbms\Database\nativeInsertSelect().

◆ makeList()

Wikimedia\Rdbms\Database::makeList	(	$a,
		$mode = `self::LIST_COMMA`
	)

Makes an encoded list of strings from an array.

These can be used to make conjunctions or disjunctions on SQL condition strings derived from an array (see IDatabase::select() $conds documentation).

Example usage:

$sql = $db->makeList( [
    'rev_user' => $id,
    $db->makeList( [ 'rev_minor' => 1, 'rev_len' < 500 ], $db::LIST_OR ] )
], $db::LIST_AND );

This would set $sql to "rev_user = '$id' AND (rev_minor = '1' OR rev_len < '500')"

Parameters

array	$a	Containing the data
int	$mode	IDatabase class constant: IDatabase::LIST_COMMA: Comma separated, no field names IDatabase::LIST_AND: ANDed WHERE clause (without the WHERE). IDatabase::LIST_OR: ORed WHERE clause (without the WHERE) IDatabase::LIST_SET: Comma separated with field names, like a SET clause IDatabase::LIST_NAMES: Comma separated field names

Exceptions

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1636 of file Database.php.

References $value, Wikimedia\Rdbms\Database\addQuotes(), as, captcha-old\count, LIST_AND, LIST_NAMES, LIST_OR, and LIST_SET.

◆ makeOrderBy()

Wikimedia\Rdbms\Database::makeOrderBy ( $options )

protected

Returns an optional ORDER BY.

Parameters

array $options Associative array of options

Returns: string

See also: Database::select()

Since: 1.21

Definition at line 1327 of file Database.php.

References $options.

Referenced by Wikimedia\Rdbms\DatabaseMssql\makeSelectOptions(), Wikimedia\Rdbms\Database\makeSelectOptions(), Wikimedia\Rdbms\DatabasePostgres\makeSelectOptions(), and Wikimedia\Rdbms\Database\unionConditionPermutations().

◆ makeSelectOptions()

Wikimedia\Rdbms\Database::makeSelectOptions ( $options )

protected

Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.

Parameters

array $options Associative array of options to be turned into an SQL query, valid keys are listed in the function.

Returns: array

See also: Database::select()

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 1218 of file Database.php.

References $options, as, Wikimedia\Rdbms\Database\ignoreIndexClause(), Wikimedia\Rdbms\Database\makeGroupByWithHaving(), Wikimedia\Rdbms\Database\makeOrderBy(), and Wikimedia\Rdbms\Database\useIndexClause().

Referenced by Wikimedia\Rdbms\Database\selectSQLText().

◆ makeUpdateOptions()

Wikimedia\Rdbms\Database::makeUpdateOptions ( $options )

protected

Make UPDATE options for the Database::update function.

Parameters

array $options The options passed to Database::update

Returns: string

Definition at line 1618 of file Database.php.

References $options, and Wikimedia\Rdbms\Database\makeUpdateOptionsArray().

Referenced by Wikimedia\Rdbms\DatabaseMssql\update(), and Wikimedia\Rdbms\Database\update().

◆ makeUpdateOptionsArray()

Wikimedia\Rdbms\Database::makeUpdateOptionsArray ( $options )

protected

Make UPDATE options array for Database::makeUpdateOptions.

Parameters

array $options

Returns: array

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 1598 of file Database.php.

References $options.

Referenced by Wikimedia\Rdbms\Database\makeUpdateOptions().

◆ makeWhereFrom2d()

Wikimedia\Rdbms\Database::makeWhereFrom2d	(	$data,
		$baseKey,
		$subKey
	)

Build a partial where clause from a 2-d array such as used for LinkBatch.

The keys on each level may be either integers or strings.

Parameters

array	$data	Organized as 2-d [ baseKeyVal => [ subKeyVal => [ignored], ... ], ... ]
string	$baseKey	Field name to match the base-level keys to (eg 'pl_namespace')
string	$subKey	Field name to match the sub-level keys to (eg 'pl_title')

Returns: string|bool SQL fragment, or false if no items in array

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1716 of file Database.php.

References $base, as, captcha-old\count, LIST_AND, LIST_OR, and Wikimedia\Rdbms\Database\makeList().

◆ masterPosWait()

Wikimedia\Rdbms\Database::masterPosWait	(	DBMasterPos	$pos,
			$timeout
	)

Wait for the replica DB to catch up to a given master position.

Parameters

DBMasterPos	$pos
int	$timeout	The maximum number of seconds to wait for synchronisation

Returns: int|null Zero if the replica DB was past that position already, greater than zero if we waited for some period of time, less than zero if it timed out, and null on error

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 2647 of file Database.php.

◆ maxListLen()

Wikimedia\Rdbms\Database::maxListLen ( )

Return the maximum number of items allowed in a list, or 0 for unlimited.

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3235 of file Database.php.

◆ namedLocksEnqueue()

Wikimedia\Rdbms\Database::namedLocksEnqueue ( )

Check to see if a named lock used by lock() use blocking queues.

Returns: bool

Since: 1.26

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 3493 of file Database.php.

◆ nativeInsertSelect()

Wikimedia\Rdbms\Database::nativeInsertSelect	(	$destTable,
		$srcTable,
		$varMap,
		$conds,
		$fname = `__METHOD__`,
		$insertOptions = `[]`,
		$selectOptions = `[]`,
		$selectJoinConds = `[]`
	)

protected

Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory.

See also: IDatabase::insertSelect()

Parameters

string	$destTable
string \| array	$srcTable
array	$varMap
array	$conds
string	$fname
array	$insertOptions
array	$selectOptions
array	$selectJoinConds

Returns: bool

Reimplemented in Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, and DatabaseOracle.

Definition at line 2430 of file Database.php.

References $fname, Wikimedia\Rdbms\Database\makeInsertOptions(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\selectSQLText(), and Wikimedia\Rdbms\Database\tableName().

Referenced by Wikimedia\Rdbms\Database\insertSelect().

◆ nativeReplace()

Wikimedia\Rdbms\Database::nativeReplace	(	$table,
		$rows,
		$fname
	)

protected

REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement.

Parameters

string	$table	Table name
array \| string	$rows	Row(s) to insert
string	$fname	Caller function name

Returns: ResultWrapper

Definition at line 2242 of file Database.php.

References $fname, $rows, as, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\replace(), and Wikimedia\Rdbms\DatabaseSqlite\replace().

◆ nextSequenceValue()

Wikimedia\Rdbms\Database::nextSequenceValue ( $seqName )

Deprecated method, calls should be removed.

This was formerly used for PostgreSQL and Oracle to handle self::insertId() auto-incrementing fields. It is no longer necessary since DatabasePostgres::insertId() has been reimplemented using lastval() and Oracle has been reimplemented using triggers.

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.

Deprecated:: since 1.30, no longer needed

Parameters

string $seqName

Returns: null|NextSequenceValue

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres.

Definition at line 2152 of file Database.php.

◆ onTransactionIdle()

Wikimedia\Rdbms\Database::onTransactionIdle	(	callable	$callback,
			$fname = `__METHOD__`
	)

final

Run a callback as soon as there is no transaction pending.

If there is a transaction and it is rolled back, then the callback is cancelled. Queries in the function will run in AUTO-COMMIT mode unless there are begin() calls. Callbacks must commit any transactions that they begin.

This is useful for updates to different systems or when separate transactions are needed. For example, one might want to enqueue jobs into a system outside the database, but only after the database is updated so that the jobs will see the data when they actually run. It can also be used for updates that easily cause deadlocks if locks are held too long.

Updates will execute in the order they were enqueued.

The callback takes one argument:

How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_IDLE)

Parameters

callable	$callback
string	$fname	Caller name

Since: 1.20

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2673 of file Database.php.

References $fname, and Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().

◆ onTransactionPreCommitOrIdle()

Wikimedia\Rdbms\Database::onTransactionPreCommitOrIdle	(	callable	$callback,
			$fname = `__METHOD__`
	)

final

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. Callbacks must not start nor commit any transactions. If no transaction is active, then a transaction will wrap the callback.

This is useful for updates that easily cause deadlocks if locks are held too long but where atomicity is strongly desired for these updates and some related updates.

Updates will execute in the order they were enqueued.

Parameters

callable	$callback
string	$fname	Caller name

Since: 1.22

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2680 of file Database.php.

References $e, $fname, DBO_TRX, Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\Database\startAtomic().

◆ onTransactionResolution()

Wikimedia\Rdbms\Database::onTransactionResolution	(	callable	$callback,
			$fname = `__METHOD__`
	)

final

Run a callback as soon as the current transaction commits or rolls back.

An error is thrown if no transaction is pending. Queries in the function will run in AUTO-COMMIT mode unless there are begin() calls. Callbacks must commit any transactions that they begin.

This is useful for combining cooperative locks and DB transactions.

The callback takes one argument:

How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK)

Parameters

callable	$callback
string	$fname	Caller name

Returns: mixed

Since: 1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2666 of file Database.php.

References $fname.

Referenced by Wikimedia\Rdbms\Database\getScopedLockAndFlush().

◆ pendingWriteAndCallbackCallers()

Wikimedia\Rdbms\Database::pendingWriteAndCallbackCallers ( )

protected

Get the list of method names that have pending write queries or callbacks for this transaction.

Returns: array

Definition at line 600 of file Database.php.

References Wikimedia\Rdbms\Database\$mTrxWriteCallers, and as.

Referenced by Wikimedia\Rdbms\Database\__destruct(), Wikimedia\Rdbms\Database\flushSnapshot(), and Wikimedia\Rdbms\Database\getScopedLockAndFlush().

◆ pendingWriteCallers()

Wikimedia\Rdbms\Database::pendingWriteCallers ( )

Get the list of method names that did write queries for this transaction.

Returns: array

Since: 1.27

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 586 of file Database.php.

◆ pendingWriteQueryDuration()

Wikimedia\Rdbms\Database::pendingWriteQueryDuration ( $type = self::ESTIMATE_TOTAL )

Get the time spend running write queries for this transaction.

High times could be due to scanning, updates, locking, and such

Parameters

string $type IDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL]

Returns: float|bool Returns false if not transaction is active

Since: 1.26

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 564 of file Database.php.

References Wikimedia\Rdbms\Database\$mTrxWriteAdjQueryCount, Wikimedia\Rdbms\Database\$mTrxWriteDuration, $type, and Wikimedia\Rdbms\Database\ping().

Referenced by Wikimedia\Rdbms\Database\commit().

◆ pendingWriteRowsAffected()

Wikimedia\Rdbms\Database::pendingWriteRowsAffected ( )

Get the number of affected rows from pending write queries.

Returns: int

Since: 1.30

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 590 of file Database.php.

References Wikimedia\Rdbms\Database\$mTrxWriteAffectedRows.

◆ ping()

Wikimedia\Rdbms\Database::ping ( & $rtt = null )

Ping the server and try to reconnect if it there is no connection.

Parameters

float | null &$rtt Value to store the estimated RTT [optional]

Returns: bool Success or failure

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3121 of file Database.php.

References Wikimedia\Rdbms\Database\$mRTTEstimate, Wikimedia\Rdbms\Database\clearFlag(), DBO_TRX, false, Wikimedia\Rdbms\Database\isOpen(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\restoreFlags().

Referenced by Wikimedia\Rdbms\Database\pendingWriteQueryDuration().

◆ prependDatabaseOrSchema()

Wikimedia\Rdbms\Database::prependDatabaseOrSchema	(	$namespace,
		$relation,
		$format
	)

private

Parameters

string \| null	$namespace	Database or schema
string	$relation	Name of table, view, sequence, etc...
string	$format	One of (raw, quoted)

Returns: string Relation name with quoted and merged $namespace as needed

Definition at line 1874 of file Database.php.

References Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\isQuotedIdentifier().

Referenced by Wikimedia\Rdbms\Database\tableName().

◆ qualifiedTableComponents()

Wikimedia\Rdbms\Database::qualifiedTableComponents ( $name )

protected

Get the table components needed for a query given the currently selected database.

Parameters

string $name Table name in the form of db.schema.table, db.table, or table

Returns: array (DB name or "" for default, schema name, table prefix, table name)

Definition at line 1834 of file Database.php.

References Wikimedia\Rdbms\Database\$mSchema, Wikimedia\Rdbms\Database\$mTablePrefix, $name, captcha-old\count, and list.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\tableExists(), and Wikimedia\Rdbms\Database\tableName().

◆ query()

Wikimedia\Rdbms\Database::query	(	$sql,
		$fname = `__METHOD__`,
		$tempIgnore = `false`
	)

Run an SQL query and return the result.

Normally throws a DBQueryError on failure. If errors are ignored, returns false instead.

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.

Parameters

string	$sql	SQL query
string	$fname	Name of the calling function, for profiling/SHOW PROCESSLIST comment (you can use METHOD or add some extra info)
bool	$tempIgnore	Whether to avoid throwing an exception on errors... maybe best to catch the exception instead?

Exceptions

Returns: bool|IResultWrapper True for a successful write query, IResultWrapper object for a successful read query, or false on failure if $tempIgnore set

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseSqliteMock.

Definition at line 888 of file Database.php.

◆ reconnect()

Wikimedia\Rdbms\Database::reconnect ( )

protected

Close existing database connection and open a new connection.

Returns: bool True if new connection is opened successfully, false if error

Definition at line 3147 of file Database.php.

References $e, Wikimedia\Rdbms\Database\closeConnection(), and Wikimedia\Rdbms\IDatabase\open().

Referenced by Wikimedia\Rdbms\Database\query().

◆ registerTempTableOperation()

Wikimedia\Rdbms\Database::registerTempTableOperation ( $sql )

protected

Parameters

string $sql A SQL query

Returns: bool Whether $sql is SQL for TEMPORARY table operation

Definition at line 853 of file Database.php.

References $matches.

Referenced by Wikimedia\Rdbms\Database\query().

◆ replace()

Wikimedia\Rdbms\Database::replace	(	$table,
		$uniqueIndexes,
		$rows,
		$fname = `__METHOD__`
	)

REPLACE query wrapper.

REPLACE is a very handy MySQL extension, which functions like an INSERT except that when there is a duplicate key error, the old row is deleted and the new row is inserted in its place.

We simulate this with standard SQL with a DELETE followed by INSERT. To perform the delete, we need to know what the unique indexes are so that we know how to find the conflicting rows.

It may be more efficient to leave off unique indexes which are unlikely to collide. However if you do this, you run the risk of encountering errors which wouldn't have occurred in MySQL.

Parameters

string	$table	The table to replace the row(s) in.
array	$uniqueIndexes	Is an array of indexes. Each element may be either a field name or an array of field names
array	$rows	Can be either a single row to insert, or multiple rows, in the same format as for IDatabase::insert()
string	$fname	Calling function name (use METHOD) for logs/profiling

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 2184 of file Database.php.

References $fname, $rows, Wikimedia\Rdbms\Database\addQuotes(), as, captcha-old\count, Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().

◆ replaceVars()

Wikimedia\Rdbms\Database::replaceVars ( $ins )

protected

Database independent variable replacement.

Replaces a set of variables in an SQL statement with their contents as given by $this->getSchemaVars().

Supports '{$var}' {$var} and / $var / (without the spaces) style variables.

'{$var}' should be used for text and is passed through the database's addQuotes method.
{$var} should be used for identifiers (e.g. table and database names). It is passed through the database's addIdentifierQuotes method which can be overridden if the database uses something other than backticks.
/ *_* / or / $wgDBprefix / passes the name that follows through the database's tableName method.
/ i / passes the name that follows through the database's indexName method.
In all other cases, / $var / is left unencoded. Except for table options, its use should be avoided. In 1.24 and older, string encoding was applied.

Parameters

string $ins SQL statement to replace variables in

Returns: string The new SQL statement with variables replaced

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, DatabaseSqliteMock, and Wikimedia\Rdbms\DatabasePostgres.

Definition at line 3384 of file Database.php.

References $vars, Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\Database\addQuotes(), Wikimedia\Rdbms\Database\getSchemaVars(), Wikimedia\Rdbms\Database\indexName(), Wikimedia\Rdbms\Database\tableName(), and use.

Referenced by Wikimedia\Rdbms\Database\sourceStream().

◆ reportConnectionError()

Wikimedia\Rdbms\Database::reportConnectionError ( $error = 'Unknown error' )

Parameters

string $error Fallback error message, used if none is given by DB

Exceptions

DBConnectionError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 793 of file Database.php.

References Wikimedia\Rdbms\IDatabase\lastError().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\open().

◆ reportQueryError()

Wikimedia\Rdbms\Database::reportQueryError	(	$error,
		$errno,
		$sql,
		$fname,
		$tempIgnore = `false`
	)

Report a query error.

Log the error, and if neither the object ignore flag nor the $tempIgnore flag is set, throw a DBQueryError.

Parameters

string	$error
int	$errno
string	$sql
string	$fname
bool	$tempIgnore

Exceptions

DBQueryError

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres.

Definition at line 1133 of file Database.php.

References $fname, Wikimedia\Rdbms\Database\getLogContext(), and Wikimedia\Rdbms\Database\ignoreErrors().

Referenced by Wikimedia\Rdbms\Database\query().

◆ requiresDatabaseUser()

Wikimedia\Rdbms\Database::requiresDatabaseUser ( )

protected

Returns: bool Whether a DB user is required to access the DB

Since: 1.28

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 3604 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\__construct().

◆ restoreErrorHandler()

Wikimedia\Rdbms\Database::restoreErrorHandler ( )

protected

Restore the previous error handler and return the last PHP error for this DB.

Returns: bool|string

Definition at line 702 of file Database.php.

References Wikimedia\Rdbms\Database\getLastPHPError().

Referenced by Wikimedia\Rdbms\DatabasePostgres\open(), and Wikimedia\Rdbms\DatabaseMysqlBase\open().

◆ restoreFlags()

Wikimedia\Rdbms\Database::restoreFlags ( $state = self::RESTORE_PRIOR )

Restore the flags to their prior state before the last setFlag/clearFlag call.

Parameters

string $state IDatabase::RESTORE_* constant. [default: RESTORE_PRIOR]

Since: 1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 637 of file Database.php.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getHeartbeatData(), and Wikimedia\Rdbms\Database\ping().

◆ resultObject()

Wikimedia\Rdbms\Database::resultObject ( $result )

protected

Take the result from a query, and wrap it in a ResultWrapper if necessary.

Boolean values are passed through as is, to indicate success of write queries or failure.

Once upon a time, Database::query() returned a bare MySQL result resource, and it was necessary to call this function to convert it to a wrapper. Nowadays, raw database objects are never exposed to external callers, so this is unnecessary in external code.

Parameters

bool | ResultWrapper | resource | object $result

Returns: bool|ResultWrapper

Reimplemented in Wikimedia\Rdbms\DatabaseMssql.

Definition at line 3108 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\query().

◆ rollback()

Wikimedia\Rdbms\Database::rollback	(	$fname = `__METHOD__`,
		$flush = `''`
	)

final

Rollback a transaction previously started using begin().

If no transaction is in progress, a warning is issued.

Only call this from code with outer transcation 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 preferrable, using a pre-installed error handler to trigger rollback (in any case, failure to issue COMMIT will cause rollback server-side).

Parameters

string	$fname	Calling function name
string	$flush	Flush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about calling rollback when no transaction is in progress. 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.

Exceptions

Referenced by Wikimedia\Rdbms\Database\deadlockLoop(), Wikimedia\Rdbms\Database\doAtomicSection(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), Wikimedia\Rdbms\DatabasePostgres\reportQueryError(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), and Wikimedia\Rdbms\Database\upsert().

Since: 1.23 Added $flush parameter

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2998 of file Database.php.

References Wikimedia\Rdbms\Database\assertOpen(), DBO_TRX, Wikimedia\Rdbms\Database\doRollback(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), and Wikimedia\Rdbms\Database\runTransactionListenerCallbacks().

◆ runOnTransactionIdleCallbacks()

Wikimedia\Rdbms\Database::runOnTransactionIdleCallbacks ( $trigger )

Actually run and consume any "on transaction idle/resolution" callbacks.

This method should not be used outside of Database/LoadBalancer

Parameters

int $trigger IDatabase::TRIGGER_* constant

Since: 1.20

Exceptions

Exception

Definition at line 2728 of file Database.php.

References $e, as, Wikimedia\Rdbms\Database\clearFlag(), captcha-old\count, DBO_TRX, Wikimedia\Rdbms\Database\getFlag(), list, Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\setFlag(), and Wikimedia\Rdbms\Database\trxLevel().

Referenced by Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\handleSessionLoss(), Wikimedia\Rdbms\Database\onTransactionIdle(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\LoadBalancer\runMasterPostTrxCallbacks().

◆ runOnTransactionPreCommitCallbacks()

Wikimedia\Rdbms\Database::runOnTransactionPreCommitCallbacks ( )

Actually run and consume any "on transaction pre-commit" callbacks.

This method should not be used outside of Database/LoadBalancer

Since: 1.22

Exceptions

Exception

Definition at line 2778 of file Database.php.

References $e, Wikimedia\Rdbms\Database\$mTrxPreCommitCallbacks, as, captcha-old\count, and list.

Referenced by Wikimedia\Rdbms\Database\commit(), and Wikimedia\Rdbms\LoadBalancer\finalizeMasterChanges().

◆ runTransactionListenerCallbacks()

Wikimedia\Rdbms\Database::runTransactionListenerCallbacks ( $trigger )

Actually run any "transaction listener" callbacks.

This method should not be used outside of Database/LoadBalancer

Parameters

int $trigger IDatabase::TRIGGER_* constant

Exceptions

Exception

Since: 1.20

Definition at line 2808 of file Database.php.

References $e, and as.

Referenced by Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\handleSessionLoss(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\LoadBalancer\runMasterPostTrxCallbacks().

◆ select()

Wikimedia\Rdbms\Database::select	(	$table,
		$vars,
		$conds = `''`,
		$fname = `__METHOD__`,
		$options = `[]`,
		$join_conds = `[]`
	)

Execute a SELECT query constructed using the various parameters provided.

See below for full details of the parameters.

Parameters

string \| array	$table	Table name
string \| array	$vars	Field names
string \| array	$conds	Conditions
string	$fname	Caller function name
array	$options	Query options
array	$join_conds	Join conditions
string \| array	$table	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).

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.

Parameters

string | array $vars 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.

Parameters

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:

Elements with a numeric key are interpreted as raw SQL fragments.
Elements with a string key are interpreted as equality conditions, where the key is the field name.
- If the value of such an array element is a scalar (such as a string), it will be treated as data and thus quoted appropriately. If it is null, an IS NULL clause will be added.
- If the value is an array, an IN (...) clause will be constructed from its non-null elements, and an IS NULL clause will be added if null is present, such that the field may match any of the elements in the array. The non-null elements will be quoted.

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()

Parameters

string | array $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:

OFFSET: Skip this many rows at the start of the result set. OFFSET with LIMIT can theoretically be used for paging through a result set, but this is discouraged for performance reasons.
LIMIT: Integer: return at most this many rows. The rows are sorted and then the first rows are taken until the limit is reached. LIMIT is applied to a result set after OFFSET.
FOR UPDATE: Boolean: lock the returned rows so that they can't be changed until the next COMMIT.
DISTINCT: Boolean: return only unique result rows.
GROUP BY: May be either an SQL fragment string naming a field or expression to group by, or an array of such SQL fragments.
HAVING: May be either an string containing a HAVING clause or an array of conditions building the HAVING clause. If an array is given, the conditions constructed from each element are combined with AND.
ORDER BY: May be either an SQL fragment giving a field name or expression to order by, or an array of such SQL fragments.
USE INDEX: This may be either a string giving the index name to use for the query, or an array. If it is an associative array, each key gives the table name (or alias), each value gives the index name to use for that table. All strings are SQL fragments and so should be validated by the caller.
EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run, instead of SELECT.

And also the following boolean MySQL extensions, see the MySQL manual for documentation:

LOCK IN SHARE MODE
STRAIGHT_JOIN
HIGH_PRIORITY
SQL_BIG_RESULT
SQL_BUFFER_RESULT
SQL_SMALL_RESULT
SQL_CALC_FOUND_ROWS
SQL_CACHE
SQL_NO_CACHE

Parameters

string | array $join_conds Optional associative array of table-specific join conditions. In the most common case, this is unnecessary, since the join condition can be in $conds. However, it is useful for doing a LEFT JOIN.

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' ] ]

Returns: IResultWrapper|bool If the query returned no rows, a IResultWrapper with no rows in it will be returned. If there was a query error, a DBQueryError exception will be thrown, except if the "ignore errors" option was set, in which case false will be returned.

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMssql.

Definition at line 1339 of file Database.php.

References $fname, $options, $vars, Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\selectSQLText().

Referenced by MediaWikiTestCase\assertSelect(), Wikimedia\Rdbms\DatabasePostgres\estimateRowCount(), Wikimedia\Rdbms\DatabaseMysqlBase\estimateRowCount(), Wikimedia\Rdbms\Database\estimateRowCount(), Wikimedia\Rdbms\Database\insertSelect(), Wikimedia\Rdbms\DatabaseSqlite\listTables(), Wikimedia\Rdbms\Database\selectField(), Wikimedia\Rdbms\Database\selectFieldValues(), Wikimedia\Rdbms\Database\selectRow(), and DatabaseSqliteTest\testNumFields().

◆ selectDB()

Wikimedia\Rdbms\Database::selectDB ( $db )

Change the current database.

Parameters

string $db

Returns: bool Success or failure

Exceptions

DBConnectionError If databasesAreIndependent() is true and an error occurs

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMssql, DatabaseOracle, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysql.

Definition at line 1771 of file Database.php.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\open().

◆ selectField()

Wikimedia\Rdbms\Database::selectField	(	$table,
		$var,
		$cond = `''`,
		$fname = `__METHOD__`,
		$options = `[]`,
		$join_conds = `[]`
	)

A SELECT wrapper which returns a single field from a single result row.

Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns false on failure.

If no result rows are returned from the query, false is returned.

Parameters

string \| array	$table	Table name. See IDatabase::select() for details.
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. See IDatabase::select() for details.
string	$fname	The function name of the caller.
string \| array	$options	The query options. See IDatabase::select() for details.
string \| array	$join_conds	The query join conditions. See IDatabase::select() for details.

Returns: bool|mixed The value from the field, or false on failure.

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1156 of file Database.php.

References $fname, $options, $res, Wikimedia\Rdbms\IDatabase\fetchRow(), Wikimedia\Rdbms\IDatabase\numRows(), and Wikimedia\Rdbms\Database\select().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getServerVersion(), Wikimedia\Rdbms\DatabasePostgres\roleExists(), Wikimedia\Rdbms\DatabasePostgres\ruleExists(), Wikimedia\Rdbms\DatabasePostgres\schemaExists(), Wikimedia\Rdbms\DatabaseMysqlBase\setBigSelects(), DatabaseSqliteTest\testDuplicateTableStructure(), and DatabaseSqliteTest\testDuplicateTableStructureVirtual().

◆ selectFieldValues()

Wikimedia\Rdbms\Database::selectFieldValues	(	$table,
		$var,
		$cond = `''`,
		$fname = `__METHOD__`,
		$options = `[]`,
		$join_conds = `[]`
	)

A SELECT wrapper which returns a list of single field values from result rows.

Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns false on failure.

If no result rows are returned from the query, false is returned.

Parameters

string \| array	$table	Table name. See IDatabase::select() for details.
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. See IDatabase::select() for details.
string	$fname	The function name of the caller.
string \| array	$options	The query options. See IDatabase::select() for details.
string \| array	$join_conds	The query join conditions. See IDatabase::select() for details.

Returns: bool|array The values from the field, or false on failure

Since: 1.25

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1183 of file Database.php.

References $fname, $options, $res, as, and Wikimedia\Rdbms\Database\select().

◆ selectRow()

Wikimedia\Rdbms\Database::selectRow	(	$table,
		$vars,
		$conds,
		$fname = `__METHOD__`,
		$options = `[]`,
		$join_conds = `[]`
	)

Single row SELECT wrapper.

Equivalent to IDatabase::select(), except that a single row object is returned. If the query returns no rows, false is returned.

Parameters

string \| array	$table	Table name
string \| array	$vars	Field names
array	$conds	Conditions
string	$fname	Caller function name
string \| array	$options	Query options
array \| string	$join_conds	Join conditions

Returns: stdClass|bool

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle.

Definition at line 1406 of file Database.php.

References $fname, $options, $res, $vars, array(), Wikimedia\Rdbms\IDatabase\fetchObject(), Wikimedia\Rdbms\IDatabase\numRows(), and Wikimedia\Rdbms\Database\select().

Referenced by Wikimedia\Rdbms\DatabaseSqlite\indexUnique().

◆ selectRowCount()

Wikimedia\Rdbms\Database::selectRowCount	(	$tables,
		$vars = `' *'`,
		$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().

Since: 1.27 Added $join_conds parameter

Parameters

array \| string	$tables	Table names
string	$vars	Unused
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)

Returns: int Row count

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1440 of file Database.php.

References $fname, $options, $res, $rows, $tables, Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\IDatabase\fetchRow(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\selectSQLText().

◆ selectSQLText()

Wikimedia\Rdbms\Database::selectSQLText	(	$table,
		$vars,
		$conds = `''`,
		$fname = `__METHOD__`,
		$options = `[]`,
		$join_conds = `[]`
	)

The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed.

This can be useful for doing UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().

Parameters

string \| array	$table	Table name
string \| array	$vars	Field names
string \| array	$conds	Conditions
string	$fname	Caller function name
string \| array	$options	Query options
string \| array	$join_conds	Join conditions

Returns: string SQL query string.

See also: IDatabase::select()

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMssql.

Definition at line 1346 of file Database.php.

References $options, $vars, array(), Wikimedia\Rdbms\Database\fieldNamesWithAlias(), Wikimedia\Rdbms\Database\limitResult(), list, LIST_AND, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\makeSelectOptions(), and Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN().

Referenced by Wikimedia\Rdbms\DatabaseSqlite\buildGroupConcatField(), Wikimedia\Rdbms\Database\buildGroupConcatField(), Wikimedia\Rdbms\Database\nativeInsertSelect(), Wikimedia\Rdbms\Database\select(), Wikimedia\Rdbms\Database\selectRowCount(), and Wikimedia\Rdbms\Database\unionConditionPermutations().

◆ serverIsReadOnly()

Wikimedia\Rdbms\Database::serverIsReadOnly ( )

Returns: bool Whether the DB is marked as read-only server-side

Since: 1.28

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 2662 of file Database.php.

◆ setBigSelects()

Wikimedia\Rdbms\Database::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.

Parameters

bool | string $value True for allow, false for deny, or "default" to restore the initial value

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 3579 of file Database.php.

◆ setFlag()

Wikimedia\Rdbms\Database::setFlag	(	$flag,
		$remember = `self::REMEMBER_NOTHING`
	)

Set a flag for this connection.

Parameters

int	$flag	DBO_* constants from Defines.php: DBO_DEBUG: output some debug info (same as debug()) DBO_NOBUFFER: don't buffer results (inverse of bufferResults()) DBO_TRX: automatically start transactions DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode and removes it in command line mode DBO_PERSISTENT: use persistant database connection
string	$remember	IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 623 of file Database.php.

Referenced by DatabaseUpdater\__construct(), Wikimedia\Rdbms\Database\bufferResults(), Wikimedia\Rdbms\Database\ignoreErrors(), DatabaseOracle\open(), and Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().

◆ setLazyMasterHandle()

Wikimedia\Rdbms\Database::setLazyMasterHandle ( IDatabase $conn )

Set a lazy-connecting DB handle to the master DB (for replication status purposes)

Parameters

IDatabase $conn

Since: 1.27

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 521 of file Database.php.

◆ setLBInfo()

Wikimedia\Rdbms\Database::setLBInfo	(	$name,
		$value = `null`
	)

Set the LB info array, or a member of it.

If called with one parameter, the LB info array is set to that parameter. If it is called with two parameters, the member with the given name is set to the given value.

Parameters

string	$name
array	$value

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 513 of file Database.php.

References $name, and $value.

◆ setLogger()

Wikimedia\Rdbms\Database::setLogger ( LoggerInterface $logger )

Set the PSR-3 logger interface to use for query logging.

(The logger interfaces for connection logging and error logging can be set with the constructor.)

Parameters

LoggerInterface $logger

Definition at line 430 of file Database.php.

◆ setSchemaVars()

Wikimedia\Rdbms\Database::setSchemaVars ( $vars )

Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS.

If an array is set here, $GLOBALS will not be used at all. If it's set to false, $GLOBALS will be used.

Parameters

bool | array $vars Mapping variable name to value.

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3285 of file Database.php.

References $vars.

◆ setSessionOptions()

Wikimedia\Rdbms\Database::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.

Parameters

array $options

Returns: void

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 3250 of file Database.php.

◆ setTableAliases()

Wikimedia\Rdbms\Database::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.

For example, "user" can be converted to "myschema.mydbname.user" for convenience. Appearances like user, somedb.user, somedb.someschema.user will used literally.

Calling this twice will completely clear any old table aliases. Also, note that callers are responsible for making sure the schemas and databases actually exist.

Parameters

array[] $aliases Map of (table => (dbname, schema, prefix) map)

Since: 1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3596 of file Database.php.

◆ setTransactionListener()

Wikimedia\Rdbms\Database::setTransactionListener	(		$name,
		callable	$callback = `null`
	)

final

Run a callback each time any transaction commits or rolls back.

The callback takes two arguments:

IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK
This IDatabase object Callbacks must commit any transactions that they begin.

Registering a callback here will not affect writesOrCallbacks() pending

Parameters

string	$name	Callback name
callable \| null	$callback	Use null to unset a listener

Returns: mixed

Since: 1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2699 of file Database.php.

References $name.

◆ setTrxEndCallbackSuppression()

Wikimedia\Rdbms\Database::setTrxEndCallbackSuppression ( $suppress )

final

Whether to disable running of post-COMMIT/ROLLBACK callbacks.

This method should not be used outside of Database/LoadBalancer

Parameters

bool $suppress

Since: 1.28

Definition at line 2715 of file Database.php.

Referenced by Wikimedia\Rdbms\LoadBalancer\beginMasterChanges(), Wikimedia\Rdbms\LoadBalancer\finalizeMasterChanges(), Wikimedia\Rdbms\LoadBalancer\runMasterPostTrxCallbacks(), and Wikimedia\Rdbms\LoadBalancer\suppressTransactionEndCallbacks().

◆ sourceFile()

Wikimedia\Rdbms\Database::sourceFile	(		$filename,
		callable	$lineCallback = `null`,
		callable	$resultCallback = `null`,
			$fname = `false`,
		callable	$inputCallback = `null`
	)

Read and execute SQL commands from a file.

Returns true on success, error string or exception on failure (depending on object's error ignore settings).

Parameters

string	$filename	File name to open
callable \| null	$lineCallback	Optional function called before reading each line
callable \| null	$resultCallback	Optional function called for each MySQL result
bool \| string	$fname	Calling function name or false if name should be generated dynamically using $filename
callable \| null	$inputCallback	Optional function called for each complete line sent

Returns: bool|string

Exceptions

Exception

Definition at line 3253 of file Database.php.

References $e, $fname, and Wikimedia\Rdbms\Database\sourceStream().

Referenced by DatabaseSqliteTest\prepareTestDB().

◆ sourceStream()

Wikimedia\Rdbms\Database::sourceStream	(		$fp,
		callable	$lineCallback = `null`,
		callable	$resultCallback = `null`,
			$fname = `__METHOD__`,
		callable	$inputCallback = `null`
	)

Read and execute commands from an open file handle.

Returns true on success, error string or exception on failure (depending on object's error ignore settings).

Parameters

resource	$fp	File handle
callable \| null	$lineCallback	Optional function called before reading each query
callable \| null	$resultCallback	Optional function called for each MySQL result
string	$fname	Calling function name
callable \| null	$inputCallback	Optional function called for each complete query sent

Returns: bool|string

Reimplemented in DatabaseOracle.

Definition at line 3289 of file Database.php.

References $fname, $line, $res, Wikimedia\Rdbms\IDatabase\lastError(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\replaceVars(), and Wikimedia\Rdbms\Database\streamStatementEnd().

Referenced by Wikimedia\Rdbms\Database\sourceFile().

◆ startAtomic()

Wikimedia\Rdbms\Database::startAtomic ( $fname = __METHOD__ )

final

Begin an atomic section of statements.

If a transaction has been started already, just keep track of the given section name to make sure the transaction is not committed pre-maturely. This function can be used in layers (with sub-sections), so use a stack to keep track of the different atomic sections. If there is no transaction, start one implicitly.

The goal of this function is to create an atomic section of SQL queries without having to start a new transaction if it already exists.

All atomic levels must be explicitly closed using IDatabase::endAtomic(), and any database transactions cannot be began or committed until all atomic levels are closed. There is no such thing as implicitly opening or closing an atomic section.

Since: 1.23

Parameters

string $fname

Exceptions

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2830 of file Database.php.

References $fname, Wikimedia\Rdbms\Database\begin(), DBO_TRX, and Wikimedia\Rdbms\Database\getFlag().

Referenced by Wikimedia\Rdbms\Database\doAtomicSection(), Wikimedia\Rdbms\Database\lockTables(), and Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle().

◆ streamStatementEnd()

Wikimedia\Rdbms\Database::streamStatementEnd	(	&	$sql,
		&	$newLine
	)

Called by sourceStream() to check if we've reached a statement end.

Parameters

string	&$sql	SQL assembled so far
string	&$newLine	New line about to be added to $sql

Returns: bool Whether $newLine contains end of the statement

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 3351 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\sourceStream().

◆ strencode()

Wikimedia\Rdbms\Database::strencode ( $s )

abstract

Wrapper for addslashes()

Parameters

string $s String to be slashed.

Returns: string Slashed string.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMssql, DatabaseOracle, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\Database\addQuotes().

◆ strreplace()

Wikimedia\Rdbms\Database::strreplace	(	$orig,
		$old,
		$new
	)

Returns a command for str_replace function in SQL query.

Uses REPLACE() in MySQL

Parameters

string	$orig	Column to modify
string	$old	Column to seek
string	$new	Column to replace with

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2577 of file Database.php.

◆ tableExists()

Wikimedia\Rdbms\Database::tableExists	(	$table,
		$fname = `__METHOD__`
	)

Query whether a given table exists.

Parameters

string	$table
string	$fname

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMssql, DatabaseOracle, and Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 1507 of file Database.php.

References $fname, $res, Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().

Referenced by Wikimedia\Rdbms\DatabaseSqlite\dropTable(), Wikimedia\Rdbms\Database\dropTable(), and Wikimedia\Rdbms\Database\indexExists().

◆ tableLocksHaveTransactionScope()

Wikimedia\Rdbms\Database::tableLocksHaveTransactionScope ( )

Checks if table locks acquired by lockTables() are transaction-bound in their scope.

Transaction-bound table locks will be released when the current transaction terminates. Table locks that are not bound to a transaction are not effected by BEGIN/COMMIT/ROLLBACK and will last until either lockTables()/unlockTables() is called or the TCP connection to the database is closed.

Returns: bool

Since: 1.29

Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 3497 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\lockTables(), and Wikimedia\Rdbms\Database\unlockTables().

◆ tableName()

Wikimedia\Rdbms\Database::tableName	(	$name,
		$format = `'quoted'`
	)

Format a table name ready for use in constructing an SQL query.

This does two important things: it quotes the table names to clean them up, and it adds a table prefix if only given a table name with no quotes.

All functions of this object which require a table name call this function themselves. Pass the canonical name to such functions. This is only needed when calling query() directly.

Note: This function does not sanitize user input. It is not safe to use this function to escape user input.

Parameters

string	$name	Database table name
string	$format	One of: quoted - Automatically pass the table name through addIdentifierQuotes() so that it can be used in a query. raw - Do not add identifier quotes to the table name

Returns: string Full database name

Reimplemented in Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, DatabaseOracle, and Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 1788 of file Database.php.

References $name, Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\Database\isQuotedIdentifier(), list, Wikimedia\Rdbms\Database\prependDatabaseOrSchema(), and Wikimedia\Rdbms\Database\qualifiedTableComponents().

◆ tableNames()

Wikimedia\Rdbms\Database::tableNames ( )

Fetch a number of table names into an array This is handy when you need to construct SQL for joins.

Example: extract( $dbr->tableNames( 'user', 'watchlist' ) ); $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user WHERE wl_user=user_id AND wl_user=$nameWithQuotes";

Returns: array

Definition at line 1885 of file Database.php.

References $name, as, and Wikimedia\Rdbms\Database\tableName().

◆ tableNamesN()

Wikimedia\Rdbms\Database::tableNamesN ( )

Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins.

Example: list( $user, $watchlist ) = $dbr->tableNamesN( 'user', 'watchlist' ); $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user WHERE wl_user=user_id AND wl_user=$nameWithQuotes";

Returns: array

Definition at line 1896 of file Database.php.

References $name, as, and Wikimedia\Rdbms\Database\tableName().

◆ tableNamesWithAlias()

Wikimedia\Rdbms\Database::tableNamesWithAlias ( $tables )

protected

Gets an array of aliased table names.

Parameters

array $tables [ [alias] => table ]

Returns: string[] See tableNameWithAlias()

Definition at line 1929 of file Database.php.

References $retval, $tables, as, and Wikimedia\Rdbms\Database\tableNameWithAlias().

◆ tableNamesWithIndexClauseOrJOIN()

Wikimedia\Rdbms\Database::tableNamesWithIndexClauseOrJOIN	(	$tables,
		$use_index = `[]`,
		$ignore_index = `[]`,
		$join_conds = `[]`
	)

protected

Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause.

Parameters

array	$tables	( [alias] => table )
array	$use_index	Same as for select()
array	$ignore_index	Same as for select()
array	$join_conds	Same as for select()

Returns: string

Definition at line 1985 of file Database.php.

References $ret, $tables, array(), as, Wikimedia\Rdbms\Database\ignoreIndexClause(), list, LIST_AND, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\tableNameWithAlias(), and Wikimedia\Rdbms\Database\useIndexClause().

Referenced by Wikimedia\Rdbms\Database\selectSQLText().

◆ tableNameWithAlias()

Wikimedia\Rdbms\Database::tableNameWithAlias	(	$name,
		$alias = `false`
	)

protected

Get an aliased table name e.g.

tableName AS newTableName

Parameters

string	$name	Table name, see tableName()
string \| bool	$alias	Alias (optional)

Returns: string SQL name for aliased table. Will not alias a table to its own name

Definition at line 1915 of file Database.php.

References $name, Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\tableName().

Referenced by Wikimedia\Rdbms\Database\tableNamesWithAlias(), and Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN().

◆ tablePrefix()

Wikimedia\Rdbms\Database::tablePrefix ( $prefix = null )

Get/set the table prefix.

Parameters

string $prefix The table prefix to set, or omitted to leave it unchanged.

Returns: string The previous table prefix.

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 480 of file Database.php.

References Wikimedia\Rdbms\Database\$mTablePrefix, and Wikimedia\Rdbms\DatabaseDomain\newUnspecified().

Referenced by MediaWikiTestCase\listTables(), MediaWikiTestCase\setupTestDB(), and DatabaseSqliteTest\testTableName().

◆ textFieldSize()

Wikimedia\Rdbms\Database::textFieldSize	(	$table,
		$field
	)

Returns the size of a text field, or -1 for "unlimited".

Parameters

string	$table
string	$field

Returns: int

Reimplemented in Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, DatabaseOracle, and Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 2338 of file Database.php.

References $res, Wikimedia\Rdbms\IDatabase\fetchObject(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().

◆ timestamp()

Wikimedia\Rdbms\Database::timestamp ( $ts = 0 )

Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS.

The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.

Parameters

string | int $ts

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and DatabaseOracle.

Definition at line 3081 of file Database.php.

References $t.

Referenced by Wikimedia\Rdbms\Database\encodeExpiry(), User\makeUpdateConditions(), and Wikimedia\Rdbms\Database\timestampOrNull().

◆ timestampOrNull()

Wikimedia\Rdbms\Database::timestampOrNull ( $ts = null )

Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS.

If NULL is input, it is passed through, allowing NULL values to be inserted into timestamp fields.

The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.

Parameters

string | int $ts

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3087 of file Database.php.

References Wikimedia\Rdbms\Database\timestamp().

◆ trxLevel()

Wikimedia\Rdbms\Database::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.

Returns: int The previous value

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 472 of file Database.php.

References Wikimedia\Rdbms\Database\$mTrxLevel.

Referenced by Wikimedia\Rdbms\SavepointPostgres\__construct(), Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\getScopedLockAndFlush(), Wikimedia\Rdbms\LoadBalancer\runMasterPostTrxCallbacks(), and Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().

◆ trxTimestamp()

Wikimedia\Rdbms\Database::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.

Returns: float|null Returns null if there is not active transaction

Since: 1.25

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 476 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\getTransactionLagStatus().

◆ unionConditionPermutations()

Wikimedia\Rdbms\Database::unionConditionPermutations	(		$table,
			$vars,
		array	$permute_conds,
			$extra_conds = `''`,
			$fname = `__METHOD__`,
			$options = `[]`,
			$join_conds = `[]`
	)

Construct a UNION query for permutations of conditions.

Databases sometimes have trouble with queries that have multiple values for multiple condition parameters combined with limits and ordering. This method constructs queries for the Cartesian product of the conditions and unions them all together.

See also: IDatabase::select()

Since: 1.30

Parameters

string \| array	$table	Table name
string \| array	$vars	Field names
array	$permute_conds	Conditions for the Cartesian product. Keys are field names, values are arrays of the possible values for that field.
string \| array	$extra_conds	Additional conditions to include in the query.
string	$fname	Caller function name
string \| array	$options	Query options. In addition to the options recognized by IDatabase::select(), the following may be used: NOTALL: Set to use UNION instead of UNION ALL. INNER ORDER BY: If specified and supported, subqueries will use this instead of ORDER BY.
string \| array	$join_conds	Join conditions

Returns: string SQL query string.

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2498 of file Database.php.

References $fname, $options, $value, $vars, array(), as, captcha-old\count, Wikimedia\Rdbms\Database\limitResult(), Wikimedia\Rdbms\Database\makeOrderBy(), Wikimedia\Rdbms\Database\selectSQLText(), Wikimedia\Rdbms\Database\unionQueries(), and Wikimedia\Rdbms\Database\unionSupportsOrderAndLimit().

◆ unionQueries()

Wikimedia\Rdbms\Database::unionQueries	(	$sqls,
		$all
	)

Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.

Parameters

array	$sqls	SQL statements to combine
bool	$all	Use UNION ALL

Returns: string SQL fragment

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in DatabaseOracle, and Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 2492 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\unionConditionPermutations().

◆ unionSupportsOrderAndLimit()

Wikimedia\Rdbms\Database::unionSupportsOrderAndLimit ( )

Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct.

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMssql.

Definition at line 2488 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\unionConditionPermutations().

◆ unlock()

Wikimedia\Rdbms\Database::unlock	(	$lockName,
		$method
	)

Release a lock.

Named locks are not related to transactions

Parameters

string	$lockName	Name of lock to release
string	$method	Name of the calling method

Returns: int Returns 1 if the lock was released, 0 if the lock was not established by this thread (in which case the lock is not released), and NULL if the named lock did not exist

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 3452 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\getScopedLockAndFlush().

◆ unlockTables()

Wikimedia\Rdbms\Database::unlockTables ( $method )

final

Unlock all tables locked via lockTables()

If table locks are scoped to transactions, then locks might not be released until the transaction ends, which could happen after this method is called.

Parameters

string $method The caller

Returns: bool

Since: 1.29