MediaWiki master
|
A single concrete connection to a relational database. More...
Inherits Stringable, Wikimedia\Rdbms\IDatabaseForOwner, Wikimedia\Rdbms\IMaintainableDatabase, and LoggerAwareInterface.
Inherited by Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Public Member Functions | |||||||||||||||||||||
__clone () | |||||||||||||||||||||
Make sure that copies do not share the same client binding handle. | |||||||||||||||||||||
__destruct () | |||||||||||||||||||||
Run a few simple checks and close dangling connections. | |||||||||||||||||||||
__sleep () | |||||||||||||||||||||
Called by serialize. | |||||||||||||||||||||
__toString () | |||||||||||||||||||||
Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present. | |||||||||||||||||||||
addIdentifierQuotes ( $s) | |||||||||||||||||||||
Escape a SQL identifier (e.g. | |||||||||||||||||||||
addQuotes ( $s) | |||||||||||||||||||||
Escape and quote a raw value string for use in a SQL query. | |||||||||||||||||||||
affectedRows () | |||||||||||||||||||||
Get the number of rows affected by the last query method call. | |||||||||||||||||||||
andExpr (array $conds) | |||||||||||||||||||||
See Expression::__construct() | |||||||||||||||||||||
anyChar () | |||||||||||||||||||||
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. | |||||||||||||||||||||
anyString () | |||||||||||||||||||||
Returns a token for buildLike() that denotes a '' to be used in a LIKE query. | |||||||||||||||||||||
begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT) | |||||||||||||||||||||
Begin a transaction. | |||||||||||||||||||||
bitAnd ( $fieldLeft, $fieldRight) | |||||||||||||||||||||
bitNot ( $field) | |||||||||||||||||||||
bitOr ( $fieldLeft, $fieldRight) | |||||||||||||||||||||
buildComparison (string $op, array $conds) | |||||||||||||||||||||
Build a condition comparing multiple values, for use with indexes that cover multiple fields, common when e.g. | |||||||||||||||||||||
buildConcat ( $stringList) | |||||||||||||||||||||
Build a concatenation list to feed into a SQL query. | |||||||||||||||||||||
buildExcludedValue ( $column) | |||||||||||||||||||||
Build a reference to a column value from the conflicting proposed upsert() row. | |||||||||||||||||||||
buildGreatest ( $fields, $values) | |||||||||||||||||||||
Build a GREATEST function statement comparing columns/values. | |||||||||||||||||||||
buildGroupConcatField ( $delim, $tables, $field, $conds='', $join_conds=[]) | |||||||||||||||||||||
Build a GROUP_CONCAT or equivalent statement for a query. | |||||||||||||||||||||
buildIntegerCast ( $field) | |||||||||||||||||||||
buildLeast ( $fields, $values) | |||||||||||||||||||||
Build a LEAST function statement comparing columns/values. | |||||||||||||||||||||
buildLike ( $param,... $params) | |||||||||||||||||||||
LIKE statement wrapper. | |||||||||||||||||||||
buildSelectSubquery ( $tables, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery. | |||||||||||||||||||||
buildStringCast ( $field) | |||||||||||||||||||||
buildSubstring ( $input, $startPosition, $length=null) | |||||||||||||||||||||
cancelAtomic ( $fname=__METHOD__, ?AtomicSectionIdentifier $sectionId=null) | |||||||||||||||||||||
Cancel an atomic section of SQL statements. | |||||||||||||||||||||
clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |||||||||||||||||||||
Clear a flag for this connection. | |||||||||||||||||||||
close ( $fname=__METHOD__) | |||||||||||||||||||||
Close the database connection. | |||||||||||||||||||||
commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Commits a transaction previously started using begin() | |||||||||||||||||||||
conditional ( $cond, $caseTrueExpression, $caseFalseExpression) | |||||||||||||||||||||
Returns an SQL expression for a simple conditional. | |||||||||||||||||||||
connectionErrorLogger ( $errno, $errstr) | |||||||||||||||||||||
Error handler for logging errors during database connection. | |||||||||||||||||||||
databasesAreIndependent () | |||||||||||||||||||||
Returns true if DBs are assumed to be on potentially different servers. | |||||||||||||||||||||
dbSchema ( $schema=null) | |||||||||||||||||||||
Get/set the db schema. | |||||||||||||||||||||
decodeBlob ( $b) | |||||||||||||||||||||
Some DBMSs return a special placeholder object representing blob fields in result objects. | |||||||||||||||||||||
decodeExpiry ( $expiry, $format=TS_MW) | |||||||||||||||||||||
Decode an expiry time into a DBMS independent format. | |||||||||||||||||||||
delete ( $table, $conds, $fname=__METHOD__) | |||||||||||||||||||||
Delete all rows in a table that match a condition. | |||||||||||||||||||||
deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__) | |||||||||||||||||||||
Delete all rows in a table that match a condition which includes a join. | |||||||||||||||||||||
doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |||||||||||||||||||||
Perform an atomic section of reversible SQL statements from a callback. | |||||||||||||||||||||
dropTable ( $table, $fname=__METHOD__) | |||||||||||||||||||||
Delete a table. | |||||||||||||||||||||
duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__) | |||||||||||||||||||||
Creates a new table with structure copied from existing table. | |||||||||||||||||||||
encodeBlob ( $b) | |||||||||||||||||||||
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. | |||||||||||||||||||||
encodeExpiry ( $expiry) | |||||||||||||||||||||
Encode an expiry time into the DBMS dependent format. | |||||||||||||||||||||
endAtomic ( $fname=__METHOD__) | |||||||||||||||||||||
Ends an atomic section of SQL statements. | |||||||||||||||||||||
estimateRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Estimate the number of rows in dataset.MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).Takes the same arguments as IDatabase::select().New callers should use newSelectQueryBuilder with SelectQueryBuilder::estimateRowCount instead, which is more readable and less error-prone.
| |||||||||||||||||||||
explicitTrxActive () | |||||||||||||||||||||
Check whether there is a transaction open at the specific request of a caller. | |||||||||||||||||||||
expr (string $field, string $op, $value) | |||||||||||||||||||||
See Expression::__construct() | |||||||||||||||||||||
factorConds ( $condsArray) | |||||||||||||||||||||
Given an array of condition arrays representing an OR list of AND lists, for example: | |||||||||||||||||||||
fieldExists ( $table, $field, $fname=__METHOD__) | |||||||||||||||||||||
Determines whether a field exists in a table. | |||||||||||||||||||||
flushSession ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Release important session-level state (named lock, table locks) as post-rollback cleanup. | |||||||||||||||||||||
flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Commit any transaction but error out if writes or callbacks are pending. | |||||||||||||||||||||
getDBname () | |||||||||||||||||||||
Get the current database name; null if there isn't one. | |||||||||||||||||||||
getDomainID () | |||||||||||||||||||||
Return the currently selected domain ID. | |||||||||||||||||||||
getFlag ( $flag) | |||||||||||||||||||||
Returns a boolean whether the flag $flag is set for this connection. | |||||||||||||||||||||
getInfinity () | |||||||||||||||||||||
Find out when 'infinity' is. | |||||||||||||||||||||
getLag () | |||||||||||||||||||||
Get the seconds of replication lag on this database server. | |||||||||||||||||||||
getLBInfo ( $name=null) | |||||||||||||||||||||
Get properties passed down from the server info array of the load balancer. | |||||||||||||||||||||
getPrimaryPos () | |||||||||||||||||||||
Get the replication position of this primary DB server. | |||||||||||||||||||||
getScopedLockAndFlush ( $lockKey, $fname, $timeout) | |||||||||||||||||||||
Acquire a named lock, flush any transaction, and return an RAII style unlocker object. | |||||||||||||||||||||
getServer () | |||||||||||||||||||||
Get the hostname or IP address of the server. | |||||||||||||||||||||
getServerInfo () | |||||||||||||||||||||
Get a human-readable string describing the current software version. | |||||||||||||||||||||
getServerName () | |||||||||||||||||||||
Get the readable name for the server. | |||||||||||||||||||||
getSessionLagStatus () | |||||||||||||||||||||
Get a cached estimate of the seconds of replication lag on this database server, using the estimate obtained at the start of the current transaction if one is active. | |||||||||||||||||||||
getTableAliases () | |||||||||||||||||||||
Return current table aliases. | |||||||||||||||||||||
implicitOrderby () | |||||||||||||||||||||
Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1. | |||||||||||||||||||||
indexExists ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Determines whether an index exists. | |||||||||||||||||||||
indexInfo ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Get information about an index into an object. | |||||||||||||||||||||
indexUnique ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Determines if a given index is unique. | |||||||||||||||||||||
initConnection () | |||||||||||||||||||||
Initialize the connection to the database over the wire (or to local files) | |||||||||||||||||||||
insert ( $table, $rows, $fname=__METHOD__, $options=[]) | |||||||||||||||||||||
Insert row(s) into a table, in the provided order. | |||||||||||||||||||||
insertId () | |||||||||||||||||||||
Get the sequence-based ID assigned by the last query method call. | |||||||||||||||||||||
insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |||||||||||||||||||||
INSERT SELECT wrapper. | |||||||||||||||||||||
isOpen () | |||||||||||||||||||||
isQuotedIdentifier ( $name) | |||||||||||||||||||||
isReadOnly () | |||||||||||||||||||||
Check if this DB server is marked as read-only according to load balancer info. | |||||||||||||||||||||
lastDoneWrites () | |||||||||||||||||||||
Get the last time that the connection was used to commit a write. | |||||||||||||||||||||
limitResult ( $sql, $limit, $offset=false) | |||||||||||||||||||||
Construct a LIMIT query with optional offset. | |||||||||||||||||||||
listTables ( $prefix=null, $fname=__METHOD__) | |||||||||||||||||||||
List all tables on the database. | |||||||||||||||||||||
lock ( $lockName, $method, $timeout=5, $flags=0) | |||||||||||||||||||||
Acquire a named lock.Named locks are not related to transactions
| |||||||||||||||||||||
lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Lock all rows meeting the given conditions/options FOR UPDATE. | |||||||||||||||||||||
lockIsFree ( $lockName, $method) | |||||||||||||||||||||
Check to see if a named lock is not locked by any thread (non-blocking)
| |||||||||||||||||||||
makeList (array $a, $mode=self::LIST_COMMA) | |||||||||||||||||||||
Makes an encoded list of strings from an array. | |||||||||||||||||||||
makeWhereFrom2d ( $data, $baseKey, $subKey) | |||||||||||||||||||||
Build a "OR" condition with pairs from a two-dimensional array. | |||||||||||||||||||||
newDeleteQueryBuilder () | |||||||||||||||||||||
Get a DeleteQueryBuilder bound to this connection. | |||||||||||||||||||||
newInsertQueryBuilder () | |||||||||||||||||||||
Get a InsertQueryBuilder bound to this connection. | |||||||||||||||||||||
newReplaceQueryBuilder () | |||||||||||||||||||||
Get a ReplaceQueryBuilder bound to this connection. | |||||||||||||||||||||
newSelectQueryBuilder () | |||||||||||||||||||||
Get a SelectQueryBuilder bound to this connection. | |||||||||||||||||||||
newUnionQueryBuilder () | |||||||||||||||||||||
Get a UnionQueryBuilder bound to this connection. | |||||||||||||||||||||
newUpdateQueryBuilder () | |||||||||||||||||||||
Get an UpdateQueryBuilder bound to this connection. | |||||||||||||||||||||
onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback when the current transaction commits or now if there is none. | |||||||||||||||||||||
onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback before the current transaction commits or now if there is none. | |||||||||||||||||||||
onTransactionResolution (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback when the current transaction commits or rolls back. | |||||||||||||||||||||
orExpr (array $conds) | |||||||||||||||||||||
See Expression::__construct() | |||||||||||||||||||||
pendingWriteAndCallbackCallers () | |||||||||||||||||||||
pendingWriteCallers () | |||||||||||||||||||||
Get the list of method names that did write queries for this transaction. | |||||||||||||||||||||
pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL) | |||||||||||||||||||||
Get the time spend running write queries for this transaction. | |||||||||||||||||||||
ping () | |||||||||||||||||||||
Ping the server and try to reconnect if it there is no connection. | |||||||||||||||||||||
primaryPosWait (DBPrimaryPos $pos, $timeout) | |||||||||||||||||||||
Wait for the replica server to catch up to a given primary server position. | |||||||||||||||||||||
query ( $sql, $fname=__METHOD__, $flags=0) | |||||||||||||||||||||
Run an SQL query statement and return the result. | |||||||||||||||||||||
replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__) | |||||||||||||||||||||
Insert row(s) into a table, in the provided order, while deleting conflicting rows. | |||||||||||||||||||||
reportQueryError ( $error, $errno, $sql, $fname, $ignore=false) | |||||||||||||||||||||
Report a query error. | |||||||||||||||||||||
restoreFlags ( $state=self::RESTORE_PRIOR) | |||||||||||||||||||||
Restore the flags to their prior state before the last setFlag/clearFlag call. | |||||||||||||||||||||
rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Rollback a transaction previously started using begin() | |||||||||||||||||||||
runOnTransactionIdleCallbacks ( $trigger, array &$errors=[]) | |||||||||||||||||||||
Consume and run any "on transaction idle/resolution" callbacks. | |||||||||||||||||||||
runOnTransactionPreCommitCallbacks () | |||||||||||||||||||||
runTransactionListenerCallbacks ( $trigger, array &$errors=[]) | |||||||||||||||||||||
Actually run any "transaction listener" callbacks. | |||||||||||||||||||||
select ( $tables, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Execute a SELECT query constructed using the various parameters provided. | |||||||||||||||||||||
selectDomain ( $domain) | |||||||||||||||||||||
Set the current domain (database, schema, and table prefix) | |||||||||||||||||||||
selectField ( $tables, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
A SELECT wrapper which returns a single field from a single result row. | |||||||||||||||||||||
selectFieldValues ( $tables, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
A SELECT wrapper which returns a list of single field values from result rows. | |||||||||||||||||||||
selectRow ( $tables, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Wrapper to IDatabase::select() that only fetches one row (via LIMIT) | |||||||||||||||||||||
selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Get the number of rows in dataset. | |||||||||||||||||||||
selectSQLText ( $tables, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Take the same arguments as IDatabase::select() and return the SQL it would use. | |||||||||||||||||||||
serverIsReadOnly () | |||||||||||||||||||||
| |||||||||||||||||||||
sessionLocksPending () | |||||||||||||||||||||
setFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |||||||||||||||||||||
Set a flag for this connection. | |||||||||||||||||||||
setIndexAliases (array $aliases) | |||||||||||||||||||||
Convert certain index names to alternative names before querying the DB. | |||||||||||||||||||||
setLBInfo ( $nameOrArray, $value=null) | |||||||||||||||||||||
Set the entire array or a particular key of the managing load balancer info array. | |||||||||||||||||||||
setLogger (LoggerInterface $logger) | |||||||||||||||||||||
Set the PSR-3 logger interface to use. | |||||||||||||||||||||
setSchemaVars ( $vars) | |||||||||||||||||||||
Set schema variables to be used when streaming commands from SQL files or stdin. | |||||||||||||||||||||
setSessionOptions (array $options) | |||||||||||||||||||||
Override database's default behavior. | |||||||||||||||||||||
setTableAliases (array $aliases) | |||||||||||||||||||||
Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. | |||||||||||||||||||||
setTransactionListener ( $name, ?callable $callback=null) | |||||||||||||||||||||
Run a callback after each time any transaction commits or rolls back. | |||||||||||||||||||||
setTransactionManager (TransactionManager $transactionManager) | |||||||||||||||||||||
setTrxEndCallbackSuppression ( $suppress) | |||||||||||||||||||||
Whether to disable running of post-COMMIT/ROLLBACK callbacks. | |||||||||||||||||||||
sourceFile ( $filename, ?callable $lineCallback=null, ?callable $resultCallback=null, $fname=false, ?callable $inputCallback=null) | |||||||||||||||||||||
Read and execute SQL commands from a file. | |||||||||||||||||||||
sourceStream ( $fp, ?callable $lineCallback=null, ?callable $resultCallback=null, $fname=__METHOD__, ?callable $inputCallback=null) | |||||||||||||||||||||
Read and execute commands from an open file handle. | |||||||||||||||||||||
startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |||||||||||||||||||||
Begin an atomic section of SQL statements. | |||||||||||||||||||||
streamStatementEnd (&$sql, &$newLine) | |||||||||||||||||||||
Called by sourceStream() to check if we've reached a statement end. | |||||||||||||||||||||
strencode ( $s) | |||||||||||||||||||||
Wrapper for addslashes() | |||||||||||||||||||||
strreplace ( $orig, $old, $new) | |||||||||||||||||||||
Returns a SQL expression for simple string replacement (e.g. | |||||||||||||||||||||
tableExists ( $table, $fname=__METHOD__) | |||||||||||||||||||||
Query whether a given table exists. | |||||||||||||||||||||
tableName (string $name, $format='quoted') | |||||||||||||||||||||
Format a table name ready for use in constructing an SQL query. | |||||||||||||||||||||
tableNamesN (... $tables) | |||||||||||||||||||||
Fetch a number of table names into a zero-indexed numerical array. | |||||||||||||||||||||
tablePrefix ( $prefix=null) | |||||||||||||||||||||
Get/set the table prefix. | |||||||||||||||||||||
timestamp ( $ts=0) | |||||||||||||||||||||
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. | |||||||||||||||||||||
timestampOrNull ( $ts=null) | |||||||||||||||||||||
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. | |||||||||||||||||||||
truncateTable ( $table, $fname=__METHOD__) | |||||||||||||||||||||
Delete all data in a table and reset any sequences owned by that table. | |||||||||||||||||||||
trxLevel () | |||||||||||||||||||||
Gets the current transaction level. | |||||||||||||||||||||
trxStatus () | |||||||||||||||||||||
trxTimestamp () | |||||||||||||||||||||
Get the UNIX timestamp of the time that the transaction was established. | |||||||||||||||||||||
unionQueries ( $sqls, $all, $options=[]) | |||||||||||||||||||||
Construct a UNION query. | |||||||||||||||||||||
unionSupportsOrderAndLimit () | |||||||||||||||||||||
Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION. | |||||||||||||||||||||
unlock ( $lockName, $method) | |||||||||||||||||||||
Release a lock.Named locks are not related to transactions
| |||||||||||||||||||||
update ( $table, $set, $conds, $fname=__METHOD__, $options=[]) | |||||||||||||||||||||
Update all rows in a table that match a given condition. | |||||||||||||||||||||
upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__) | |||||||||||||||||||||
Upsert row(s) into a table, in the provided order, while updating conflicting rows. | |||||||||||||||||||||
writesOrCallbacksPending () | |||||||||||||||||||||
Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. | |||||||||||||||||||||
writesPending () | |||||||||||||||||||||
Public Member Functions inherited from Wikimedia\Rdbms\IReadableDatabase | |||||||||||||||||||||
getServerVersion () | |||||||||||||||||||||
A string describing the current software version. | |||||||||||||||||||||
getSoftwareLink () | |||||||||||||||||||||
Returns a wikitext style link to the DB's website (e.g. | |||||||||||||||||||||
getType () | |||||||||||||||||||||
Get the RDBMS type of the server (e.g. | |||||||||||||||||||||
lastErrno () | |||||||||||||||||||||
Get the RDBMS-specific error code from the last attempted query statement. | |||||||||||||||||||||
lastError () | |||||||||||||||||||||
Get the RDBMS-specific error description from the last attempted query statement. | |||||||||||||||||||||
Public Member Functions inherited from Wikimedia\Rdbms\Platform\ISQLPlatform | |||||||||||||||||||||
buildSubString ( $input, $startPosition, $length=null) | |||||||||||||||||||||
Build a SUBSTRING function. | |||||||||||||||||||||
Public Member Functions inherited from Wikimedia\Rdbms\IMaintainableDatabase | |||||||||||||||||||||
fieldInfo ( $table, $field) | |||||||||||||||||||||
Get information about a field Returns false if the field doesn't exist. | |||||||||||||||||||||
Static Public Member Functions | |
static | getAttributes () |
static | getCacheSetOptions (?IReadableDatabase ... $dbs) |
Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination. | |
Public Attributes | |
if(is_string( $params['sqlMode'] ?? null)) | $flags = (int)$params['flags'] |
$this | agent = (string)$params['agent'] |
$this | cliMode = (bool)$params['cliMode'] |
$this | connectionParams |
$this | connectionVariables = $params['variables'] ?? [] |
$this | connectTimeout = $params['connectTimeout'] ?? null |
$this | csProvider = $params['criticalSectionProvider'] ?? null |
$this | currentDomain |
$this | deprecationLogger = $params['deprecationLogger'] |
$this | errorLogger = $params['errorLogger'] |
$this | flagsHolder = new DatabaseFlags( $flags ) |
$this | lbInfo = $params['lbInfo'] ?? [] |
$this | nonNativeInsertSelectBatchSize = $params['nonNativeInsertSelectBatchSize'] ?? 10000 |
$this | platform |
$this | profiler = is_callable( $params['profiler'] ) ? $params['profiler'] : null |
$this | receiveTimeout = $params['receiveTimeout'] ?? null |
$this | serverName = $params['serverName'] |
$this | ssl = $params['ssl'] ?? (bool)( $flags & self::DBO_SSL ) |
$this | strictWarnings = !empty( $params['strictWarnings'] ) |
$this | tracer = $params['tracer'] ?? new NoopTracer() |
Public Attributes inherited from Wikimedia\Rdbms\IDatabase | |
const | ATOMIC_CANCELABLE = 'cancelable' |
Atomic section is cancelable. | |
const | ATOMIC_NOT_CANCELABLE = '' |
Atomic section is not cancelable. | |
const | ESTIMATE_DB_APPLY = 'apply' |
Estimate time to apply (scanning, applying) | |
const | ESTIMATE_TOTAL = 'total' |
Estimate total time (RTT, scanning, waiting on locks, applying) | |
const | FLUSHING_ALL_PEERS = 'flush' |
Commit/rollback is from the owning connection manager for the IDatabase handle. | |
const | FLUSHING_INTERNAL = 'flush-internal' |
Commit/rollback is from the IDatabase handle internally. | |
const | FLUSHING_ONE = '' |
Commit/rollback is from outside the IDatabase handle and connection manager. | |
const | LB_READ_ONLY_REASON = 'readOnlyReason' |
Field for getLBInfo()/setLBInfo(); configured read-only mode explanation or false. | |
const | LB_TRX_ROUND_FNAME = 'trxRoundOwner' |
Field for getLBInfo()/setLBInfo(); relevant transaction round owner name or null. | |
const | LB_TRX_ROUND_ID = self::LB_TRX_ROUND_FNAME |
Alias to LB_TRX_ROUND_FNAME. | |
const | LOCK_TIMESTAMP = 1 |
Flag to return the lock acquisition timestamp (null if not acquired) | |
const | ROLE_STATIC_CLONE = 'static-clone' |
Replica server within a static dataset. | |
const | ROLE_STREAMING_MASTER = 'streaming-master' |
Primary server than can stream writes to replica servers. | |
const | ROLE_STREAMING_REPLICA = 'streaming-replica' |
Replica server that receives writes from a primary server. | |
const | ROLE_UNKNOWN = 'unknown' |
Server with unknown topology role. | |
const | TRANSACTION_EXPLICIT = '' |
Transaction is requested by regular caller outside of the DB layer. | |
const | TRANSACTION_INTERNAL = 'implicit' |
Transaction is requested internally via DBO_TRX/startAtomic() | |
const | TRIGGER_CANCEL = 4 |
Callback triggered by atomic section cancel (ROLLBACK TO SAVEPOINT) | |
const | TRIGGER_COMMIT = 2 |
Callback triggered by COMMIT. | |
const | TRIGGER_IDLE = 1 |
Callback triggered immediately due to no active transaction. | |
const | TRIGGER_ROLLBACK = 3 |
Callback triggered by ROLLBACK. | |
Public Attributes inherited from Wikimedia\Rdbms\IReadableDatabase | |
const | UNION_ALL = true |
Parameter to unionQueries() for UNION ALL. | |
const | UNION_DISTINCT = false |
Parameter to unionQueries() for UNION DISTINCT. | |
Public Attributes inherited from Wikimedia\Rdbms\Platform\ISQLPlatform | |
const | ALL_ROWS = '*' |
Unconditional update/delete of whole table. | |
const | CALLER_SUBQUERY = 'subquery' |
Special value for ->caller() / $fname parameter used when providing a caller is not expected, because we're formatting a subquery that won't be executed directly. | |
const | CALLER_UNKNOWN = 'unknown' |
Special value for ->caller() / $fname parameter used when a caller is not provided. | |
const | LIST_AND = 1 |
Combine list with AND clauses. | |
const | LIST_COMMA = 0 |
Combine list with comma delimiters. | |
const | LIST_NAMES = 3 |
Treat as field name and do not apply value escaping. | |
const | LIST_OR = 4 |
Combine list with OR clauses. | |
const | LIST_SET = 2 |
Convert map into a SET clause. | |
const | QUERY_CHANGE_LOCKS = 512 |
Query is a command for advisory locks. | |
const | QUERY_CHANGE_NONE = 32 |
Query is a read-only Data Query Language query. | |
const | QUERY_CHANGE_ROWS = 128 |
Query is a Data Manipulation Language command (INSERT, DELETE, LOCK, ...) | |
const | QUERY_CHANGE_SCHEMA = 256 |
Query is a Data Definition Language command. | |
const | QUERY_CHANGE_TRX = 64 |
Query is a Transaction Control Language command (BEGIN, USE, SET, ...) | |
const | QUERY_IGNORE_DBO_TRX = 8 |
Ignore the current presence of any DBO_TRX flag. | |
const | QUERY_NO_RETRY = 16 |
Do not try to retry the query if the connection was lost. | |
const | QUERY_NORMAL = 0 |
Idiom for "no special flags". | |
const | QUERY_PSEUDO_PERMANENT = 2 |
Track a TEMPORARY table CREATE as if it was for a permanent table (for testing) | |
const | QUERY_REPLICA_ROLE = 4 |
Enforce that a query does not make effective writes. | |
const | QUERY_SILENCE_ERRORS = 1 |
Ignore query errors and return false when they happen. | |
Public Attributes inherited from Wikimedia\Rdbms\Database\IDatabaseFlags | |
const | DBO_COMPRESS = 512 |
Enable compression in connection protocol. | |
const | DBO_DDLMODE = 128 |
Schema file mode; was used by Oracle. | |
const | DBO_DEBUG = 1 |
Enable debug logging of all SQL queries. | |
const | DBO_DEFAULT = 16 |
Join load balancer transaction rounds (which control DBO_TRX) in non-CLI mode. | |
const | DBO_GAUGE = 1024 |
Optimize connection for guaging server state (e.g. | |
const | DBO_IGNORE = 4 |
Unused since 1.31. | |
const | DBO_NOBUFFER = 2 |
Unused since 1.34. | |
const | DBO_PERSISTENT = 32 |
Use DB persistent connections if possible. | |
const | DBO_SSL = 256 |
Enable SSL/TLS in connection protocol. | |
const | DBO_SYSDBA = 64 |
DBA session mode; was used by Oracle. | |
const | DBO_TRX = 8 |
Automatically start a transaction before running a query if none is active. | |
const | REMEMBER_NOTHING = '' |
Do not remember the prior flags. | |
const | REMEMBER_PRIOR = 'remember' |
Remember the prior flags. | |
const | RESTORE_INITIAL = 'initial' |
Restore to the initial flag state. | |
const | RESTORE_PRIOR = 'prior' |
Restore to the prior flag state. | |
Protected Member Functions | |
assertHasConnectionHandle () | |
Make sure there is an open connection handle (alive or not) | |
checkInsertWarnings (Query $query, $fname) | |
Check for warnings after performing an INSERT query, and throw exceptions if necessary. | |
closeConnection () | |
Closes underlying database connection. | |
commenceCriticalSection (string $fname) | |
Demark the start of a critical section of session/transaction state changes. | |
completeCriticalSection (string $fname, ?CriticalSectionScope $csm, ?Throwable $trxError=null) | |
Demark the completion of a critical section of session/transaction state changes. | |
doBegin ( $fname) | |
Issues the BEGIN command to the database server. | |
doFlushSession ( $fname) | |
Reset the server-side session state for named locks and table locks. | |
doHandleSessionLossPreconnect () | |
Reset any additional subclass trx* and session* fields. | |
doInsertSelectNative ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds) | |
Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory. | |
doLock (string $lockName, string $method, int $timeout) | |
doLockIsFree (string $lockName, string $method) | |
doSelectDomain (DatabaseDomain $domain) | |
doSingleStatementQuery (string $sql) | |
Run a query and return a QueryStatus instance with the query result information. | |
doUnlock (string $lockName, string $method) | |
executeQuery ( $sql, $fname, $flags) | |
Execute a query without enforcing public (non-Database) caller restrictions. | |
getBindingHandle () | |
Get the underlying binding connection handle. | |
getInsertIdColumnForUpsert ( $table) | |
getLastPHPError () | |
getLogContext (array $extras=[]) | |
Create a log context to pass to PSR-3 logger functions. | |
getReadOnlyReason () | |
getTransactionRoundFname () | |
getValueTypesForWithClause ( $table) | |
installErrorHandler () | |
Set a custom error handler for logging errors during database connection. | |
isConnectionError ( $errno) | |
Do not use this method outside of Database/DBError classes. | |
isInsertSelectSafe (array $insertOptions, array $selectOptions, $fname) | |
isKnownStatementRollbackError ( $errno) | |
isQueryTimeoutError ( $errno) | |
Checks whether the cause of the error is detected to be a timeout. | |
lastInsertId () | |
Get a row ID from the last insert statement to implicitly assign one within the session. | |
newExceptionAfterConnectError ( $error) | |
open ( $server, $user, $password, $db, $schema, $tablePrefix) | |
Open a new connection to the database (closing any existing one) | |
registerTempTables (Query $query) | |
Register creation and dropping of temporary tables. | |
replaceLostConnection ( $lastErrno, $fname) | |
Close any existing (dead) database connection and open a new connection. | |
restoreErrorHandler () | |
Restore the previous error handler and return the last PHP error for this DB. | |
Protected Attributes | |
string | $agent |
Agent name for query profiling. | |
bool | $cliMode |
Whether this PHP instance is for a CLI script. | |
object resource null | $conn |
Database connection. | |
array< string, mixed > | $connectionParams |
Connection parameters used by initConnection() and open() | |
string[] int[] float[] | $connectionVariables |
SQL variables values to use for all new connections. | |
int null | $connectTimeout |
Maximum seconds to wait on connection attempts. | |
CriticalSectionProvider null | $csProvider |
DatabaseDomain | $currentDomain |
string false | $delimiter = ';' |
Current SQL query delimiter. | |
callable | $deprecationLogger |
Deprecation logging callback. | |
callable | $errorLogger |
Error logging callback. | |
DatabaseFlags | $flagsHolder |
array | $lbInfo = [] |
Current LoadBalancer tracking information. | |
LoggerInterface | $logger |
int | $nonNativeInsertSelectBatchSize |
Row batch size to use for emulated INSERT SELECT queries. | |
callable null | $profiler |
int null | $receiveTimeout |
Maximum seconds to wait on receiving query results. | |
string null | $serverName |
Readable name or host/IP of the database server. | |
array< string, array > | $sessionNamedLocks = [] |
Map of (lock name => (UNIX time,trx ID)) | |
bool | $ssl |
Whether to use SSL connections. | |
bool | $strictWarnings |
Whether to check for warnings. | |
array< string, array< string, $sessionTempTables=[];protected int $lastQueryAffectedRows=0;protected int|null $lastQueryInsertId;protected int|null $lastEmulatedAffectedRows;protected int|null $lastEmulatedInsertId;protected string $lastConnectError='';private float $lastPing=0.0;private float|null $lastWriteTime;private string|false $lastPhpError=false;private int|null $csmId;private string|null $csmFname;private DBUnexpectedError|null $csmError;public const ATTR_DB_IS_FILE='db-is-file';public const ATTR_DB_LEVEL_LOCKING='db-level-locking';public const ATTR_SCHEMAS_AS_TABLE_GROUPS='supports-schemas';public const NEW_UNCONNECTED=0;public const NEW_CONNECTED=1;protected const ERR_NONE=0;protected const ERR_RETRY_QUERY=1;protected const ERR_ABORT_QUERY=2;protected const ERR_ABORT_TRX=4;protected const ERR_ABORT_SESSION=8;protected const DROPPED_CONN_BLAME_THRESHOLD_SEC=3.0;=private const NOT_APPLICABLE 'n/a';private const PING_TTL=1.0;private const PING_QUERY='SELECT 1 AS ping';protected const CONN_HOST='host';protected const CONN_USER='user';protected const CONN_PASSWORD='password';protected const CONN_INITIAL_DB='dbname';protected const CONN_INITIAL_SCHEMA='schema';protected const CONN_INITIAL_TABLE_PREFIX='tablePrefix';protected SQLPlatform $platform;protected ReplicationReporter $replicationReporter;public function __construct(array $params) { $this->logger=$params[ 'logger'] ?? new NullLogger();$this-> | transactionManager |
TempTableInfo>> Map of (DB name => table name => info) | |
A single concrete connection to a relational database.
This is the base class for all connection-specific relational database handles. No two instances of this class should share the same underlying network connection.
Definition at line 51 of file Database.php.
Wikimedia\Rdbms\Database::__destruct | ( | ) |
Run a few simple checks and close dangling connections.
Definition at line 3224 of file Database.php.
Wikimedia\Rdbms\Database::__clone | ( | ) |
Make sure that copies do not share the same client binding handle.
DBConnectionError |
Definition at line 3184 of file Database.php.
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 3216 of file Database.php.
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.
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 3165 of file Database.php.
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"
string | $s |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3394 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\doSelectDomain().
Wikimedia\Rdbms\Database::addQuotes | ( | $s | ) |
Escape and quote a raw value string for use in a SQL query.
?scalar | RawSQLValue | Blob | $s |
Implements Wikimedia\Rdbms\Database\DbQuoter.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1571 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\open().
Wikimedia\Rdbms\Database::affectedRows | ( | ) |
Get the number of rows affected by the last query method call.
This method should only be called when all the following hold true:
In all other cases, the return value is unspecified.
UPDATE queries consider rows affected even when all their new column values match the previous values. Such rows can be excluded from the count by changing the WHERE clause to filter them out.
If the last query method call was to query() or queryMulti(), then the results are based on the (last) statement provided to that call and are driver-specific.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2560 of file Database.php.
Wikimedia\Rdbms\Database::andExpr | ( | array | $conds | ) |
See Expression::__construct()
non-empty-array<string,?scalar|RawSQLValue|Blob|LikeValue|non-empty-list<scalar|Blob>>|non-empty-array<int,IExpression> | $conds |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1593 of file Database.php.
Wikimedia\Rdbms\Database::anyChar | ( | ) |
Returns a token for buildLike()
that denotes a '_' to be used in a LIKE query.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3406 of file Database.php.
Wikimedia\Rdbms\Database::anyString | ( | ) |
Returns a token for buildLike()
that denotes a '' to be used in a LIKE query.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3410 of file Database.php.
|
finalprotected |
Make sure there is an open connection handle (alive or not)
This guards against fatal errors to the binding handle not being defined in cases where open() was never called or close() was already called.
DBUnexpectedError |
Definition at line 541 of file Database.php.
References Wikimedia\Rdbms\Database\isOpen().
Referenced by Wikimedia\Rdbms\Database\executeQuery().
|
final |
Begin a transaction.
Only call this from code with outer transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.
Note that when the DBO_TRX flag is set (which is usually the case for web requests, but not for maintenance scripts), any previous database query will have started a transaction automatically.
Nesting of transactions is not supported. Attempts to nest transactions will cause a warning, unless the current transaction was started automatically because of the DBO_TRX flag.
string | $fname | Calling function name |
string | $mode | A situationally valid IDatabase::TRANSACTION_* constant [optional] |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2315 of file Database.php.
Wikimedia\Rdbms\Database::bitAnd | ( | $fieldLeft, | |
$fieldRight ) |
string | int | $fieldLeft | |
string | int | $fieldRight |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3354 of file Database.php.
Wikimedia\Rdbms\Database::bitNot | ( | $field | ) |
string | int | $field |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3350 of file Database.php.
Wikimedia\Rdbms\Database::bitOr | ( | $fieldLeft, | |
$fieldRight ) |
string | int | $fieldLeft | |
string | int | $fieldRight |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3358 of file Database.php.
Wikimedia\Rdbms\Database::buildComparison | ( | string | $op, |
array | $conds ) |
Build a condition comparing multiple values, for use with indexes that cover multiple fields, common when e.g.
paging through results or doing batch operations.
For example, you might be displaying a list of people ordered alphabetically by their last and first name, split across multiple pages. The first page of the results ended at Jane Doe. When building the query for the next page, you would use:
$queryBuilder->where( $db->buildComparison( '>', [ 'last' => 'Doe', 'first' => 'Jane' ] ) );
This will return people whose last name follows Doe, or whose last name is Doe and first name follows Jane.
Note that the order of keys in the associative array $conds is significant, and must match the order of fields used by the index.
When comparing a single value, prefer using the expression builder:
$db->expr( 'key', '<=', $val ) // equivalent to: $db->buildComparison( '<=', [ 'key' => $val ] ) 'key <= ' . $db->addQuotes( $val )
string | $op | Comparison operator, one of '>', '>=', '<', '<=' |
non-empty-array<string,mixed> | $conds Map of field names to their values to use in the comparison |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3334 of file Database.php.
Wikimedia\Rdbms\Database::buildConcat | ( | $stringList | ) |
Build a concatenation list to feed into a SQL query.
string[] | $stringList | Raw SQL expression list; caller is responsible for escaping |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3362 of file Database.php.
Wikimedia\Rdbms\Database::buildExcludedValue | ( | $column | ) |
Build a reference to a column value from the conflicting proposed upsert() row.
The reference comes in the form of an alias, function, or parenthesized SQL expression. It can be used in upsert() SET expressions to handle the merging of column values between each conflicting pair of existing and proposed rows. Such proposed rows are said to have been "excluded" from insertion in favor of updating the existing row.
This is useful for multi-row upserts() since the proposed values cannot just be included as literals in the SET expressions.
string | $column | Column name |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3479 of file Database.php.
Wikimedia\Rdbms\Database::buildGreatest | ( | $fields, | |
$values ) |
Build a GREATEST function statement comparing columns/values.
Integer and float values in $values will not be quoted
If $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
string | string[] | $fields | Name(s) of column(s) with values to compare |
string | int | float | string[] | int[] | float[] | $values | Values to compare |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3366 of file Database.php.
Wikimedia\Rdbms\Database::buildGroupConcatField | ( | $delim, | |
$tables, | |||
$field, | |||
$conds = '', | |||
$join_conds = [] ) |
Build a GROUP_CONCAT or equivalent statement for a query.
This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.
string | $delim | Glue to bind the results together |
string | array | $tables | Table reference(s), using the unqualified name of tables or of the form "information_schema.<identifier>". { |
string | $field | Field name @phpcs:ignore Generic.Files.LineLength |
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $conds Conditions | |
string | array | $join_conds | Join conditions |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3466 of file Database.php.
Wikimedia\Rdbms\Database::buildIntegerCast | ( | $field | ) |
string | $field | Field or column to cast |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3382 of file Database.php.
Wikimedia\Rdbms\Database::buildLeast | ( | $fields, | |
$values ) |
Build a LEAST function statement comparing columns/values.
Integer and float values in $values will not be quoted
If $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
string | string[] | $fields | Name(s) of column(s) with values to compare |
string | int | float | string[] | int[] | float[] | $values | Values to compare |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3370 of file Database.php.
Wikimedia\Rdbms\Database::buildLike | ( | $param, | |
$params ) |
LIKE statement wrapper.
This takes a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar()
or anyString()
. Alternatively, the function could be provided with an array of the aforementioned parameters.
Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches for subpages of 'My page title'. Alternatively: $pattern = [ 'My_page_title/', $dbr->anyString() ]; $query .= $dbr->buildLike( $pattern );
array[] | string | LikeMatch | $param | |
string|LikeMatch | ...$params |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3402 of file Database.php.
References $params.
Wikimedia\Rdbms\Database::buildSelectSubquery | ( | $tables, | |
$vars, | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery.
string | array | $tables | Table reference(s), using the unqualified name of tables or of the form "information_schema.<identifier>". { |
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 |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3472 of file Database.php.
Wikimedia\Rdbms\Database::buildStringCast | ( | $field | ) |
string | $field | Field or column to cast |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3378 of file Database.php.
Wikimedia\Rdbms\Database::buildSubstring | ( | $input, | |
$startPosition, | |||
$length = null ) |
Definition at line 3374 of file Database.php.
|
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 that a call to IDatabase::rollback() will also roll back any open atomic sections.
string | $fname | |
AtomicSectionIdentifier | null | $sectionId | Section ID from startAtomic(); passing this enables cancellation of unclosed nested sections [optional] |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2223 of file Database.php.
|
protected |
Check for warnings after performing an INSERT query, and throw exceptions if necessary.
Query | $query | |
string | $fname |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1521 of file Database.php.
Wikimedia\Rdbms\Database::clearFlag | ( | $flag, | |
$remember = self::REMEMBER_NOTHING ) |
Clear a flag for this connection.
int | $flag | One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX) |
string | $remember | IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING] |
Implements Wikimedia\Rdbms\Database\IDatabaseFlags.
Definition at line 3252 of file Database.php.
|
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.
string | $fname | Caller name |
DBError |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 486 of file Database.php.
References Wikimedia\Rdbms\Database\closeConnection(), Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\transactionManager, and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\DatabaseMySQL\open(), Wikimedia\Rdbms\DatabasePostgres\open(), and Wikimedia\Rdbms\DatabaseSqlite\open().
|
abstractprotected |
Closes underlying database connection.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Referenced by Wikimedia\Rdbms\Database\close().
|
protected |
Demark the start of a critical section of session/transaction state changes.
Use this to disable potentially DB handles due to corruption from highly unexpected exceptions (e.g. from zend timers or coding errors) preempting execution of methods.
Callers must demark completion of the critical section with completeCriticalSection(). Callers should handle DBError exceptions that do not cause object state corruption by catching them, calling completeCriticalSection(), and then rethrowing them.
string | $fname | Caller name |
DBUnexpectedError | If an unresolved critical section error already exists |
Definition at line 3099 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQuery().
|
final |
Commits a transaction previously started using begin()
If no transaction is in progress, a warning is issued.
Only call this from code with outer transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.
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. |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2358 of file Database.php.
|
protected |
Demark the completion of a critical section of session/transaction state changes.
string | $fname | Caller name |
CriticalSectionScope | null | $csm | RAII-style monitor (topmost sections only) |
Throwable | null | $trxError | Error that requires setting STATUS_TRX_ERROR (if any) |
Definition at line 3142 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQuery().
Wikimedia\Rdbms\Database::conditional | ( | $cond, | |
$caseTrueExpression, | |||
$caseFalseExpression ) |
Returns an SQL expression for a simple conditional.
This doesn't need to be overridden unless CASE isn't supported in the RDBMS.
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>>|array<int,string|IExpression> | $cond SQL condition expression (yields a boolean) | |
string | $caseTrueExpression | SQL expression to return when the condition is true |
string | $caseFalseExpression | SQL expression to return when the condition is false |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3426 of file Database.php.
Wikimedia\Rdbms\Database::connectionErrorLogger | ( | $errno, | |
$errstr ) |
Error handler for logging errors during database connection.
int | string | $errno | |
string | $errstr |
Definition at line 465 of file Database.php.
Wikimedia\Rdbms\Database::databasesAreIndependent | ( | ) |
Returns true if DBs are assumed to be on potentially different servers.
In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.
Implements Wikimedia\Rdbms\IReadableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1531 of file Database.php.
Wikimedia\Rdbms\Database::dbSchema | ( | $schema = null | ) |
Get/set the db schema.
string | null | $schema | The database schema to set, or omitted to leave it unchanged |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 329 of file Database.php.
References Wikimedia\Rdbms\Database\currentDomain, Wikimedia\Rdbms\Database\getDBname(), and Wikimedia\Rdbms\Database\platform.
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.
string | Blob | $b |
DBError |
Implements Wikimedia\Rdbms\IReadableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2725 of file Database.php.
Wikimedia\Rdbms\Database::decodeExpiry | ( | $expiry, | |
$format = TS_MW ) |
Decode an expiry time into a DBMS independent format.
string | $expiry | DB timestamp field value for expiry |
int | $format | TS_* constant, defaults to TS_MW |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3450 of file Database.php.
Wikimedia\Rdbms\Database::delete | ( | $table, | |
$conds, | |||
$fname = __METHOD__ ) |
Delete all rows in a table that match a condition.
This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
string | $table | The unqualified name of a table |
@phpcs:ignore Generic.Files.LineLength
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $conds Array of conditions. See $conds in IDatabase::select() In order to prevent possible performance or replication issues or damaging a data accidentally, an empty condition for 'delete' queries isn't allowed. IDatabase::ALL_ROWS should be passed explicitly in order to delete all rows. | |
string | $fname | Name of the calling function |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1747 of file Database.php.
Wikimedia\Rdbms\Database::deleteJoin | ( | $delTable, | |
$joinTable, | |||
$delVar, | |||
$joinVar, | |||
$conds, | |||
$fname = __METHOD__ ) |
Delete all rows in a table that match a condition which includes a join.
For safety, an empty $conds will not delete everything. If you want to delete all rows where the join condition matches, set $conds=IDatabase::ALL_ROWS.
DO NOT put the join condition in $conds.
This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
string | $delTable | The unqualified name of the table to delete rows from. |
string | $joinTable | The unqualified name of the reference table to join on. |
string | $delVar | The variable to join on, in the first table. |
string | $joinVar | The variable to join on, in the second table. @phpcs:ignore Generic.Files.LineLength |
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $conds Condition array of field names mapped to variables, ANDed together in the WHERE clause | |
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1734 of file Database.php.
|
final |
Perform an atomic section of reversible SQL statements from a callback.
The $callback takes the following arguments:
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:
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:
string | $fname | Caller name (usually METHOD) |
callable | $callback | Callback that issues write queries |
string | $cancelable | Pass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section. |
DBError | If an error occurs, { |
Exception | If an error occurs in the callback |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2294 of file Database.php.
|
protected |
Issues the BEGIN command to the database server.
string | $fname |
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2353 of file Database.php.
|
protected |
Reset the server-side session state for named locks and table locks.
Connection and query errors will be suppressed and logged
string | $fname |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2526 of file Database.php.
|
protected |
Reset any additional subclass trx* and session* fields.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1148 of file Database.php.
|
protected |
Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory.
string | $destTable | The unqualified name of destination table |
string | array | $srcTable | The unqualified name of source table |
array | $varMap | |
array | $conds | |
string | $fname | |
array | $insertOptions | |
array | $selectOptions | |
array | $selectJoinConds |
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1890 of file Database.php.
|
protected |
string | $lockName | |
string | $method | |
int | $timeout |
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2922 of file Database.php.
|
protected |
string | $lockName | |
string | $method |
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2884 of file Database.php.
|
protected |
DatabaseDomain | $domain |
DBConnectionError | |
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1554 of file Database.php.
|
abstractprotected |
Run a query and return a QueryStatus instance with the query result information.
This is meant to handle the basic command of actually sending a query to the server via the driver. No implicit transaction, reconnection, nor retry logic should happen here. The higher level query() method is designed to handle those sorts of concerns. This method should not trigger such higher level methods.
The lastError() and lastErrno() methods should meaningfully reflect what error, if any, occurred during the last call to this method. Methods like executeQuery(), query(), select(), insert(), update(), delete(), and upsert() implement their calls to doQuery() such that an immediately subsequent call to lastError()/lastErrno() meaningfully reflects any error that occurred during that public query method call.
For SELECT queries, the result field contains either:
For non-SELECT queries, the result field contains either:
string | $sql | Single-statement SQL query |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
References Wikimedia\Rdbms\Query\getVerb(), Wikimedia\Rdbms\Query\getWriteTable(), and Wikimedia\Rdbms\Database\platform.
|
protected |
string | $lockName | |
string | $method |
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2959 of file Database.php.
Wikimedia\Rdbms\Database::dropTable | ( | $table, | |
$fname = __METHOD__ ) |
Delete a table.
string | $table | The unqualified name of a table |
string | $fname |
DBError | If an error occurs |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 2998 of file Database.php.
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).
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 |
RuntimeException |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2547 of file Database.php.
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().
string | $b |
DBError |
Implements Wikimedia\Rdbms\IReadableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2721 of file Database.php.
Wikimedia\Rdbms\Database::encodeExpiry | ( | $expiry | ) |
Encode an expiry time into the DBMS dependent format.
string | $expiry | Timestamp for expiry, or the 'infinity' string |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3446 of file Database.php.
|
final |
Ends an atomic section of SQL statements.
Ends the next section of atomic SQL statements and commits the transaction if necessary.
string | $fname |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2190 of file Database.php.
Wikimedia\Rdbms\Database::estimateRowCount | ( | $tables, | |
$var = '*', | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Estimate the number of rows in dataset.MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).Takes the same arguments as IDatabase::select().New callers should use newSelectQueryBuilder
with SelectQueryBuilder::estimateRowCount
instead, which is more readable and less error-prone.
string | string[] | $tables | Table reference(s), using the unqualified name of tables or of the form "information_schema.<identifier>". { |
string | $var | Column for which NULL values are not counted [default "*"] @phpcs:ignore Generic.Files.LineLength |
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $conds Filters on the table | |
string | $fname | Function name for profiling |
array | $options | Options for select |
array | string | $join_conds | Join conditions |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IReadableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1399 of file Database.php.
|
finalprotected |
Execute a query without enforcing public (non-Database) caller restrictions.
Retry it if there is a recoverable connection loss (e.g. no important state lost).
This does not precheck for transaction/session state errors or critical section errors.
Query | $sql | SQL statement |
string | $fname | Name of the calling function |
int | $flags | Bit field of ISQLPlatform::QUERY_* constants |
DBUnexpectedError |
Definition at line 673 of file Database.php.
References Wikimedia\Rdbms\Database\$flags, $source, Wikimedia\Rdbms\Database\assertHasConnectionHandle(), Wikimedia\Rdbms\Database\commenceCriticalSection(), Wikimedia\Rdbms\Database\completeCriticalSection(), Wikimedia\Rdbms\Database\currentDomain, Wikimedia\Rdbms\Database\getReadOnlyReason(), Wikimedia\Rdbms\ChangedTablesTracker\recordQuery(), and Wikimedia\Rdbms\Database\registerTempTables().
Referenced by Wikimedia\Rdbms\DatabaseMySQL\doSelectDomain(), Wikimedia\Rdbms\DatabaseMySQL\open(), and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\Database::explicitTrxActive | ( | ) |
Check whether there is a transaction open at the specific request of a caller.
Explicit transactions are spawned by begin(), startAtomic(), and doAtomicSection(). Note that explicit transactions should not be confused with explicit transaction rounds.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3316 of file Database.php.
Wikimedia\Rdbms\Database::expr | ( | string | $field, |
string | $op, | ||
$value ) |
See Expression::__construct()
string | $field | |
string | $op | One of '>', '<', '!=', '=', '>=', '<=', IExpression::LIKE, IExpression::NOT_LIKE |
?scalar|RawSQLValue|Blob|LikeValue|non-empty-list<scalar|Blob> | $value |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1589 of file Database.php.
Wikimedia\Rdbms\Database::factorConds | ( | $condsArray | ) |
Given an array of condition arrays representing an OR list of AND lists, for example:
(A=1 AND B=2) OR (A=1 AND B=3)
produce an SQL expression in which the conditions are factored:
(A=1 AND (B=2 OR B=3))
We also use IN() to simplify further:
(A=1 AND (B IN (2,3))
More compactly, in boolean algebra notation, a sum of products, e.g. AB + AC is factored to produce A(B+C). Factoring proceeds recursively to reduce expressions with any number of variables, for example AEP + AEQ + AFP + AFQ = A(E(P+Q) + F(P+Q))
The algorithm is simple and will not necessarily find the shortest possible expression. For the best results, fields should be given in a consistent order, and the fields with values likely to be shared should be leftmost in the associative arrays.
array | $condsArray | An array of associative arrays. The associative array keys represent field names, and the values represent the field values to compare against. |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3346 of file Database.php.
Wikimedia\Rdbms\Database::fieldExists | ( | $table, | |
$field, | |||
$fname = __METHOD__ ) |
Determines whether a field exists in a table.
string | $table | The unqualified name of a table |
string | $field | Field to check on that table |
string | $fname | Calling function name |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 1470 of file Database.php.
Wikimedia\Rdbms\Database::flushSession | ( | $fname = __METHOD__, | |
$flush = self::FLUSHING_ONE ) |
Release important session-level state (named lock, table locks) as post-rollback cleanup.
This should only be called by a load balancer or if the handle is not attached to one. Also, there must be no chance that a future caller will still be expecting some of the lost session state.
Connection and query errors will be suppressed and logged
string | $fname | Calling function name |
string | $flush | Flush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly rolling back implicit transactions. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context. |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabaseForOwner.
Definition at line 2463 of file Database.php.
Wikimedia\Rdbms\Database::flushSnapshot | ( | $fname = __METHOD__, | |
$flush = self::FLUSHING_ONE ) |
Commit any transaction but error out if writes or callbacks are pending.
This is intended for clearing out REPEATABLE-READ snapshots so that callers can see a new point-in-time of the database. This is useful when one of many transaction rounds finished and significant time will pass in the script's lifetime. It is also useful to call on a replica server after waiting on replication to catch up to the primary server.
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. |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2530 of file Database.php.
|
static |
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 297 of file Database.php.
|
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().
DBUnexpectedError |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3052 of file Database.php.
|
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
IReadableDatabase|null | ...$dbs Note: For backward compatibility, it is allowed for null values to be passed among the parameters. This is deprecated since 1.36, only IReadableDatabase objects should be passed. |
DBError |
Definition at line 2698 of file Database.php.
Referenced by MediaWiki\Storage\NameTableStore\getName(), MediaWiki\User\User\loadFromCache(), MediaWiki\SiteStats\SiteStats\numberingroup(), MediaWiki\SiteStats\SiteStats\pagesInNs(), and MediaWiki\ResourceLoader\MessageBlobStore\recacheMessageBlob().
Wikimedia\Rdbms\Database::getDBname | ( | ) |
Get the current database name; null if there isn't one.
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1559 of file Database.php.
Referenced by Wikimedia\Rdbms\LoadBalancerSingle\__construct(), Wikimedia\Rdbms\Database\dbSchema(), Wikimedia\Rdbms\DatabaseMySQL\doSelectDomain(), Wikimedia\Rdbms\DatabasePostgres\doSelectDomain(), Wikimedia\Rdbms\DatabaseSqlite\getDbFilePath(), and Wikimedia\Rdbms\Database\getLogContext().
Wikimedia\Rdbms\Database::getDomainID | ( | ) |
Return the currently selected domain ID.
Null components (database/schema) might change once a connection is established
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 408 of file Database.php.
References Wikimedia\Rdbms\Database\currentDomain.
Wikimedia\Rdbms\Database::getFlag | ( | $flag | ) |
Returns a boolean whether the flag $flag is set for this connection.
int | $flag | One of the class IDatabase::DBO_* constants |
Implements Wikimedia\Rdbms\Database\IDatabaseFlags.
Definition at line 3260 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\open().
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.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3442 of file Database.php.
|
protected |
string | $table | The unqualified name of a table |
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1722 of file Database.php.
Wikimedia\Rdbms\Database::getLag | ( | ) |
Get the seconds of replication lag on this database server.
Callers should avoid using this method while a transaction is active
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 3498 of file Database.php.
|
protected |
Definition at line 446 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\restoreErrorHandler().
Wikimedia\Rdbms\Database::getLBInfo | ( | $name = null | ) |
Get properties passed down from the server info array of the load balancer.
string | null | $name | The entry of the info array to get, or null to get the whole array |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 352 of file Database.php.
References Wikimedia\Rdbms\Database\lbInfo.
Referenced by Wikimedia\Rdbms\Database\getTransactionRoundFname().
|
protected |
Create a log context to pass to PSR-3 logger functions.
array | $extras | Additional data to add to context |
Definition at line 475 of file Database.php.
References Wikimedia\Rdbms\Database\connectionParams, Wikimedia\Rdbms\Database\getDBname(), and Wikimedia\Rdbms\Database\getServerName().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\open().
Wikimedia\Rdbms\Database::getPrimaryPos | ( | ) |
Get the replication position of this primary DB server.
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabaseForOwner.
Definition at line 3494 of file Database.php.
|
protected |
Definition at line 3027 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQuery().
Wikimedia\Rdbms\Database::getScopedLockAndFlush | ( | $lockKey, | |
$fname, | |||
$timeout ) |
Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
Only call this from outer transaction scope and when only one DB server will be affected. See https://www.mediawiki.org/wiki/Database_transactions for details.
This is suitable for transactions that need to be serialized using cooperative locks, where each transaction can see each others' changes. Any transaction is flushed to clear out stale REPEATABLE-READ snapshot data. Once the returned object falls out of PHP scope, the lock will be released unless a transaction is active. If one is active, then the lock will be released when it either commits or rolls back.
If the lock acquisition failed, then no transaction flush happens, and null is returned.
string | $lockKey | Name of lock to release |
string | $fname | Name of the calling method |
int | $timeout | Acquisition timeout in seconds |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2963 of file Database.php.
References if.
Wikimedia\Rdbms\Database::getServer | ( | ) |
Get the hostname or IP address of the server.
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1563 of file Database.php.
Referenced by Wikimedia\Rdbms\LoadBalancerSingle\__construct().
Wikimedia\Rdbms\Database::getServerInfo | ( | ) |
Get a human-readable string describing the current software version.
Use getServerVersion() to get machine-friendly information.
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 310 of file Database.php.
References Wikimedia\Rdbms\IReadableDatabase\getServerVersion().
Wikimedia\Rdbms\Database::getServerName | ( | ) |
Get the readable name for the server.
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1567 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getLogContext().
Wikimedia\Rdbms\Database::getSessionLagStatus | ( | ) |
Get a cached estimate of the seconds of replication lag on this database server, using the estimate obtained at the start of the current transaction if one is active.
This is useful when transactions might use snapshot isolation (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data is this lag plus transaction duration. If they don't, it is still safe to be pessimistic. In AUTOCOMMIT mode, this still gives an indication of the staleness of subsequent reads.
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 3502 of file Database.php.
Wikimedia\Rdbms\Database::getTableAliases | ( | ) |
Return current table aliases.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3458 of file Database.php.
|
finalprotected |
Definition at line 394 of file Database.php.
References Wikimedia\Rdbms\Database\flagsHolder, and Wikimedia\Rdbms\Database\getLBInfo().
|
protected |
string | $table | The unqualified name of a table |
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1730 of file Database.php.
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.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3324 of file Database.php.
Wikimedia\Rdbms\Database::indexExists | ( | $table, | |
$index, | |||
$fname = __METHOD__ ) |
Determines whether an index exists.
string | $table | The unqualified name of a table |
string | $index | |
string | $fname |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 1478 of file Database.php.
|
abstract |
Get information about an index into an object.
string | $table | The unqualified name of a table |
string | $index | Index name |
string | $fname | Calling function name |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Wikimedia\Rdbms\Database::indexUnique | ( | $table, | |
$index, | |||
$fname = __METHOD__ ) |
Determines if a given index is unique.
string | $table | The unqualified name of a table |
string | $index | |
string | $fname | Calling function name |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 1484 of file Database.php.
|
final |
Initialize the connection to the database over the wire (or to local files)
LogicException | |
InvalidArgumentException | |
DBConnectionError |
Definition at line 264 of file Database.php.
References Wikimedia\Rdbms\Database\connectionParams, Wikimedia\Rdbms\Database\isOpen(), and Wikimedia\Rdbms\Database\open().
Wikimedia\Rdbms\Database::insert | ( | $table, | |
$rows, | |||
$fname = __METHOD__, | |||
$options = [] ) |
Insert row(s) into a table, in the provided order.
This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
string | $table | The unqualified name of a table |
array | array[] | $rows | Row(s) to insert, as either:
|
string | $fname | Calling function name (use METHOD) for logs/profiling |
string | array | $options | Combination map/list where each string-keyed entry maps a non-boolean option to the option parameters and each integer-keyed value is the name of a boolean option. Supported options are:
|
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1501 of file Database.php.
Wikimedia\Rdbms\Database::insertId | ( | ) |
Get the sequence-based ID assigned by the last query method call.
This method should only be called when all the following hold true:
In all other cases, the return value is unspecified.
When the query method is either insert() with "IGNORE", upsert(), or insertSelect(), callers should first check affectedRows() before calling this method, making sure that the query method actually created a row. Otherwise, an ID from a previous insert might be incorrectly assumed to belong to last insert.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 2566 of file Database.php.
|
final |
INSERT SELECT wrapper.
This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
string | $destTable | Unqualified name of destination table |
string | array | $srcTable | Unqualified name of source table(s) (use an array for 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() @phpcs:ignore Generic.Files.LineLength |
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $conds Condition array. See $conds in IDatabase::select() for the details of the format of condition arrays. May be "*" to copy the whole table. | |
string | $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. |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1753 of file Database.php.
|
protected |
Set a custom error handler for logging errors during database connection.
Definition at line 423 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\open(), and Wikimedia\Rdbms\DatabasePostgres\open().
|
protected |
Do not use this method outside of Database/DBError classes.
int | string | $errno |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1926 of file Database.php.
|
protected |
array | $insertOptions | |
array | $selectOptions | |
string | $fname |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1804 of file Database.php.
|
protected |
int | string | $errno |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1937 of file Database.php.
Wikimedia\Rdbms\Database::isOpen | ( | ) |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 404 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\assertHasConnectionHandle(), and Wikimedia\Rdbms\Database\initConnection().
|
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.
int | string | $errno | Error number |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1162 of file Database.php.
Wikimedia\Rdbms\Database::isQuotedIdentifier | ( | $name | ) |
Definition at line 3398 of file Database.php.
Wikimedia\Rdbms\Database::isReadOnly | ( | ) |
Check if this DB server is marked as read-only according to load balancer info.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3020 of file Database.php.
Wikimedia\Rdbms\Database::lastDoneWrites | ( | ) |
Get the last time that the connection was used to commit a write.
Implements Wikimedia\Rdbms\IDatabaseForOwner.
Definition at line 378 of file Database.php.
|
abstractprotected |
Get a row ID from the last insert statement to implicitly assign one within the session.
If the statement involved assigning sequence IDs to multiple rows, then the return value will be any one of those values (database-specific). If the statement was an "UPSERT" and some existing rows were updated, then the result will either reflect only IDs of created rows or it will reflect IDs of both created and updated rows (this is database-specific).
The result is unspecified if the statement gave an error.
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
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.
string | $sql | SQL query we will append the limit too |
int | $limit | The SQL limit |
int | false | $offset | The SQL offset (default false) |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3414 of file Database.php.
Wikimedia\Rdbms\Database::listTables | ( | $prefix = null, | |
$fname = __METHOD__ ) |
List all tables on the database.
Since MW 1.42, this will no longer include MySQL views.
string | null | $prefix | Only show tables with this prefix, e.g. mw_ |
string | $fname | Calling function name |
DBError |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMySQL, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2556 of file Database.php.
Wikimedia\Rdbms\Database::lock | ( | $lockName, | |
$method, | |||
$timeout = 5, | |||
$flags = 0 ) |
Acquire a named lock.Named locks are not related to transactions
string | $lockName | Name of lock to acquire |
string | $method | Name of the calling method |
int | $timeout | Acquisition timeout in seconds (0 means non-blocking) |
int | $flags | Bit field of IDatabase::LOCK_* constants |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2891 of file Database.php.
Wikimedia\Rdbms\Database::lockForUpdate | ( | $table, | |
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Lock all rows meeting the given conditions/options FOR UPDATE.
string | string[] | $table | The unqualified name of table(s) (use an array for a join) @phpcs:ignore Generic.Files.LineLength |
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $conds Condition in the format of IDatabase::select() conditions | |
string | $fname | Function name for profiling |
array | $options | Options for select ("FOR UPDATE" is added automatically) |
array | $join_conds | Join conditions |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1454 of file Database.php.
Wikimedia\Rdbms\Database::lockIsFree | ( | $lockName, | |
$method ) |
Check to see if a named lock is not locked by any thread (non-blocking)
string | $lockName | Name of lock to poll |
string | $method | Name of method calling us |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2863 of file Database.php.
Wikimedia\Rdbms\Database::makeList | ( | array | $a, |
$mode = self::LIST_COMMA ) |
Makes an encoded list of strings from an array.
These can be used to make conjunctions or disjunctions on SQL condition strings derived from an array ({
Example usage:
This would set $sql to "rev_page = '$id' AND (rev_minor = 1 OR rev_len < 500)"
array | $a | Containing the data |
int | $mode | IDatabase class constant:
|
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3338 of file Database.php.
Wikimedia\Rdbms\Database::makeWhereFrom2d | ( | $data, | |
$baseKey, | |||
$subKey ) |
Build a "OR" condition with pairs from a two-dimensional array.
The associative array should have integer keys relating to the $baseKey field. The nested array should have string keys for the $subKey field. The inner values are ignored, and are typically boolean true.
Example usage:
array | $data | Nested array, must be non-empty |
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') |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3342 of file Database.php.
Wikimedia\Rdbms\Database::newDeleteQueryBuilder | ( | ) |
Get a DeleteQueryBuilder bound to this connection.
This is overridden by DBConnRef.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1290 of file Database.php.
|
finalprotected |
string | $error |
Definition at line 1236 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\open(), Wikimedia\Rdbms\DatabasePostgres\open(), and Wikimedia\Rdbms\DatabaseSqlite\open().
Wikimedia\Rdbms\Database::newInsertQueryBuilder | ( | ) |
Get a InsertQueryBuilder bound to this connection.
This is overridden by DBConnRef.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1300 of file Database.php.
Wikimedia\Rdbms\Database::newReplaceQueryBuilder | ( | ) |
Get a ReplaceQueryBuilder bound to this connection.
This is overridden by DBConnRef.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1310 of file Database.php.
Wikimedia\Rdbms\Database::newSelectQueryBuilder | ( | ) |
Get a SelectQueryBuilder bound to this connection.
This is overridden by DBConnRef.
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1260 of file Database.php.
Wikimedia\Rdbms\Database::newUnionQueryBuilder | ( | ) |
Get a UnionQueryBuilder bound to this connection.
This is overridden by DBConnRef.
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1270 of file Database.php.
Wikimedia\Rdbms\Database::newUpdateQueryBuilder | ( | ) |
Get an UpdateQueryBuilder bound to this connection.
This is overridden by DBConnRef.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1280 of file Database.php.
|
final |
Run a callback when the current transaction commits or now if there is none.
If there is a transaction and it is rolled back, then the callback is cancelled.
When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.
This IDatabase instance will start off in auto-commit mode when the callback starts. The use of other IDatabase handles from the callback should be avoided unless they are known to be in auto-commit mode. Callbacks that create transactions via begin() or startAtomic() must have matching calls to commit()/endAtomic().
Use this method only for the following purposes:
The callback takes the following arguments:
Callbacks will execute in the order they were enqueued.
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, { |
Exception | If the callback runs immediately and an error occurs in it |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1952 of file Database.php.
|
final |
Run a callback before the current transaction commits or now if there is none.
If there is a transaction and it is rolled back, then the callback is cancelled.
When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.
If there is no current transaction, one will be created to wrap the callback. Callbacks cannot use begin()/commit() to manage transactions. The use of other IDatabase handles from the callback should be avoided.
Use this method only for the following purposes:
The callback takes the one argument:
Callbacks will execute in the order they were enqueued.
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, { |
Exception | If the callback runs immediately and an error occurs in it |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1970 of file Database.php.
|
final |
Run a callback when the current transaction commits or rolls back.
An error is thrown if no transaction is pending.
When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT/ROLLBACK.
This IDatabase instance will start off in auto-commit mode when the callback starts. The use of other IDatabase handles from the callback should be avoided unless they are known to be in auto-commit mode. Callbacks that create transactions via begin() or startAtomic() must have matching calls to commit()/endAtomic().
Use this method only for the following purposes:
The callback takes the following arguments:
Callbacks will execute in the order they were enqueued.
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, { |
Exception | If the callback runs immediately and an error occurs in it |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1948 of file Database.php.
|
abstractprotected |
Open a new connection to the database (closing any existing one)
string | null | $server | Server host/address and optional port { |
string | null | $user | User name { |
string | null | $password | User password { |
string | null | $db | Database name |
string | null | $schema | Database schema name |
string | $tablePrefix |
DBConnectionError |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Referenced by Wikimedia\Rdbms\Database\initConnection().
Wikimedia\Rdbms\Database::orExpr | ( | array | $conds | ) |
See Expression::__construct()
non-empty-array<string,?scalar|RawSQLValue|Blob|LikeValue|non-empty-list<scalar|Blob>>|non-empty-array<int,IExpression> | $conds |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1597 of file Database.php.
Wikimedia\Rdbms\Database::pendingWriteAndCallbackCallers | ( | ) |
Definition at line 3305 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\close().
Wikimedia\Rdbms\Database::pendingWriteCallers | ( | ) |
Get the list of method names that did write queries for this transaction.
Implements Wikimedia\Rdbms\IDatabaseForOwner.
Definition at line 3298 of file Database.php.
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.
string | $type | IDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL] |
Implements Wikimedia\Rdbms\IDatabaseForOwner.
Definition at line 3294 of file Database.php.
Wikimedia\Rdbms\Database::ping | ( | ) |
Ping the server and try to reconnect if it there is no connection.
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 2595 of file Database.php.
Wikimedia\Rdbms\Database::primaryPosWait | ( | DBPrimaryPos | $pos, |
$timeout ) |
Wait for the replica server to catch up to a given primary server position.
Note that this does not start any new transactions.
Callers might want to flush any existing transaction before invoking this method. Upon success, this assures that replica server queries will reflect all changes up to the given position, without interference from prior REPEATABLE-READ snapshots.
DBPrimaryPos | $pos | |
int | $timeout | The maximum number of seconds to wait for synchronisation |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabaseForOwner.
Definition at line 3490 of file Database.php.
Wikimedia\Rdbms\Database::query | ( | $sql, | |
$fname = __METHOD__, | |||
$flags = 0 ) |
Run an SQL query statement and return the result.
If a connection loss is detected, then an attempt to reconnect will be made. For queries that involve no larger transactions or locks, they will be re-issued for convenience, provided the connection was re-established.
In new code, the query wrappers select(), insert(), update(), delete(), etc. should be used where possible, since they give much better DBMS independence and automatically quote or validate user input in a variety of contexts. This function is generally only useful for queries which are explicitly DBMS-dependent and are unsupported by the query wrappers, such as CREATE TABLE.
However, the query wrappers themselves should call this function.
Callers should avoid the use of statements like BEGIN, COMMIT, and ROLLBACK. Methods like startAtomic(), endAtomic(), and cancelAtomic() can be used instead.
string | Query | $sql | Single-statement SQL query |
string | $fname | Caller name; used for profiling/SHOW PROCESSLIST comments |
int | $flags | Bit field of ISQLPlatform::QUERY_* constants |
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 630 of file Database.php.
References Wikimedia\Rdbms\Database\$flags, Wikimedia\Rdbms\QueryBuilderFromRawSql\buildQuery(), Wikimedia\Rdbms\Database\currentDomain, Wikimedia\Rdbms\Database\executeQuery(), and Wikimedia\Rdbms\Database\reportQueryError().
Referenced by Wikimedia\Rdbms\PostgresField\fromText(), Wikimedia\Rdbms\DatabasePostgres\open(), and Wikimedia\Rdbms\DatabaseSqlite\open().
|
protected |
Register creation and dropping of temporary tables.
Query | $query |
Definition at line 610 of file Database.php.
References Wikimedia\Rdbms\Query\getFlags(), Wikimedia\Rdbms\Query\getVerb(), Wikimedia\Rdbms\Query\getWriteTable(), Wikimedia\Rdbms\Database\platform, and Wikimedia\Rdbms\Database\transactionManager.
Referenced by Wikimedia\Rdbms\Database\executeQuery().
Wikimedia\Rdbms\Database::replace | ( | $table, | |
$uniqueKeys, | |||
$rows, | |||
$fname = __METHOD__ ) |
Insert row(s) into a table, in the provided order, while deleting conflicting rows.
Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.
Note some important implications of the deletion semantics:
This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
string | $table | The unqualified name of a table |
string | string[] | string[][] | $uniqueKeys | Column name or non-empty list of column name lists that define all applicable unique keys on the table. There must only be one such key. Each unique key on the table is "applicable" unless either:
|
array | array[] | $rows | Row(s) to insert, in the form of either:
|
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1601 of file Database.php.
|
protected |
Close any existing (dead) database connection and open a new connection.
int | null | $lastErrno | |
string | $fname |
Definition at line 2625 of file Database.php.
Wikimedia\Rdbms\Database::reportQueryError | ( | $error, | |
$errno, | |||
$sql, | |||
$fname, | |||
$ignore = false ) |
Report a query error.
If $ignore is set, emit a DEBUG level log entry and continue, otherwise, emit an ERROR level log entry and throw an exception.
string | $error | |
int | string | $errno | |
string | $sql | |
string | $fname | |
bool | $ignore | Whether to just log an error rather than throw an exception |
DBQueryError |
Definition at line 1179 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\checkInsertWarnings(), Wikimedia\Rdbms\DatabaseMySQL\doSelectDomain(), Wikimedia\Rdbms\DatabaseMySQL\open(), and Wikimedia\Rdbms\Database\query().
|
protected |
Restore the previous error handler and return the last PHP error for this DB.
Definition at line 434 of file Database.php.
References Wikimedia\Rdbms\Database\getLastPHPError().
Referenced by Wikimedia\Rdbms\DatabaseMySQL\open(), and Wikimedia\Rdbms\DatabasePostgres\open().
Wikimedia\Rdbms\Database::restoreFlags | ( | $state = self::RESTORE_PRIOR | ) |
Restore the flags to their prior state before the last setFlag/clearFlag call.
string | $state | IDatabase::RESTORE_* constant. [default: RESTORE_PRIOR] |
Implements Wikimedia\Rdbms\Database\IDatabaseFlags.
Definition at line 3256 of file Database.php.
|
final |
Rollback a transaction previously started using begin()
Only call this from code with outer transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported. If a serious unexpected error occurs, throwing an Exception is preferable, using a pre-installed error handler to trigger rollback (in any case, failure to issue COMMIT will cause rollback server-side).
Query, connection, and onTransaction* callback errors will be suppressed and logged.
string | $fname | Calling function name |
string | $flush | Flush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly rolling back implicit transactions. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context. |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2395 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\close().
Wikimedia\Rdbms\Database::runOnTransactionIdleCallbacks | ( | $trigger, | |
array & | $errors = [] ) |
Consume and run any "on transaction idle/resolution" callbacks.
int | $trigger | IDatabase::TRIGGER_* constant |
DBError[] | &$errors | DB exceptions caught [returned] |
DBUnexpectedError | |
Throwable | Any non-DBError exception thrown by a callback |
Definition at line 2027 of file Database.php.
Wikimedia\Rdbms\Database::runOnTransactionPreCommitCallbacks | ( | ) |
Definition at line 3312 of file Database.php.
Wikimedia\Rdbms\Database::runTransactionListenerCallbacks | ( | $trigger, | |
array & | $errors = [] ) |
Actually run any "transaction listener" callbacks.
int | $trigger | IDatabase::TRIGGER_* constant |
DBError[] | &$errors | DB exceptions caught [returned] |
Throwable | Any non-DBError exception thrown by a callback |
Definition at line 2082 of file Database.php.
Wikimedia\Rdbms\Database::select | ( | $tables, | |
$vars, | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Execute a SELECT query constructed using the various parameters provided.
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchResultSet
instead, which is more readable and less error-prone.
string | array | $tables | Table reference(s), using the unqualified name of tables or of the form "information_schema.<identifier>". |
Each table reference assigns a table name to a specified collection of rows for the context of the query (e.g. field expressions, WHERE clause, GROUP BY clause, HAVING clause, ect...). Use of multiple table references implies a JOIN.
If a string is given, it must hold the name of the table having the specified collection of rows. If an array is given, each entry must be one of the following:
String keys allow table aliases to be specified, for example:
[ 'a' => 'user' ]
This includes the user table in the query, with the alias "a" available for use in field names (e.g. a.user_name).
A derived table, defined by the result of selectSQLText(), requires an alias key and a Subquery instance value which wraps the SQL query, for example:
[ 'c' => new Subquery( 'SELECT ...' ) ]
Joins using parentheses for grouping (since MediaWiki 1.31) may be constructed using nested arrays. For example,
[ 'tableA', 'nestedB' => [ 'tableB', 'b2' => 'tableB2' ] ]
along with $join_conds
like
[ 'b2' => [ 'JOIN', 'b_id = b2_id' ], 'nestedB' => [ 'LEFT JOIN', 'b_a = a_id' ] ]
will produce SQL something like
FROM tableA LEFT JOIN (tableB JOIN tableB2 AS b2 ON (b_id = b2_id)) ON (b_a = a_id)
All of the table names given here are automatically run through Database::tableName(), which causes the table prefix (if any) to be added, and various other table name mappings to be performed.
Do not use untrusted user input as a table name. Alias names should not have characters outside of the Basic multilingual plane.
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.
@phpcs:ignore Generic.Files.LineLength
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $conds |
May be either a string containing a single condition, or an array of conditions. If an array is given, the conditions constructed from each element are combined with AND.
Array elements may take one of two forms:
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 IDatabase::ALL_ROWS to select all rows.
You can put simple join conditions here, but this is strongly discouraged. Instead of
// $conds... 'rev_actor = actor_id',
use (see below for $join_conds):
// $join_conds... 'actor' => [ 'JOIN', 'rev_actor = actor_id' ],
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:
And also the following boolean MySQL extensions, see the MySQL manual for documentation:
string | array | $join_conds | Join conditions |
Optional associative array of table-specific join conditions. Simple conditions can also be specified in the regular $conds, but this is strongly discouraged in favor of the more explicit syntax here.
The key of the array contains the table name or alias. The value is an array with two elements, numbered 0 and 1. The first gives the type of join, the second is the same as the $conds parameter. Thus it can be an SQL fragment, or an array where the string keys are equality and the numeric keys are SQL fragments all AND'd together. For example:
[ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1362 of file Database.php.
|
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
string | DatabaseDomain | $domain |
DBConnectionError | If databasesAreIndependent() is true and connection change fails |
DBError | On query error, if domain changes are disallowed, or the domain is invalid |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1535 of file Database.php.
Wikimedia\Rdbms\Database::selectField | ( | $tables, | |
$var, | |||
$cond = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
A SELECT wrapper which returns a single field from a single result row.
If no result rows are returned from the query, false is returned.
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchField
instead, which is more readable and less error-prone.
string | array | $tables | Table reference(s), using the unqualified name of tables or of the form "information_schema.<identifier>". { |
string | array | $var | The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. Can be an array, but must contain exactly 1 element then. { |
@phpcs:ignore Generic.Files.LineLength
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $cond The condition array. { |
string | $fname | The function name of the caller. |
string | array | $options | The query options. { |
string | array | $join_conds | The query join conditions. { |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1314 of file Database.php.
Wikimedia\Rdbms\Database::selectFieldValues | ( | $tables, | |
$var, | |||
$cond = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
A SELECT wrapper which returns a list of single field values from result rows.
If no result rows are returned from the query, an empty array is returned.
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchFieldValues
instead, which is more readable and less error-prone.
string | array | $tables | Table reference(s), using the unqualified name of tables or of the form "information_schema.<identifier>". { |
string | $var | The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. |
@phpcs:ignore Generic.Files.LineLength
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $cond The condition array. { |
string | $fname | The function name of the caller. |
string | array | $options | The query options. { |
string | array | $join_conds | The query join conditions. { |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1339 of file Database.php.
Wikimedia\Rdbms\Database::selectRow | ( | $tables, | |
$vars, | |||
$conds, | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Wrapper to IDatabase::select() that only fetches one row (via LIMIT)
If the query returns no rows, false is returned.
This method is convenient for fetching a row based on a unique key condition.
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchRow
instead, which is more readable and less error-prone.
string | array | $tables | Table reference(s), using the unqualified name of tables or of the form "information_schema.<identifier>". { |
string | array | $vars | Field names |
@phpcs:ignore Generic.Files.LineLength
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $conds Conditions | |
string | $fname | Caller function name |
string | array | $options | Query options |
array | string | $join_conds | Join conditions |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1378 of file Database.php.
Wikimedia\Rdbms\Database::selectRowCount | ( | $tables, | |
$var = ' *', | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Get the number of rows in dataset.
This is useful when trying to do COUNT(*) but with a LIMIT for performance.
Takes the same arguments as IDatabase::select().
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchRowCount
instead, which is more readable and less error-prone.
string | string[] | $tables | Table reference(s), using the unqualified name of tables or of the form "information_schema.<identifier>". { |
string | $var | Column for which NULL values are not counted [default "*"] |
@phpcs:ignore Generic.Files.LineLength
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $conds Filters on the table | |
string | $fname | Function name for profiling |
array | $options | Options for select |
array | $join_conds | Join conditions (since 1.27) |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1416 of file Database.php.
Wikimedia\Rdbms\Database::selectSQLText | ( | $tables, | |
$vars, | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Take the same arguments as IDatabase::select() and return the SQL it would use.
This can be useful for making UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().
string | array | $tables | Table reference(s), using the unqualified name of tables or of the form "information_schema.<identifier>". |
string | array | $vars | Field names |
@phpcs:ignore Generic.Files.LineLength
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $conds Conditions | |
string | $fname | Caller function name |
string | array | $options | Query options |
string | array | $join_conds | Join conditions |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 3328 of file Database.php.
Wikimedia\Rdbms\Database::serverIsReadOnly | ( | ) |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabaseForOwner.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1944 of file Database.php.
Wikimedia\Rdbms\Database::sessionLocksPending | ( | ) |
Definition at line 387 of file Database.php.
Wikimedia\Rdbms\Database::setFlag | ( | $flag, | |
$remember = self::REMEMBER_NOTHING ) |
Set a flag for this connection.
int | $flag | One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX) |
string | $remember | IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING] |
Implements Wikimedia\Rdbms\Database\IDatabaseFlags.
Definition at line 3248 of file Database.php.
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.
string[] | $aliases |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3462 of file Database.php.
Wikimedia\Rdbms\Database::setLBInfo | ( | $nameOrArray, | |
$value = null ) |
Set the entire array or a particular key of the managing load balancer info array.
Keys matching the IDatabase::LB_* constants are also used internally by subclasses
array | string | $nameOrArray | The new array or the name of a key to set |
array | mixed | null | $value | If $nameOrArray is a string, the new key value (null to unset) |
Implements Wikimedia\Rdbms\IDatabaseForOwner.
Definition at line 364 of file Database.php.
References Wikimedia\Rdbms\Database\lbInfo.
Referenced by Wikimedia\Rdbms\LoadBalancerSingle\__construct().
Wikimedia\Rdbms\Database::setLogger | ( | LoggerInterface | $logger | ) |
Set the PSR-3 logger interface to use.
LoggerInterface | $logger |
Definition at line 306 of file Database.php.
Wikimedia\Rdbms\Database::setSchemaVars | ( | $vars | ) |
Set schema variables to be used when streaming commands from SQL files or stdin.
Variables appear as SQL comments and are substituted by their corresponding values
array | null | $vars | Map of (variable => value) or null to use the defaults |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3483 of file Database.php.
Wikimedia\Rdbms\Database::setSessionOptions | ( | array | $options | ) |
Override database's default behavior.
Not all options are supported on all database backends; unsupported options are silently ignored.
$options include:
array | $options |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 2732 of file Database.php.
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.
array[] | $aliases | Map of (unqualified name of table => (dbname, schema, prefix) map) |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3454 of file Database.php.
|
final |
Run a callback after each time any transaction commits or rolls back.
The callback takes two arguments:
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.
string | $name | Callback name |
callable | null | $callback | Use null to unset a listener |
Implements Wikimedia\Rdbms\IDatabaseForOwner.
Definition at line 1999 of file Database.php.
Wikimedia\Rdbms\Database::setTransactionManager | ( | TransactionManager | $transactionManager | ) |
TransactionManager | $transactionManager |
Definition at line 2459 of file Database.php.
|
final |
Whether to disable running of post-COMMIT/ROLLBACK callbacks.
bool | $suppress |
Definition at line 2011 of file Database.php.
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).
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 |
string | false | $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 |
Exception |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 2735 of file Database.php.
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).
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 |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 2767 of file Database.php.
|
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:
Example usage:
Example usage (atomic changes that might have to be discarded):
string | $fname | |
string | $cancelable | Pass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section. |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2128 of file Database.php.
Wikimedia\Rdbms\Database::streamStatementEnd | ( | & | $sql, |
& | $newLine ) |
Called by sourceStream() to check if we've reached a statement end.
string | &$sql | SQL assembled so far |
string | &$newLine | New line about to be added to $sql |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 2844 of file Database.php.
|
abstract |
Wrapper for addslashes()
string | $s | String to be slashed. |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Wikimedia\Rdbms\Database::strreplace | ( | $orig, | |
$old, | |||
$new ) |
Returns a SQL expression for simple string replacement (e.g.
REPLACE() in mysql)
string | $orig | Column to modify |
string | $old | Column to seek |
string | $new | Column to replace with |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3430 of file Database.php.
|
abstract |
Query whether a given table exists.
string | $table | The unqualified name of a table |
string | $fname |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Wikimedia\Rdbms\Database::tableName | ( | string | $name, |
$format = 'quoted' ) |
Format a table name ready for use in constructing an SQL query.
This does two important things: it quotes the table names to clean them up, and it adds a table prefix if only given a table name with no quotes.
All functions of this object which require a table name call this function themselves. Pass the canonical name to such functions. This is only needed when calling query()
directly.
The provided name should not qualify the database nor the schema, unless the name is of the form "information_schema.<identifier>". Unlike information_schema tables, regular tables can receive writes and are subject to configuration regarding table aliases, virtual domains, and LBFactory sharding. Callers needing to access remote databases should use appropriate connection factory methods.
string | $name | The unqualified name of a table (no quotes, db, schema, nor table prefix), or a table name of the form "information_schema.<unquoted identifier>". |
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. |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3386 of file Database.php.
Referenced by Wikimedia\Rdbms\PostgresField\fromText().
Wikimedia\Rdbms\Database::tableNamesN | ( | $tables | ) |
Fetch a number of table names into a zero-indexed numerical array.
Much like tableName()
, this is only needed when calling query()
directly. You should prefer calling other methods, or using SelectQueryBuilder
.
Theoretical example (which really does not require raw SQL):
string | ...$tables |
tableName
. Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3390 of file Database.php.
Wikimedia\Rdbms\Database::tablePrefix | ( | $prefix = null | ) |
Get/set the table prefix.
string | null | $prefix | The table prefix to set, or omitted to leave it unchanged |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 314 of file Database.php.
References Wikimedia\Rdbms\Database\currentDomain, and Wikimedia\Rdbms\Database\platform.
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.
string | int | $ts |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3434 of file Database.php.
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.
string | int | null | $ts |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3438 of file Database.php.
Wikimedia\Rdbms\Database::truncateTable | ( | $table, | |
$fname = __METHOD__ ) |
Delete all data in a table and reset any sequences owned by that table.
string | $table | The unqualified name of a table |
string | $fname |
DBError | If an error occurs |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3014 of file Database.php.
|
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.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3268 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\close().
Wikimedia\Rdbms\Database::trxStatus | ( | ) |
Definition at line 3282 of file Database.php.
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).
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3278 of file Database.php.
Wikimedia\Rdbms\Database::unionQueries | ( | $sqls, | |
$all, | |||
$options = [] ) |
Construct a UNION query.
This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.
array | $sqls | SQL statements to combine |
bool | $all | Either IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT |
array | $options | Query options |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3422 of file Database.php.
Wikimedia\Rdbms\Database::unionSupportsOrderAndLimit | ( | ) |
Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3418 of file Database.php.
Wikimedia\Rdbms\Database::unlock | ( | $lockName, | |
$method ) |
Release a lock.Named locks are not related to transactions
string | $lockName | Name of lock to release |
string | $method | Name of the calling method |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2929 of file Database.php.
Wikimedia\Rdbms\Database::update | ( | $table, | |
$set, | |||
$conds, | |||
$fname = __METHOD__, | |||
$options = [] ) |
Update all rows in a table that match a given condition.
This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
string | $table | The unqualified name of a table |
array<string,?scalar|RawSQLValue>|array<int,string> | $set Combination map/list where each string-keyed entry maps a column to a literal assigned value and each integer-keyed value is a SQL expression in the format of a column assignment within UPDATE...SET. The (column => value) entries are convenient due to automatic value quoting and conversion of null to NULL. The SQL assignment format is useful for updates like "column = column + X". All assignments have no defined execution order, so they should not depend on each other. Do not modify AUTOINCREMENT or UUID columns in assignments. |
@phpcs:ignore Generic.Files.LineLength
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>|RawSQLValue>|array<int,string|IExpression> | $conds Condition in the format of IDatabase::select() conditions. In order to prevent possible performance or replication issues or damaging a data accidentally, an empty condition for 'update' queries isn't allowed. IDatabase::ALL_ROWS should be passed explicitly in order to update all rows. | |
string | $fname | Calling function name (use METHOD) for logs/profiling |
string | array | $options | Combination map/list where each string-keyed entry maps a non-boolean option to the option parameters and each integer-keyed value is the name of a boolean option. Supported options are:
|
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1524 of file Database.php.
Wikimedia\Rdbms\Database::upsert | ( | $table, | |
array | $rows, | ||
$uniqueKeys, | |||
array | $set, | ||
$fname = __METHOD__ ) |
Upsert row(s) into a table, in the provided order, while updating conflicting rows.
Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.
This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.
string | $table | The unqualified name of a table |
array | array[] | $rows | Row(s) to insert, in the form of either:
|
string | string[] | string[][] | $uniqueKeys | Column name or non-empty list of column name lists that define all applicable unique keys on the table. There must only be one such key. Each unique key on the table is "applicable" unless either:
|
array<string,?scalar|RawSQLValue>|array<int,string> | $set Combination map/list where each string-keyed entry maps a column to a literal assigned value and each integer-keyed value is a SQL assignment expression of the form "<unquoted alphanumeric column> = <SQL expression>". The (column => value) entries are convenient due to automatic value quoting and conversion of null to NULL. The SQL assignment entries are useful for updates like "column = column + X". All of the assignments have no defined execution order, so callers should make sure that they not depend on each other. Do not modify AUTOINCREMENT or UUID columns in assignments, even if they are just "secondary" unique keys. For multi-row upserts, use buildExcludedValue() to reference the value of a column from the corresponding row in $rows that conflicts with the current row. | |
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1632 of file Database.php.
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().
Implements Wikimedia\Rdbms\IDatabaseForOwner.
Definition at line 3290 of file Database.php.
Wikimedia\Rdbms\Database::writesPending | ( | ) |
Implements Wikimedia\Rdbms\IDatabaseForOwner.
Definition at line 3286 of file Database.php.
|
protected |
Agent name for query profiling.
Definition at line 85 of file Database.php.
|
protected |
Whether this PHP instance is for a CLI script.
Definition at line 79 of file Database.php.
|
protected |
Database connection.
Definition at line 74 of file Database.php.
|
protected |
Connection parameters used by initConnection() and open()
Definition at line 87 of file Database.php.
|
protected |
SQL variables values to use for all new connections.
Definition at line 89 of file Database.php.
|
protected |
Maximum seconds to wait on connection attempts.
Definition at line 81 of file Database.php.
|
protected |
Definition at line 53 of file Database.php.
|
protected |
Definition at line 68 of file Database.php.
|
protected |
Current SQL query delimiter.
Definition at line 100 of file Database.php.
|
protected |
Deprecation logging callback.
Definition at line 59 of file Database.php.
|
protected |
Error logging callback.
Definition at line 57 of file Database.php.
if (is_string($params[ 'sqlMode'] ?? null)) Wikimedia\Rdbms\Database::$flags = (int)$params['flags'] |
Definition at line 223 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\DatabaseMySQL\open(), and Wikimedia\Rdbms\Database\query().
|
protected |
Definition at line 70 of file Database.php.
|
protected |
Current LoadBalancer tracking information.
Definition at line 98 of file Database.php.
|
protected |
Definition at line 55 of file Database.php.
|
protected |
Row batch size to use for emulated INSERT SELECT queries.
Definition at line 91 of file Database.php.
|
protected |
Definition at line 61 of file Database.php.
|
protected |
Maximum seconds to wait on receiving query results.
Definition at line 83 of file Database.php.
|
protected |
Readable name or host/IP of the database server.
Definition at line 77 of file Database.php.
|
protected |
Map of (lock name => (UNIX time,trx ID))
Definition at line 106 of file Database.php.
|
protected |
Whether to use SSL connections.
Definition at line 94 of file Database.php.
|
protected |
Whether to check for warnings.
Definition at line 96 of file Database.php.
$this Wikimedia\Rdbms\Database::agent = (string)$params['agent'] |
Definition at line 229 of file Database.php.
$this Wikimedia\Rdbms\Database::cliMode = (bool)$params['cliMode'] |
Definition at line 228 of file Database.php.
$this Wikimedia\Rdbms\Database::connectionParams |
Definition at line 200 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\doSelectDomain(), Wikimedia\Rdbms\Database\getLogContext(), and Wikimedia\Rdbms\Database\initConnection().
$this Wikimedia\Rdbms\Database::connectionVariables = $params['variables'] ?? [] |
Definition at line 218 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\open(), and Wikimedia\Rdbms\DatabaseSqlite\open().
$this Wikimedia\Rdbms\Database::connectTimeout = $params['connectTimeout'] ?? null |
Definition at line 226 of file Database.php.
$this Wikimedia\Rdbms\Database::csProvider = $params['criticalSectionProvider'] ?? null |
Definition at line 238 of file Database.php.
$this Wikimedia\Rdbms\Database::currentDomain |
Definition at line 241 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\__construct(), Wikimedia\Rdbms\DatabasePostgres\__construct(), Wikimedia\Rdbms\DatabaseSqlite\__construct(), Wikimedia\Rdbms\Database\dbSchema(), Wikimedia\Rdbms\DatabaseMySQL\doSelectDomain(), Wikimedia\Rdbms\DatabasePostgres\doSelectDomain(), Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\Database\getDomainID(), Wikimedia\Rdbms\DatabaseMySQL\open(), Wikimedia\Rdbms\DatabasePostgres\open(), Wikimedia\Rdbms\DatabaseSqlite\open(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tablePrefix().
$this Wikimedia\Rdbms\Database::deprecationLogger = $params['deprecationLogger'] |
Definition at line 236 of file Database.php.
$this Wikimedia\Rdbms\Database::errorLogger = $params['errorLogger'] |
Definition at line 235 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\__construct(), Wikimedia\Rdbms\DatabasePostgres\__construct(), and Wikimedia\Rdbms\DatabaseSqlite\__construct().
$this Wikimedia\Rdbms\Database::flagsHolder = new DatabaseFlags( $flags ) |
Definition at line 224 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getTransactionRoundFname(), and Wikimedia\Rdbms\DatabaseMySQL\open().
$this Wikimedia\Rdbms\Database::lbInfo = $params['lbInfo'] ?? [] |
Definition at line 217 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getLBInfo(), and Wikimedia\Rdbms\Database\setLBInfo().
$this Wikimedia\Rdbms\Database::nonNativeInsertSelectBatchSize = $params['nonNativeInsertSelectBatchSize'] ?? 10000 |
Definition at line 231 of file Database.php.
$this Wikimedia\Rdbms\Database::platform |
Definition at line 246 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\__construct(), Wikimedia\Rdbms\DatabasePostgres\__construct(), Wikimedia\Rdbms\DatabaseSqlite\__construct(), Wikimedia\Rdbms\Database\dbSchema(), Wikimedia\Rdbms\DatabaseMySQL\doSelectDomain(), Wikimedia\Rdbms\DatabasePostgres\doSelectDomain(), Wikimedia\Rdbms\Database\doSingleStatementQuery(), Wikimedia\Rdbms\DatabaseMySQL\open(), Wikimedia\Rdbms\DatabasePostgres\open(), Wikimedia\Rdbms\DatabaseSqlite\open(), Wikimedia\Rdbms\Database\registerTempTables(), and Wikimedia\Rdbms\Database\tablePrefix().
$this Wikimedia\Rdbms\Database::profiler = is_callable( $params['profiler'] ) ? $params['profiler'] : null |
Definition at line 234 of file Database.php.
$this Wikimedia\Rdbms\Database::receiveTimeout = $params['receiveTimeout'] ?? null |
Definition at line 227 of file Database.php.
$this Wikimedia\Rdbms\Database::serverName = $params['serverName'] |
Definition at line 230 of file Database.php.
$this Wikimedia\Rdbms\Database::ssl = $params['ssl'] ?? (bool)( $flags & self::DBO_SSL ) |
Definition at line 225 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\open().
$this Wikimedia\Rdbms\Database::strictWarnings = !empty( $params['strictWarnings'] ) |
Definition at line 232 of file Database.php.
$this Wikimedia\Rdbms\Database::tracer = $params['tracer'] ?? new NoopTracer() |
Definition at line 252 of file Database.php.
|
protected |
TempTableInfo>> Map of (DB name => table name => info)
Definition at line 196 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\close(), and Wikimedia\Rdbms\Database\registerTempTables().