Database Class Reference

Relational database abstraction object. More...

Inheritance diagram for Database:

Collaboration diagram for Database:

Public Member Functions
	__clone ()
	Make sure that copies do not share the same client binding handle.
	__construct (array $params)
	Constructor and database handle and attempt to connect to the DB server.
	__destruct ()
	Run a few simple sanity checks and close dangling connections.
	__sleep ()
	Called by serialize.
	__toString ()
	addIdentifierQuotes ( $s)
	Quotes an identifier using backticks or "double quotes" depending on the database type.
	addQuotes ( $s)
	Adds quotes and backslashes.
	aggregateValue ( $valuedata, $valuename='value')
	Return aggregated value alias.
	anyChar ()
	Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.
	anyString ()
	Returns a token for buildLike() that denotes a '' to be used in a LIKE query.
	begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
	Begin a transaction.
	bitAnd ( $fieldLeft, $fieldRight)
	bitNot ( $field)
	bitOr ( $fieldLeft, $fieldRight)
	bufferResults ( $buffer=null)
	Turns buffering of SQL result sets on (true) or off (false).
	buildConcat ( $stringList)
	Build a concatenation list to feed into a SQL query.
	buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
	Build a GROUP_CONCAT or equivalent statement for a query.
	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().
	buildStringCast ( $field)
	clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
	Clear a flag for this connection.
	close ()
	Closes a database connection.
	commit ( $fname=__METHOD__, $flush='')
	Commits a transaction previously started using begin().
	conditional ( $cond, $trueVal, $falseVal)
	Returns an SQL expression for a simple conditional.
	connectionErrorLogger ( $errno, $errstr)
	This method should not be used outside of Database classes.
	dbSchema ( $schema=null)
	Get/set the db schema.
	deadlockLoop ()
	Perform a deadlock-prone transaction.
	decodeBlob ( $b)
	Some DBMSs return a special placeholder object representing blob fields in result objects.
	decodeExpiry ( $expiry, $format=TS_MW)
	Decode an expiry time into a DBMS independent format.
	delete ( $table, $conds, $fname=__METHOD__)
	DELETE query wrapper.
	deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
	DELETE where the condition is a join.
	doAtomicSection ( $fname, callable $callback)
	Run a callback to do an atomic set of updates for this database.
	doneWrites ()
	Returns true if the connection may have been used for write queries.
	dropTable ( $tableName, $fName=__METHOD__)
	Delete a table.
	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.
	encodeBlob ( $b)
	Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.
	encodeExpiry ( $expiry)
	Encode an expiry time into the DBMS dependent format.
	endAtomic ( $fname=__METHOD__)
	Ends an atomic section of SQL statements.
	estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=[])
	Estimate the number of rows in dataset.
	explicitTrxActive ()
	fieldExists ( $table, $field, $fname=__METHOD__)
	Determines whether a field exists in a table.
	flushSnapshot ( $fname=__METHOD__)
	Commit any transaction but error out if writes or callbacks are pending.
	freeResult ( $res)
	Free a result object returned by query() or select().
	getDBname ()
	Get the current DB name.
	getDomainID ()
	getFlag ( $flag)
	Returns a boolean whether the flag $flag is set for this connection.
	getInfinity ()
	Find out when 'infinity' is.
	getLag ()
	Get replica DB lag.
	getLBInfo ( $name=null)
	Get properties passed down from the server info array of the load balancer.
	getMasterPos ()
	Get the position of this master.
	getProperty ( $name)
	getReplicaPos ()
	Get the replication position of this replica DB.
	getScopedLockAndFlush ( $lockKey, $fname, $timeout)
	Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
	getSearchEngine ()
	getServer ()
	Get the server hostname or IP address.
	getServerInfo ()
	A string describing the current software version, and possibly other details in a user-friendly way.
	getServerUptime ()
	Determines how long the server has been up.
	getSessionLagStatus ()
	Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active.
	getWikiID ()
	Alias for getDomainID()
	ignoreIndexClause ( $index)
	IGNORE INDEX clause.
	implicitGroupby ()
	Returns true if this database does an implicit sort when doing GROUP BY.
	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.
	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.
	indexInfo ( $table, $index, $fname=__METHOD__)
	Get information about an index into an object.
	indexUnique ( $table, $index)
	Determines if a given index is unique.
	insert ( $table, $a, $fname=__METHOD__, $options=[])
	INSERT wrapper, inserts an array into a table.
	insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
	INSERT SELECT wrapper.
	isOpen ()
	Is a connection to the database open?
	isQuotedIdentifier ( $name)
	Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers .
	isReadOnly ()
	lastDoneWrites ()
	Returns the last time the connection may have been used for write queries.
	lastQuery ()
	Return the last query that went through IDatabase::query()
	limitResult ( $sql, $limit, $offset=false)
	Construct a LIMIT query with optional offset.
	listTables ( $prefix=null, $fname=__METHOD__)
	List all tables on the database.
	listViews ( $prefix=null, $fname=__METHOD__)
	Lists all the VIEWs in the database.
	lock ( $lockName, $method, $timeout=5)
	Acquire a named lock.
	lockIsFree ( $lockName, $method)
	Check to see if a named lock is available (non-blocking)
	lockTables ( $read, $write, $method, $lowPriority=true)
	Lock specific tables.
	makeList ( $a, $mode=self::LIST_COMMA)
	Makes an encoded list of strings from an array.
	makeWhereFrom2d ( $data, $baseKey, $subKey)
	Build a partial where clause from a 2-d array such as used for LinkBatch.
	masterPosWait (DBMasterPos $pos, $timeout)
	Wait for the replica DB to catch up to a given master position.
	maxListLen ()
	Return the maximum number of items allowed in a list, or 0 for unlimited.
	namedLocksEnqueue ()
	Check to see if a named lock used by lock() use blocking queues.
	nextSequenceValue ( $seqName)
	Returns an appropriately quoted sequence value for inserting a new row.
	onTransactionIdle (callable $callback, $fname=__METHOD__)
	Run a callback as soon as there is no transaction pending.
	onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
	Run a callback before the current transaction commits or now if there is none.
	onTransactionResolution (callable $callback, $fname=__METHOD__)
	Run a callback as soon as the current transaction commits or rolls back.
	pendingWriteCallers ()
	Get the list of method names that did write queries for this transaction.
	pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
	Get the time spend running write queries for this transaction.
	ping (&$rtt=null)
	Ping the server and try to reconnect if it there is no connection.
	query ( $sql, $fname=__METHOD__, $tempIgnore=false)
	Run an SQL query and return the result.
	replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
	REPLACE query wrapper.
	reportConnectionError ( $error='Unknown error')
	reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false)
	Report a query error.
	restoreFlags ( $state=self::RESTORE_PRIOR)
	Restore the flags to their prior state before the last setFlag/clearFlag call.
	rollback ( $fname=__METHOD__, $flush='')
	Rollback a transaction previously started using begin().
	runOnTransactionIdleCallbacks ( $trigger)
	Actually run and consume any "on transaction idle/resolution" callbacks.
	runOnTransactionPreCommitCallbacks ()
	Actually run and consume any "on transaction pre-commit" callbacks.
	runTransactionListenerCallbacks ( $trigger)
	Actually run any "transaction listener" callbacks.
	select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Execute a SELECT query constructed using the various parameters provided.
	selectDB ( $db)
	Change the current database.
	selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[])
	A SELECT wrapper which returns a single field from a single result row.
	selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
	selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
	Single row SELECT wrapper.
	selectRowCount ( $tables, $vars=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Get the number of rows in dataset.
	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.
	serverIsReadOnly ()
	setBigSelects ( $value=true)
	Allow or deny "big selects" for this session only.
	setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
	Set a flag for this connection.
	setLazyMasterHandle (IDatabase $conn)
	Set a lazy-connecting DB handle to the master DB (for replication status purposes)
	setLBInfo ( $name, $value=null)
	Set the LB info array, or a member of it.
	setLogger (LoggerInterface $logger)
	setSchemaVars ( $vars)
	Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS.
	setSessionOptions (array $options)
	Override database's default behavior.
	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.
	setTransactionListener ( $name, callable $callback=null)
	Run a callback each time any transaction commits or rolls back.
	setTrxEndCallbackSuppression ( $suppress)
	Whether to disable running of post-COMMIT/ROLLBACK callbacks.
	sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
	Read and execute SQL commands from a file.
	sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
	Read and execute commands from an open file handle.
	startAtomic ( $fname=__METHOD__)
	Begin an atomic section of statements.
	streamStatementEnd (&$sql, &$newLine)
	Called by sourceStream() to check if we've reached a statement end.
	strencode ( $s)
	Wrapper for addslashes()
	strreplace ( $orig, $old, $new)
	Returns a comand for str_replace function in SQL query.
	tableExists ( $table, $fname=__METHOD__)
	Query whether a given table exists.
	tableName ( $name, $format='quoted')
	Format a table name ready for use in constructing an SQL query.
	tableNames ()
	Fetch a number of table names into an array This is handy when you need to construct SQL for joins.
	tableNamesN ()
	Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins.
	tablePrefix ( $prefix=null)
	Get/set the table prefix.
	textFieldSize ( $table, $field)
	Returns the size of a text field, or -1 for "unlimited".
	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.
	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.
	trxLevel ()
	Gets the current transaction level.
	trxTimestamp ()
	Get the UNIX timestamp of the time that the transaction was established.
	unionQueries ( $sqls, $all)
	Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.
	unionSupportsOrderAndLimit ()
	Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct.
	unlock ( $lockName, $method)
	Release a lock.
	unlockTables ( $method)
	Unlock specific tables.
	update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
	UPDATE wrapper.
	upsert ( $table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)
	INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
	useIndexClause ( $index)
	USE INDEX clause.
	wasConnectionError ( $errno)
	Do not use this method outside of Database/DBError classes.
	wasDeadlock ()
	Determines if the last failure was due to a deadlock.
	wasErrorReissuable ()
	Determines if the last query error was due to a dropped connection and should be dealt with by pinging the connection and reissuing the query.
	wasLockTimeout ()
	Determines if the last failure was due to a lock timeout.
	wasReadOnlyError ()
	Determines if the last failure was due to the database being read-only.
	writesOrCallbacksPending ()
	Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish.
	writesPending ()
Public Member Functions inherited from IDatabase
	affectedRows ()
	Get the number of rows affected by the last write query.
	dataSeek ( $res, $row)
	Change the position of the cursor in a result object.
	fetchObject ( $res)
	Fetch the next row from the given result object, in object form.
	fetchRow ( $res)
	Fetch the next row from the given result object, in associative array form.
	fieldInfo ( $table, $field)
	mysql_fetch_field() wrapper Returns false if the field doesn't exist
	fieldName ( $res, $n)
	Get a field name in a result object.
	getServerVersion ()
	A string describing the current software version, like from mysql_get_server_info().
	getSoftwareLink ()
	Returns a wikitext link to the DB's website, e.g., return "[http://www.mysql.com/ MySQL]"; Should at least contain plain text, if for some reason your database has no website.
	getType ()
	Get the type of the DBMS, as it appears in $wgDBtype.
	insertId ()
	Get the inserted value of an auto-increment row.
	lastErrno ()
	Get the last error number.
	lastError ()
	Get a description of the last error.
	numFields ( $res)
	Get the number of fields in a result object.
	numRows ( $res)
	Get the number of rows in a result object.
	open ( $server, $user, $password, $dbName)
	Open a connection to the database.
	selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[])
	A SELECT wrapper which returns a list of single field values from result rows.

Static Public Member Functions
static	factory ( $dbType, $p=[])
	Construct a Database subclass instance given a database type and parameters.
static	getCacheSetOptions (IDatabase $db1)
	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.

Public Attributes
const	DEADLOCK_DELAY_MAX = 1500000
	Maximum time to wait before retry.
const	DEADLOCK_DELAY_MIN = 500000
	Minimum time to wait before retry, in microseconds.
const	DEADLOCK_TRIES = 4
	Number of times to re-try an operation in case of deadlock.
const	PING_QUERY = 'SELECT 1 AS ping'
const	PING_TTL = 1.0
	How long before it is worth doing a dummy query to test the connection.
const	SLOW_WRITE_SEC = .500
const	SMALL_WRITE_ROWS = 100
const	TINY_WRITE_SEC = .010

Protected Member Functions
	assertOpen ()
	Make sure isOpen() returns true as a sanity check.
	closeConnection ()
	Closes underlying database connection.
	doBegin ( $fname)
	Issues the BEGIN command to the database server.
	doCommit ( $fname)
	Issues the COMMIT command to the database server.
	doQuery ( $sql)
	The DBMS-dependent part of query()
	doRollback ( $fname)
	Issues the ROLLBACK command to the database server.
	escapeLikeInternal ( $s)
	fieldNamesWithAlias ( $fields)
	Gets an array of aliased field names.
	fieldNameWithAlias ( $name, $alias=false)
	Get an aliased field name e.g.
	getApproximateLagStatus ()
	Get a replica DB lag estimate for this server.
	getBindingHandle ()
	Get the underlying binding handle, mConn.
	getDefaultSchemaVars ()
	Get schema variables to use if none have been set via setSchemaVars().
	getLastPHPError ()
	getLazyMasterHandle ()
	getLogContext (array $extras=[])
	Create a log context to pass to PSR-3 logger functions.
	getQueryVerb ( $sql)
	getReadOnlyReason ()
	getSchemaVars ()
	Get schema variables.
	getTransactionLagStatus ()
	Get the replica DB lag when the current transaction started.
	ignoreErrors ( $ignoreErrors=null)
	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.
	indexName ( $index)
	Get the name of an index in a given table.
	installErrorHandler ()
	isTransactableQuery ( $sql)
	Determine whether a SQL statement is sensitive to isolation level.
	isWriteQuery ( $sql)
	Determine whether a query writes to the DB.
	makeGroupByWithHaving ( $options)
	Returns an optional GROUP BY with an optional HAVING.
	makeInsertOptions ( $options)
	Helper for Database::insert().
	makeOrderBy ( $options)
	Returns an optional ORDER BY.
	makeSelectOptions ( $options)
	Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.
	makeUpdateOptions ( $options)
	Make UPDATE options for the Database::update function.
	makeUpdateOptionsArray ( $options)
	Make UPDATE options array for Database::makeUpdateOptions.
	nativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
	nativeReplace ( $table, $rows, $fname)
	REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement.
	pendingWriteAndCallbackCallers ()
	reconnect ()
	registerTempTableOperation ( $sql)
	replaceVars ( $ins)
	Database independent variable replacement.
	requiresDatabaseUser ()
	restoreErrorHandler ()
	resultObject ( $result)
	Take the result from a query, and wrap it in a ResultWrapper if necessary.
	tableNamesWithAlias ( $tables)
	Gets an array of aliased table names.
	tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[])
	Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause.
	tableNameWithAlias ( $name, $alias=false)
	Get an aliased table name e.g.

Static Protected Member Functions
static	generalizeSQL ( $sql)
	Removes most variables from an SQL query and replaces them with X or N for numbers.

Protected Attributes
string	$agent
	Agent name for query profiling.
bool	$cliMode
	Whether this PHP instance is for a CLI script.
LoggerInterface	$connLogger
DatabaseDomain	$currentDomain
string	$delimiter = ';'
callback	$errorLogger
	Error logging callback.
string bool null	$htmlErrors
	Stashed value of html_errors INI setting.
float	$lastPing = 0.0
	UNIX timestamp.
resource null	$mConn = null
	Database connection.
string	$mDBname
bool null	$mDefaultBigSelects = null
integer	$mFlags
string	$mLastQuery = ''
	SQL query.
float bool	$mLastWriteTime = false
	UNIX timestamp of last write query.
array	$mLBInfo = []
bool	$mOpened = false
string	$mPassword
string bool	$mPHPError = false
string	$mSchema = ''
array bool	$mSchemaVars = false
string	$mServer
array	$mSessionTempTables = []
	Map of (table name => 1) for TEMPORARY tables.
array	$mSessionVars = []
string	$mTablePrefix = ''
array[]	$mTrxEndCallbacks = []
	List of (callable, method name)
bool	$mTrxEndCallbacksSuppressed = false
	Whether to suppress triggering of transaction end callbacks.
array[]	$mTrxIdleCallbacks = []
	List of (callable, method name)
int	$mTrxLevel = 0
	Either 1 if a transaction is active or 0 otherwise.
array[]	$mTrxPreCommitCallbacks = []
	List of (callable, method name)
callable[]	$mTrxRecurringCallbacks = []
	Map of (name => callable)
string	$mTrxShortId = ''
	Either a short hexidecimal string if a transaction is active or "".
string	$mUser
array null	$preparedArgs
object string	$profiler
	Class name or object With profileIn/profileOut methods.
LoggerInterface	$queryLogger
BagOStuff	$srvCache
	APC cache.
	$tableAliases = []
TransactionProfiler	$trxProfiler

Private Member Functions
	canRecoverFromDisconnect ( $sql, $priorWritesPending)
	doProfiledQuery ( $sql, $commentedSql, $isWrite, $fname)
	handleSessionLoss ()
	prependDatabaseOrSchema ( $namespace, $relation, $format)
	updateTrxWriteQueryTime ( $sql, $runtime)
	Update the estimated run-time of a query, not counting large row lock times.

Private Attributes
IDatabase null	$lazyMasterHandle
	Lazy handle to the master DB this server replicates from.
array	$mNamedLocksHeld = []
	Map of (name => 1) for locks obtained via lock()
float	$mRTTEstimate = 0.0
	RTT time estimate.
array	$mTrxAtomicLevels = []
	Array of levels of atomicity within transactions.
bool	$mTrxAutomatic = false
	Record if the current transaction was started implicitly due to DBO_TRX being set.
bool	$mTrxAutomaticAtomic = false
	Record if the current transaction was started implicitly by Database::startAtomic.
bool	$mTrxDoneWrites = false
	Record if possible write queries were done in the last transaction started.
string	$mTrxFname = null
	Remembers the function name given for starting the most recent transaction via begin().
float	$mTrxReplicaLag = null
	Lag estimate at the time of BEGIN.
float null	$mTrxTimestamp = null
	The UNIX time that the transaction started.
float	$mTrxWriteAdjDuration = 0.0
	Like mTrxWriteQueryCount but excludes lock-bound, easy to replicate, queries.
integer	$mTrxWriteAdjQueryCount = 0
	Number of write queries counted in mTrxWriteAdjDuration.
string[]	$mTrxWriteCallers = []
	Track the write query callers of the current transaction.
float	$mTrxWriteDuration = 0.0
	Seconds spent in write queries for the current transaction.
integer	$mTrxWriteQueryCount = 0
	Number of write queries for the current transaction.
int[]	$priorFlags = []
	Prior mFlags values.

Detailed Description

Relational database abstraction object.

Since

1.28

Examples

/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 36 of file Database.php.

Constructor & Destructor Documentation

__construct()

Database::__construct

(

array

$params

)

Constructor and database handle and attempt to connect to the DB server.

IDatabase classes should not be constructed directly in external code. Database::factory() should be used instead.

Parameters

array

$params

Parameters passed from Database::factory()

Reimplemented in DatabaseSqlite, DatabaseMysqlBase, and DatabasePostgres.

Definition at line 234 of file Database.php.

References $params, $user, DBO_TRX, DatabaseDomain\newUnspecified(), IDatabase\open(), and requiresDatabaseUser().

__destruct()

Database::__destruct

(

)

Run a few simple sanity checks and close dangling connections.

Definition at line 3472 of file Database.php.

References closeConnection(), and pendingWriteAndCallbackCallers().

Member Function Documentation

__clone()

Database::__clone

(

)

Make sure that copies do not share the same client binding handle.

Exceptions

DBConnectionError

Definition at line 3442 of file Database.php.

References handleSessionLoss(), isOpen(), and IDatabase\open().

__sleep()

Database::__sleep

(

)

Called by serialize.

Throw an exception when DB connection is serialized. This causes problems on some database engines because the connection is not restored on unserialize.

Definition at line 3464 of file Database.php.

__toString()

Database::__toString

(

)

Since

1.19

Returns

string

Reimplemented in DatabaseMysqli, and DatabaseSqlite.

Definition at line 3434 of file Database.php.

addIdentifierQuotes()

Database::addIdentifierQuotes

(

$s

)

Quotes an identifier using backticks or "double quotes" depending on the database type.

MySQL uses backticks while basically everything else uses double quotes. Since MySQL is the odd one out here the double quotes are our generic and we implement backticks in DatabaseMysql.

Parameters

string

$s

Returns

string

Reimplemented in DatabaseMysqlBase, and DatabaseTestHelper.

Definition at line 1998 of file Database.php.

References $s.

Referenced by DatabasePostgres\determineCoreSchema(), DatabasePostgres\duplicateTableStructure(), DatabaseSqlite\duplicateTableStructure(), fieldNameWithAlias(), prependDatabaseOrSchema(), replaceVars(), selectRowCount(), tableName(), tableNameWithAlias(), DatabaseMysqlBaseTest\testAddIdentifierQuotes(), LBFactoryTest\testNiceDomains(), and LBFactoryTest\testTrickyDomain().

addQuotes()

Database::addQuotes

(

$s

)

Adds quotes and backslashes.

Parameters

string | int | null | bool | Blob

$s

Returns

string|int

Implements IDatabase.

Reimplemented in DatabaseMysqlBase, DatabasePostgres, and DatabaseSqlite.

Definition at line 1972 of file Database.php.

References $s, and strencode().

Referenced by buildGroupConcatField(), PopulateRecentChangesSource\buildUpdateCondition(), RefreshImageMetadata\execute(), RefreshImageMetadata\getConditions(), makeList(), PopulateContentModel\populatePage(), PopulateContentModel\populateRevisionOrArchive(), replace(), and replaceVars().

aggregateValue()

Database::aggregateValue	(		$valuedata,
			$valuename = 'value'
	)

Return aggregated value alias.

Parameters

array	$valuedata
string	$valuename

Returns

string

Implements IDatabase.

Reimplemented in DatabasePostgres.

Definition at line 1647 of file Database.php.

anyChar()

Database::anyChar

(

)

Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.

Returns

LikeMatch

Implements IDatabase.

Definition at line 2043 of file Database.php.

anyString()

Database::anyString

(

)

Returns a token for buildLike() that denotes a '' to be used in a LIKE query.

Returns

LikeMatch

Implements IDatabase.

Definition at line 2047 of file Database.php.

Referenced by RefreshImageMetadata\getConditions().

assertOpen()

Database::assertOpen ( )

protected

Make sure isOpen() returns true as a sanity check.

Exceptions

DBUnexpectedError

Definition at line 728 of file Database.php.

References isOpen().

Referenced by begin(), commit(), query(), and rollback().

begin()

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

DBError

Implements IDatabase.

Definition at line 2692 of file Database.php.

References $fname, $status, assertOpen(), doBegin(), getApproximateLagStatus(), and getFlag().

Referenced by SavepointPostgres\__construct(), DatabaseTest\badLockingMethodExplicit(), DatabasePostgres\determineCoreSchema(), DatabaseTest\testTransactionListener(), and DatabaseTest\testTransactionResolution().

bitAnd()

Database::bitAnd	(		$fieldLeft,
			$fieldRight
	)

Parameters

string	$fieldLeft
string	$fieldRight

Returns

string

Implements IDatabase.

Definition at line 1655 of file Database.php.

bitNot()

Database::bitNot

(

$field

)

Parameters

string

$field

Returns

string

Implements IDatabase.

Definition at line 1651 of file Database.php.

bitOr()

Database::bitOr	(		$fieldLeft,
			$fieldRight
	)

Parameters

string	$fieldLeft
string	$fieldRight

Returns

string

Implements IDatabase.

Definition at line 1659 of file Database.php.

bufferResults()

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

Definition at line 406 of file Database.php.

References $buffer, $res, clearFlag(), getFlag(), and setFlag().

Referenced by DatabaseMysql\doQuery().

buildConcat()

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

Reimplemented in DatabasePostgres, and DatabaseSqlite.

Definition at line 1663 of file Database.php.

buildGroupConcatField()

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

Reimplemented in DatabaseSqlite.

Definition at line 1667 of file Database.php.

References addQuotes(), and selectSQLText().

buildLike()

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

Reimplemented in DatabaseSqlite.

Definition at line 2023 of file Database.php.

References $params, $s, $value, as, and escapeLikeInternal().

Referenced by RefreshImageMetadata\getConditions(), and DatabaseMysqlBase\tableExists().

buildStringCast()

Database::buildStringCast

(

$field

)

Parameters

string

$field

Field or column to cast

Returns

string

Since

1.28

Implements IDatabase.

Reimplemented in DatabasePostgres, and DatabaseSqlite.

Definition at line 1675 of file Database.php.

canRecoverFromDisconnect()

Database::canRecoverFromDisconnect (   $sql,   $priorWritesPending  )

private

Definition at line 1001 of file Database.php.

References explicitTrxActive().

Referenced by query().

clearFlag()

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

Reimplemented in FakeDatabase.

Definition at line 588 of file Database.php.

Referenced by bufferResults(), ignoreErrors(), ping(), runOnTransactionIdleCallbacks(), DatabaseTest\testFlagSetting(), DatabaseTest\testGetScopedLock(), DatabaseTest\testTransactionIdle(), and DatabaseTest\testTransactionResolution().

close()

Database::close

(

)

Closes a database connection.

if it is open : commits any open transactions

Exceptions

DBError

Returns

bool Operation success. true if already closed.

Implements IDatabase.

Definition at line 705 of file Database.php.

References closeConnection(), commit(), and trxLevel().

Referenced by DatabaseSqlite\open(), DatabaseMysqlBase\open(), DatabasePostgres\open(), DatabaseSqliteTest\testInsertIdType(), DatabaseSqliteTest\testNumFields(), and DatabaseSqliteTest\testUpgrades().

closeConnection()

Database::closeConnection ( )

abstractprotected

Closes underlying database connection.

Since

1.20

Returns

bool Whether connection was closed successfully

Reimplemented in DatabaseMysql, DatabaseMysqli, DatabasePostgres, DatabaseSqlite, FakeDatabaseMysqlBase, DatabaseTestHelper, and FakeDatabase.

Referenced by __destruct(), close(), and reconnect().

commit()

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

DBUnexpectedError

Implements IDatabase.

Definition at line 2752 of file Database.php.

References $fname, assertOpen(), doCommit(), pendingWriteQueryDuration(), runOnTransactionIdleCallbacks(), runOnTransactionPreCommitCallbacks(), and runTransactionListenerCallbacks().

Referenced by DatabasePostgres\determineCoreSchema(), DatabaseTest\testTransactionListener(), and DatabaseTest\testTransactionResolution().

conditional()

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

Definition at line 2393 of file Database.php.

References makeList().

connectionErrorLogger()

Database::connectionErrorLogger	(		$errno,
			$errstr
	)

This method should not be used outside of Database classes.

Parameters

int	$errno
string	$errstr

Definition at line 684 of file Database.php.

dbSchema()

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

Definition at line 460 of file Database.php.

deadlockLoop()

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

Implements IMaintainableDatabase.

Reimplemented in DatabaseSqlite.

Definition at line 2435 of file Database.php.

References $args, $e, begin(), commit(), rollback, and wasDeadlock().

decodeBlob()

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

Reimplemented in DatabasePostgres, and DatabaseSqlite.

Definition at line 3068 of file Database.php.

decodeExpiry()

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

Definition at line 3371 of file Database.php.

References ConvertibleTimestamp\convert(), and getInfinity().

delete()

Database::delete	(		$table,
			$conds,
			$fname = __METHOD__
	)

DELETE query wrapper.

Parameters

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

DBUnexpectedError

Returns

bool|ResultWrapper

Implements IDatabase.

Examples

/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 2254 of file Database.php.

References $fname, makeList(), query(), and tableName().

Referenced by MediaWikiTestCase\resetDB().

deleteJoin()

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

DBUnexpectedError

Implements IDatabase.

Reimplemented in DatabaseMysqlBase.

Definition at line 2219 of file Database.php.

References $fname, makeList(), query(), and tableName().

Referenced by DatabaseSqliteTest\testDeleteJoin().

doAtomicSection()

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

Definition at line 2679 of file Database.php.

References $e, $fname, $res, endAtomic(), rollback, and startAtomic().

doBegin()

Database::doBegin (   $fname )

protected

Issues the BEGIN command to the database server.

See also

Database::begin()

Parameters

string

$fname

Reimplemented in DatabaseSqlite.

Definition at line 2747 of file Database.php.

References $fname, and query().

Referenced by begin().

doCommit()

Database::doCommit (   $fname )

protected

Issues the COMMIT command to the database server.

See also

Database::commit()

Parameters

string

$fname

Definition at line 2806 of file Database.php.

References $fname, and query().

Referenced by commit().

doneWrites()

Database::doneWrites

(

)

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

Should return true if unsure.

Returns

bool

Implements IDatabase.

Definition at line 514 of file Database.php.

doProfiledQuery()

Database::doProfiledQuery (   $sql,   $commentedSql,   $isWrite,   $fname  )

private

Definition at line 920 of file Database.php.

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

Referenced by query().

doQuery()

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 DatabaseMysql, DatabasePostgres, DatabaseSqlite, FakeDatabaseMysqlBase, DatabaseTestHelper, and FakeDatabase.

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

doRollback()

Database::doRollback (   $fname )

protected

Issues the ROLLBACK command to the database server.

See also

Database::rollback()

Parameters

string

$fname

Definition at line 2853 of file Database.php.

References $fname, and query().

Referenced by rollback().

dropTable()

Database::dropTable	(		$tableName,
			$fName = __METHOD__
	)

Delete a table.

Parameters

string	$tableName
string	$fName

Returns

bool|ResultWrapper

Since

1.18

Implements IMaintainableDatabase.

Reimplemented in DatabaseMysqlBase, and DatabaseSqlite.

Definition at line 3352 of file Database.php.

References query(), tableExists(), and tableName().

duplicateTableStructure()

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

Exceptions

RuntimeException

Returns

bool True if operation was successful

Reimplemented in DatabaseMysqlBase, DatabasePostgres, and DatabaseSqlite.

Definition at line 2894 of file Database.php.

encodeBlob()

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

Implements IDatabase.

Reimplemented in DatabasePostgres, and DatabaseSqlite.

Definition at line 3064 of file Database.php.

encodeExpiry()

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

Definition at line 3365 of file Database.php.

References getInfinity(), and timestamp().

endAtomic()

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

DBError

Implements IDatabase.

Definition at line 2664 of file Database.php.

References $fname, and commit().

Referenced by doAtomicSection(), and onTransactionPreCommitOrIdle().

escapeLikeInternal()

Database::escapeLikeInternal (   $s )

protected

Parameters

string

$s

Returns

string

Definition at line 2019 of file Database.php.

References $s.

Referenced by buildLike().

estimateRowCount()

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

Reimplemented in DatabaseMysqlBase, and DatabasePostgres.

Definition at line 1337 of file Database.php.

References $fname, $options, $res, IDatabase\fetchRow(), and select().

explicitTrxActive()

Database::explicitTrxActive

(

)

Returns

bool Whether an explicit transaction or atomic sections are still open

Since

1.28

Implements IDatabase.

Definition at line 2875 of file Database.php.

Referenced by canRecoverFromDisconnect(), flushSnapshot(), and query().

factory()

static 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 325 of file Database.php.

References $e, and as.

Referenced by DatabaseSqliteMock\newInstance(), and DatabaseSqlite\newStandaloneInstance().

fieldExists()

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

Definition at line 1399 of file Database.php.

References IDatabase\fieldInfo().

fieldNamesWithAlias()

Database::fieldNamesWithAlias (   $fields )

protected

Gets an array of aliased field names.

Parameters

array

$fields

[ [alias] => field ]

Returns

string[] See fieldNameWithAlias()

Definition at line 1860 of file Database.php.

References $retval, as, and fieldNameWithAlias().

Referenced by selectSQLText().

fieldNameWithAlias()

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 1846 of file Database.php.

References $name, and addIdentifierQuotes().

Referenced by fieldNamesWithAlias(), and insertSelect().

flushSnapshot()

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

DBUnexpectedError

Since

1.28

Implements IDatabase.

Definition at line 2862 of file Database.php.

References $fname, commit(), explicitTrxActive(), pendingWriteAndCallbackCallers(), and writesOrCallbacksPending().

Referenced by LoadBalancer\beginMasterChanges(), and DatabaseTest\testFlushSnapshot().

freeResult()

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

Reimplemented in DatabaseMysqlBase, DatabasePostgres, and DatabaseSqlite.

Definition at line 1058 of file Database.php.

generalizeSQL()

static 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 1377 of file Database.php.

getApproximateLagStatus()

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

Definition at line 3014 of file Database.php.

References getLag(), and getLBInfo().

Referenced by begin(), and getSessionLagStatus().

getBindingHandle()

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

DBUnexpectedError

Since

1.26

Definition at line 3419 of file Database.php.

Referenced by DatabasePostgres\addQuotes(), DatabaseMysql\affectedRows(), DatabaseMysqli\affectedRows(), DatabaseMysql\closeConnection(), DatabaseMysqli\closeConnection(), DatabaseMysql\doQuery(), DatabasePostgres\doQuery(), DatabasePostgres\fetchObject(), DatabasePostgres\fetchRow(), DatabasePostgres\getServerVersion(), DatabasePostgres\hasConstraint(), DatabaseMysql\insertId(), DatabaseMysqli\insertId(), DatabaseMysql\mysqlRealEscapeString(), DatabaseMysqli\mysqlRealEscapeString(), DatabaseMysql\mysqlSetCharset(), DatabaseMysqli\mysqlSetCharset(), DatabasePostgres\numRows(), DatabaseMysql\selectDB(), DatabaseMysqli\selectDB(), and DatabasePostgres\strencode().

getCacheSetOptions()

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

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 3039 of file Database.php.

References $res, $status, as, and false.

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

getDBname()

Database::getDBname

(

)

Get the current DB name.

Returns

string

Implements IDatabase.

Reimplemented in DatabasePostgres.

Definition at line 1688 of file Database.php.

getDefaultSchemaVars()

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 3263 of file Database.php.

Referenced by getSchemaVars().

getDomainID()

Database::getDomainID

(

)

Returns

string

Implements IDatabase.

Definition at line 621 of file Database.php.

Referenced by getWikiID(), LBFactoryTest\testNiceDomains(), and LBFactoryTest\testTrickyDomain().

getFlag()

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

Definition at line 608 of file Database.php.

Referenced by begin(), bufferResults(), ignoreErrors(), query(), rollback(), runOnTransactionIdleCallbacks(), startAtomic(), DatabaseTest\testFlagSetting(), DatabaseTest\testTransactionIdle(), and DatabaseTest\testTransactionResolution().

getInfinity()

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

Definition at line 3361 of file Database.php.

Referenced by decodeExpiry(), and encodeExpiry().

getLag()

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

Reimplemented in DatabaseMysqlBase.

Definition at line 3056 of file Database.php.

Referenced by getApproximateLagStatus(), and DatabaseMysqlBaseTest\testPtHeartbeat().

getLastPHPError()

Database::getLastPHPError ( )

protected

Returns

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

Definition at line 667 of file Database.php.

Referenced by DatabasePostgres\lastError(), and restoreErrorHandler().

getLazyMasterHandle()

Database::getLazyMasterHandle ( )

protected

Returns

IDatabase|null

See also

setLazyMasterHandle()

Since

1.27

Definition at line 498 of file Database.php.

Referenced by DatabaseMysqlBase\getMasterServerInfo().

getLBInfo()

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

Definition at line 469 of file Database.php.

References $name.

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

getLogContext()

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 694 of file Database.php.

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

getMasterPos()

Database::getMasterPos

(

)

Get the position of this master.

Returns

DBMasterPos|bool False if this is not a master

Implements IDatabase.

Reimplemented in DatabaseMysqlBase.

Definition at line 2481 of file Database.php.

getProperty()

Database::getProperty

(

$name

)

Parameters

string

$name

Class field name

Returns

mixed

Deprecated:

Since 1.28

Definition at line 617 of file Database.php.

getQueryVerb()

Database::getQueryVerb (   $sql )

protected

Parameters

$sql

Returns

string|null

Definition at line 776 of file Database.php.

Referenced by isTransactableQuery(), and updateTrxWriteQueryTime().

getReadOnlyReason()

Database::getReadOnlyReason ( )

protected

Returns

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

Definition at line 3390 of file Database.php.

References getLBInfo().

Referenced by isReadOnly(), and query().

getReplicaPos()

Database::getReplicaPos

(

)

Get the replication position of this replica DB.

Returns

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

Implements IDatabase.

Reimplemented in DatabaseMysqlBase.

Definition at line 2476 of file Database.php.

getSchemaVars()

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 3247 of file Database.php.

References getDefaultSchemaVars().

Referenced by replaceVars().

getScopedLockAndFlush()

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

DBUnexpectedError

Since

1.27

Implements IDatabase.

Definition at line 3283 of file Database.php.

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

Referenced by DatabaseTest\badLockingMethodExplicit(), and DatabaseTest\badLockingMethodImplicit().

getSearchEngine()

Database::getSearchEngine

(

)

Deprecated:

since 1.28 use SearchEngineFactory::getSearchEngineClass instead

Returns

string

Implements IDatabase.

Definition at line 3498 of file Database.php.

References wfDeprecated().

getServer()

Database::getServer

(

)

Get the server hostname or IP address.

Returns

string

Implements IDatabase.

Reimplemented in DatabasePostgres.

Definition at line 1692 of file Database.php.

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

getServerInfo()

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

Reimplemented in DatabaseTestHelper.

Definition at line 402 of file Database.php.

References IDatabase\getServerVersion().

getServerUptime()

Database::getServerUptime

(

)

Determines how long the server has been up.

Returns

int

Implements IDatabase.

Reimplemented in DatabaseMysqlBase.

Definition at line 2405 of file Database.php.

getSessionLagStatus()

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

Definition at line 2987 of file Database.php.

References getApproximateLagStatus(), and getTransactionLagStatus().

getTransactionLagStatus()

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 3002 of file Database.php.

References trxTimestamp().

Referenced by getSessionLagStatus().

getWikiID()

Database::getWikiID ( )

final

Alias for getDomainID()

Returns

string

Implements IDatabase.

Definition at line 625 of file Database.php.

References getDomainID().

handleSessionLoss()

Database::handleSessionLoss ( )

private

Definition at line 1021 of file Database.php.

References $e, runOnTransactionIdleCallbacks(), and runTransactionListenerCallbacks().

Referenced by __clone(), and query().

ignoreErrors()

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 429 of file Database.php.

References $res, clearFlag(), getFlag(), and setFlag().

Referenced by reportQueryError(), DatabasePostgres\reportQueryError(), and tableExists().

ignoreIndexClause()

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

Definition at line 2079 of file Database.php.

Referenced by makeSelectOptions(), and tableNamesWithIndexClauseOrJOIN().

implicitGroupby()

Database::implicitGroupby

(

)

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

Returns

bool

Implements IDatabase.

Reimplemented in DatabasePostgres, and DatabaseSqlite.

Definition at line 502 of file Database.php.

implicitOrderby()

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

Reimplemented in DatabasePostgres.

Definition at line 506 of file Database.php.

indexExists()

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

Definition at line 1405 of file Database.php.

References $fname, indexInfo(), and tableExists().

indexInfo()

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 DatabaseTestHelper, DatabaseMysqlBase, DatabasePostgres, DatabaseSqlite, and FakeDatabase.

Referenced by indexExists(), and indexUnique().

indexName()

Database::indexName (   $index )

protected

Get the name of an index in a given table.

Parameters

string

$index

Returns

string

Reimplemented in DatabaseSqlite.

Definition at line 1957 of file Database.php.

Referenced by DatabaseMysqlBase\ignoreIndexClause(), DatabaseMysqlBase\indexInfo(), DatabasePostgres\indexUnique(), replaceVars(), and DatabaseMysqlBase\useIndexClause().

indexUnique()

Database::indexUnique	(		$table,
			$index
	)

Determines if a given index is unique.

Parameters

string	$table
string	$index

Returns

bool

Implements IDatabase.

Definition at line 1432 of file Database.php.

References indexInfo().

insert()

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

Reimplemented in DatabaseSqlite, FakeDatabase, and DatabasePostgres.

Definition at line 1452 of file Database.php.

References $fname, $keys, $options, as, makeInsertOptions(), makeList(), query(), and tableName().

insertSelect()

Database::insertSelect	(		$destTable,
			$srcTable,
			$varMap,
			$conds,
			$fname = __METHOD__,
			$insertOptions = [],
			$selectOptions = []
	)

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.

Returns

ResultWrapper

Implements IDatabase.

Definition at line 2272 of file Database.php.

References $fname, $res, array(), as, fieldNameWithAlias(), insert, nativeInsertSelect(), and select().

installErrorHandler()

Database::installErrorHandler ( )

protected

Definition at line 646 of file Database.php.

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

isOpen()

Database::isOpen

(

)

Is a connection to the database open?

Returns

bool

Implements IDatabase.

Reimplemented in DatabaseTestHelper.

Definition at line 577 of file Database.php.

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

isQuotedIdentifier()

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

Definition at line 2011 of file Database.php.

References $name.

Referenced by prependDatabaseOrSchema(), and tableName().

isReadOnly()

Database::isReadOnly

(

)

Returns

bool Whether this DB is read-only

Since

1.27

Implements IDatabase.

Definition at line 3383 of file Database.php.

References getReadOnlyReason().

isTransactableQuery()

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 789 of file Database.php.

References getQueryVerb().

Referenced by query().

isWriteQuery()

Database::isWriteQuery (   $sql )

protected

Determine whether a query writes to the DB.

Should return true if unsure.

Parameters

string

$sql

Returns

bool

Reimplemented in DatabaseSqlite.

Definition at line 767 of file Database.php.

Referenced by query().

lastDoneWrites()

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

Definition at line 518 of file Database.php.

lastQuery()

Database::lastQuery

(

)

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

Returns

string

Implements IDatabase.

Definition at line 510 of file Database.php.

Referenced by DatabaseSqliteMock\query().

limitResult()

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

DBUnexpectedError

Returns

string

Reimplemented in DatabasePostgres.

Definition at line 2372 of file Database.php.

References $limit.

Referenced by selectSQLText().

listTables()

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

DBError

Returns

array

Implements IDatabase.

Reimplemented in DatabaseMysqlBase, DatabasePostgres, and DatabaseSqlite.

Examples

/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 2900 of file Database.php.

Referenced by MediaWikiTestCase\listTables().

listViews()

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

Implements IMaintainableDatabase.

Reimplemented in DatabaseMysqlBase.

Examples

/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 2904 of file Database.php.

Referenced by MediaWikiTestCase\listTables(), and DatabaseMysqlBaseTest\testListviews().

lock()

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

Reimplemented in DatabaseMysqlBase, DatabasePostgres, and DatabaseSqlite.

Definition at line 3271 of file Database.php.

Referenced by getScopedLockAndFlush().

lockIsFree()

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

Reimplemented in DatabaseMysqlBase, and DatabasePostgres.

Definition at line 3267 of file Database.php.

Referenced by DatabaseTest\testGetScopedLock().

lockTables()

Database::lockTables	(		$read,
			$write,
			$method,
			$lowPriority = true
	)

Lock specific tables.

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
bool	$lowPriority	Whether to indicate writes to be LOW PRIORITY

Returns

bool

Reimplemented in DatabaseMysqlBase.

Definition at line 3331 of file Database.php.

makeGroupByWithHaving()

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 1212 of file Database.php.

References $options, and makeList().

Referenced by makeSelectOptions(), and DatabasePostgres\makeSelectOptions().

makeInsertOptions()

Database::makeInsertOptions (   $options )

protected

Helper for Database::insert().

Parameters

array

$options

Returns

string

Reimplemented in DatabaseSqlite.

Definition at line 1448 of file Database.php.

References $options.

Referenced by insert(), and nativeInsertSelect().

makeList()

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

DBError

Returns

string

Implements IDatabase.

Definition at line 1548 of file Database.php.

References $value, addQuotes(), as, and makeList().

Referenced by conditional(), delete(), deleteJoin(), DatabaseMysqlBase\deleteJoin(), DatabaseMysqlBase\getHeartbeatData(), insert(), DatabasePostgres\insert(), makeGroupByWithHaving(), makeList(), makeWhereFrom2d(), nativeInsertSelect(), DatabasePostgres\nativeInsertSelect(), nativeReplace(), selectSQLText(), tableNamesWithIndexClauseOrJOIN(), update(), upsert(), and DatabaseMysqlBase\upsert().

makeOrderBy()

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 1238 of file Database.php.

References $options.

Referenced by makeSelectOptions(), and DatabasePostgres\makeSelectOptions().

makeSelectOptions()

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 DatabasePostgres, and DatabaseSqlite.

Definition at line 1123 of file Database.php.

References $options, as, ignoreIndexClause(), makeGroupByWithHaving(), makeOrderBy(), and useIndexClause().

Referenced by nativeInsertSelect(), and selectSQLText().

makeUpdateOptions()

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 1530 of file Database.php.

References $options, and makeUpdateOptionsArray().

Referenced by update().

makeUpdateOptionsArray()

Database::makeUpdateOptionsArray (   $options )

protected

Make UPDATE options array for Database::makeUpdateOptions.

Parameters

array

$options

Returns

array

Reimplemented in DatabaseSqlite.

Definition at line 1510 of file Database.php.

References $options.

Referenced by makeUpdateOptions().

makeWhereFrom2d()

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

Definition at line 1628 of file Database.php.

References $base, as, and makeList().

masterPosWait()

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

Reimplemented in DatabaseMysqlBase.

Definition at line 2471 of file Database.php.

maxListLen()

Database::maxListLen

(

)

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

Returns

int

Implements IDatabase.

Definition at line 3060 of file Database.php.

namedLocksEnqueue()

Database::namedLocksEnqueue

(

)

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

Returns

bool

Since

1.26

Implements IDatabase.

Reimplemented in DatabaseMysqlBase.

Definition at line 3318 of file Database.php.

nativeInsertSelect()

Database::nativeInsertSelect (   $destTable,   $srcTable,   $varMap,   $conds,   $fname = __METHOD__,   $insertOptions = [],   $selectOptions = []  )

protected

Reimplemented in DatabasePostgres.

Definition at line 2311 of file Database.php.

References $fname, list, makeInsertOptions(), makeList(), makeSelectOptions(), query(), and tableName().

Referenced by insertSelect().

nativeReplace()

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

Reimplemented in DatabaseTestHelper.

Definition at line 2141 of file Database.php.

References $fname, as, makeList(), query(), and tableName().

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

nextSequenceValue()

Database::nextSequenceValue

(

$seqName

)

Returns an appropriately quoted sequence value for inserting a new row.

MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL subclass will return an integer, and save the value for insertId()

Any implementation of this function should not involve reusing sequence numbers created for rolled-back transactions. See http://bugs.mysql.com/bug.php?id=30767 for details.

Parameters

string

$seqName

Returns

null|int

Implements IDatabase.

Reimplemented in DatabasePostgres.

Definition at line 2051 of file Database.php.

onTransactionIdle()

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

Definition at line 2497 of file Database.php.

References $fname, and runOnTransactionIdleCallbacks().

Referenced by DatabaseTest\testTransactionIdle().

onTransactionPreCommitOrIdle()

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

Definition at line 2504 of file Database.php.

References $e, $fname, endAtomic(), rollback, and startAtomic().

onTransactionResolution()

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

Definition at line 2490 of file Database.php.

References $fname.

Referenced by getScopedLockAndFlush(), and DatabaseTest\testTransactionResolution().

pendingWriteAndCallbackCallers()

Database::pendingWriteAndCallbackCallers ( )

protected

Definition at line 558 of file Database.php.

References as.

Referenced by __destruct(), flushSnapshot(), and getScopedLockAndFlush().

pendingWriteCallers()

Database::pendingWriteCallers

(

)

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

Returns

array

Since

1.27

Implements IDatabase.

Definition at line 554 of file Database.php.

pendingWriteQueryDuration()

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

Definition at line 532 of file Database.php.

References $type, and ping().

Referenced by commit().

ping()

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

Reimplemented in DatabaseTestHelper.

Definition at line 2948 of file Database.php.

References clearFlag(), false, isOpen(), query(), and restoreFlags().

Referenced by pendingWriteQueryDuration().

prependDatabaseOrSchema()

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 1771 of file Database.php.

References addIdentifierQuotes(), and isQuotedIdentifier().

Referenced by tableName().

query()

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

DBError

Returns

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

Implements IDatabase.

Reimplemented in DatabaseSqliteMock, and DatabaseTestHelper.

Examples

/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 829 of file Database.php.

References $fname, $res, $ret, assertOpen(), begin(), canRecoverFromDisconnect(), doProfiledQuery(), explicitTrxActive(), getFlag(), getReadOnlyReason(), handleSessionLoss(), isTransactableQuery(), isWriteQuery(), IDatabase\lastErrno(), IDatabase\lastError(), reconnect(), registerTempTableOperation(), reportQueryError(), resultObject(), wasDeadlock(), wasErrorReissuable(), and writesOrCallbacksPending().

Referenced by DatabaseSqlite\attachDatabase(), DatabaseTest\badLockingMethodImplicit(), DatabaseSqlite\checkForEnabledSearch(), DatabasePostgres\constraintExists(), DatabasePostgres\currentSequenceValue(), delete(), deleteJoin(), DatabaseMysqlBase\deleteJoin(), doBegin(), DatabaseSqlite\doBegin(), doCommit(), doRollback(), dropTable(), DatabaseMysqlBase\dropTable(), DatabaseSqlite\dropTable(), DatabaseMysqlBase\duplicateTableStructure(), DatabasePostgres\duplicateTableStructure(), DatabaseSqlite\duplicateTableStructure(), DatabaseMysqlBase\fieldInfo(), DatabaseSqlite\fieldInfo(), PostgresField\fromText(), DatabasePostgres\getCurrentSchema(), DatabaseMysqlBase\getHeartbeatData(), DatabaseMysqlBase\getLagFromSlaveStatus(), DatabaseMysqlBase\getMasterPos(), DatabaseMysqlBase\getMysqlStatus(), DatabaseMysqlBase\getReplicaPos(), DatabasePostgres\getSchemas(), DatabasePostgres\getSearchPath(), DatabasePostgres\indexAttributes(), DatabaseMysqlBase\indexInfo(), DatabasePostgres\indexInfo(), DatabaseSqlite\indexInfo(), DatabasePostgres\indexUnique(), insert(), DatabasePostgres\insert(), DatabaseMysqlBase\listTables(), DatabasePostgres\listTables(), DatabaseMysqlBase\listViews(), DatabaseMysqlBase\lock(), DatabasePostgres\lock(), DatabaseMysqlBase\lockIsFree(), DatabasePostgres\lockIsFree(), DatabaseMysqlBase\lockTables(), DatabaseMysql\mysqlSetCharset(), DatabaseMysqli\mysqlSetCharset(), nativeInsertSelect(), DatabasePostgres\nativeInsertSelect(), nativeReplace(), DatabasePostgres\nextSequenceValue(), DatabasePostgres\open(), DatabaseSqlite\openFile(), ping(), DatabasePostgres\queryIgnore(), DatabasePostgres\relationExists(), replace(), MediaWikiTestCase\resetDB(), select(), selectRowCount(), DatabaseMysqlBase\serverIsReadOnly(), DatabaseMysqlBase\setBigSelects(), DatabasePostgres\setSearchPath(), DatabaseMysqlBase\setSessionOptions(), MediaWikiTestCase\setupTestDB(), sourceStream(), tableExists(), DatabaseMysqlBase\tableExists(), DatabaseTest\testFlushSnapshot(), textFieldSize(), DatabasePostgres\textFieldSize(), DatabasePostgres\triggerExists(), DatabaseMysqlBase\unlock(), DatabasePostgres\unlock(), DatabaseMysqlBase\unlockTables(), update(), and DatabaseMysqlBase\upsert().

reconnect()

Database::reconnect ( )

protected

Returns

bool

Definition at line 2972 of file Database.php.

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

Referenced by query().

registerTempTableOperation()

Database::registerTempTableOperation (   $sql )

protected

Parameters

string

$sql

A SQL query

Returns

bool Whether $sql is SQL for creating/dropping a new TEMPORARY table

Definition at line 801 of file Database.php.

References $matches.

Referenced by query().

replace()

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

Reimplemented in DatabaseMysqlBase, and DatabaseSqlite.

Definition at line 2083 of file Database.php.

References $fname, addQuotes(), as, insert, query(), and tableName().

replaceVars()

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 DatabasePostgres, DatabaseSqlite, and DatabaseSqliteMock.

Definition at line 3209 of file Database.php.

References $vars, addIdentifierQuotes(), addQuotes(), getSchemaVars(), indexName(), tableName(), and use.

Referenced by sourceStream().

reportConnectionError()

Database::reportConnectionError

(

$error = 'Unknown error'

)

Parameters

string

$error

Fallback error message, used if none is given by DB

Exceptions

DBConnectionError

Implements IDatabase.

Definition at line 741 of file Database.php.

References IDatabase\lastError().

Referenced by DatabaseMysqlBase\open().

reportQueryError()

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

Reimplemented in DatabasePostgres.

Definition at line 1038 of file Database.php.

References $fname, getLogContext(), and ignoreErrors().

Referenced by query().

requiresDatabaseUser()

Database::requiresDatabaseUser ( )

protected

Returns

bool Whether a DB user is required to access the DB

Since

1.28

Reimplemented in DatabaseSqlite.

Definition at line 3404 of file Database.php.

Referenced by __construct().

restoreErrorHandler()

Database::restoreErrorHandler ( )

protected

Returns

bool|string

Definition at line 655 of file Database.php.

References getLastPHPError().

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

restoreFlags()

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

Definition at line 595 of file Database.php.

Referenced by ping(), DatabaseTest\testFlagSetting(), and DatabaseTest\testFlushSnapshot().

resultObject()

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

Definition at line 2935 of file Database.php.

Referenced by query().

rollback()

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

DBUnexpectedError

Since

1.23 Added $flush parameter

Implements IDatabase.

Definition at line 2813 of file Database.php.

References $fname, assertOpen(), doRollback(), getFlag(), runOnTransactionIdleCallbacks(), and runTransactionListenerCallbacks().

Referenced by DatabaseTest\testGetScopedLock(), DatabaseTest\testTransactionListener(), and DatabaseTest\testTransactionResolution().

runOnTransactionIdleCallbacks()

Database::runOnTransactionIdleCallbacks

(

$trigger

)

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

This method should not be used outside of Database/LoadBalancer

Parameters

integer

$trigger

IDatabase::TRIGGER_* constant

Since

1.20

Exceptions

Exception

Definition at line 2549 of file Database.php.

References $e, as, clearFlag(), getFlag(), list, rollback, setFlag(), and trxLevel().

Referenced by commit(), handleSessionLoss(), onTransactionIdle(), and rollback().

runOnTransactionPreCommitCallbacks()

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 2599 of file Database.php.

References $e, as, and list.

Referenced by commit(), and LoadBalancer\finalizeMasterChanges().

runTransactionListenerCallbacks()

Database::runTransactionListenerCallbacks

(

$trigger

)

Actually run any "transaction listener" callbacks.

This method should not be used outside of Database/LoadBalancer

Parameters

integer

$trigger

IDatabase::TRIGGER_* constant

Exceptions

Exception

Since

1.20

Definition at line 2629 of file Database.php.

References $e, and as.

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

select()

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:

• IDatabase::buildLike()
• IDatabase::conditional()

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

ResultWrapper|bool If the query returned no rows, a ResultWrapper 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 IDatabase.

Examples

/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 1250 of file Database.php.

References $fname, $options, $vars, query(), and selectSQLText().

Referenced by MediaWikiTestCase\assertSelect(), RefreshImageMetadata\execute(), PopulateContentModel\populatePage(), PopulateContentModel\populateRevisionOrArchive(), and DatabaseSqliteTest\testNumFields().

selectDB()

Database::selectDB

(

$db

)

Change the current database.

Parameters

string

$db

Returns

bool Success or failure

Implements IDatabase.

Reimplemented in DatabaseMysql, DatabaseMysqli, and DatabasePostgres.

Definition at line 1679 of file Database.php.

Referenced by DatabaseMysqlBase\open(), and LBFactoryTest\testTrickyDomain().

selectField()

Database::selectField	(		$table,
			$var,
			$cond = '',
			$fname = __METHOD__,
			$options = []
	)

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.

Returns

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

Implements IDatabase.

Definition at line 1061 of file Database.php.

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

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

selectFieldValues()

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

Definition at line 1088 of file Database.php.

References $fname, $options, $res, as, and select().

selectRow()

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

Definition at line 1317 of file Database.php.

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

Referenced by DatabaseSqlite\indexUnique().

selectRowCount()

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

Definition at line 1351 of file Database.php.

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

selectSQLText()

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

Reimplemented in DatabasePostgres.

Definition at line 1257 of file Database.php.

References $from, $options, $vars, array(), false, fieldNamesWithAlias(), limitResult(), list, makeList(), makeSelectOptions(), and tableNamesWithIndexClauseOrJOIN().

Referenced by buildGroupConcatField(), DatabaseSqlite\buildGroupConcatField(), select(), and selectRowCount().

serverIsReadOnly()

Database::serverIsReadOnly

(

)

Returns

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

Since

1.28

Implements IDatabase.

Reimplemented in DatabaseMysqlBase.

Definition at line 2486 of file Database.php.

setBigSelects()

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

Reimplemented in DatabaseMysqlBase.

Definition at line 3379 of file Database.php.

setFlag()

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

Reimplemented in FakeDatabase.

Definition at line 581 of file Database.php.

Referenced by DatabaseUpdater\__construct(), bufferResults(), ignoreErrors(), runOnTransactionIdleCallbacks(), DatabaseTest\testFlagSetting(), DatabaseTest\testFlushSnapshot(), DatabaseTest\testGetScopedLock(), DatabaseTest\testTransactionIdle(), and DatabaseTest\testTransactionResolution().

setLazyMasterHandle()

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

Definition at line 489 of file Database.php.

setLBInfo()

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

Definition at line 481 of file Database.php.

References $name, and $value.

Referenced by DatabaseMysqlBaseTest\testPtHeartbeat().

setLogger()

Database::setLogger

(

LoggerInterface

$logger

)

Definition at line 398 of file Database.php.

setSchemaVars()

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

Definition at line 3110 of file Database.php.

References $vars.

setSessionOptions()

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

Reimplemented in DatabaseMysqlBase.

Definition at line 3075 of file Database.php.

setTableAliases()

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

Definition at line 3396 of file Database.php.

setTransactionListener()

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

Definition at line 2520 of file Database.php.

References $name.

Referenced by DatabaseTest\testTransactionListener().

setTrxEndCallbackSuppression()

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 2536 of file Database.php.

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

sourceFile()

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

Implements IMaintainableDatabase.

Definition at line 3078 of file Database.php.

References $e, $fname, and sourceStream().

Referenced by DatabaseSqliteTest\prepareTestDB().

sourceStream()

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

Implements IMaintainableDatabase.

Definition at line 3114 of file Database.php.

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

Referenced by sourceFile().

startAtomic()

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

DBError

Implements IDatabase.

Definition at line 2651 of file Database.php.

References $fname, begin(), and getFlag().

Referenced by doAtomicSection(), and onTransactionPreCommitOrIdle().

streamStatementEnd()

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

Implements IMaintainableDatabase.

Reimplemented in DatabaseMysqlBase, and DatabasePostgres.

Definition at line 3176 of file Database.php.

Referenced by sourceStream().

strencode()

Database::strencode (   $s )

abstract

Wrapper for addslashes()

Parameters

string

$s

String to be slashed.

Returns

string Slashed string.

Reimplemented in DatabaseMysqlBase, DatabasePostgres, DatabaseSqlite, DatabaseTestHelper, and FakeDatabase.

Referenced by addQuotes().

strreplace()

Database::strreplace	(		$orig,
			$old,
			$new
	)

Returns a comand 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 IDatabase.

Definition at line 2401 of file Database.php.

tableExists()

Database::tableExists	(		$table,
			$fname = __METHOD__
	)

Query whether a given table exists.

Parameters

string	$table
string	$fname

Returns

bool

Implements IDatabase.

Reimplemented in DatabaseMysqlBase, and DatabaseTestHelper.

Definition at line 1418 of file Database.php.

References $fname, $res, ignoreErrors(), query(), and tableName().

Referenced by dropTable(), DatabaseSqlite\dropTable(), and indexExists().

tableName()

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

Implements IMaintainableDatabase.

Reimplemented in DatabasePostgres, and DatabaseSqlite.

Examples

/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 1696 of file Database.php.

References $name, addIdentifierQuotes(), isQuotedIdentifier(), list, and prependDatabaseOrSchema().

Referenced by MediaWikiTestCase\resetDB(), LBFactoryTest\testNiceDomains(), and LBFactoryTest\testTrickyDomain().

tableNames()

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

Implements IMaintainableDatabase.

Definition at line 1782 of file Database.php.

References $name, as, and tableName().

tableNamesN()

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

Implements IMaintainableDatabase.

Definition at line 1793 of file Database.php.

References $name, as, and tableName().

tableNamesWithAlias()

Database::tableNamesWithAlias (   $tables )

protected

Gets an array of aliased table names.

Parameters

array

$tables

[ [alias] => table ]

Returns

string[] See tableNameWithAlias()

Definition at line 1826 of file Database.php.

References $retval, $tables, as, and tableNameWithAlias().

tableNamesWithIndexClauseOrJOIN()

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 1882 of file Database.php.

References $ret, $tables, array(), as, ignoreIndexClause(), list, makeList(), tableNameWithAlias(), and useIndexClause().

Referenced by selectSQLText().

tableNameWithAlias()

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 1812 of file Database.php.

References $name, addIdentifierQuotes(), and tableName().

Referenced by tableNamesWithAlias(), and tableNamesWithIndexClauseOrJOIN().

tablePrefix()

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

Examples

/src/tests/phpunit/MediaWikiTestCase.php.

Definition at line 448 of file Database.php.

References DatabaseDomain\newUnspecified().

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

textFieldSize()

Database::textFieldSize	(		$table,
			$field
	)

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

Parameters

string	$table
string	$field

Returns

int

Implements IMaintainableDatabase.

Reimplemented in DatabasePostgres, and DatabaseSqlite.

Definition at line 2237 of file Database.php.

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

timestamp()

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

Reimplemented in DatabasePostgres.

Definition at line 2908 of file Database.php.

References $t, and TS_MW.

Referenced by encodeExpiry(), User\makeUpdateConditions(), ReverseChronologicalPagerTest\testGetDateCond(), and timestampOrNull().

timestampOrNull()

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

Definition at line 2914 of file Database.php.

References timestamp().

trxLevel()

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

Definition at line 440 of file Database.php.

Referenced by SavepointPostgres\__construct(), close(), getScopedLockAndFlush(), LoadBalancer\runMasterPostTrxCallbacks(), runOnTransactionIdleCallbacks(), DatabaseTest\testFlushSnapshot(), and DatabaseTest\testGetScopedLock().

trxTimestamp()

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

Definition at line 444 of file Database.php.

Referenced by getTransactionLagStatus().

unionQueries()

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

Reimplemented in DatabaseSqlite.

Definition at line 2387 of file Database.php.

unionSupportsOrderAndLimit()

Database::unionSupportsOrderAndLimit

(

)

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

Returns

bool

Implements IDatabase.

Reimplemented in DatabaseSqlite.

Definition at line 2383 of file Database.php.

unlock()

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

Reimplemented in DatabaseMysqlBase, DatabasePostgres, and DatabaseSqlite.

Definition at line 3277 of file Database.php.

Referenced by getScopedLockAndFlush().

unlockTables()

Database::unlockTables

(

$method

)

Unlock specific tables.

Parameters

string

$method

The caller

Returns

bool

Reimplemented in DatabaseMysqlBase.

Definition at line 3341 of file Database.php.

update()

Database::update	(		$table,
			$values,
			$conds,
			$fname = __METHOD__,
			$options = []
	)

UPDATE wrapper.

Takes a condition array and a SET array.

Parameters

string	$table	Name of the table to UPDATE. This will be passed through Database::tableName().
array	$values	An array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by IDatabase::addQuotes().
array	$conds	An array of conditions (WHERE). See IDatabase::select() for the details of the format of condition arrays. Use '*' to update all rows.
string	$fname	The function name of the caller (from METHOD), for logging and profiling.
array	$options	An array of UPDATE options, can be: IGNORE: Ignore unique key conflicts LOW_PRIORITY: MySQL-specific, see MySQL manual.

Returns

bool

Implements IDatabase.

Definition at line 1536 of file Database.php.

References $fname, $options, makeList(), makeUpdateOptions(), query(), and tableName().

Referenced by PopulateContentModel\updatePageRows(), PopulateContentModel\updateRevisionOrArchiveRows(), and upsert().

updateTrxWriteQueryTime()

Database::updateTrxWriteQueryTime (   $sql,   $runtime  )

private

Update the estimated run-time of a query, not counting large row lock times.

LoadBalancer can be set to rollback transactions that will create huge replication lag. It bases this estimate off of pendingWriteQueryDuration(). Certain simple queries, like inserting a row can take a long time due to row locking. This method uses some simple heuristics to discount those cases.

Parameters

string	$sql	A SQL write query
float	$runtime	Total runtime, including RTT

Definition at line 980 of file Database.php.

References IDatabase\affectedRows(), and getQueryVerb().

Referenced by doProfiledQuery().

upsert()

Database::upsert	(		$table,
		array	$rows,
		array	$uniqueIndexes,
		array	$set,
			$fname = __METHOD__
	)

INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.

This updates any conflicting rows (according to the unique indexes) using the provided SET clause and inserts any remaining (non-conflicted) rows.

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

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.

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

Since

1.22

Parameters

string	$table	Table name. This will be passed through Database::tableName().
array	$rows	A single row or list of rows to insert
array	$uniqueIndexes	List of single field names or field name tuples
array	$set	An array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by IDatabase::addQuotes().
string	$fname	Calling function name (use METHOD) for logs/profiling

Exceptions

Exception

Returns

bool

Implements IDatabase.

Reimplemented in DatabaseMysqlBase.

Definition at line 2165 of file Database.php.

References $e, $fname, as, begin(), commit(), insert, makeList(), rollback, and update().

useIndexClause()

Database::useIndexClause

(

$index

)

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

Definition at line 2065 of file Database.php.

Referenced by makeSelectOptions(), and tableNamesWithIndexClauseOrJOIN().

wasConnectionError()

Database::wasConnectionError

(

$errno

)

Do not use this method outside of Database/DBError classes.

Parameters

integer | string

$errno

Returns

bool Whether the given query error was a connection drop

Reimplemented in DatabaseMysqlBase.

Definition at line 2431 of file Database.php.

wasDeadlock()

Database::wasDeadlock

(

)

Determines if the last failure was due to a deadlock.

Returns

bool

Implements IDatabase.

Reimplemented in DatabaseMysqlBase, DatabasePostgres, and DatabaseSqlite.

Definition at line 2409 of file Database.php.

Referenced by deadlockLoop(), and query().

wasErrorReissuable()

Database::wasErrorReissuable

(

)

Determines if the last query error was due to a dropped connection and should be dealt with by pinging the connection and reissuing the query.

Returns

bool

Implements IDatabase.

Reimplemented in DatabaseMysqlBase, and DatabaseSqlite.

Definition at line 2417 of file Database.php.

Referenced by query().

wasLockTimeout()

Database::wasLockTimeout

(

)

Determines if the last failure was due to a lock timeout.

Returns

bool

Implements IDatabase.

Reimplemented in DatabaseMysqlBase.

Definition at line 2413 of file Database.php.

wasReadOnlyError()

Database::wasReadOnlyError

(

)

Determines if the last failure was due to the database being read-only.

Returns

bool

Implements IDatabase.

Reimplemented in DatabaseMysqlBase, and DatabaseSqlite.

Definition at line 2421 of file Database.php.

writesOrCallbacksPending()

Database::writesOrCallbacksPending

(

)

Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish.

This does not count recurring callbacks, e.g. from setTransactionListener().

Returns

bool

Implements IDatabase.

Definition at line 526 of file Database.php.

Referenced by flushSnapshot(), getScopedLockAndFlush(), query(), and LoadBalancer\runMasterPostTrxCallbacks().

writesPending()

Database::writesPending

(

)

Returns

bool Whether there is a transaction open with possible write queries

Since

1.27

Implements IDatabase.

Definition at line 522 of file Database.php.

Member Data Documentation

$agent

string Database::$agent

protected

Agent name for query profiling.

Definition at line 71 of file Database.php.

$cliMode

bool Database::$cliMode

protected

Whether this PHP instance is for a CLI script.

Definition at line 69 of file Database.php.

$connLogger

LoggerInterface Database::$connLogger

protected

Definition at line 76 of file Database.php.

$currentDomain

DatabaseDomain Database::$currentDomain

protected

Definition at line 119 of file Database.php.

$delimiter

string Database::$delimiter = ';'

protected

Definition at line 117 of file Database.php.

Referenced by DatabasePostgres\buildGroupConcatField().

$errorLogger

callback Database::$errorLogger

protected

Error logging callback.

Definition at line 80 of file Database.php.

$htmlErrors

string bool null Database::$htmlErrors

protected

Stashed value of html_errors INI setting.

Definition at line 115 of file Database.php.

$lastPing

float Database::$lastPing = 0.0

protected

UNIX timestamp.

Definition at line 216 of file Database.php.

$lazyMasterHandle

IDatabase null Database::$lazyMasterHandle

private

Lazy handle to the master DB this server replicates from.

Definition at line 213 of file Database.php.

$mConn

resource null Database::$mConn = null

protected

Database connection.

Definition at line 83 of file Database.php.

Referenced by DatabaseMysqli\__toString(), and DatabasePostgres\open().

$mDBname

string Database::$mDBname

protected

Definition at line 65 of file Database.php.

Referenced by DatabaseSqlite\__construct(), DatabasePostgres\getDBname(), and DatabaseMysqlBase\listViews().

$mDefaultBigSelects

bool null Database::$mDefaultBigSelects = null

protected

Definition at line 107 of file Database.php.

Referenced by DatabaseMysqlBase\setBigSelects().

$mFlags

integer Database::$mFlags

protected

Definition at line 103 of file Database.php.

$mLastQuery

string Database::$mLastQuery = ''

protected

SQL query.

Definition at line 53 of file Database.php.

$mLastWriteTime

float bool Database::$mLastWriteTime = false

protected

UNIX timestamp of last write query.

Definition at line 55 of file Database.php.

$mLBInfo

array Database::$mLBInfo = []

protected

Definition at line 105 of file Database.php.

$mNamedLocksHeld

array Database::$mNamedLocksHeld = []

private

Map of (name => 1) for locks obtained via lock()

Definition at line 208 of file Database.php.

$mOpened

bool Database::$mOpened = false

protected

Definition at line 85 of file Database.php.

$mPassword

string Database::$mPassword

protected

Definition at line 63 of file Database.php.

$mPHPError

string bool Database::$mPHPError = false

protected

Definition at line 57 of file Database.php.

$mRTTEstimate

float Database::$mRTTEstimate = 0.0

private

RTT time estimate.

Definition at line 205 of file Database.php.

$mSchema

string Database::$mSchema = ''

protected

Definition at line 101 of file Database.php.

$mSchemaVars

array bool Database::$mSchemaVars = false

protected

Definition at line 109 of file Database.php.

$mServer

string Database::$mServer

protected

Definition at line 59 of file Database.php.

Referenced by DatabasePostgres\getServer().

$mSessionTempTables

array Database::$mSessionTempTables = []

protected

Map of (table name => 1) for TEMPORARY tables.

Definition at line 210 of file Database.php.

$mSessionVars

array Database::$mSessionVars = []

protected

Definition at line 111 of file Database.php.

$mTablePrefix

string Database::$mTablePrefix = ''

protected

Definition at line 99 of file Database.php.

$mTrxAtomicLevels

array Database::$mTrxAtomicLevels = []

private

Array of levels of atomicity within transactions.

Definition at line 173 of file Database.php.

$mTrxAutomatic

bool Database::$mTrxAutomatic = false

private

Record if the current transaction was started implicitly due to DBO_TRX being set.

See also

Database::mTrxLevel

Definition at line 167 of file Database.php.

$mTrxAutomaticAtomic

bool Database::$mTrxAutomaticAtomic = false

private

Record if the current transaction was started implicitly by Database::startAtomic.

Definition at line 179 of file Database.php.

$mTrxDoneWrites

bool Database::$mTrxDoneWrites = false

private

Record if possible write queries were done in the last transaction started.

See also

Database::mTrxLevel

Definition at line 160 of file Database.php.

$mTrxEndCallbacks

array [] Database::$mTrxEndCallbacks = []

protected

List of (callable, method name)

Definition at line 92 of file Database.php.

$mTrxEndCallbacksSuppressed

bool Database::$mTrxEndCallbacksSuppressed = false

protected

Whether to suppress triggering of transaction end callbacks.

Definition at line 96 of file Database.php.

$mTrxFname

string Database::$mTrxFname = null

private

Remembers the function name given for starting the most recent transaction via begin().

Used to provide additional context for error reporting.

See also

Database::mTrxLevel

Definition at line 153 of file Database.php.

$mTrxIdleCallbacks

array [] Database::$mTrxIdleCallbacks = []

protected

List of (callable, method name)

Definition at line 88 of file Database.php.

$mTrxLevel

int Database::$mTrxLevel = 0

protected

Either 1 if a transaction is active or 0 otherwise.

The other Trx fields may not be meaningfull if this is 0.

Definition at line 127 of file Database.php.

$mTrxPreCommitCallbacks

array [] Database::$mTrxPreCommitCallbacks = []

protected

List of (callable, method name)

Definition at line 90 of file Database.php.

$mTrxRecurringCallbacks

callable [] Database::$mTrxRecurringCallbacks = []

protected

Map of (name => callable)

Definition at line 94 of file Database.php.

$mTrxReplicaLag

float Database::$mTrxReplicaLag = null

private

Lag estimate at the time of BEGIN.

Definition at line 145 of file Database.php.

$mTrxShortId

string Database::$mTrxShortId = ''

protected

Either a short hexidecimal string if a transaction is active or "".

See also

Database::mTrxLevel

Definition at line 134 of file Database.php.

$mTrxTimestamp

float null Database::$mTrxTimestamp = null

private

The UNIX time that the transaction started.

Callers can assume that if snapshot isolation is used, then the data is at least up to date to that point (possibly more up-to-date since the first SELECT defines the snapshot).

See also

Database::mTrxLevel

Definition at line 143 of file Database.php.

$mTrxWriteAdjDuration

float Database::$mTrxWriteAdjDuration = 0.0

private

Like mTrxWriteQueryCount but excludes lock-bound, easy to replicate, queries.

Definition at line 197 of file Database.php.

$mTrxWriteAdjQueryCount

integer Database::$mTrxWriteAdjQueryCount = 0

private

Number of write queries counted in mTrxWriteAdjDuration.

Definition at line 201 of file Database.php.

$mTrxWriteCallers

string [] Database::$mTrxWriteCallers = []

private

Track the write query callers of the current transaction.

Definition at line 185 of file Database.php.

$mTrxWriteDuration

float Database::$mTrxWriteDuration = 0.0

private

Seconds spent in write queries for the current transaction.

Definition at line 189 of file Database.php.

$mTrxWriteQueryCount

integer Database::$mTrxWriteQueryCount = 0

private

Number of write queries for the current transaction.

Definition at line 193 of file Database.php.

$mUser

string Database::$mUser

protected

Definition at line 61 of file Database.php.

$preparedArgs

array null Database::$preparedArgs

protected

Definition at line 113 of file Database.php.

$priorFlags

int [] Database::$priorFlags = []

private

Prior mFlags values.

Definition at line 219 of file Database.php.

$profiler

object string Database::$profiler

protected

Class name or object With profileIn/profileOut methods.

Definition at line 222 of file Database.php.

$queryLogger

LoggerInterface Database::$queryLogger

protected

Definition at line 78 of file Database.php.

$srvCache

BagOStuff Database::$srvCache

protected

APC cache.

Definition at line 74 of file Database.php.

Referenced by DatabaseMysqlBase\getMasterServerInfo().

$tableAliases

Database::$tableAliases = []

protected

Definition at line 67 of file Database.php.

$trxProfiler

TransactionProfiler Database::$trxProfiler

protected

Definition at line 224 of file Database.php.

DEADLOCK_DELAY_MAX

const Database::DEADLOCK_DELAY_MAX = 1500000

Maximum time to wait before retry.

Definition at line 42 of file Database.php.

DEADLOCK_DELAY_MIN

const Database::DEADLOCK_DELAY_MIN = 500000

Minimum time to wait before retry, in microseconds.

Definition at line 40 of file Database.php.

DEADLOCK_TRIES

const Database::DEADLOCK_TRIES = 4

Number of times to re-try an operation in case of deadlock.

Definition at line 38 of file Database.php.

PING_QUERY

const Database::PING_QUERY = 'SELECT 1 AS ping'

Definition at line 46 of file Database.php.

PING_TTL

const Database::PING_TTL = 1.0

How long before it is worth doing a dummy query to test the connection.

Definition at line 45 of file Database.php.

SLOW_WRITE_SEC

const Database::SLOW_WRITE_SEC = .500

Definition at line 49 of file Database.php.

SMALL_WRITE_ROWS

const Database::SMALL_WRITE_ROWS = 100

Definition at line 50 of file Database.php.

TINY_WRITE_SEC

const Database::TINY_WRITE_SEC = .010

Definition at line 48 of file Database.php.

---

The documentation for this class was generated from the following file:

• includes/libs/rdbms/database/Database.php