Relational database abstraction object. More...
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
Constructor & Destructor Documentation
◆ __construct()
| Wikimedia\Rdbms\Database::__construct | ( | array | $params | ) |
- Note
- exceptions for missing libraries/drivers should be thrown in initConnection()
- Parameters
-
array $params Parameters passed from Database::factory()
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
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 4917 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 4880 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 4909 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 4856 of file Database.php.
References Wikimedia\Rdbms\IDatabase\getType().
◆ addIdentifierQuotes()
| Wikimedia\Rdbms\Database::addIdentifierQuotes | ( | $s | ) |
Escape a SQL identifier (e.g.
table, column, database) for use in a SQL query
Depending on the database this will either be backticks or "double quotes"
- Parameters
-
string $s
- Returns
- string
- Since
- 1.33
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2747 of file Database.php.
References $s.
Referenced by Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema(), Wikimedia\Rdbms\Database\doReleaseSavepoint(), Wikimedia\Rdbms\Database\doRollbackToSavepoint(), Wikimedia\Rdbms\Database\doSavepoint(), Wikimedia\Rdbms\DatabasePostgres\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseSqlite\duplicateTableStructure(), Wikimedia\Rdbms\Database\fieldNameWithAlias(), Wikimedia\Rdbms\DatabasePostgres\open(), Wikimedia\Rdbms\Database\prependDatabaseOrSchema(), Wikimedia\Rdbms\Database\replaceVars(), Wikimedia\Rdbms\DatabaseSqlite\resetSequenceForTable(), Wikimedia\Rdbms\DatabasePostgres\selectSQLText(), Wikimedia\Rdbms\Database\tableName(), and Wikimedia\Rdbms\Database\tableNameWithAlias().
◆ 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.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2730 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 4250 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.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 2290 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 2802 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 2806 of file Database.php.
◆ assertBuildSubstringParams()
|
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 2339 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\buildSubstring(), and Wikimedia\Rdbms\Database\buildSubstring().
◆ 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()
|
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\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 1436 of file Database.php.
References Wikimedia\Rdbms\Database\explicitTrxActive(), and Wikimedia\Rdbms\Database\flatAtomicSectionList().
◆ assertQueryIsCurrentlyAllowed()
|
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 1409 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()
|
staticfinal |
- Parameters
-
string $dbType A possible DB type (sqlite, mysql, postgres,...) string | null $driver Optional 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.
References Wikimedia\Rdbms\Database\getClass().
Referenced by Wikimedia\Rdbms\LoadBalancer\getServerAttributes().
◆ begin()
|
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 $fname Calling function name string $mode A situationally valid IDatabase::TRANSACTION_* constant [optional]
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3977 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()
|
private |
Start an implicit transaction if DBO_TRX is enabled and no transaction is active.
- Parameters
-
string $sql string $fname
Definition at line 1357 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 2298 of file Database.php.
◆ bitNot()
| Wikimedia\Rdbms\Database::bitNot | ( | $field | ) |
- Parameters
-
string $field
- Returns
- string
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2294 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 2302 of file Database.php.
◆ bufferResults()
| Wikimedia\Rdbms\Database::bufferResults | ( | $buffer = null | ) |
Backwards-compatibility no-op method for disabling query buffering.
- Parameters
-
null | bool $buffer Whether 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.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2306 of file Database.php.
◆ buildGroupConcatField()
| Wikimedia\Rdbms\Database::buildGroupConcatField | ( | $delim, | |
| $table, | |||
| $field, | |||
$conds = '', |
|||
$join_conds = [] |
|||
| ) |
Build a GROUP_CONCAT or equivalent statement for a query.
This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.
- Parameters
-
string $delim Glue to bind the results together string | array $table Table name string $field Field name string | array $conds Conditions string | array $join_conds Join conditions
- Returns
- string SQL text
- Since
- 1.23
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2310 of file Database.php.
References Wikimedia\Rdbms\Database\addQuotes(), and Wikimedia\Rdbms\Database\selectSQLText().
◆ buildIntegerCast()
| Wikimedia\Rdbms\Database::buildIntegerCast | ( | $field | ) |
- Parameters
-
string $field Field or column to cast
- Returns
- string
- Since
- 1.31
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2358 of file Database.php.
◆ buildLike()
| Wikimedia\Rdbms\Database::buildLike | ( | $param, | |
| $params | |||
| ) |
Definition at line 2775 of file Database.php.
References $s, Wikimedia\Rdbms\Database\addQuotes(), and Wikimedia\Rdbms\Database\escapeLikeInternal().
◆ 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 $table Table name string | array $vars Field names string | array $conds Conditions string $fname Caller function name string | array $options Query options string | array $join_conds Join conditions
- Returns
- Subquery
- Since
- 1.31
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2362 of file Database.php.
References Wikimedia\Rdbms\Database\selectSQLText().
Referenced by Wikimedia\Rdbms\Database\selectRowCount().
◆ buildStringCast()
| Wikimedia\Rdbms\Database::buildStringCast | ( | $field | ) |
- Parameters
-
string $field Field or column to cast
- Returns
- string
- Since
- 1.28
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2352 of file Database.php.
◆ buildSubstring()
| Wikimedia\Rdbms\Database::buildSubstring | ( | $input, | |
| $startPosition, | |||
$length = null |
|||
| ) |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2318 of file Database.php.
References Wikimedia\Rdbms\Database\assertBuildSubstringParams().
◆ cancelAtomic()
|
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 $sectionId Section ID from startAtomic(); passing this enables cancellation of unclosed nested sections [optional]
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3876 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()
|
private |
Determine whether it is safe to retry queries after a database connection is lost.
- Parameters
-
string $sql SQL query bool $priorWritesPending Whether there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish.
- Returns
- bool True if it is safe to retry the query, false otherwise
Definition at line 1455 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 $flag One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX) string $remember IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 758 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().
◆ close()
|
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 $fname Caller name int | null $owner ID 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()
|
abstractprotected |
Closes underlying database connection.
- Since
- 1.20
- Returns
- bool Whether connection was closed successfully
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqli.
Referenced by Wikimedia\Rdbms\Database\__destruct(), Wikimedia\Rdbms\Database\close(), and Wikimedia\Rdbms\Database\replaceLostConnection().
◆ commit()
|
final |
Commits a transaction previously started using begin()
If no transaction is in progress, a warning is issued.
Only call this from code with outer transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.
- Parameters
-
string $fname string $flush Flush flag, set to situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly committing implicit transactions, or calling commit when no transaction is in progress. This will trigger an exception if there is an ongoing explicit transaction. Only set the flush flag if you are sure that these warnings are not applicable, and no explicit transactions are open.
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4040 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 $cond SQL expression which will result in a boolean value string $trueVal SQL expression to return if true string $falseVal SQL expression to return if false
- Returns
- string SQL fragment
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3286 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()
|
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 1538 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()
|
private |
- Returns
- AtomicSectionIdentifier|null ID of the topmost atomic section level
Definition at line 3457 of file Database.php.
References Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\onAtomicSectionCancel(), Wikimedia\Rdbms\Database\onTransactionCommitOrIdle(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), and Wikimedia\Rdbms\Database\onTransactionResolution().
◆ databasesAreIndependent()
| Wikimedia\Rdbms\Database::databasesAreIndependent | ( | ) |
Returns true if DBs are assumed to be on potentially different servers.
In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as fully separate, only allowing mechanisms like postgres_fdw to effectively "mount" foreign DBs. This is true even among DBs on the same server.
- Returns
- bool
- Since
- 1.29
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 2371 of file Database.php.
◆ dbSchema()
| Wikimedia\Rdbms\Database::dbSchema | ( | $schema = null | ) |
Get/set the db schema.
- Parameters
-
string | null $schema The database schema to set, or omitted to leave it unchanged
- Returns
- string The previous db schema
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 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.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3346 of file Database.php.
References $args, Wikimedia\Rdbms\Database\$DEADLOCK_TRIES, 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.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4443 of file Database.php.
◆ decodeExpiry()
| Wikimedia\Rdbms\Database::decodeExpiry | ( | $expiry, | |
$format = TS_MW |
|||
| ) |
Decode an expiry time into a DBMS independent format.
- Parameters
-
string $expiry DB timestamp field value for expiry int $format TS_* constant, defaults to TS_MW
- Returns
- string
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4786 of file Database.php.
References Wikimedia\Rdbms\Database\getInfinity().
◆ delete()
| Wikimedia\Rdbms\Database::delete | ( | $table, | |
| $conds, | |||
$fname = __METHOD__ |
|||
| ) |
DELETE query wrapper.
- Parameters
-
string $table Table name string | array $conds Array of conditions. See $conds in IDatabase::select() for the format. Use $conds == "*" to delete all rows string $fname Name of the calling function
- Returns
- bool Return true if no exception was thrown (deprecated since 1.33)
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3012 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 $delTable The table to delete from. string $joinTable The other table. string $delVar The variable to join on, in the first table. string $joinVar The variable to join on, in the second table. array | string $conds Condition array of field names mapped to variables, ANDed together in the WHERE clause string $fname Calling function name (use METHOD) for logs/profiling
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2977 of file Database.php.
References LIST_AND, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
◆ doAtomicSection()
|
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:
Example usage, caller of the "RecordStore::save" method:
- Parameters
-
string $fname Caller name (usually METHOD) callable $callback Callback that issues DB updates string $cancelable Pass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section.
- Returns
- mixed $res Result of the callback (since 1.28)
- Exceptions
-
DBError If an error occurs, see IDatabase::query() Exception If 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 3961 of file Database.php.
References $res, Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), and Wikimedia\Rdbms\Database\startAtomic().
◆ doBegin()
|
protected |
Issues the BEGIN command to the database server.
- See also
- Database::begin()
- Parameters
-
string $fname
- Exceptions
-
DBError
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4036 of file Database.php.
References Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\begin().
◆ doCommit()
|
protected |
Issues the COMMIT command to the database server.
- See also
- Database::commit()
- Parameters
-
string $fname
- Exceptions
-
DBError
Definition at line 4109 of file Database.php.
References Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\commit().
◆ doGetLag()
|
protected |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4431 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getLag().
◆ doHandleSessionLossPreconnect()
|
protected |
Reset any additional subclass trx* and session* fields.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1510 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\handleSessionLossPreconnect().
◆ 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()
|
protected |
Helper function for lockTables() that handles the actual table locking.
- Parameters
-
array $read Array of tables to lock for read access array $write Array of tables to lock for write access string $method Name of caller
- Returns
- true
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4736 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\lockTables().
◆ doQuery()
|
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 $sql SQL query
- Returns
- mixed|bool An object, resource, or true on success; false on failure
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqli.
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt().
◆ doReleaseSavepoint()
|
protected |
Release a savepoint.
This is used internally to implement atomic sections. It should not be used otherwise.
- Since
- 1.31
- Parameters
-
string $identifier Identifier for the savepoint string $fname Calling function name
Definition at line 3775 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\endAtomic().
◆ doRollback()
|
protected |
Issues the ROLLBACK command to the database server.
- See also
- Database::rollback()
- Parameters
-
string $fname
- Exceptions
-
DBError
Definition at line 4178 of file Database.php.
References Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\rollback().
◆ doRollbackToSavepoint()
|
protected |
Rollback to a savepoint.
This is used internally to implement atomic sections. It should not be used otherwise.
- Since
- 1.31
- Parameters
-
string $identifier Identifier for the savepoint string $fname Calling function name
Definition at line 3789 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\cancelAtomic().
◆ doSavepoint()
|
protected |
Create a savepoint.
This is used internally to implement atomic sections. It should not be used otherwise.
- Since
- 1.31
- Parameters
-
string $identifier Identifier for the savepoint string $fname Calling function name
Definition at line 3761 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\startAtomic().
◆ doSelectDomain()
|
protected |
- Parameters
-
DatabaseDomain $domain
- Exceptions
-
DBConnectionError DBError
- Since
- 1.32
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 2395 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\selectDomain().
◆ doUnlockTables()
|
protected |
Helper function for unlockTables() that handles the actual table unlocking.
- Parameters
-
string $method Name of caller
- Returns
- true
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4756 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.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4767 of file Database.php.
References Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\tableExists(), and Wikimedia\Rdbms\Database\tableName().
◆ duplicateTableStructure()
| Wikimedia\Rdbms\Database::duplicateTableStructure | ( | $oldName, | |
| $newName, | |||
$temporary = false, |
|||
$fname = __METHOD__ |
|||
| ) |
Creates a new table with structure copied from existing table.
Note that unlike most database abstraction functions, this function does not automatically append database prefix, because it works at a lower abstraction level. The table names passed to this function shall not be quoted (this function calls addIdentifierQuotes() when needed).
- Parameters
-
string $oldName Name of table whose structure should be copied string $newName Name of table to be created bool $temporary Whether the new table should be temporary string $fname Calling function name
- Returns
- bool True if operation was successful
- Exceptions
-
RuntimeException
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 4222 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.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4439 of file Database.php.
◆ encodeExpiry()
| Wikimedia\Rdbms\Database::encodeExpiry | ( | $expiry | ) |
Encode an expiry time into the DBMS dependent format.
- Parameters
-
string $expiry Timestamp for expiry, or the 'infinity' string
- Returns
- string
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4780 of file Database.php.
References Wikimedia\Rdbms\Database\getInfinity(), and Wikimedia\Rdbms\Database\timestamp().
◆ endAtomic()
|
final |
Ends an atomic section of SQL statements.
Ends the next section of atomic SQL statements and commits the transaction if necessary.
- Since
- 1.23
- See also
- IDatabase::startAtomic
- Parameters
-
string $fname
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3842 of file Database.php.
References Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\currentAtomicSectionId(), Wikimedia\Rdbms\Database\doReleaseSavepoint(), Wikimedia\Rdbms\Database\reassignCallbacksForSection(), and Wikimedia\Rdbms\Database\trxLevel().
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(), Wikimedia\Rdbms\Database\unlockTables(), and Wikimedia\Rdbms\Database\upsert().
◆ escapeLikeInternal()
|
protected |
- Parameters
-
string $s string $escapeChar
- Returns
- string
Definition at line 2769 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 $table Table name string $var Column for which NULL values are not counted [default "*"] array | string $conds Filters on the table string $fname Function name for profiling array $options Options for select array | string $join_conds Join conditions
- Returns
- int Row count
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1911 of file Database.php.
References $res, Wikimedia\Rdbms\Database\extractSingleFieldFromList(), Wikimedia\Rdbms\IDatabase\fetchRow(), Wikimedia\Rdbms\Database\normalizeConditions(), and Wikimedia\Rdbms\Database\select().
◆ executeQuery()
|
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 $sql Original SQL query string $fname Name of the calling function int $flags Bit 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\$flags, Wikimedia\Rdbms\Database\$TEMP_NORMAL, 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(), and Wikimedia\Rdbms\Database\query().
◆ executeQueryAttempt()
|
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 $sql Original SQL query string $commentedSql SQL query with debugging/trace comment bool $isPermWrite Whether the query is a (non-temporary table) write string $fname Name of the calling function int $flags Bit 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 4218 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()
|
finalprotected |
- Returns
- string|null Column name or null; ignores aliases
- Exceptions
-
DBUnexpectedError Errors out if multiple columns are given
Definition at line 2028 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\estimateRowCount(), Wikimedia\Rdbms\DatabaseMysqlBase\estimateRowCount(), Wikimedia\Rdbms\Database\estimateRowCount(), and Wikimedia\Rdbms\Database\selectRowCount().
◆ factory()
|
staticfinal |
Construct a Database subclass instance given a database type and parameters.
This also connects to the database immediately upon object construction
- Parameters
-
string $type A possible DB type (sqlite, mysql, postgres,...) array $params Parameter map with keys: - host : The hostname of the DB server
- user : The name of the database user the client operates under
- password : The password for the database user
- dbname : The name of the database to use where queries do not specify one. The database must exist or an error might be thrown. Setting this to the empty string will avoid any such errors and make the handle have no implicit database scope. This is useful for queries like SHOW STATUS, CREATE DATABASE, or DROP DATABASE. Note that a "database" in Postgres is rougly equivalent to an entire MySQL server. This the domain in which user names and such are defined, e.g. users are database-specific in Postgres.
- schema : The database schema to use (if supported). A "schema" in Postgres is roughly equivalent to a "database" in MySQL. Note that MySQL and SQLite do not use schemas.
- tablePrefix : Optional table prefix that is implicitly added on to all table names recognized in queries. This can be used in place of schemas for handle site farms.
- flags : Optional 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 $connect One of the class constants (NEW_CONNECTED, NEW_UNCONNECTED) [optional]
- Returns
- Database|null If the database driver or extension cannot be found
- Exceptions
-
InvalidArgumentException If the database driver or extension cannot be found
- Since
- 1.18
Definition at line 370 of file Database.php.
References Wikimedia\Rdbms\Database\$conn, $type, and Wikimedia\Rdbms\Database\getClass().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\newStandaloneInstance(), and Wikimedia\Rdbms\LoadBalancer\reallyOpenConnection().
◆ fetchAffectedRowCount()
|
abstractprotected |
- Returns
- int Number of retrieved rows according to the driver
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqli.
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 $table Table name string $field Filed to check on that table string $fname Calling function name (optional)
- Returns
- bool Whether $table has filed $field
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2060 of file Database.php.
References Wikimedia\Rdbms\IMaintainableDatabase\fieldInfo().
◆ fieldHasBit()
|
finalprotected |
- Parameters
-
int $field int $flags
- Returns
- bool
- Since
- 1.34
Definition at line 4830 of file Database.php.
References Wikimedia\Rdbms\Database\$flags.
Referenced by Wikimedia\Rdbms\Database\executeQuery(), and Wikimedia\Rdbms\Database\query().
◆ fieldNamesWithAlias()
|
protected |
Gets an array of aliased field names.
- Parameters
-
array $fields [ [alias] => field ]
- Returns
- string[] See fieldNameWithAlias()
Definition at line 2609 of file Database.php.
References Wikimedia\Rdbms\Database\fieldNameWithAlias().
Referenced by Wikimedia\Rdbms\Database\selectSQLText().
◆ fieldNameWithAlias()
|
protected |
Get an aliased field name e.g.
fieldName AS newFieldName
- Parameters
-
string $name Field name string | bool $alias Alias (optional)
- Returns
- string SQL name for aliased field. Will not alias a field to its own name
Definition at line 2595 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes().
Referenced by Wikimedia\Rdbms\Database\fieldNamesWithAlias(), and Wikimedia\Rdbms\Database\nonNativeInsertSelect().
◆ flatAtomicSectionList()
|
private |
- Returns
- string
Definition at line 733 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\assertNoOpenTransactions(), Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\close(), and Wikimedia\Rdbms\Database\commit().
◆ 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 $fname Calling function name string $flush Flush flag, set to situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly committing implicit transactions, or calling commit when no transaction is in progress. This will trigger an exception if there is an ongoing explicit transaction. Only set the flush flag if you are sure that these warnings are not applicable, and no explicit transactions are open.
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
- Since
- 1.28
- 1.34 Added $flush parameter
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4186 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 $res A SQL result
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 1628 of file Database.php.
◆ getApproximateLagStatus()
|
protected |
Get a replica DB lag estimate for this server.
- Returns
- array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)
- Since
- 1.27
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4378 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()
|
staticprotected |
- Returns
- array Map of (Database::ATTR_* constant => value)
- Since
- 1.31
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 501 of file Database.php.
◆ getBindingHandle()
|
protected |
Get the underlying binding connection handle.
Makes sure the connection resource is set (disconnects and ping() failure can unset it). This catches broken callers than catch and ignore disconnection exceptions. Unlike checking isOpen(), this is safe to call inside of open().
- Returns
- mixed
- Exceptions
-
DBUnexpectedError
- Since
- 1.26
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMysqli.
Definition at line 4845 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 |
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
- 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 4404 of file Database.php.
Referenced by Revision\RevisionStore\getKnownCurrentRevision(), MediaWiki\Storage\NameTableStore\getName(), MediaWiki\Storage\NameTableStore\getTableFromCachesOrReplica(), MediaWiki\Block\DatabaseBlock\isWhitelistedFromAutoblocks(), and MediaWiki\Interwiki\ClassicInterwikiLookup\load().
◆ getClass()
|
staticprivate |
- Parameters
-
string $dbType A possible DB type (sqlite, mysql, postgres,...) string | null $driver Optional name of a specific DB client driver
- Returns
- string Database subclass name to use
- Exceptions
-
InvalidArgumentException
Definition at line 450 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\attributesFromType(), and Wikimedia\Rdbms\Database\factory().
◆ getDBname()
| Wikimedia\Rdbms\Database::getDBname | ( | ) |
Get the current DB name.
- Returns
- string|null
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2399 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\attachDatabasesFromTableAliases(), Wikimedia\Rdbms\Database\dbSchema(), Wikimedia\Rdbms\DatabasePostgres\doSelectDomain(), Wikimedia\Rdbms\DatabaseMysqlBase\doSelectDomain(), Wikimedia\Rdbms\DatabaseSqlite\doSelectDomain(), Wikimedia\Rdbms\DatabaseSqlite\getDbFilePath(), Wikimedia\Rdbms\Database\getLogContext(), Wikimedia\Rdbms\DatabaseMysqlBase\listViews(), and Wikimedia\Rdbms\LoadBalancer\runMasterTransactionIdleCallbacks().
◆ 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 4649 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.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\__construct(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\handleSessionLossPreconnect(), and Wikimedia\Rdbms\Database\rollback().
◆ getFlag()
| Wikimedia\Rdbms\Database::getFlag | ( | $flag | ) |
Returns a boolean whether the flag $flag is set for this connection.
- Parameters
-
int $flag One of the class IDatabase::DBO_* constants
- Returns
- bool
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 786 of file Database.php.
Referenced by Wikimedia\Rdbms\LoadBalancer\applyTransactionRoundFlags(), Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\beginIfImplied(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\getTransactionRoundId(), Wikimedia\Rdbms\Database\lockForUpdate(), Wikimedia\Rdbms\DatabaseMysqli\mysqlConnect(), Wikimedia\Rdbms\DatabasePostgres\open(), Wikimedia\Rdbms\DatabaseSqlite\open(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), Wikimedia\Rdbms\Database\startAtomic(), and Wikimedia\Rdbms\LoadBalancer\undoTransactionRoundFlags().
◆ 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 4776 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
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4421 of file Database.php.
References Wikimedia\Rdbms\Database\doGetLag(), and Wikimedia\Rdbms\Database\getLBInfo().
Referenced by Wikimedia\Rdbms\Database\getApproximateLagStatus().
◆ 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()
|
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()
| Wikimedia\Rdbms\Database::getLBInfo | ( | $name = null | ) |
Get properties passed down from the server info array of the load balancer.
- Parameters
-
string | null $name The entry of the info array to get, or null to get the whole array
- Returns
- array|mixed|null
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 585 of file Database.php.
References Wikimedia\Rdbms\Database\$lbInfo.
Referenced by Wikimedia\Rdbms\LoadBalancer\applyTransactionRoundFlags(), Wikimedia\Rdbms\Database\assertIsWritableMaster(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\getApproximateLagStatus(), Wikimedia\Rdbms\Database\getLag(), Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo(), Wikimedia\Rdbms\Database\getReadOnlyReason(), Wikimedia\Rdbms\Database\getTransactionRoundId(), Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait(), and Wikimedia\Rdbms\LoadBalancer\undoTransactionRoundFlags().
◆ getLogContext()
|
protected |
Create a log context to pass to PSR-3 logger functions.
- Parameters
-
array $extras Additional data to add to context
- Returns
- array
Definition at line 865 of file Database.php.
References Wikimedia\Rdbms\Database\getDBname().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromPtHeartbeat(), Wikimedia\Rdbms\Database\getQueryExceptionAndLog(), Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait(), Wikimedia\Rdbms\Database\newExceptionAfterConnectError(), and Wikimedia\Rdbms\DatabaseSqlite\open().
◆ getMasterPos()
| Wikimedia\Rdbms\Database::getMasterPos | ( | ) |
Get the position of this master.
- Returns
- DBMasterPos|bool False if this is not a master
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3392 of file Database.php.
◆ getQueryExceptionAndLog()
|
private |
- Parameters
-
string $error string | int $errno string $sql string $fname
- Returns
- DBError
Definition at line 1585 of file Database.php.
References Wikimedia\Rdbms\Database\getLogContext(), Wikimedia\Rdbms\Database\wasConnectionError(), and Wikimedia\Rdbms\Database\wasQueryTimeout().
Referenced by Wikimedia\Rdbms\Database\executeQuery(), and Wikimedia\Rdbms\Database\reportQueryError().
◆ getQueryVerb()
|
protected |
- Parameters
-
string $sql
- Returns
- string|null
Definition at line 1057 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\assertQueryIsCurrentlyAllowed(), Wikimedia\Rdbms\DatabaseSqlite\isTransactableQuery(), Wikimedia\Rdbms\Database\isTransactableQuery(), and Wikimedia\Rdbms\Database\updateTrxWriteQueryTime().
◆ getReadOnlyReason()
|
protected |
- Returns
- string|bool Reason this DB is read-only or false if it is not
Definition at line 4805 of file Database.php.
References Wikimedia\Rdbms\Database\getLBInfo().
Referenced by Wikimedia\Rdbms\Database\assertIsWritableMaster(), and Wikimedia\Rdbms\Database\isReadOnly().
◆ 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 4366 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
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3387 of file Database.php.
◆ 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 4637 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 $lockKey Name of lock to release string $fname Name of the calling method int $timeout Acquisition timeout in seconds
- Returns
- ScopedCallback|null
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
- Since
- 1.27
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4672 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()
| Wikimedia\Rdbms\Database::getServer | ( | ) |
Get the server hostname or IP address.
- Returns
- string
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2403 of file Database.php.
References Wikimedia\Rdbms\Database\$server.
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\DatabaseMysqlBase\getApproximateLagStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo(), Wikimedia\Rdbms\Database\replaceLostConnection(), and Wikimedia\Rdbms\LoadBalancer\runMasterTransactionIdleCallbacks().
◆ 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.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3298 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
-
DBError If an error occurs, see IDatabase::query()
- Since
- 1.27
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4349 of file Database.php.
References Wikimedia\Rdbms\Database\getApproximateLagStatus(), and Wikimedia\Rdbms\Database\getRecordedTransactionLagStatus().
◆ getTempWrites()
|
protected |
- Parameters
-
string $sql A SQL query bool $pseudoPermanent Treat 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, Wikimedia\Rdbms\Database\$TEMP_NORMAL, Wikimedia\Rdbms\Database\$TEMP_PSEUDO_PERMANENT, and $type.
Referenced by Wikimedia\Rdbms\Database\executeQuery().
◆ getTransactionRoundId()
|
finalprotected |
- Returns
- string|null
Definition at line 657 of file Database.php.
References DBO_TRX, Wikimedia\Rdbms\Database\getFlag(), and Wikimedia\Rdbms\Database\getLBInfo().
Referenced by Wikimedia\Rdbms\Database\flushSnapshot(), Wikimedia\Rdbms\Database\onTransactionCommitOrIdle(), and Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle().
◆ handleSessionLossPostconnect()
|
private |
Clean things up after session (and thus transaction) loss after reconnect.
Definition at line 1517 of file Database.php.
References Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), and Wikimedia\Rdbms\Database\runTransactionListenerCallbacks().
Referenced by Wikimedia\Rdbms\Database\replaceLostConnection().
◆ handleSessionLossPreconnect()
|
private |
Clean things up after session (and thus transaction) loss before reconnect.
Definition at line 1480 of file Database.php.
References Wikimedia\Rdbms\Database\consumeTrxShortId(), Wikimedia\Rdbms\Database\doHandleSessionLossPreconnect(), Wikimedia\Rdbms\Database\getDomainID(), and Wikimedia\Rdbms\Database\pendingWriteQueryDuration().
Referenced by Wikimedia\Rdbms\Database\__clone(), and Wikimedia\Rdbms\Database\replaceLostConnection().
◆ ignoreIndexClause()
| Wikimedia\Rdbms\Database::ignoreIndexClause | ( | $index | ) |
IGNORE INDEX clause.
Unlikely to be useful for anything but MySQL. This is only needed because a) MySQL must be as efficient as possible due to its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about which index to pick. Anyway, other databases might have different indexes on a given table. So don't bother overriding this unless you're MySQL.
- Parameters
-
string $index
- Returns
- string
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2838 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.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
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
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2066 of file Database.php.
References Wikimedia\Rdbms\Database\indexInfo(), and Wikimedia\Rdbms\Database\tableExists().
◆ indexInfo()
|
abstract |
Get information about an index into an object.
- Parameters
-
string $table Table name string $index Index name string $fname Calling function name
- Returns
- mixed Database-specific index description class or false if the index does not exist
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Referenced by Wikimedia\Rdbms\Database\indexExists(), and Wikimedia\Rdbms\Database\indexUnique().
◆ indexName()
|
protected |
Allows for index remapping in queries where this is not consistent across DBMS.
- Parameters
-
string $index
- Returns
- string
Definition at line 2726 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\ignoreIndexClause(), Wikimedia\Rdbms\DatabaseSqlite\indexInfo(), Wikimedia\Rdbms\DatabaseMysqlBase\indexInfo(), Wikimedia\Rdbms\DatabasePostgres\indexUnique(), Wikimedia\Rdbms\DatabaseSqlite\indexUnique(), Wikimedia\Rdbms\Database\replaceVars(), and Wikimedia\Rdbms\DatabaseMysqlBase\useIndexClause().
◆ 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 2081 of file Database.php.
References Wikimedia\Rdbms\Database\indexInfo().
◆ 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 $table Table name. This will be passed through Database::tableName(). array $a Array of rows to insert string $fname Calling function name (use METHOD) for logs/profiling array $options Array of options
- Returns
- bool Return true if no exception was thrown (deprecated since 1.33)
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2101 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()
|
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 $destTable The table name to insert into string | array $srcTable May be either a table name, or an array of table names to include in a join. array $varMap Must be an associative array of the form [ 'dest1' => 'source1', ... ]. Source items may be literals rather than field names, but strings should be quoted with IDatabase::addQuotes() array $conds Condition array. See $conds in IDatabase::select() for the details of the format of condition arrays. May be "*" to copy the whole table. string $fname The function name of the caller, from METHOD array $insertOptions Options for the INSERT part of the query, see IDatabase::insert() for details. 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 $selectOptions Options for the SELECT part of the query, see IDatabase::select() for details. array $selectJoinConds Join conditions for the SELECT part of the query, see IDatabase::select() for details.
- Returns
- bool Return true if no exception was thrown (deprecated since 1.33)
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3032 of file Database.php.
References Wikimedia\Rdbms\Database\isInsertSelectSafe(), Wikimedia\Rdbms\Database\nativeInsertSelect(), and Wikimedia\Rdbms\Database\nonNativeInsertSelect().
◆ 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()
|
protected |
- Parameters
-
array $insertOptions INSERT options array $selectOptions SELECT options
- Returns
- bool Whether an INSERT SELECT with these options will be replication safe
- Since
- 1.31
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3076 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\insertSelect().
◆ isOpen()
| Wikimedia\Rdbms\Database::isOpen | ( | ) |
- Returns
- bool Whether a connection to the database open
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 739 of file Database.php.
References Wikimedia\Rdbms\Database\$conn.
Referenced by Wikimedia\Rdbms\Database\__clone(), Wikimedia\Rdbms\Database\assertHasConnectionHandle(), Wikimedia\Rdbms\Database\initConnection(), Wikimedia\Rdbms\Database\ping(), and Wikimedia\Rdbms\DatabaseSqlite\setTableAliases().
◆ isQuotedIdentifier()
| Wikimedia\Rdbms\Database::isQuotedIdentifier | ( | $name | ) |
Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers .
- Note
- Do not use this to determine if untrusted input is safe. A malicious user can trick this function.
- Parameters
-
string $name
- Returns
- bool
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2760 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 4798 of file Database.php.
References Wikimedia\Rdbms\Database\getReadOnlyReason().
◆ isTransactableQuery()
|
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
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1074 of file Database.php.
References Wikimedia\Rdbms\Database\getQueryVerb().
Referenced by Wikimedia\Rdbms\Database\beginIfImplied().
◆ isWriteQuery()
|
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
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
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 $sql SQL query we will append the limit too int $limit The SQL limit int | bool $offset The SQL offset (default false)
- Returns
- string
- Since
- 1.34
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 3191 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 $prefix Only show tables with this prefix, e.g. mw_ string $fname Calling function name
- Exceptions
-
DBError
- Returns
- array
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 4228 of file Database.php.
◆ listViews()
| Wikimedia\Rdbms\Database::listViews | ( | $prefix = null, |
|
$fname = __METHOD__ |
|||
| ) |
Lists all the VIEWs in the database.
- Parameters
-
string | null $prefix Only show VIEWs with this prefix, eg. unit_test_ string $fname Name of calling function
- Exceptions
-
RuntimeException
- Returns
- array
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4232 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 $lockName Name of lock to aquire string $method Name of the calling method int $timeout Acquisition timeout in seconds (0 means non-blocking)
- Returns
- bool Success
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4660 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 $table Table names array | string $conds Filters on the table string $fname Function name for profiling array $options Options for select ("FOR UPDATE" is added automatically) array $join_conds Join conditions
- Returns
- int Number of matching rows found (and locked)
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
- Since
- 1.32
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2044 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 $lockName Name of lock to poll string $method Name of method calling us
- Returns
- bool
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
- Since
- 1.20
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4653 of file Database.php.
◆ lockTables()
|
final |
Lock specific tables.
Any pending transaction should be resolved before calling this method, since: a) Doing so resets any REPEATABLE-READ snapshot of the data to a fresh one. b) Previous row and table locks from the transaction or session may be released by LOCK TABLES, which may be unsafe for the changes in such a transaction. c) The main use case of lockTables() is to avoid deadlocks and timeouts by locking entire tables in order to do long-running, batched, and lag-aware, updates. Batching and replication lag checks do not work when all the updates happen in a transaction.
Always get all relevant table locks up-front in one call, since LOCK TABLES might release any prior table locks on some RDBMes (e.g MySQL).
For compatibility, callers should check tableLocksHaveTransactionScope() before using this method. If locks are scoped specifically to transactions then caller must either:
- a) Start a new transaction and acquire table locks for the scope of that transaction, doing all row updates within that transaction. It will not be possible to update rows in batches; this might result in high replication lag.
- b) Forgo table locks entirely and avoid calling this method. Careful use of hints like LOCK IN SHARE MODE and FOR UPDATE and the use of query batching may be preferrable to using table locks with a potentially large transaction. Use of MySQL and Postges style REPEATABLE-READ (Snapshot Isolation with or without First-Committer-Rule) can also be considered for certain tasks that require a consistent view of entire tables.
If session scoped locks are not supported, then calling lockTables() will trigger startAtomic(), with unlockTables() triggering endAtomic(). This will automatically start a transaction if one is not already present and cause the locks to be released when the transaction finishes (normally during the unlockTables() call).
In any case, avoid using begin()/commit() in code that runs while such table locks are acquired, as that breaks in case when a transaction is needed. The startAtomic() and endAtomic() methods are safe, however, since they will join any existing transaction.
- Parameters
-
array $read Array of tables to lock for read access array $write Array of tables to lock for write access string $method Name of caller
- Returns
- bool
- Since
- 1.29
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 4716 of file Database.php.
References Wikimedia\Rdbms\Database\doLockTables(), Wikimedia\Rdbms\Database\startAtomic(), Wikimedia\Rdbms\Database\tableLocksHaveTransactionScope(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().
◆ makeGroupByWithHaving()
|
protected |
Returns an optional GROUP BY with an optional HAVING.
- Parameters
-
array $options Associative array of options
- Returns
- string
- See also
- Database::select()
- Since
- 1.21
Definition at line 1764 of file Database.php.
References LIST_AND, and Wikimedia\Rdbms\Database\makeList().
Referenced by Wikimedia\Rdbms\DatabasePostgres\makeSelectOptions(), and Wikimedia\Rdbms\Database\makeSelectOptions().
◆ makeInsertOptions()
|
protected |
Helper for Database::insert().
- Parameters
-
array $options
- Returns
- string
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2097 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:
This would set $sql to "rev_page = '$id' AND (rev_minor = '1' OR rev_len < '500')"
- Parameters
-
array $a Containing the data int $mode IDatabase class constant: - IDatabase::LIST_COMMA: Comma separated, no field names
- IDatabase::LIST_AND: ANDed WHERE clause (without the WHERE).
- IDatabase::LIST_OR: ORed WHERE clause (without the WHERE)
- IDatabase::LIST_SET: Comma separated with field names, like a SET clause
- IDatabase::LIST_NAMES: Comma separated field names
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
- Returns
- string
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2191 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()
|
protected |
Returns an optional ORDER BY.
- Parameters
-
array $options Associative array of options
- Returns
- string
- See also
- Database::select()
- Since
- 1.21
Definition at line 1790 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\makeSelectOptions(), Wikimedia\Rdbms\Database\makeSelectOptions(), and Wikimedia\Rdbms\Database\unionConditionPermutations().
◆ makeSelectOptions()
|
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 $options Associative array of options to be turned into an SQL query, valid keys are listed in the function.
- Returns
- array
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1693 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()
|
protected |
Make UPDATE options for the Database::update function.
- Parameters
-
array $options The options passed to Database::update
- Returns
- string
Definition at line 2171 of file Database.php.
References Wikimedia\Rdbms\Database\makeUpdateOptionsArray().
Referenced by Wikimedia\Rdbms\Database\update().
◆ makeUpdateOptionsArray()
|
protected |
Make UPDATE options array for Database::makeUpdateOptions.
- Parameters
-
array $options
- Returns
- array
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2151 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 $data Organized as 2-d [ baseKeyVal => [ subKeyVal => [ignored], ... ], ... ] string $baseKey Field name to match the base-level keys to (eg 'pl_namespace') string $subKey Field name to match the sub-level keys to (eg 'pl_title')
- Returns
- string|bool SQL fragment, or false if no items in array
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2271 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 $timeout The maximum number of seconds to wait for synchronisation
- Returns
- int|null Zero if the replica DB was past that position already, greater than zero if we waited for some period of time, less than zero if it timed out, and null on error
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3382 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 4435 of file Database.php.
◆ modifyCallbacksForCancel()
|
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 $newSectionId New top section ID.
- Exceptions
-
UnexpectedValueException
Definition at line 3517 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.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4708 of file Database.php.
◆ nativeInsertSelect()
|
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
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 3163 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()
|
protected |
REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement.
- Parameters
-
string $table Table name array | string $rows Row(s) to insert string $fname Caller function name
Definition at line 2903 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()
|
finalprotected |
- Parameters
-
string $error
- Returns
- DBConnectionError
Definition at line 1613 of file Database.php.
References Wikimedia\Rdbms\Database\getLogContext().
Referenced by Wikimedia\Rdbms\DatabaseMysqli\mysqlConnect(), Wikimedia\Rdbms\DatabasePostgres\open(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\DatabaseSqlite\open().
◆ nextSavepointId()
|
private |
- Parameters
-
string $fname
- Returns
- string
Definition at line 3797 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.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 2810 of file Database.php.
◆ nonNativeInsertSelect()
|
protected |
Implementation of insertSelect() based on select() and insert()
- See also
- IDatabase::insertSelect()
- Since
- 1.30
- Parameters
-
string $destTable string | array $srcTable array $varMap array $conds string $fname array $insertOptions array $selectOptions array $selectJoinConds
Definition at line 3094 of file Database.php.
References Wikimedia\Rdbms\Database\$affectedRowCount, Wikimedia\Rdbms\Database\$nonNativeInsertSelectBatchSize, $res, Wikimedia\Rdbms\Database\affectedRows(), Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\fieldNameWithAlias(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\select(), and Wikimedia\Rdbms\Database\startAtomic().
Referenced by Wikimedia\Rdbms\Database\insertSelect(), and Wikimedia\Rdbms\DatabasePostgres\nativeInsertSelect().
◆ normalizeConditions()
|
finalprotected |
- Parameters
-
array | string $conds string $fname
- Returns
- array
Definition at line 2005 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\estimateRowCount(), Wikimedia\Rdbms\DatabaseMysqlBase\estimateRowCount(), Wikimedia\Rdbms\Database\estimateRowCount(), and Wikimedia\Rdbms\Database\selectRowCount().
◆ onAtomicSectionCancel()
|
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 $fname Caller name
- Since
- 1.34
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3447 of file Database.php.
References Wikimedia\Rdbms\Database\currentAtomicSectionId(), and Wikimedia\Rdbms\Database\trxLevel().
◆ onTransactionCommitOrIdle()
|
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 $fname Caller name
- Exceptions
-
DBError If an error occurs, see IDatabase::query() Exception If the callback runs immediately and an error occurs in it
- Since
- 1.32
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3408 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()
|
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 3421 of file Database.php.
References Wikimedia\Rdbms\Database\onTransactionCommitOrIdle().
◆ onTransactionPreCommitOrIdle()
|
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:
- This IDatabase instance (since 1.32)
- Parameters
-
callable $callback string $fname Caller name
- Exceptions
-
DBError If an error occurs, see IDatabase::query() Exception If the callback runs immediately and an error occurs in it
- Since
- 1.22
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3425 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()
|
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 $fname Caller name
- Exceptions
-
DBError If an error occurs, see IDatabase::query() Exception If the callback runs immediately and an error occurs in it
- Since
- 1.28
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3401 of file Database.php.
References Wikimedia\Rdbms\Database\currentAtomicSectionId(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\getScopedLockAndFlush().
◆ open()
|
abstractprotected |
Open a new connection to the database (closing any existing one)
- Parameters
-
string | null $server Database server host string | null $user Database user name string | null $password Database user password string | null $dbName Database name string | null $schema Database schema name string $tablePrefix Table prefix
- Exceptions
-
DBConnectionError
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
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 $type IDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL]
- Returns
- float|bool Returns false if not transaction is active
- Since
- 1.26
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 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 &$rtt Value to store the estimated RTT [optional]
- Returns
- bool Success or failure
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4285 of file Database.php.
References Wikimedia\Rdbms\Database\$flags, Wikimedia\Rdbms\Database\$lastRoundTripEstimate, Wikimedia\Rdbms\Database\isOpen(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\pingAndCalculateLastTrxApplyTime().
◆ 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()
|
private |
- Parameters
-
string | null $namespace Database or schema string $relation Name of table, view, sequence, etc... string $format One of (raw, quoted)
- Returns
- string Relation name with quoted and merged $namespace as needed
Definition at line 2505 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\isQuotedIdentifier().
Referenced by Wikimedia\Rdbms\Database\tableName().
◆ qualifiedTableComponents()
|
protected |
Get the table components needed for a query given the currently selected database.
- Parameters
-
string $name Table name in the form of db.schema.table, db.table, or table
- Returns
- array (DB name or "" for default, schema name, table prefix, table name)
Definition at line 2465 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 $sql SQL query string $fname Name of the calling function, for profiling/SHOW PROCESSLIST comment (you can use METHOD or add some extra info) int $flags Bitfield 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
-
DBQueryError If the query is issued, fails, and QUERY_SILENCE_ERRORS is not set. DBExpectedError If the query is not, and cannot, be issued yet (non-DBQueryError) DBError If the query is inherently not allowed (non-DBExpectedError)
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1141 of file Database.php.
References Wikimedia\Rdbms\Database\$flags, 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\DatabaseMysqlBase\masterPosWait(), 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()
|
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 3473 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\endAtomic().
◆ registerTempWrites()
|
protected |
- Parameters
-
IResultWrapper | bool $ret int | null $tmpType TEMP_NORMAL or TEMP_PSEUDO_PERMANENT string | null $tmpNew Name of created temp table string | null $tmpDel Name of dropped temp table
Definition at line 1130 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQuery().
◆ relationSchemaQualifier()
|
protected |
- Returns
- string Schema to use to qualify relations in queries
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
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 $table The 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 $rows Can be either a single row to insert, or multiple rows, in the same format as for IDatabase::insert() string $fname Calling function name (use METHOD) for logs/profiling
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2842 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()
|
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 4310 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()
|
protected |
Database independent variable replacement.
Replaces a set of variables in an SQL statement with their contents as given by $this->getSchemaVars().
Supports '{$var}' {$var} and / $var / (without the spaces) style variables.
- '{$var}' should be used for text and is passed through the database's addQuotes method.
{$var}should be used for identifiers (e.g. table and database names). It is passed through the database's addIdentifierQuotes method which can be overridden if the database uses something other than backticks.- / *_* / or / $wgDBprefix / passes the name that follows through the database's tableName method.
- / i / passes the name that follows through the database's indexName method.
- In all other cases, / $var / is left unencoded. Except for table options, its use should be avoided. In 1.24 and older, string encoding was applied.
- Parameters
-
string $ins SQL statement to replace variables in
- Returns
- string The new SQL statement with variables replaced
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4599 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 1570 of file Database.php.
References Wikimedia\Rdbms\Database\getQueryExceptionAndLog().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\doSelectDomain(), and Wikimedia\Rdbms\Database\query().
◆ 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 $state IDatabase::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()
|
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 4273 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\query().
◆ rollback()
|
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 $fname Calling function name string $flush Flush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about calling rollback when no transaction is in progress. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context.
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
- Since
- 1.23 Added $flush parameter
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4115 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()
|
private |
Actually run any "atomic section cancel" callbacks.
- Parameters
-
int $trigger IDatabase::TRIGGER_* constant AtomicSectionIdentifier[] | null $sectionIds Section IDs to cancel, null on transaction rollback
Definition at line 3686 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 $trigger IDatabase::TRIGGER_* constant
- Returns
- int Number of callbacks attempted
- Since
- 1.20
- Exceptions
-
Exception
Definition at line 3583 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 3652 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 $trigger IDatabase::TRIGGER_* constant
- Exceptions
-
Exception
- Since
- 1.20
Definition at line 3729 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 $table Table 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 $vars Field 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 $conds May be either a string containing a single condition, or an array of conditions. If an array is given, the conditions constructed from each element are combined with AND.
Array elements may take one of two forms:
- Elements with a numeric key are interpreted as raw SQL fragments.
- Elements with a string key are interpreted as equality conditions, where the key is the field name.
- If the value of such an array element is a scalar (such as a string), it will be treated as data and thus quoted appropriately. If it is null, an IS NULL clause will be added.
- If the value is an array, an IN (...) clause will be constructed from its non-null elements, and an IS NULL clause will be added if null is present, such that the field may match any of the elements in the array. The non-null elements will be quoted.
Note that expressions are often DBMS-dependent in their syntax. DBMS-independent wrappers are provided for constructing several types of expression commonly used in condition queries. See:
Untrusted user input is safe in the values of string keys, however untrusted input must not be used in the array key names or in the values of numeric keys. Escaping of untrusted input used in values of numeric keys should be done via IDatabase::addQuotes()
Use an empty array, string, or '*' to update all rows.
- Parameters
-
string $fname Caller function name string | array $options Query 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_conds Join 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
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1802 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()
|
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
-
DBConnectionError If databasesAreIndependent() is true and connection change fails DBError On query error or if database changes are disallowed
- Deprecated:
- Since 1.32 Use selectDomain() instead
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2375 of file Database.php.
References Wikimedia\Rdbms\Database\selectDomain().
◆ selectDomain()
|
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
-
DBConnectionError If databasesAreIndependent() is true and connection change fails DBError On query error, if domain changes are disallowed, or the domain is invalid
- Since
- 1.32
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2385 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 $table Table name. See IDatabase::select() for details. string $var The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. string | array $cond The condition array. See IDatabase::select() for details. string $fname The function name of the caller. string | array $options The query options. See IDatabase::select() for details. string | array $join_conds The query join conditions. See IDatabase::select() for details.
- Returns
- mixed The value from the field
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1631 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()
|
private |
- Parameters
-
array | string $fields array | string $options
- Returns
- bool
Definition at line 1977 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 $table Table name. See IDatabase::select() for details. string $var The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. string | array $cond The condition array. See IDatabase::select() for details. string $fname The function name of the caller. string | array $options The query options. See IDatabase::select() for details. string | array $join_conds The query join conditions. See IDatabase::select() for details.
- Returns
- array The values from the field in the order they were returned from the DB
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
- Since
- 1.25
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1657 of file Database.php.
References $res, and Wikimedia\Rdbms\Database\select().
◆ selectOptionsIncludeLocking()
|
private |
- Parameters
-
string | array $options
- Returns
- bool
Definition at line 1961 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 $table Table name string | array $vars Field names string | array $conds Conditions string $fname Caller function name string | array $options Query options array | string $join_conds Join conditions
- Returns
- stdClass|bool
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1893 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 $tables Table names string $var Column for which NULL values are not counted [default "*"] array | string $conds Filters on the table string $fname Function name for profiling array $options Options for select array $join_conds Join conditions (since 1.27)
- Returns
- int Row count
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1928 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 $table Table name string | array $vars Field names string | array $conds Conditions string $fname Caller function name string | array $options Query options string | array $join_conds Join conditions
- Returns
- string SQL query string
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1810 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.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3397 of file Database.php.
◆ setBigSelects()
| Wikimedia\Rdbms\Database::setBigSelects | ( | $value = true | ) |
Allow or deny "big selects" for this session only.
This is done by setting the sql_big_selects session variable.
This is a MySQL-specific feature.
- Parameters
-
bool | string $value True for allow, false for deny, or "default" to restore the initial value
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4794 of file Database.php.
◆ setFlag()
| Wikimedia\Rdbms\Database::setFlag | ( | $flag, | |
$remember = self::REMEMBER_NOTHING |
|||
| ) |
Set a flag for this connection.
- Parameters
-
int $flag One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX) string $remember IDatabase::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 4820 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 $nameOrArray The new array or the name of a key to set array | null $value If $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 $vars Mapping variable name to value.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4485 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
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4450 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.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4816 of file Database.php.
◆ setTransactionListener()
|
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 $name Callback name callable | null $callback Use null to unset a listener
- Since
- 1.28
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3553 of file Database.php.
◆ setTrxEndCallbackSuppression()
|
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 3569 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 $filename File name to open callable | null $lineCallback Optional function called before reading each line callable | null $resultCallback Optional function called for each MySQL result bool | string $fname Calling function name or false if name should be generated dynamically using $filename callable | null $inputCallback Optional function called for each complete line sent
- Returns
- bool|string
- Exceptions
-
Exception
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 4453 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 $fp File handle callable | null $lineCallback Optional function called before reading each query callable | null $resultCallback Optional function called for each MySQL result string $fname Calling function name callable | null $inputCallback Optional function called for each complete query sent
- Returns
- bool|string
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 4489 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()
|
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:
Example usage (atomic changes that might have to be discarded):
- Since
- 1.23
- Parameters
-
string $fname string $cancelable Pass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section.
- Returns
- AtomicSectionIdentifier section ID token
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3812 of file Database.php.
References Wikimedia\Rdbms\Database\$NOT_APPLICABLE, 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 &$sql SQL assembled so far string &$newLine New line about to be added to $sql
- Returns
- bool Whether $newLine contains end of the statement
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4566 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\sourceStream().
◆ strencode()
|
abstract |
Wrapper for addslashes()
- Parameters
-
string $s String to be slashed.
- Returns
- string Slashed string.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMysqlBase.
Referenced by Wikimedia\Rdbms\Database\addQuotes().
◆ strreplace()
| Wikimedia\Rdbms\Database::strreplace | ( | $orig, | |
| $old, | |||
| $new | |||
| ) |
Returns a SQL expression for simple string replacement (e.g.
REPLACE() in mysql)
- Parameters
-
string $orig Column to modify string $old Column to seek string $new Column to replace with
- Returns
- string
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3294 of file Database.php.
◆ tableExists()
|
abstract |
Query whether a given table exists.
- Parameters
-
string $table string $fname
- Returns
- bool
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMysqlBase.
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.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4712 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\lockTables(), and Wikimedia\Rdbms\Database\unlockTables().
◆ tableName()
| Wikimedia\Rdbms\Database::tableName | ( | $name, | |
$format = 'quoted' |
|||
| ) |
Format a table name ready for use in constructing an SQL query.
This does two important things: it quotes the table names to clean them up, and it adds a table prefix if only given a table name with no quotes.
All functions of this object which require a table name call this function themselves. Pass the canonical name to such functions. This is only needed when calling query() directly.
- Note
- This function does not sanitize user input. It is not safe to use this function to escape user input.
- Parameters
-
string $name Database table name string $format One of: quoted - Automatically pass the table name through addIdentifierQuotes() so that it can be used in a query. raw - Do not add identifier quotes to the table name
- Returns
- string Full database name
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2407 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 2516 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 2527 of file Database.php.
References Wikimedia\Rdbms\Database\tableName().
◆ tableNamesWithAlias()
|
protected |
Gets an array of aliased table names.
- Parameters
-
array $tables [ [alias] => table ]
- Returns
- string[] See tableNameWithAlias()
Definition at line 2575 of file Database.php.
References Wikimedia\Rdbms\Database\tableNameWithAlias().
◆ tableNamesWithIndexClauseOrJOIN()
|
protected |
Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause.
- Parameters
-
array $tables ( [alias] => table ) array $use_index Same as for select() array $ignore_index Same as for select() array $join_conds Same as for select()
- Returns
- string
Definition at line 2631 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()
|
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 $table Table name or object with a 'sql' field string | bool $alias Table alias (optional)
- Returns
- string SQL name for aliased table. Will not alias a table to its own name
Definition at line 2549 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 $prefix The table prefix to set, or omitted to leave it unchanged
- Returns
- string The previous table prefix
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 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.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2995 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.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 4236 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 4242 of file Database.php.
References Wikimedia\Rdbms\Database\timestamp().
◆ 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()
| Wikimedia\Rdbms\Database::trxStatus | ( | ) |
- Returns
- int One of the STATUS_TRX_* class constants
- Since
- 1.31
Definition at line 543 of file Database.php.
References Wikimedia\Rdbms\Database\$trxStatus.
Referenced by Wikimedia\Rdbms\Database\assertQueryIsCurrentlyAllowed(), Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\executeQuery(), and Wikimedia\Rdbms\Database\rollback().
◆ 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 $table Table name string | array $vars Field names array $permute_conds Conditions for the Cartesian product. Keys are field names, values are arrays of the possible values for that field. string | array $extra_conds Additional conditions to include in the query. string $fname Caller function name string | array $options Query options. In addition to the options recognized by IDatabase::select(), the following may be used: - NOTALL: Set to use UNION instead of UNION ALL.
- INNER ORDER BY: If specified and supported, subqueries will use this instead of ORDER BY.
string | array $join_conds Join conditions
- Returns
- string SQL query string.
- Since
- 1.30
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3215 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 $sqls SQL statements to combine bool $all Either IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT
- Returns
- string SQL fragment
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3209 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.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3205 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\unionConditionPermutations().
◆ unlock()
| Wikimedia\Rdbms\Database::unlock | ( | $lockName, | |
| $method | |||
| ) |
Release a lock.
Named locks are not related to transactions
- Parameters
-
string $lockName Name of lock to release string $method Name of the calling method
- Returns
- bool Success
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4666 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getScopedLockAndFlush().
◆ unlockTables()
|
final |
Unlock all tables locked via lockTables()
If table locks are scoped to transactions, then locks might not be released until the transaction ends, which could happen after this method is called.
- Parameters
-
string $method The caller
- Returns
- bool
- Since
- 1.29
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 4740 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 $table Name of the table to UPDATE. This will be passed through Database::tableName(). array $values An array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by IDatabase::addQuotes(). Values with integer keys form unquoted SET statements, which can be used for things like "field = field + 1" or similar computed values. array | string $conds An array of conditions (WHERE). See IDatabase::select() for the details of the format of condition arrays. Use '*' to update all rows. string $fname The function name of the caller (from METHOD), for logging and profiling. array $options An array of UPDATE options, can be: - IGNORE: Ignore unique key conflicts
- Returns
- bool Return true if no exception was thrown (deprecated since 1.33)
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2177 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()
|
private |
Update the estimated run-time of a query, not counting large row lock times.
LoadBalancer can be set to rollback transactions that will create huge replication lag. It bases this estimate off of pendingWriteQueryDuration(). Certain simple queries, like inserting a row can take a long time due to row locking. This method uses some simple heuristics to discount those cases.
- Parameters
-
string $sql A SQL write query float $runtime Total runtime, including RTT int $affected Affected row count
Definition at line 1380 of file Database.php.
References Wikimedia\Rdbms\Database\$SMALL_WRITE_ROWS, 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 $table Table name. This will be passed through Database::tableName(). array $rows A 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 $set An array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by IDatabase::addQuotes(). Values with integer keys form unquoted SET statements, which can be used for things like "field = field + 1" or similar computed values. string $fname Calling function name (use METHOD) for logs/profiling
- Returns
- bool Return true if no exception was thrown (deprecated since 1.33)
- Exceptions
-
DBError If an error occurs, see IDatabase::query()
- Since
- 1.22
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2927 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
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2824 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
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3332 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 3310 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.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3302 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 3318 of file Database.php.
References Wikimedia\Rdbms\Database\wasConnectionLoss(), Wikimedia\Rdbms\Database\wasDeadlock(), and Wikimedia\Rdbms\Database\wasLockTimeout().
◆ 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
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3342 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.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 3306 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\wasErrorReissuable().
◆ wasQueryTimeout()
|
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 $error Error text int $errno Error number
- Returns
- bool
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 1555 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.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3314 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
|
protected |
Rows affected by the last query to query() or its CRUD wrappers.
Definition at line 164 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\affectedRows(), Wikimedia\Rdbms\DatabaseSqlite\insert(), Wikimedia\Rdbms\Database\nonNativeInsertSelect(), Wikimedia\Rdbms\DatabaseSqlite\replace(), Wikimedia\Rdbms\Database\replace(), and Wikimedia\Rdbms\Database\upsert().
◆ $agent
|
protected |
Agent name for query profiling.
Definition at line 83 of file Database.php.
◆ $cliMode
|
protected |
Whether this PHP instance is for a CLI script.
Definition at line 81 of file Database.php.
◆ $conn
|
protected |
Database connection.
Definition at line 69 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabaseMysqli\closeConnection(), Wikimedia\Rdbms\DatabasePostgres\doQuery(), Wikimedia\Rdbms\Database\factory(), Wikimedia\Rdbms\DatabaseMysqli\fetchAffectedRowCount(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\DatabasePostgres\fetchRow(), Wikimedia\Rdbms\Database\getBindingHandle(), Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo(), Wikimedia\Rdbms\DatabasePostgres\getServerVersion(), Wikimedia\Rdbms\DatabaseMysqli\insertId(), Wikimedia\Rdbms\Database\isOpen(), Wikimedia\Rdbms\DatabaseMysqli\mysqlError(), Wikimedia\Rdbms\DatabaseMysqli\mysqlRealEscapeString(), Wikimedia\Rdbms\DatabasePostgres\numRows(), and Wikimedia\Rdbms\Database\setLazyMasterHandle().
◆ $connectionParams
|
protected |
Parameters used by initConnection() to establish a connection.
Definition at line 85 of file Database.php.
◆ $connectionVariables
|
protected |
SQL variables values to use for all new connections.
Definition at line 87 of file Database.php.
◆ $connLogger
|
protected |
Definition at line 53 of file Database.php.
◆ $currentDomain
|
protected |
Definition at line 66 of file Database.php.
◆ $DBO_MUTABLE
|
staticprotected |
Bit field of all DBO_* flags that can be changed after connection.
Definition at line 234 of file Database.php.
◆ $DEADLOCK_DELAY_MAX
|
staticprivate |
Maximum time to wait before retry.
Definition at line 212 of file Database.php.
◆ $DEADLOCK_DELAY_MIN
|
staticprivate |
Minimum time to wait before retry, in microseconds.
Definition at line 210 of file Database.php.
◆ $DEADLOCK_TRIES
|
staticprivate |
Number of times to re-try an operation in case of deadlock.
Definition at line 208 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\deadlockLoop().
◆ $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
|
protected |
Deprecation logging callback.
Definition at line 59 of file Database.php.
◆ $errorLogger
|
protected |
Error logging callback.
Definition at line 57 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\runOnAtomicSectionCancelCallbacks(), Wikimedia\Rdbms\Database\runOnTransactionPreCommitCallbacks(), and Wikimedia\Rdbms\Database\runTransactionListenerCallbacks().
◆ $flags
|
protected |
Current bit field of class DBO_* constants.
Definition at line 92 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\Database\fieldHasBit(), Wikimedia\Rdbms\DatabaseMysqlBase\fieldInfo(), Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromSlaveStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo(), Wikimedia\Rdbms\DatabaseMysqlBase\getMysqlStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerGTIDs(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerId(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerRoleStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerUUID(), Wikimedia\Rdbms\DatabaseMysqlBase\lock(), Wikimedia\Rdbms\DatabaseMysqlBase\lockIsFree(), Wikimedia\Rdbms\DatabaseSqlite\open(), Wikimedia\Rdbms\Database\ping(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\DatabaseMysqlBase\serverIsReadOnly(), Wikimedia\Rdbms\DatabaseMysqlBase\setSessionOptions(), and Wikimedia\Rdbms\DatabaseMysqlBase\unlock().
◆ $htmlErrors
|
private |
Stashed value of html_errors INI setting.
Definition at line 105 of file Database.php.
◆ $indexAliases
|
protected |
Current map of (index alias => index)
Definition at line 100 of file Database.php.
◆ $lastPhpError
|
private |
Definition at line 173 of file Database.php.
◆ $lastPing
|
private |
UNIX timestamp.
Definition at line 167 of file Database.php.
◆ $lastQuery
|
private |
The last SQL query attempted.
Definition at line 169 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\lastQuery().
◆ $lastRoundTripEstimate
|
private |
Query rount trip time estimate.
Definition at line 175 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\ping().
◆ $lastWriteTime
|
private |
UNIX timestamp of last write query.
Definition at line 171 of file Database.php.
◆ $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
|
protected |
Current LoadBalancer tracking information.
Definition at line 94 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getLBInfo().
◆ $MUTABLE_FLAGS
|
staticprotected |
List of DBO_* flags that can be changed after connection.
Definition at line 227 of file Database.php.
◆ $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
|
staticprivate |
Idiom used when a cancelable atomic section started the transaction.
Definition at line 198 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\startAtomic().
◆ $ownerId
|
private |
Integer ID of the managing LBFactory instance or null if none.
Definition at line 178 of file Database.php.
◆ $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
|
staticprivate |
Dummy SQL query.
Definition at line 217 of file Database.php.
◆ $PING_TTL
|
staticprivate |
How long before it is worth doing a dummy query to test the connection.
Definition at line 215 of file Database.php.
◆ $priorFlags
|
private |
Prior flags member variable values.
Definition at line 107 of file Database.php.
◆ $profiler
|
protected |
Definition at line 61 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt().
◆ $queryLogger
|
protected |
Definition at line 55 of file Database.php.
◆ $SAVEPOINT_PREFIX
|
staticprivate |
Prefix to the atomic section counter used to make savepoint IDs.
Definition at line 200 of file Database.php.
◆ $schemaVars
|
protected |
Current variables use for schema element placeholders.
Definition at line 102 of file Database.php.
◆ $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
|
protected |
Map of (name => 1) for locks obtained via lock()
Definition at line 110 of file Database.php.
◆ $sessionTempTables
|
protected |
Map of (table name => 1) for TEMPORARY tables.
Definition at line 112 of file Database.php.
◆ $SLOW_WRITE_SEC
|
staticprivate |
Consider a write slow if it took more than this many seconds.
Definition at line 222 of file Database.php.
◆ $SMALL_WRITE_ROWS
|
staticprivate |
Assume an insert of this many rows or less should be fast to replicate.
Definition at line 224 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\updateTrxWriteQueryTime().
◆ $srvCache
|
protected |
APC cache.
Definition at line 51 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo(), and Wikimedia\Rdbms\DatabaseMysqlBase\getServerVersion().
◆ $tableAliases
|
protected |
Current map of (table => (dbname, schema, prefix) map)
Definition at line 98 of file Database.php.
◆ $TEMP_NORMAL
|
staticprivate |
Writes to this temporary table do not affect lastDoneWrites()
Definition at line 203 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQuery(), and Wikimedia\Rdbms\Database\getTempWrites().
◆ $TEMP_PSEUDO_PERMANENT
|
staticprivate |
Writes to this temporary table effect lastDoneWrites()
Definition at line 205 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getTempWrites().
◆ $TINY_WRITE_SEC
|
staticprivate |
Guess of how many seconds it takes to replicate a small insert.
Definition at line 220 of file Database.php.
◆ $trxAtomicCounter
|
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
|
private |
List of (name, unique ID, savepoint ID) for each active atomic section level.
Definition at line 135 of file Database.php.
◆ $trxAutomatic
|
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
|
private |
Whether the current transaction was started implicitly by startAtomic()
Definition at line 137 of file Database.php.
◆ $trxDoneWrites
|
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
|
private |
List of (callable, method name, atomic section id)
Definition at line 155 of file Database.php.
◆ $trxEndCallbacksSuppressed
|
private |
Whether to suppress triggering of transaction end callbacks.
Definition at line 161 of file Database.php.
◆ $trxFname
|
private |
Name of the function that start the last transaction.
Definition at line 127 of file Database.php.
◆ $trxIdleCallbacks
|
private |
List of (callable, method name, atomic section id)
Definition at line 151 of file Database.php.
◆ $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
|
protected |
Definition at line 63 of file Database.php.
◆ $trxRecurringCallbacks
|
private |
Map of (name => callable)
Definition at line 159 of file Database.php.
◆ $trxReplicaLag
|
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
|
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
|
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
|
private |
Transaction status.
Definition at line 117 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\trxStatus().
◆ $trxStatusCause
|
private |
The last error that caused the status to become STATUS_TRX_ERROR.
Definition at line 119 of file Database.php.
◆ $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
|
private |
UNIX timestamp at the time of BEGIN for the last transaction.
Definition at line 123 of file Database.php.
◆ $trxWriteAdjDuration
|
private |
Like trxWriteQueryCount but excludes lock-bound, easy to replicate, queries.
Definition at line 147 of file Database.php.
◆ $trxWriteAdjQueryCount
|
private |
Number of write queries counted in trxWriteAdjDuration.
Definition at line 149 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\pingAndCalculateLastTrxApplyTime().
◆ $trxWriteAffectedRows
|
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
|
private |
Write query callers of the current transaction.
Definition at line 139 of file Database.php.
◆ $trxWriteDuration
|
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
|
private |
Number of write queries for the current transaction.
Definition at line 143 of file Database.php.
◆ $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:
- includes/libs/rdbms/database/Database.php
