MediaWiki master
Wikimedia\Rdbms\Database Class Reference

Relational database abstraction object. More...

Inherits Stringable, Wikimedia\Rdbms\IDatabaseForOwner, Wikimedia\Rdbms\IMaintainableDatabase, and LoggerAwareInterface.

Inherited by Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.

Collaboration diagram for Wikimedia\Rdbms\Database:

Public Member Functions

 __clone ()
 Make sure that copies do not share the same client binding handle.
 
 __destruct ()
 Run a few simple checks and close dangling connections.
 
 __sleep ()
 Called by serialize.
 
 __toString ()
 Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present.
 
 addIdentifierQuotes ( $s)
 Escape a SQL identifier (e.g.
 
 addQuotes ( $s)
 Escape and quote a raw value string for use in a SQL query.
 
 affectedRows ()
 Get the number of rows affected by the last query method call.
 
 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)
 
 buildComparison (string $op, array $conds)
 Build a condition comparing multiple values, for use with indexes that cover multiple fields, common when e.g.
 
 buildConcat ( $stringList)
 Build a concatenation list to feed into a SQL query.
 
 buildExcludedValue ( $column)
 Build a reference to a column value from the conflicting proposed upsert() row.
 
 buildGreatest ( $fields, $values)
 Build a GREATEST function statement comparing columns/values.
 
 buildGroupConcatField ( $delim, $tables, $field, $conds='', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query.
 
 buildIntegerCast ( $field)
 
 buildLeast ( $fields, $values)
 Build a LEAST function statement comparing columns/values.
 
 buildLike ( $param,... $params)
 LIKE statement wrapper.
 
 buildSelectSubquery ( $tables, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery.
 
 buildStringCast ( $field)
 
 buildSubstring ( $input, $startPosition, $length=null)
 
 cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
 Cancel an atomic section of SQL statements.
 
 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection.
 
 close ( $fname=__METHOD__)
 Close the database connection.
 
 commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commits a transaction previously started using begin()
 
 conditional ( $cond, $caseTrueExpression, $caseFalseExpression)
 Returns an SQL expression for a simple conditional.
 
 connectionErrorLogger ( $errno, $errstr)
 Error handler for logging errors during database connection.
 
 databasesAreIndependent ()
 Returns true if DBs are assumed to be on potentially different servers.
 
 dbSchema ( $schema=null)
 Get/set the db schema.
 
 decodeBlob ( $b)
 Some DBMSs return a special placeholder object representing blob fields in result objects.
 
 decodeExpiry ( $expiry, $format=TS_MW)
 Decode an expiry time into a DBMS independent format.
 
 delete ( $table, $conds, $fname=__METHOD__)
 Delete all rows in a table that match a condition.
 
 deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
 Delete all rows in a table that match a condition which includes a join.
 
 doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Perform an atomic section of reversible SQL statements from a callback.
 
 dropTable ( $table, $fname=__METHOD__)
 Delete a table.
 
 duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
 Creates a new table with structure copied from existing table.
 
 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 ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Estimate the number of rows in dataset.MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).Takes the same arguments as IDatabase::select().New callers should use newSelectQueryBuilder with SelectQueryBuilder::estimateRowCount instead, which is more readable and less error-prone.
Access: internal
Parameters
string | string[]$tablesUnqualified name of table(s)
string$varColumn for which NULL values are not counted [default "*"]
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$conds Filters on the table
string$fnameFunction name for profiling
array$optionsOptions for select
array | string$join_condsJoin conditions
Returns
int Row count
Exceptions
DBErrorIf an error occurs, {
See also
query}

 
 explicitTrxActive ()
 Check whether there is a transaction open at the specific request of a caller.
 
 expr (string $field, string $op, $value)
 See Expression::__construct()
 
 factorConds ( $condsArray)
 Given an array of condition arrays representing an OR list of AND lists, for example:
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table.
 
 flushSession ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Release important session-level state (named lock, table locks) as post-rollback cleanup.
 
 flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commit any transaction but error out if writes or callbacks are pending.
 
 getDBname ()
 Get the current database name; null if there isn't one.
 
 getDomainID ()
 Return the currently selected domain ID.
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection.
 
 getInfinity ()
 Find out when 'infinity' is.
 
 getLag ()
 Get the seconds of replication lag on this database server.
 
 getLBInfo ( $name=null)
 Get properties passed down from the server info array of the load balancer.
 
 getPrimaryPos ()
 Get the replication position of this primary DB server.
 
 getScopedLockAndFlush ( $lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
 
 getServer ()
 Get the hostname or IP address of the server.
 
 getServerInfo ()
 Get a human-readable string describing the current software version.
 
 getServerName ()
 Get the readable name for the server.
 
 getSessionLagStatus ()
 Get a cached estimate of the seconds of replication lag on this database server, using the estimate obtained at the start of the current transaction if one is active.
 
 getTableAliases ()
 Return current table aliases.
 
 implicitOrderby ()
 Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1.
 
 indexExists ( $table, $index, $fname=__METHOD__)
 Determines whether an index exists.
 
 indexInfo ( $table, $index, $fname=__METHOD__)
 Get information about an index into an object.
 
 indexUnique ( $table, $index, $fname=__METHOD__)
 Determines if a given index is unique.
 
 initConnection ()
 Initialize the connection to the database over the wire (or to local files)
 
 insert ( $table, $rows, $fname=__METHOD__, $options=[])
 Insert row(s) into a table, in the provided order.
 
 insertId ()
 Get the sequence-based ID assigned by the last query method call.
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 INSERT SELECT wrapper.
 
 isOpen ()
 
 isQuotedIdentifier ( $name)
 
 isReadOnly ()
 Check if this DB server is marked as read-only according to load balancer info.
 
 lastDoneWrites ()
 Get the last time the connection may have been used for a write query.
 
 limitResult ( $sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset.
 
 listTables ( $prefix=null, $fname=__METHOD__)
 List all tables on the database.
 
 lock ( $lockName, $method, $timeout=5, $flags=0)
 Acquire a named lock.Named locks are not related to transactions
Parameters
string$lockNameName of lock to acquire
string$methodName of the calling method
int$timeoutAcquisition timeout in seconds (0 means non-blocking)
int$flagsBit field of IDatabase::LOCK_* constants
Returns
bool|float|null Success (bool); acquisition time (float/null) if LOCK_TIMESTAMP
Exceptions
DBErrorIf an error occurs, {
See also
query}

 
 lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Lock all rows meeting the given conditions/options FOR UPDATE.
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is not locked by any thread (non-blocking)
Parameters
string$lockNameName of lock to poll
string$methodName of method calling us
Returns
bool
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.20

 
 makeList (array $a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array.
 
 makeWhereFrom2d ( $data, $baseKey, $subKey)
 Build a "OR" condition with pairs from a two-dimensional array.
 
 newDeleteQueryBuilder ()
 Get a DeleteQueryBuilder bound to this connection.
 
 newInsertQueryBuilder ()
 Get a InsertQueryBuilder bound to this connection.
 
 newReplaceQueryBuilder ()
 Get a ReplaceQueryBuilder bound to this connection.
 
 newSelectQueryBuilder ()
 Get a SelectQueryBuilder bound to this connection.
 
 newUnionQueryBuilder ()
 Get a UnionQueryBuilder bound to this connection.
 
 newUpdateQueryBuilder ()
 Get an UpdateQueryBuilder bound to this connection.
 
 onAtomicSectionCancel (callable $callback, $fname=__METHOD__)
 Run a callback when the atomic section is cancelled.
 
 onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback when the current transaction commits or now if there is none.
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none.
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback when the current transaction commits or rolls back.
 
 pendingWriteAndCallbackCallers ()
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction.
 
 pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction.
 
 ping ()
 Ping the server and try to reconnect if it there is no connection.
 
 primaryPosWait (DBPrimaryPos $pos, $timeout)
 Wait for the replica server to catch up to a given primary server position.
 
 query ( $sql, $fname=__METHOD__, $flags=0)
 Run an SQL query statement and return the result.
 
 replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__)
 Insert row(s) into a table, in the provided order, while deleting conflicting rows.
 
 reportQueryError ( $error, $errno, $sql, $fname, $ignore=false)
 Report a query error.
 
 restoreFlags ( $state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call.
 
 rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Rollback a transaction previously started using begin()
 
 runOnTransactionIdleCallbacks ( $trigger, array &$errors=[])
 Consume and run any "on transaction idle/resolution" callbacks.
 
 runOnTransactionPreCommitCallbacks ()
 
 runTransactionListenerCallbacks ( $trigger, array &$errors=[])
 Actually run any "transaction listener" callbacks.
 
 select ( $tables, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided.
 
 selectDomain ( $domain)
 Set the current domain (database, schema, and table prefix)
 
 selectField ( $tables, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a single field from a single result row.
 
 selectFieldValues ( $tables, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a list of single field values from result rows.
 
 selectRow ( $tables, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Wrapper to IDatabase::select() that only fetches one row (via LIMIT)
 
 selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Get the number of rows in dataset.
 
 selectSQLText ( $tables, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Take the same arguments as IDatabase::select() and return the SQL it would use.
 
 serverIsReadOnly ()
 
Returns
bool Whether this DB server is running in server-side read-only mode
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.28

 
 sessionLocksPending ()
 
 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.
 
 setLBInfo ( $nameOrArray, $value=null)
 Set the entire array or a particular key of the managing load balancer info array.
 
 setLogger (LoggerInterface $logger)
 Set the PSR-3 logger interface to use.
 
 setSchemaVars ( $vars)
 Set schema variables to be used when streaming commands from SQL files or stdin.
 
 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 after each time any transaction commits or rolls back.
 
 setTransactionManager (TransactionManager $transactionManager)
 
 setTrxEndCallbackSuppression ( $suppress)
 Whether to disable running of post-COMMIT/ROLLBACK callbacks.
 
 sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
 Read and execute SQL commands from a file.
 
 sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
 Read and execute commands from an open file handle.
 
 startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Begin an atomic section of SQL statements.
 
 streamStatementEnd (&$sql, &$newLine)
 Called by sourceStream() to check if we've reached a statement end.
 
 strencode ( $s)
 Wrapper for addslashes()
 
 strreplace ( $orig, $old, $new)
 Returns a SQL expression for simple string replacement (e.g.
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists.
 
 tableName (string $name, $format='quoted')
 Format a table name ready for use in constructing an SQL query.
 
 tableNames (... $tables)
 Fetch a number of table names into an associative array.
 
 tableNamesN (... $tables)
 Fetch a number of table names into a zero-indexed numerical array.
 
 tablePrefix ( $prefix=null)
 Get/set the table prefix.
 
 timestamp ( $ts=0)
 Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.
 
 timestampOrNull ( $ts=null)
 Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.
 
 truncateTable ( $table, $fname=__METHOD__)
 Delete all data in a table and reset any sequences owned by that table.
 
 trxLevel ()
 Gets the current transaction level.
 
 trxStatus ()
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established.
 
 unionQueries ( $sqls, $all, $options=[])
 Construct a UNION query.
 
 unionSupportsOrderAndLimit ()
 Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.
 
 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
bool Success
Exceptions
DBErrorIf an error occurs, {
See also
query}

 
 update ( $table, $set, $conds, $fname=__METHOD__, $options=[])
 Update all rows in a table that match a given condition.
 
 upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__)
 Upsert row(s) into a table, in the provided order, while updating conflicting rows.
 
 writesOrCallbacksPending ()
 Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending.
 
 writesPending ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\IReadableDatabase
 getServerVersion ()
 A string describing the current software version.
 
 getSoftwareLink ()
 Returns a wikitext style link to the DB's website (e.g.
 
 getType ()
 Get the RDBMS type of the server (e.g.
 
 lastErrno ()
 Get the RDBMS-specific error code from the last attempted query statement.
 
 lastError ()
 Get the RDBMS-specific error description from the last attempted query statement.
 
- Public Member Functions inherited from Wikimedia\Rdbms\Platform\ISQLPlatform
 buildSubString ( $input, $startPosition, $length=null)
 Build a SUBSTRING function.
 
- Public Member Functions inherited from Wikimedia\Rdbms\IMaintainableDatabase
 fieldInfo ( $table, $field)
 Get information about a field Returns false if the field doesn't exist.
 

Static Public Member Functions

static getAttributes ()
 
static getCacheSetOptions (?IReadableDatabase ... $dbs)
 Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination.
 

Public Attributes

if(is_string( $params['sqlMode'] ?? null)) $flags = (int)$params['flags']
 
$this agent = (string)$params['agent']
 
$this cliMode = (bool)$params['cliMode']
 
$this connectionParams
 
$this connectionVariables = $params['variables'] ?? []
 
$this connectTimeout = $params['connectTimeout'] ?? null
 
$this csProvider = $params['criticalSectionProvider'] ?? null
 
$this currentDomain
 
$this deprecationLogger = $params['deprecationLogger']
 
$this errorLogger = $params['errorLogger']
 
$this flagsHolder = new DatabaseFlags( $flags )
 
$this lbInfo = $params['lbInfo'] ?? []
 
$this nonNativeInsertSelectBatchSize = $params['nonNativeInsertSelectBatchSize'] ?? 10000
 
$this platform
 
$this profiler = is_callable( $params['profiler'] ) ? $params['profiler'] : null
 
$this receiveTimeout = $params['receiveTimeout'] ?? null
 
$this serverName = $params['serverName']
 
$this ssl = $params['ssl'] ?? (bool)( $flags & self::DBO_SSL )
 
$this strictWarnings = !empty( $params['strictWarnings'] )
 
- Public Attributes inherited from Wikimedia\Rdbms\IDatabase
const ATOMIC_CANCELABLE = 'cancelable'
 Atomic section is cancelable.
 
const ATOMIC_NOT_CANCELABLE = ''
 Atomic section is not cancelable.
 
const ESTIMATE_DB_APPLY = 'apply'
 Estimate time to apply (scanning, applying)
 
const ESTIMATE_TOTAL = 'total'
 Estimate total time (RTT, scanning, waiting on locks, applying)
 
const FLUSHING_ALL_PEERS = 'flush'
 Commit/rollback is from the connection manager for the IDatabase handle.
 
const FLUSHING_INTERNAL = 'flush-internal'
 Commit/rollback is from the IDatabase handle internally.
 
const FLUSHING_ONE = ''
 Commit/rollback is from outside the IDatabase handle and connection manager.
 
const LB_READ_ONLY_REASON = 'readOnlyReason'
 Field for getLBInfo()/setLBInfo()
 
const LB_TRX_ROUND_ID = 'trxRoundId'
 Field for getLBInfo()/setLBInfo()
 
const LOCK_TIMESTAMP = 1
 Flag to return the lock acquisition timestamp (null if not acquired)
 
const ROLE_STATIC_CLONE = 'static-clone'
 Replica server within a static dataset.
 
const ROLE_STREAMING_MASTER = 'streaming-master'
 Primary server than can stream writes to replica servers.
 
const ROLE_STREAMING_REPLICA = 'streaming-replica'
 Replica server that receives writes from a primary server.
 
const ROLE_UNKNOWN = 'unknown'
 Server with unknown topology role.
 
const TRANSACTION_EXPLICIT = ''
 Transaction is requested by regular caller outside of the DB layer.
 
const TRANSACTION_INTERNAL = 'implicit'
 Transaction is requested internally via DBO_TRX/startAtomic()
 
const TRIGGER_CANCEL = 4
 Callback triggered by atomic section cancel (ROLLBACK TO SAVEPOINT)
 
const TRIGGER_COMMIT = 2
 Callback triggered by COMMIT.
 
const TRIGGER_IDLE = 1
 Callback triggered immediately due to no active transaction.
 
const TRIGGER_ROLLBACK = 3
 Callback triggered by ROLLBACK.
 
- Public Attributes inherited from Wikimedia\Rdbms\IReadableDatabase
const UNION_ALL = true
 Parameter to unionQueries() for UNION ALL.
 
const UNION_DISTINCT = false
 Parameter to unionQueries() for UNION DISTINCT.
 
- Public Attributes inherited from Wikimedia\Rdbms\Platform\ISQLPlatform
const ALL_ROWS = '*'
 Unconditional update/delete of whole table.
 
const CALLER_SUBQUERY = 'subquery'
 Special value for ->caller() / $fname parameter used when providing a caller is not expected, because we're formatting a subquery that won't be executed directly.
 
const CALLER_UNKNOWN = 'unknown'
 Special value for ->caller() / $fname parameter used when a caller is not provided.
 
const LIST_AND = 1
 Combine list with AND clauses.
 
const LIST_COMMA = 0
 Combine list with comma delimiters.
 
const LIST_NAMES = 3
 Treat as field name and do not apply value escaping.
 
const LIST_OR = 4
 Combine list with OR clauses.
 
const LIST_SET = 2
 Convert map into a SET clause.
 
const QUERY_CHANGE_LOCKS = 512 | self::QUERY_IGNORE_DBO_TRX
 Query is a command for advisory locks.
 
const QUERY_CHANGE_NONE = 32
 Query is a read-only Data Query Language query.
 
const QUERY_CHANGE_ROWS = 128
 Query is a Data Manipulation Language command (INSERT, DELETE, LOCK, ...)
 
const QUERY_CHANGE_SCHEMA = 256 | self::QUERY_IGNORE_DBO_TRX
 Query is a Data Definition Language command.
 
const QUERY_CHANGE_TRX = 64 | self::QUERY_IGNORE_DBO_TRX
 Query is a Transaction Control Language command (BEGIN, USE, SET, ...)
 
const QUERY_IGNORE_DBO_TRX = 8
 Ignore the current presence of any DBO_TRX flag.
 
const QUERY_NO_RETRY = 16
 Do not try to retry the query if the connection was lost.
 
const QUERY_NORMAL = 0
 Idiom for "no special flags".
 
const QUERY_PSEUDO_PERMANENT = 2
 Track a TEMPORARY table CREATE as if it was for a permanent table (for testing)
 
const QUERY_REPLICA_ROLE = 4
 Enforce that a query does not make effective writes.
 
const QUERY_SILENCE_ERRORS = 1
 Ignore query errors and return false when they happen.
 
- Public Attributes inherited from Wikimedia\Rdbms\Database\IDatabaseFlags
const DBO_COMPRESS = 512
 Enable compression in connection protocol.
 
const DBO_DDLMODE = 128
 Schema file mode; was used by Oracle.
 
const DBO_DEBUG = 1
 Enable debug logging of all SQL queries.
 
const DBO_DEFAULT = 16
 Join load balancer transaction rounds (which control DBO_TRX) in non-CLI mode.
 
const DBO_GAUGE = 1024
 Optimize connection for guaging server state (e.g.
 
const DBO_IGNORE = 4
 Unused since 1.31.
 
const DBO_NOBUFFER = 2
 Unused since 1.34.
 
const DBO_PERSISTENT = 32
 Use DB persistent connections if possible.
 
const DBO_SSL = 256
 Enable SSL/TLS in connection protocol.
 
const DBO_SYSDBA = 64
 DBA session mode; was used by Oracle.
 
const DBO_TRX = 8
 Automatically start a transaction before running a query if none is active.
 
const REMEMBER_NOTHING = ''
 Do not remember the prior flags.
 
const REMEMBER_PRIOR = 'remember'
 Remember the prior flags.
 
const RESTORE_INITIAL = 'initial'
 Restore to the initial flag state.
 
const RESTORE_PRIOR = 'prior'
 Restore to the prior flag state.
 

Protected Member Functions

 assertHasConnectionHandle ()
 Make sure there is an open connection handle (alive or not)
 
 checkInsertWarnings (Query $query, $fname)
 Check for warnings after performing an INSERT query, and throw exceptions if necessary.
 
 closeConnection ()
 Closes underlying database connection.
 
 commenceCriticalSection (string $fname)
 Demark the start of a critical section of session/transaction state changes.
 
 completeCriticalSection (string $fname, ?CriticalSectionScope $csm, Throwable $trxError=null)
 Demark the completion of a critical section of session/transaction state changes.
 
 doBegin ( $fname)
 Issues the BEGIN command to the database server.
 
 doFlushSession ( $fname)
 Reset the server-side session state for named locks and table locks.
 
 doHandleSessionLossPreconnect ()
 Reset any additional subclass trx* and session* fields.
 
 doInsertSelectNative ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds)
 Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory.
 
 doLock (string $lockName, string $method, int $timeout)
 
 doLockIsFree (string $lockName, string $method)
 
 doSelectDomain (DatabaseDomain $domain)
 
 doSingleStatementQuery (string $sql)
 Run a query and return a QueryStatus instance with the query result information.
 
 doUnlock (string $lockName, string $method)
 
 executeQuery ( $sql, $fname, $flags)
 Execute a query without enforcing public (non-Database) caller restrictions.
 
 getBindingHandle ()
 Get the underlying binding connection handle.
 
 getInsertIdColumnForUpsert ( $table)
 
 getLastPHPError ()
 
 getLogContext (array $extras=[])
 Create a log context to pass to PSR-3 logger functions.
 
 getReadOnlyReason ()
 
 getTransactionRoundId ()
 
 getValueTypesForWithClause ( $table)
 
 installErrorHandler ()
 Set a custom error handler for logging errors during database connection.
 
 isConnectionError ( $errno)
 Do not use this method outside of Database/DBError classes.
 
 isInsertSelectSafe (array $insertOptions, array $selectOptions, $fname=__METHOD__)
 
 isKnownStatementRollbackError ( $errno)
 
 isQueryTimeoutError ( $errno)
 Checks whether the cause of the error is detected to be a timeout.
 
 lastInsertId ()
 Get a row ID from the last insert statement to implicitly assign one within the session.
 
 newExceptionAfterConnectError ( $error)
 
 open ( $server, $user, $password, $db, $schema, $tablePrefix)
 Open a new connection to the database (closing any existing one)
 
 registerTempTables (Query $query)
 Register creation and dropping of temporary tables.
 
 replaceLostConnection ( $lastErrno, $fname)
 Close any existing (dead) database connection and open a new connection.
 
 restoreErrorHandler ()
 Restore the previous error handler and return the last PHP error for this DB.
 

Protected Attributes

string $agent
 Agent name for query profiling.
 
bool $cliMode
 Whether this PHP instance is for a CLI script.
 
object resource null $conn
 Database connection.
 
array< string, mixed > $connectionParams
 Connection parameters used by initConnection() and open()
 
string[] int[] float[] $connectionVariables
 SQL variables values to use for all new connections.
 
int null $connectTimeout
 Maximum seconds to wait on connection attempts.
 
CriticalSectionProvider null $csProvider
 
DatabaseDomain $currentDomain
 
string false $delimiter = ';'
 Current SQL query delimiter.
 
callable $deprecationLogger
 Deprecation logging callback.
 
callable $errorLogger
 Error logging callback.
 
DatabaseFlags $flagsHolder
 
array $lbInfo = []
 Current LoadBalancer tracking information.
 
LoggerInterface $logger
 
int $nonNativeInsertSelectBatchSize
 Row batch size to use for emulated INSERT SELECT queries.
 
callable null $profiler
 
int null $receiveTimeout
 Maximum seconds to wait on receiving query results.
 
string null $serverName
 Readable name or host/IP of the database server.
 
array< string, array > $sessionNamedLocks = []
 Map of (lock name => (UNIX time,trx ID))
 
bool $ssl
 Whether to use SSL connections.
 
bool $strictWarnings
 Whether to check for warnings.
 
array< string, array< string, $sessionTempTables=[];protected int $lastQueryAffectedRows=0;protected int|null $lastQueryInsertId;protected int|null $lastEmulatedAffectedRows;protected int|null $lastEmulatedInsertId;protected string $lastConnectError='';private float $lastPing=0.0;private float|false $lastWriteTime=false;private string|false $lastPhpError=false;private int|null $csmId;private string|null $csmFname;private DBUnexpectedError|null $csmError;public const ATTR_DB_IS_FILE='db-is-file';public const ATTR_DB_LEVEL_LOCKING='db-level-locking';public const ATTR_SCHEMAS_AS_TABLE_GROUPS='supports-schemas';public const NEW_UNCONNECTED=0;public const NEW_CONNECTED=1;protected const ERR_NONE=0;protected const ERR_RETRY_QUERY=1;protected const ERR_ABORT_QUERY=2;protected const ERR_ABORT_TRX=4;protected const ERR_ABORT_SESSION=8;protected const DROPPED_CONN_BLAME_THRESHOLD_SEC=3.0;=private const NOT_APPLICABLE 'n/a';private const PING_TTL=1.0;private const PING_QUERY='SELECT 1 AS ping';protected const CONN_HOST='host';protected const CONN_USER='user';protected const CONN_PASSWORD='password';protected const CONN_INITIAL_DB='dbname';protected const CONN_INITIAL_SCHEMA='schema';protected const CONN_INITIAL_TABLE_PREFIX='tablePrefix';protected SQLPlatform $platform;protected ReplicationReporter $replicationReporter;public function __construct(array $params) { $this->logger=$params[ 'logger'] ?? new NullLogger();$this-> transactionManager
 TempTableInfo>> Map of (DB name => table name => info)
 

Detailed Description

Relational database abstraction object.

Since
1.28

Definition at line 44 of file Database.php.

Constructor & Destructor Documentation

◆ __destruct()

Wikimedia\Rdbms\Database::__destruct ( )

Run a few simple checks and close dangling connections.

Definition at line 3181 of file Database.php.

Member Function Documentation

◆ __clone()

Wikimedia\Rdbms\Database::__clone ( )

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

Exceptions
DBConnectionError

Definition at line 3141 of file Database.php.

◆ __sleep()

Wikimedia\Rdbms\Database::__sleep ( )

Called by serialize.

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

Returns
never

Definition at line 3173 of file Database.php.

◆ __toString()

Wikimedia\Rdbms\Database::__toString ( )

Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present.

Returns
string "<db type> object #<X>" or "<db type> object #<X> (resource/handle id #<Y>)"
Since
1.34

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 3122 of file Database.php.

◆ addIdentifierQuotes()

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

Escape a SQL identifier (e.g.

table, column, database) for use in a SQL query

Depending on the database this will either be backticks or "double quotes"

Parameters
string$s
Returns
string
Since
1.33

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3355 of file Database.php.

Referenced by Wikimedia\Rdbms\DatabaseMySQL\doSelectDomain(), and MediaWiki\Installer\PostgresInstaller\setupUser().

◆ addQuotes()

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

Escape and quote a raw value string for use in a SQL query.

Parameters
?scalar | RawSQLValue | Blob$s
Returns
string

Implements Wikimedia\Rdbms\Database\DbQuoter.

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

Definition at line 1541 of file Database.php.

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

◆ affectedRows()

Wikimedia\Rdbms\Database::affectedRows ( )

Get the number of rows affected by the last query method call.

This method should only be called when all the following hold true:

  • (a) A method call was made to insert(), upsert(), replace(), update(), delete(), insertSelect(), query() with a non-SELECT statement, or queryMulti() with a non-SELECT terminal statement
  • (b) The method call succeeded
  • (c) No subsequent method calls were made, with the exception of affectedRows(), lastErrno(), lastError(), and getType()

In all other cases, the return value is unspecified.

UPDATE queries consider rows affected even when all their new column values match the previous values. Such rows can be excluded from the count by changing the WHERE clause to filter them out.

If the last query method call was to query() or queryMulti(), then the results are based on the (last) statement provided to that call and are driver-specific.

Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2517 of file Database.php.

◆ anyChar()

Wikimedia\Rdbms\Database::anyChar ( )

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

Returns
LikeMatch

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3367 of file Database.php.

◆ anyString()

Wikimedia\Rdbms\Database::anyString ( )

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

Returns
LikeMatch

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3371 of file Database.php.

◆ assertHasConnectionHandle()

Wikimedia\Rdbms\Database::assertHasConnectionHandle ( )
finalprotected

Make sure there is an open connection handle (alive or not)

This guards against fatal errors to the binding handle not being defined in cases where open() was never called or close() was already called.

Exceptions
DBUnexpectedError

Definition at line 533 of file Database.php.

References Wikimedia\Rdbms\Database\isOpen().

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

◆ begin()

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

Begin a transaction.

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

Note that when the DBO_TRX flag is set (which is usually the case for web requests, but not for maintenance scripts), any previous database query will have started a transaction automatically.

Nesting of transactions is not supported. Attempts to nest transactions will cause a warning, unless the current transaction was started automatically because of the DBO_TRX flag.

Parameters
string$fnameCalling function name
string$modeA situationally valid IDatabase::TRANSACTION_* constant [optional]
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2283 of file Database.php.

◆ bitAnd()

Wikimedia\Rdbms\Database::bitAnd ( $fieldLeft,
$fieldRight )
Parameters
string | int$fieldLeft
string | int$fieldRight
Returns
string

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3311 of file Database.php.

◆ bitNot()

Wikimedia\Rdbms\Database::bitNot ( $field)
Parameters
string | int$field
Returns
string

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3307 of file Database.php.

◆ bitOr()

Wikimedia\Rdbms\Database::bitOr ( $fieldLeft,
$fieldRight )
Parameters
string | int$fieldLeft
string | int$fieldRight
Returns
string

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3315 of file Database.php.

◆ buildComparison()

Wikimedia\Rdbms\Database::buildComparison ( string $op,
array $conds )

Build a condition comparing multiple values, for use with indexes that cover multiple fields, common when e.g.

paging through results or doing batch operations.

For example, you might be displaying a list of people ordered alphabetically by their last and first name, split across multiple pages. The first page of the results ended at Jane Doe. When building the query for the next page, you would use:

$queryBuilder->where( $db->buildComparison( '>', [ 'last' => 'Doe', 'first' => 'Jane' ] ) );

This will return people whose last name follows Doe, or whose last name is Doe and first name follows Jane.

Note that the order of keys in the associative array $conds is significant, and must match the order of fields used by the index.

When comparing a single value, prefer using the expression builder:

$db->expr( 'key', '<=', $val )

// equivalent to:
$db->buildComparison( '<=', [ 'key' => $val ] )
'key <= ' . $db->addQuotes( $val )
Parameters
string$opComparison operator, one of '>', '>=', '<', '<='
non-empty-array<string,mixed>$conds Map of field names to their values to use in the comparison
Returns
string SQL code

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3291 of file Database.php.

◆ buildConcat()

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

Build a concatenation list to feed into a SQL query.

Parameters
string[]$stringListRaw SQL expression list; caller is responsible for escaping
Returns
string

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3319 of file Database.php.

◆ buildExcludedValue()

Wikimedia\Rdbms\Database::buildExcludedValue ( $column)

Build a reference to a column value from the conflicting proposed upsert() row.

The reference comes in the form of an alias, function, or parenthesized SQL expression. It can be used in upsert() SET expressions to handle the merging of column values between each conflicting pair of existing and proposed rows. Such proposed rows are said to have been "excluded" from insertion in favor of updating the existing row.

This is useful for multi-row upserts() since the proposed values cannot just be included as literals in the SET expressions.

See also
IDatabase::upsert()
Parameters
string$columnColumn name
Returns
string SQL expression returning a scalar
Since
1.39

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3440 of file Database.php.

◆ buildGreatest()

Wikimedia\Rdbms\Database::buildGreatest ( $fields,
$values )

Build a GREATEST function statement comparing columns/values.

Integer and float values in $values will not be quoted

If $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.

Parameters
string | string[]$fieldsName(s) of column(s) with values to compare
string | int | float | string[] | int[] | float[]$valuesValues to compare
Returns
mixed
Since
1.35 in IDatabase, moved to ISQLPlatform in 1.39

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3323 of file Database.php.

◆ buildGroupConcatField()

Wikimedia\Rdbms\Database::buildGroupConcatField ( $delim,
$tables,
$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$tablesTable reference(s) using unqualified table names
string$fieldField name
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$conds Conditions
string | array$join_condsJoin conditions
Returns
string SQL text
Since
1.23

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3427 of file Database.php.

◆ buildIntegerCast()

Wikimedia\Rdbms\Database::buildIntegerCast ( $field)
Parameters
string$fieldField or column to cast
Returns
string
Since
1.31 in IDatabase, moved to ISQLPlatform in 1.39

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3339 of file Database.php.

◆ buildLeast()

Wikimedia\Rdbms\Database::buildLeast ( $fields,
$values )

Build a LEAST function statement comparing columns/values.

Integer and float values in $values will not be quoted

If $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.

Parameters
string | string[]$fieldsName(s) of column(s) with values to compare
string | int | float | string[] | int[] | float[]$valuesValues to compare
Returns
mixed
Since
1.35 in IDatabase, moved to ISQLPlatform in 1.39

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3327 of file Database.php.

◆ buildLike()

Wikimedia\Rdbms\Database::buildLike ( $param,
$params )

LIKE statement wrapper.

This takes 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 the 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 in IDatabase, moved to ISQLPlatform in 1.39
Parameters
array[] | string | LikeMatch$param
string|LikeMatch...$params
Returns
string Fully built LIKE statement

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3363 of file Database.php.

References $params.

◆ buildSelectSubquery()

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

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

See also
IDatabase::selectSQLText()
Parameters
string | array$tablesTable reference(s) using unqualified table names
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

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3433 of file Database.php.

◆ buildStringCast()

Wikimedia\Rdbms\Database::buildStringCast ( $field)
Parameters
string$fieldField or column to cast
Returns
string
Since
1.28 in IDatabase, moved to ISQLPlatform in 1.39

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3335 of file Database.php.

◆ buildSubstring()

Wikimedia\Rdbms\Database::buildSubstring ( $input,
$startPosition,
$length = null )

Definition at line 3331 of file Database.php.

◆ cancelAtomic()

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

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 an optimization to save rountrips, 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 | null$sectionIdSection ID from startAtomic(); passing this enables cancellation of unclosed nested sections [optional]
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2189 of file Database.php.

◆ checkInsertWarnings()

Wikimedia\Rdbms\Database::checkInsertWarnings ( Query $query,
$fname )
protected

Check for warnings after performing an INSERT query, and throw exceptions if necessary.

Parameters
Query$query
string$fname
Returns
void

Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.

Definition at line 1491 of file Database.php.

◆ clearFlag()

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

Clear a flag for this connection.

Parameters
int$flagOne of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX)
string$rememberIDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]

Implements Wikimedia\Rdbms\Database\IDatabaseFlags.

Definition at line 3209 of file Database.php.

◆ close()

Wikimedia\Rdbms\Database::close ( $fname = __METHOD__)
final

Close the database connection.

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

Access: internal
Only for use by LoadBalancer
Parameters
string$fnameCaller name
Returns
bool Success
Exceptions
DBError

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 478 of file Database.php.

References Wikimedia\Rdbms\Database\closeConnection(), Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\transactionManager, and Wikimedia\Rdbms\Database\trxLevel().

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

◆ closeConnection()

Wikimedia\Rdbms\Database::closeConnection ( )
abstractprotected

Closes underlying database connection.

Returns
bool Whether connection was closed successfully
Since
1.20

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

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

◆ commenceCriticalSection()

Wikimedia\Rdbms\Database::commenceCriticalSection ( string $fname)
protected

Demark the start of a critical section of session/transaction state changes.

Use this to disable potentially DB handles due to corruption from highly unexpected exceptions (e.g. from zend timers or coding errors) preempting execution of methods.

Callers must demark completion of the critical section with completeCriticalSection(). Callers should handle DBError exceptions that do not cause object state corruption by catching them, calling completeCriticalSection(), and then rethrowing them.

$cs = $this->commenceCriticalSection( __METHOD__ );
try {
//...send a query that changes the session/transaction state...
} catch ( DBError $e ) {
$this->completeCriticalSection( __METHOD__, $cs );
throw $expectedException;
}
try {
//...send another query that changes the session/transaction state...
} catch ( DBError $trxError ) {
// Require ROLLBACK before allowing any other queries from outside callers
$this->completeCriticalSection( __METHOD__, $cs, $trxError );
throw $expectedException;
}
// ...update session state fields of $this...
$this->completeCriticalSection( __METHOD__, $cs );
Database error base class.
Definition DBError.php:36
See also
Database::completeCriticalSection()
Since
1.36
Parameters
string$fnameCaller name
Returns
CriticalSectionScope|null RAII-style monitor (topmost sections only)
Exceptions
DBUnexpectedErrorIf an unresolved critical section error already exists

Definition at line 3056 of file Database.php.

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

◆ commit()

Wikimedia\Rdbms\Database::commit ( $fname = __METHOD__,
$flush = self::FLUSHING_ONE )
final

Commits a transaction previously started using begin()

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

Only call this from code with outer transaction 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
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2327 of file Database.php.

◆ completeCriticalSection()

Wikimedia\Rdbms\Database::completeCriticalSection ( string $fname,
?CriticalSectionScope $csm,
Throwable $trxError = null )
protected

Demark the completion of a critical section of session/transaction state changes.

See also
Database::commenceCriticalSection()
Since
1.36
Parameters
string$fnameCaller name
CriticalSectionScope | null$csmRAII-style monitor (topmost sections only)
Throwable | null$trxErrorError that requires setting STATUS_TRX_ERROR (if any)

Definition at line 3099 of file Database.php.

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

◆ conditional()

Wikimedia\Rdbms\Database::conditional ( $cond,
$caseTrueExpression,
$caseFalseExpression )

Returns an SQL expression for a simple conditional.

This doesn't need to be overridden unless CASE isn't supported in the RDBMS.

Parameters
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>>|array<int,string|IExpression>$cond SQL condition expression (yields a boolean)
string$caseTrueExpressionSQL expression to return when the condition is true
string$caseFalseExpressionSQL expression to return when the condition is false
Returns
string SQL fragment

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3387 of file Database.php.

◆ connectionErrorLogger()

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

Error handler for logging errors during database connection.

Access: internal
This method should not be used outside of Database classes
Parameters
int | string$errno
string$errstr

Definition at line 457 of file Database.php.

◆ databasesAreIndependent()

Wikimedia\Rdbms\Database::databasesAreIndependent ( )

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

In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.

Returns
bool
Since
1.29

Implements Wikimedia\Rdbms\IReadableDatabase.

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

Definition at line 1501 of file Database.php.

◆ dbSchema()

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

Get/set the db schema.

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

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 319 of file Database.php.

References Wikimedia\Rdbms\Database\currentDomain, Wikimedia\Rdbms\Database\getDBname(), and Wikimedia\Rdbms\Database\platform.

Referenced by MediaWiki\Installer\DatabaseInstaller\selectDatabase().

◆ decodeBlob()

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

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

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

Parameters
string | Blob$b
Returns
string
Exceptions
DBError

Implements Wikimedia\Rdbms\IReadableDatabase.

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

Definition at line 2682 of file Database.php.

◆ decodeExpiry()

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

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3411 of file Database.php.

◆ delete()

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

Delete all rows in a table that match a condition.

This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.

Access: internal
callers outside of rdbms library should use DeleteQueryBuilder instead.
Parameters
string$tableUnqualified name of table
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$conds Array of conditions. See $conds in IDatabase::select() In order to prevent possible performance or replication issues or damaging a data accidentally, an empty condition for 'delete' queries isn't allowed. IDatabase::ALL_ROWS should be passed explicitly in order to delete all rows.
string$fnameName of the calling function
Returns
bool Return true if no exception was thrown (deprecated since 1.33)
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1709 of file Database.php.

◆ deleteJoin()

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

Delete all rows in a table that match a condition which includes a join.

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

DO NOT put the join condition in $conds.

This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.

Parameters
string$delTableUnqualified name of table to delete rows from.
string$joinTableUnqualified name of reference table to join on.
string$delVarThe variable to join on, in the first table.
string$joinVarThe variable to join on, in the second table.
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$conds Condition array of field names mapped to variables, ANDed together in the WHERE clause
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1696 of file Database.php.

◆ doAtomicSection()

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

Perform an atomic section of reversible 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 throws 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__ );
See also
Database::startAtomic
Database::endAtomic
Database::cancelAtomic
Parameters
string$fnameCaller name (usually METHOD)
callable$callbackCallback that issues write queries
string$cancelablePass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section.
Returns
mixed Result of the callback (since 1.28)
Exceptions
DBErrorIf an error occurs, {
See also
query}
Exceptions
ExceptionIf an error occurs in the callback
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.

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2262 of file Database.php.

◆ doBegin()

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

Issues the BEGIN command to the database server.

See also
Database::begin()
Parameters
string$fname
Exceptions
DBError

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 2322 of file Database.php.

◆ doFlushSession()

Wikimedia\Rdbms\Database::doFlushSession ( $fname)
protected

Reset the server-side session state for named locks and table locks.

Connection and query errors will be suppressed and logged

Parameters
string$fname
Since
1.38

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

Definition at line 2495 of file Database.php.

◆ doHandleSessionLossPreconnect()

Wikimedia\Rdbms\Database::doHandleSessionLossPreconnect ( )
protected

Reset any additional subclass trx* and session* fields.

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

Definition at line 1118 of file Database.php.

◆ doInsertSelectNative()

Wikimedia\Rdbms\Database::doInsertSelectNative ( $destTable,
$srcTable,
array $varMap,
$conds,
$fname,
array $insertOptions,
array $selectOptions,
$selectJoinConds )
protected

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

See also
IDatabase::insertSelect()
Parameters
string$destTableUnqualified name of destination table
string | array$srcTableUnqualified name of source table
array$varMap
array$conds
string$fname
array$insertOptions
array$selectOptions
array$selectJoinConds
Since
1.35

Reimplemented in Wikimedia\Rdbms\DatabasePostgres.

Definition at line 1852 of file Database.php.

◆ doLock()

Wikimedia\Rdbms\Database::doLock ( string $lockName,
string $method,
int $timeout )
protected
See also
lock()
Parameters
string$lockName
string$method
int$timeout
Returns
float|null UNIX timestamp of lock acquisition; null on failure
Exceptions
DBError

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

Definition at line 2879 of file Database.php.

◆ doLockIsFree()

Wikimedia\Rdbms\Database::doLockIsFree ( string $lockName,
string $method )
protected
See also
lockIsFree()
Parameters
string$lockName
string$method
Returns
bool Success
Exceptions
DBError

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

Definition at line 2841 of file Database.php.

◆ doSelectDomain()

Wikimedia\Rdbms\Database::doSelectDomain ( DatabaseDomain $domain)
protected
Parameters
DatabaseDomain$domain
Exceptions
DBConnectionError
DBError
Since
1.32

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

Definition at line 1524 of file Database.php.

◆ doSingleStatementQuery()

Wikimedia\Rdbms\Database::doSingleStatementQuery ( string $sql)
abstractprotected

Run a query and return a QueryStatus instance with the query result information.

This is meant to handle the basic command of actually sending a query to the server via the driver. No implicit transaction, reconnection, nor retry logic should happen here. The higher level query() method is designed to handle those sorts of concerns. This method should not trigger such higher level methods.

The lastError() and lastErrno() methods should meaningfully reflect what error, if any, occurred during the last call to this method. Methods like executeQuery(), query(), select(), insert(), update(), delete(), and upsert() implement their calls to doQuery() such that an immediately subsequent call to lastError()/lastErrno() meaningfully reflects any error that occurred during that public query method call.

For SELECT queries, the result field contains either:

  • a) A driver-specific IResultWrapper describing the query results
  • b) False, on any query failure

For non-SELECT queries, the result field contains either:

  • a) A driver-specific IResultWrapper, only on success
  • b) True, only on success (e.g. no meaningful result other than "OK")
  • c) False, on any query failure
Parameters
string$sqlSingle-statement SQL query
Returns
QueryStatus
Since
1.39

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

References Wikimedia\Rdbms\Query\getVerb(), Wikimedia\Rdbms\Query\getWriteTable(), and Wikimedia\Rdbms\Database\platform.

◆ doUnlock()

Wikimedia\Rdbms\Database::doUnlock ( string $lockName,
string $method )
protected
See also
unlock()
Parameters
string$lockName
string$method
Returns
bool Success
Exceptions
DBError

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

Definition at line 2916 of file Database.php.

◆ dropTable()

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

Delete a table.

Parameters
string$tableUnqualified name of table
string$fname
Returns
bool Whether the table already existed
Exceptions
DBErrorIf an error occurs

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 2955 of file Database.php.

◆ duplicateTableStructure()

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

Creates a new table with structure copied from existing table.

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

Parameters
string$oldNameName of table whose structure should be copied
string$newNameName of table to be created
bool$temporaryWhether the new table should be temporary
string$fnameCalling function name
Returns
bool True if operation was successful
Exceptions
RuntimeException

Implements Wikimedia\Rdbms\IMaintainableDatabase.

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

Definition at line 2504 of file Database.php.

◆ encodeBlob()

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

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

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

Parameters
string$b
Returns
string|Blob
Exceptions
DBError

Implements Wikimedia\Rdbms\IReadableDatabase.

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

Definition at line 2678 of file Database.php.

◆ encodeExpiry()

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

Encode an expiry time into the DBMS dependent format.

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

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3407 of file Database.php.

◆ endAtomic()

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

Ends an atomic section of SQL statements.

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

Since
1.23
See also
IDatabase::startAtomic
Parameters
string$fname
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2156 of file Database.php.

◆ estimateRowCount()

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

Estimate the number of rows in dataset.MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).Takes the same arguments as IDatabase::select().New callers should use newSelectQueryBuilder with SelectQueryBuilder::estimateRowCount instead, which is more readable and less error-prone.

Access: internal
Parameters
string | string[]$tablesUnqualified name of table(s)
string$varColumn for which NULL values are not counted [default "*"]
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$conds Filters on the table
string$fnameFunction name for profiling
array$optionsOptions for select
array | string$join_condsJoin conditions
Returns
int Row count
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IReadableDatabase.

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

Definition at line 1369 of file Database.php.

◆ executeQuery()

Wikimedia\Rdbms\Database::executeQuery ( $sql,
$fname,
$flags )
finalprotected

Execute a query without enforcing public (non-Database) caller restrictions.

Retry it if there is a recoverable connection loss (e.g. no important state lost).

This does not precheck for transaction/session state errors or critical section errors.

See also
Database::query()
Parameters
Query$sqlSQL statement
string$fnameName of the calling function
int$flagsBit field of class QUERY_* constants
Returns
QueryStatus
Exceptions
DBUnexpectedError
Since
1.34

Definition at line 665 of file Database.php.

References Wikimedia\Rdbms\Database\$flags, $source, Wikimedia\Rdbms\Database\assertHasConnectionHandle(), Wikimedia\Rdbms\Database\commenceCriticalSection(), Wikimedia\Rdbms\Database\completeCriticalSection(), Wikimedia\Rdbms\Database\currentDomain, Wikimedia\Rdbms\Database\getReadOnlyReason(), Wikimedia\Rdbms\ChangedTablesTracker\recordQuery(), and Wikimedia\Rdbms\Database\registerTempTables().

Referenced by Wikimedia\Rdbms\DatabaseMySQL\doSelectDomain(), Wikimedia\Rdbms\DatabaseMySQL\open(), and Wikimedia\Rdbms\Database\query().

◆ explicitTrxActive()

Wikimedia\Rdbms\Database::explicitTrxActive ( )

Check whether there is a transaction open at the specific request of a caller.

Explicit transactions are spawned by begin(), startAtomic(), and doAtomicSection(). Note that explicit transactions should not be confused with explicit transaction rounds.

Returns
bool
Since
1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3273 of file Database.php.

◆ expr()

Wikimedia\Rdbms\Database::expr ( string $field,
string $op,
$value )

See Expression::__construct()

Since
1.42
Parameters
string$field
string$opOne of '>', '<', '!=', '=', '>=', '<=', IExpression::LIKE, IExpression::NOT_LIKE
?scalar|RawSQLValue|Blob|LikeValue|non-empty-list<scalar|Blob>$value
Returns
Expression

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 1559 of file Database.php.

◆ factorConds()

Wikimedia\Rdbms\Database::factorConds ( $condsArray)

Given an array of condition arrays representing an OR list of AND lists, for example:

(A=1 AND B=2) OR (A=1 AND B=3)

produce an SQL expression in which the conditions are factored:

(A=1 AND (B=2 OR B=3))

We also use IN() to simplify further:

(A=1 AND (B IN (2,3))

More compactly, in boolean algebra notation, a sum of products, e.g. AB + AC is factored to produce A(B+C). Factoring proceeds recursively to reduce expressions with any number of variables, for example AEP + AEQ + AFP + AFQ = A(E(P+Q) + F(P+Q))

The algorithm is simple and will not necessarily find the shortest possible expression. For the best results, fields should be given in a consistent order, and the fields with values likely to be shared should be leftmost in the associative arrays.

Parameters
array$condsArrayAn array of associative arrays. The associative array keys represent field names, and the values represent the field values to compare against.
Returns
string SQL expression fragment

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3303 of file Database.php.

◆ fieldExists()

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

Determines whether a field exists in a table.

Parameters
string$tableUnqualified name of table
string$fieldField to check on that table
string$fnameCalling function name (optional)
Returns
bool Whether $table has field $field
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1440 of file Database.php.

◆ flushSession()

Wikimedia\Rdbms\Database::flushSession ( $fname = __METHOD__,
$flush = self::FLUSHING_ONE )

Release important session-level state (named lock, table locks) as post-rollback cleanup.

This should only be called by a load balancer or if the handle is not attached to one. Also, there must be no chance that a future caller will still be expecting some of the lost session state.

Connection and query errors will be suppressed and logged

Parameters
string$fnameCalling function name
string$flushFlush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly rolling back implicit transactions. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context.
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.38

Implements Wikimedia\Rdbms\IDatabaseForOwner.

Definition at line 2432 of file Database.php.

◆ flushSnapshot()

Wikimedia\Rdbms\Database::flushSnapshot ( $fname = __METHOD__,
$flush = self::FLUSHING_ONE )

Commit any transaction but error out if writes or callbacks are pending.

This is intended for clearing out REPEATABLE-READ snapshots so that callers can see a new point-in-time of the database. This is useful when one of many transaction rounds finished and significant time will pass in the script's lifetime. It is also useful to call on a replica server after waiting on replication to catch up to the primary server.

Parameters
string$fnameCalling function name
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
DBErrorIf an error occurs, {
See also
query}
Since
1.28
1.34 Added $flush parameter

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2499 of file Database.php.

◆ getAttributes()

static Wikimedia\Rdbms\Database::getAttributes ( )
static
Returns
array Map of (Database::ATTR_* constant => value)
Since
1.31

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

Definition at line 287 of file Database.php.

◆ getBindingHandle()

Wikimedia\Rdbms\Database::getBindingHandle ( )
protected

Get the underlying binding connection handle.

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

Returns
mixed
Exceptions
DBUnexpectedError
Since
1.26

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 3009 of file Database.php.

◆ getCacheSetOptions()

static Wikimedia\Rdbms\Database::getCacheSetOptions ( ?IReadableDatabase ... $dbs)
static

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

This is information is useful for caching modules

See also
WANObjectCache::set()
WANObjectCache::getWithSetCallback()
Parameters
IReadableDatabase|null...$dbs Note: For backward compatibility, it is allowed for null values to be passed among the parameters. This is deprecated since 1.36, only IReadableDatabase objects should be passed.
Returns
array Map of values:
  • lag: highest lag of any of the DBs or false on error (e.g. replication stopped)
  • since: oldest UNIX timestamp of any of the DB lag estimates
  • pending: whether any of the DBs have uncommitted changes
Exceptions
DBError
Since
1.27

Definition at line 2655 of file Database.php.

Referenced by MediaWiki\Storage\NameTableStore\getName(), MediaWiki\User\User\loadFromCache(), MediaWiki\SiteStats\SiteStats\numberingroup(), MediaWiki\SiteStats\SiteStats\pagesInNs(), and MediaWiki\ResourceLoader\MessageBlobStore\recacheMessageBlob().

◆ getDBname()

◆ getDomainID()

Wikimedia\Rdbms\Database::getDomainID ( )

Return the currently selected domain ID.

Null components (database/schema) might change once a connection is established

Returns
string

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 400 of file Database.php.

References Wikimedia\Rdbms\Database\currentDomain.

◆ getFlag()

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

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

Parameters
int$flagOne of the class IDatabase::DBO_* constants
Returns
bool

Implements Wikimedia\Rdbms\Database\IDatabaseFlags.

Definition at line 3217 of file Database.php.

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

◆ getInfinity()

Wikimedia\Rdbms\Database::getInfinity ( )

Find out when 'infinity' is.

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

Returns
string

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3403 of file Database.php.

◆ getInsertIdColumnForUpsert()

Wikimedia\Rdbms\Database::getInsertIdColumnForUpsert ( $table)
protected
Parameters
string$tableUnqualified name of table
Returns
string|null The AUTO_INCREMENT/SERIAL column; null if not needed

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

Definition at line 1684 of file Database.php.

◆ getLag()

Wikimedia\Rdbms\Database::getLag ( )

Get the seconds of replication lag on this database server.

Callers should avoid using this method while a transaction is active

Returns
float|int|false Database replication lag in seconds or false on error
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 3459 of file Database.php.

◆ getLastPHPError()

Wikimedia\Rdbms\Database::getLastPHPError ( )
protected
Returns
string|false Last PHP error for this DB (typically connection errors)

Definition at line 438 of file Database.php.

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

◆ getLBInfo()

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

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

Access: internal
should not be called outside of rdbms library.
Parameters
string | null$nameThe entry of the info array to get, or null to get the whole array
Returns
array|mixed|null

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 342 of file Database.php.

References Wikimedia\Rdbms\Database\lbInfo.

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

◆ getLogContext()

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

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

Parameters
array$extrasAdditional data to add to context
Returns
array

Definition at line 467 of file Database.php.

References Wikimedia\Rdbms\Database\connectionParams, Wikimedia\Rdbms\Database\getDBname(), and Wikimedia\Rdbms\Database\getServerName().

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

◆ getPrimaryPos()

Wikimedia\Rdbms\Database::getPrimaryPos ( )

Get the replication position of this primary DB server.

Returns
DBPrimaryPos|false Position; false if this is not a primary DB
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.37

Implements Wikimedia\Rdbms\IDatabaseForOwner.

Definition at line 3455 of file Database.php.

◆ getReadOnlyReason()

Wikimedia\Rdbms\Database::getReadOnlyReason ( )
protected
Returns
array|null Tuple of (reason string, "role" or "lb") if read-only; null otherwise

Definition at line 2984 of file Database.php.

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

◆ getScopedLockAndFlush()

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

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

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

This is suitable for transactions that need to be serialized using cooperative locks, where each transaction can see each others' changes. Any transaction is flushed to clear out stale REPEATABLE-READ snapshot data. Once the returned object falls out of PHP scope, the lock will be released unless a transaction is active. If one is active, then the lock will be released when it either commits or rolls back.

If the lock acquisition failed, then no transaction flush happens, and null is returned.

Parameters
string$lockKeyName of lock to release
string$fnameName of the calling method
int$timeoutAcquisition timeout in seconds
Returns
ScopedCallback|null
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.27

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2920 of file Database.php.

References if.

◆ getServer()

Wikimedia\Rdbms\Database::getServer ( )

Get the hostname or IP address of the server.

Returns
string|null

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 1533 of file Database.php.

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

◆ getServerInfo()

Wikimedia\Rdbms\Database::getServerInfo ( )

Get a human-readable string describing the current software version.

Use getServerVersion() to get machine-friendly information.

Returns
string Version information from the database server

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 300 of file Database.php.

References Wikimedia\Rdbms\IReadableDatabase\getServerVersion().

◆ getServerName()

Wikimedia\Rdbms\Database::getServerName ( )

Get the readable name for the server.

Returns
string Readable server name, falling back to the hostname or IP address
Since
1.36

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 1537 of file Database.php.

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

◆ getSessionLagStatus()

Wikimedia\Rdbms\Database::getSessionLagStatus ( )

Get a cached estimate of the seconds of replication lag on this database server, using the estimate obtained at the start of the current transaction if one 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
DBErrorIf an error occurs, {
See also
query}
Since
1.27

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 3463 of file Database.php.

◆ getTableAliases()

Wikimedia\Rdbms\Database::getTableAliases ( )

Return current table aliases.

Access: internal
only to be used inside rdbms library

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3419 of file Database.php.

◆ getTransactionRoundId()

Wikimedia\Rdbms\Database::getTransactionRoundId ( )
finalprotected
Returns
string|null ID of the active explicit transaction round being participating in

Definition at line 384 of file Database.php.

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

◆ getValueTypesForWithClause()

Wikimedia\Rdbms\Database::getValueTypesForWithClause ( $table)
protected
Parameters
string$tableUnqualified name of table
Returns
array<string,string> Map of (column => type); [] if not needed

Reimplemented in Wikimedia\Rdbms\DatabasePostgres.

Definition at line 1692 of file Database.php.

◆ implicitOrderby()

Wikimedia\Rdbms\Database::implicitOrderby ( )

Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1.

Returns
bool

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3281 of file Database.php.

◆ indexExists()

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

Determines whether an index exists.

Parameters
string$tableUnqualified name of table
string$index
string$fname
Returns
bool
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1448 of file Database.php.

◆ indexInfo()

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

Get information about an index into an object.

Parameters
string$tableUnqualified name of table
string$indexIndex name
string$fnameCalling function name
Returns
array<string,mixed>|false Index info map; false if it does not exist

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

◆ indexUnique()

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

Determines if a given index is unique.

Parameters
string$tableUnqualified name of table
string$index
string$fnameCalling function name
Returns
bool|null Returns null if the index does not exist
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1454 of file Database.php.

◆ initConnection()

Wikimedia\Rdbms\Database::initConnection ( )
final

Initialize the connection to the database over the wire (or to local files)

Exceptions
LogicException
InvalidArgumentException
DBConnectionError
Since
1.31

Definition at line 254 of file Database.php.

References Wikimedia\Rdbms\Database\connectionParams, Wikimedia\Rdbms\Database\isOpen(), and Wikimedia\Rdbms\Database\open().

◆ insert()

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

Insert row(s) into a table, in the provided order.

This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.

Access: internal
callers outside of rdbms library should use InsertQueryBuilder instead.
Parameters
string$tableUnqualified name of table
array | array[]$rowsRow(s) to insert, as either:
  • A string-keyed map of (column name => value) defining a new row. Values are treated as literals and quoted appropriately; null is interpreted as NULL.
  • An integer-keyed list of such string-keyed maps, defining a list of new rows. The keys in each map must be identical to each other and in the same order. The rows must not collide with each other.
string$fnameCalling function name (use METHOD) for logs/profiling
string | array$optionsCombination map/list where each string-keyed entry maps a non-boolean option to the option parameters and each integer-keyed value is the name of a boolean option. Supported options are:
  • IGNORE: Boolean: skip insertion of rows that would cause unique key conflicts. IDatabase::affectedRows() can be used to determine how many rows were inserted.
Returns
bool Return true if no exception was thrown (deprecated since 1.33)
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1471 of file Database.php.

◆ insertId()

Wikimedia\Rdbms\Database::insertId ( )

Get the sequence-based ID assigned by the last query method call.

This method should only be called when all the following hold true:

  • (a) A method call was made to insert(), upsert(), replace(), or insertSelect()
  • (b) The method call attempts to insert exactly one row
  • (c) The method call omits the value of exactly one auto-increment column
  • (d) The method call succeeded
  • (e) No subsequent method calls were made, with the exception of affectedRows(), lastErrno(), lastError(), and getType()

In all other cases, the return value is unspecified.

When the query method is either insert() with "IGNORE", upsert(), or insertSelect(), callers should first check affectedRows() before calling this method, making sure that the query method actually created a row. Otherwise, an ID from a previous insert might be incorrectly assumed to belong to last insert.

Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.

Definition at line 2523 of file Database.php.

◆ insertSelect()

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

INSERT SELECT wrapper.

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.

This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.

Parameters
string$destTableUnqualified name of destination table
string | array$srcTableUnqualified name of source table(s) (use an array for 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()
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$conds Condition array. See $conds in IDatabase::select() for the details of the format of condition arrays. May be "*" to copy the whole table.
string$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 Return true if no exception was thrown (deprecated since 1.33)
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1715 of file Database.php.

◆ installErrorHandler()

Wikimedia\Rdbms\Database::installErrorHandler ( )
protected

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

Definition at line 415 of file Database.php.

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

◆ isConnectionError()

Wikimedia\Rdbms\Database::isConnectionError ( $errno)
protected

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

Parameters
int | string$errno
Returns
bool Whether the given query error was a connection drop
Since
1.38

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

Definition at line 1888 of file Database.php.

◆ isInsertSelectSafe()

Wikimedia\Rdbms\Database::isInsertSelectSafe ( array $insertOptions,
array $selectOptions,
$fname = __METHOD__ )
protected
Parameters
array$insertOptions
array$selectOptions
string$fname
Returns
bool Whether an INSERT SELECT with these options will be replication safe
Since
1.31

Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.

Definition at line 1766 of file Database.php.

◆ isKnownStatementRollbackError()

Wikimedia\Rdbms\Database::isKnownStatementRollbackError ( $errno)
protected
Parameters
int | string$errno
Returns
bool Whether it is known that the last query error only caused statement rollback
Note
This is for backwards compatibility for callers catching DBError exceptions in order to ignore problems like duplicate key errors or foreign key violations
Since
1.39

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

Definition at line 1899 of file Database.php.

◆ isOpen()

Wikimedia\Rdbms\Database::isOpen ( )
Returns
bool Whether a connection to the database open

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 396 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\assertHasConnectionHandle(), and Wikimedia\Rdbms\Database\initConnection().

◆ isQueryTimeoutError()

Wikimedia\Rdbms\Database::isQueryTimeoutError ( $errno)
protected

Checks whether the cause of the error is detected to be a timeout.

It returns false by default, and not all engines support detecting this yet. If this returns false, it will be treated as a generic query error.

Parameters
int | string$errnoError number
Returns
bool
Since
1.39

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

Definition at line 1132 of file Database.php.

◆ isQuotedIdentifier()

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

Definition at line 3359 of file Database.php.

◆ isReadOnly()

Wikimedia\Rdbms\Database::isReadOnly ( )

Check if this DB server is marked as read-only according to load balancer info.

Note
LoadBalancer checks serverIsReadOnly() when setting the load balancer info array
Returns
bool
Since
1.27

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2977 of file Database.php.

◆ lastDoneWrites()

Wikimedia\Rdbms\Database::lastDoneWrites ( )

Get the last time the connection may have been used for a write query.

Returns
int|float|false UNIX timestamp or false
Since
1.24

Implements Wikimedia\Rdbms\IDatabaseForOwner.

Definition at line 368 of file Database.php.

◆ lastInsertId()

Wikimedia\Rdbms\Database::lastInsertId ( )
abstractprotected

Get a row ID from the last insert statement to implicitly assign one within the session.

If the statement involved assigning sequence IDs to multiple rows, then the return value will be any one of those values (database-specific). If the statement was an "UPSERT" and some existing rows were updated, then the result will either reflect only IDs of created rows or it will reflect IDs of both created and updated rows (this is database-specific).

The result is unspecified if the statement gave an error.

Returns
int Sequence ID, 0 (if none)
Exceptions
DBError

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

◆ limitResult()

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

Construct a LIMIT query with optional offset.

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

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

Parameters
string$sqlSQL query we will append the limit too
int$limitThe SQL limit
int | false$offsetThe SQL offset (default false)
Returns
string
Since
1.34 in IDatabase, moved to ISQLPlatform in 1.39

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3375 of file Database.php.

◆ listTables()

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

List all tables on the database.

Since MW 1.42, this will no longer include MySQL views.

Parameters
string | null$prefixOnly show tables with this prefix, e.g. mw_
string$fnameCalling function name
Exceptions
DBError
Returns
array

Implements Wikimedia\Rdbms\IMaintainableDatabase.

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

Definition at line 2513 of file Database.php.

◆ lock()

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

Acquire a named lock.Named locks are not related to transactions

Parameters
string$lockNameName of lock to acquire
string$methodName of the calling method
int$timeoutAcquisition timeout in seconds (0 means non-blocking)
int$flagsBit field of IDatabase::LOCK_* constants
Returns
bool|float|null Success (bool); acquisition time (float/null) if LOCK_TIMESTAMP
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2848 of file Database.php.

◆ lockForUpdate()

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

Lock all rows meeting the given conditions/options FOR UPDATE.

Parameters
string | string[]$tableUnqualified name of table(s) (use an array for a join)
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$conds Condition in the format of IDatabase::select() conditions
string$fnameFunction name for profiling
array$optionsOptions for select ("FOR UPDATE" is added automatically)
array$join_condsJoin conditions
Returns
int Number of matching rows found (and locked)
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.32
Deprecated
since 1.43; Use SelectQueryBuilder::acquireRowLocks

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1424 of file Database.php.

◆ lockIsFree()

Wikimedia\Rdbms\Database::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
DBErrorIf an error occurs, {
See also
query}
Since
1.20

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2820 of file Database.php.

◆ makeList()

Wikimedia\Rdbms\Database::makeList ( array $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 also
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
DBErrorIf an error occurs, {
See also
IDatabase::query}
Returns
string

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3295 of file Database.php.

◆ makeWhereFrom2d()

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

Build a "OR" condition with pairs from a two-dimensional array.

The associative array should have integer keys relating to the $baseKey field. The nested array should have string keys for the $subKey field. The inner values are ignored, and are typically boolean true.

Example usage:

$data = [
2 => [
'Foo' => true,
'Bar' => true,
],
3 => [
'Quux' => true,
],
];
// (page_namespace = 2 AND page_title IN ('Foo','Bar'))
// OR (page_namespace = 3 AND page_title = 'Quux')
Todo
This is effectively specific to MediaWiki's LinkBatch. Consider deprecating or generalising slightly.
Parameters
array$dataNested array, must be non-empty
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 SQL fragment

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3299 of file Database.php.

◆ newDeleteQueryBuilder()

Wikimedia\Rdbms\Database::newDeleteQueryBuilder ( )

Get a DeleteQueryBuilder bound to this connection.

This is overridden by DBConnRef.

Returns
DeleteQueryBuilder

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1260 of file Database.php.

◆ newExceptionAfterConnectError()

Wikimedia\Rdbms\Database::newExceptionAfterConnectError ( $error)
finalprotected
Parameters
string$error
Returns
DBConnectionError

Definition at line 1206 of file Database.php.

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

◆ newInsertQueryBuilder()

Wikimedia\Rdbms\Database::newInsertQueryBuilder ( )

Get a InsertQueryBuilder bound to this connection.

This is overridden by DBConnRef.

Returns
InsertQueryBuilder

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1270 of file Database.php.

◆ newReplaceQueryBuilder()

Wikimedia\Rdbms\Database::newReplaceQueryBuilder ( )

Get a ReplaceQueryBuilder bound to this connection.

This is overridden by DBConnRef.

Returns
ReplaceQueryBuilder

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1280 of file Database.php.

◆ newSelectQueryBuilder()

Wikimedia\Rdbms\Database::newSelectQueryBuilder ( )

Get a SelectQueryBuilder bound to this connection.

This is overridden by DBConnRef.

Returns
SelectQueryBuilder

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 1230 of file Database.php.

◆ newUnionQueryBuilder()

Wikimedia\Rdbms\Database::newUnionQueryBuilder ( )

Get a UnionQueryBuilder bound to this connection.

This is overridden by DBConnRef.

Returns
UnionQueryBuilder

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 1240 of file Database.php.

◆ newUpdateQueryBuilder()

Wikimedia\Rdbms\Database::newUpdateQueryBuilder ( )

Get an UpdateQueryBuilder bound to this connection.

This is overridden by DBConnRef.

Returns
UpdateQueryBuilder

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1250 of file Database.php.

◆ onAtomicSectionCancel()

Wikimedia\Rdbms\Database::onAtomicSectionCancel ( callable $callback,
$fname = __METHOD__ )
final

Run a callback when the atomic section is cancelled.

The callback is run just after the current atomic section, any outer atomic section, or the whole transaction is rolled back.

An error is thrown if no atomic section is pending. The atomic section need not have been created with the ATOMIC_CANCELABLE flag.

Queries in the function may be running in the context of an outer transaction or may be running in AUTOCOMMIT mode. The callback should use atomic sections if necessary.

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

The callback takes the following arguments:

  • IDatabase::TRIGGER_CANCEL or IDatabase::TRIGGER_ROLLBACK
  • This IDatabase instance
Parameters
callable$callback
string$fnameCaller name
Since
1.34

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1961 of file Database.php.

◆ onTransactionCommitOrIdle()

Wikimedia\Rdbms\Database::onTransactionCommitOrIdle ( callable $callback,
$fname = __METHOD__ )
final

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

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

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

This IDatabase instance will start off in auto-commit mode when the callback starts. The use of other IDatabase handles from the callback should be avoided unless they are known to be in auto-commit mode. Callbacks that create transactions via begin() or startAtomic() must have matching calls to commit()/endAtomic().

Use this method only for the following purposes:

  • (a) RDBMS updates, prone to lock timeouts/deadlocks, that do not require atomicity with respect to the updates in the current transaction (if any)
  • (b) Purges to lightweight cache services due to RDBMS updates
  • (c) Updates to secondary DBs/stores that must only commit once the updates in the current transaction (if any) are committed (e.g. insert user account row to DB1, then, initialize corresponding LDAP account)

The callback takes the following arguments:

  • How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_IDLE)
  • This IDatabase instance (since 1.32)

Callbacks will execute in the order they were enqueued.

Parameters
callable$callback
string$fnameCaller name
Exceptions
DBErrorIf an error occurs, {
See also
query}
Exceptions
ExceptionIf the callback runs immediately and an error occurs in it
Since
1.32

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1914 of file Database.php.

◆ onTransactionPreCommitOrIdle()

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

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

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

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

If there is no current transaction, one will be created to wrap the callback. Callbacks cannot use begin()/commit() to manage transactions. The use of other IDatabase handles from the callback should be avoided.

Use this method only for the following purposes:

  • a) RDBMS updates, prone to lock timeouts/deadlocks, that require atomicity with respect to the updates in the current transaction (if any)
  • b) Purges to lightweight cache services due to RDBMS updates

The callback takes the one argument:

  • This IDatabase instance (since 1.32)

Callbacks will execute in the order they were enqueued.

Parameters
callable$callback
string$fnameCaller name
Exceptions
DBErrorIf an error occurs, {
See also
query}
Exceptions
ExceptionIf the callback runs immediately and an error occurs in it
Since
1.22

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1932 of file Database.php.

◆ onTransactionResolution()

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

Run a callback when the current transaction commits or rolls back.

An error is thrown if no transaction is pending.

When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT/ROLLBACK.

This IDatabase instance will start off in auto-commit mode when the callback starts. The use of other IDatabase handles from the callback should be avoided unless they are known to be in auto-commit mode. Callbacks that create transactions via begin() or startAtomic() must have matching calls to commit()/endAtomic().

Use this method only for the following purposes:

  • (a) Release of cooperative locks on resources
  • (b) Cancellation of in-process deferred tasks

The callback takes the following arguments:

  • How the current atomic section (if any) or overall transaction (otherwise) ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK)
  • This IDatabase instance (since 1.32)

Callbacks will execute in the order they were enqueued.

Note
Use onAtomicSectionCancel() to take action as soon as an atomic section is cancelled
Parameters
callable$callback
string$fnameCaller name
Exceptions
DBErrorIf an error occurs, {
See also
query}
Exceptions
ExceptionIf the callback runs immediately and an error occurs in it
Since
1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1910 of file Database.php.

◆ open()

Wikimedia\Rdbms\Database::open ( $server,
$user,
$password,
$db,
$schema,
$tablePrefix )
abstractprotected

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

Parameters
string | null$serverServer host/address and optional port {
See also
connectionParams}
Parameters
string | null$userUser name {
See also
connectionParams}
Parameters
string | null$passwordUser password {
See also
connectionParams}
Parameters
string | null$dbDatabase name
string | null$schemaDatabase schema name
string$tablePrefix
Exceptions
DBConnectionError

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

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

◆ pendingWriteAndCallbackCallers()

Wikimedia\Rdbms\Database::pendingWriteAndCallbackCallers ( )

Definition at line 3262 of file Database.php.

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

◆ pendingWriteCallers()

Wikimedia\Rdbms\Database::pendingWriteCallers ( )

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

Returns
array
Since
1.27

Implements Wikimedia\Rdbms\IDatabaseForOwner.

Definition at line 3255 of file Database.php.

◆ pendingWriteQueryDuration()

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

Get the time spend running write queries for this transaction.

High values could be due to scanning, updates, locking, and such.

Parameters
string$typeIDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL]
Returns
float|false Returns false if not transaction is active
Since
1.26

Implements Wikimedia\Rdbms\IDatabaseForOwner.

Definition at line 3251 of file Database.php.

◆ ping()

Wikimedia\Rdbms\Database::ping ( )

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

Returns
bool Success or failure

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 2552 of file Database.php.

◆ primaryPosWait()

Wikimedia\Rdbms\Database::primaryPosWait ( DBPrimaryPos $pos,
$timeout )

Wait for the replica server to catch up to a given primary server position.

Note that this does not start any new transactions.

Callers might want to flush any existing transaction before invoking this method. Upon success, this assures that replica server queries will reflect all changes up to the given position, without interference from prior REPEATABLE-READ snapshots.

Parameters
DBPrimaryPos$pos
int$timeoutThe maximum number of seconds to wait for synchronisation
Returns
int|null Zero if the replica DB server 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
DBErrorIf an error occurs, {
See also
query}
Since
1.37

Implements Wikimedia\Rdbms\IDatabaseForOwner.

Definition at line 3451 of file Database.php.

◆ query()

Wikimedia\Rdbms\Database::query ( $sql,
$fname = __METHOD__,
$flags = 0 )

Run an SQL query statement and return the result.

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

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

However, the query wrappers themselves should call this function.

Callers should avoid the use of statements like BEGIN, COMMIT, and ROLLBACK. Methods like startAtomic(), endAtomic(), and cancelAtomic() can be used instead.

Parameters
string | Query$sqlSingle-statement SQL query
string$fnameCaller name; used for profiling/SHOW PROCESSLIST comments
int$flagsBit field of IDatabase::QUERY_* constants.
Returns
bool|IResultWrapper True for a successful write query, IResultWrapper object for a successful read query, or false on failure if QUERY_SILENCE_ERRORS is set.
Exceptions
DBQueryErrorIf the query is issued, fails, and QUERY_SILENCE_ERRORS is not set.
DBExpectedErrorIf the query is not, and cannot, be issued yet (non-DBQueryError)
DBErrorIf the query is inherently not allowed (non-DBExpectedError)

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 622 of file Database.php.

References Wikimedia\Rdbms\Database\$flags, Wikimedia\Rdbms\QueryBuilderFromRawSql\buildQuery(), Wikimedia\Rdbms\Database\currentDomain, Wikimedia\Rdbms\Database\executeQuery(), and Wikimedia\Rdbms\Database\reportQueryError().

Referenced by Wikimedia\Rdbms\PostgresField\fromText(), Wikimedia\Rdbms\DatabasePostgres\open(), and Wikimedia\Rdbms\DatabaseSqlite\open().

◆ registerTempTables()

Wikimedia\Rdbms\Database::registerTempTables ( Query $query)
protected

◆ replace()

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

Insert row(s) into a table, in the provided order, while deleting conflicting rows.

Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.

Note some important implications of the deletion semantics:

  • If the table has an AUTOINCREMENT column and $rows omit that column, then any conflicting existing rows will be replaced with newer having higher values for that column, even if nothing else changed.
  • There might be worse contention than upsert() due to the use of gap-locking. This does not apply to RDBMS types that use predicate locking nor those that just lock the whole table or databases anyway.

This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.

Access: internal
callers outside of rdbms library should use ReplaceQueryBuilder instead.
Parameters
string$tableUnqualified name of table
string | string[] | string[][]$uniqueKeysColumn name or non-empty list of column name lists that define all applicable unique keys on the table. There must only be one such key. Each unique key on the table is "applicable" unless either:
  • It involves an AUTOINCREMENT column for which no values are assigned in $rows
  • It involves a UUID column for which newly generated UUIDs are assigned in $rows
array | array[]$rowsRow(s) to insert, in the form of either:
  • A string-keyed map of (column name => value) defining a new row. Values are treated as literals and quoted appropriately; null is interpreted as NULL. Columns belonging to a key in $uniqueKeys must be defined here and non-null.
  • An integer-keyed list of such string-keyed maps, defining a list of new rows. The keys in each map must be identical to each other and in the same order. The rows must not collide with each other.
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

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

Definition at line 1563 of file Database.php.

◆ replaceLostConnection()

Wikimedia\Rdbms\Database::replaceLostConnection ( $lastErrno,
$fname )
protected

Close any existing (dead) database connection and open a new connection.

Parameters
int | null$lastErrno
string$fname
Returns
bool True if new connection is opened successfully, false if error

Definition at line 2582 of file Database.php.

◆ reportQueryError()

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

Report a query error.

If $ignore is set, emit a DEBUG level log entry and continue, otherwise, emit an ERROR level log entry and throw an exception.

Parameters
string$error
int | string$errno
string$sql
string$fname
bool$ignoreWhether to just log an error rather than throw an exception
Exceptions
DBQueryError

Definition at line 1149 of file Database.php.

Referenced by Wikimedia\Rdbms\DatabaseMySQL\checkInsertWarnings(), Wikimedia\Rdbms\DatabaseMySQL\doSelectDomain(), Wikimedia\Rdbms\DatabaseMySQL\open(), and Wikimedia\Rdbms\Database\query().

◆ restoreErrorHandler()

Wikimedia\Rdbms\Database::restoreErrorHandler ( )
protected

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

Returns
string|false

Definition at line 426 of file Database.php.

References Wikimedia\Rdbms\Database\getLastPHPError().

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

◆ restoreFlags()

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

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

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

Implements Wikimedia\Rdbms\Database\IDatabaseFlags.

Definition at line 3213 of file Database.php.

◆ rollback()

Wikimedia\Rdbms\Database::rollback ( $fname = __METHOD__,
$flush = self::FLUSHING_ONE )
final

Rollback a transaction previously started using begin()

Only call this from code with outer transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported. If a serious unexpected error occurs, throwing an Exception is preferable, using a pre-installed error handler to trigger rollback (in any case, failure to issue COMMIT will cause rollback server-side).

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

Parameters
string$fnameCalling function name
string$flushFlush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly rolling back implicit transactions. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context.
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.23 Added $flush parameter

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2364 of file Database.php.

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

◆ runOnTransactionIdleCallbacks()

Wikimedia\Rdbms\Database::runOnTransactionIdleCallbacks ( $trigger,
array & $errors = [] )

Consume and run any "on transaction idle/resolution" callbacks.

Access: internal
This method should not be used outside of Database/LoadBalancer
Since
1.20
Parameters
int$triggerIDatabase::TRIGGER_* constant
DBError[]&$errorsDB exceptions caught [returned]
Returns
int Number of callbacks attempted
Exceptions
DBUnexpectedError
ThrowableAny non-DBError exception thrown by a callback

Definition at line 1993 of file Database.php.

◆ runOnTransactionPreCommitCallbacks()

Wikimedia\Rdbms\Database::runOnTransactionPreCommitCallbacks ( )

Definition at line 3269 of file Database.php.

◆ runTransactionListenerCallbacks()

Wikimedia\Rdbms\Database::runTransactionListenerCallbacks ( $trigger,
array & $errors = [] )

Actually run any "transaction listener" callbacks.

Access: internal
This method should not be used outside of Database/LoadBalancer
Since
1.20
Parameters
int$triggerIDatabase::TRIGGER_* constant
DBError[]&$errorsDB exceptions caught [returned]
Exceptions
ThrowableAny non-DBError exception thrown by a callback

Definition at line 2048 of file Database.php.

◆ select()

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

Execute a SELECT query constructed using the various parameters provided.

New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchResultSet instead, which is more readable and less error-prone.

Parameters
string | array$tablesTable reference(s) using unqualified table names.

Each table reference assigns a table name to a specified collection of rows for the context of the query (e.g. field expressions, WHERE clause, GROUP BY clause, HAVING clause, ect...). Use of multiple table references implies a JOIN.

If a string is given, it must hold the name of the table having the specified collection of rows. If an array is given, each entry must be one of the following:

  • A string holding the name of the existing table which has the collection of rows. If keyed by a string, the key will be the assigned table name.
  • A Subquery instance which specifies the collection of rows derived from a subquery. If keyed by a string, the key will be the assigned table name. Otherwise, the SQL text of the subquery will be the assigned table name.
  • An array specifying the collection of rows derived from a parenthesized JOIN. It must be keyed by a string, which will be used as the assigned table name.

String keys allow table aliases to 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$varsField name(s)

May be either a field name or an array of field names. The field names can be complete fragments of SQL, for direct inclusion into the SELECT query. If an array is given, field aliases can be specified, for example:

[ 'maxrev' => 'MAX(rev_id)' ]

This includes an expression with the alias "maxrev" in the query.

If an expression is given, care must be taken to ensure that it is DBMS-independent.

Untrusted user input must not be passed to this parameter.

Parameters
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$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()

Use an empty array, string, or IDatabase::ALL_ROWS to select all rows.

You can put simple join conditions here, but this is strongly discouraged. Instead of

// $conds...
'rev_actor = actor_id',

use (see below for $join_conds):

// $join_conds...
'actor' => [ 'JOIN', 'rev_actor = actor_id' ],
Parameters
string$fnameCaller function name
string | array$optionsQuery 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.
  • LOCK IN SHARE MODE: Boolean: lock the returned rows so that they can't be changed until the next COMMIT. Cannot be used with aggregate functions (COUNT, MAX, etc., but also DISTINCT).
  • FOR UPDATE: Boolean: lock the returned rows so that they can't be changed nor read with LOCK IN SHARE MODE until the next COMMIT. Cannot be used with aggregate functions (COUNT, MAX, etc., but also DISTINCT).
  • 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 a 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.
  • IGNORE INDEX: This may be either be a string giving an index name to ignore 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 ignore 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.
  • MAX_EXECUTION_TIME: (only in MySQL/MariaDB) maximum allowed time to run the query in milliseconds (if database supports it).

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

  • STRAIGHT_JOIN
  • SQL_BIG_RESULT
  • SQL_BUFFER_RESULT
  • SQL_SMALL_RESULT
  • SQL_CALC_FOUND_ROWS
Parameters
string | array$join_condsJoin conditions

Optional associative array of table-specific join conditions. Simple conditions can also be specified in the regular $conds, but this is strongly discouraged in favor of the more explicit syntax here.

The key of the array contains the table name or alias. The value is an array with two elements, numbered 0 and 1. The first gives the type of join, the second is the same as the $conds parameter. Thus it can be an SQL fragment, or an array where the string keys are equality and the numeric keys are SQL fragments all AND'd together. For example:

[ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]

Access: internal
Returns
IResultWrapper Resulting rows
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 1332 of file Database.php.

◆ selectDomain()

Wikimedia\Rdbms\Database::selectDomain ( $domain)
final

Set the current domain (database, schema, and table prefix)

This will throw an error for some database types if the database is unspecified

This should only be called by a load balancer or if the handle is not attached to one

Parameters
string | DatabaseDomain$domain
Exceptions
DBConnectionErrorIf databasesAreIndependent() is true and connection change fails
DBErrorOn query error, if domain changes are disallowed, or the domain is invalid
Since
1.32

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 1505 of file Database.php.

Referenced by MediaWiki\Installer\DatabaseInstaller\selectDatabase().

◆ selectField()

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

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

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

New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchField instead, which is more readable and less error-prone.

Access: internal
callers outside of rdbms library should use SelectQueryBuilder instead.
Parameters
string | array$tablesTable reference(s) using unqualified table names. {
See also
select} for details.
Parameters
string | array$varThe field name to select. This must be a valid SQL fragment: do not use unvalidated user input. Can be an array, but must contain exactly 1 element then. {
See also
select} for details.
Parameters
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$cond The condition array. {
See also
select} for details.
Parameters
string$fnameThe function name of the caller.
string | array$optionsThe query options. {
See also
select} for details.
Parameters
string | array$join_condsThe query join conditions. {
See also
select} for details.
Returns
mixed|false The value from the field, or false if nothing was found
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 1284 of file Database.php.

◆ selectFieldValues()

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

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

If no result rows are returned from the query, an empty array is returned.

New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchFieldValues instead, which is more readable and less error-prone.

Access: internal
callers outside of rdbms library should use SelectQueryBuilder instead.
Parameters
string | array$tablesTable reference(s) using unqualified table names. {
See also
select} for details.
Parameters
string$varThe field name to select. This must be a valid SQL fragment: do not use unvalidated user input.
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$cond The condition array. {
See also
select} for details.
Parameters
string$fnameThe function name of the caller.
string | array$optionsThe query options. {
See also
select} for details.
Parameters
string | array$join_condsThe query join conditions. {
See also
select} for details.
Returns
array The values from the field in the order they were returned from the DB
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.25

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 1309 of file Database.php.

◆ selectRow()

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

Wrapper to IDatabase::select() that only fetches one row (via LIMIT)

If the query returns no rows, false is returned.

This method is convenient for fetching a row based on a unique key condition.

New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchRow instead, which is more readable and less error-prone.

Access: internal
Parameters
string | array$tablesTable reference(s) using unqualified table names. {
See also
select} for details.
Parameters
string | array$varsField names
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$conds Conditions
string$fnameCaller function name
string | array$optionsQuery options
array | string$join_condsJoin conditions
Returns
stdClass|false
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 1348 of file Database.php.

◆ selectRowCount()

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

Get the number of rows in dataset.

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

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

New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchRowCount instead, which is more readable and less error-prone.

Since
1.27 Added $join_conds parameter
Access: internal
Parameters
string | string[]$tablesUnqualified name of table(s)
string$varColumn for which NULL values are not counted [default "*"]
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$conds Filters on the table
string$fnameFunction name for profiling
array$optionsOptions for select
array$join_condsJoin conditions (since 1.27)
Returns
int Row count
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 1386 of file Database.php.

◆ selectSQLText()

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

Take the same arguments as IDatabase::select() and return the SQL it would use.

This can be useful for making 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$tablesTable reference(s) using unqualified table names
string | array$varsField names
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$conds Conditions
string$fnameCaller function name
string | array$optionsQuery options
string | array$join_condsJoin conditions
Returns
string SQL query string

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.

Definition at line 3285 of file Database.php.

◆ serverIsReadOnly()

Wikimedia\Rdbms\Database::serverIsReadOnly ( )

Returns
bool Whether this DB server is running in server-side read-only mode
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.28

Implements Wikimedia\Rdbms\IDatabaseForOwner.

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

Definition at line 1906 of file Database.php.

◆ sessionLocksPending()

Wikimedia\Rdbms\Database::sessionLocksPending ( )
Returns
bool
Since
1.39
Access: internal
For use by Database/LoadBalancer only

Definition at line 377 of file Database.php.

◆ setFlag()

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

Set a flag for this connection.

Parameters
int$flagOne of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX)
string$rememberIDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]

Implements Wikimedia\Rdbms\Database\IDatabaseFlags.

Definition at line 3205 of file Database.php.

◆ setIndexAliases()

Wikimedia\Rdbms\Database::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
Since
1.31 in IDatabase, moved to ISQLPlatform in 1.39

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3423 of file Database.php.

◆ setLBInfo()

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

Set the entire array or a particular key of the managing load balancer info array.

Keys matching the IDatabase::LB_* constants are also used internally by subclasses

Access: internal
should not be called outside of rdbms library.
Parameters
array | string$nameOrArrayThe new array or the name of a key to set
array | mixed | null$valueIf $nameOrArray is a string, the new key value (null to unset)

Implements Wikimedia\Rdbms\IDatabaseForOwner.

Definition at line 354 of file Database.php.

References Wikimedia\Rdbms\Database\lbInfo.

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

◆ setLogger()

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

Set the PSR-3 logger interface to use.

Parameters
LoggerInterface$logger

Definition at line 296 of file Database.php.

◆ setSchemaVars()

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

Set schema variables to be used when streaming commands from SQL files or stdin.

Variables appear as SQL comments and are substituted by their corresponding values

Parameters
array | null$varsMap of (variable => value) or null to use the defaults

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3444 of file Database.php.

◆ setSessionOptions()

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

Override database's default behavior.

Not all options are supported on all database backends; unsupported options are silently ignored.

$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. Only supported on MySQL and MariaDB.
  • 'groupConcatMaxLen': Maximum length of a GROUP_CONCAT() result. Only supported on MySQL and MariaDB.
Parameters
array$options
Returns
void
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.

Definition at line 2689 of file Database.php.

◆ setTableAliases()

Wikimedia\Rdbms\Database::setTableAliases ( array $aliases)

Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.

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

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

Parameters
array[]$aliasesMap of (unqualified table name => (dbname, schema, prefix) map)
Since
1.28 in IDatabase, moved to ISQLPlatform in 1.39

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.

Definition at line 3415 of file Database.php.

◆ setTransactionListener()

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

Run a callback after 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.

Since callbacks from this or onTransactionCommitOrIdle() can start and end transactions, a single call to IDatabase::commit might trigger multiple runs of the listener callbacks.

Parameters
string$nameCallback name
callable | null$callbackUse null to unset a listener
Since
1.28

Implements Wikimedia\Rdbms\IDatabaseForOwner.

Definition at line 1965 of file Database.php.

◆ setTransactionManager()

Wikimedia\Rdbms\Database::setTransactionManager ( TransactionManager $transactionManager)
Access: internal
Only for tests and highly discouraged
Parameters
TransactionManager$transactionManager

Definition at line 2428 of file Database.php.

◆ setTrxEndCallbackSuppression()

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

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

Access: internal
This method should not be used outside of Database/LoadBalancer
Since
1.28
Parameters
bool$suppress

Definition at line 1977 of file Database.php.

◆ sourceFile()

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

Read and execute SQL commands from a file.

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

Parameters
string$filenameFile name to open
callable | null$lineCallbackOptional function called before reading each line
callable | null$resultCallbackOptional function called for each MySQL result
string | false$fnameCalling function name or false if name should be generated dynamically using $filename
callable | null$inputCallbackOptional function called for each complete line sent
Returns
bool|string
Exceptions
Exception

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 2692 of file Database.php.

◆ sourceStream()

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

Read and execute commands from an open file handle.

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

Parameters
resource$fpFile handle
callable | null$lineCallbackOptional function called before reading each query
callable | null$resultCallbackOptional function called for each MySQL result
string$fnameCalling function name
callable | null$inputCallbackOptional function called for each complete query sent
Returns
bool|string

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 2724 of file Database.php.

◆ startAtomic()

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

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 );
}
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
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2094 of file Database.php.

◆ streamStatementEnd()

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

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

Parameters
string&$sqlSQL assembled so far
string&$newLineNew line about to be added to $sql
Returns
bool Whether $newLine contains end of the statement

Implements Wikimedia\Rdbms\IMaintainableDatabase.

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

Definition at line 2801 of file Database.php.

◆ strencode()

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

Wrapper for addslashes()

Parameters
string$sString to be slashed.
Returns
string Slashed string.

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

◆ strreplace()

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

Returns a SQL expression for simple string replacement (e.g.

REPLACE() in mysql)

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

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3391 of file Database.php.

◆ tableExists()

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

Query whether a given table exists.

Parameters
string$tableUnqualified name of table
string$fname
Returns
bool
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IMaintainableDatabase.

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

◆ tableName()

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

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

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

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

Note
This function does not sanitize user input. It is not safe to use this function to escape user input.
Parameters
string$nameUnqualified name of table (no quotes, db, schema, nor table prefix)
string$formatOne of: quoted - Automatically pass the table name through addIdentifierQuotes() so that it can be used in a query. raw - Do not add identifier quotes to the table name
Returns
string Qualified table name (includes any applicable prefix or foreign db/schema)

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3343 of file Database.php.

◆ tableNames()

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

Fetch a number of table names into an associative array.

Much like tableName(), this is only needed when calling query() directly. Prefer calling other methods, or using SelectQueryBuilder.

Theoretical example (which really does not require raw SQL):

[ 'user' => $user, 'watchlist' => $watchlist ] =
$dbr->tableNames( 'user', 'watchlist' );
$sql = "SELECT wl_namespace, wl_title FROM $watchlist, $user
WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
Parameters
string...$tables
Returns
array
Deprecated
since 1.39; if you must format table names, write several calls to tableName or use tableNamesN instead of calling this function.

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3347 of file Database.php.

◆ tableNamesN()

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

Fetch a number of table names into a zero-indexed numerical array.

Much like tableName(), this is only needed when calling query() directly. It is slightly more convenient than tableNames(), but you should still prefer calling other methods, or using SelectQueryBuilder.

Theoretical example (which really does not require raw SQL):

[ $user, $watchlist ] = $dbr->tableNamesN( 'user', 'watchlist' );
$sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
Parameters
string...$tables
Returns
array
Deprecated
Since 1.43; if you must format table names, write several calls to tableName.

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3351 of file Database.php.

◆ tablePrefix()

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

Get/set the table prefix.

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

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 304 of file Database.php.

References Wikimedia\Rdbms\Database\currentDomain, and Wikimedia\Rdbms\Database\platform.

Referenced by MediaWiki\Installer\DatabaseInstaller\selectDatabase().

◆ timestamp()

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

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

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

Parameters
string | int$ts
Returns
string

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3395 of file Database.php.

◆ timestampOrNull()

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

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

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 | null$ts
Returns
string|null

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3399 of file Database.php.

◆ truncateTable()

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

Delete all data in a table and reset any sequences owned by that table.

Parameters
string$tableUnqualified name of table
string$fname
Exceptions
DBErrorIf an error occurs
Since
1.42

Implements Wikimedia\Rdbms\IMaintainableDatabase.

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

Definition at line 2971 of file Database.php.

◆ trxLevel()

Wikimedia\Rdbms\Database::trxLevel ( )
final

Gets the current transaction level.

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

Returns
int The previous value

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3225 of file Database.php.

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

◆ trxStatus()

Wikimedia\Rdbms\Database::trxStatus ( )

Definition at line 3239 of file Database.php.

◆ trxTimestamp()

Wikimedia\Rdbms\Database::trxTimestamp ( )

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

This can be used to reason about the staleness of SELECT data in REPEATABLE-READ transaction isolation level. Callers can assume that if a view-snapshot isolation is used, then the data read by SQL queries is at least up to date to that point (possibly more up-to-date since the first SELECT defines the snapshot).

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3235 of file Database.php.

◆ unionQueries()

Wikimedia\Rdbms\Database::unionQueries ( $sqls,
$all,
$options = [] )

Construct a UNION query.

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

Access: internal
callers outside of rdbms library should use UnionQueryBuilder instead.
Parameters
array$sqlsSQL statements to combine
bool$allEither IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT
array$optionsQuery options
Returns
string SQL fragment

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3383 of file Database.php.

◆ unionSupportsOrderAndLimit()

Wikimedia\Rdbms\Database::unionSupportsOrderAndLimit ( )

Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.

Returns
bool

Implements Wikimedia\Rdbms\Platform\ISQLPlatform.

Definition at line 3379 of file Database.php.

◆ unlock()

Wikimedia\Rdbms\Database::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
bool Success
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2886 of file Database.php.

◆ update()

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

Update all rows in a table that match a given condition.

This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.

Access: internal
callers outside of rdbms library should use UpdateQueryBuilder instead.
Parameters
string$tableUnqualified name of table
array<string,?scalar|RawSQLValue>|array<int,string>$set Combination map/list where each string-keyed entry maps a column to a literal assigned value and each integer-keyed value is a SQL expression in the format of a column assignment within UPDATE...SET. The (column => value) entries are convenient due to automatic value quoting and conversion of null to NULL. The SQL assignment format is useful for updates like "column = column + X". All assignments have no defined execution order, so they should not depend on each other. Do not modify AUTOINCREMENT or UUID columns in assignments.
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression>$conds Condition in the format of IDatabase::select() conditions. In order to prevent possible performance or replication issues or damaging a data accidentally, an empty condition for 'update' queries isn't allowed. IDatabase::ALL_ROWS should be passed explicitly in order to update all rows.
string$fnameCalling function name (use METHOD) for logs/profiling
string | array$optionsCombination map/list where each string-keyed entry maps a non-boolean option to the option parameters and each integer-keyed value is the name of a boolean option. Supported options are:
  • IGNORE: Boolean: skip update of rows that would cause unique key conflicts. IDatabase::affectedRows() includes all matching rows, that includes also rows not updated due to key conflict.
Returns
bool Return true if no exception was thrown (deprecated since 1.33)
Exceptions
DBErrorIf an error occurs, {
See also
query}

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1494 of file Database.php.

◆ upsert()

Wikimedia\Rdbms\Database::upsert ( $table,
array $rows,
$uniqueKeys,
array $set,
$fname = __METHOD__ )

Upsert row(s) into a table, in the provided order, while updating conflicting rows.

Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.

This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.

Access: internal
callers outside of rdbms library should use InsertQueryBuilder instead.
Parameters
string$tableUnqualified name of table
array | array[]$rowsRow(s) to insert, in the form of either:
  • A string-keyed map of (column name => value) defining a new row. Values are treated as literals and quoted appropriately; null is interpreted as NULL. Columns belonging to a key in $uniqueKeys must be defined here and non-null.
  • An integer-keyed list of such string-keyed maps, defining a list of new rows. The keys in each map must be identical to each other and in the same order. The rows must not collide with each other.
string | string[] | string[][]$uniqueKeysColumn name or non-empty list of column name lists that define all applicable unique keys on the table. There must only be one such key. Each unique key on the table is "applicable" unless either:
  • It involves an AUTOINCREMENT column for which no values are assigned in $rows
  • It involves a UUID column for which newly generated UUIDs are assigned in $rows
array<string,?scalar|RawSQLValue>|array<int,string>$set Combination map/list where each string-keyed entry maps a column to a literal assigned value and each integer-keyed value is a SQL assignment expression of the form "<unquoted alphanumeric column> = <SQL expression>". The (column => value) entries are convenient due to automatic value quoting and conversion of null to NULL. The SQL assignment entries are useful for updates like "column = column + X". All of the assignments have no defined execution order, so callers should make sure that they not depend on each other. Do not modify AUTOINCREMENT or UUID columns in assignments, even if they are just "secondary" unique keys. For multi-row upserts, use buildExcludedValue() to reference the value of a column from the corresponding row in $rows that conflicts with the current row.
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.22

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.

Definition at line 1594 of file Database.php.

◆ writesOrCallbacksPending()

Wikimedia\Rdbms\Database::writesOrCallbacksPending ( )

Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending.

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

Returns
bool

Implements Wikimedia\Rdbms\IDatabaseForOwner.

Definition at line 3247 of file Database.php.

◆ writesPending()

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

Implements Wikimedia\Rdbms\IDatabaseForOwner.

Definition at line 3243 of file Database.php.

Member Data Documentation

◆ $agent

string Wikimedia\Rdbms\Database::$agent
protected

Agent name for query profiling.

Definition at line 76 of file Database.php.

◆ $cliMode

bool Wikimedia\Rdbms\Database::$cliMode
protected

Whether this PHP instance is for a CLI script.

Definition at line 70 of file Database.php.

◆ $conn

object resource null Wikimedia\Rdbms\Database::$conn
protected

Database connection.

Definition at line 65 of file Database.php.

◆ $connectionParams

array<string,mixed> Wikimedia\Rdbms\Database::$connectionParams
protected

Connection parameters used by initConnection() and open()

Definition at line 78 of file Database.php.

◆ $connectionVariables

string [] int [] float [] Wikimedia\Rdbms\Database::$connectionVariables
protected

SQL variables values to use for all new connections.

Definition at line 80 of file Database.php.

◆ $connectTimeout

int null Wikimedia\Rdbms\Database::$connectTimeout
protected

Maximum seconds to wait on connection attempts.

Definition at line 72 of file Database.php.

◆ $csProvider

CriticalSectionProvider null Wikimedia\Rdbms\Database::$csProvider
protected

Definition at line 46 of file Database.php.

◆ $currentDomain

DatabaseDomain Wikimedia\Rdbms\Database::$currentDomain
protected

Definition at line 59 of file Database.php.

◆ $delimiter

string false Wikimedia\Rdbms\Database::$delimiter = ';'
protected

Current SQL query delimiter.

Definition at line 91 of file Database.php.

◆ $deprecationLogger

callable Wikimedia\Rdbms\Database::$deprecationLogger
protected

Deprecation logging callback.

Definition at line 52 of file Database.php.

◆ $errorLogger

callable Wikimedia\Rdbms\Database::$errorLogger
protected

Error logging callback.

Definition at line 50 of file Database.php.

◆ $flags

if (is_string($params[ 'sqlMode'] ?? null)) Wikimedia\Rdbms\Database::$flags = (int)$params['flags']

◆ $flagsHolder

DatabaseFlags Wikimedia\Rdbms\Database::$flagsHolder
protected

Definition at line 61 of file Database.php.

◆ $lbInfo

array Wikimedia\Rdbms\Database::$lbInfo = []
protected

Current LoadBalancer tracking information.

Definition at line 89 of file Database.php.

◆ $logger

LoggerInterface Wikimedia\Rdbms\Database::$logger
protected

Definition at line 48 of file Database.php.

◆ $nonNativeInsertSelectBatchSize

int Wikimedia\Rdbms\Database::$nonNativeInsertSelectBatchSize
protected

Row batch size to use for emulated INSERT SELECT queries.

Definition at line 82 of file Database.php.

◆ $profiler

callable null Wikimedia\Rdbms\Database::$profiler
protected

Definition at line 54 of file Database.php.

◆ $receiveTimeout

int null Wikimedia\Rdbms\Database::$receiveTimeout
protected

Maximum seconds to wait on receiving query results.

Definition at line 74 of file Database.php.

◆ $serverName

string null Wikimedia\Rdbms\Database::$serverName
protected

Readable name or host/IP of the database server.

Definition at line 68 of file Database.php.

◆ $sessionNamedLocks

array<string,array> Wikimedia\Rdbms\Database::$sessionNamedLocks = []
protected

Map of (lock name => (UNIX time,trx ID))

Definition at line 97 of file Database.php.

◆ $ssl

bool Wikimedia\Rdbms\Database::$ssl
protected

Whether to use SSL connections.

Definition at line 85 of file Database.php.

◆ $strictWarnings

bool Wikimedia\Rdbms\Database::$strictWarnings
protected

Whether to check for warnings.

Definition at line 87 of file Database.php.

◆ agent

$this Wikimedia\Rdbms\Database::agent = (string)$params['agent']

Definition at line 220 of file Database.php.

◆ cliMode

$this Wikimedia\Rdbms\Database::cliMode = (bool)$params['cliMode']

Definition at line 219 of file Database.php.

◆ connectionParams

$this Wikimedia\Rdbms\Database::connectionParams
Initial value:
= [
self::CONN_HOST => ( isset( $params['host'] ) && $params['host'] !== '' )
? $params['host']
: null,
self::CONN_USER => ( isset( $params['user'] ) && $params['user'] !== '' )
? $params['user']
: null,
self::CONN_INITIAL_DB => ( isset( $params['dbname'] ) && $params['dbname'] !== '' )
? $params['dbname']
: null,
self::CONN_INITIAL_SCHEMA => ( isset( $params['schema'] ) && $params['schema'] !== '' )
? $params['schema']
: null,
self::CONN_PASSWORD => is_string( $params['password'] ) ? $params['password'] : null,
self::CONN_INITIAL_TABLE_PREFIX => (string)$params['tablePrefix']
]
array $params
The job parameters.

Definition at line 191 of file Database.php.

Referenced by Wikimedia\Rdbms\DatabasePostgres\doSelectDomain(), Wikimedia\Rdbms\Database\getLogContext(), and Wikimedia\Rdbms\Database\initConnection().

◆ connectionVariables

$this Wikimedia\Rdbms\Database::connectionVariables = $params['variables'] ?? []

◆ connectTimeout

$this Wikimedia\Rdbms\Database::connectTimeout = $params['connectTimeout'] ?? null

Definition at line 217 of file Database.php.

◆ csProvider

$this Wikimedia\Rdbms\Database::csProvider = $params['criticalSectionProvider'] ?? null

Definition at line 229 of file Database.php.

◆ currentDomain

◆ deprecationLogger

$this Wikimedia\Rdbms\Database::deprecationLogger = $params['deprecationLogger']

Definition at line 227 of file Database.php.

◆ errorLogger

$this Wikimedia\Rdbms\Database::errorLogger = $params['errorLogger']

◆ flagsHolder

$this Wikimedia\Rdbms\Database::flagsHolder = new DatabaseFlags( $flags )

◆ lbInfo

$this Wikimedia\Rdbms\Database::lbInfo = $params['lbInfo'] ?? []

◆ nonNativeInsertSelectBatchSize

$this Wikimedia\Rdbms\Database::nonNativeInsertSelectBatchSize = $params['nonNativeInsertSelectBatchSize'] ?? 10000

Definition at line 222 of file Database.php.

◆ platform

◆ profiler

$this Wikimedia\Rdbms\Database::profiler = is_callable( $params['profiler'] ) ? $params['profiler'] : null

Definition at line 225 of file Database.php.

◆ receiveTimeout

$this Wikimedia\Rdbms\Database::receiveTimeout = $params['receiveTimeout'] ?? null

Definition at line 218 of file Database.php.

◆ serverName

$this Wikimedia\Rdbms\Database::serverName = $params['serverName']

Definition at line 221 of file Database.php.

◆ ssl

$this Wikimedia\Rdbms\Database::ssl = $params['ssl'] ?? (bool)( $flags & self::DBO_SSL )

Definition at line 216 of file Database.php.

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

◆ strictWarnings

$this Wikimedia\Rdbms\Database::strictWarnings = !empty( $params['strictWarnings'] )

Definition at line 223 of file Database.php.

◆ transactionManager

array<string,array<string, $sessionTempTables = []; protected int $lastQueryAffectedRows = 0; protected int|null $lastQueryInsertId; protected int|null $lastEmulatedAffectedRows; protected int|null $lastEmulatedInsertId; protected string $lastConnectError = ''; private float $lastPing = 0.0; private float|false $lastWriteTime = false; private string|false $lastPhpError = false; private int|null $csmId; private string|null $csmFname; private DBUnexpectedError|null $csmError; public const ATTR_DB_IS_FILE = 'db-is-file'; public const ATTR_DB_LEVEL_LOCKING = 'db-level-locking'; public const ATTR_SCHEMAS_AS_TABLE_GROUPS = 'supports-schemas'; public const NEW_UNCONNECTED = 0; public const NEW_CONNECTED = 1; protected const ERR_NONE = 0; protected const ERR_RETRY_QUERY = 1; protected const ERR_ABORT_QUERY = 2; protected const ERR_ABORT_TRX = 4; protected const ERR_ABORT_SESSION = 8; protected const DROPPED_CONN_BLAME_THRESHOLD_SEC = 3.0; = private const NOT_APPLICABLE 'n/a'; private const PING_TTL = 1.0; private const PING_QUERY = 'SELECT 1 AS ping'; protected const CONN_HOST = 'host'; protected const CONN_USER = 'user'; protected const CONN_PASSWORD = 'password'; protected const CONN_INITIAL_DB = 'dbname'; protected const CONN_INITIAL_SCHEMA = 'schema'; protected const CONN_INITIAL_TABLE_PREFIX = 'tablePrefix'; protected SQLPlatform $platform; protected ReplicationReporter $replicationReporter; public function __construct( array $params ) { $this->logger = $params['logger'] ?? new NullLogger(); $this-> Wikimedia\Rdbms\Database::transactionManager
protected
Initial value:
= new TransactionManager(
$this->logger,
$params['trxProfiler']
)

TempTableInfo>> Map of (DB name => table name => info)

Definition at line 187 of file Database.php.

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


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