MediaWiki
master
|
Relational database abstraction object. More...
Classes | |
class | DatabaseFlags |
interface | DbQuoter |
interface | IDatabaseFlags |
Public Member Functions | |||||||||||||||||||||
__clone () | |||||||||||||||||||||
Make sure that copies do not share the same client binding handle. More... | |||||||||||||||||||||
__construct (array $params) | |||||||||||||||||||||
__destruct () | |||||||||||||||||||||
Run a few simple checks and close dangling connections. More... | |||||||||||||||||||||
__sleep () | |||||||||||||||||||||
Called by serialize. More... | |||||||||||||||||||||
__toString () | |||||||||||||||||||||
Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present. More... | |||||||||||||||||||||
addIdentifierQuotes ( $s) | |||||||||||||||||||||
Escape a SQL identifier (e.g. More... | |||||||||||||||||||||
addQuotes ( $s) | |||||||||||||||||||||
Escape and quote a raw value string for use in a SQL query.
| |||||||||||||||||||||
affectedRows () | |||||||||||||||||||||
Get the number of rows affected by the last query method call. More... | |||||||||||||||||||||
anyChar () | |||||||||||||||||||||
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More... | |||||||||||||||||||||
anyString () | |||||||||||||||||||||
Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More... | |||||||||||||||||||||
begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT) | |||||||||||||||||||||
Begin a transaction. More... | |||||||||||||||||||||
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. More... | |||||||||||||||||||||
buildConcat ( $stringList) | |||||||||||||||||||||
Build a concatenation list to feed into a SQL query. More... | |||||||||||||||||||||
buildExcludedValue ( $column) | |||||||||||||||||||||
Build a reference to a column value from the conflicting proposed upsert() row. More... | |||||||||||||||||||||
buildGreatest ( $fields, $values) | |||||||||||||||||||||
Build a GREATEST function statement comparing columns/values. More... | |||||||||||||||||||||
buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[]) | |||||||||||||||||||||
Build a GROUP_CONCAT or equivalent statement for a query. More... | |||||||||||||||||||||
buildIntegerCast ( $field) | |||||||||||||||||||||
buildLeast ( $fields, $values) | |||||||||||||||||||||
Build a LEAST function statement comparing columns/values. More... | |||||||||||||||||||||
buildLike ( $param,... $params) | |||||||||||||||||||||
LIKE statement wrapper. More... | |||||||||||||||||||||
buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery. More... | |||||||||||||||||||||
buildStringCast ( $field) | |||||||||||||||||||||
buildSubstring ( $input, $startPosition, $length=null) | |||||||||||||||||||||
cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null) | |||||||||||||||||||||
Cancel an atomic section of SQL statements. More... | |||||||||||||||||||||
clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |||||||||||||||||||||
Clear a flag for this connection. More... | |||||||||||||||||||||
close ( $fname=__METHOD__) | |||||||||||||||||||||
Close the database connection. More... | |||||||||||||||||||||
commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Commits a transaction previously started using begin() More... | |||||||||||||||||||||
conditional ( $cond, $caseTrueExpression, $caseFalseExpression) | |||||||||||||||||||||
Returns an SQL expression for a simple conditional. More... | |||||||||||||||||||||
connectionErrorLogger ( $errno, $errstr) | |||||||||||||||||||||
Error handler for logging errors during database connection. More... | |||||||||||||||||||||
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.
| |||||||||||||||||||||
dbSchema ( $schema=null) | |||||||||||||||||||||
Get/set the db schema. More... | |||||||||||||||||||||
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.
| |||||||||||||||||||||
decodeExpiry ( $expiry, $format=TS_MW) | |||||||||||||||||||||
Decode an expiry time into a DBMS independent format. More... | |||||||||||||||||||||
delete ( $table, $conds, $fname=__METHOD__) | |||||||||||||||||||||
Delete all rows in a table that match a condition. More... | |||||||||||||||||||||
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.
| |||||||||||||||||||||
doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |||||||||||||||||||||
Perform an atomic section of reversible SQL statements from a callback. More... | |||||||||||||||||||||
dropTable ( $table, $fname=__METHOD__) | |||||||||||||||||||||
Delete a table. More... | |||||||||||||||||||||
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).
| |||||||||||||||||||||
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().
| |||||||||||||||||||||
encodeExpiry ( $expiry) | |||||||||||||||||||||
Encode an expiry time into the DBMS dependent format. More... | |||||||||||||||||||||
endAtomic ( $fname=__METHOD__) | |||||||||||||||||||||
Ends an atomic section of SQL statements. More... | |||||||||||||||||||||
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. More... | |||||||||||||||||||||
factorConds ( $condsArray) | |||||||||||||||||||||
Given an array of condition arrays representing an OR list of AND lists, for example: More... | |||||||||||||||||||||
fieldExists ( $table, $field, $fname=__METHOD__) | |||||||||||||||||||||
Determines whether a field exists in a table. More... | |||||||||||||||||||||
flushSession ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Release important session-level state (named lock, table locks) as post-rollback cleanup. More... | |||||||||||||||||||||
flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Commit any transaction but error out if writes or callbacks are pending. More... | |||||||||||||||||||||
getDBname () | |||||||||||||||||||||
Get the current database name; null if there isn't one. More... | |||||||||||||||||||||
getDomainID () | |||||||||||||||||||||
Return the currently selected domain ID. More... | |||||||||||||||||||||
getFlag ( $flag) | |||||||||||||||||||||
Returns a boolean whether the flag $flag is set for this connection. More... | |||||||||||||||||||||
getInfinity () | |||||||||||||||||||||
Find out when 'infinity' is. More... | |||||||||||||||||||||
getLag () | |||||||||||||||||||||
Get the seconds of replication lag on this database server. More... | |||||||||||||||||||||
getLBInfo ( $name=null) | |||||||||||||||||||||
Get properties passed down from the server info array of the load balancer. More... | |||||||||||||||||||||
getPrimaryPos () | |||||||||||||||||||||
Get the replication position of this primary DB server. More... | |||||||||||||||||||||
getReplicaPos () | |||||||||||||||||||||
Get the replication position of this replica DB. More... | |||||||||||||||||||||
getScopedLockAndFlush ( $lockKey, $fname, $timeout) | |||||||||||||||||||||
Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More... | |||||||||||||||||||||
getServer () | |||||||||||||||||||||
Get the hostname or IP address of the server. More... | |||||||||||||||||||||
getServerInfo () | |||||||||||||||||||||
Get a human-readable string describing the current software version. More... | |||||||||||||||||||||
getServerName () | |||||||||||||||||||||
Get the readable name for the server. More... | |||||||||||||||||||||
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. More... | |||||||||||||||||||||
getTableAliases () | |||||||||||||||||||||
Return current table aliases. More... | |||||||||||||||||||||
getTopologyBasedServerId () | |||||||||||||||||||||
Get a non-recycled ID that uniquely identifies this server within the replication topology. More... | |||||||||||||||||||||
getTopologyRole () | |||||||||||||||||||||
Get the replication topology role of this server. More... | |||||||||||||||||||||
implicitOrderby () | |||||||||||||||||||||
Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1. More... | |||||||||||||||||||||
indexExists ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Determines whether an index exists. More... | |||||||||||||||||||||
indexInfo ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Get information about an index into an object. More... | |||||||||||||||||||||
indexUnique ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Determines if a given index is unique.
| |||||||||||||||||||||
initConnection () | |||||||||||||||||||||
Initialize the connection to the database over the wire (or to local files) More... | |||||||||||||||||||||
insert ( $table, $rows, $fname=__METHOD__, $options=[]) | |||||||||||||||||||||
Insert row(s) into a table, in the provided order. More... | |||||||||||||||||||||
insertId () | |||||||||||||||||||||
Get the sequence-based ID assigned by the last query method call. More... | |||||||||||||||||||||
insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |||||||||||||||||||||
INSERT SELECT wrapper. More... | |||||||||||||||||||||
isOpen () | |||||||||||||||||||||
isQuotedIdentifier ( $name) | |||||||||||||||||||||
isReadOnly () | |||||||||||||||||||||
Check if this DB server is marked as read-only according to load balancer info. More... | |||||||||||||||||||||
lastDoneWrites () | |||||||||||||||||||||
Get the last time the connection may have been used for a write query. More... | |||||||||||||||||||||
limitResult ( $sql, $limit, $offset=false) | |||||||||||||||||||||
Construct a LIMIT query with optional offset. More... | |||||||||||||||||||||
listTables ( $prefix=null, $fname=__METHOD__) | |||||||||||||||||||||
List all tables on the database.
| |||||||||||||||||||||
listViews ( $prefix=null, $fname=__METHOD__) | |||||||||||||||||||||
Lists all the VIEWs in 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. More... | |||||||||||||||||||||
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. More... | |||||||||||||||||||||
makeWhereFrom2d ( $data, $baseKey, $subKey) | |||||||||||||||||||||
Build a "OR" condition with pairs from a two-dimensional array. More... | |||||||||||||||||||||
namedLocksEnqueue () | |||||||||||||||||||||
Check to see if a named lock used by lock() use blocking queues.
| |||||||||||||||||||||
newDeleteQueryBuilder () | |||||||||||||||||||||
Get a DeleteQueryBuilder bound to this connection. More... | |||||||||||||||||||||
newInsertQueryBuilder () | |||||||||||||||||||||
Get a InsertQueryBuilder bound to this connection. More... | |||||||||||||||||||||
newReplaceQueryBuilder () | |||||||||||||||||||||
Get a ReplaceQueryBuilder bound to this connection. More... | |||||||||||||||||||||
newSelectQueryBuilder () | |||||||||||||||||||||
Get a SelectQueryBuilder bound to this connection. More... | |||||||||||||||||||||
newUnionQueryBuilder () | |||||||||||||||||||||
Get a UnionQueryBuilder bound to this connection. More... | |||||||||||||||||||||
newUpdateQueryBuilder () | |||||||||||||||||||||
Get an UpdateQueryBuilder bound to this connection. More... | |||||||||||||||||||||
nextSequenceValue ( $seqName) | |||||||||||||||||||||
Deprecated method, calls should be removed. More... | |||||||||||||||||||||
onAtomicSectionCancel (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback when the atomic section is cancelled. More... | |||||||||||||||||||||
onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback when the current transaction commits or now if there is none. More... | |||||||||||||||||||||
onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback before the current transaction commits or now if there is none. More... | |||||||||||||||||||||
onTransactionResolution (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback when the current transaction commits or rolls back. More... | |||||||||||||||||||||
pendingWriteAndCallbackCallers () | |||||||||||||||||||||
pendingWriteCallers () | |||||||||||||||||||||
Get the list of method names that did write queries for this transaction. More... | |||||||||||||||||||||
pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL) | |||||||||||||||||||||
Get the time spend running write queries for this transaction. More... | |||||||||||||||||||||
ping () | |||||||||||||||||||||
Ping the server and try to reconnect if it there is no connection. More... | |||||||||||||||||||||
primaryPosWait (DBPrimaryPos $pos, $timeout) | |||||||||||||||||||||
Wait for the replica server to catch up to a given primary server position. More... | |||||||||||||||||||||
query ( $sql, $fname=__METHOD__, $flags=0) | |||||||||||||||||||||
Run an SQL query statement and return the result. More... | |||||||||||||||||||||
replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__) | |||||||||||||||||||||
Insert row(s) into a table, in the provided order, while deleting conflicting rows. More... | |||||||||||||||||||||
reportQueryError ( $error, $errno, $sql, $fname, $ignore=false) | |||||||||||||||||||||
Report a query error. More... | |||||||||||||||||||||
restoreFlags ( $state=self::RESTORE_PRIOR) | |||||||||||||||||||||
Restore the flags to their prior state before the last setFlag/clearFlag call. More... | |||||||||||||||||||||
rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Rollback a transaction previously started using begin() More... | |||||||||||||||||||||
runOnTransactionIdleCallbacks ( $trigger, array &$errors=[]) | |||||||||||||||||||||
Consume and run any "on transaction idle/resolution" callbacks. More... | |||||||||||||||||||||
runOnTransactionPreCommitCallbacks () | |||||||||||||||||||||
runTransactionListenerCallbacks ( $trigger, array &$errors=[]) | |||||||||||||||||||||
Actually run any "transaction listener" callbacks. More... | |||||||||||||||||||||
select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Execute a SELECT query constructed using the various parameters provided. More... | |||||||||||||||||||||
selectDomain ( $domain) | |||||||||||||||||||||
Set the current domain (database, schema, and table prefix) More... | |||||||||||||||||||||
selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
A SELECT wrapper which returns a single field from a single result row. More... | |||||||||||||||||||||
selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
A SELECT wrapper which returns a list of single field values from result rows. More... | |||||||||||||||||||||
selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Wrapper to IDatabase::select() that only fetches one row (via LIMIT) More... | |||||||||||||||||||||
selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Get the number of rows in dataset. More... | |||||||||||||||||||||
selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Take the same arguments as IDatabase::select() and return the SQL it would use. More... | |||||||||||||||||||||
serverIsReadOnly () | |||||||||||||||||||||
| |||||||||||||||||||||
sessionLocksPending () | |||||||||||||||||||||
setFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |||||||||||||||||||||
Set a flag for this connection. More... | |||||||||||||||||||||
setIndexAliases (array $aliases) | |||||||||||||||||||||
Convert certain index names to alternative names before querying the DB. More... | |||||||||||||||||||||
setLBInfo ( $nameOrArray, $value=null) | |||||||||||||||||||||
Set the entire array or a particular key of the managing load balancer info array. More... | |||||||||||||||||||||
setLogger (LoggerInterface $logger) | |||||||||||||||||||||
Set the PSR-3 logger interface to use. More... | |||||||||||||||||||||
setSchemaVars ( $vars) | |||||||||||||||||||||
Set schema variables to be used when streaming commands from SQL files or stdin. More... | |||||||||||||||||||||
setSessionOptions (array $options) | |||||||||||||||||||||
Override database's default behavior.Not all options are supported on all database backends; unsupported options are silently ignored.$options include:
| |||||||||||||||||||||
setTableAliases (array $aliases) | |||||||||||||||||||||
Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. More... | |||||||||||||||||||||
setTransactionListener ( $name, callable $callback=null) | |||||||||||||||||||||
Run a callback after each time any transaction commits or rolls back. More... | |||||||||||||||||||||
setTransactionManager (TransactionManager $transactionManager) | |||||||||||||||||||||
setTrxEndCallbackSuppression ( $suppress) | |||||||||||||||||||||
Whether to disable running of post-COMMIT/ROLLBACK callbacks. More... | |||||||||||||||||||||
sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null) | |||||||||||||||||||||
Read and execute SQL commands from a file. More... | |||||||||||||||||||||
sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null) | |||||||||||||||||||||
Read and execute commands from an open file handle. More... | |||||||||||||||||||||
startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |||||||||||||||||||||
Begin an atomic section of SQL statements. More... | |||||||||||||||||||||
streamStatementEnd (&$sql, &$newLine) | |||||||||||||||||||||
Called by sourceStream() to check if we've reached a statement end. More... | |||||||||||||||||||||
strencode ( $s) | |||||||||||||||||||||
Wrapper for addslashes() More... | |||||||||||||||||||||
strreplace ( $orig, $old, $new) | |||||||||||||||||||||
Returns a SQL expression for simple string replacement (e.g. More... | |||||||||||||||||||||
tableExists ( $table, $fname=__METHOD__) | |||||||||||||||||||||
Query whether a given table exists. More... | |||||||||||||||||||||
tableName ( $name, $format='quoted') | |||||||||||||||||||||
Format a table name ready for use in constructing an SQL query. More... | |||||||||||||||||||||
tableNames (... $tables) | |||||||||||||||||||||
Fetch a number of table names into an associative array. More... | |||||||||||||||||||||
tableNamesN (... $tables) | |||||||||||||||||||||
Fetch a number of table names into a zero-indexed numerical array. More... | |||||||||||||||||||||
tablePrefix ( $prefix=null) | |||||||||||||||||||||
Get/set the table prefix. More... | |||||||||||||||||||||
textFieldSize ( $table, $field) | |||||||||||||||||||||
Returns the size of a text field, or -1 for "unlimited".
| |||||||||||||||||||||
timestamp ( $ts=0) | |||||||||||||||||||||
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. More... | |||||||||||||||||||||
timestampOrNull ( $ts=null) | |||||||||||||||||||||
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. More... | |||||||||||||||||||||
truncate ( $tables, $fname=__METHOD__) | |||||||||||||||||||||
Delete all data in a table(s) and reset any sequences owned by that table(s) More... | |||||||||||||||||||||
trxLevel () | |||||||||||||||||||||
Gets the current transaction level. More... | |||||||||||||||||||||
trxStatus () | |||||||||||||||||||||
trxTimestamp () | |||||||||||||||||||||
Get the UNIX timestamp of the time that the transaction was established. More... | |||||||||||||||||||||
unionQueries ( $sqls, $all, $options=[]) | |||||||||||||||||||||
Construct a UNION query. More... | |||||||||||||||||||||
unionSupportsOrderAndLimit () | |||||||||||||||||||||
Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION. More... | |||||||||||||||||||||
unlock ( $lockName, $method) | |||||||||||||||||||||
Release a lock.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. More... | |||||||||||||||||||||
upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__) | |||||||||||||||||||||
Upsert row(s) into a table, in the provided order, while updating conflicting rows. More... | |||||||||||||||||||||
wasDeadlock () | |||||||||||||||||||||
Determines if the last failure was due to a deadlock.Note that during a deadlock, the prior transaction will have been lost
| |||||||||||||||||||||
wasReadOnlyError () | |||||||||||||||||||||
Determines if the last failure was due to the database being read-only.
| |||||||||||||||||||||
writesOrCallbacksPending () | |||||||||||||||||||||
Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. More... | |||||||||||||||||||||
writesPending () | |||||||||||||||||||||
![]() | |||||||||||||||||||||
getServerVersion () | |||||||||||||||||||||
A string describing the current software version, like from mysql_get_server_info() More... | |||||||||||||||||||||
getSoftwareLink () | |||||||||||||||||||||
Returns a wikitext style link to the DB's website (e.g. More... | |||||||||||||||||||||
getType () | |||||||||||||||||||||
Get the RDBMS type of the server (e.g. More... | |||||||||||||||||||||
lastErrno () | |||||||||||||||||||||
Get the RDBMS-specific error code from the last attempted query statement. More... | |||||||||||||||||||||
lastError () | |||||||||||||||||||||
Get the RDBMS-specific error description from the last attempted query statement. More... | |||||||||||||||||||||
![]() | |||||||||||||||||||||
buildSubString ( $input, $startPosition, $length=null) | |||||||||||||||||||||
Build a SUBSTRING function. More... | |||||||||||||||||||||
![]() | |||||||||||||||||||||
fieldInfo ( $table, $field) | |||||||||||||||||||||
Get information about a field Returns false if the field doesn't exist. More... | |||||||||||||||||||||
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. More... | |
Protected Member Functions | |
assertHasConnectionHandle () | |
Make sure there is an open connection handle (alive or not) More... | |
closeConnection () | |
Closes underlying database connection. More... | |
commenceCriticalSection (string $fname) | |
Demark the start of a critical section of session/transaction state changes. More... | |
completeCriticalSection (string $fname, ?CriticalSectionScope $csm, Throwable $trxError=null) | |
Demark the completion of a critical section of session/transaction state changes. More... | |
doBegin ( $fname) | |
Issues the BEGIN command to the database server. More... | |
doFlushSession ( $fname) | |
Reset the server-side session state for named locks and table locks. More... | |
doHandleSessionLossPreconnect () | |
Reset any additional subclass trx* and session* fields. More... | |
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. More... | |
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. More... | |
doTruncate (array $tables, $fname) | |
doUnlock (string $lockName, string $method) | |
executeQuery ( $sql, $fname, $flags) | |
Execute a query without enforcing public (non-Database) caller restrictions. More... | |
getBindingHandle () | |
Get the underlying binding connection handle. More... | |
getInsertIdColumnForUpsert ( $table) | |
getLastPHPError () | |
getLogContext (array $extras=[]) | |
Create a log context to pass to PSR-3 logger functions. More... | |
getReadOnlyReason () | |
getTransactionRoundId () | |
getValueTypesForWithClause ( $table) | |
installErrorHandler () | |
Set a custom error handler for logging errors during database connection. More... | |
isConnectionError ( $errno) | |
Do not use this method outside of Database/DBError classes. More... | |
isInsertSelectSafe (array $insertOptions, array $selectOptions) | |
isKnownStatementRollbackError ( $errno) | |
isQueryTimeoutError ( $errno) | |
Checks whether the cause of the error is detected to be a timeout. More... | |
lastInsertId () | |
Get a row ID from the last insert statement to implicitly assign one within the session. More... | |
newExceptionAfterConnectError ( $error) | |
open ( $server, $user, $password, $db, $schema, $tablePrefix) | |
Open a new connection to the database (closing any existing one) More... | |
registerTempWrites ( $ret, array $changes) | |
replaceLostConnection ( $lastErrno, $fname) | |
Close any existing (dead) database connection and open a new connection. More... | |
restoreErrorHandler () | |
Restore the previous error handler and return the last PHP error for this DB. More... | |
Protected Attributes | |
string | $agent |
Agent name for query profiling. More... | |
bool | $cliMode |
Whether this PHP instance is for a CLI script. More... | |
object resource null | $conn |
Database connection. More... | |
array< string, mixed > | $connectionParams |
Connection parameters used by initConnection() and open() More... | |
string[] int[] float[] | $connectionVariables |
SQL variables values to use for all new connections. More... | |
int null | $connectTimeout |
Maximum seconds to wait on connection attempts. More... | |
CriticalSectionProvider null | $csProvider |
DatabaseDomain | $currentDomain |
string false | $delimiter = ';' |
Current SQL query delimiter. More... | |
callable | $deprecationLogger |
Deprecation logging callback. More... | |
callable | $errorLogger |
Error logging callback. More... | |
DatabaseFlags | $flagsHolder |
string | $lastConnectError = '' |
Last error during connection; empty string if none. More... | |
int null | $lastEmulatedAffectedRows |
Affected row count for the last query method call; null if unspecified. More... | |
int null | $lastEmulatedInsertId |
Insert (row) ID for the last query method call; null if unspecified. More... | |
int | $lastQueryAffectedRows = 0 |
Affected row count for the last statement to query() More... | |
int null | $lastQueryInsertId |
Insert (row) ID for the last statement to query() (null if not supported) More... | |
array | $lbInfo = [] |
Current LoadBalancer tracking information. More... | |
LoggerInterface | $logger |
int | $nonNativeInsertSelectBatchSize |
Row batch size to use for emulated INSERT SELECT queries. More... | |
SQLPlatform | $platform |
callable null | $profiler |
int null | $receiveTimeout |
Maximum seconds to wait on receiving query results. More... | |
ReplicationReporter | $replicationReporter |
string null | $serverName |
Readable name or host/IP of the database server. More... | |
array< string, array > | $sessionNamedLocks = [] |
Map of (name => (UNIX time,trx ID)) for current lock() mutexes. More... | |
array< string, array > | $sessionTempTables = [] |
Map of (name => (type,pristine,trx ID)) for current temp tables. More... | |
bool | $ssl |
Whether to use SSL connections. More... | |
const | CONN_HOST = 'host' |
Hostname or IP address to use on all connections. More... | |
const | CONN_INITIAL_DB = 'dbname' |
Database name to use on initial connection. More... | |
const | CONN_INITIAL_SCHEMA = 'schema' |
Schema name to use on initial connection. More... | |
const | CONN_INITIAL_TABLE_PREFIX = 'tablePrefix' |
Table prefix to use on initial connection. More... | |
const | CONN_PASSWORD = 'password' |
Database server password to use on all connections. More... | |
const | CONN_USER = 'user' |
Database server username to use on all connections. More... | |
const | DROPPED_CONN_BLAME_THRESHOLD_SEC = 3.0 |
Assume that queries taking this long to yield connection loss errors are at fault. More... | |
const | ERR_ABORT_QUERY = 2 |
Abort query (no retries) due to a statement rollback (session/transaction intact) More... | |
const | ERR_ABORT_SESSION = 8 |
Abort and reset session due to server-side session-level state loss (locks, temp tables) More... | |
const | ERR_ABORT_TRX = 4 |
Abort any current transaction, by rolling it back, due to an error during the query. More... | |
const | ERR_NONE = 0 |
No errors occurred during the query. More... | |
const | ERR_RETRY_QUERY = 1 |
Retry query due to a connection loss detected while sending the query (session intact) More... | |
Additional Inherited Members | |
![]() | |
const | LOCK_TIMESTAMP = 1 |
Flag to return the lock acquisition timestamp (null if not acquired) More... | |
![]() | |
const | QUERY_PSEUDO_PERMANENT = 2 |
Track a TEMPORARY table CREATE as if it was for a permanent table (for testing) More... | |
![]() | |
const | DBO_COMPRESS = 512 |
Enable compression in connection protocol. More... | |
const | DBO_DDLMODE = 128 |
Schema file mode; was used by Oracle. More... | |
const | DBO_DEBUG = 1 |
Enable debug logging of all SQL queries. More... | |
const | DBO_DEFAULT = 16 |
Join load balancer transaction rounds (which control DBO_TRX) in non-CLI mode. More... | |
const | DBO_GAUGE = 1024 |
Optimize connection for guaging server state (e.g. More... | |
const | DBO_IGNORE = 4 |
Unused since 1.31. More... | |
const | DBO_NOBUFFER = 2 |
Unused since 1.34. More... | |
const | DBO_PERSISTENT = 32 |
Use DB persistent connections if possible. More... | |
const | DBO_SSL = 256 |
Enable SSL/TLS in connection protocol. More... | |
const | DBO_SYSDBA = 64 |
DBA session mode; was used by Oracle. More... | |
const | DBO_TRX = 8 |
Automatically start a transaction before running a query if none is active. More... | |
const | REMEMBER_NOTHING = '' |
Do not remember the prior flags. More... | |
const | REMEMBER_PRIOR = 'remember' |
Remember the prior flags. More... | |
const | RESTORE_INITIAL = 'initial' |
Restore to the initial flag state. More... | |
const | RESTORE_PRIOR = 'prior' |
Restore to the prior flag state. More... | |
Relational database abstraction object.
Definition at line 44 of file Database.php.
Wikimedia\Rdbms\Database::__construct | ( | array | $params | ) |
array | $params | Parameters passed from Database::factory() |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 189 of file Database.php.
References DBO_SSL.
Wikimedia\Rdbms\Database::__destruct | ( | ) |
Run a few simple checks and close dangling connections.
Definition at line 3335 of file Database.php.
Wikimedia\Rdbms\Database::__clone | ( | ) |
Make sure that copies do not share the same client binding handle.
DBConnectionError |
Definition at line 3295 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 3327 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 3276 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 3509 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\doSelectDomain(), and Wikimedia\Rdbms\DatabaseMySQL\duplicateTableStructure().
Wikimedia\Rdbms\Database::addQuotes | ( | $s | ) |
Escape and quote a raw value string for use in a SQL query.
string | int | float | null | bool | Blob | $s |
Implements Wikimedia\Rdbms\Database\DbQuoter.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1580 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\doFlushSession(), and 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 2617 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 3521 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 3525 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 549 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 2366 of file Database.php.
Wikimedia\Rdbms\Database::bitAnd | ( | $fieldLeft, | |
$fieldRight | |||
) |
string | int | $fieldLeft | |
string | int | $fieldRight |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3465 of file Database.php.
Wikimedia\Rdbms\Database::bitNot | ( | $field | ) |
string | int | $field |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3461 of file Database.php.
Wikimedia\Rdbms\Database::bitOr | ( | $fieldLeft, | |
$fieldRight | |||
) |
string | int | $fieldLeft | |
string | int | $fieldRight |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3469 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.
You might also use it to generate a simple comparison without writing raw SQL:
$db->buildComparison( '<=', [ 'key' => $val ] ) // equivalent to: 'key <= ' . $db->addQuotes( $val )
string | $op | Comparison operator, one of '>', '>=', '<', '<=' |
array | $conds | Map of field names to their values to use in the comparison |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3445 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 3473 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 3594 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 3477 of file Database.php.
Wikimedia\Rdbms\Database::buildGroupConcatField | ( | $delim, | |
$table, | |||
$field, | |||
$conds = '' , |
|||
$join_conds = [] |
|||
) |
Build a GROUP_CONCAT or equivalent statement for a query.
This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.
string | $delim | Glue to bind the results together |
string | array | $table | Table name |
string | $field | Field name |
string | array | $conds | Conditions |
string | array | $join_conds | Join conditions |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3581 of file Database.php.
Wikimedia\Rdbms\Database::buildIntegerCast | ( | $field | ) |
string | $field | Field or column to cast |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3493 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 3481 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 3517 of file Database.php.
Wikimedia\Rdbms\Database::buildSelectSubquery | ( | $table, | |
$vars, | |||
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery.
string | array | $table | Table name |
string | array | $vars | Field names |
string | array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
string | array | $join_conds | Join conditions |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3587 of file Database.php.
Wikimedia\Rdbms\Database::buildStringCast | ( | $field | ) |
string | $field | Field or column to cast |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3489 of file Database.php.
Wikimedia\Rdbms\Database::buildSubstring | ( | $input, | |
$startPosition, | |||
$length = null |
|||
) |
Definition at line 3485 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 2272 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 3363 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 494 of file Database.php.
References Wikimedia\Rdbms\Database\closeConnection(), Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers(), Wikimedia\Rdbms\Database\rollback(), 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\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
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 3210 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 2411 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 3253 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 | array | $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 3541 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 473 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\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1535 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 323 of file Database.php.
References Wikimedia\Rdbms\Database\getDBname().
Referenced by DatabaseInstaller\selectDatabase().
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\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 2790 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 3565 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 | Table name |
string | array | $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 1772 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 table to delete from. |
string | $joinTable | The reference table used by the join (not modified). |
string | $delVar | The variable to join on, in the first table. |
string | $joinVar | The variable to join on, in the second table. |
array | string | $conds | Condition array of field names mapped to variables, ANDed together in the WHERE clause |
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1733 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 2345 of file Database.php.
|
protected |
Issues the BEGIN command to the database server.
string | $fname |
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2406 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\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 2579 of file Database.php.
|
protected |
Reset any additional subclass trx* and session* fields.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1155 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 | |
string | array | $srcTable | |
array | $varMap | |
array | $conds | |
string | $fname | |
array | $insertOptions | |
array | $selectOptions | |
array | $selectJoinConds |
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1915 of file Database.php.
|
protected |
string | $lockName | |
string | $method | |
int | $timeout |
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 2994 of file Database.php.
|
protected |
string | $lockName | |
string | $method |
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 2955 of file Database.php.
|
protected |
DatabaseDomain | $domain |
DBConnectionError | |
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1559 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\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
References Wikimedia\Rdbms\Query\getTables(), and Wikimedia\Rdbms\Query\getVerb().
|
protected |
string[] | $tables | |
string | $fname |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 3122 of file Database.php.
|
protected |
string | $lockName | |
string | $method |
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 3032 of file Database.php.
Wikimedia\Rdbms\Database::dropTable | ( | $table, | |
$fname = __METHOD__ |
|||
) |
Delete a table.
string | $table | |
string | $fname |
DBError | If an error occurs |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 3079 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\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 2592 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\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 2782 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 3561 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 2239 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 name(s) |
string | $var | Column for which NULL values are not counted [default "*"] |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select |
array | string | $join_conds | Join conditions |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IReadableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1408 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 class QUERY_* constants |
DBUnexpectedError |
Definition at line 701 of file Database.php.
References $source, Wikimedia\Rdbms\Database\assertHasConnectionHandle(), Wikimedia\Rdbms\Database\commenceCriticalSection(), Wikimedia\Rdbms\Database\completeCriticalSection(), Wikimedia\Rdbms\Database\getReadOnlyReason(), and Wikimedia\Rdbms\Database\registerTempWrites().
Referenced by Wikimedia\Rdbms\DatabaseMySQL\doFlushSession(), 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 3427 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 3457 of file Database.php.
Wikimedia\Rdbms\Database::fieldExists | ( | $table, | |
$field, | |||
$fname = __METHOD__ |
|||
) |
Determines whether a field exists in a table.
string | $table | Table name |
string | $field | Field to check on that table |
string | $fname | Calling function name (optional) |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 1479 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\IDatabase.
Definition at line 2516 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 2583 of file Database.php.
|
static |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 291 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 3163 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 2755 of file Database.php.
Referenced by MediaWiki\Storage\NameTableStore\getName(), MediaWiki\Block\DatabaseBlock\isExemptedFromAutoblocks(), 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 1564 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(), Wikimedia\Rdbms\Database\getLogContext(), and Wikimedia\Rdbms\DatabaseMySQL\listViews().
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 404 of file Database.php.
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 3371 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 3557 of file Database.php.
|
protected |
string | $table |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1716 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 3625 of file Database.php.
|
protected |
Definition at line 454 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 346 of file Database.php.
References Wikimedia\Rdbms\Database\$lbInfo.
Referenced by Wikimedia\Rdbms\Database\getTransactionRoundId().
|
protected |
Create a log context to pass to PSR-3 logger functions.
array | $extras | Additional data to add to context |
Definition at line 483 of file Database.php.
References 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\IDatabase.
Definition at line 3613 of file Database.php.
|
protected |
Definition at line 3137 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQuery().
Wikimedia\Rdbms\Database::getReplicaPos | ( | ) |
Get the replication position of this replica DB.
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 3609 of file Database.php.
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 3036 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 1568 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 304 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 1572 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 3629 of file Database.php.
Wikimedia\Rdbms\Database::getTableAliases | ( | ) |
Return current table aliases.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3573 of file Database.php.
Wikimedia\Rdbms\Database::getTopologyBasedServerId | ( | ) |
Get a non-recycled ID that uniquely identifies this server within the replication topology.
A replication topology defines which servers can originate changes to a given dataset and how those changes propagate among database servers. It is assumed that the server only participates in the replication of a single relevant dataset.
DBQueryError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3621 of file Database.php.
Wikimedia\Rdbms\Database::getTopologyRole | ( | ) |
Get the replication topology role of this server.
A replication topology defines which servers can originate changes to a given dataset and how those changes propagate among database servers. It is assumed that the server only participates in the replication of a single relevant dataset.
DBQueryError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3617 of file Database.php.
|
finalprotected |
Definition at line 388 of file Database.php.
References Wikimedia\Rdbms\Database\getLBInfo().
|
protected |
string | $table |
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1725 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 3435 of file Database.php.
Wikimedia\Rdbms\Database::indexExists | ( | $table, | |
$index, | |||
$fname = __METHOD__ |
|||
) |
Determines whether an index exists.
string | $table | |
string | $index | |
string | $fname |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 1485 of file Database.php.
|
abstract |
Get information about an index into an object.
string | $table | Table name |
string | $index | Index name |
string | $fname | Calling function name |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Wikimedia\Rdbms\Database::indexUnique | ( | $table, | |
$index, | |||
$fname = __METHOD__ |
|||
) |
Determines if a given index is unique.
string | $table | |
string | $index | |
string | $fname | Calling function name |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1504 of file Database.php.
|
final |
Initialize the connection to the database over the wire (or to local files)
LogicException | |
InvalidArgumentException | |
DBConnectionError |
Definition at line 257 of file Database.php.
References 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 | Table name |
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 1514 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 2623 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 | The table name to insert into |
string | array | $srcTable | May be either a table name, or an array of table names to include in a join. |
array | $varMap | Must be an associative array of the form [ 'dest1' => 'source1', ... ]. Source items may be literals rather than field names, but strings should be quoted with IDatabase::addQuotes() |
array | $conds | Condition array. See $conds in IDatabase::select() for the details of the format of condition arrays. May be "*" to copy the whole table. |
string | $fname | The function name of the caller, from METHOD |
array | $insertOptions | Options for the INSERT part of the query, see IDatabase::insert() for details. Also, one additional option is available: pass 'NO_AUTO_COLUMNS' to hint that the query does not use an auto-increment or sequence to determine any column values. |
array | $selectOptions | Options for the SELECT part of the query, see IDatabase::select() for details. |
array | $selectJoinConds | Join conditions for the SELECT part of the query, see IDatabase::select() for details. |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1778 of file Database.php.
|
protected |
Set a custom error handler for logging errors during database connection.
Definition at line 431 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\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1969 of file Database.php.
|
protected |
array | $insertOptions | |
array | $selectOptions |
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1829 of file Database.php.
|
protected |
int | string | $errno |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1981 of file Database.php.
Wikimedia\Rdbms\Database::isOpen | ( | ) |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 400 of file Database.php.
References Wikimedia\Rdbms\Database\$conn.
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\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1170 of file Database.php.
Wikimedia\Rdbms\Database::isQuotedIdentifier | ( | $name | ) |
Definition at line 3513 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 3130 of file Database.php.
Wikimedia\Rdbms\Database::lastDoneWrites | ( | ) |
Get the last time the connection may have been used for a write query.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 372 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\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
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 3529 of file Database.php.
Wikimedia\Rdbms\Database::listTables | ( | $prefix = null , |
|
$fname = __METHOD__ |
|||
) |
List all tables on the database.
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\DatabaseSqlite, Wikimedia\Rdbms\DatabaseMySQL, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 2605 of file Database.php.
Wikimedia\Rdbms\Database::listViews | ( | $prefix = null , |
|
$fname = __METHOD__ |
|||
) |
Lists all the VIEWs in the database.
string | null | $prefix | Only show VIEWs with this prefix, eg. unit_test_ |
string | $fname | Name of calling function |
RuntimeException |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 2613 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 2962 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 | Table name(s) |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select ("FOR UPDATE" is added automatically) |
array | $join_conds | Join conditions |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1463 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 2933 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 3449 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\upsert().
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 3453 of file Database.php.
Wikimedia\Rdbms\Database::namedLocksEnqueue | ( | ) |
Check to see if a named lock used by lock() use blocking queues.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 3075 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 1298 of file Database.php.
|
finalprotected |
string | $error |
Definition at line 1244 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 1308 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 1318 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 1268 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 1278 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 1288 of file Database.php.
Wikimedia\Rdbms\Database::nextSequenceValue | ( | $seqName | ) |
Deprecated method, calls should be removed.
This was formerly used for PostgreSQL to handle self::insertId() auto-incrementing fields. It is no longer necessary since DatabasePostgres::insertId() has been reimplemented using lastval()
Implementations should return null if inserting NULL
into an auto-incrementing field works, otherwise it should return an instance of NextSequenceValue and filter it on calls to relevant methods.
string | $seqName |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1595 of file Database.php.
|
final |
Run a callback when the atomic section is cancelled.
The callback is run just after the current atomic section, any outer atomic section, or the whole transaction is rolled back.
An error is thrown if no atomic section is pending. The atomic section need not have been created with the ATOMIC_CANCELABLE flag.
Queries in the function may be running in the context of an outer transaction or may be running in AUTOCOMMIT mode. The callback should use atomic sections if necessary.
The callback takes the following arguments:
callable | $callback | |
string | $fname | Caller name |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2044 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 1997 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 2015 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 1993 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\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Referenced by Wikimedia\Rdbms\Database\initConnection().
Wikimedia\Rdbms\Database::pendingWriteAndCallbackCallers | ( | ) |
Definition at line 3416 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\IDatabase.
Definition at line 3409 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\IDatabase.
Definition at line 3405 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 2652 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\IReadableDatabase.
Definition at line 3605 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 IDatabase::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 658 of file Database.php.
References Wikimedia\Rdbms\QueryBuilderFromRawSql\buildQuery(), Wikimedia\Rdbms\Database\executeQuery(), and Wikimedia\Rdbms\Database\reportQueryError().
Referenced by Wikimedia\Rdbms\DatabaseMySQL\doLock(), Wikimedia\Rdbms\DatabaseMySQL\doLockIsFree(), Wikimedia\Rdbms\DatabaseMySQL\doUnlock(), Wikimedia\Rdbms\DatabaseMySQL\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseMySQL\fieldInfo(), Wikimedia\Rdbms\PostgresField\fromText(), Wikimedia\Rdbms\DatabaseMySQL\indexInfo(), Wikimedia\Rdbms\DatabaseMySQL\listTables(), Wikimedia\Rdbms\DatabaseMySQL\listViews(), Wikimedia\Rdbms\DatabasePostgres\open(), Wikimedia\Rdbms\DatabaseSqlite\open(), Wikimedia\Rdbms\DatabaseMySQL\replace(), Wikimedia\Rdbms\DatabaseMySQL\serverIsReadOnly(), Wikimedia\Rdbms\DatabaseMySQL\setSessionOptions(), Wikimedia\Rdbms\DatabaseMySQL\tableExists(), and Wikimedia\Rdbms\DatabaseMySQL\upsert().
|
protected |
IResultWrapper | bool | $ret | |
array[] | $changes | List of change n-tuples with from getTempTableWrites() |
Definition at line 627 of file Database.php.
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 table name |
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\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1599 of file Database.php.
|
protected |
Close any existing (dead) database connection and open a new connection.
int | null | $lastErrno | |
string | $fname |
Definition at line 2682 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 1187 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\doFlushSession(), 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 442 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 3367 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 2448 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 2076 of file Database.php.
References DBO_TRX.
Wikimedia\Rdbms\Database::runOnTransactionPreCommitCallbacks | ( | ) |
Definition at line 3423 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 2131 of file Database.php.
Wikimedia\Rdbms\Database::select | ( | $table, | |
$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 | $table | Table name(s) |
May be either an array of table names, or a single string holding a table name. If an array is given, table aliases can be specified, for example:
[ 'a' => 'user' ]
This includes the user table in the query, with the alias "a" available for use in field names (e.g. a.user_name).
A derived table, defined by the result of selectSQLText(), requires an alias key and a Subquery instance value which wraps the SQL query, for example:
[ 'c' => new Subquery( 'SELECT ...' ) ]
Joins using parentheses for grouping (since MediaWiki 1.31) may be constructed using nested arrays. For example,
[ 'tableA', 'nestedB' => [ 'tableB', 'b2' => 'tableB2' ] ]
along with $join_conds
like
[ 'b2' => [ 'JOIN', 'b_id = b2_id' ], 'nestedB' => [ 'LEFT JOIN', 'b_a = a_id' ] ]
will produce SQL something like
FROM tableA LEFT JOIN (tableB JOIN tableB2 AS b2 ON (b_id = b2_id)) ON (b_a = a_id)
All of the table names given here are automatically run through Database::tableName(), which causes the table prefix (if any) to be added, and various other table name mappings to be performed.
Do not use untrusted user input as a table name. Alias names should not have characters outside of the Basic multilingual plane.
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.
string | array | $conds | May be either a string containing a single condition, or an array of conditions. If an array is given, the conditions constructed from each element are combined with AND. |
Array elements may take one of two forms:
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 1370 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\estimateRowCount().
|
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 1539 of file Database.php.
Referenced by DatabaseInstaller\selectDatabase().
Wikimedia\Rdbms\Database::selectField | ( | $table, | |
$var, | |||
$cond = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
A SELECT wrapper which returns a single field from a single result row.
If no result rows are returned from the query, false is returned.
New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchField instead, which is more readable and less error-prone.
string | array | $table | Table name. { |
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. { |
string | array | $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 1322 of file Database.php.
Wikimedia\Rdbms\Database::selectFieldValues | ( | $table, | |
$var, | |||
$cond = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
A SELECT wrapper which returns a list of single field values from result rows.
If no result rows are returned from the query, an empty array is returned.
New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchFieldValues instead, which is more readable and less error-prone.
string | array | $table | Table name. { |
string | $var | The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. |
string | array | $cond | The condition array. { |
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 1347 of file Database.php.
Wikimedia\Rdbms\Database::selectRow | ( | $table, | |
$vars, | |||
$conds, | |||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Wrapper to IDatabase::select() that only fetches one row (via LIMIT)
If the query returns no rows, false is returned.
This method is convenient for fetching a row based on a unique key condition.
New callers should use newSelectQueryBuilder with SelectQueryBuilder::fetchRow instead, which is more readable and less error-prone.
string | array | $table | Table name |
string | array | $vars | Field names |
string | array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
array | string | $join_conds | Join conditions |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1386 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 name(s) |
string | $var | Column for which NULL values are not counted [default "*"] |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select |
array | $join_conds | Join conditions (since 1.27) |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IReadableDatabase.
Definition at line 1425 of file Database.php.
Wikimedia\Rdbms\Database::selectSQLText | ( | $table, | |
$vars, | |||
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Take the same arguments as IDatabase::select() and return the SQL it would use.
This can be useful for making UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().
string | array | $table | Table name(s) |
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.
Reimplemented in Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 3439 of file Database.php.
Wikimedia\Rdbms\Database::serverIsReadOnly | ( | ) |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1989 of file Database.php.
Wikimedia\Rdbms\Database::sessionLocksPending | ( | ) |
Definition at line 381 of file Database.php.
References Wikimedia\Rdbms\Database\$sessionNamedLocks.
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 3359 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 3577 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\IDatabase.
Definition at line 358 of file Database.php.
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 300 of file Database.php.
References Wikimedia\Rdbms\Database\$logger.
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 3598 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 2801 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 (table => (dbname, schema, prefix) map) |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3569 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\IDatabase.
Definition at line 2048 of file Database.php.
Wikimedia\Rdbms\Database::setTransactionManager | ( | TransactionManager | $transactionManager | ) |
TransactionManager | $transactionManager |
Definition at line 2512 of file Database.php.
|
final |
Whether to disable running of post-COMMIT/ROLLBACK callbacks.
bool | $suppress |
Definition at line 2060 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 2804 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 2836 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 2177 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\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 2914 of file Database.php.
|
abstract |
Wrapper for addslashes()
string | $s | String to be slashed. |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
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 3545 of file Database.php.
|
abstract |
Query whether a given table exists.
string | $table | |
string | $fname |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMySQL.
Wikimedia\Rdbms\Database::tableName | ( | $name, | |
$format = 'quoted' |
|||
) |
Format a table name ready for use in constructing an SQL query.
This does two important things: it quotes the table names to clean them up, and it adds a table prefix if only given a table name with no quotes.
All functions of this object which require a table name call this function themselves. Pass the canonical name to such functions. This is only needed when calling query() directly.
string | $name | Database table name |
string | $format | One of: quoted - Automatically pass the table name through addIdentifierQuotes() so that it can be used in a query. raw - Do not add identifier quotes to the table name |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3497 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\fieldInfo(), Wikimedia\Rdbms\DatabaseMySQL\indexInfo(), Wikimedia\Rdbms\DatabaseMySQL\replace(), and Wikimedia\Rdbms\DatabaseMySQL\upsert().
Wikimedia\Rdbms\Database::tableNames | ( | $tables | ) |
Fetch a number of table names into an associative array.
Much like tableName(), this is only needed when calling query() directly. Prefer calling other methods, or using SelectQueryBuilder.
Theoretical example (which really does not require raw SQL):
string | ...$tables |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3501 of file Database.php.
Wikimedia\Rdbms\Database::tableNamesN | ( | $tables | ) |
Fetch a number of table names into a zero-indexed numerical array.
Much like tableName(), this is only needed when calling query() directly. It is slightly more convenient than tableNames(), but you should still prefer calling other methods, or using SelectQueryBuilder.
Theoretical example (which really does not require raw SQL):
string | ...$tables |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 3505 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 308 of file Database.php.
Referenced by DatabaseInstaller\selectDatabase().
Wikimedia\Rdbms\Database::textFieldSize | ( | $table, | |
$field | |||
) |
Returns the size of a text field, or -1 for "unlimited".
string | $table | |
string | $field |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1750 of file Database.php.
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 3549 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 3553 of file Database.php.
Wikimedia\Rdbms\Database::truncate | ( | $tables, | |
$fname = __METHOD__ |
|||
) |
Delete all data in a table(s) and reset any sequences owned by that table(s)
string | string[] | $tables | |
string | $fname |
DBError | If an error occurs |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 3095 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 3379 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\close().
Wikimedia\Rdbms\Database::trxStatus | ( | ) |
Definition at line 3393 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 3389 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 3537 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 3533 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 3001 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 | Table name |
array | $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. |
array | string | $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 | Table name |
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 | $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 1630 of file Database.php.
References LIST_SET.
Wikimedia\Rdbms\Database::wasDeadlock | ( | ) |
Determines if the last failure was due to a deadlock.Note that during a deadlock, the prior transaction will have been lost
Implements Wikimedia\Rdbms\IReadableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1949 of file Database.php.
Wikimedia\Rdbms\Database::wasReadOnlyError | ( | ) |
Determines if the last failure was due to the database being read-only.
Implements Wikimedia\Rdbms\IReadableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMySQL.
Definition at line 1957 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\IDatabase.
Definition at line 3401 of file Database.php.
Wikimedia\Rdbms\Database::writesPending | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3397 of file Database.php.
|
protected |
Agent name for query profiling.
Definition at line 76 of file Database.php.
|
protected |
Whether this PHP instance is for a CLI script.
Definition at line 70 of file Database.php.
|
protected |
Database connection.
Definition at line 65 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\isOpen().
|
protected |
Connection parameters used by initConnection() and open()
Definition at line 78 of file Database.php.
|
protected |
SQL variables values to use for all new connections.
Definition at line 80 of file Database.php.
|
protected |
Maximum seconds to wait on connection attempts.
Definition at line 72 of file Database.php.
|
protected |
Definition at line 46 of file Database.php.
|
protected |
Definition at line 59 of file Database.php.
|
protected |
Current SQL query delimiter.
Definition at line 89 of file Database.php.
|
protected |
Deprecation logging callback.
Definition at line 52 of file Database.php.
|
protected |
Error logging callback.
Definition at line 50 of file Database.php.
|
protected |
Definition at line 61 of file Database.php.
|
protected |
Last error during connection; empty string if none.
Definition at line 110 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMySQL\lastError().
|
protected |
Affected row count for the last query method call; null if unspecified.
Definition at line 105 of file Database.php.
|
protected |
Insert (row) ID for the last query method call; null if unspecified.
Definition at line 107 of file Database.php.
|
protected |
Affected row count for the last statement to query()
Definition at line 100 of file Database.php.
|
protected |
Insert (row) ID for the last statement to query() (null if not supported)
Definition at line 102 of file Database.php.
|
protected |
Current LoadBalancer tracking information.
Definition at line 87 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getLBInfo().
|
protected |
Definition at line 48 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\setLogger().
|
protected |
Row batch size to use for emulated INSERT SELECT queries.
Definition at line 82 of file Database.php.
|
protected |
Definition at line 179 of file Database.php.
|
protected |
Definition at line 54 of file Database.php.
|
protected |
Maximum seconds to wait on receiving query results.
Definition at line 74 of file Database.php.
|
protected |
Definition at line 182 of file Database.php.
|
protected |
Readable name or host/IP of the database server.
Definition at line 68 of file Database.php.
|
protected |
Map of (name => (UNIX time,trx ID)) for current lock() mutexes.
Definition at line 95 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\sessionLocksPending().
|
protected |
Map of (name => (type,pristine,trx ID)) for current temp tables.
Definition at line 97 of file Database.php.
|
protected |
Whether to use SSL connections.
Definition at line 85 of file Database.php.
|
protected |
Hostname or IP address to use on all connections.
Definition at line 166 of file Database.php.
|
protected |
Database name to use on initial connection.
Definition at line 172 of file Database.php.
|
protected |
Schema name to use on initial connection.
Definition at line 174 of file Database.php.
|
protected |
Table prefix to use on initial connection.
Definition at line 176 of file Database.php.
|
protected |
Database server password to use on all connections.
Definition at line 170 of file Database.php.
|
protected |
Database server username to use on all connections.
Definition at line 168 of file Database.php.
|
protected |
Assume that queries taking this long to yield connection loss errors are at fault.
Definition at line 150 of file Database.php.
|
protected |
Abort query (no retries) due to a statement rollback (session/transaction intact)
Definition at line 143 of file Database.php.
|
protected |
Abort and reset session due to server-side session-level state loss (locks, temp tables)
Definition at line 147 of file Database.php.
|
protected |
Abort any current transaction, by rolling it back, due to an error during the query.
Definition at line 145 of file Database.php.
|
protected |
No errors occurred during the query.
Definition at line 139 of file Database.php.
|
protected |
Retry query due to a connection loss detected while sending the query (session intact)
Definition at line 141 of file Database.php.