MediaWiki  master
Wikimedia\Rdbms\Database Class Reference

Relational database abstraction object. More...

Inheritance diagram for Wikimedia\Rdbms\Database:
Collaboration diagram for Wikimedia\Rdbms\Database:

Public Member Functions

 __clone ()
 Make sure that copies do not share the same client binding handle. More...
 
 __construct (array $params)
 
 __destruct ()
 Run a few simple sanity checks and close dangling connections. More...
 
 __sleep ()
 Called by serialize. More...
 
 __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. More...
 
 addIdentifierQuotes ( $s)
 Escape a SQL identifier (e.g. More...
 
 addQuotes ( $s)
 Escape and quote a raw value string for use in a SQL query. More...
 
 affectedRows ()
 Get the number of rows affected by the last write query. More...
 
 aggregateValue ( $valuedata, $valuename='value')
 Return aggregated value alias. More...
 
 anyChar ()
 Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More...
 
 anyString ()
 Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More...
 
 assertNoOpenTransactions ()
 Assert that all explicit transactions or atomic sections have been closed. More...
 
 begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
 Begin a transaction. More...
 
 bitAnd ( $fieldLeft, $fieldRight)
 
 bitNot ( $field)
 
 bitOr ( $fieldLeft, $fieldRight)
 
 bufferResults ( $buffer=null)
 Backwards-compatibility no-op method for disabling query buffering. More...
 
 buildConcat ( $stringList)
 Build a concatenation list to feed into a SQL query. More...
 
 buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query. More...
 
 buildIntegerCast ( $field)
 
 buildLike ( $param,... $params)
 
 buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery. More...
 
 buildStringCast ( $field)
 
 buildSubstring ( $input, $startPosition, $length=null)
 
 cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
 Cancel an atomic section of SQL statements. More...
 
 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection. More...
 
 close ( $fname=__METHOD__, $owner=null)
 Close the database connection. More...
 
 commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commits a transaction previously started using begin() More...
 
 conditional ( $cond, $trueVal, $falseVal)
 Returns an SQL expression for a simple conditional. More...
 
 connectionErrorLogger ( $errno, $errstr)
 Error handler for logging errors during database connection This method should not be used outside of Database classes. More...
 
 databasesAreIndependent ()
 Returns true if DBs are assumed to be on potentially different servers. More...
 
 dbSchema ( $schema=null)
 Get/set the db schema. More...
 
 deadlockLoop ()
 Perform a deadlock-prone transaction. More...
 
 decodeBlob ( $b)
 Some DBMSs return a special placeholder object representing blob fields in result objects. More...
 
 decodeExpiry ( $expiry, $format=TS_MW)
 Decode an expiry time into a DBMS independent format. More...
 
 delete ( $table, $conds, $fname=__METHOD__)
 DELETE query wrapper. More...
 
 deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
 DELETE where the condition is a join. More...
 
 doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Perform an atomic section of reversable SQL statements from a callback. More...
 
 dropTable ( $tableName, $fName=__METHOD__)
 Delete a table. More...
 
 duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
 Creates a new table with structure copied from existing table. More...
 
 encodeBlob ( $b)
 Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. More...
 
 encodeExpiry ( $expiry)
 Encode an expiry time into the DBMS dependent format. More...
 
 endAtomic ( $fname=__METHOD__)
 Ends an atomic section of SQL statements. More...
 
 estimateRowCount ( $table, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Estimate the number of rows in dataset. More...
 
 explicitTrxActive ()
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. More...
 
 flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commit any transaction but error out if writes or callbacks are pending. More...
 
 freeResult ( $res)
 Free a result object returned by query() or select() More...
 
 getDBname ()
 Get the current DB name. More...
 
 getDomainID ()
 Return the currently selected domain ID. More...
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is. More...
 
 getLag ()
 Get the amount of replication lag for this database server. More...
 
 getLBInfo ( $name=null)
 Get properties passed down from the server info array of the load balancer. More...
 
 getMasterPos ()
 Get the position of this master. More...
 
 getReplicaPos ()
 Get the replication position of this replica DB. More...
 
 getScopedLockAndFlush ( $lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More...
 
 getServer ()
 Get the server hostname or IP address. More...
 
 getServerInfo ()
 Get a human-readable string describing the current software version. More...
 
 getServerUptime ()
 Determines how long the server has been up. More...
 
 getSessionLagStatus ()
 Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More...
 
 ignoreIndexClause ( $index)
 IGNORE INDEX clause. More...
 
 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. More...
 
 indexExists ( $table, $index, $fname=__METHOD__)
 Determines whether an index exists. More...
 
 indexInfo ( $table, $index, $fname=__METHOD__)
 Get information about an index into an object. More...
 
 indexUnique ( $table, $index)
 Determines if a given index is unique. More...
 
 initConnection ()
 Initialize the connection to the database over the wire (or to local files) More...
 
 insert ( $table, $a, $fname=__METHOD__, $options=[])
 INSERT wrapper, inserts an array into a table. More...
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 INSERT SELECT wrapper. More...
 
 isOpen ()
 
 isQuotedIdentifier ( $name)
 Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers . More...
 
 isReadOnly ()
 
 lastDoneWrites ()
 Get the last time the connection may have been used for a write query. More...
 
 lastQuery ()
 Get the last query that sent on account of IDatabase::query() More...
 
 limitResult ( $sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset. More...
 
 listTables ( $prefix=null, $fname=__METHOD__)
 List all tables on the database. More...
 
 listViews ( $prefix=null, $fname=__METHOD__)
 Lists all the VIEWs in the database. More...
 
 lock ( $lockName, $method, $timeout=5)
 Acquire a named lock. More...
 
 lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Lock all rows meeting the given conditions/options FOR UPDATE. More...
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is not locked by any thread (non-blocking) More...
 
 lockTables (array $read, array $write, $method)
 Lock specific tables. More...
 
 makeList ( $a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array. More...
 
 makeWhereFrom2d ( $data, $baseKey, $subKey)
 Build a partial where clause from a 2-d array such as used for LinkBatch. More...
 
 masterPosWait (DBMasterPos $pos, $timeout)
 Wait for the replica DB to catch up to a given master position. More...
 
 maxListLen ()
 Return the maximum number of items allowed in a list, or 0 for unlimited. More...
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues. More...
 
 nextSequenceValue ( $seqName)
 Deprecated method, calls should be removed. More...
 
 onAtomicSectionCancel (callable $callback, $fname=__METHOD__)
 Run a callback when the atomic section is cancelled. More...
 
 onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback as soon as there is no transaction pending. More...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Alias for onTransactionCommitOrIdle() for backwards-compatibility. More...
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none. More...
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback as soon as the current transaction commits or rolls back. More...
 
 pendingWriteAndCallbackCallers ()
 List the methods that have write queries or callbacks for the current transaction. More...
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction. More...
 
 pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction. More...
 
 pendingWriteRowsAffected ()
 Get the number of affected rows from pending write queries. More...
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection. More...
 
 preCommitCallbacksPending ()
 
 query ( $sql, $fname=__METHOD__, $flags=0)
 Run an SQL query and return the result. More...
 
 replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
 REPLACE query wrapper. More...
 
 reportQueryError ( $error, $errno, $sql, $fname, $ignore=false)
 Report a query error. More...
 
 restoreFlags ( $state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call. More...
 
 rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Rollback a transaction previously started using begin() More...
 
 runOnTransactionIdleCallbacks ( $trigger)
 Actually consume and run any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually consume and run any "on transaction pre-commit" callbacks. More...
 
 runTransactionListenerCallbacks ( $trigger)
 Actually run any "transaction listener" callbacks. More...
 
 select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided. More...
 
 selectDB ( $db)
 Change the current database. More...
 
 selectDomain ( $domain)
 Set the current domain (database, schema, and table prefix) More...
 
 selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a list of single field values from result rows. More...
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Wrapper to IDatabase::select() that only fetches one row (via LIMIT) More...
 
 selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Get the number of rows in dataset. More...
 
 selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Take the same arguments as IDatabase::select() and return the SQL it would use. More...
 
 serverIsReadOnly ()
 
 setBigSelects ( $value=true)
 Allow or deny "big selects" for this session only. More...
 
 setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Set a flag for this connection. More...
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB. More...
 
 setLazyMasterHandle (IDatabase $conn)
 Set a lazy-connecting DB handle to the master DB (for replication status purposes) More...
 
 setLBInfo ( $nameOrArray, $value=null)
 Set the entire array or a particular key of the managing load balancer info array. More...
 
 setLogger (LoggerInterface $logger)
 Set the PSR-3 logger interface to use for query logging. More...
 
 setSchemaVars ( $vars)
 Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS. More...
 
 setSessionOptions (array $options)
 Override database's default behavior. More...
 
 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. More...
 
 setTransactionListener ( $name, callable $callback=null)
 Run a callback after each time any transaction commits or rolls back. More...
 
 setTrxEndCallbackSuppression ( $suppress)
 Whether to disable running of post-COMMIT/ROLLBACK callbacks. More...
 
 sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
 Read and execute SQL commands from a file. More...
 
 sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
 Read and execute commands from an open file handle. More...
 
 startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Begin an atomic section of SQL statements. More...
 
 streamStatementEnd (&$sql, &$newLine)
 Called by sourceStream() to check if we've reached a statement end. More...
 
 strencode ( $s)
 Wrapper for addslashes() More...
 
 strreplace ( $orig, $old, $new)
 Returns a SQL expression for simple string replacement (e.g. More...
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 tableLocksHaveTransactionScope ()
 Checks if table locks acquired by lockTables() are transaction-bound in their scope. More...
 
 tableName ( $name, $format='quoted')
 Format a table name ready for use in constructing an SQL query. More...
 
 tableNames ()
 Fetch a number of table names into an array This is handy when you need to construct SQL for joins. More...
 
 tableNamesN ()
 Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins. More...
 
 tablePrefix ( $prefix=null)
 Get/set the table prefix. More...
 
 textFieldSize ( $table, $field)
 Returns the size of a text field, or -1 for "unlimited". More...
 
 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. More...
 
 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. More...
 
 trxLevel ()
 Gets the current transaction level. More...
 
 trxStatus ()
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established. More...
 
 unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Construct a UNION query for permutations of conditions. More...
 
 unionQueries ( $sqls, $all)
 Construct a UNION query. More...
 
 unionSupportsOrderAndLimit ()
 Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION. More...
 
 unlock ( $lockName, $method)
 Release a lock. More...
 
 unlockTables ( $method)
 Unlock all tables locked via lockTables() More...
 
 update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
 UPDATE wrapper. More...
 
 upsert ( $table, array $rows, $uniqueIndexes, array $set, $fname=__METHOD__)
 INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. More...
 
 useIndexClause ( $index)
 USE INDEX clause. More...
 
 wasConnectionError ( $errno)
 Do not use this method outside of Database/DBError classes. More...
 
 wasConnectionLoss ()
 Determines if the last query error was due to a dropped connection. More...
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock. More...
 
 wasErrorReissuable ()
 Determines if the last query error was due to something outside of the query itself. More...
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout. More...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. More...
 
 writesOrCallbacksPending ()
 Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. More...
 
 writesPending ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\IDatabase
 buildLike ( $param)
 LIKE statement wrapper. More...
 
 buildSubString ( $input, $startPosition, $length=null)
 Build a SUBSTRING function. More...
 
 dataSeek ( $res, $row)
 Change the position of the cursor in a result object. More...
 
 fetchObject ( $res)
 Fetch the next row from the given result object, in object form. More...
 
 fetchRow ( $res)
 Fetch the next row from the given result object, in associative array form. More...
 
 fieldName ( $res, $n)
 Get a field name in a result object. More...
 
 getServerVersion ()
 A string describing the current software version, like from mysql_get_server_info() More...
 
 getSoftwareLink ()
 Returns a wikitext style link to the DB's website (e.g. More...
 
 getType ()
 Get the type of the DBMS (e.g. More...
 
 insertId ()
 Get the inserted value of an auto-increment row. More...
 
 lastErrno ()
 Get the last error number. More...
 
 lastError ()
 Get a description of the last error. More...
 
 numFields ( $res)
 Get the number of fields in a result object. More...
 
 numRows ( $res)
 Get the number of rows in a query result. More...
 
- Public Member Functions inherited from Wikimedia\Rdbms\IMaintainableDatabase
 fieldInfo ( $table, $field)
 mysql_fetch_field() wrapper Returns false if the field doesn't exist More...
 

Static Public Member Functions

static attributesFromType ( $dbType, $driver=null)
 
static factory ( $type, $params=[], $connect=self::NEW_CONNECTED)
 Construct a Database subclass instance given a database type and parameters. More...
 
static getCacheSetOptions (IDatabase $db1, IDatabase $db2=null)
 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. More...
 

Protected Member Functions

 assertBuildSubstringParams ( $startPosition, $length)
 Check type and bounds for parameters to self::buildSubstring() More...
 
 assertHasConnectionHandle ()
 Make sure there is an open connection handle (alive or not) as a sanity check. More...
 
 assertIsWritableMaster ()
 Make sure that this server is not marked as a replica nor read-only as a sanity check. More...
 
 closeConnection ()
 Closes underlying database connection. More...
 
 doBegin ( $fname)
 Issues the BEGIN command to the database server. More...
 
 doCommit ( $fname)
 Issues the COMMIT command to the database server. More...
 
 doGetLag ()
 
 doHandleSessionLossPreconnect ()
 Reset any additional subclass trx* and session* fields. More...
 
 doInitConnection ()
 Actually connect to the database over the wire (or to local files) More...
 
 doLockTables (array $read, array $write, $method)
 Helper function for lockTables() that handles the actual table locking. More...
 
 doQuery ( $sql)
 Run a query and return a DBMS-dependent wrapper or boolean. More...
 
 doReleaseSavepoint ( $identifier, $fname)
 Release a savepoint. More...
 
 doRollback ( $fname)
 Issues the ROLLBACK command to the database server. More...
 
 doRollbackToSavepoint ( $identifier, $fname)
 Rollback to a savepoint. More...
 
 doSavepoint ( $identifier, $fname)
 Create a savepoint. More...
 
 doSelectDomain (DatabaseDomain $domain)
 
 doUnlockTables ( $method)
 Helper function for unlockTables() that handles the actual table unlocking. More...
 
 escapeLikeInternal ( $s, $escapeChar='`')
 
 executeQuery ( $sql, $fname, $flags)
 Execute a query, retrying it if there is a recoverable connection loss. More...
 
 extractSingleFieldFromList ( $var)
 
 fetchAffectedRowCount ()
 
 fieldHasBit ( $field, $flags)
 
 fieldNamesWithAlias ( $fields)
 Gets an array of aliased field names. More...
 
 fieldNameWithAlias ( $name, $alias=false)
 Get an aliased field name e.g. More...
 
 getApproximateLagStatus ()
 Get a replica DB lag estimate for this server. More...
 
 getBindingHandle ()
 Get the underlying binding connection handle. More...
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars(). More...
 
 getLastPHPError ()
 
 getLazyMasterHandle ()
 
 getLogContext (array $extras=[])
 Create a log context to pass to PSR-3 logger functions. More...
 
 getQueryVerb ( $sql)
 
 getReadOnlyReason ()
 
 getRecordedTransactionLagStatus ()
 Get the replica DB lag when the current transaction started. More...
 
 getSchemaVars ()
 Get schema variables. More...
 
 getTempWrites ( $sql, $pseudoPermanent)
 
 getTransactionRoundId ()
 
 indexName ( $index)
 Allows for index remapping in queries where this is not consistent across DBMS. More...
 
 installErrorHandler ()
 Set a custom error handler for logging errors during database connection. More...
 
 isInsertSelectSafe (array $insertOptions, array $selectOptions)
 
 isTransactableQuery ( $sql)
 Determine whether a SQL statement is sensitive to isolation level. More...
 
 isWriteQuery ( $sql)
 Determine whether a query writes to the DB. More...
 
 makeGroupByWithHaving ( $options)
 Returns an optional GROUP BY with an optional HAVING. More...
 
 makeInsertOptions ( $options)
 Helper for Database::insert(). More...
 
 makeOrderBy ( $options)
 Returns an optional ORDER BY. More...
 
 makeSelectOptions (array $options)
 Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. More...
 
 makeUpdateOptions ( $options)
 Make UPDATE options for the Database::update function. More...
 
 makeUpdateOptionsArray ( $options)
 Make UPDATE options array for Database::makeUpdateOptions. More...
 
 nativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory. More...
 
 nativeReplace ( $table, $rows, $fname)
 REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More...
 
 newExceptionAfterConnectError ( $error)
 
 nonNativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 Implementation of insertSelect() based on select() and insert() More...
 
 normalizeConditions ( $conds, $fname)
 
 open ( $server, $user, $password, $dbName, $schema, $tablePrefix)
 Open a new connection to the database (closing any existing one) More...
 
 qualifiedTableComponents ( $name)
 Get the table components needed for a query given the currently selected database. More...
 
 registerTempWrites ( $ret, $tmpType, $tmpNew, $tmpDel)
 
 relationSchemaQualifier ()
 
 replaceLostConnection ( $fname)
 Close any existing (dead) database connection and open a new connection. More...
 
 replaceVars ( $ins)
 Database independent variable replacement. More...
 
 restoreErrorHandler ()
 Restore the previous error handler and return the last PHP error for this DB. More...
 
 resultObject ( $result)
 Take a query result and wrap it in an iterable result wrapper if necessary. More...
 
 tableNamesWithAlias ( $tables)
 Gets an array of aliased table names. More...
 
 tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[])
 Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause. More...
 
 tableNameWithAlias ( $table, $alias=false)
 Get an aliased table name. More...
 
 wasKnownStatementRollbackError ()
 
 wasQueryTimeout ( $error, $errno)
 Checks whether the cause of the error is detected to be a timeout. More...
 

Static Protected Member Functions

static getAttributes ()
 

Protected Attributes

integer null $affectedRowCount
 Rows affected by the last query to query() or its CRUD wrappers. More...
 
string $agent
 Agent name for query profiling. More...
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
object resource null $conn
 Database connection. More...
 
array $connectionParams
 Parameters used by initConnection() to establish a connection. More...
 
string [] int [] float [] $connectionVariables
 SQL variables values to use for all new connections. More...
 
LoggerInterface $connLogger
 
DatabaseDomain $currentDomain
 
string $delimiter = ';'
 Current SQL query delimiter. More...
 
callable $deprecationLogger
 Deprecation logging callback. More...
 
callable $errorLogger
 Error logging callback. More...
 
int $flags
 Current bit field of class DBO_* constants. More...
 
string [] $indexAliases = []
 Current map of (index alias => index) More...
 
array $lbInfo = []
 Current LoadBalancer tracking information. More...
 
int $nonNativeInsertSelectBatchSize
 Row batch size to use for emulated INSERT SELECT queries. More...
 
string $password
 Password used to establish the current connection. More...
 
callable null $profiler
 
LoggerInterface $queryLogger
 
array null $schemaVars
 Current variables use for schema element placeholders. More...
 
string $server
 Server that this instance is currently connected to. More...
 
array $sessionNamedLocks = []
 Map of (name => 1) for locks obtained via lock() More...
 
array $sessionTempTables = []
 Map of (table name => 1) for TEMPORARY tables. More...
 
BagOStuff $srvCache
 APC cache. More...
 
array [] $tableAliases = []
 Current map of (table => (dbname, schema, prefix) map) More...
 
TransactionProfiler $trxProfiler
 
string $user
 User that this instance is currently connected under the name of. More...
 

Static Protected Attributes

static int $DBO_MUTABLE
 Bit field of all DBO_* flags that can be changed after connection. More...
 
static string [] $MUTABLE_FLAGS
 List of DBO_* flags that can be changed after connection. More...
 

Private Member Functions

 assertQueryIsCurrentlyAllowed ( $sql, $fname)
 Error out if the DB is not in a valid state for a query via query() More...
 
 beginIfImplied ( $sql, $fname)
 Start an implicit transaction if DBO_TRX is enabled and no transaction is active. More...
 
 canRecoverFromDisconnect ( $sql, $priorWritesPending)
 Determine whether it is safe to retry queries after a database connection is lost. More...
 
 consumeTrxShortId ()
 Reset the transaction ID and return the old one. More...
 
 currentAtomicSectionId ()
 
 executeQueryAttempt ( $sql, $commentedSql, $isPermWrite, $fname, $flags)
 Wrapper for doQuery() that handles DBO_TRX, profiling, logging, affected row count tracking, and reconnects (without retry) on query failure due to connection loss. More...
 
 flatAtomicSectionList ()
 
 getQueryExceptionAndLog ( $error, $errno, $sql, $fname)
 
 handleSessionLossPostconnect ()
 Clean things up after session (and thus transaction) loss after reconnect. More...
 
 handleSessionLossPreconnect ()
 Clean things up after session (and thus transaction) loss before reconnect. More...
 
 modifyCallbacksForCancel (array $sectionIds, AtomicSectionIdentifier $newSectionId=null)
 Update callbacks that were owned by cancelled atomic sections. More...
 
 nextSavepointId ( $fname)
 
 pingAndCalculateLastTrxApplyTime ()
 
 prependDatabaseOrSchema ( $namespace, $relation, $format)
 
 reassignCallbacksForSection (AtomicSectionIdentifier $old, AtomicSectionIdentifier $new)
 Hoist callback ownership for callbacks in a section to a parent section. More...
 
 runOnAtomicSectionCancelCallbacks ( $trigger, array $sectionIds=null)
 Actually run any "atomic section cancel" callbacks. More...
 
 selectFieldsOrOptionsAggregate ( $fields, $options)
 
 selectOptionsIncludeLocking ( $options)
 
 updateTrxWriteQueryTime ( $sql, $runtime, $affected)
 Update the estimated run-time of a query, not counting large row lock times. More...
 

Static Private Member Functions

static getClass ( $dbType, $driver=null)
 

Private Attributes

string bool null $htmlErrors
 Stashed value of html_errors INI setting. More...
 
string bool $lastPhpError = false
 
float $lastPing = 0.0
 UNIX timestamp. More...
 
string $lastQuery = ''
 The last SQL query attempted. More...
 
float $lastRoundTripEstimate = 0.0
 Query rount trip time estimate. More...
 
float bool $lastWriteTime = false
 UNIX timestamp of last write query. More...
 
IDatabase null $lazyMasterHandle
 Lazy handle to the master DB this server replicates from. More...
 
int null $ownerId
 Integer ID of the managing LBFactory instance or null if none. More...
 
int [] $priorFlags = []
 Prior flags member variable values. More...
 
int $trxAtomicCounter = 0
 Counter for atomic savepoint identifiers (reset with each transaction) More...
 
array $trxAtomicLevels = []
 List of (name, unique ID, savepoint ID) for each active atomic section level. More...
 
bool $trxAutomatic = false
 Whether the current transaction was started implicitly due to DBO_TRX. More...
 
bool $trxAutomaticAtomic = false
 Whether the current transaction was started implicitly by startAtomic() More...
 
bool $trxDoneWrites = false
 Whether possible write queries were done in the last transaction started. More...
 
array [] $trxEndCallbacks = []
 List of (callable, method name, atomic section id) More...
 
bool $trxEndCallbacksSuppressed = false
 Whether to suppress triggering of transaction end callbacks. More...
 
string $trxFname = null
 Name of the function that start the last transaction. More...
 
array [] $trxIdleCallbacks = []
 List of (callable, method name, atomic section id) More...
 
array [] $trxPreCommitCallbacks = []
 List of (callable, method name, atomic section id) More...
 
callable [] $trxRecurringCallbacks = []
 Map of (name => callable) More...
 
float $trxReplicaLag = null
 Replication lag estimate at the time of BEGIN for the last transaction. More...
 
array [] $trxSectionCancelCallbacks = []
 List of (callable, method name, atomic section id) More...
 
string $trxShortId = ''
 ID of the active transaction or the empty string otherwise. More...
 
int $trxStatus = self::STATUS_TRX_NONE
 Transaction status. More...
 
Exception null $trxStatusCause
 The last error that caused the status to become STATUS_TRX_ERROR. More...
 
array null $trxStatusIgnoredCause
 Error details of the last statement-only rollback. More...
 
float null $trxTimestamp = null
 UNIX timestamp at the time of BEGIN for the last transaction. More...
 
float $trxWriteAdjDuration = 0.0
 Like trxWriteQueryCount but excludes lock-bound, easy to replicate, queries. More...
 
int $trxWriteAdjQueryCount = 0
 Number of write queries counted in trxWriteAdjDuration. More...
 
int $trxWriteAffectedRows = 0
 Number of rows affected by write queries for the current transaction. More...
 
string [] $trxWriteCallers = []
 Write query callers of the current transaction. More...
 
float $trxWriteDuration = 0.0
 Seconds spent in write queries for the current transaction. More...
 
int $trxWriteQueryCount = 0
 Number of write queries for the current transaction. More...
 

Static Private Attributes

static int $DEADLOCK_DELAY_MAX = 1500000
 Maximum time to wait before retry. More...
 
static int $DEADLOCK_DELAY_MIN = 500000
 Minimum time to wait before retry, in microseconds. More...
 
static int $DEADLOCK_TRIES = 4
 Number of times to re-try an operation in case of deadlock. More...
 
static string $NOT_APPLICABLE = 'n/a'
 Idiom used when a cancelable atomic section started the transaction. More...
 
static string $PING_QUERY = 'SELECT 1 AS ping'
 Dummy SQL query. More...
 
static int $PING_TTL = 1.0
 How long before it is worth doing a dummy query to test the connection. More...
 
static string $SAVEPOINT_PREFIX = 'wikimedia_rdbms_atomic'
 Prefix to the atomic section counter used to make savepoint IDs. More...
 
static float $SLOW_WRITE_SEC = 0.500
 Consider a write slow if it took more than this many seconds. More...
 
static float $SMALL_WRITE_ROWS = 100
 Assume an insert of this many rows or less should be fast to replicate. More...
 
static int $TEMP_NORMAL = 1
 Writes to this temporary table do not affect lastDoneWrites() More...
 
static int $TEMP_PSEUDO_PERMANENT = 2
 Writes to this temporary table effect lastDoneWrites() More...
 
static float $TINY_WRITE_SEC = 0.010
 Guess of how many seconds it takes to replicate a small insert. More...
 

Detailed Description

Relational database abstraction object.

Since
1.28

Definition at line 49 of file Database.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\Database::__construct ( array  $params)
Note
exceptions for missing libraries/drivers should be thrown in initConnection()
Parameters
array$paramsParameters passed from Database::factory()

Definition at line 242 of file Database.php.

References DBO_DEFAULT, and DBO_TRX.

◆ __destruct()

Wikimedia\Rdbms\Database::__destruct ( )

Run a few simple sanity checks and close dangling connections.

Definition at line 4916 of file Database.php.

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

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

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

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

Definition at line 4908 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\IDatabase.

Definition at line 4855 of file Database.php.

References Wikimedia\Rdbms\IDatabase\getType().

◆ addIdentifierQuotes()

◆ addQuotes()

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

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

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2729 of file Database.php.

References $s, and Wikimedia\Rdbms\Database\strencode().

Referenced by Wikimedia\Rdbms\Database\buildGroupConcatField(), Wikimedia\Rdbms\Database\buildLike(), Wikimedia\Rdbms\Database\makeList(), and Wikimedia\Rdbms\Database\replaceVars().

◆ affectedRows()

Wikimedia\Rdbms\Database::affectedRows ( )

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

Similar to https://www.php.net/mysql_affected_rows but includes rows matched but not changed (ie. an UPDATE which sets all fields to the same value they already have). To get the old mysql_affected_rows behavior, include non-equality of the fields in WHERE.

Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4249 of file Database.php.

References Wikimedia\Rdbms\Database\$affectedRowCount, and Wikimedia\Rdbms\Database\fetchAffectedRowCount().

Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\DatabaseSqlite\insert(), Wikimedia\Rdbms\Database\nonNativeInsertSelect(), Wikimedia\Rdbms\DatabaseSqlite\replace(), Wikimedia\Rdbms\Database\replace(), Wikimedia\Rdbms\Database\updateTrxWriteQueryTime(), and Wikimedia\Rdbms\Database\upsert().

◆ aggregateValue()

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

Return aggregated value alias.

Parameters
array$valuedata
string$valuename
Returns
array|string
Deprecated:
Since 1.33

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2289 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\IDatabase.

Definition at line 2801 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\IDatabase.

Definition at line 2805 of file Database.php.

◆ assertBuildSubstringParams()

Wikimedia\Rdbms\Database::assertBuildSubstringParams (   $startPosition,
  $length 
)
protected

Check type and bounds for parameters to self::buildSubstring()

All supported databases have substring functions that behave the same for positive $startPosition and non-negative $length, but behaviors differ when given 0 or negative $startPosition or negative $length. The simplest solution to that is to just forbid those values.

Parameters
int$startPosition
int | null$length
Since
1.31

Definition at line 2338 of file Database.php.

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

◆ assertHasConnectionHandle()

Wikimedia\Rdbms\Database::assertHasConnectionHandle ( )
finalprotected

Make sure there is an open connection handle (alive or not) as a sanity check.

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

References Wikimedia\Rdbms\Database\isOpen().

Referenced by Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\DatabaseSqlite\serverIsReadOnly().

◆ assertIsWritableMaster()

Wikimedia\Rdbms\Database::assertIsWritableMaster ( )
protected

Make sure that this server is not marked as a replica nor read-only as a sanity check.

Exceptions
DBReadOnlyRoleError
DBReadOnlyError

Definition at line 966 of file Database.php.

References Wikimedia\Rdbms\Database\closeConnection(), Wikimedia\Rdbms\Database\doQuery(), Wikimedia\Rdbms\Database\getLBInfo(), and Wikimedia\Rdbms\Database\getReadOnlyReason().

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

◆ assertNoOpenTransactions()

Wikimedia\Rdbms\Database::assertNoOpenTransactions ( )

Assert that all explicit transactions or atomic sections have been closed.

Exceptions
DBTransactionError
Since
1.32

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1435 of file Database.php.

References Wikimedia\Rdbms\Database\explicitTrxActive(), and Wikimedia\Rdbms\Database\flatAtomicSectionList().

◆ assertQueryIsCurrentlyAllowed()

Wikimedia\Rdbms\Database::assertQueryIsCurrentlyAllowed (   $sql,
  $fname 
)
private

Error out if the DB is not in a valid state for a query via query()

Parameters
string$sql
string$fname
Exceptions
DBTransactionStateError

Definition at line 1408 of file Database.php.

References Wikimedia\Rdbms\Database\$trxStatusIgnoredCause, Wikimedia\Rdbms\Database\getQueryVerb(), and Wikimedia\Rdbms\Database\trxStatus().

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

◆ attributesFromType()

static Wikimedia\Rdbms\Database::attributesFromType (   $dbType,
  $driver = null 
)
staticfinal
Parameters
string$dbTypeA possible DB type (sqlite, mysql, postgres,...)
string | null$driverOptional name of a specific DB client driver
Returns
array Map of (Database::ATTR_* constant => value) for all such constants
Exceptions
InvalidArgumentException
Since
1.31

Definition at line 433 of file Database.php.

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

◆ begin()

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

Begin a transaction.

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

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

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

Parameters
string$fnameCalling function name
string$modeA situationally valid IDatabase::TRANSACTION_* constant [optional]
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3976 of file Database.php.

References Wikimedia\Rdbms\Database\assertHasConnectionHandle(), DBO_TRX, Wikimedia\Rdbms\Database\doBegin(), Wikimedia\Rdbms\Database\flatAtomicSectionList(), Wikimedia\Rdbms\Database\getApproximateLagStatus(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\trxLevel(), Wikimedia\Rdbms\Database\trxStatus(), and Wikimedia\Rdbms\Database\trxTimestamp().

Referenced by Wikimedia\Rdbms\Database\beginIfImplied(), Wikimedia\Rdbms\Database\deadlockLoop(), Wikimedia\Rdbms\Database\onTransactionCommitOrIdle(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), and Wikimedia\Rdbms\Database\startAtomic().

◆ beginIfImplied()

Wikimedia\Rdbms\Database::beginIfImplied (   $sql,
  $fname 
)
private

Start an implicit transaction if DBO_TRX is enabled and no transaction is active.

Parameters
string$sql
string$fname

Definition at line 1356 of file Database.php.

References Wikimedia\Rdbms\Database\begin(), DBO_TRX, Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\isTransactableQuery(), and Wikimedia\Rdbms\Database\trxLevel().

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

◆ bitAnd()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2297 of file Database.php.

◆ bitNot()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2293 of file Database.php.

◆ bitOr()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2301 of file Database.php.

◆ bufferResults()

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

Backwards-compatibility no-op method for disabling query buffering.

Parameters
null | bool$bufferWhether to buffer queries (ignored)
Returns
bool Whether buffering was already enabled (always true)
Deprecated:
Since 1.34 Use query batching; this no longer does anything

Definition at line 527 of file Database.php.

◆ buildConcat()

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

Build a concatenation list to feed into a SQL query.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2305 of file Database.php.

◆ buildGroupConcatField()

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

Build a GROUP_CONCAT or equivalent statement for a query.

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

Parameters
string$delimGlue to bind the results together
string | array$tableTable name
string$fieldField name
string | array$condsConditions
string | array$join_condsJoin conditions
Returns
string SQL text
Since
1.23

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2309 of file Database.php.

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

◆ buildIntegerCast()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2357 of file Database.php.

◆ buildLike()

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

◆ buildSelectSubquery()

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

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

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2361 of file Database.php.

References Wikimedia\Rdbms\Database\selectSQLText().

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

◆ buildStringCast()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2351 of file Database.php.

◆ buildSubstring()

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

◆ 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 a micro-optimization to save a few DB calls, this method may only be called when startAtomic() was called with the ATOMIC_CANCELABLE flag.
Since
1.31
See also
IDatabase::startAtomic
Parameters
string$fname
AtomicSectionIdentifier | null$sectionIdSection ID from startAtomic(); passing this enables cancellation of unclosed nested sections [optional]
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3875 of file Database.php.

References Wikimedia\Rdbms\Database\currentAtomicSectionId(), Wikimedia\Rdbms\Database\doRollbackToSavepoint(), Wikimedia\Rdbms\Database\modifyCallbacksForCancel(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\runOnAtomicSectionCancelCallbacks(), Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\trxStatus().

Referenced by Wikimedia\Rdbms\Database\doAtomicSection(), Wikimedia\Rdbms\DatabasePostgres\insert(), Wikimedia\Rdbms\DatabaseSqlite\insert(), Wikimedia\Rdbms\Database\nonNativeInsertSelect(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), Wikimedia\Rdbms\DatabaseSqlite\replace(), Wikimedia\Rdbms\Database\replace(), and Wikimedia\Rdbms\Database\upsert().

◆ canRecoverFromDisconnect()

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

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

Parameters
string$sqlSQL query
bool$priorWritesPendingWhether there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish.
Returns
bool True if it is safe to retry the query, false otherwise

Definition at line 1454 of file Database.php.

References Wikimedia\Rdbms\Database\explicitTrxActive().

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

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

Definition at line 758 of file Database.php.

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

◆ close()

Wikimedia\Rdbms\Database::close (   $fname = __METHOD__,
  $owner = null 
)
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.

Parameters
string$fnameCaller name
int | null$ownerID of the calling instance (e.g. the LBFactory ID)
Returns
bool Success
Exceptions
DBError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 876 of file Database.php.

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

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

◆ closeConnection()

Wikimedia\Rdbms\Database::closeConnection ( )
abstractprotected

Closes underlying database connection.

Since
1.20
Returns
bool Whether connection was closed successfully

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

◆ 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 transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.

Parameters
string$fname
string$flushFlush flag, set to situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly committing implicit transactions, or calling commit when no transaction is in progress. This will trigger an exception if there is an ongoing explicit transaction. Only set the flush flag if you are sure that these warnings are not applicable, and no explicit transactions are open.
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4039 of file Database.php.

References Wikimedia\Rdbms\Database\assertHasConnectionHandle(), Wikimedia\Rdbms\Database\consumeTrxShortId(), Wikimedia\Rdbms\Database\doCommit(), Wikimedia\Rdbms\Database\flatAtomicSectionList(), Wikimedia\Rdbms\Database\getDomainID(), Wikimedia\Rdbms\Database\pendingWriteQueryDuration(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), Wikimedia\Rdbms\Database\runOnTransactionPreCommitCallbacks(), Wikimedia\Rdbms\Database\runTransactionListenerCallbacks(), Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\trxStatus().

Referenced by Wikimedia\Rdbms\Database\deadlockLoop(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\flushSnapshot(), Wikimedia\Rdbms\Database\getScopedLockAndFlush(), and Wikimedia\Rdbms\LoadBalancer\runMasterTransactionIdleCallbacks().

◆ conditional()

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

Returns an SQL expression for a simple conditional.

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

Parameters
string | array$condSQL expression which will result in a boolean value
string$trueValSQL expression to return if true
string$falseValSQL expression to return if false
Returns
string SQL fragment

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3285 of file Database.php.

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

◆ connectionErrorLogger()

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

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

Parameters
int$errno
string$errstr

Definition at line 855 of file Database.php.

◆ consumeTrxShortId()

Wikimedia\Rdbms\Database::consumeTrxShortId ( )
private

Reset the transaction ID and return the old one.

Returns
string The old transaction ID or the empty string if there wasn't one

Definition at line 1537 of file Database.php.

References Wikimedia\Rdbms\Database\$trxShortId.

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

◆ currentAtomicSectionId()

◆ databasesAreIndependent()

Wikimedia\Rdbms\Database::databasesAreIndependent ( )

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

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

Returns
bool
Since
1.29

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2370 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\IDatabase.

Definition at line 560 of file Database.php.

References Wikimedia\Rdbms\Database\getDBname().

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

◆ deadlockLoop()

Wikimedia\Rdbms\Database::deadlockLoop ( )

Perform a deadlock-prone transaction.

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

Avoid using this method outside of Job or Maintenance classes.

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

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

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

Returns
mixed
Exceptions
DBUnexpectedError
Exception

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 3345 of file Database.php.

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

◆ decodeBlob()

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

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

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

Parameters
string | Blob$b
Returns
string
Exceptions
DBError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4442 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\IDatabase.

Definition at line 4785 of file Database.php.

References Wikimedia\Rdbms\Database\getInfinity().

◆ delete()

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

DELETE query wrapper.

Parameters
string$tableTable name
string | array$condsArray of conditions. See $conds in IDatabase::select() for the format. Use $conds == "*" to delete all rows
string$fnameName of the calling function
Returns
bool Return true if no exception was thrown (deprecated since 1.33)
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3011 of file Database.php.

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

◆ deleteJoin()

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

DELETE where the condition is a join.

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

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

DO NOT put the join condition in $conds.

Parameters
string$delTableThe table to delete from.
string$joinTableThe other table.
string$delVarThe variable to join on, in the first table.
string$joinVarThe variable to join on, in the second table.
array | string$condsCondition 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 IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2976 of file Database.php.

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

◆ doAtomicSection()

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

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

The $callback takes the following arguments:

  • This database object
  • The value of $fname

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

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

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

Example usage, "RecordStore::save" method:

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

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

$dbw->startAtomic( __METHOD__ );
// ...various SQL writes happen...
try {
$recordStore->save( $record );
} catch ( StoreFailureException $e ) {
// ...various SQL writes happen...
}
// ...various SQL writes happen...
$dbw->endAtomic( __METHOD__ );
See also
Database::startAtomic
Database::endAtomic
Database::cancelAtomic
Parameters
string$fnameCaller name (usually METHOD)
callable$callbackCallback that issues DB updates
string$cancelablePass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section.
Returns
mixed $res Result of the callback (since 1.28)
Exceptions
DBErrorIf an error occurs, see IDatabase::query()
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 3960 of file Database.php.

References $res, Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), and Wikimedia\Rdbms\Database\startAtomic().

◆ doBegin()

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

Issues the BEGIN command to the database server.

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

Definition at line 4035 of file Database.php.

References Wikimedia\Rdbms\Database\query().

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

◆ doCommit()

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

Issues the COMMIT command to the database server.

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

Definition at line 4108 of file Database.php.

References Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\trxLevel().

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

◆ doGetLag()

Wikimedia\Rdbms\Database::doGetLag ( )
protected

Definition at line 4430 of file Database.php.

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

◆ doHandleSessionLossPreconnect()

Wikimedia\Rdbms\Database::doHandleSessionLossPreconnect ( )
protected

Reset any additional subclass trx* and session* fields.

Definition at line 1509 of file Database.php.

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

◆ doInitConnection()

Wikimedia\Rdbms\Database::doInitConnection ( )
protected

Actually connect to the database over the wire (or to local files)

Exceptions
DBConnectionError
Since
1.31

Definition at line 300 of file Database.php.

References Wikimedia\Rdbms\Database\open().

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

◆ doLockTables()

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

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

Parameters
array$readArray of tables to lock for read access
array$writeArray of tables to lock for write access
string$methodName of caller
Returns
true

Definition at line 4735 of file Database.php.

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

◆ doQuery()

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

Run a query and return a DBMS-dependent wrapper or boolean.

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, occured 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 occured during that public query method call.

For SELECT queries, this returns either:

  • a) A driver-specific value/resource, only on success. This can be iterated over by calling fetchObject()/fetchRow() until there are no more rows. Alternatively, the result can be passed to resultObject() to obtain an IResultWrapper instance which can then be iterated over via "foreach".
  • b) False, on any query failure

For non-SELECT queries, this returns either:

  • a) A driver-specific value/resource, only on success
  • b) True, only on success (e.g. no meaningful result other than "OK")
  • c) False, on any query failure
Parameters
string$sqlSQL query
Returns
mixed|bool An object, resource, or true on success; false on failure

Referenced by Wikimedia\Rdbms\Database\assertIsWritableMaster(), and Wikimedia\Rdbms\Database\executeQueryAttempt().

◆ doReleaseSavepoint()

Wikimedia\Rdbms\Database::doReleaseSavepoint (   $identifier,
  $fname 
)
protected

Release a savepoint.

This is used internally to implement atomic sections. It should not be used otherwise.

Since
1.31
Parameters
string$identifierIdentifier for the savepoint
string$fnameCalling function name

Definition at line 3774 of file Database.php.

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

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

◆ doRollback()

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

Issues the ROLLBACK command to the database server.

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

Definition at line 4177 of file Database.php.

References Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\trxLevel().

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

◆ doRollbackToSavepoint()

Wikimedia\Rdbms\Database::doRollbackToSavepoint (   $identifier,
  $fname 
)
protected

Rollback to a savepoint.

This is used internally to implement atomic sections. It should not be used otherwise.

Since
1.31
Parameters
string$identifierIdentifier for the savepoint
string$fnameCalling function name

Definition at line 3788 of file Database.php.

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

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

◆ doSavepoint()

Wikimedia\Rdbms\Database::doSavepoint (   $identifier,
  $fname 
)
protected

Create a savepoint.

This is used internally to implement atomic sections. It should not be used otherwise.

Since
1.31
Parameters
string$identifierIdentifier for the savepoint
string$fnameCalling function name

Definition at line 3760 of file Database.php.

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

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

◆ doSelectDomain()

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

Definition at line 2394 of file Database.php.

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

◆ doUnlockTables()

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

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

Parameters
string$methodName of caller
Returns
true

Definition at line 4755 of file Database.php.

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

◆ dropTable()

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

Delete a table.

Parameters
string$tableName
string$fName
Returns
bool|IResultWrapper
Since
1.18

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 4766 of file Database.php.

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

◆ duplicateTableStructure()

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

Creates a new table with structure copied from existing table.

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

Parameters
string$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.

Definition at line 4221 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\IDatabase.

Definition at line 4438 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\IDatabase.

Definition at line 4779 of file Database.php.

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

◆ endAtomic()

◆ escapeLikeInternal()

Wikimedia\Rdbms\Database::escapeLikeInternal (   $s,
  $escapeChar = '`' 
)
protected
Parameters
string$s
string$escapeChar
Returns
string

Definition at line 2768 of file Database.php.

References $s.

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

◆ estimateRowCount()

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

Estimate the number of rows in dataset.

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

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

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

Parameters
string$tableTable name
string$varColumn for which NULL values are not counted [default "*"]
array | string$condsFilters on the table
string$fnameFunction name for profiling
array$optionsOptions for select
array | string$join_condsJoin conditions
Returns
int Row count
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1910 of file Database.php.

References $res, Wikimedia\Rdbms\Database\extractSingleFieldFromList(), Wikimedia\Rdbms\IDatabase\fetchRow(), Wikimedia\Rdbms\Database\normalizeConditions(), and Wikimedia\Rdbms\Database\select().

◆ executeQuery()

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

Execute a query, retrying it if there is a recoverable connection loss.

This is similar to query() except:

  • It does not prevent all non-ROLLBACK queries if there is a corrupted transaction
  • It does not disallow raw queries that are supposed to use dedicated IDatabase methods
  • It does not throw exceptions for common error cases

This is meant for internal use with Database subclasses.

Parameters
string$sqlOriginal SQL query
string$fnameName of the calling function
int$flagsBit field of class QUERY_* constants
Returns
array An n-tuple of:
  • mixed|bool: An object, resource, or true on success; false on failure
  • string: The result of calling lastError()
  • int: The result of calling lastErrno()
  • bool: Whether a rollback is needed to allow future non-rollback queries
Exceptions
DBUnexpectedError

Definition at line 1178 of file Database.php.

References Wikimedia\Rdbms\Database\assertHasConnectionHandle(), Wikimedia\Rdbms\Database\assertIsWritableMaster(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\fieldHasBit(), Wikimedia\Rdbms\Database\getQueryExceptionAndLog(), Wikimedia\Rdbms\Database\getTempWrites(), Wikimedia\Rdbms\Database\isWriteQuery(), Wikimedia\Rdbms\Database\registerTempWrites(), Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\trxStatus().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\doSelectDomain(), Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait(), and Wikimedia\Rdbms\Database\query().

◆ executeQueryAttempt()

Wikimedia\Rdbms\Database::executeQueryAttempt (   $sql,
  $commentedSql,
  $isPermWrite,
  $fname,
  $flags 
)
private

Wrapper for doQuery() that handles DBO_TRX, profiling, logging, affected row count tracking, and reconnects (without retry) on query failure due to connection loss.

Parameters
string$sqlOriginal SQL query
string$commentedSqlSQL query with debugging/trace comment
bool$isPermWriteWhether the query is a (non-temporary table) write
string$fnameName of the calling function
int$flagsBit field of class QUERY_* constants
Returns
array An n-tuple of:
  • mixed|bool: An object, resource, or true on success; false on failure
  • string: The result of calling lastError()
  • int: The result of calling lastErrno()
    • bool: Whether a statement rollback error occured
  • bool: Whether a disconnect both happened and was recoverable
  • bool: Whether a reconnection attempt was both made and succeeded
Exceptions
DBUnexpectedError

Definition at line 1269 of file Database.php.

References Wikimedia\Rdbms\Database\$profiler, Wikimedia\Rdbms\Database\affectedRows(), Wikimedia\Rdbms\Database\beginIfImplied(), Wikimedia\Rdbms\Database\canRecoverFromDisconnect(), DBO_DEBUG, Wikimedia\Rdbms\Database\doQuery(), Wikimedia\Rdbms\Database\getDomainID(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\getLBInfo(), Wikimedia\Rdbms\Database\getServer(), Wikimedia\Rdbms\IDatabase\lastErrno(), Wikimedia\Rdbms\IDatabase\lastError(), Wikimedia\Rdbms\Database\lastQuery(), Wikimedia\Rdbms\IDatabase\numRows(), Wikimedia\Rdbms\Database\replaceLostConnection(), Wikimedia\Rdbms\Database\trxLevel(), Wikimedia\Rdbms\Database\updateTrxWriteQueryTime(), Wikimedia\Rdbms\Database\wasConnectionError(), Wikimedia\Rdbms\Database\wasKnownStatementRollbackError(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().

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

◆ explicitTrxActive()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4217 of file Database.php.

References Wikimedia\Rdbms\Database\$trxAutomatic, and Wikimedia\Rdbms\Database\trxLevel().

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

◆ extractSingleFieldFromList()

Wikimedia\Rdbms\Database::extractSingleFieldFromList (   $var)
finalprotected
Parameters
array | string$varField parameter in the style of select()
Returns
string|null Column name or null; ignores aliases
Exceptions
DBUnexpectedErrorErrors out if multiple columns are given

Definition at line 2027 of file Database.php.

Referenced by Wikimedia\Rdbms\DatabasePostgres\estimateRowCount(), Wikimedia\Rdbms\DatabaseMysqlBase\estimateRowCount(), Wikimedia\Rdbms\Database\estimateRowCount(), and Wikimedia\Rdbms\Database\selectRowCount().

◆ factory()

static Wikimedia\Rdbms\Database::factory (   $type,
  $params = [],
  $connect = self::NEW_CONNECTED 
)
staticfinal

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

This also connects to the database immediately upon object construction

Parameters
string$typeA possible DB type (sqlite, mysql, postgres,...)
array$paramsParameter map with keys:
  • host : The hostname of the DB server
  • user : The name of the database user the client operates under
  • password : The password for the database user
  • dbname : The name of the database to use where queries do not specify one. The database must exist or an error might be thrown. Setting this to the empty string will avoid any such errors and make the handle have no implicit database scope. This is useful for queries like SHOW STATUS, CREATE DATABASE, or DROP DATABASE. Note that a "database" in Postgres is rougly equivalent to an entire MySQL server. This the domain in which user names and such are defined, e.g. users are database-specific in Postgres.
  • schema : The database schema to use (if supported). A "schema" in Postgres is roughly equivalent to a "database" in MySQL. Note that MySQL and SQLite do not use schemas.
  • tablePrefix : Optional table prefix that is implicitly added on to all table names recognized in queries. This can be used in place of schemas for handle site farms.
  • flags : Optional bit field of DBO_* constants that define connection, protocol, buffering, and transaction behavior. It is STRONGLY adviced to leave the DBO_DEFAULT flag in place UNLESS this this database simply acts as a key/value store.
  • driver: Optional name of a specific DB client driver. For MySQL, there is only the 'mysqli' driver; the old one 'mysql' has been removed.
  • variables: Optional map of session variables to set after connecting. This can be used to adjust lock timeouts or encoding modes and the like.
  • connLogger: Optional PSR-3 logger interface instance.
  • queryLogger: Optional PSR-3 logger interface instance.
  • profiler : Optional callback that takes a section name argument and returns a ScopedCallback instance that ends the profile section in its destructor. These will be called in query(), using a simplified version of the SQL that also includes the agent as a SQL comment.
  • trxProfiler: Optional TransactionProfiler instance.
  • errorLogger: Optional callback that takes an Exception and logs it.
  • deprecationLogger: Optional callback that takes a string and logs it.
  • cliMode: Whether to consider the execution context that of a CLI script.
  • agent: Optional name used to identify the end-user in query profiling/logging.
  • srvCache: Optional BagOStuff instance to an APC-style cache.
  • nonNativeInsertSelectBatchSize: Optional batch size for non-native INSERT SELECT.
  • ownerId: Optional integer ID of a LoadBalancer instance that manages this instance.
int$connectOne of the class constants (NEW_CONNECTED, NEW_UNCONNECTED) [optional]
Returns
Database|null If the database driver or extension cannot be found
Exceptions
InvalidArgumentExceptionIf the database driver or extension cannot be found
Since
1.18

Definition at line 370 of file Database.php.

References Wikimedia\Rdbms\Database\$conn, and $type.

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

◆ fetchAffectedRowCount()

Wikimedia\Rdbms\Database::fetchAffectedRowCount ( )
abstractprotected
Returns
int Number of retrieved rows according to the driver

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

◆ fieldExists()

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

Determines whether a field exists in a table.

Parameters
string$tableTable name
string$fieldFiled to check on that table
string$fnameCalling function name (optional)
Returns
bool Whether $table has filed $field
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2059 of file Database.php.

References Wikimedia\Rdbms\IMaintainableDatabase\fieldInfo().

◆ fieldHasBit()

Wikimedia\Rdbms\Database::fieldHasBit (   $field,
  $flags 
)
finalprotected
Parameters
int$field
int$flags
Returns
bool
Since
1.34

Definition at line 4829 of file Database.php.

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

◆ fieldNamesWithAlias()

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

Gets an array of aliased field names.

Parameters
array$fields[ [alias] => field ]
Returns
string[] See fieldNameWithAlias()

Definition at line 2608 of file Database.php.

References Wikimedia\Rdbms\Database\fieldNameWithAlias().

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

◆ fieldNameWithAlias()

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

Get an aliased field name e.g.

fieldName AS newFieldName

Parameters
string$nameField name
string | bool$aliasAlias (optional)
Returns
string SQL name for aliased field. Will not alias a field to its own name

Definition at line 2594 of file Database.php.

References Wikimedia\Rdbms\Database\addIdentifierQuotes().

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

◆ flatAtomicSectionList()

Wikimedia\Rdbms\Database::flatAtomicSectionList ( )
private

◆ 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 DB after waiting on replication to catch up to the master.

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 IDatabase::query()
Since
1.28
1.34 Added $flush parameter

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4185 of file Database.php.

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

◆ freeResult()

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

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

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

Parameters
mixed$resA SQL result

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1627 of file Database.php.

◆ getApproximateLagStatus()

Wikimedia\Rdbms\Database::getApproximateLagStatus ( )
protected

Get a replica DB lag estimate for this server.

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

Definition at line 4377 of file Database.php.

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

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

◆ getAttributes()

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

Definition at line 501 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

Definition at line 4844 of file Database.php.

References Wikimedia\Rdbms\Database\$conn.

Referenced by Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\doQuery(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\DatabasePostgres\fetchRow(), Wikimedia\Rdbms\DatabasePostgres\getServerVersion(), Wikimedia\Rdbms\DatabasePostgres\numRows(), and Wikimedia\Rdbms\DatabasePostgres\strencode().

◆ getCacheSetOptions()

static Wikimedia\Rdbms\Database::getCacheSetOptions ( IDatabase  $db1,
IDatabase  $db2 = null 
)
static

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

This is information is useful for caching modules

See also
WANObjectCache::set()
WANObjectCache::getWithSetCallback()
Parameters
IDatabase$db1
IDatabase | null$db2[optional]
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 4403 of file Database.php.

References $res, and Wikimedia\Rdbms\IDatabase\getSessionLagStatus().

Referenced by Revision\RevisionStore\getKnownCurrentRevision(), MediaWiki\Storage\NameTableStore\getName(), MediaWiki\Storage\NameTableStore\getTableFromCachesOrReplica(), MediaWiki\Block\DatabaseBlock\isWhitelistedFromAutoblocks(), and MediaWiki\Interwiki\ClassicInterwikiLookup\load().

◆ getClass()

static Wikimedia\Rdbms\Database::getClass (   $dbType,
  $driver = null 
)
staticprivate
Parameters
string$dbTypeA possible DB type (sqlite, mysql, postgres,...)
string | null$driverOptional name of a specific DB client driver
Returns
string Database subclass name to use
Exceptions
InvalidArgumentException

Definition at line 450 of file Database.php.

◆ getDBname()

◆ getDefaultSchemaVars()

Wikimedia\Rdbms\Database::getDefaultSchemaVars ( )
protected

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

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

Returns
array

Definition at line 4648 of file Database.php.

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

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

Definition at line 790 of file Database.php.

References $s, Wikimedia\Rdbms\Database\indexInfo(), and Wikimedia\Rdbms\Database\strencode().

Referenced by Wikimedia\Rdbms\DatabaseSqlite\__construct(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\handleSessionLossPreconnect(), and Wikimedia\Rdbms\Database\rollback().

◆ getFlag()

◆ getInfinity()

Wikimedia\Rdbms\Database::getInfinity ( )

Find out when 'infinity' is.

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

Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4775 of file Database.php.

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

◆ getLag()

Wikimedia\Rdbms\Database::getLag ( )

Get the amount of replication lag for this database server.

Callers should avoid using this method while a transaction is active

Returns
int|bool Database replication lag in seconds or false on error
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4420 of file Database.php.

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

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

◆ getLastPHPError()

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

Definition at line 837 of file Database.php.

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

◆ getLazyMasterHandle()

Wikimedia\Rdbms\Database::getLazyMasterHandle ( )
protected
Returns
IDatabase|null
See also
setLazyMasterHandle()
Since
1.27

Definition at line 620 of file Database.php.

References Wikimedia\Rdbms\Database\$lazyMasterHandle.

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

◆ getLBInfo()

◆ getLogContext()

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

◆ getMasterPos()

Wikimedia\Rdbms\Database::getMasterPos ( )

Get the position of this master.

Returns
DBMasterPos|bool False if this is not a master
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3391 of file Database.php.

◆ getQueryExceptionAndLog()

Wikimedia\Rdbms\Database::getQueryExceptionAndLog (   $error,
  $errno,
  $sql,
  $fname 
)
private

◆ getQueryVerb()

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

◆ getReadOnlyReason()

Wikimedia\Rdbms\Database::getReadOnlyReason ( )
protected
Returns
string|bool Reason this DB is read-only or false if it is not

Definition at line 4804 of file Database.php.

References Wikimedia\Rdbms\Database\getLBInfo().

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

◆ getRecordedTransactionLagStatus()

Wikimedia\Rdbms\Database::getRecordedTransactionLagStatus ( )
finalprotected

Get the replica DB lag when the current transaction started.

This is useful when transactions might use snapshot isolation (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data is this lag plus transaction duration. If they don't, it is still safe to be pessimistic. This returns null if there is no transaction.

This returns null if the lag status for this transaction was not yet recorded.

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

Definition at line 4365 of file Database.php.

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

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

◆ getReplicaPos()

Wikimedia\Rdbms\Database::getReplicaPos ( )

Get the replication position of this replica DB.

Returns
DBMasterPos|bool False if this is not a replica DB
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3386 of file Database.php.

◆ getSchemaVars()

Wikimedia\Rdbms\Database::getSchemaVars ( )
protected

Get schema variables.

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

Returns
array

Definition at line 4636 of file Database.php.

References Wikimedia\Rdbms\Database\getDefaultSchemaVars().

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

◆ getScopedLockAndFlush()

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

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

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

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

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

Parameters
string$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 IDatabase::query()
Since
1.27

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4671 of file Database.php.

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

◆ getServer()

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

Definition at line 516 of file Database.php.

References Wikimedia\Rdbms\IDatabase\getServerVersion().

◆ getServerUptime()

Wikimedia\Rdbms\Database::getServerUptime ( )

Determines how long the server has been up.

Returns
int
Exceptions
DBError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3297 of file Database.php.

◆ getSessionLagStatus()

Wikimedia\Rdbms\Database::getSessionLagStatus ( )

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

This is useful when transactions might use snapshot isolation (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data is this lag plus transaction duration. If they don't, it is still safe to be pessimistic. In 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 IDatabase::query()
Since
1.27

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4348 of file Database.php.

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

◆ getTempWrites()

Wikimedia\Rdbms\Database::getTempWrites (   $sql,
  $pseudoPermanent 
)
protected
Parameters
string$sqlA SQL query
bool$pseudoPermanentTreat any table from CREATE TEMPORARY as pseudo-permanent
Returns
array A n-tuple of:
  • int|null: A self::TEMP_* constant for temp table operations or null otherwise
  • string|null: The name of the new temporary table $sql creates, or null
  • string|null: The name of the temporary table that $sql drops, or null

Definition at line 1090 of file Database.php.

References $matches, and $type.

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

◆ getTransactionRoundId()

Wikimedia\Rdbms\Database::getTransactionRoundId ( )
finalprotected

◆ handleSessionLossPostconnect()

Wikimedia\Rdbms\Database::handleSessionLossPostconnect ( )
private

Clean things up after session (and thus transaction) loss after reconnect.

Definition at line 1516 of file Database.php.

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

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

◆ handleSessionLossPreconnect()

Wikimedia\Rdbms\Database::handleSessionLossPreconnect ( )
private

◆ ignoreIndexClause()

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

IGNORE INDEX clause.

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

Parameters
string$index
Returns
string

Definition at line 2837 of file Database.php.

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

◆ implicitOrderby()

Wikimedia\Rdbms\Database::implicitOrderby ( )

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

Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 624 of file Database.php.

◆ indexExists()

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

Determines whether an index exists.

Parameters
string$table
string$index
string$fname
Returns
bool|null
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2065 of file Database.php.

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

◆ indexInfo()

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

Get information about an index into an object.

Parameters
string$tableTable name
string$indexIndex name
string$fnameCalling function name
Returns
mixed Database-specific index description class or false if the index does not exist

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

◆ indexName()

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

◆ indexUnique()

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

Determines if a given index is unique.

Parameters
string$table
string$index
Returns
bool

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 2080 of file Database.php.

References Wikimedia\Rdbms\Database\indexInfo().

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

References Wikimedia\Rdbms\Database\doInitConnection(), and Wikimedia\Rdbms\Database\isOpen().

◆ insert()

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

INSERT wrapper, inserts an array into a table.

$a may be either:

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

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

  • IGNORE: Boolean: if present, duplicate key errors are ignored, and any rows which cause duplicate key errors are not inserted. It's possible to determine how many rows were successfully inserted using IDatabase::affectedRows().
Parameters
string$tableTable name. This will be passed through Database::tableName().
array$aArray of rows to insert
string$fnameCalling function name (use METHOD) for logs/profiling
array$optionsArray of options
Returns
bool Return true if no exception was thrown (deprecated since 1.33)
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2100 of file Database.php.

References $keys, Wikimedia\Rdbms\Database\makeInsertOptions(), Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().

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

◆ 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.
Parameters
string$destTableThe table name to insert into
string | array$srcTableMay be either a table name, or an array of table names to include in a join.
array$varMapMust be an associative array of the form [ 'dest1' => 'source1', ... ]. Source items may be literals rather than field names, but strings should be quoted with IDatabase::addQuotes()
array$condsCondition array. See $conds in IDatabase::select() for the details of the format of condition arrays. May be "*" to copy the whole table.
string$fnameThe function name of the caller, from METHOD
array$insertOptionsOptions for the INSERT part of the query, see IDatabase::insert() for details. Also, one additional option is available: pass 'NO_AUTO_COLUMNS' to hint that the query does not use an auto-increment or sequence to determine any column values.
array$selectOptionsOptions for the SELECT part of the query, see IDatabase::select() for details.
array$selectJoinCondsJoin conditions for the SELECT part of the query, see IDatabase::select() for details.
Returns
bool Return true if no exception was thrown (deprecated since 1.33)
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3031 of file Database.php.

References Wikimedia\Rdbms\Database\isInsertSelectSafe(), Wikimedia\Rdbms\Database\nativeInsertSelect(), and Wikimedia\Rdbms\Database\nonNativeInsertSelect().

◆ installErrorHandler()

Wikimedia\Rdbms\Database::installErrorHandler ( )
protected

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

Definition at line 814 of file Database.php.

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

◆ isInsertSelectSafe()

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

Definition at line 3075 of file Database.php.

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

◆ isOpen()

◆ isQuotedIdentifier()

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

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

Note
Do not use this to determine if untrusted input is safe. A malicious user can trick this function.
Parameters
string$name
Returns
bool

Definition at line 2759 of file Database.php.

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

◆ isReadOnly()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4797 of file Database.php.

References Wikimedia\Rdbms\Database\getReadOnlyReason().

◆ isTransactableQuery()

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

Determine whether a SQL statement is sensitive to isolation level.

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

Main purpose: Used by query() to decide whether to begin a transaction before the current query (in DBO_TRX mode, on by default).

Parameters
string$sql
Returns
bool

Definition at line 1074 of file Database.php.

References Wikimedia\Rdbms\Database\getQueryVerb().

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

◆ isWriteQuery()

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

Determine whether a query writes to the DB.

When in doubt, this returns true.

Main use cases:

  • Subsequent web requests should not need to wait for replication from the master position seen by this web request, unless this request made changes to the master. This is handled by ChronologyProtector by checking doneWrites() at the end of the request. doneWrites() returns true if any query set lastWriteTime; which query() does based on isWriteQuery().
  • Reject write queries to replica DBs, in query().
Parameters
string$sql
Returns
bool

Definition at line 1033 of file Database.php.

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

◆ lastDoneWrites()

Wikimedia\Rdbms\Database::lastDoneWrites ( )

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

Returns
int|float UNIX timestamp or false
Since
1.24

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 632 of file Database.php.

◆ lastQuery()

Wikimedia\Rdbms\Database::lastQuery ( )

Get the last query that sent on account of IDatabase::query()

Returns
string SQL text or empty string if there was no such query

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 628 of file Database.php.

References Wikimedia\Rdbms\Database\$lastQuery.

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

◆ 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 | bool$offsetThe SQL offset (default false)
Returns
string
Since
1.34

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3190 of file Database.php.

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

◆ listTables()

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

List all tables on the database.

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

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 4227 of file Database.php.

◆ listViews()

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

Lists all the VIEWs in the database.

Parameters
string | null$prefixOnly show VIEWs with this prefix, eg. unit_test_
string$fnameName of calling function
Exceptions
RuntimeException
Returns
array

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 4231 of file Database.php.

◆ lock()

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

Acquire a named lock.

Named locks are not related to transactions

Parameters
string$lockNameName of lock to aquire
string$methodName of the calling method
int$timeoutAcquisition timeout in seconds (0 means non-blocking)
Returns
bool Success
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4659 of file Database.php.

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

◆ lockForUpdate()

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

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

Parameters
array | string$tableTable names
array | string$condsFilters on the table
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 IDatabase::query()
Since
1.32

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2043 of file Database.php.

References DBO_TRX, Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\selectRowCount(), and Wikimedia\Rdbms\Database\trxLevel().

◆ 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 IDatabase::query()
Since
1.20

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4652 of file Database.php.

◆ lockTables()

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

Lock specific tables.

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

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

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

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

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

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

Parameters
array$readArray of tables to lock for read access
array$writeArray of tables to lock for write access
string$methodName of caller
Returns
bool
Since
1.29

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 4715 of file Database.php.

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

◆ makeGroupByWithHaving()

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

Returns an optional GROUP BY with an optional HAVING.

Parameters
array$optionsAssociative array of options
Returns
string
See also
Database::select()
Since
1.21

Definition at line 1763 of file Database.php.

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

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

◆ makeInsertOptions()

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

Helper for Database::insert().

Parameters
array$options
Returns
string

Definition at line 2096 of file Database.php.

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

◆ makeList()

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

Makes an encoded list of strings from an array.

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

Example usage:

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

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 IDatabase::query()
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2190 of file Database.php.

References Wikimedia\Rdbms\Database\addQuotes(), LIST_AND, LIST_NAMES, LIST_OR, and LIST_SET.

Referenced by Wikimedia\Rdbms\Database\conditional(), Wikimedia\Rdbms\Database\delete(), Wikimedia\Rdbms\DatabaseMysqlBase\deleteJoin(), Wikimedia\Rdbms\Database\deleteJoin(), Wikimedia\Rdbms\DatabaseMysqlBase\getHeartbeatData(), Wikimedia\Rdbms\DatabasePostgres\insert(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\makeGroupByWithHaving(), Wikimedia\Rdbms\Database\makeWhereFrom2d(), Wikimedia\Rdbms\Database\nativeReplace(), Wikimedia\Rdbms\Database\replace(), Wikimedia\Rdbms\Database\selectSQLText(), Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN(), Wikimedia\Rdbms\Database\update(), Wikimedia\Rdbms\DatabaseMysqlBase\upsert(), and Wikimedia\Rdbms\Database\upsert().

◆ makeOrderBy()

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

Returns an optional ORDER BY.

Parameters
array$optionsAssociative array of options
Returns
string
See also
Database::select()
Since
1.21

Definition at line 1789 of file Database.php.

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

◆ makeSelectOptions()

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

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

See also
Database::select()
Parameters
array$optionsAssociative array of options to be turned into an SQL query, valid keys are listed in the function.
Returns
array

Definition at line 1692 of file Database.php.

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

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

◆ makeUpdateOptions()

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

Make UPDATE options for the Database::update function.

Parameters
array$optionsThe options passed to Database::update
Returns
string

Definition at line 2170 of file Database.php.

References Wikimedia\Rdbms\Database\makeUpdateOptionsArray().

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

◆ makeUpdateOptionsArray()

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

Make UPDATE options array for Database::makeUpdateOptions.

Parameters
array$options
Returns
array

Definition at line 2150 of file Database.php.

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

◆ makeWhereFrom2d()

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

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

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

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2270 of file Database.php.

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

◆ masterPosWait()

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

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

Note that this does not start any new transactions. If any existing transaction is flushed, and this is called, then queries will reflect the point the DB was synced up to (on success) without interference from REPEATABLE-READ snapshots.

Parameters
DBMasterPos$pos
int$timeoutThe maximum number of seconds to wait for synchronisation
Returns
int|null Zero if the replica DB was past that position already, greater than zero if we waited for some period of time, less than zero if it timed out, and null on error
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3381 of file Database.php.

◆ maxListLen()

Wikimedia\Rdbms\Database::maxListLen ( )

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

Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4434 of file Database.php.

◆ modifyCallbacksForCancel()

Wikimedia\Rdbms\Database::modifyCallbacksForCancel ( array  $sectionIds,
AtomicSectionIdentifier  $newSectionId = null 
)
private

Update callbacks that were owned by cancelled atomic sections.

Callbacks for "on commit" should never be run if they're owned by a section that won't be committed.

Callbacks for "on resolution" need to reflect that the section was rolled back, even if the transaction as a whole commits successfully.

Callbacks for "on section cancel" should already have been consumed, but errors during the cancellation itself can prevent that while still destroying the section. Hoist any such callbacks to the new top section, which we assume will itself have to be cancelled or rolled back to resolve the error.

Parameters
AtomicSectionIdentifier[]$sectionIds ID of an actual savepoint
AtomicSectionIdentifier | null$newSectionIdNew top section ID.
Exceptions
UnexpectedValueException

Definition at line 3516 of file Database.php.

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

◆ namedLocksEnqueue()

Wikimedia\Rdbms\Database::namedLocksEnqueue ( )

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

Returns
bool
Since
1.26

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4707 of file Database.php.

◆ nativeInsertSelect()

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

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

See also
IDatabase::insertSelect()
Parameters
string$destTable
string | array$srcTable
array$varMap
array$conds
string$fname
array$insertOptions
array$selectOptions
array$selectJoinConds

Definition at line 3162 of file Database.php.

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

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

◆ nativeReplace()

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

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

Parameters
string$tableTable name
array | string$rowsRow(s) to insert
string$fnameCaller function name

Definition at line 2902 of file Database.php.

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

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

◆ newExceptionAfterConnectError()

Wikimedia\Rdbms\Database::newExceptionAfterConnectError (   $error)
finalprotected

◆ nextSavepointId()

Wikimedia\Rdbms\Database::nextSavepointId (   $fname)
private
Parameters
string$fname
Returns
string

Definition at line 3796 of file Database.php.

References Wikimedia\Rdbms\Database\$trxAtomicCounter.

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

◆ nextSequenceValue()

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

Deprecated method, calls should be removed.

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

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

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2809 of file Database.php.

◆ nonNativeInsertSelect()

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

◆ normalizeConditions()

Wikimedia\Rdbms\Database::normalizeConditions (   $conds,
  $fname 
)
finalprotected

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

References Wikimedia\Rdbms\Database\currentAtomicSectionId(), and Wikimedia\Rdbms\Database\trxLevel().

◆ onTransactionCommitOrIdle()

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

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

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

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

Queries in the function will run in AUTOCOMMIT mode unless there are begin() calls. Callbacks must commit any transactions that they begin.

This is useful for updates to different systems or when separate transactions are needed. For example, one might want to enqueue jobs into a system outside the database, but only after the database is updated so that the jobs will see the data when they actually run. It can also be used for updates that easily suffer from lock timeouts and deadlocks, but where atomicity is not essential.

Avoid using IDatabase instances aside from this one in the callback, unless such instances never have IDatabase::DBO_TRX set. This keeps callbacks from interfering with one another.

Updates will execute in the order they were enqueued.

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

The callback takes the following arguments:

  • How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_IDLE)
  • This IDatabase instance (since 1.32)
Parameters
callable$callback
string$fnameCaller name
Exceptions
DBErrorIf an error occurs, see IDatabase::query()
ExceptionIf the callback runs immediately and an error occurs in it
Since
1.32

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3407 of file Database.php.

References Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\currentAtomicSectionId(), Wikimedia\Rdbms\Database\getTransactionRoundId(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), and Wikimedia\Rdbms\Database\trxLevel().

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

◆ onTransactionIdle()

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

Alias for onTransactionCommitOrIdle() for backwards-compatibility.

Parameters
callable$callback
string$fname
Since
1.20
Deprecated:
Since 1.32

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3420 of file Database.php.

References Wikimedia\Rdbms\Database\onTransactionCommitOrIdle().

◆ 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 before all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.

Callbacks must not start nor commit any transactions. If no transaction is active, then a transaction will wrap the callback.

This is useful for updates that easily suffer from lock timeouts and deadlocks, but where atomicity is strongly desired for these updates and some related updates.

Updates will execute in the order they were enqueued.

The callback takes the one argument:

Parameters
callable$callback
string$fnameCaller name
Exceptions
DBErrorIf an error occurs, see IDatabase::query()
ExceptionIf the callback runs immediately and an error occurs in it
Since
1.22

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3424 of file Database.php.

References Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\currentAtomicSectionId(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\getTransactionRoundId(), Wikimedia\Rdbms\Database\startAtomic(), and Wikimedia\Rdbms\Database\trxLevel().

◆ onTransactionResolution()

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

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

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

This is useful for combining cooperative locks and DB transactions.

Note this is called when the whole transaction is resolved. To take action immediately when an atomic section is cancelled, use onAtomicSectionCancel().

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

The callback takes the following arguments:

  • How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK)
  • This IDatabase instance (since 1.32)
Parameters
callable$callback
string$fnameCaller name
Exceptions
DBErrorIf an error occurs, see IDatabase::query()
ExceptionIf the callback runs immediately and an error occurs in it
Since
1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3400 of file Database.php.

References Wikimedia\Rdbms\Database\currentAtomicSectionId(), and Wikimedia\Rdbms\Database\trxLevel().

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

◆ open()

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

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

Parameters
string | null$serverDatabase server host
string | null$userDatabase user name
string | null$passwordDatabase user password
string | null$dbNameDatabase name
string | null$schemaDatabase schema name
string$tablePrefixTable prefix
Exceptions
DBConnectionError

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

◆ pendingWriteAndCallbackCallers()

Wikimedia\Rdbms\Database::pendingWriteAndCallbackCallers ( )

List the methods that have write queries or callbacks for the current transaction.

This method should not be used outside of Database/LoadBalancer

Returns
string[]
Since
1.32

Definition at line 714 of file Database.php.

References Wikimedia\Rdbms\Database\pendingWriteCallers().

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

◆ pendingWriteCallers()

Wikimedia\Rdbms\Database::pendingWriteCallers ( )

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

Returns
array
Since
1.27

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 698 of file Database.php.

References Wikimedia\Rdbms\Database\trxLevel().

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

◆ 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|bool Returns false if not transaction is active
Since
1.26

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 668 of file Database.php.

References Wikimedia\Rdbms\Database\$trxWriteDuration, $type, Wikimedia\Rdbms\Database\pingAndCalculateLastTrxApplyTime(), and Wikimedia\Rdbms\Database\trxLevel().

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

◆ pendingWriteRowsAffected()

Wikimedia\Rdbms\Database::pendingWriteRowsAffected ( )

Get the number of affected rows from pending write queries.

Returns
int
Since
1.30

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 702 of file Database.php.

References Wikimedia\Rdbms\Database\$trxWriteAffectedRows.

◆ ping()

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

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

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4284 of file Database.php.

References Wikimedia\Rdbms\Database\$lastRoundTripEstimate, Wikimedia\Rdbms\Database\isOpen(), and Wikimedia\Rdbms\Database\query().

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

◆ pingAndCalculateLastTrxApplyTime()

Wikimedia\Rdbms\Database::pingAndCalculateLastTrxApplyTime ( )
private
Returns
float Time to apply writes to replicas based on trxWrite* fields

Definition at line 686 of file Database.php.

References Wikimedia\Rdbms\Database\$trxWriteAdjQueryCount, and Wikimedia\Rdbms\Database\ping().

Referenced by Wikimedia\Rdbms\Database\pendingWriteQueryDuration(), and Wikimedia\Rdbms\Database\rollback().

◆ preCommitCallbacksPending()

Wikimedia\Rdbms\Database::preCommitCallbacksPending ( )
Returns
bool Whether there is a transaction open with pre-commit callbacks pending
Since
1.32

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 650 of file Database.php.

References Wikimedia\Rdbms\Database\$trxPreCommitCallbacks, and Wikimedia\Rdbms\Database\trxLevel().

◆ prependDatabaseOrSchema()

Wikimedia\Rdbms\Database::prependDatabaseOrSchema (   $namespace,
  $relation,
  $format 
)
private
Parameters
string | null$namespaceDatabase or schema
string$relationName of table, view, sequence, etc...
string$formatOne of (raw, quoted)
Returns
string Relation name with quoted and merged $namespace as needed

Definition at line 2504 of file Database.php.

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

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

◆ qualifiedTableComponents()

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

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

Parameters
string$nameTable name in the form of db.schema.table, db.table, or table
Returns
array (DB name or "" for default, schema name, table prefix, table name)

Definition at line 2464 of file Database.php.

References Wikimedia\Rdbms\Database\relationSchemaQualifier(), and Wikimedia\Rdbms\Database\tablePrefix().

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

◆ query()

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

Run an SQL query 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.

Parameters
string$sqlSQL query
string$fnameName of the calling function, for profiling/SHOW PROCESSLIST comment (you can use METHOD or add some extra info)
int$flagsBitfield of IDatabase::QUERY_* constants. Note that suppression of errors is best handled by try/catch rather than using one of these flags.
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 1141 of file Database.php.

References Wikimedia\Rdbms\Database\assertQueryIsCurrentlyAllowed(), Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\Database\fieldHasBit(), Wikimedia\Rdbms\Database\reportQueryError(), and Wikimedia\Rdbms\Database\resultObject().

Referenced by Wikimedia\Rdbms\DatabaseSqlite\attachDatabase(), SqliteMaintenance\backup(), Wikimedia\Rdbms\DatabasePostgres\constraintExists(), Wikimedia\Rdbms\DatabasePostgres\currentSequenceValue(), Wikimedia\Rdbms\Database\delete(), Wikimedia\Rdbms\DatabaseMysqlBase\deleteJoin(), Wikimedia\Rdbms\Database\deleteJoin(), Wikimedia\Rdbms\DatabaseSqlite\doBegin(), Wikimedia\Rdbms\Database\doBegin(), Wikimedia\Rdbms\Database\doCommit(), Wikimedia\Rdbms\DatabaseMysqlBase\doLockTables(), Wikimedia\Rdbms\DatabasePostgres\doLockTables(), Wikimedia\Rdbms\Database\doReleaseSavepoint(), Wikimedia\Rdbms\Database\doRollback(), Wikimedia\Rdbms\Database\doRollbackToSavepoint(), Wikimedia\Rdbms\Database\doSavepoint(), Wikimedia\Rdbms\DatabaseMysqlBase\doUnlockTables(), Wikimedia\Rdbms\DatabaseSqlite\dropTable(), Wikimedia\Rdbms\DatabaseMysqlBase\dropTable(), Wikimedia\Rdbms\Database\dropTable(), Wikimedia\Rdbms\DatabasePostgres\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseSqlite\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseMysqlBase\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseMysqlBase\fieldInfo(), Wikimedia\Rdbms\DatabaseSqlite\fieldInfo(), Wikimedia\Rdbms\PostgresField\fromText(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), Wikimedia\Rdbms\DatabasePostgres\getCurrentSchema(), Wikimedia\Rdbms\DatabaseMysqlBase\getHeartbeatData(), Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromSlaveStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getMysqlStatus(), Wikimedia\Rdbms\DatabasePostgres\getSchemas(), Wikimedia\Rdbms\DatabasePostgres\getSearchPath(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerGTIDs(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerId(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerRoleStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerUUID(), Wikimedia\Rdbms\DatabasePostgres\indexAttributes(), Wikimedia\Rdbms\DatabasePostgres\indexInfo(), Wikimedia\Rdbms\DatabaseSqlite\indexInfo(), Wikimedia\Rdbms\DatabaseMysqlBase\indexInfo(), Wikimedia\Rdbms\DatabasePostgres\indexUnique(), Wikimedia\Rdbms\DatabasePostgres\insert(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\DatabasePostgres\insertId(), SqliteMaintenance\integrityCheck(), Wikimedia\Rdbms\DatabasePostgres\listTables(), Wikimedia\Rdbms\DatabaseMysqlBase\listTables(), Wikimedia\Rdbms\DatabaseMysqlBase\listViews(), Wikimedia\Rdbms\DatabaseMysqlBase\lock(), Wikimedia\Rdbms\DatabasePostgres\lock(), Wikimedia\Rdbms\DatabaseMysqlBase\lockIsFree(), Wikimedia\Rdbms\DatabasePostgres\lockIsFree(), Wikimedia\Rdbms\DatabasePostgres\nativeInsertSelect(), Wikimedia\Rdbms\Database\nativeInsertSelect(), Wikimedia\Rdbms\Database\nativeReplace(), Wikimedia\Rdbms\DatabasePostgres\open(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), Wikimedia\Rdbms\DatabaseSqlite\open(), Wikimedia\Rdbms\Database\ping(), Wikimedia\Rdbms\DatabasePostgres\relationExists(), Wikimedia\Rdbms\DatabasePostgres\resetSequenceForTable(), Wikimedia\Rdbms\DatabaseSqlite\resetSequenceForTable(), Wikimedia\Rdbms\DatabasePostgres\schemaExists(), Wikimedia\Rdbms\Database\select(), Wikimedia\Rdbms\DatabaseMysqlBase\serverIsReadOnly(), Wikimedia\Rdbms\DatabasePostgres\serverIsReadOnly(), Wikimedia\Rdbms\DatabaseMysqlBase\setBigSelects(), Wikimedia\Rdbms\DatabasePostgres\setSearchPath(), Wikimedia\Rdbms\DatabaseMysqlBase\setSessionOptions(), Wikimedia\Rdbms\Database\sourceStream(), Wikimedia\Rdbms\DatabaseMysqlBase\tableExists(), Wikimedia\Rdbms\DatabaseSqlite\tableExists(), Wikimedia\Rdbms\DatabasePostgres\textFieldSize(), Wikimedia\Rdbms\Database\textFieldSize(), Wikimedia\Rdbms\DatabasePostgres\triggerExists(), Wikimedia\Rdbms\DatabaseMysqlBase\unlock(), Wikimedia\Rdbms\DatabasePostgres\unlock(), Wikimedia\Rdbms\Database\update(), Wikimedia\Rdbms\DatabaseMysqlBase\upsert(), and SqliteMaintenance\vacuum().

◆ reassignCallbacksForSection()

Wikimedia\Rdbms\Database::reassignCallbacksForSection ( AtomicSectionIdentifier  $old,
AtomicSectionIdentifier  $new 
)
private

Hoist callback ownership for callbacks in a section to a parent section.

All callbacks should have an owner that is present in trxAtomicLevels.

Parameters
AtomicSectionIdentifier$old
AtomicSectionIdentifier$new

Definition at line 3472 of file Database.php.

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

◆ registerTempWrites()

Wikimedia\Rdbms\Database::registerTempWrites (   $ret,
  $tmpType,
  $tmpNew,
  $tmpDel 
)
protected
Parameters
IResultWrapper | bool$ret
int | null$tmpTypeTEMP_NORMAL or TEMP_PSEUDO_PERMANENT
string | null$tmpNewName of created temp table
string | null$tmpDelName of dropped temp table

Definition at line 1130 of file Database.php.

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

◆ relationSchemaQualifier()

Wikimedia\Rdbms\Database::relationSchemaQualifier ( )
protected
Returns
string Schema to use to qualify relations in queries

Definition at line 581 of file Database.php.

References Wikimedia\Rdbms\Database\dbSchema().

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

◆ replace()

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

REPLACE query wrapper.

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

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

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

Parameters
string$tableThe table to replace the row(s) in.
array[]|string[]|string$uniqueIndexes All unique indexes. One of the following: a) the one unique field in the table (when no composite unique key exist) b) a list of all unique fields in the table (when no composite unique key exist) c) a list of all unique indexes in the table (each as a list of the indexed fields)
array$rowsCan be either a single row to insert, or multiple rows, in the same format as for IDatabase::insert()
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2841 of file Database.php.

References Wikimedia\Rdbms\Database\$affectedRowCount, Wikimedia\Rdbms\Database\affectedRows(), Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\insert(), LIST_AND, LIST_OR, Wikimedia\Rdbms\Database\makeList(), and Wikimedia\Rdbms\Database\startAtomic().

◆ replaceLostConnection()

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

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

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

Definition at line 4309 of file Database.php.

References Wikimedia\Rdbms\Database\closeConnection(), Wikimedia\Rdbms\Database\getServer(), Wikimedia\Rdbms\Database\handleSessionLossPostconnect(), Wikimedia\Rdbms\Database\handleSessionLossPreconnect(), Wikimedia\Rdbms\Database\open(), and Wikimedia\Rdbms\Database\tablePrefix().

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

◆ replaceVars()

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

Database independent variable replacement.

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

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

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

Definition at line 4598 of file Database.php.

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

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

◆ reportQueryError()

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

Report a query error.

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

Parameters
string$error
int$errno
string$sql
string$fname
bool$ignore
Exceptions
DBQueryError

Definition at line 1569 of file Database.php.

References Wikimedia\Rdbms\Database\getQueryExceptionAndLog().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\doSelectDomain(), 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
bool|string

Definition at line 825 of file Database.php.

References Wikimedia\Rdbms\Database\getLastPHPError().

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

◆ restoreFlags()

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

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

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 773 of file Database.php.

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

◆ resultObject()

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

Take a query result and wrap it in an iterable result wrapper if necessary.

Booleans are passed through as-is to indicate success/failure of write queries.

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

Parameters
bool | IResultWrapper | resource$result
Returns
bool|IResultWrapper

Definition at line 4272 of file Database.php.

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

◆ 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 transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported. If a serious unexpected error occurs, throwing an Exception is preferrable, using a pre-installed error handler to trigger rollback (in any case, failure to issue COMMIT will cause rollback server-side).

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

Parameters
string$fnameCalling function name
string$flushFlush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about calling rollback when no transaction is in progress. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context.
Exceptions
DBErrorIf an error occurs, see IDatabase::query()
Since
1.23 Added $flush parameter

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4114 of file Database.php.

References Wikimedia\Rdbms\Database\assertHasConnectionHandle(), Wikimedia\Rdbms\Database\consumeTrxShortId(), DBO_TRX, Wikimedia\Rdbms\Database\doRollback(), Wikimedia\Rdbms\Database\getDomainID(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\pingAndCalculateLastTrxApplyTime(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), Wikimedia\Rdbms\Database\runTransactionListenerCallbacks(), Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\trxStatus().

Referenced by Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\deadlockLoop(), and Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().

◆ runOnAtomicSectionCancelCallbacks()

Wikimedia\Rdbms\Database::runOnAtomicSectionCancelCallbacks (   $trigger,
array  $sectionIds = null 
)
private

Actually run any "atomic section cancel" callbacks.

Parameters
int$triggerIDatabase::TRIGGER_* constant
AtomicSectionIdentifier[]|null$sectionIds Section IDs to cancel, null on transaction rollback

Definition at line 3685 of file Database.php.

References Wikimedia\Rdbms\Database\$errorLogger, and Wikimedia\Rdbms\Database\$trxSectionCancelCallbacks.

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

◆ runOnTransactionIdleCallbacks()

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

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

This method should not be used outside of Database/LoadBalancer

Parameters
int$triggerIDatabase::TRIGGER_* constant
Returns
int Number of callbacks attempted
Since
1.20
Exceptions
Exception

Definition at line 3582 of file Database.php.

References Wikimedia\Rdbms\Database\clearFlag(), DBO_TRX, Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\setFlag(), and Wikimedia\Rdbms\Database\trxLevel().

Referenced by Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\handleSessionLossPostconnect(), Wikimedia\Rdbms\Database\onTransactionCommitOrIdle(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\LoadBalancer\runMasterTransactionIdleCallbacks().

◆ runOnTransactionPreCommitCallbacks()

Wikimedia\Rdbms\Database::runOnTransactionPreCommitCallbacks ( )

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

This method should not be used outside of Database/LoadBalancer

Since
1.22
Returns
int Number of callbacks attempted
Exceptions
Exception

Definition at line 3651 of file Database.php.

References Wikimedia\Rdbms\Database\$errorLogger, and Wikimedia\Rdbms\Database\$trxPreCommitCallbacks.

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

◆ runTransactionListenerCallbacks()

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

Actually run any "transaction listener" callbacks.

This method should not be used outside of Database/LoadBalancer

Parameters
int$triggerIDatabase::TRIGGER_* constant
Exceptions
Exception
Since
1.20

Definition at line 3728 of file Database.php.

References Wikimedia\Rdbms\Database\$errorLogger.

Referenced by Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\handleSessionLossPostconnect(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\LoadBalancer\runMasterTransactionListenerCallbacks().

◆ select()

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

Execute a SELECT query constructed using the various parameters provided.

Parameters
string | array$tableTable name(s)

May be either an array of table names, or a single string holding a table name. If an array is given, table aliases can be specified, for example:

[ 'a' => 'user' ]

This includes the user table in the query, with the alias "a" available for use in field names (e.g. a.user_name).

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

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

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

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

along with $join_conds like

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

will produce SQL something like

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

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

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

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 | array$condsMay be either a string containing a single condition, or an array of conditions. If an array is given, the conditions constructed from each element are combined with AND.

Array elements may take one of two forms:

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

Note that expressions are often DBMS-dependent in their syntax. DBMS-independent wrappers are provided for constructing several types of expression commonly used in condition queries. See:

Untrusted user input is safe in the values of string keys, however untrusted input must not be used in the array key names or in the values of numeric keys. Escaping of untrusted input used in values of numeric keys should be done via IDatabase::addQuotes()

Use an empty array, string, or '*' to update all rows.

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 an string containing a HAVING clause or an array of conditions building the HAVING clause. If an array is given, the conditions constructed from each element are combined with AND.
  • ORDER BY: May be either an SQL fragment giving a field name or expression to order by, or an array of such SQL fragments.
  • USE INDEX: This may be either a string giving the index name to use for the query, or an array. If it is an associative array, each key gives the table name (or alias), each value gives the index name to use for that table. All strings are SQL fragments and so should be validated by the caller.
  • EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run, instead of SELECT.

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

  • 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. In the most common case, this is unnecessary, since the join condition can be in $conds. However, it is useful for doing a LEFT JOIN.

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

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

Returns
IResultWrapper Resulting rows
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1801 of file Database.php.

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

Referenced by Wikimedia\Rdbms\DatabasePostgres\estimateRowCount(), Wikimedia\Rdbms\DatabaseMysqlBase\estimateRowCount(), Wikimedia\Rdbms\Database\estimateRowCount(), Wikimedia\Rdbms\DatabaseSqlite\listTables(), Wikimedia\Rdbms\Database\nonNativeInsertSelect(), Wikimedia\Rdbms\Database\selectField(), Wikimedia\Rdbms\Database\selectFieldValues(), Wikimedia\Rdbms\Database\selectRow(), and Wikimedia\Rdbms\Database\selectRowCount().

◆ selectDB()

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

Change the current database.

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

Parameters
string$db
Returns
bool True unless an exception was thrown
Exceptions
DBConnectionErrorIf databasesAreIndependent() is true and connection change fails
DBErrorOn query error or if database changes are disallowed
Deprecated:
Since 1.32 Use selectDomain() instead

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2374 of file Database.php.

References Wikimedia\Rdbms\Database\selectDomain().

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

Definition at line 2384 of file Database.php.

References Wikimedia\Rdbms\Database\doSelectDomain(), and Wikimedia\Rdbms\DatabaseDomain\newFromId().

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

◆ selectField()

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

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

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

Parameters
string | array$tableTable name. See IDatabase::select() for details.
string$varThe field name to select. This must be a valid SQL fragment: do not use unvalidated user input.
string | array$condThe condition array. See IDatabase::select() for details.
string$fnameThe function name of the caller.
string | array$optionsThe query options. See IDatabase::select() for details.
string | array$join_condsThe query join conditions. See IDatabase::select() for details.
Returns
mixed The value from the field
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1630 of file Database.php.

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

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

◆ selectFieldsOrOptionsAggregate()

Wikimedia\Rdbms\Database::selectFieldsOrOptionsAggregate (   $fields,
  $options 
)
private
Parameters
array | string$fields
array | string$options
Returns
bool

Definition at line 1976 of file Database.php.

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

◆ selectFieldValues()

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

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

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

Parameters
string | array$tableTable name. See IDatabase::select() for details.
string$varThe field name to select. This must be a valid SQL fragment: do not use unvalidated user input.
string | array$condThe condition array. See IDatabase::select() for details.
string$fnameThe function name of the caller.
string | array$optionsThe query options. See IDatabase::select() for details.
string | array$join_condsThe query join conditions. See IDatabase::select() for details.
Returns
array The values from the field in the order they were returned from the DB
Exceptions
DBErrorIf an error occurs, see IDatabase::query()
Since
1.25

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1656 of file Database.php.

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

◆ selectOptionsIncludeLocking()

Wikimedia\Rdbms\Database::selectOptionsIncludeLocking (   $options)
private
Parameters
string | array$options
Returns
bool

Definition at line 1960 of file Database.php.

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

◆ selectRow()

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

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

If the query returns no rows, false is returned.

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

Parameters
string | array$tableTable name
string | array$varsField names
string | array$condsConditions
string$fnameCaller function name
string | array$optionsQuery options
array | string$join_condsJoin conditions
Returns
stdClass|bool
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1892 of file Database.php.

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

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getReplicationSafetyInfo(), Wikimedia\Rdbms\DatabaseSqlite\indexUnique(), and Wikimedia\Rdbms\DatabaseMysqlBase\wasKnownStatementRollbackError().

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

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1927 of file Database.php.

References $res, Wikimedia\Rdbms\Database\buildSelectSubquery(), Wikimedia\Rdbms\Database\extractSingleFieldFromList(), Wikimedia\Rdbms\IDatabase\fetchRow(), Wikimedia\Rdbms\Database\normalizeConditions(), and Wikimedia\Rdbms\Database\select().

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

◆ selectSQLText()

Wikimedia\Rdbms\Database::selectSQLText (   $table,
  $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$tableTable name
string | array$varsField names
string | array$condsConditions
string$fnameCaller function name
string | array$optionsQuery options
string | array$join_condsJoin conditions
Returns
string SQL query string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1809 of file Database.php.

References Wikimedia\Rdbms\Database\fieldNamesWithAlias(), Wikimedia\Rdbms\Database\limitResult(), LIST_AND, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\makeSelectOptions(), Wikimedia\Rdbms\Database\selectFieldsOrOptionsAggregate(), Wikimedia\Rdbms\Database\selectOptionsIncludeLocking(), and Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN().

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

◆ serverIsReadOnly()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3396 of file Database.php.

◆ setBigSelects()

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

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

This is done by setting the sql_big_selects session variable.

This is a MySQL-specific feature.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4793 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\IDatabase.

Definition at line 743 of file Database.php.

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

◆ 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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4819 of file Database.php.

◆ setLazyMasterHandle()

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

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

Parameters
IDatabase$conn
Since
1.27

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 611 of file Database.php.

References Wikimedia\Rdbms\Database\$conn.

◆ setLBInfo()

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

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

Parameters
array | string$nameOrArrayThe new array or the name of a key to set
array | null$valueIf $nameOrArray is a string, the new key value (null to unset)

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 597 of file Database.php.

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

◆ setLogger()

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

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

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

Parameters
LoggerInterface$logger

Definition at line 512 of file Database.php.

◆ setSchemaVars()

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

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

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

Parameters
bool | array$varsMapping variable name to value.

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4484 of file Database.php.

◆ setSessionOptions()

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

Override database's default behavior.

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

Parameters
array$options
Returns
void
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4449 of file Database.php.

◆ setTableAliases()

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

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

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

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

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4815 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\IDatabase.

Definition at line 3552 of file Database.php.

◆ setTrxEndCallbackSuppression()

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

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

This method should not be used outside of Database/LoadBalancer

Parameters
bool$suppress
Since
1.28

Definition at line 3568 of file Database.php.

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

◆ 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
bool | string$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 4452 of file Database.php.

References Wikimedia\Rdbms\Database\sourceStream().

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

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

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

◆ startAtomic()

Wikimedia\Rdbms\Database::startAtomic (   $fname = __METHOD__,
  $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 IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3811 of file Database.php.

References Wikimedia\Rdbms\Database\begin(), DBO_TRX, Wikimedia\Rdbms\Database\doSavepoint(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\nextSavepointId(), and Wikimedia\Rdbms\Database\trxLevel().

Referenced by Wikimedia\Rdbms\Database\doAtomicSection(), Wikimedia\Rdbms\DatabasePostgres\insert(), Wikimedia\Rdbms\DatabaseSqlite\insert(), Wikimedia\Rdbms\Database\lockTables(), Wikimedia\Rdbms\Database\nonNativeInsertSelect(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), Wikimedia\Rdbms\DatabaseSqlite\replace(), Wikimedia\Rdbms\Database\replace(), and Wikimedia\Rdbms\Database\upsert().

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

Definition at line 4565 of file Database.php.

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

◆ strencode()

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

Wrapper for addslashes()

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

Referenced by Wikimedia\Rdbms\Database\addQuotes(), and Wikimedia\Rdbms\Database\getDomainID().

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

Definition at line 3293 of file Database.php.

◆ tableExists()

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

Query whether a given table exists.

Parameters
string$table
string$fname
Returns
bool
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

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

◆ tableLocksHaveTransactionScope()

Wikimedia\Rdbms\Database::tableLocksHaveTransactionScope ( )

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

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

Returns
bool
Since
1.29

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 4711 of file Database.php.

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

◆ tableName()

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

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

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

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

Note
This function does not sanitize user input. It is not safe to use this function to escape user input.
Parameters
string$nameDatabase table name
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 Full database name

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 2406 of file Database.php.

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

Referenced by Wikimedia\Rdbms\Database\delete(), Wikimedia\Rdbms\DatabaseMysqlBase\deleteJoin(), Wikimedia\Rdbms\Database\deleteJoin(), Wikimedia\Rdbms\DatabaseMysqlBase\doLockTables(), Wikimedia\Rdbms\DatabaseMysqlBase\dropTable(), Wikimedia\Rdbms\Database\dropTable(), Wikimedia\Rdbms\DatabaseMysqlBase\fieldInfo(), Wikimedia\Rdbms\DatabaseMysqlBase\indexInfo(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\nativeInsertSelect(), Wikimedia\Rdbms\Database\nativeReplace(), Wikimedia\Rdbms\Database\replaceVars(), Wikimedia\Rdbms\Database\tableNames(), Wikimedia\Rdbms\Database\tableNamesN(), Wikimedia\Rdbms\Database\tableNameWithAlias(), Wikimedia\Rdbms\Database\textFieldSize(), Wikimedia\Rdbms\Database\update(), and Wikimedia\Rdbms\DatabaseMysqlBase\upsert().

◆ tableNames()

Wikimedia\Rdbms\Database::tableNames ( )

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

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

Returns
array

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 2515 of file Database.php.

References Wikimedia\Rdbms\Database\tableName().

◆ tableNamesN()

Wikimedia\Rdbms\Database::tableNamesN ( )

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

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

Returns
array

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 2526 of file Database.php.

References Wikimedia\Rdbms\Database\tableName().

◆ tableNamesWithAlias()

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

Gets an array of aliased table names.

Parameters
array$tables[ [alias] => table ]
Returns
string[] See tableNameWithAlias()

Definition at line 2574 of file Database.php.

References Wikimedia\Rdbms\Database\tableNameWithAlias().

◆ tableNamesWithIndexClauseOrJOIN()

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

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

Parameters
array$tables( [alias] => table )
array$use_indexSame as for select()
array$ignore_indexSame as for select()
array$join_condsSame as for select()
Returns
string

Definition at line 2630 of file Database.php.

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

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

◆ tableNameWithAlias()

Wikimedia\Rdbms\Database::tableNameWithAlias (   $table,
  $alias = false 
)
protected

Get an aliased table name.

This returns strings like "tableName AS newTableName" for aliased tables and "(SELECT * from tableA) newTablename" for subqueries (e.g. derived tables)

See also
Database::tableName()
Parameters
string | Subquery$tableTable name or object with a 'sql' field
string | bool$aliasTable alias (optional)
Returns
string SQL name for aliased table. Will not alias a table to its own name

Definition at line 2548 of file Database.php.

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

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

◆ tablePrefix()

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

Get/set the table prefix.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 547 of file Database.php.

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

◆ textFieldSize()

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

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

Parameters
string$table
string$field
Returns
int

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 2994 of file Database.php.

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

◆ timestamp()

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

Convert a timestamp in one of the formats accepted by 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\IDatabase.

Definition at line 4235 of file Database.php.

References $t.

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

◆ 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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4241 of file Database.php.

References Wikimedia\Rdbms\Database\timestamp().

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

Referenced by Wikimedia\Rdbms\Database\__destruct(), Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\beginIfImplied(), Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\currentAtomicSectionId(), Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema(), Wikimedia\Rdbms\Database\doCommit(), Wikimedia\Rdbms\Database\doRollback(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\explicitTrxActive(), Wikimedia\Rdbms\Database\flushSnapshot(), Wikimedia\Rdbms\Database\getRecordedTransactionLagStatus(), Wikimedia\Rdbms\Database\getScopedLockAndFlush(), Wikimedia\Rdbms\Database\lockForUpdate(), Wikimedia\Rdbms\Database\onAtomicSectionCancel(), Wikimedia\Rdbms\Database\onTransactionCommitOrIdle(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), Wikimedia\Rdbms\Database\onTransactionResolution(), Wikimedia\Rdbms\Database\pendingWriteCallers(), Wikimedia\Rdbms\Database\pendingWriteQueryDuration(), Wikimedia\Rdbms\Database\preCommitCallbacksPending(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\LoadBalancer\runMasterTransactionIdleCallbacks(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), Wikimedia\Rdbms\Database\startAtomic(), Wikimedia\Rdbms\Database\trxTimestamp(), Wikimedia\Rdbms\Database\writesOrCallbacksPending(), and Wikimedia\Rdbms\Database\writesPending().

◆ trxStatus()

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

References Wikimedia\Rdbms\Database\trxLevel().

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

◆ unionConditionPermutations()

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

Construct a UNION query for permutations of conditions.

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

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3214 of file Database.php.

References Wikimedia\Rdbms\Database\limitResult(), Wikimedia\Rdbms\Database\makeOrderBy(), Wikimedia\Rdbms\Database\selectSQLText(), Wikimedia\Rdbms\Database\unionQueries(), and Wikimedia\Rdbms\Database\unionSupportsOrderAndLimit().

◆ unionQueries()

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

Construct a UNION query.

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

Parameters
array$sqlsSQL statements to combine
bool$allEither IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT
Returns
string SQL fragment

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3208 of file Database.php.

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

◆ unionSupportsOrderAndLimit()

Wikimedia\Rdbms\Database::unionSupportsOrderAndLimit ( )

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

Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3204 of file Database.php.

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

◆ unlock()

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

Release a lock.

Named locks are not related to transactions

Parameters
string$lockNameName of lock to release
string$methodName of the calling method
Returns
bool Success
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 4665 of file Database.php.

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

◆ unlockTables()

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

Unlock all tables locked via lockTables()

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

Parameters
string$methodThe caller
Returns
bool
Since
1.29

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 4739 of file Database.php.

References Wikimedia\Rdbms\Database\doUnlockTables(), Wikimedia\Rdbms\Database\endAtomic(), and Wikimedia\Rdbms\Database\tableLocksHaveTransactionScope().

◆ update()

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

UPDATE wrapper.

Takes a condition array and a SET array.

Parameters
string$tableName of the table to UPDATE. This will be passed through Database::tableName().
array$valuesAn array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by IDatabase::addQuotes(). Values with integer keys form unquoted SET statements, which can be used for things like "field = field + 1" or similar computed values.
array | string$condsAn array of conditions (WHERE). See IDatabase::select() for the details of the format of condition arrays. Use '*' to update all rows.
string$fnameThe function name of the caller (from METHOD), for logging and profiling.
array$optionsAn array of UPDATE options, can be:
  • IGNORE: Ignore unique key conflicts
Returns
bool Return true if no exception was thrown (deprecated since 1.33)
Exceptions
DBErrorIf an error occurs, see IDatabase::query()

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2176 of file Database.php.

References LIST_AND, LIST_SET, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\makeUpdateOptions(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().

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

◆ updateTrxWriteQueryTime()

Wikimedia\Rdbms\Database::updateTrxWriteQueryTime (   $sql,
  $runtime,
  $affected 
)
private

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

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

Parameters
string$sqlA SQL write query
float$runtimeTotal runtime, including RTT
int$affectedAffected row count

Definition at line 1379 of file Database.php.

References Wikimedia\Rdbms\Database\affectedRows(), and Wikimedia\Rdbms\Database\getQueryVerb().

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

◆ upsert()

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

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

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

$rows may be either:

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

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

Parameters
string$tableTable name. This will be passed through Database::tableName().
array$rowsA single row or list of rows to insert
array[]|string[]|string$uniqueIndexes All unique indexes. One of the following: a) the one unique field in the table (when no composite unique key exist) b) a list of all unique fields in the table (when no composite unique key exist) c) a list of all unique indexes in the table (each as a list of the indexed fields)
array$setAn array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by IDatabase::addQuotes(). Values with integer keys form unquoted SET statements, which can be used for things like "field = field + 1" or similar computed values.
string$fnameCalling function name (use METHOD) for logs/profiling
Returns
bool Return true if no exception was thrown (deprecated since 1.33)
Exceptions
DBErrorIf an error occurs, see IDatabase::query()
Since
1.22

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 2926 of file Database.php.

References Wikimedia\Rdbms\Database\$affectedRowCount, Wikimedia\Rdbms\Database\affectedRows(), Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\insert(), LIST_AND, LIST_OR, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\startAtomic(), and Wikimedia\Rdbms\Database\update().

◆ useIndexClause()

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

USE INDEX clause.

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

Parameters
string$index
Returns
string

Definition at line 2823 of file Database.php.

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

◆ wasConnectionError()

Wikimedia\Rdbms\Database::wasConnectionError (   $errno)

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

Definition at line 3331 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\getQueryExceptionAndLog(), and Wikimedia\Rdbms\Database\wasConnectionLoss().

◆ wasConnectionLoss()

Wikimedia\Rdbms\Database::wasConnectionLoss ( )

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

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

Returns
bool
Since
1.31

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3309 of file Database.php.

References Wikimedia\Rdbms\IDatabase\lastErrno(), and Wikimedia\Rdbms\Database\wasConnectionError().

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

◆ wasDeadlock()

Wikimedia\Rdbms\Database::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

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

Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3301 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\deadlockLoop(), and Wikimedia\Rdbms\Database\wasErrorReissuable().

◆ wasErrorReissuable()

Wikimedia\Rdbms\Database::wasErrorReissuable ( )

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

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

Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3317 of file Database.php.

References Wikimedia\Rdbms\Database\wasConnectionLoss(), Wikimedia\Rdbms\Database\wasDeadlock(), and Wikimedia\Rdbms\Database\wasLockTimeout().

◆ wasKnownStatementRollbackError()

Wikimedia\Rdbms\Database::wasKnownStatementRollbackError ( )
protected
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 foriegn key violations
Since
1.31

Definition at line 3341 of file Database.php.

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

◆ wasLockTimeout()

Wikimedia\Rdbms\Database::wasLockTimeout ( )

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

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

Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3305 of file Database.php.

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

◆ wasQueryTimeout()

Wikimedia\Rdbms\Database::wasQueryTimeout (   $error,
  $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
string$errorError text
int$errnoError number
Returns
bool

Definition at line 1554 of file Database.php.

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

◆ wasReadOnlyError()

Wikimedia\Rdbms\Database::wasReadOnlyError ( )

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

Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 3313 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\IDatabase.

Definition at line 640 of file Database.php.

References Wikimedia\Rdbms\Database\$trxSectionCancelCallbacks, and Wikimedia\Rdbms\Database\trxLevel().

Referenced by Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\flushSnapshot(), Wikimedia\Rdbms\Database\getScopedLockAndFlush(), and Wikimedia\Rdbms\Database\lockTables().

◆ writesPending()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 636 of file Database.php.

References Wikimedia\Rdbms\Database\$trxDoneWrites, and Wikimedia\Rdbms\Database\trxLevel().

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

Member Data Documentation

◆ $affectedRowCount

integer null Wikimedia\Rdbms\Database::$affectedRowCount
protected

◆ $agent

string Wikimedia\Rdbms\Database::$agent
protected

Agent name for query profiling.

Definition at line 83 of file Database.php.

◆ $cliMode

bool Wikimedia\Rdbms\Database::$cliMode
protected

Whether this PHP instance is for a CLI script.

Definition at line 81 of file Database.php.

◆ $conn

◆ $connectionParams

array Wikimedia\Rdbms\Database::$connectionParams
protected

Parameters used by initConnection() to establish a connection.

Definition at line 85 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 87 of file Database.php.

◆ $connLogger

LoggerInterface Wikimedia\Rdbms\Database::$connLogger
protected

Definition at line 53 of file Database.php.

◆ $currentDomain

DatabaseDomain Wikimedia\Rdbms\Database::$currentDomain
protected

Definition at line 66 of file Database.php.

◆ $DBO_MUTABLE

int Wikimedia\Rdbms\Database::$DBO_MUTABLE
staticprotected
Initial value:

Bit field of all DBO_* flags that can be changed after connection.

Definition at line 234 of file Database.php.

◆ $DEADLOCK_DELAY_MAX

int Wikimedia\Rdbms\Database::$DEADLOCK_DELAY_MAX = 1500000
staticprivate

Maximum time to wait before retry.

Definition at line 212 of file Database.php.

◆ $DEADLOCK_DELAY_MIN

int Wikimedia\Rdbms\Database::$DEADLOCK_DELAY_MIN = 500000
staticprivate

Minimum time to wait before retry, in microseconds.

Definition at line 210 of file Database.php.

◆ $DEADLOCK_TRIES

int Wikimedia\Rdbms\Database::$DEADLOCK_TRIES = 4
staticprivate

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

Definition at line 208 of file Database.php.

◆ $delimiter

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

Current SQL query delimiter.

Definition at line 96 of file Database.php.

Referenced by Wikimedia\Rdbms\DatabasePostgres\buildGroupConcatField(), and Wikimedia\Rdbms\Database\sourceStream().

◆ $deprecationLogger

callable Wikimedia\Rdbms\Database::$deprecationLogger
protected

Deprecation logging callback.

Definition at line 59 of file Database.php.

◆ $errorLogger

callable Wikimedia\Rdbms\Database::$errorLogger
protected

◆ $flags

◆ $htmlErrors

string bool null Wikimedia\Rdbms\Database::$htmlErrors
private

Stashed value of html_errors INI setting.

Definition at line 105 of file Database.php.

◆ $indexAliases

string [] Wikimedia\Rdbms\Database::$indexAliases = []
protected

Current map of (index alias => index)

Definition at line 100 of file Database.php.

◆ $lastPhpError

string bool Wikimedia\Rdbms\Database::$lastPhpError = false
private

Definition at line 173 of file Database.php.

◆ $lastPing

float Wikimedia\Rdbms\Database::$lastPing = 0.0
private

UNIX timestamp.

Definition at line 167 of file Database.php.

◆ $lastQuery

string Wikimedia\Rdbms\Database::$lastQuery = ''
private

The last SQL query attempted.

Definition at line 169 of file Database.php.

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

◆ $lastRoundTripEstimate

float Wikimedia\Rdbms\Database::$lastRoundTripEstimate = 0.0
private

Query rount trip time estimate.

Definition at line 175 of file Database.php.

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

◆ $lastWriteTime

float bool Wikimedia\Rdbms\Database::$lastWriteTime = false
private

UNIX timestamp of last write query.

Definition at line 171 of file Database.php.

◆ $lazyMasterHandle

IDatabase null Wikimedia\Rdbms\Database::$lazyMasterHandle
private

Lazy handle to the master DB this server replicates from.

Definition at line 72 of file Database.php.

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

◆ $lbInfo

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

Current LoadBalancer tracking information.

Definition at line 94 of file Database.php.

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

◆ $MUTABLE_FLAGS

string [] Wikimedia\Rdbms\Database::$MUTABLE_FLAGS
staticprotected
Initial value:
= [
'DBO_DEBUG',
'DBO_NOBUFFER',
'DBO_TRX',
'DBO_DDLMODE',
]

List of DBO_* flags that can be changed after connection.

Definition at line 227 of file Database.php.

◆ $nonNativeInsertSelectBatchSize

int Wikimedia\Rdbms\Database::$nonNativeInsertSelectBatchSize
protected

Row batch size to use for emulated INSERT SELECT queries.

Definition at line 89 of file Database.php.

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

◆ $NOT_APPLICABLE

string Wikimedia\Rdbms\Database::$NOT_APPLICABLE = 'n/a'
staticprivate

Idiom used when a cancelable atomic section started the transaction.

Definition at line 198 of file Database.php.

◆ $ownerId

int null Wikimedia\Rdbms\Database::$ownerId
private

Integer ID of the managing LBFactory instance or null if none.

Definition at line 178 of file Database.php.

◆ $password

string Wikimedia\Rdbms\Database::$password
protected

Password used to establish the current connection.

Definition at line 79 of file Database.php.

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

◆ $PING_QUERY

string Wikimedia\Rdbms\Database::$PING_QUERY = 'SELECT 1 AS ping'
staticprivate

Dummy SQL query.

Definition at line 217 of file Database.php.

◆ $PING_TTL

int Wikimedia\Rdbms\Database::$PING_TTL = 1.0
staticprivate

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

Definition at line 215 of file Database.php.

◆ $priorFlags

int [] Wikimedia\Rdbms\Database::$priorFlags = []
private

Prior flags member variable values.

Definition at line 107 of file Database.php.

◆ $profiler

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

Definition at line 61 of file Database.php.

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

◆ $queryLogger

LoggerInterface Wikimedia\Rdbms\Database::$queryLogger
protected

Definition at line 55 of file Database.php.

◆ $SAVEPOINT_PREFIX

string Wikimedia\Rdbms\Database::$SAVEPOINT_PREFIX = 'wikimedia_rdbms_atomic'
staticprivate

Prefix to the atomic section counter used to make savepoint IDs.

Definition at line 200 of file Database.php.

◆ $schemaVars

array null Wikimedia\Rdbms\Database::$schemaVars
protected

Current variables use for schema element placeholders.

Definition at line 102 of file Database.php.

◆ $server

string Wikimedia\Rdbms\Database::$server
protected

Server that this instance is currently connected to.

Definition at line 75 of file Database.php.

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

◆ $sessionNamedLocks

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

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

Definition at line 110 of file Database.php.

◆ $sessionTempTables

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

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

Definition at line 112 of file Database.php.

◆ $SLOW_WRITE_SEC

float Wikimedia\Rdbms\Database::$SLOW_WRITE_SEC = 0.500
staticprivate

Consider a write slow if it took more than this many seconds.

Definition at line 222 of file Database.php.

◆ $SMALL_WRITE_ROWS

float Wikimedia\Rdbms\Database::$SMALL_WRITE_ROWS = 100
staticprivate

Assume an insert of this many rows or less should be fast to replicate.

Definition at line 224 of file Database.php.

◆ $srvCache

BagOStuff Wikimedia\Rdbms\Database::$srvCache
protected

◆ $tableAliases

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

Current map of (table => (dbname, schema, prefix) map)

Definition at line 98 of file Database.php.

◆ $TEMP_NORMAL

int Wikimedia\Rdbms\Database::$TEMP_NORMAL = 1
staticprivate

Writes to this temporary table do not affect lastDoneWrites()

Definition at line 203 of file Database.php.

◆ $TEMP_PSEUDO_PERMANENT

int Wikimedia\Rdbms\Database::$TEMP_PSEUDO_PERMANENT = 2
staticprivate

Writes to this temporary table effect lastDoneWrites()

Definition at line 205 of file Database.php.

◆ $TINY_WRITE_SEC

float Wikimedia\Rdbms\Database::$TINY_WRITE_SEC = 0.010
staticprivate

Guess of how many seconds it takes to replicate a small insert.

Definition at line 220 of file Database.php.

◆ $trxAtomicCounter

int Wikimedia\Rdbms\Database::$trxAtomicCounter = 0
private

Counter for atomic savepoint identifiers (reset with each transaction)

Definition at line 133 of file Database.php.

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

◆ $trxAtomicLevels

array Wikimedia\Rdbms\Database::$trxAtomicLevels = []
private

List of (name, unique ID, savepoint ID) for each active atomic section level.

Definition at line 135 of file Database.php.

◆ $trxAutomatic

bool Wikimedia\Rdbms\Database::$trxAutomatic = false
private

Whether the current transaction was started implicitly due to DBO_TRX.

Definition at line 131 of file Database.php.

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

◆ $trxAutomaticAtomic

bool Wikimedia\Rdbms\Database::$trxAutomaticAtomic = false
private

Whether the current transaction was started implicitly by startAtomic()

Definition at line 137 of file Database.php.

◆ $trxDoneWrites

bool Wikimedia\Rdbms\Database::$trxDoneWrites = false
private

Whether possible write queries were done in the last transaction started.

Definition at line 129 of file Database.php.

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

◆ $trxEndCallbacks

array [] Wikimedia\Rdbms\Database::$trxEndCallbacks = []
private

List of (callable, method name, atomic section id)

Definition at line 155 of file Database.php.

◆ $trxEndCallbacksSuppressed

bool Wikimedia\Rdbms\Database::$trxEndCallbacksSuppressed = false
private

Whether to suppress triggering of transaction end callbacks.

Definition at line 161 of file Database.php.

◆ $trxFname

string Wikimedia\Rdbms\Database::$trxFname = null
private

Name of the function that start the last transaction.

Definition at line 127 of file Database.php.

◆ $trxIdleCallbacks

array [] Wikimedia\Rdbms\Database::$trxIdleCallbacks = []
private

List of (callable, method name, atomic section id)

Definition at line 151 of file Database.php.

◆ $trxPreCommitCallbacks

array [] Wikimedia\Rdbms\Database::$trxPreCommitCallbacks = []
private

List of (callable, method name, atomic section id)

Definition at line 153 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\preCommitCallbacksPending(), and Wikimedia\Rdbms\Database\runOnTransactionPreCommitCallbacks().

◆ $trxProfiler

TransactionProfiler Wikimedia\Rdbms\Database::$trxProfiler
protected

Definition at line 63 of file Database.php.

◆ $trxRecurringCallbacks

callable [] Wikimedia\Rdbms\Database::$trxRecurringCallbacks = []
private

Map of (name => callable)

Definition at line 159 of file Database.php.

◆ $trxReplicaLag

float Wikimedia\Rdbms\Database::$trxReplicaLag = null
private

Replication lag estimate at the time of BEGIN for the last transaction.

Definition at line 125 of file Database.php.

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

◆ $trxSectionCancelCallbacks

array [] Wikimedia\Rdbms\Database::$trxSectionCancelCallbacks = []
private

List of (callable, method name, atomic section id)

Definition at line 157 of file Database.php.

Referenced by Wikimedia\Rdbms\Database\runOnAtomicSectionCancelCallbacks(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().

◆ $trxShortId

string Wikimedia\Rdbms\Database::$trxShortId = ''
private

ID of the active transaction or the empty string otherwise.

Definition at line 115 of file Database.php.

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

◆ $trxStatus

int Wikimedia\Rdbms\Database::$trxStatus = self::STATUS_TRX_NONE
private

Transaction status.

Definition at line 117 of file Database.php.

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

◆ $trxStatusCause

Exception null Wikimedia\Rdbms\Database::$trxStatusCause
private

The last error that caused the status to become STATUS_TRX_ERROR.

Definition at line 119 of file Database.php.

◆ $trxStatusIgnoredCause

array null Wikimedia\Rdbms\Database::$trxStatusIgnoredCause
private

Error details of the last statement-only rollback.

Definition at line 121 of file Database.php.

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

◆ $trxTimestamp

float null Wikimedia\Rdbms\Database::$trxTimestamp = null
private

UNIX timestamp at the time of BEGIN for the last transaction.

Definition at line 123 of file Database.php.

◆ $trxWriteAdjDuration

float Wikimedia\Rdbms\Database::$trxWriteAdjDuration = 0.0
private

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

Definition at line 147 of file Database.php.

◆ $trxWriteAdjQueryCount

int Wikimedia\Rdbms\Database::$trxWriteAdjQueryCount = 0
private

Number of write queries counted in trxWriteAdjDuration.

Definition at line 149 of file Database.php.

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

◆ $trxWriteAffectedRows

int Wikimedia\Rdbms\Database::$trxWriteAffectedRows = 0
private

Number of rows affected by write queries for the current transaction.

Definition at line 145 of file Database.php.

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

◆ $trxWriteCallers

string [] Wikimedia\Rdbms\Database::$trxWriteCallers = []
private

Write query callers of the current transaction.

Definition at line 139 of file Database.php.

◆ $trxWriteDuration

float Wikimedia\Rdbms\Database::$trxWriteDuration = 0.0
private

Seconds spent in write queries for the current transaction.

Definition at line 141 of file Database.php.

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

◆ $trxWriteQueryCount

int Wikimedia\Rdbms\Database::$trxWriteQueryCount = 0
private

Number of write queries for the current transaction.

Definition at line 143 of file Database.php.

◆ $user

string Wikimedia\Rdbms\Database::$user
protected

User that this instance is currently connected under the name of.

Definition at line 77 of file Database.php.

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


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