MediaWiki REL1_31
Public Member Functions | List of all members
Wikimedia\Rdbms\IDatabase Interface Reference
Database

Basic database interface for live and lazy-loaded relation database handles. More...

Inheritance diagram for Wikimedia\Rdbms\IDatabase:
Inheritance graph
[legend]

Public Member Functions

 addQuotes ( $s)
 Adds quotes and backslashes.
 
 affectedRows ()
 Get the number of rows affected by the last write query.
 
 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.
 
 buildIntegerCast ( $field)
 
 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().
 
 buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery.
 
 buildStringCast ( $field)
 
 buildSubString ( $input, $startPosition, $length=null)
 Build a SUBSTRING function.
 
 cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
 Cancel an atomic section of SQL statements.
 
 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection.
 
 close ()
 Close the 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.
 
 databasesAreIndependent ()
 Returns true if DBs are assumed to be on potentially different servers.
 
 dataSeek ( $res, $row)
 Change the position of the cursor in a result object.
 
 dbSchema ( $schema=null)
 Get/set the db schema.
 
 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, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Perform an atomic section of reversable SQL statements from a callback.
 
 doneWrites ()
 Returns true if the connection may have been used for write queries.
 
 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, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Estimate the number of rows in dataset.
 
 explicitTrxActive ()
 
 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.
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table.
 
 fieldName ( $res, $n)
 Get a field name in a result object.
 
 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 the amount of replication lag for this database server.
 
 getLBInfo ( $name=null)
 Get properties passed down from the server info array of the load balancer.
 
 getMasterPos ()
 Get the position of this master.
 
 getReplicaPos ()
 Get the replication position of this replica DB.
 
 getScopedLockAndFlush ( $lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
 
 getServer ()
 Get the 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.
 
 getServerVersion ()
 A string describing the current software version, like from mysql_get_server_info().
 
 getSessionLagStatus ()
 Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active.
 
 getSoftwareLink ()
 Returns a wikitext link to the DB's website, e.g., return "[https://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.
 
 getWikiID ()
 Alias for getDomainID()
 
 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.
 
 insert ( $table, $a, $fname=__METHOD__, $options=[])
 INSERT wrapper, inserts an array into a table.
 
 insertId ()
 Get the inserted value of an auto-increment row.
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 INSERT SELECT wrapper.
 
 isOpen ()
 Is a connection to the database open?
 
 isReadOnly ()
 
 lastDoneWrites ()
 Returns the last time the connection may have been used for write queries.
 
 lastErrno ()
 Get the last error number.
 
 lastError ()
 Get a description of the last error.
 
 lastQuery ()
 Return the last query that went through IDatabase::query()
 
 lock ( $lockName, $method, $timeout=5)
 Acquire a named lock.
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is not locked by any thread (non-blocking)
 
 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)
 Deprecated method, calls should be removed.
 
 numFields ( $res)
 Get the number of fields in a result object.
 
 numRows ( $res)
 Get the number of rows in a result object.
 
 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.
 
 open ( $server, $user, $password, $dbName)
 Open a new connection to the database (closing any existing one)
 
 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.
 
 pendingWriteRowsAffected ()
 Get the number of affected rows from pending write queries.
 
 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.
 
 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().
 
 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=[], $join_conds=[])
 A SELECT wrapper which returns a single field from a single result row.
 
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a list of single field values from result rows.
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Single row SELECT wrapper.
 
 selectRowCount ( $tables, $var=' *', $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.
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB.
 
 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.
 
 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.
 
 startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Begin an atomic section of SQL statements.
 
 strreplace ( $orig, $old, $new)
 Returns a command for str_replace function in SQL query.
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists.
 
 tablePrefix ( $prefix=null)
 Get/set the table prefix.
 
 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.
 
 unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Construct a UNION query for permutations of conditions.
 
 unionQueries ( $sqls, $all)
 Construct a UNION query 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.
 
 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.
 
 wasConnectionLoss ()
 Determines if the last query error was due to a dropped connection.
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock.
 
 wasErrorReissuable ()
 Determines if the last query error was due to something outside of the query itself.
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout.
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only.
 
 writesOrCallbacksPending ()
 Returns true if there is a transaction/round open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish.
 
 writesPending ()
 

Detailed Description

Basic database interface for live and lazy-loaded relation database handles.

Note
: IDatabase and DBConnRef should be updated to reflect any changes

Definition at line 38 of file IDatabase.php.

Member Function Documentation

◆ addQuotes()

Wikimedia\Rdbms\IDatabase::addQuotes ( $s)

Adds quotes and backslashes.

Parameters
string | int | null | bool | Blob$s
Returns
string|int

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

Referenced by PopulateRecentChangesSource\buildUpdateCondition(), DBFileJournal\doGetChangeEntries(), DBFileJournal\doGetPositionAtTime(), DBFileJournal\doPurgeOldLogs(), RefreshImageMetadata\execute(), RefreshImageMetadata\getConditions(), WatchedItemQueryService\getFromUntilTargetConds(), WatchedItemQueryService\getStartEndConds(), WatchedItemQueryService\getStartFromConds(), WANCacheReapUpdate\getTitleChangeEvents(), WatchedItemStore\getVisitingWatchersCondition(), WatchedItemQueryService\getWatchedItemsWithRCInfoQueryConds(), UserGroupMembership\insert(), Title\invalidateCache(), PurgeJobUtils\invalidatePages(), PopulateContentModel\populatePage(), PopulateContentModel\populateRevisionOrArchive(), Block\purgeExpired(), UserGroupMembership\purgeExpired(), Title\purgeExpiredRestrictions(), and MediaWiki\Storage\RevisionStore\userWasLastToEdit().

◆ affectedRows()

Wikimedia\Rdbms\IDatabase::affectedRows ( )

Get the number of rows affected by the last write query.

See also
https://secure.php.net/mysql_affected_rows
Returns
int

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by MigrateActors\addActorsForRows(), UserGroupMembership\delete(), UserGroupMembership\insert(), and MigrateComments\loadCommentIDs().

◆ aggregateValue()

Wikimedia\Rdbms\IDatabase::aggregateValue ( $valuedata,
$valuename = 'value' )

Return aggregated value alias.

Parameters
array$valuedata
string$valuename
Returns
string

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.

◆ anyChar()

Wikimedia\Rdbms\IDatabase::anyChar ( )

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

Returns
LikeMatch

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ anyString()

Wikimedia\Rdbms\IDatabase::anyString ( )

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

Returns
LikeMatch

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by RefreshImageMetadata\getConditions(), and GadgetHooks\onDeleteUnknownPreferences().

◆ begin()

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

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$fnameCalling function name
string$modeA situationally valid IDatabase::TRANSACTION_* constant [optional]
Exceptions
DBError

Implemented in Wikimedia\Rdbms\DBConnRef, and Wikimedia\Rdbms\Database.

Referenced by DatabaseTest\badLockingMethodExplicit(), and Maintenance\beginTransaction().

◆ bitAnd()

Wikimedia\Rdbms\IDatabase::bitAnd ( $fieldLeft,
$fieldRight )
Parameters
string$fieldLeft
string$fieldRight
Returns
string

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by WatchedItemQueryService\getExtraDeletedPageLogEntryRelatedCond(), and WatchedItemQueryService\getUserRelatedConds().

◆ bitNot()

Wikimedia\Rdbms\IDatabase::bitNot ( $field)
Parameters
string$field
Returns
string

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ bitOr()

Wikimedia\Rdbms\IDatabase::bitOr ( $fieldLeft,
$fieldRight )
Parameters
string$fieldLeft
string$fieldRight
Returns
string

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ bufferResults()

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

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ buildConcat()

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

Build a concatenation list to feed into a SQL query.

Parameters
array$stringListList of raw SQL expressions; caller is responsible for any quoting
Returns
string

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ buildGroupConcatField()

Wikimedia\Rdbms\IDatabase::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$delimGlue to bind the results together
string | array$tableTable name
string$fieldField name
string | array$condsConditions
string | array$join_condsJoin conditions
Returns
string SQL text
Since
1.23

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ buildIntegerCast()

Wikimedia\Rdbms\IDatabase::buildIntegerCast ( $field)
Parameters
string$fieldField or column to cast
Returns
string
Since
1.31

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.

◆ buildLike()

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

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by RefreshImageMetadata\getConditions(), and GadgetHooks\onDeleteUnknownPreferences().

◆ buildSelectSubquery()

Wikimedia\Rdbms\IDatabase::buildSelectSubquery ( $table,
$vars,
$conds = '',
$fname = __METHOD__,
$options = [],
$join_conds = [] )

Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery.

See also
IDatabase::selectSQLText()
Parameters
string | array$tableTable name
string | array$varsField names
string | array$condsConditions
string$fnameCaller function name
string | array$optionsQuery options
string | array$join_condsJoin conditions
Returns
Subquery
Since
1.31

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ buildStringCast()

Wikimedia\Rdbms\IDatabase::buildStringCast ( $field)
Parameters
string$fieldField or column to cast
Returns
string
Since
1.28

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ buildSubString()

Wikimedia\Rdbms\IDatabase::buildSubString ( $input,
$startPosition,
$length = null )

Build a SUBSTRING function.

Behavior for non-ASCII values is undefined.

Parameters
string$inputField name
int$startPositionPositive integer
int | null$lengthNon-negative integer length or null for no limit
Exceptions
InvalidArgumentException
Returns
string SQL text
Since
1.31

◆ cancelAtomic()

Wikimedia\Rdbms\IDatabase::cancelAtomic ( $fname = __METHOD__,
AtomicSectionIdentifier $sectionId = null )

Cancel an atomic section of SQL statements.

This will roll back only the statements executed since the start of the most recent atomic section, and close that section. If a transaction was open before the corresponding startAtomic() call, any statements before that call are not rolled back and the transaction remains open. If the corresponding startAtomic() implicitly started a transaction, that transaction is rolled back.

Note
: callers must use additional measures for situations involving two or more (peer) transactions (e.g. updating two database servers at once). The transaction and savepoint logic of startAtomic() are bound to specific IDatabase instances.

Note that a call to IDatabase::rollback() will also roll back any open atomic sections.

Note
As a micro-optimization to save a few DB calls, this method may only be called when startAtomic() was called with the ATOMIC_CANCELABLE flag.
Since
1.31
See also
IDatabase::startAtomic
Parameters
string$fname
AtomicSectionIdentifier$sectionIdSection ID from startAtomic(); passing this enables cancellation of unclosed nested sections [optional]
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ clearFlag()

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

Clear a flag for this connection.

Parameters
int$flagDBO_* 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$rememberIDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ close()

Wikimedia\Rdbms\IDatabase::close ( )

Close the database connection.

This should only be called after any transactions have been resolved, aside from read-only transactions (assuming no callbacks are registered). If a transaction is still open anyway, it will be committed if possible.

Exceptions
DBError
Returns
bool Operation success. true if already closed.

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by Wikimedia\Rdbms\LoadBalancer\closeAll(), and Wikimedia\Rdbms\LoadBalancer\closeConnection().

◆ commit()

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

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

Implemented in Wikimedia\Rdbms\DBConnRef, and Wikimedia\Rdbms\Database.

Referenced by Wikimedia\Rdbms\LoadBalancer\commitAll(), and Maintenance\commitTransaction().

◆ conditional()

Wikimedia\Rdbms\IDatabase::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$condSQL expression which will result in a boolean value
string$trueValSQL expression to return if true
string$falseValSQL expression to return if false
Returns
string SQL fragment

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ databasesAreIndependent()

Wikimedia\Rdbms\IDatabase::databasesAreIndependent ( )

Returns true if DBs are assumed to be on potentially different servers.

In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as fully separate, only allowing mechanisms like postgres_fdw to effectively "mount" foreign DBs. This is true even among DBs on the same server.

Returns
bool
Since
1.29

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ dataSeek()

Wikimedia\Rdbms\IDatabase::dataSeek ( $res,
$row )

Change the position of the cursor in a result object.

See also
https://secure.php.net/mysql_data_seek
Parameters
mixed$resA SQL result
int$row

Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

◆ dbSchema()

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

Get/set the db schema.

Parameters
string$schemaThe database schema to set, or omitted to leave it unchanged.
Returns
string The previous db schema.

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ decodeBlob()

Wikimedia\Rdbms\IDatabase::decodeBlob ( $b)

Some DBMSs return a special placeholder object representing blob fields in result objects.

Pass the object through this function to return the original string.

Parameters
string | Blob$b
Returns
string

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ decodeExpiry()

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

Decode an expiry time into a DBMS independent format.

Parameters
string$expiryDB timestamp field value for expiry
int$formatTS_* constant, defaults to TS_MW
Returns
string

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ delete()

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

DELETE query wrapper.

Parameters
string$tableTable name
string | array$condsArray of conditions. See $conds in IDatabase::select() for the format. Use $conds == "*" to delete all rows
string$fnameName of the calling function
Exceptions
DBUnexpectedError
Returns
bool|IResultWrapper
Exceptions
DBError

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DBConnRef.

Referenced by UserGroupMembership\delete(), DBFileJournal\doPurgeOldLogs(), Block\purgeExpired(), UserGroupMembership\purgeExpired(), Title\purgeExpiredRestrictions(), QueryPage\recache(), and OATHAuthHooks\schemaUpdateOldUsers().

◆ deleteJoin()

Wikimedia\Rdbms\IDatabase::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$delTableThe table to delete from.
string$joinTableThe other table.
string$delVarThe variable to join on, in the first table.
string$joinVarThe variable to join on, in the second table.
array$condsCondition array of field names mapped to variables, ANDed together in the WHERE clause
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.

◆ doAtomicSection()

Wikimedia\Rdbms\IDatabase::doAtomicSection ( $fname,
callable $callback,
$cancelable = self::ATOMIC_NOT_CANCELABLE )

Perform an atomic section of reversable SQL statements from a callback.

The $callback takes the following arguments:

  • This database object
  • The value of $fname

This will execute the callback inside a pair of startAtomic()/endAtomic() calls. If any exception occurs during execution of the callback, it will be handled as follows:

  • If $cancelable is ATOMIC_CANCELABLE, cancelAtomic() will be called to back out any (and only) statements executed during the atomic section. If that succeeds, then the exception will be re-thrown; if it fails, then a different exception will be thrown and any further query attempts will fail until rollback() is called.
  • If $cancelable is ATOMIC_NOT_CANCELABLE, cancelAtomic() will be called to mark the end of the section and the error will be re-thrown. Any further query attempts will fail until rollback() is called.

This method is convenient for letting calls to the caller of this method be wrapped in a try/catch blocks for exception types that imply that the caller failed but was able to properly discard the changes it made in the transaction. This method can be an alternative to explicit calls to startAtomic()/endAtomic()/cancelAtomic().

Example usage, "RecordStore::save" method:

$dbw->doAtomicSection( __METHOD__, function ( $dbw ) use ( $record ) {
// Create new record metadata row
$dbw->insert( 'records', $record->toArray(), __METHOD__ );
// Figure out where to store the data based on the new row's ID
$path = $this->recordDirectory . '/' . $dbw->insertId();
// Write the record data to the storage system;
// blob store throughs StoreFailureException on failure
$this->blobStore->create( $path, $record->getJSON() );
// Try to cleanup files orphaned by transaction rollback
$dbw->onTransactionResolution(
function ( $type ) use ( $path ) {
if ( $type === IDatabase::TRIGGER_ROLLBACK ) {
$this->blobStore->delete( $path );
}
},
__METHOD__
);
}, $dbw::ATOMIC_CANCELABLE );

Example usage, caller of the "RecordStore::save" method:

$dbw->startAtomic( __METHOD__ );
// ...various SQL writes happen...
try {
$recordStore->save( $record );
} catch ( StoreFailureException $e ) {
// ...various SQL writes happen...
}
// ...various SQL writes happen...
$dbw->endAtomic( __METHOD__ );
$e
returning false will NOT prevent logging $e
Definition hooks.txt:2176
See also
Database::startAtomic
Database::endAtomic
Database::cancelAtomic
Parameters
string$fnameCaller name (usually METHOD)
callable$callbackCallback that issues DB updates
string$cancelablePass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section.
Returns
mixed $res Result of the callback (since 1.28)
Exceptions
DBError
RuntimeException
Since
1.27; prior to 1.31 this did a rollback() instead of cancelAtomic(), and assumed no callers up the stack would ever try to catch the exception.

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ doneWrites()

Wikimedia\Rdbms\IDatabase::doneWrites ( )

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

Should return true if unsure.

Returns
bool
Deprecated
Since 1.31; use lastDoneWrites()

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ encodeBlob()

Wikimedia\Rdbms\IDatabase::encodeBlob ( $b)

Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.

To insert into such a field, pass the data through this function before passing it to IDatabase::insert().

Parameters
string$b
Returns
string|Blob

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ encodeExpiry()

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

Encode an expiry time into the DBMS dependent format.

Parameters
string$expiryTimestamp for expiry, or the 'infinity' string
Returns
string

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by Block\getDatabaseArray().

◆ endAtomic()

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

Ends an atomic section of SQL statements.

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

Since
1.23
See also
IDatabase::startAtomic
Parameters
string$fname
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by JobQueueDB\doBatchPushInternal(), and UserGroupMembership\purgeExpired().

◆ estimateRowCount()

Wikimedia\Rdbms\IDatabase::estimateRowCount ( $table,
$var = ' *',
$conds = '',
$fname = __METHOD__,
$options = [],
$join_conds = [] )

Estimate the number of rows in dataset.

MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.

For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).

Takes the same arguments as IDatabase::select().

Parameters
string$tableTable name
string$varColumn for which NULL values are not counted [default "*"]
array | string$condsFilters on the table
string$fnameFunction name for profiling
array$optionsOptions for select
array | string$join_condsJoin conditions
Returns
int Row count
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.

◆ explicitTrxActive()

Wikimedia\Rdbms\IDatabase::explicitTrxActive ( )
Returns
bool Whether an explicit transaction or atomic sections are still open
Since
1.28

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by Wikimedia\Rdbms\LoadBalancer\approveMasterChanges(), and DeferredUpdates\areDatabaseTransactionsActive().

◆ fetchObject()

Wikimedia\Rdbms\IDatabase::fetchObject ( $res)

Fetch the next row from the given result object, in object form.

Fields can be retrieved with $row->fieldname, with fields acting like member variables. If no more rows are available, false is returned.

Parameters
IResultWrapper | stdClass$resObject as returned from IDatabase::query(), etc.
Returns
stdClass|bool
Exceptions
DBUnexpectedErrorThrown if the database returns an error

Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

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

◆ fetchRow()

Wikimedia\Rdbms\IDatabase::fetchRow ( $res)

Fetch the next row from the given result object, in associative array form.

Fields are retrieved with $row['fieldname']. If no more rows are available, false is returned.

Parameters
IResultWrapper$resResult object as returned from IDatabase::query(), etc.
Returns
array|bool
Exceptions
DBUnexpectedErrorThrown if the database returns an error

Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

◆ fieldExists()

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

Determines whether a field exists in a table.

Parameters
string$tableTable name
string$fieldFiled to check on that table
string$fnameCalling function name (optional)
Returns
bool Whether $table has filed $field
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DBConnRef.

Referenced by OATHAuthHooks\schemaUpdateOldUsers().

◆ fieldName()

Wikimedia\Rdbms\IDatabase::fieldName ( $res,
$n )

Get a field name in a result object.

See also
https://secure.php.net/mysql_field_name
Parameters
mixed$resA SQL result
int$n
Returns
string

Implemented in Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, DatabaseTestHelper, and DatabaseOracle.

◆ flushSnapshot()

Wikimedia\Rdbms\IDatabase::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$fnameCalling function name
Exceptions
DBError
Since
1.28

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by Wikimedia\Rdbms\LoadBalancer\commitMasterChanges(), and Wikimedia\Rdbms\LoadBalancer\flushReplicaSnapshots().

◆ freeResult()

Wikimedia\Rdbms\IDatabase::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$resA SQL result

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ getDBname()

Wikimedia\Rdbms\IDatabase::getDBname ( )

Get the current DB name.

Returns
string

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.

◆ getDomainID()

Wikimedia\Rdbms\IDatabase::getDomainID ( )
Returns
string

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by MediaWiki\Storage\RevisionStore\checkDatabaseWikiId(), ResourceLoaderWikiModule\preloadTitleInfo(), UserGroupMembership\purgeExpired(), and Wikimedia\Rdbms\LoadBalancer\reuseConnection().

◆ getFlag()

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

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

Parameters
int$flagDBO_* 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

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by Wikimedia\Rdbms\LoadBalancer\applyTransactionRoundFlags(), and Wikimedia\Rdbms\LoadBalancer\undoTransactionRoundFlags().

◆ getInfinity()

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

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ getLag()

Wikimedia\Rdbms\IDatabase::getLag ( )

Get the amount of replication lag for this database server.

Callers should avoid using this method while a transaction is active

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

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.

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

◆ getLBInfo()

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

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

Parameters
string$nameThe entry of the info array to get, or null to get the whole array
Returns
array|mixed|null

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by Wikimedia\Rdbms\LoadBalancer\applyTransactionRoundFlags(), Wikimedia\Rdbms\LoadBalancer\closeConnection(), Wikimedia\Rdbms\LoadBalancer\commitAll(), Wikimedia\Rdbms\LoadBalancer\reuseConnection(), Wikimedia\Rdbms\LoadBalancer\safeWaitForMasterPos(), Wikimedia\Rdbms\LoadBalancer\setDomainPrefix(), and Wikimedia\Rdbms\LoadBalancer\undoTransactionRoundFlags().

◆ getMasterPos()

Wikimedia\Rdbms\IDatabase::getMasterPos ( )

Get the position of this master.

Returns
DBMasterPos|bool False if this is not a master
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.

◆ getReplicaPos()

Wikimedia\Rdbms\IDatabase::getReplicaPos ( )

Get the replication position of this replica DB.

Returns
DBMasterPos|bool False if this is not a replica DB
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.

◆ getScopedLockAndFlush()

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

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

Only call this from outer 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$lockKeyName of lock to release
string$fnameName of the calling method
int$timeoutAcquisition timeout in seconds
Returns
ScopedCallback|null
Exceptions
DBError
Since
1.27

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by LinksUpdate\acquirePageLock(), DatabaseTest\badLockingMethodExplicit(), DatabaseTest\badLockingMethodImplicit(), and UserGroupMembership\purgeExpired().

◆ getServer()

Wikimedia\Rdbms\IDatabase::getServer ( )

Get the server hostname or IP address.

Returns
string

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.

Referenced by Wikimedia\Rdbms\LoadBalancer\closeAll(), and Wikimedia\Rdbms\LoadBalancer\safeWaitForMasterPos().

◆ getServerInfo()

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

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

◆ getServerUptime()

Wikimedia\Rdbms\IDatabase::getServerUptime ( )

Determines how long the server has been up.

Returns
int
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.

◆ getServerVersion()

Wikimedia\Rdbms\IDatabase::getServerVersion ( )

A string describing the current software version, like from mysql_get_server_info().

Returns
string Version information from the database server.

Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

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

◆ getSessionLagStatus()

Wikimedia\Rdbms\IDatabase::getSessionLagStatus ( )

Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active.

This is useful when transactions might use snapshot isolation (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data is this lag plus transaction duration. If they don't, it is still safe to be pessimistic. In AUTOCOMMIT mode, this still gives an indication of the staleness of subsequent reads.

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

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ getSoftwareLink()

Wikimedia\Rdbms\IDatabase::getSoftwareLink ( )

Returns a wikitext link to the DB's website, e.g., return "[https://www.mysql.com/ MySQL]"; Should at least contain plain text, if for some reason your database has no website.

Returns
string Wikitext of a link to the server software's web site

Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

◆ getType()

Wikimedia\Rdbms\IDatabase::getType ( )

Get the type of the DBMS, as it appears in $wgDBtype.

Returns
string

Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

Referenced by SearchEngineFactory\getSearchEngineClass(), DatabaseInstaller\getSqlFilePath(), WatchedItemQueryService\getWatchedItemsWithRCInfoQueryConds(), MediaWikiTestCase\listTables(), DatabaseUpdater\newForDB(), DatabaseUpdater\patchPath(), LBFactoryTest\quoteTable(), MediaWikiTestCase\resetDB(), MediaWikiTestCase\setupDatabaseWithTestPrefix(), MediaWikiTestCase\setupTestDB(), and LBFactoryTest\testInvalidSelectDB().

◆ getWikiID()

Wikimedia\Rdbms\IDatabase::getWikiID ( )

Alias for getDomainID()

Returns
string
Deprecated
1.30

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ implicitGroupby()

Wikimedia\Rdbms\IDatabase::implicitGroupby ( )

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

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

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ implicitOrderby()

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

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.

◆ indexExists()

Wikimedia\Rdbms\IDatabase::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
Exceptions
DBError

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ insert()

Wikimedia\Rdbms\IDatabase::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$tableTable name. This will be passed through Database::tableName().
array$aArray of rows to insert
string$fnameCalling function name (use METHOD) for logs/profiling
array$optionsArray of options
Returns
bool
Exceptions
DBError

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMssql.

Referenced by MigrateActors\addActorsForRows(), CommentStore\createComment(), UserGroupMembership\delete(), JobQueueDB\doBatchPushInternal(), DBFileJournal\doLogChangeBatch(), UserGroupMembership\insert(), CommentStore\insertInternal(), MediaWiki\Storage\RevisionStore\insertRevisionOn(), MigrateComments\loadCommentIDs(), UserGroupMembership\purgeExpired(), QueryPage\recache(), and User\updateActorId().

◆ insertId()

Wikimedia\Rdbms\IDatabase::insertId ( )

Get the inserted value of an auto-increment row.

This should only be called after an insert that used an auto-incremented value. If no such insert was previously done in the current database session, the return value is undefined.

Returns
int

Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

Referenced by CommentStore\createComment(), MediaWiki\Storage\RevisionStore\insertRevisionOn(), and User\updateActorId().

◆ insertSelect()

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

INSERT SELECT wrapper.

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

Warning
If the insert will use an auto-increment or sequence to determine the value of a column, this may break replication on databases using statement-based replication if the SELECT is not deterministically ordered.
Parameters
string$destTableThe table name to insert into
string | array$srcTableMay be either a table name, or an array of table names to include in a join.
array$varMapMust 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$condsCondition array. See $conds in IDatabase::select() for the details of the format of condition arrays. May be "*" to copy the whole table.
string$fnameThe function name of the caller, from METHOD
array$insertOptionsOptions for the INSERT part of the query, see IDatabase::insert() for details. Also, one additional option is available: pass 'NO_AUTO_COLUMNS' to hint that the query does not use an auto-increment or sequence to determine any column values.
array$selectOptionsOptions for the SELECT part of the query, see IDatabase::select() for details.
array$selectJoinCondsJoin conditions for the SELECT part of the query, see IDatabase::select() for details.
Returns
bool
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ isOpen()

Wikimedia\Rdbms\IDatabase::isOpen ( )

Is a connection to the database open?

Returns
bool

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

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

◆ isReadOnly()

Wikimedia\Rdbms\IDatabase::isReadOnly ( )
Returns
bool Whether this DB is read-only
Since
1.27

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ lastDoneWrites()

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

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

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

◆ lastErrno()

Wikimedia\Rdbms\IDatabase::lastErrno ( )

Get the last error number.

See also
https://secure.php.net/mysql_errno
Returns
int

Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchRow(), Wikimedia\Rdbms\Database\wasConnectionLoss(), Wikimedia\Rdbms\DatabaseMysqlBase\wasDeadlock(), Wikimedia\Rdbms\DatabaseMysqlBase\wasKnownStatementRollbackError(), Wikimedia\Rdbms\DatabaseMysqlBase\wasLockTimeout(), and Wikimedia\Rdbms\DatabaseMysqlBase\wasReadOnlyError().

◆ lastError()

Wikimedia\Rdbms\IDatabase::lastError ( )

Get a description of the last error.

See also
https://secure.php.net/mysql_error
Returns
string

Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

Referenced by MediaWikiTestCase\assertSelect(), Wikimedia\Rdbms\Database\reportConnectionError(), and Wikimedia\Rdbms\Database\sourceStream().

◆ lastQuery()

Wikimedia\Rdbms\IDatabase::lastQuery ( )

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

Returns
string

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ lock()

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

Acquire a named lock.

Named locks are not related to transactions

Parameters
string$lockNameName of lock to aquire
string$methodName of the calling method
int$timeoutAcquisition timeout in seconds
Returns
bool
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ lockIsFree()

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

Check to see if a named lock is not locked by any thread (non-blocking)

Parameters
string$lockNameName of lock to poll
string$methodName of method calling us
Returns
bool
Exceptions
DBError
Since
1.20

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.

◆ makeList()

Wikimedia\Rdbms\IDatabase::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_page' => $id,
$db->makeList( [ 'rev_minor' => 1, 'rev_len' < 500 ], $db::LIST_OR ] )
], $db::LIST_AND );

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

Parameters
array$aContaining the data
int$modeIDatabase 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

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by WatchedItemQueryService\getExtraDeletedPageLogEntryRelatedCond(), WatchedItemQueryService\getFromUntilTargetConds(), WatchedItemQueryService\getStartFromConds(), WANCacheReapUpdate\getTitleChangeEvents(), WatchedItemStore\getVisitingWatchersCondition(), WatchedItemQueryService\getWatchedItemsWithRCInfoQueryConds(), ActorMigration\getWhere(), MigrateComments\loadCommentIDs(), and UserGroupMembership\purgeExpired().

◆ makeWhereFrom2d()

Wikimedia\Rdbms\IDatabase::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$dataOrganized as 2-d [ baseKeyVal => [ subKeyVal => [ignored], ... ], ... ]
string$baseKeyField name to match the base-level keys to (eg 'pl_namespace')
string$subKeyField name to match the sub-level keys to (eg 'pl_title')
Returns
string|bool SQL fragment, or false if no items in array

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ masterPosWait()

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

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

Parameters
DBMasterPos$pos
int$timeoutThe 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
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.

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

◆ maxListLen()

Wikimedia\Rdbms\IDatabase::maxListLen ( )

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

Returns
int

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ namedLocksEnqueue()

Wikimedia\Rdbms\IDatabase::namedLocksEnqueue ( )

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

Returns
bool
Since
1.26

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.

◆ nextSequenceValue()

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

Deprecated method, calls should be removed.

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

Implementations should return null if inserting NULL into an auto-incrementing field works, otherwise it should return an instance of NextSequenceValue and filter it on calls to relevant methods.

Deprecated
since 1.30, no longer needed
Parameters
string$seqName
Returns
null|NextSequenceValue

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.

◆ numFields()

Wikimedia\Rdbms\IDatabase::numFields ( $res)

Get the number of fields in a result object.

See also
https://secure.php.net/mysql_num_fields
Parameters
mixed$resA SQL result
Returns
int

Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

◆ numRows()

Wikimedia\Rdbms\IDatabase::numRows ( $res)

Get the number of rows in a result object.

Parameters
mixed$resA SQL result
Returns
int

Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

◆ onTransactionIdle()

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

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.

When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.

Queries in the function will run in AUTOCOMMIT 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 suffer from lock timeouts and deadlocks, but where atomicity is not essential.

Updates will execute in the order they were enqueued.

Note
: do not assume that other IDatabase instances will be AUTOCOMMIT mode

The callback takes one argument:

  • How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_IDLE)
Parameters
callable$callback
string$fnameCaller name
Since
1.20

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by PurgeJobUtils\invalidatePages().

◆ onTransactionPreCommitOrIdle()

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

Run a callback before the current transaction commits or now if there is none.

If there is a transaction and it is rolled back, then the callback is cancelled.

When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just before all peer transactions COMMIT. If the transaction round 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 suffer from lock timeouts and deadlocks, 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$fnameCaller name
Since
1.22

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ onTransactionResolution()

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

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 AUTOCOMMIT mode unless there are begin() calls. Callbacks must commit any transactions that they begin.

This is useful for combining cooperative locks and DB transactions.

Note
: do not assume that other IDatabase instances will be AUTOCOMMIT mode

The callback takes one argument:

  • How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK)
Parameters
callable$callback
string$fnameCaller name
Returns
mixed
Since
1.28

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ open()

Wikimedia\Rdbms\IDatabase::open ( $server,
$user,
$password,
$dbName )

Open a new connection to the database (closing any existing one)

Parameters
string$serverDatabase server host
string$userDatabase user name
string$passwordDatabase user password
string$dbNameDatabase name
Returns
bool
Exceptions
DBConnectionError

Implemented in Wikimedia\Rdbms\DatabaseSqlite, DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

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

◆ pendingWriteCallers()

Wikimedia\Rdbms\IDatabase::pendingWriteCallers ( )

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

Returns
array
Since
1.27

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

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

◆ pendingWriteQueryDuration()

Wikimedia\Rdbms\IDatabase::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$typeIDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL]
Returns
float|bool Returns false if not transaction is active
Since
1.26

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

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

◆ pendingWriteRowsAffected()

Wikimedia\Rdbms\IDatabase::pendingWriteRowsAffected ( )

Get the number of affected rows from pending write queries.

Returns
int
Since
1.30

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ ping()

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

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

Parameters
float | null&$rttValue to store the estimated RTT [optional]
Returns
bool Success or failure

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

Referenced by Wikimedia\Rdbms\LoadBalancer\approveMasterChanges(), and Wikimedia\Rdbms\LoadBalancer\pingAll().

◆ query()

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

If a connection loss is detected, then an attempt to reconnect will be made. For queries that involve no larger transactions or locks, they will be re-issued for convenience, provided the connection was re-established.

In new code, the query wrappers select(), insert(), update(), delete(), etc. should be used where possible, since they give much better DBMS independence and automatically quote or validate user input in a variety of contexts. This function is generally only useful for queries which are explicitly DBMS-dependent and are unsupported by the query wrappers, such as CREATE TABLE.

However, the query wrappers themselves should call this function.

Parameters
string$sqlSQL query
string$fnameName of the calling function, for profiling/SHOW PROCESSLIST comment (you can use METHOD or add some extra info)
bool$tempIgnoreWhether to avoid throwing an exception on errors... maybe best to catch the exception instead?
Returns
bool|IResultWrapper True for a successful write query, IResultWrapper object for a successful read query, or false on failure if $tempIgnore set
Exceptions
DBError

Implemented in DatabaseSqliteMock, DatabaseTestHelper, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by DatabaseTest\badLockingMethodImplicit(), MediaWikiTestCase\dropMockTables(), MySqlLockManager\initConnection(), and MwSql\sqlDoQuery().

◆ replace()

Wikimedia\Rdbms\IDatabase::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$tableThe table to replace the row(s) in.
array$uniqueIndexesIs an array of indexes. Each element may be either a field name or an array of field names
array$rowsCan be either a single row to insert, or multiple rows, in the same format as for IDatabase::insert()
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ restoreFlags()

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

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

Parameters
string$stateIDatabase::RESTORE_* constant. [default: RESTORE_PRIOR]
Since
1.28

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

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

◆ rollback()

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

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

Query, connection, and onTransaction* callback errors will be suppressed and logged.

Parameters
string$fnameCalling function name
string$flushFlush 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
DBError
Since
1.23 Added $flush parameter

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by Wikimedia\Rdbms\LoadBalancer\rollbackMasterChanges(), and Maintenance\rollbackTransaction().

◆ select()

Wikimedia\Rdbms\IDatabase::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$tableTable name
string | array$varsField names
string | array$condsConditions
string$fnameCaller function name
array$optionsQuery options
array$join_condsJoin 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).

A derived table, defined by the result of selectSQLText(), requires an alias key and a Subquery instance value which wraps the SQL query, for example:

[ 'c' => new Subquery( 'SELECT ...' ) ]

Joins using parentheses for grouping (since MediaWiki 1.31) may be constructed using nested arrays. For example,

[ 'tableA', 'nestedB' => [ 'tableB', 'b2' => 'tableB2' ] ]

along with $join_conds like

[ 'b2' => [ 'JOIN', 'b_id = b2_id' ], 'nestedB' => [ 'LEFT JOIN', 'b_a = a_id' ] ]

will produce SQL something like

FROM tableA LEFT JOIN (tableB JOIN tableB2 AS b2 ON (b_id = b2_id)) ON (b_a = a_id)

All of the table names given here are automatically run through Database::tableName(), which causes the table prefix (if any) to be added, and various other table name mappings to be performed.

Do not use untrusted user input as a table name. Alias names should not have characters outside of the Basic multilingual plane.

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
IResultWrapper Resulting rows
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DBConnRef.

Referenced by MigrateActors\addActorsForRows(), JobQueueDB\doBatchPushInternal(), DBFileJournal\doGetChangeEntries(), RefreshImageMetadata\execute(), ResourceLoaderWikiModule\fetchTitleInfo(), WANCacheReapUpdate\getTitleChangeEvents(), MediaWiki\Storage\RevisionStore\listRevisionSizes(), MigrateComments\loadCommentIDs(), MediaWiki\Storage\NameTableStore\loadTable(), PopulateContentModel\populatePage(), PopulateContentModel\populateRevisionOrArchive(), UserGroupMembership\purgeExpired(), OATHAuthHooks\schemaUpdateOldUsers(), and MediaWiki\Storage\RevisionStore\userWasLastToEdit().

◆ selectDB()

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

Change the current database.

Parameters
string$db
Returns
bool Success or failure
Exceptions
DBConnectionErrorIf databasesAreIndependent() is true and an error occurs

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.

◆ selectField()

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

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

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$tableTable name. See IDatabase::select() for details.
string$varThe field name to select. This must be a valid SQL fragment: do not use unvalidated user input.
string | array$condThe condition array. See IDatabase::select() for details.
string$fnameThe function name of the caller.
string | array$optionsThe query options. See IDatabase::select() for details.
string | array$join_condsThe query join conditions. See IDatabase::select() for details.
Returns
mixed The value from the field
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by CommentStore\createComment(), DBFileJournal\doGetCurrentPosition(), DBFileJournal\doGetPositionAtTime(), MediaWiki\Storage\RevisionStore\getPreviousRevisionId(), PopulateArchiveRevId\makeDummyRevisionRow(), and LocalFileMoveBatch\verifyDBUpdates().

◆ selectFieldValues()

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

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

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$tableTable name. See IDatabase::select() for details.
string$varThe field name to select. This must be a valid SQL fragment: do not use unvalidated user input.
string | array$condThe condition array. See IDatabase::select() for details.
string$fnameThe function name of the caller.
string | array$optionsThe query options. See IDatabase::select() for details.
string | array$join_condsThe query join conditions. See IDatabase::select() for details.
Returns
array The values from the field
Exceptions
DBError
Since
1.25

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by PurgeJobUtils\invalidatePages(), Block\purgeExpired(), and Title\purgeExpiredRestrictions().

◆ selectRow()

Wikimedia\Rdbms\IDatabase::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$tableTable name
string | array$varsField names
array$condsConditions
string$fnameCaller function name
string | array$optionsQuery options
array | string$join_condsJoin conditions
Returns
stdClass|bool
Exceptions
DBError

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by MediaWiki\Storage\RevisionStore\countRevisionsByPageId(), SiteStats\doLoadFromDB(), LinkCache\fetchPageRow(), MediaWiki\Storage\RevisionStore\fetchRevisionRowFromConds(), ActorMigration\getExistingActorId(), UserGroupMembership\insert(), PopulateArchiveRevId\makeDummyRevisionRow(), DatabaseLogEntry\newFromId(), and MediaWiki\Storage\RevisionStore\newNullRevision().

◆ selectRowCount()

Wikimedia\Rdbms\IDatabase::selectRowCount ( $tables,
$var = ' *',
$conds = '',
$fname = __METHOD__,
$options = [],
$join_conds = [] )

Get the number of rows in dataset.

This is useful when trying to do COUNT(*) but with a LIMIT for performance.

Takes the same arguments as IDatabase::select().

Since
1.27 Added $join_conds parameter
Parameters
array | string$tablesTable names
string$varColumn for which NULL values are not counted [default "*"]
array | string$condsFilters on the table
string$fnameFunction name for profiling
array$optionsOptions for select
array$join_condsJoin conditions (since 1.27)
Returns
int Row count
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ selectSQLText()

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

See also
IDatabase::select()
Parameters
string | array$tableTable name
string | array$varsField names
string | array$condsConditions
string$fnameCaller function name
string | array$optionsQuery options
string | array$join_condsJoin conditions
Returns
string SQL query string

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.

◆ serverIsReadOnly()

Wikimedia\Rdbms\IDatabase::serverIsReadOnly ( )
Returns
bool Whether the DB is marked as read-only server-side
Since
1.28

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.

◆ setBigSelects()

Wikimedia\Rdbms\IDatabase::setBigSelects ( $value = true)

Allow or deny "big selects" for this session only.

This is done by setting the sql_big_selects session variable.

This is a MySQL-specific feature.

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

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.

◆ setFlag()

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

Set a flag for this connection.

Parameters
int$flagDBO_* 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$rememberIDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

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

◆ setIndexAliases()

Wikimedia\Rdbms\IDatabase::setIndexAliases ( array $aliases)

Convert certain index names to alternative names before querying the DB.

Note that this applies to indexes regardless of the table they belong to.

This can be employed when an index was renamed X => Y in code, but the new Y-named indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA, the aliases can be removed, and then the old X-named indexes dropped.

Parameters
string[]$aliases
Returns
mixed
Since
1.31

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ setLazyMasterHandle()

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

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

Parameters
IDatabase$conn
Since
1.27

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ setLBInfo()

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

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by Wikimedia\Rdbms\LoadBalancer\applyTransactionRoundFlags(), Wikimedia\Rdbms\LoadBalancer\reuseConnection(), and Wikimedia\Rdbms\LoadBalancer\undoTransactionRoundFlags().

◆ setSchemaVars()

Wikimedia\Rdbms\IDatabase::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$varsMapping variable name to value.

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ setSessionOptions()

Wikimedia\Rdbms\IDatabase::setSessionOptions ( array $options)

Override database's default behavior.

$options include: 'connTimeout' : Set the connection timeout value in seconds. May be useful for very long batch queries such as full-wiki dumps, where a single query reads out over hours or days.

Parameters
array$options
Returns
void
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.

Referenced by BackupDumper\backupDb().

◆ setTableAliases()

Wikimedia\Rdbms\IDatabase::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[]$aliasesMap of (table => (dbname, schema, prefix) map)
Since
1.28

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ setTransactionListener()

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

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$nameCallback name
callable | null$callbackUse null to unset a listener
Returns
mixed
Since
1.28

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

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

◆ startAtomic()

Wikimedia\Rdbms\IDatabase::startAtomic ( $fname = __METHOD__,
$cancelable = self::ATOMIC_NOT_CANCELABLE )

Begin an atomic section of SQL statements.

Start an implicit transaction if no transaction is already active, set a savepoint (if $cancelable is ATOMIC_CANCELABLE), and track the given section name to enforce that the transaction is not committed prematurely. The end of the section must be signified exactly once, either by endAtomic() or cancelAtomic(). Sections can have have layers of inner sections (sub-sections), but all sections must be ended in order of innermost to outermost. Transactions cannot be started or committed until all atomic sections are closed.

ATOMIC_CANCELABLE is useful when the caller needs to handle specific failure cases by discarding the section's writes. This should not be used for failures when:

  • upsert() could easily be used instead
  • insert() with IGNORE could easily be used instead
  • select() with FOR UPDATE could be checked before issuing writes instead
  • The failure is from code that runs after the first write but doesn't need to
  • The failures are from contention solvable via onTransactionPreCommitOrIdle()
  • The failures are deadlocks; the RDBMs usually discard the whole transaction
Note
: callers must use additional measures for situations involving two or more (peer) transactions (e.g. updating two database servers at once). The transaction and savepoint logic of this method only applies to this specific IDatabase instance.

Example usage:

// Start a transaction if there isn't one already
$dbw->startAtomic( __METHOD__ );
// Serialize these thread table updates
$dbw->select( 'thread', '1', [ 'td_id' => $tid ], __METHOD__, 'FOR UPDATE' );
// Add a new comment for the thread
$dbw->insert( 'comment', $row, __METHOD__ );
$cid = $db->insertId();
// Update thread reference to last comment
$dbw->update( 'thread', [ 'td_latest' => $cid ], [ 'td_id' => $tid ], __METHOD__ );
// Demark the end of this conceptual unit of updates
$dbw->endAtomic( __METHOD__ );

Example usage (atomic changes that might have to be discarded):

// Start a transaction if there isn't one already
$sectionId = $dbw->startAtomic( __METHOD__, $dbw::ATOMIC_CANCELABLE );
// Create new record metadata row
$dbw->insert( 'records', $row, __METHOD__ );
// Figure out where to store the data based on the new row's ID
$path = $recordDirectory . '/' . $dbw->insertId();
// Write the record data to the storage system
$status = $fileBackend->create( [ 'dst' => $path, 'content' => $data ] );
if ( $status->isOK() ) {
// Try to cleanup files orphaned by transaction rollback
$dbw->onTransactionResolution(
function ( $type ) use ( $fileBackend, $path ) {
if ( $type === IDatabase::TRIGGER_ROLLBACK ) {
$fileBackend->delete( [ 'src' => $path ] );
}
},
__METHOD__
);
// Demark the end of this conceptual unit of updates
$dbw->endAtomic( __METHOD__ );
} else {
// Discard these writes from the transaction (preserving prior writes)
$dbw->cancelAtomic( __METHOD__, $sectionId );
}
$status
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action or null $user:User who performed the tagging when the tagging is subsequent to the action or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy: boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition hooks.txt:1051
Since
1.23
Parameters
string$fname
string$cancelablePass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section.
Returns
AtomicSectionIdentifier section ID token
Exceptions
DBError

Implemented in Wikimedia\Rdbms\DBConnRef, and Wikimedia\Rdbms\Database.

Referenced by JobQueueDB\doBatchPushInternal(), MySqlLockManager\initConnection(), and UserGroupMembership\purgeExpired().

◆ strreplace()

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

Returns a command for str_replace function in SQL query.

Uses REPLACE() in MySQL

Parameters
string$origColumn to modify
string$oldColumn to seek
string$newColumn to replace with
Returns
string

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ tableExists()

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

Query whether a given table exists.

Parameters
string$table
string$fname
Returns
bool
Exceptions
DBError

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

◆ tablePrefix()

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

Get/set the table prefix.

Parameters
string$prefixThe table prefix to set, or omitted to leave it unchanged.
Returns
string The previous table prefix.

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by MediaWikiTestCase\ensureMockDatabaseConnection(), MediaWikiTestCase\listTables(), MediaWikiTestCase\recloneMockTables(), and MediaWikiTestCase\setupDatabaseWithTestPrefix().

◆ timestamp()

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

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.

Referenced by DBFileJournal\doGetPositionAtTime(), DBFileJournal\doLogChangeBatch(), DBFileJournal\doPurgeOldLogs(), UserGroupMembership\getDatabaseArray(), Block\getDatabaseArray(), WatchedItemQueryService\getStartEndConds(), WatchedItemQueryService\getStartFromConds(), WANCacheReapUpdate\getTitleChangeEvents(), WatchedItemStore\getVisitingWatchersCondition(), UserGroupMembership\insert(), MediaWiki\Storage\RevisionStore\insertRevisionOn(), Title\invalidateCache(), PurgeJobUtils\invalidatePages(), MediaWiki\Storage\RevisionStore\loadRevisionFromTimestamp(), PopulateArchiveRevId\makeDummyRevisionRow(), Block\purgeExpired(), UserGroupMembership\purgeExpired(), Title\purgeExpiredRestrictions(), QueryPage\recache(), and MediaWiki\Storage\RevisionStore\userWasLastToEdit().

◆ timestampOrNull()

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

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ trxLevel()

Wikimedia\Rdbms\IDatabase::trxLevel ( )

Gets the current transaction level.

Historically, transactions were allowed to be "nested". This is no longer supported, so this function really only returns a boolean.

Returns
int The previous value

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ trxTimestamp()

Wikimedia\Rdbms\IDatabase::trxTimestamp ( )

Get the UNIX timestamp of the time that the transaction was established.

This can be used to reason about the staleness of SELECT data in REPEATABLE-READ transaction isolation level.

Returns
float|null Returns null if there is not active transaction
Since
1.25

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ unionConditionPermutations()

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

Construct a UNION query for permutations of conditions.

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

See also
IDatabase::select()
Since
1.30
Parameters
string | array$tableTable name
string | array$varsField names
array$permute_condsConditions for the Cartesian product. Keys are field names, values are arrays of the possible values for that field.
string | array$extra_condsAdditional conditions to include in the query.
string$fnameCaller function name
string | array$optionsQuery options. In addition to the options recognized by IDatabase::select(), the following may be used:
  • NOTALL: Set to use UNION instead of UNION ALL.
  • INNER ORDER BY: If specified and supported, subqueries will use this instead of ORDER BY.
string | array$join_condsJoin conditions
Returns
string SQL query string.

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ unionQueries()

Wikimedia\Rdbms\IDatabase::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$sqlsSQL statements to combine
bool$allUse UNION ALL
Returns
string SQL fragment

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ unionSupportsOrderAndLimit()

Wikimedia\Rdbms\IDatabase::unionSupportsOrderAndLimit ( )

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

Returns
bool

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseTestHelper.

◆ unlock()

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

Release a lock.

Named locks are not related to transactions

Parameters
string$lockNameName of lock to release
string$methodName 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
Exceptions
DBError

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ update()

Wikimedia\Rdbms\IDatabase::update ( $table,
$values,
$conds,
$fname = __METHOD__,
$options = [] )

UPDATE wrapper.

Takes a condition array and a SET array.

Parameters
string$tableName of the table to UPDATE. This will be passed through Database::tableName().
array$valuesAn 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(). Values with integer keys form unquoted SET statements, which can be used for things like "field = field + 1" or similar computed values.
array$condsAn array of conditions (WHERE). See IDatabase::select() for the details of the format of condition arrays. Use '*' to update all rows.
string$fnameThe function name of the caller (from METHOD), for logging and profiling.
array$optionsAn array of UPDATE options, can be:
  • IGNORE: Ignore unique key conflicts
  • LOW_PRIORITY: MySQL-specific, see MySQL manual.
Returns
bool
Exceptions
DBError

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DBConnRef.

Referenced by SiteStatsUpdate\cacheUpdate(), LocalFileMoveBatch\doDBUpdates(), UserGroupMembership\insert(), Title\invalidateCache(), PurgeJobUtils\invalidatePages(), OATHAuthHooks\schemaUpdateOldUsers(), PopulateContentModel\updatePageRows(), and PopulateContentModel\updateRevisionOrArchiveRows().

◆ upsert()

Wikimedia\Rdbms\IDatabase::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$tableTable name. This will be passed through Database::tableName().
array$rowsA single row or list of rows to insert
array$uniqueIndexesList of single field names or field name tuples
array$setAn 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(). Values with integer keys form unquoted SET statements, which can be used for things like "field = field + 1" or similar computed values.
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBError
Returns
bool

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.

Referenced by ActorMigration\getInsertValuesWithTempTable().

◆ wasConnectionLoss()

Wikimedia\Rdbms\IDatabase::wasConnectionLoss ( )

Determines if the last query error was due to a dropped connection.

Note that during a connection loss, the prior transaction will have been lost

Returns
bool
Since
1.31

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ wasDeadlock()

Wikimedia\Rdbms\IDatabase::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

Note that during a deadlock, the prior transaction will have been lost

Returns
bool

Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ wasErrorReissuable()

Wikimedia\Rdbms\IDatabase::wasErrorReissuable ( )

Determines if the last query error was due to something outside of the query itself.

Note that the transaction may have been lost, discarding prior writes and results

Returns
bool

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

◆ wasLockTimeout()

Wikimedia\Rdbms\IDatabase::wasLockTimeout ( )

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

Note that during a lock wait timeout, the prior transaction will have been lost

Returns
bool

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.

◆ wasReadOnlyError()

Wikimedia\Rdbms\IDatabase::wasReadOnlyError ( )

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

Returns
bool

Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.

◆ writesOrCallbacksPending()

Wikimedia\Rdbms\IDatabase::writesOrCallbacksPending ( )

Returns true if there is a transaction/round 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

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

Referenced by Wikimedia\Rdbms\LoadBalancer\approveMasterChanges(), DeferredUpdates\areDatabaseTransactionsActive(), Wikimedia\Rdbms\LoadBalancer\commitMasterChanges(), and Wikimedia\Rdbms\LoadBalancer\hasMasterChanges().

◆ writesPending()

Wikimedia\Rdbms\IDatabase::writesPending ( )
Returns
bool Whether there is a transaction open with possible write queries
Since
1.27

Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.

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