MediaWiki REL1_35
|
Relational database abstraction object. More...
Public Member Functions | |||||||||||||||||||||
__clone () | |||||||||||||||||||||
Make sure that copies do not share the same client binding handle. | |||||||||||||||||||||
__construct (array $params) | |||||||||||||||||||||
__destruct () | |||||||||||||||||||||
Run a few simple sanity checks and close dangling connections. | |||||||||||||||||||||
__sleep () | |||||||||||||||||||||
Called by serialize. | |||||||||||||||||||||
__toString () | |||||||||||||||||||||
Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present. | |||||||||||||||||||||
addIdentifierQuotes ( $s) | |||||||||||||||||||||
Escape a SQL identifier (e.g.table, column, database) for use in a SQL queryDepending on the database this will either be backticks or "double quotes"
| |||||||||||||||||||||
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 write query. | |||||||||||||||||||||
aggregateValue ( $valuedata, $valuename='value') | |||||||||||||||||||||
Return aggregated value alias.
| |||||||||||||||||||||
anyChar () | |||||||||||||||||||||
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. | |||||||||||||||||||||
anyString () | |||||||||||||||||||||
Returns a token for buildLike() that denotes a '' to be used in a LIKE query. | |||||||||||||||||||||
assertNoOpenTransactions () | |||||||||||||||||||||
Assert that all explicit transactions or atomic sections have been closed. | |||||||||||||||||||||
begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT) | |||||||||||||||||||||
Begin a transaction. | |||||||||||||||||||||
bitAnd ( $fieldLeft, $fieldRight) | |||||||||||||||||||||
| |||||||||||||||||||||
bitNot ( $field) | |||||||||||||||||||||
| |||||||||||||||||||||
bitOr ( $fieldLeft, $fieldRight) | |||||||||||||||||||||
| |||||||||||||||||||||
buildConcat ( $stringList) | |||||||||||||||||||||
Build a concatenation list to feed into a SQL query.
| |||||||||||||||||||||
buildGreatest ( $fields, $values) | |||||||||||||||||||||
Build a GREATEST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $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.
| |||||||||||||||||||||
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.
| |||||||||||||||||||||
buildIntegerCast ( $field) | |||||||||||||||||||||
| |||||||||||||||||||||
buildLeast ( $fields, $values) | |||||||||||||||||||||
Build a LEAST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $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.
| |||||||||||||||||||||
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 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 );
| |||||||||||||||||||||
buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery. | |||||||||||||||||||||
buildStringCast ( $field) | |||||||||||||||||||||
| |||||||||||||||||||||
buildSubstring ( $input, $startPosition, $length=null) | |||||||||||||||||||||
Stable to override | |||||||||||||||||||||
cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null) | |||||||||||||||||||||
Cancel an atomic section of SQL statements. | |||||||||||||||||||||
clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |||||||||||||||||||||
Clear a flag for this connection. | |||||||||||||||||||||
close ( $fname=__METHOD__, $owner=null) | |||||||||||||||||||||
Close the database connection. | |||||||||||||||||||||
commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Commits a transaction previously started using begin() | |||||||||||||||||||||
conditional ( $cond, $trueVal, $falseVal) | |||||||||||||||||||||
Returns an SQL expression for a simple conditional.This doesn't need to be overridden unless CASE isn't supported in the RDBMS.
| |||||||||||||||||||||
connectionErrorLogger ( $errno, $errstr) | |||||||||||||||||||||
Error handler for logging errors during database connection This method should not be used outside of Database classes. | |||||||||||||||||||||
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. | |||||||||||||||||||||
deadlockLoop (... $args) | |||||||||||||||||||||
Perform a deadlock-prone transaction.This function invokes a callback function to perform a set of write queries. If a deadlock occurs during the processing, the transaction will be rolled back and the callback function will be called again.Avoid using this method outside of Job or Maintenance classes.Usage: $dbw->deadlockLoop( callback, ... );Extra arguments are passed through to the specified callback function. This method requires that no transactions are already active to avoid causing premature commits or exceptions.Returns whatever the callback function returned on its successful, iteration, or false on error, for example if the retry limit was reached.
| |||||||||||||||||||||
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. | |||||||||||||||||||||
delete ( $table, $conds, $fname=__METHOD__) | |||||||||||||||||||||
Delete all rows in a table that match a condition. | |||||||||||||||||||||
deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__) | |||||||||||||||||||||
DELETE where the condition is a join.MySQL overrides this to use a multi-table DELETE syntax, in other databases we use sub-selectsFor 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.
| |||||||||||||||||||||
doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |||||||||||||||||||||
Perform an atomic section of reversable SQL statements from a callback. | |||||||||||||||||||||
dropTable ( $table, $fname=__METHOD__) | |||||||||||||||||||||
Delete a table. | |||||||||||||||||||||
duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__) | |||||||||||||||||||||
Creates a new table with structure copied from existing table.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. | |||||||||||||||||||||
endAtomic ( $fname=__METHOD__) | |||||||||||||||||||||
Ends an atomic section of SQL statements. | |||||||||||||||||||||
estimateRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Estimate the number of rows in dataset.MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).Takes the same arguments as IDatabase::select().
| |||||||||||||||||||||
explicitTrxActive () | |||||||||||||||||||||
fieldExists ( $table, $field, $fname=__METHOD__) | |||||||||||||||||||||
Determines whether a field exists in a table. | |||||||||||||||||||||
flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Commit any transaction but error out if writes or callbacks are pending. | |||||||||||||||||||||
freeResult ( $res) | |||||||||||||||||||||
Free a result object returned by query() or select()It's usually not necessary to call this, just use unset() or let the variable holding the result object go out of scope.
| |||||||||||||||||||||
getDBname () | |||||||||||||||||||||
Get the current DB name. | |||||||||||||||||||||
getDomainID () | |||||||||||||||||||||
Return the currently selected domain ID. | |||||||||||||||||||||
getFlag ( $flag) | |||||||||||||||||||||
Returns a boolean whether the flag $flag is set for this connection. | |||||||||||||||||||||
getInfinity () | |||||||||||||||||||||
Find out when 'infinity' is.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.
| |||||||||||||||||||||
getLag () | |||||||||||||||||||||
Get the amount of replication lag for this database server. | |||||||||||||||||||||
getLBInfo ( $name=null) | |||||||||||||||||||||
Get properties passed down from the server info array of the load balancer. | |||||||||||||||||||||
getMasterPos () | |||||||||||||||||||||
Get the position of this master.
| |||||||||||||||||||||
getReplicaPos () | |||||||||||||||||||||
Get the replication position of this replica DB.
| |||||||||||||||||||||
getScopedLockAndFlush ( $lockKey, $fname, $timeout) | |||||||||||||||||||||
Acquire a named lock, flush any transaction, and return an RAII style unlocker object. | |||||||||||||||||||||
getServer () | |||||||||||||||||||||
Get the server hostname or IP address. | |||||||||||||||||||||
getServerInfo () | |||||||||||||||||||||
Get a human-readable string describing the current software version. | |||||||||||||||||||||
getServerUptime () | |||||||||||||||||||||
Determines how long the server has been up.
| |||||||||||||||||||||
getSessionLagStatus () | |||||||||||||||||||||
Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. | |||||||||||||||||||||
getTopologyRole () | |||||||||||||||||||||
Get the replication topology role of this server. | |||||||||||||||||||||
getTopologyRootMaster () | |||||||||||||||||||||
Get the host (or address) of the root master server for the replication topology. | |||||||||||||||||||||
ignoreIndexClause ( $index) | |||||||||||||||||||||
IGNORE INDEX clause. | |||||||||||||||||||||
implicitOrderby () | |||||||||||||||||||||
Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1.
| |||||||||||||||||||||
indexExists ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Determines whether an index exists. | |||||||||||||||||||||
indexInfo ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Get information about an index into an object. | |||||||||||||||||||||
indexUnique ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||||
Determines if a given index is unique.
| |||||||||||||||||||||
initConnection () | |||||||||||||||||||||
Initialize the connection to the database over the wire (or to local files) | |||||||||||||||||||||
insert ( $table, $rows, $fname=__METHOD__, $options=[]) | |||||||||||||||||||||
Insert the given row(s) into a table. | |||||||||||||||||||||
insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |||||||||||||||||||||
INSERT SELECT wrapper. | |||||||||||||||||||||
isOpen () | |||||||||||||||||||||
isQuotedIdentifier ( $name) | |||||||||||||||||||||
Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers. | |||||||||||||||||||||
isReadOnly () | |||||||||||||||||||||
lastDoneWrites () | |||||||||||||||||||||
Get the last time the connection may have been used for a write query. | |||||||||||||||||||||
lastQuery () | |||||||||||||||||||||
Get the last query that sent on account of IDatabase::query() | |||||||||||||||||||||
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.
| |||||||||||||||||||||
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) | |||||||||||||||||||||
Acquire a named lock.Named locks are not related to transactions
| |||||||||||||||||||||
lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Lock all rows meeting the given conditions/options FOR UPDATE. | |||||||||||||||||||||
lockIsFree ( $lockName, $method) | |||||||||||||||||||||
Check to see if a named lock is not locked by any thread (non-blocking)
| |||||||||||||||||||||
lockTables (array $read, array $write, $method) | |||||||||||||||||||||
Lock specific tables. | |||||||||||||||||||||
makeList (array $a, $mode=self::LIST_COMMA) | |||||||||||||||||||||
Makes an encoded list of strings from an array. | |||||||||||||||||||||
makeWhereFrom2d ( $data, $baseKey, $subKey) | |||||||||||||||||||||
Build a partial where clause from a 2-d array such as used for LinkBatch. | |||||||||||||||||||||
masterPosWait (DBMasterPos $pos, $timeout) | |||||||||||||||||||||
Wait for the replica DB to catch up to a given master position.Note that this does not start any new transactions. If any existing transaction is flushed, and this is called, then queries will reflect the point the DB was synced up to (on success) without interference from REPEATABLE-READ snapshots.
| |||||||||||||||||||||
maxListLen () | |||||||||||||||||||||
Return the maximum number of items allowed in a list, or 0 for unlimited.
| |||||||||||||||||||||
namedLocksEnqueue () | |||||||||||||||||||||
Check to see if a named lock used by lock() use blocking queues.
| |||||||||||||||||||||
newSelectQueryBuilder () | |||||||||||||||||||||
Create an empty SelectQueryBuilder which can be used to run queries against this connection.
| |||||||||||||||||||||
nextSequenceValue ( $seqName) | |||||||||||||||||||||
Deprecated method, calls should be removed. | |||||||||||||||||||||
onAtomicSectionCancel (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback when the atomic section is cancelled. | |||||||||||||||||||||
onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback as soon as there is no transaction pending. | |||||||||||||||||||||
onTransactionIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Alias for onTransactionCommitOrIdle() for backwards-compatibility. | |||||||||||||||||||||
onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback before the current transaction commits or now if there is none. | |||||||||||||||||||||
onTransactionResolution (callable $callback, $fname=__METHOD__) | |||||||||||||||||||||
Run a callback as soon as the current transaction commits or rolls back. | |||||||||||||||||||||
pendingWriteAndCallbackCallers () | |||||||||||||||||||||
List the methods that have write queries or callbacks for the current transaction. | |||||||||||||||||||||
pendingWriteCallers () | |||||||||||||||||||||
Get the list of method names that did write queries for this transaction. | |||||||||||||||||||||
pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL) | |||||||||||||||||||||
Get the time spend running write queries for this transaction. | |||||||||||||||||||||
pendingWriteRowsAffected () | |||||||||||||||||||||
Get the number of affected rows from pending write queries. | |||||||||||||||||||||
ping (&$rtt=null) | |||||||||||||||||||||
Ping the server and try to reconnect if it there is no connection. | |||||||||||||||||||||
preCommitCallbacksPending () | |||||||||||||||||||||
query ( $sql, $fname=__METHOD__, $flags=self::QUERY_NORMAL) | |||||||||||||||||||||
Run an SQL query and return the result. | |||||||||||||||||||||
replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__) | |||||||||||||||||||||
Insert row(s) into a table, deleting all conflicting rows beforehand. | |||||||||||||||||||||
reportQueryError ( $error, $errno, $sql, $fname, $ignore=false) | |||||||||||||||||||||
Report a query error. | |||||||||||||||||||||
restoreFlags ( $state=self::RESTORE_PRIOR) | |||||||||||||||||||||
Restore the flags to their prior state before the last setFlag/clearFlag call. | |||||||||||||||||||||
rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |||||||||||||||||||||
Rollback a transaction previously started using begin() | |||||||||||||||||||||
runOnTransactionIdleCallbacks ( $trigger) | |||||||||||||||||||||
Actually consume and run any "on transaction idle/resolution" callbacks. | |||||||||||||||||||||
runOnTransactionPreCommitCallbacks () | |||||||||||||||||||||
Actually consume and run any "on transaction pre-commit" callbacks. | |||||||||||||||||||||
runTransactionListenerCallbacks ( $trigger) | |||||||||||||||||||||
Actually run any "transaction listener" callbacks. | |||||||||||||||||||||
select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Execute a SELECT query constructed using the various parameters provided. | |||||||||||||||||||||
selectDB ( $db) | |||||||||||||||||||||
Change the current database. | |||||||||||||||||||||
selectDomain ( $domain) | |||||||||||||||||||||
Set the current domain (database, schema, and table prefix) | |||||||||||||||||||||
selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
A SELECT wrapper which returns a single field from a single result row. | |||||||||||||||||||||
selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
A SELECT wrapper which returns a list of single field values from result rows. | |||||||||||||||||||||
selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Wrapper to IDatabase::select() that only fetches one row (via LIMIT) | |||||||||||||||||||||
selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Get the number of rows in dataset. | |||||||||||||||||||||
selectSQLText ( $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().
| |||||||||||||||||||||
serverIsReadOnly () | |||||||||||||||||||||
| |||||||||||||||||||||
setBigSelects ( $value=true) | |||||||||||||||||||||
Allow or deny "big selects" for this session only.This is done by setting the sql_big_selects session variable.This is a MySQL-specific feature.
| |||||||||||||||||||||
setFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |||||||||||||||||||||
Set a flag for this connection. | |||||||||||||||||||||
setIndexAliases (array $aliases) | |||||||||||||||||||||
Convert certain index names to alternative names before querying the DB.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.
| |||||||||||||||||||||
setLBInfo ( $nameOrArray, $value=null) | |||||||||||||||||||||
Set the entire array or a particular key of the managing load balancer info array. | |||||||||||||||||||||
setLogger (LoggerInterface $logger) | |||||||||||||||||||||
Set the PSR-3 logger interface to use for query logging. | |||||||||||||||||||||
setSchemaVars ( $vars) | |||||||||||||||||||||
Set schema variables to be used when streaming commands from SQL files or stdin. | |||||||||||||||||||||
setSessionOptions (array $options) | |||||||||||||||||||||
Override database's default behavior.$options include: 'connTimeout' : Set the connection timeout value in seconds. May be useful for very long batch queries such as full-wiki dumps, where a single query reads out over hours or days.
| |||||||||||||||||||||
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.
| |||||||||||||||||||||
setTransactionListener ( $name, callable $callback=null) | |||||||||||||||||||||
Run a callback after each time any transaction commits or rolls back. | |||||||||||||||||||||
setTrxEndCallbackSuppression ( $suppress) | |||||||||||||||||||||
Whether to disable running of post-COMMIT/ROLLBACK callbacks. | |||||||||||||||||||||
sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null) | |||||||||||||||||||||
Read and execute SQL commands from a file. | |||||||||||||||||||||
sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null) | |||||||||||||||||||||
Read and execute commands from an open file handle. | |||||||||||||||||||||
startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |||||||||||||||||||||
Begin an atomic section of SQL statements. | |||||||||||||||||||||
streamStatementEnd (&$sql, &$newLine) | |||||||||||||||||||||
Called by sourceStream() to check if we've reached a statement end. | |||||||||||||||||||||
strencode ( $s) | |||||||||||||||||||||
Wrapper for addslashes() | |||||||||||||||||||||
strreplace ( $orig, $old, $new) | |||||||||||||||||||||
Returns a SQL expression for simple string replacement (e.g.REPLACE() in mysql)
| |||||||||||||||||||||
tableExists ( $table, $fname=__METHOD__) | |||||||||||||||||||||
Query whether a given table exists. | |||||||||||||||||||||
tableLocksHaveTransactionScope () | |||||||||||||||||||||
Checks if table locks acquired by lockTables() are transaction-bound in their scope. | |||||||||||||||||||||
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.
| |||||||||||||||||||||
tableNames (... $tables) | |||||||||||||||||||||
Fetch a number of table names into an array This is handy when you need to construct SQL for joins. | |||||||||||||||||||||
tableNamesN (... $tables) | |||||||||||||||||||||
Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins. | |||||||||||||||||||||
tablePrefix ( $prefix=null) | |||||||||||||||||||||
Get/set the table prefix. | |||||||||||||||||||||
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.The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
| |||||||||||||||||||||
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. | |||||||||||||||||||||
truncate ( $tables, $fname=__METHOD__) | |||||||||||||||||||||
Delete all data in a table(s) and reset any sequences owned by that table(s) | |||||||||||||||||||||
trxLevel () | |||||||||||||||||||||
Gets the current transaction level. | |||||||||||||||||||||
trxStatus () | |||||||||||||||||||||
trxTimestamp () | |||||||||||||||||||||
Get the UNIX timestamp of the time that the transaction was established. | |||||||||||||||||||||
unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |||||||||||||||||||||
Construct a UNION query for permutations of conditions. | |||||||||||||||||||||
unionQueries ( $sqls, $all) | |||||||||||||||||||||
Construct a UNION query.This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.
| |||||||||||||||||||||
unionSupportsOrderAndLimit () | |||||||||||||||||||||
Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.
| |||||||||||||||||||||
unlock ( $lockName, $method) | |||||||||||||||||||||
Release a lock.Named locks are not related to transactions
| |||||||||||||||||||||
unlockTables ( $method) | |||||||||||||||||||||
Unlock all tables locked via lockTables() | |||||||||||||||||||||
update ( $table, $set, $conds, $fname=__METHOD__, $options=[]) | |||||||||||||||||||||
Update all rows in a table that match a given condition. | |||||||||||||||||||||
upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__) | |||||||||||||||||||||
Upsert the given row(s) into a table. | |||||||||||||||||||||
useIndexClause ( $index) | |||||||||||||||||||||
USE INDEX clause. | |||||||||||||||||||||
wasConnectionError ( $errno) | |||||||||||||||||||||
Do not use this method outside of Database/DBError classes. | |||||||||||||||||||||
wasConnectionLoss () | |||||||||||||||||||||
Determines if the last query error was due to a dropped connection.Note that during a connection loss, the prior transaction will have been lost
| |||||||||||||||||||||
wasDeadlock () | |||||||||||||||||||||
Determines if the last failure was due to a deadlock.Note that during a deadlock, the prior transaction will have been lost
| |||||||||||||||||||||
wasErrorReissuable () | |||||||||||||||||||||
Determines if the last query error was due to something outside of the query itself. | |||||||||||||||||||||
wasLockTimeout () | |||||||||||||||||||||
Determines if the last failure was due to a lock timeout.Note that during a lock wait timeout, the prior transaction will have been lost
| |||||||||||||||||||||
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. | |||||||||||||||||||||
writesPending () | |||||||||||||||||||||
Public Member Functions inherited from Wikimedia\Rdbms\IDatabase | |||||||||||||||||||||
buildSubString ( $input, $startPosition, $length=null) | |||||||||||||||||||||
Build a SUBSTRING function. | |||||||||||||||||||||
dataSeek ( $res, $row) | |||||||||||||||||||||
Change the position of the cursor in a result object. | |||||||||||||||||||||
fetchObject ( $res) | |||||||||||||||||||||
Fetch the next row from the given result object, in object form. | |||||||||||||||||||||
fetchRow ( $res) | |||||||||||||||||||||
Fetch the next row from the given result object, in associative array form. | |||||||||||||||||||||
fieldName ( $res, $n) | |||||||||||||||||||||
Get a field name in a result object. | |||||||||||||||||||||
getServerVersion () | |||||||||||||||||||||
A string describing the current software version, like from mysql_get_server_info() | |||||||||||||||||||||
getSoftwareLink () | |||||||||||||||||||||
Returns a wikitext style link to the DB's website (e.g. | |||||||||||||||||||||
getType () | |||||||||||||||||||||
Get the type of the DBMS (e.g. | |||||||||||||||||||||
insertId () | |||||||||||||||||||||
Get the inserted value of an auto-increment row. | |||||||||||||||||||||
lastErrno () | |||||||||||||||||||||
Get the last error number. | |||||||||||||||||||||
lastError () | |||||||||||||||||||||
Get a description of the last error. | |||||||||||||||||||||
numFields ( $res) | |||||||||||||||||||||
Get the number of fields in a result object. | |||||||||||||||||||||
numRows ( $res) | |||||||||||||||||||||
Get the number of rows in a query result. | |||||||||||||||||||||
Public Member Functions inherited from Wikimedia\Rdbms\IMaintainableDatabase | |||||||||||||||||||||
fieldInfo ( $table, $field) | |||||||||||||||||||||
mysql_fetch_field() wrapper Returns false if the field doesn't exist | |||||||||||||||||||||
Static Public Member Functions | |
static | attributesFromType ( $dbType, $driver=null) |
static | factory ( $type, $params=[], $connect=self::NEW_CONNECTED) |
Construct a Database subclass instance given a database type and parameters. | |
static | getCacheSetOptions (IDatabase $db1, IDatabase $db2=null) |
Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination. | |
Protected Member Functions | |
assertBuildSubstringParams ( $startPosition, $length) | |
Check type and bounds for parameters to self::buildSubstring() | |
assertConditionIsNotEmpty ( $conds, string $fname, bool $deprecate) | |
Check type and bounds conditions parameters for update. | |
assertHasConnectionHandle () | |
Make sure there is an open connection handle (alive or not) as a sanity check. | |
assertIsWritableMaster () | |
Make sure that this server is not marked as a replica nor read-only as a sanity check. | |
buildSuperlative ( $sqlfunc, $fields, $values) | |
Build a superlative function statement comparing columns/values. | |
closeConnection () | |
Closes underlying database connection. | |
doBegin ( $fname) | |
Issues the BEGIN command to the database server. | |
doCommit ( $fname) | |
Issues the COMMIT command to the database server. | |
doDropTable ( $table, $fname) | |
doGetLag () | |
Stable to override | |
doHandleSessionLossPreconnect () | |
Reset any additional subclass trx* and session* fields Stable to override. | |
doInitConnection () | |
Actually connect to the database over the wire (or to local files) | |
doInsert ( $table, array $rows, $fname) | |
doInsertNonConflicting ( $table, array $rows, $fname) | |
doInsertSelectGeneric ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds) | |
Implementation of insertSelect() based on select() and insert() | |
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. | |
doLockTables (array $read, array $write, $method) | |
Helper function for lockTables() that handles the actual table locking. | |
doQuery ( $sql) | |
Run a query and return a DBMS-dependent wrapper or boolean. | |
doReleaseSavepoint ( $identifier, $fname) | |
Release a savepoint. | |
doReplace ( $table, array $uniqueKeys, array $rows, $fname) | |
doRollback ( $fname) | |
Issues the ROLLBACK command to the database server. | |
doRollbackToSavepoint ( $identifier, $fname) | |
Rollback to a savepoint. | |
doSavepoint ( $identifier, $fname) | |
Create a savepoint. | |
doSelectDomain (DatabaseDomain $domain) | |
Stable to override. | |
doTruncate (array $tables, $fname) | |
doUnlockTables ( $method) | |
Helper function for unlockTables() that handles the actual table unlocking. | |
doUpsert ( $table, array $rows, array $uniqueKeys, array $set, $fname) | |
escapeLikeInternal ( $s, $escapeChar='`') | |
Stable to override. | |
executeQuery ( $sql, $fname, $flags) | |
Execute a query, retrying it if there is a recoverable connection loss. | |
extractSingleFieldFromList ( $var) | |
fetchAffectedRowCount () | |
fieldHasBit ( $field, $flags) | |
fieldNamesWithAlias ( $fields) | |
Gets an array of aliased field names. | |
fieldNameWithAlias ( $name, $alias=false) | |
Get an aliased field name e.g. | |
getApproximateLagStatus () | |
Get a replica DB lag estimate for this server at the start of a transaction. | |
getBindingHandle () | |
Get the underlying binding connection handle. | |
getDefaultSchemaVars () | |
Get schema variables to use if none have been set via setSchemaVars(). | |
getLastPHPError () | |
getLazyMasterHandle () | |
Get a handle to the master server of the cluster to which this server belongs. | |
getLogContext (array $extras=[]) | |
Create a log context to pass to PSR-3 logger functions. | |
getQueryVerb ( $sql) | |
getReadOnlyReason () | |
getRecordedTransactionLagStatus () | |
Get the replica DB lag when the current transaction started. | |
getSchemaVars () | |
Get schema variables. | |
getTempTableWrites ( $sql, $pseudoPermanent) | |
getTransactionRoundId () | |
indexName ( $index) | |
Allows for index remapping in queries where this is not consistent across DBMS. | |
installErrorHandler () | |
Set a custom error handler for logging errors during database connection. | |
isFlagInOptions ( $option, array $options) | |
isInsertSelectSafe (array $insertOptions, array $selectOptions) | |
Stable to override. | |
isPristineTemporaryTable ( $table) | |
Check if the table is both a TEMPORARY table and has not yet received CRUD operations. | |
isTransactableQuery ( $sql) | |
Determine whether a SQL statement is sensitive to isolation level. | |
isWriteQuery ( $sql, $flags) | |
Determine whether a query writes to the DB. | |
makeConditionCollidesUponKeys (array $rows, array $uniqueKeys) | |
makeGroupByWithHaving ( $options) | |
Returns an optional GROUP BY with an optional HAVING. | |
makeInsertLists (array $rows) | |
Make SQL lists of columns, row tuples for INSERT/VALUES expressions. | |
makeInsertNonConflictingVerbAndOptions () | |
Stable to override. | |
makeOrderBy ( $options) | |
Returns an optional ORDER BY. | |
makeSelectOptions (array $options) | |
Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. | |
makeUpdateOptions ( $options) | |
Make UPDATE options for the Database::update function. | |
makeUpdateOptionsArray ( $options) | |
Make UPDATE options array for Database::makeUpdateOptions. | |
newExceptionAfterConnectError ( $error) | |
normalizeConditions ( $conds, $fname) | |
normalizeOptions ( $options) | |
normalizeRowArray (array $rowOrRows) | |
normalizeUpsertKeys ( $uniqueKeys) | |
open ( $server, $user, $password, $dbName, $schema, $tablePrefix) | |
Open a new connection to the database (closing any existing one) | |
qualifiedTableComponents ( $name) | |
Get the table components needed for a query given the currently selected database. | |
registerTempWrites ( $ret, array $changes) | |
relationSchemaQualifier () | |
Stable to override. | |
replaceLostConnection ( $fname) | |
Close any existing (dead) database connection and open a new connection. | |
replaceVars ( $ins) | |
Database independent variable replacement. | |
restoreErrorHandler () | |
Restore the previous error handler and return the last PHP error for this DB. | |
resultObject ( $result) | |
Take a query result and wrap it in an iterable result wrapper if necessary. | |
tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[]) | |
Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause. | |
tableNameWithAlias ( $table, $alias=false) | |
Get an aliased table name. | |
wasKnownStatementRollbackError () | |
Stable to override. | |
wasQueryTimeout ( $error, $errno) | |
Checks whether the cause of the error is detected to be a timeout. | |
Static Protected Member Functions | |
static | getAttributes () |
Stable to override. | |
Protected Attributes | |
integer null | $affectedRowCount |
Rows affected by the last query to query() or its CRUD wrappers. | |
string | $agent |
Agent name for query profiling. | |
bool | $cliMode |
Whether this PHP instance is for a CLI script. | |
object resource null | $conn |
Database connection. | |
array | $connectionParams |
Parameters used by initConnection() to establish a connection. | |
string[] int[] float[] | $connectionVariables |
SQL variables values to use for all new connections. | |
LoggerInterface | $connLogger |
DatabaseDomain | $currentDomain |
string | $delimiter = ';' |
Current SQL query delimiter. | |
callable | $deprecationLogger |
Deprecation logging callback. | |
callable | $errorLogger |
Error logging callback. | |
int | $flags |
Current bit field of class DBO_* constants. | |
string[] | $indexAliases = [] |
Current map of (index alias => index) | |
array | $lbInfo = [] |
Current LoadBalancer tracking information. | |
int | $nonNativeInsertSelectBatchSize |
Row batch size to use for emulated INSERT SELECT queries. | |
string | $password |
Password used to establish the current connection. | |
callable null | $profiler |
LoggerInterface | $queryLogger |
LoggerInterface | $replLogger |
array null | $schemaVars |
Current variables use for schema element placeholders. | |
string | $server |
Server that this instance is currently connected to. | |
array | $sessionDirtyTempTables = [] |
Map of (table name => 1) for current TEMPORARY tables. | |
array | $sessionNamedLocks = [] |
Map of (name => 1) for locks obtained via lock() | |
array | $sessionTempTables = [] |
Map of (table name => 1) for current TEMPORARY tables. | |
BagOStuff | $srvCache |
APC cache. | |
array[] | $tableAliases = [] |
Current map of (table => (dbname, schema, prefix) map) | |
string | $topologyRole |
Replication topology role of the server; one of the class ROLE_* constants. | |
string null | $topologyRootMaster |
Host (or address) of the root master server for the replication topology. | |
TransactionProfiler | $trxProfiler |
string | $user |
User that this instance is currently connected under the name of. | |
Static Protected Attributes | |
static int | $DBO_MUTABLE |
Bit field of all DBO_* flags that can be changed after connection. | |
static string[] | $MUTABLE_FLAGS |
List of DBO_* flags that can be changed after connection. | |
Private Member Functions | |
assertQueryIsCurrentlyAllowed ( $sql, $fname) | |
Error out if the DB is not in a valid state for a query via query() | |
beginIfImplied ( $sql, $fname) | |
Start an implicit transaction if DBO_TRX is enabled and no transaction is active. | |
canRecoverFromDisconnect ( $sql, $priorWritesPending) | |
Determine whether it is safe to retry queries after a database connection is lost. | |
consumeTrxShortId () | |
Reset the transaction ID and return the old one. | |
currentAtomicSectionId () | |
executeQueryAttempt ( $sql, $commentedSql, $isPermWrite, $fname, $flags) | |
Wrapper for doQuery() that handles DBO_TRX, profiling, logging, affected row count tracking, and reconnects (without retry) on query failure due to connection loss. | |
flatAtomicSectionList () | |
getQueryException ( $error, $errno, $sql, $fname) | |
getQueryExceptionAndLog ( $error, $errno, $sql, $fname) | |
handleSessionLossPostconnect () | |
Clean things up after session (and thus transaction) loss after reconnect. | |
handleSessionLossPreconnect () | |
Clean things up after session (and thus transaction) loss before reconnect. | |
makeConditionCollidesUponKey (array $rows, array $uniqueKey) | |
modifyCallbacksForCancel (array $sectionIds, AtomicSectionIdentifier $newSectionId=null) | |
Update callbacks that were owned by cancelled atomic sections. | |
nextSavepointId ( $fname) | |
pingAndCalculateLastTrxApplyTime () | |
prependDatabaseOrSchema ( $namespace, $relation, $format) | |
reassignCallbacksForSection (AtomicSectionIdentifier $old, AtomicSectionIdentifier $new) | |
Hoist callback ownership for callbacks in a section to a parent section. | |
runOnAtomicSectionCancelCallbacks ( $trigger, array $sectionIds=null) | |
Actually run any "atomic section cancel" callbacks. | |
selectFieldsOrOptionsAggregate ( $fields, $options) | |
selectOptionsIncludeLocking ( $options) | |
updateTrxWriteQueryTime ( $sql, $runtime, $affected) | |
Update the estimated run-time of a query, not counting large row lock times. | |
Static Private Member Functions | |
static | getClass ( $dbType, $driver=null) |
Private Attributes | |
string bool null | $htmlErrors |
Stashed value of html_errors INI setting. | |
string bool | $lastPhpError = false |
float | $lastPing = 0.0 |
UNIX timestamp. | |
string | $lastQuery = '' |
The last SQL query attempted. | |
float | $lastRoundTripEstimate = 0.0 |
Query round trip time estimate. | |
float bool | $lastWriteTime = false |
UNIX timestamp of last write query. | |
IDatabase null | $lazyMasterHandle |
Lazy handle to the master DB this server replicates from. | |
int null | $ownerId |
Integer ID of the managing LBFactory instance or null if none. | |
int[] | $priorFlags = [] |
Prior flags member variable values. | |
int | $trxAtomicCounter = 0 |
Counter for atomic savepoint identifiers (reset with each transaction) | |
array | $trxAtomicLevels = [] |
List of (name, unique ID, savepoint ID) for each active atomic section level. | |
bool | $trxAutomatic = false |
Whether the current transaction was started implicitly due to DBO_TRX. | |
bool | $trxAutomaticAtomic = false |
Whether the current transaction was started implicitly by startAtomic() | |
bool | $trxDoneWrites = false |
Whether possible write queries were done in the last transaction started. | |
array[] | $trxEndCallbacks = [] |
List of (callable, method name, atomic section id) -var array<array{0:callable,1:string,2:AtomicSectionIdentifier|null}> | |
bool | $trxEndCallbacksSuppressed = false |
Whether to suppress triggering of transaction end callbacks. | |
string | $trxFname = null |
Name of the function that start the last transaction. | |
array[] | $trxIdleCallbacks = [] |
List of (callable, method name, atomic section id) | |
array[] | $trxPreCommitCallbacks = [] |
List of (callable, method name, atomic section id) | |
callable[] | $trxRecurringCallbacks = [] |
Map of (name => callable) | |
float | $trxReplicaLag = null |
Replication lag estimate at the time of BEGIN for the last transaction. | |
array[] | $trxSectionCancelCallbacks = [] |
List of (callable, method name, atomic section id) | |
string | $trxShortId = '' |
ID of the active transaction or the empty string otherwise. | |
int | $trxStatus = self::STATUS_TRX_NONE |
Transaction status. | |
Exception null | $trxStatusCause |
The last error that caused the status to become STATUS_TRX_ERROR. | |
array null | $trxStatusIgnoredCause |
Error details of the last statement-only rollback. | |
float null | $trxTimestamp = null |
UNIX timestamp at the time of BEGIN for the last transaction. | |
float | $trxWriteAdjDuration = 0.0 |
Like trxWriteQueryCount but excludes lock-bound, easy to replicate, queries. | |
int | $trxWriteAdjQueryCount = 0 |
Number of write queries counted in trxWriteAdjDuration. | |
int | $trxWriteAffectedRows = 0 |
Number of rows affected by write queries for the current transaction. | |
string[] | $trxWriteCallers = [] |
Write query callers of the current transaction. | |
float | $trxWriteDuration = 0.0 |
Seconds spent in write queries for the current transaction. | |
int | $trxWriteQueryCount = 0 |
Number of write queries for the current transaction. | |
Static Private Attributes | |
static int | $DEADLOCK_DELAY_MAX = 1500000 |
Maximum time to wait before retry. | |
static int | $DEADLOCK_DELAY_MIN = 500000 |
Minimum time to wait before retry, in microseconds. | |
static int | $DEADLOCK_TRIES = 4 |
Number of times to re-try an operation in case of deadlock. | |
static string | $NOT_APPLICABLE = 'n/a' |
Idiom used when a cancelable atomic section started the transaction. | |
static string | $PING_QUERY = 'SELECT 1 AS ping' |
Dummy SQL query. | |
static int | $PING_TTL = 1.0 |
How long before it is worth doing a dummy query to test the connection. | |
static string | $SAVEPOINT_PREFIX = 'wikimedia_rdbms_atomic' |
Prefix to the atomic section counter used to make savepoint IDs. | |
static float | $SLOW_WRITE_SEC = 0.500 |
Consider a write slow if it took more than this many seconds. | |
static float | $SMALL_WRITE_ROWS = 100 |
Assume an insert of this many rows or less should be fast to replicate. | |
static int | $TEMP_NORMAL = 1 |
Writes to this temporary table do not affect lastDoneWrites() | |
static int | $TEMP_PSEUDO_PERMANENT = 2 |
Writes to this temporary table effect lastDoneWrites() | |
static float | $TINY_WRITE_SEC = 0.010 |
Guess of how many seconds it takes to replicate a small insert. | |
Relational database abstraction object.
Stable to extend
Definition at line 50 of file Database.php.
Wikimedia\Rdbms\Database::__construct | ( | array | $params | ) |
array | $params | Parameters passed from Database::factory() |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 258 of file Database.php.
Wikimedia\Rdbms\Database::__destruct | ( | ) |
Run a few simple sanity checks and close dangling connections.
Definition at line 5546 of file Database.php.
References Wikimedia\Rdbms\Database\closeConnection(), Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers(), and Wikimedia\Rdbms\Database\trxLevel().
Wikimedia\Rdbms\Database::__clone | ( | ) |
Make sure that copies do not share the same client binding handle.
DBConnectionError |
Definition at line 5509 of file Database.php.
References Wikimedia\Rdbms\Database\handleSessionLossPreconnect(), Wikimedia\Rdbms\Database\isOpen(), and Wikimedia\Rdbms\Database\open().
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 5538 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\IDatabase.
Definition at line 5484 of file Database.php.
References Wikimedia\Rdbms\IDatabase\getType().
Wikimedia\Rdbms\Database::addIdentifierQuotes | ( | $s | ) |
Escape a SQL identifier (e.g.table, column, database) for use in a SQL queryDepending on the database this will either be backticks
or "double quotes"
string | $s |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3143 of file Database.php.
References $s.
Referenced by Wikimedia\Rdbms\Database\buildSuperlative(), Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema(), Wikimedia\Rdbms\Database\doReleaseSavepoint(), Wikimedia\Rdbms\Database\doRollbackToSavepoint(), Wikimedia\Rdbms\Database\doSavepoint(), Wikimedia\Rdbms\DatabaseSqlite\doTruncate(), Wikimedia\Rdbms\DatabasePostgres\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseSqlite\duplicateTableStructure(), Wikimedia\Rdbms\Database\fieldNameWithAlias(), Wikimedia\Rdbms\DatabasePostgres\open(), Wikimedia\Rdbms\Database\prependDatabaseOrSchema(), Wikimedia\Rdbms\Database\replaceVars(), Wikimedia\Rdbms\DatabasePostgres\selectSQLText(), Wikimedia\Rdbms\Database\tableName(), and Wikimedia\Rdbms\Database\tableNameWithAlias().
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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3124 of file Database.php.
References $s, and Wikimedia\Rdbms\Database\strencode().
Referenced by Wikimedia\Rdbms\Database\buildGroupConcatField(), Wikimedia\Rdbms\Database\buildLike(), Wikimedia\Rdbms\Database\buildSuperlative(), Wikimedia\Rdbms\DatabaseMysqlBase\lock(), Wikimedia\Rdbms\DatabaseMysqlBase\lockIsFree(), Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), Wikimedia\Rdbms\Database\replaceVars(), and Wikimedia\Rdbms\DatabaseMysqlBase\unlock().
Wikimedia\Rdbms\Database::affectedRows | ( | ) |
Get the number of rows affected by the last write query.
Similar to https://www.php.net/mysql_affected_rows but includes rows matched but not changed (ie. an UPDATE which sets all fields to the same value they already have). To get the old mysql_affected_rows behavior, include non-equality of the fields in WHERE.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4775 of file Database.php.
References Wikimedia\Rdbms\Database\$affectedRowCount, and Wikimedia\Rdbms\Database\fetchAffectedRowCount().
Referenced by Wikimedia\Rdbms\Database\doInsertSelectGeneric(), Wikimedia\Rdbms\Database\doReplace(), Wikimedia\Rdbms\Database\doUpsert(), Wikimedia\Rdbms\Database\executeQueryAttempt(), and Wikimedia\Rdbms\Database\updateTrxWriteQueryTime().
Wikimedia\Rdbms\Database::aggregateValue | ( | $valuedata, | |
$valuename = 'value' |
|||
) |
Return aggregated value alias.
array | $valuedata | |
string | $valuename |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 2575 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\IDatabase.
Definition at line 3204 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\IDatabase.
Definition at line 3208 of file Database.php.
|
protected |
Check type and bounds for parameters to self::buildSubstring()
All supported databases have substring functions that behave the same for positive $startPosition and non-negative $length, but behaviors differ when given 0 or negative $startPosition or negative $length. The simplest solution to that is to just forbid those values.
int | $startPosition | |
int | null | $length |
Definition at line 2707 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\buildSubstring(), and Wikimedia\Rdbms\DatabaseSqlite\buildSubstring().
|
protected |
Check type and bounds conditions parameters for update.
In order to prevent possible performance or replication issues, empty condition for 'update' queries isn't allowed
array | string | $conds | conditions to be validated on emptiness |
string | $fname | caller's function name to be passed to exception |
bool | $deprecate | define the assertion type. If true then wfDeprecated will be called, otherwise DBUnexpectedError will be raised. |
Definition at line 2733 of file Database.php.
References wfDeprecated().
Referenced by Wikimedia\Rdbms\Database\delete(), and Wikimedia\Rdbms\Database\update().
|
finalprotected |
Make sure there is an open connection handle (alive or not) as a sanity check.
This guards against fatal errors to the binding handle not being defined in cases where open() was never called or close() was already called
DBUnexpectedError |
Definition at line 990 of file Database.php.
References Wikimedia\Rdbms\Database\isOpen().
Referenced by Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\DatabaseSqlite\serverIsReadOnly().
|
protected |
Make sure that this server is not marked as a replica nor read-only as a sanity check.
DBReadOnlyError |
Definition at line 1001 of file Database.php.
References $source, and Wikimedia\Rdbms\Database\getReadOnlyReason().
Referenced by Wikimedia\Rdbms\Database\executeQuery().
Wikimedia\Rdbms\Database::assertNoOpenTransactions | ( | ) |
Assert that all explicit transactions or atomic sections have been closed.
DBTransactionError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1531 of file Database.php.
References Wikimedia\Rdbms\Database\explicitTrxActive(), and Wikimedia\Rdbms\Database\flatAtomicSectionList().
|
private |
Error out if the DB is not in a valid state for a query via query()
string | $sql | |
string | $fname |
DBTransactionStateError |
Definition at line 1504 of file Database.php.
References Wikimedia\Rdbms\Database\$trxStatusIgnoredCause, Wikimedia\Rdbms\Database\getQueryVerb(), and Wikimedia\Rdbms\Database\trxStatus().
Referenced by Wikimedia\Rdbms\Database\query().
|
staticfinal |
string | $dbType | A possible DB type (sqlite, mysql, postgres,...) |
string | null | $driver | Optional name of a specific DB client driver |
InvalidArgumentException |
Definition at line 460 of file Database.php.
References Wikimedia\Rdbms\Database\getClass().
Referenced by Wikimedia\Rdbms\LoadBalancer\getServerAttributes().
|
final |
Begin a transaction.
Only call this from code with outer transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.
Note that when the DBO_TRX flag is set (which is usually the case for web requests, but not for maintenance scripts), any previous database query will have started a transaction automatically.
Nesting of transactions is not supported. Attempts to nest transactions will cause a warning, unless the current transaction was started automatically because of the DBO_TRX flag.
string | $fname | Calling function name |
string | $mode | A situationally valid IDatabase::TRANSACTION_* constant [optional] |
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4484 of file Database.php.
References Wikimedia\Rdbms\Database\assertHasConnectionHandle(), Wikimedia\Rdbms\Database\doBegin(), Wikimedia\Rdbms\Database\flatAtomicSectionList(), Wikimedia\Rdbms\Database\getApproximateLagStatus(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\trxLevel(), Wikimedia\Rdbms\Database\trxStatus(), and Wikimedia\Rdbms\Database\trxTimestamp().
Referenced by Wikimedia\Rdbms\Database\beginIfImplied(), Wikimedia\Rdbms\Database\deadlockLoop(), Wikimedia\Rdbms\Database\onTransactionCommitOrIdle(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), and Wikimedia\Rdbms\Database\startAtomic().
|
private |
Start an implicit transaction if DBO_TRX is enabled and no transaction is active.
string | $sql | |
string | $fname |
Definition at line 1452 of file Database.php.
References Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\isTransactableQuery(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt().
Wikimedia\Rdbms\Database::bitAnd | ( | $fieldLeft, | |
$fieldRight | |||
) |
string | int | $fieldLeft | |
string | int | $fieldRight |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2591 of file Database.php.
Wikimedia\Rdbms\Database::bitNot | ( | $field | ) |
string | int | $field |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2583 of file Database.php.
Wikimedia\Rdbms\Database::bitOr | ( | $fieldLeft, | |
$fieldRight | |||
) |
string | int | $fieldLeft | |
string | int | $fieldRight |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2599 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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2607 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 quotedIf $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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2627 of file Database.php.
References Wikimedia\Rdbms\Database\buildSuperlative().
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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2615 of file Database.php.
References Wikimedia\Rdbms\Database\addQuotes(), and Wikimedia\Rdbms\Database\selectSQLText().
Wikimedia\Rdbms\Database::buildIntegerCast | ( | $field | ) |
string | $field | Field or column to cast |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2758 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 quotedIf $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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2635 of file Database.php.
References Wikimedia\Rdbms\Database\buildSuperlative().
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 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\IDatabase.
Definition at line 3177 of file Database.php.
References $s, Wikimedia\Rdbms\Database\addQuotes(), and Wikimedia\Rdbms\Database\escapeLikeInternal().
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\IDatabase.
Definition at line 2762 of file Database.php.
References Wikimedia\Rdbms\Database\selectSQLText().
Referenced by Wikimedia\Rdbms\Database\selectRowCount().
Wikimedia\Rdbms\Database::buildStringCast | ( | $field | ) |
string | $field | Field or column to cast |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2748 of file Database.php.
Wikimedia\Rdbms\Database::buildSubstring | ( | $input, | |
$startPosition, | |||
$length = null |
|||
) |
Stable to override
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2686 of file Database.php.
References Wikimedia\Rdbms\Database\assertBuildSubstringParams().
|
protected |
Build a superlative 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.
Stable to override
string | $sqlfunc | Name of a SQL function |
string | string[] | $fields | Name(s) of column(s) with values to compare |
string | int | float | string[] | int[] | float[] | $values | Values to compare |
Definition at line 2655 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\addQuotes().
Referenced by Wikimedia\Rdbms\Database\buildGreatest(), Wikimedia\Rdbms\DatabaseSqlite\buildGreatest(), Wikimedia\Rdbms\Database\buildLeast(), and Wikimedia\Rdbms\DatabaseSqlite\buildLeast().
|
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4383 of file Database.php.
References Wikimedia\Rdbms\Database\currentAtomicSectionId(), Wikimedia\Rdbms\Database\doRollbackToSavepoint(), Wikimedia\Rdbms\Database\modifyCallbacksForCancel(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\runOnAtomicSectionCancelCallbacks(), Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\trxStatus().
Referenced by Wikimedia\Rdbms\Database\doAtomicSection(), Wikimedia\Rdbms\DatabasePostgres\doInsertNonConflicting(), Wikimedia\Rdbms\Database\doInsertSelectGeneric(), Wikimedia\Rdbms\Database\doReplace(), Wikimedia\Rdbms\Database\doUpsert(), and Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle().
|
private |
Determine whether it is safe to retry queries after a database connection is lost.
string | $sql | SQL query |
bool | $priorWritesPending | Whether there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. |
Definition at line 1550 of file Database.php.
References Wikimedia\Rdbms\Database\explicitTrxActive().
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt().
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\IDatabase.
Definition at line 791 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().
|
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 |
int | null | $owner | ID of the calling instance (e.g. the LBFactory ID) |
DBError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 912 of file Database.php.
References Wikimedia\Rdbms\Database\closeConnection(), Wikimedia\Rdbms\Database\flatAtomicSectionList(), Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\open(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\DatabasePostgres\open().
|
abstractprotected |
Closes underlying database connection.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Referenced by Wikimedia\Rdbms\Database\__destruct(), Wikimedia\Rdbms\Database\close(), and Wikimedia\Rdbms\Database\replaceLostConnection().
|
final |
Commits a transaction previously started using begin()
If no transaction is in progress, a warning is issued.
Only call this from code with outer transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4548 of file Database.php.
References Wikimedia\Rdbms\Database\assertHasConnectionHandle(), Wikimedia\Rdbms\Database\consumeTrxShortId(), Wikimedia\Rdbms\Database\doCommit(), Wikimedia\Rdbms\Database\flatAtomicSectionList(), Wikimedia\Rdbms\Database\getDomainID(), Wikimedia\Rdbms\Database\pendingWriteQueryDuration(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), Wikimedia\Rdbms\Database\runOnTransactionPreCommitCallbacks(), Wikimedia\Rdbms\Database\runTransactionListenerCallbacks(), Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\trxStatus().
Referenced by Wikimedia\Rdbms\Database\deadlockLoop(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\flushSnapshot(), and Wikimedia\Rdbms\Database\getScopedLockAndFlush().
Wikimedia\Rdbms\Database::conditional | ( | $cond, | |
$trueVal, | |||
$falseVal | |||
) |
Returns an SQL expression for a simple conditional.This doesn't need to be overridden unless CASE isn't supported in the RDBMS.
string | array | $cond | SQL expression which will result in a boolean value |
string | $trueVal | SQL expression to return if true |
string | $falseVal | SQL expression to return if false |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3744 of file Database.php.
References Wikimedia\Rdbms\Database\makeList().
Wikimedia\Rdbms\Database::connectionErrorLogger | ( | $errno, | |
$errstr | |||
) |
Error handler for logging errors during database connection This method should not be used outside of Database classes.
int | $errno | |
string | $errstr |
Definition at line 891 of file Database.php.
|
private |
Reset the transaction ID and return the old one.
Definition at line 1635 of file Database.php.
References Wikimedia\Rdbms\Database\$trxShortId.
Referenced by Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\handleSessionLossPreconnect(), and Wikimedia\Rdbms\Database\rollback().
|
private |
Definition at line 3960 of file Database.php.
References Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\onAtomicSectionCancel(), Wikimedia\Rdbms\Database\onTransactionCommitOrIdle(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), and Wikimedia\Rdbms\Database\onTransactionResolution().
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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2775 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\IDatabase.
Definition at line 587 of file Database.php.
References Wikimedia\Rdbms\Database\getDBname().
Referenced by Wikimedia\Rdbms\Database\relationSchemaQualifier().
Wikimedia\Rdbms\Database::deadlockLoop | ( | $args | ) |
Perform a deadlock-prone transaction.This function invokes a callback function to perform a set of write queries. If a deadlock occurs during the processing, the transaction will be rolled back and the callback function will be called again.Avoid using this method outside of Job or Maintenance classes.Usage: $dbw->deadlockLoop( callback, ... );Extra arguments are passed through to the specified callback function. This method requires that no transactions are already active to avoid causing premature commits or exceptions.Returns whatever the callback function returned on its successful, iteration, or false on error, for example if the retry limit was reached.
mixed | ...$args |
DBUnexpectedError | |
Exception |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3834 of file Database.php.
References $args, Wikimedia\Rdbms\Database\$DEADLOCK_TRIES, Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\Database\wasDeadlock().
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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4987 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\IDatabase.
Definition at line 5397 of file Database.php.
References Wikimedia\Rdbms\Database\getInfinity().
Wikimedia\Rdbms\Database::delete | ( | $table, | |
$conds, | |||
$fname = __METHOD__ |
|||
) |
Delete all rows in a table that match a condition.
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 explicitely in order to delete all rows. |
string | $fname | Name of the calling function |
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3452 of file Database.php.
References Wikimedia\Rdbms\Database\assertConditionIsNotEmpty(), Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
Wikimedia\Rdbms\Database::deleteJoin | ( | $delTable, | |
$joinTable, | |||
$delVar, | |||
$joinVar, | |||
$conds, | |||
$fname = __METHOD__ |
|||
) |
DELETE where the condition is a join.MySQL overrides this to use a multi-table DELETE syntax, in other databases we use sub-selectsFor 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.
string | $delTable | The table to delete from. |
string | $joinTable | The other table. |
string | $delVar | The variable to join on, in the first table. |
string | $joinVar | The variable to join on, in the second table. |
array | string | $conds | Condition array of field names mapped to variables, ANDed together in the WHERE clause |
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3413 of file Database.php.
References Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
|
final |
Perform an atomic section of reversable 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 DB updates |
string | $cancelable | Pass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section. |
DBError | If an error occurs, see IDatabase::query() |
Exception | If an error occurs in the callback |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4468 of file Database.php.
References $res, Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), and Wikimedia\Rdbms\Database\startAtomic().
|
protected |
Issues the BEGIN command to the database server.
string | $fname |
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4544 of file Database.php.
References Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\begin().
|
protected |
Issues the COMMIT command to the database server.
Stable to override
string | $fname |
DBError |
Definition at line 4618 of file Database.php.
References Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\commit().
|
protected |
string | $table | |
string | $fname |
Definition at line 5345 of file Database.php.
References Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\dropTable().
|
protected |
Stable to override
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4963 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getLag().
|
protected |
Reset any additional subclass trx* and session* fields Stable to override.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1607 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\handleSessionLossPreconnect().
|
protected |
Actually connect to the database over the wire (or to local files)
DBConnectionError |
Definition at line 328 of file Database.php.
References Wikimedia\Rdbms\Database\open().
Referenced by Wikimedia\Rdbms\Database\initConnection().
|
protected |
string | $table | |
array | $rows | Non-empty list of rows |
string | $fname |
Definition at line 2351 of file Database.php.
References Wikimedia\Rdbms\Database\makeInsertLists(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\replace(), and Wikimedia\Rdbms\Database\upsert().
|
protected |
string | $table | |
array | $rows | Non-empty list of rows |
string | $fname |
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 2368 of file Database.php.
References Wikimedia\Rdbms\Database\makeInsertLists(), Wikimedia\Rdbms\Database\makeInsertNonConflictingVerbAndOptions(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\insert().
|
protected |
Implementation of insertSelect() based on select() and insert()
string | $destTable | |
string | array | $srcTable | |
array | $varMap | |
array | $conds | |
string | $fname | |
array | $insertOptions | |
array | $selectOptions | |
array | $selectJoinConds |
Definition at line 3539 of file Database.php.
References Wikimedia\Rdbms\Database\$affectedRowCount, $res, Wikimedia\Rdbms\Database\affectedRows(), Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\fieldNameWithAlias(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\select(), and Wikimedia\Rdbms\Database\startAtomic().
Referenced by Wikimedia\Rdbms\DatabasePostgres\doInsertSelectNative(), and Wikimedia\Rdbms\Database\insertSelect().
|
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 3604 of file Database.php.
References Wikimedia\Rdbms\Database\isFlagInOptions(), Wikimedia\Rdbms\Database\makeInsertNonConflictingVerbAndOptions(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\selectSQLText(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\insertSelect().
|
protected |
Helper function for lockTables() that handles the actual table locking.
Stable to override
array | $read | Array of tables to lock for read access |
array | $write | Array of tables to lock for write access |
string | $method | Name of caller |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 5304 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\lockTables().
|
abstractprotected |
Run a query and return a DBMS-dependent wrapper or boolean.
This is meant to handle the basic command of actually sending a query to the server via the driver. No implicit transaction, reconnection, nor retry logic should happen here. The higher level query() method is designed to handle those sorts of concerns. This method should not trigger such higher level methods.
The lastError() and lastErrno() methods should meaningfully reflect what error, if any, 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, this returns either:
For non-SELECT queries, this returns either:
string | $sql | SQL query |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt().
|
protected |
Release a savepoint.
This is used internally to implement atomic sections. It should not be used otherwise.
Stable to override
string | $identifier | Identifier for the savepoint |
string | $fname | Calling function name |
Definition at line 4279 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\endAtomic().
|
protected |
string | $table | |
string[][] | $uniqueKeys | Non-empty list of unique keys |
array | $rows | Non-empty list of rows |
string | $fname |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3273 of file Database.php.
References Wikimedia\Rdbms\Database\$affectedRowCount, Wikimedia\Rdbms\Database\affectedRows(), Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\makeConditionCollidesUponKeys(), and Wikimedia\Rdbms\Database\startAtomic().
Referenced by Wikimedia\Rdbms\Database\replace().
|
protected |
Issues the ROLLBACK command to the database server.
Stable to override
string | $fname |
DBError |
Definition at line 4688 of file Database.php.
References Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\rollback().
|
protected |
Rollback to a savepoint.
This is used internally to implement atomic sections. It should not be used otherwise.
Stable to override
string | $identifier | Identifier for the savepoint |
string | $fname | Calling function name |
Definition at line 4295 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\cancelAtomic().
|
protected |
Create a savepoint.
This is used internally to implement atomic sections. It should not be used otherwise.
Stable to override
string | $identifier | Identifier for the savepoint |
string | $fname | Calling function name |
Definition at line 4263 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\startAtomic().
|
protected |
Stable to override.
DatabaseDomain | $domain |
DBConnectionError | |
DBError |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2800 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\selectDomain().
|
protected |
string[] | $tables | |
string | $fname |
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 5376 of file Database.php.
References Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\truncate().
|
protected |
Helper function for unlockTables() that handles the actual table unlocking.
Stable to override
string | $method | Name of caller |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 5325 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\unlockTables().
|
protected |
string | $table | |
array[] | $rows | Non-empty list of rows |
string[][] | $uniqueKeys | Non-empty list of unique keys |
array | $set | |
string | $fname |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3385 of file Database.php.
References Wikimedia\Rdbms\Database\$affectedRowCount, Wikimedia\Rdbms\Database\affectedRows(), Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\makeConditionCollidesUponKeys(), Wikimedia\Rdbms\Database\startAtomic(), and Wikimedia\Rdbms\Database\update().
Referenced by Wikimedia\Rdbms\Database\upsert().
Wikimedia\Rdbms\Database::dropTable | ( | $table, | |
$fname = __METHOD__ |
|||
) |
Delete a table.
string | $table | |
string | $fname |
DBError | If an error occurs |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 5329 of file Database.php.
References Wikimedia\Rdbms\Database\doDropTable(), and Wikimedia\Rdbms\Database\tableExists().
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\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4735 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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4979 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\IDatabase.
Definition at line 5391 of file Database.php.
References Wikimedia\Rdbms\Database\getInfinity(), and Wikimedia\Rdbms\Database\timestamp().
|
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4349 of file Database.php.
References Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\currentAtomicSectionId(), Wikimedia\Rdbms\Database\doReleaseSavepoint(), Wikimedia\Rdbms\Database\reassignCallbacksForSection(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\doAtomicSection(), Wikimedia\Rdbms\DatabasePostgres\doInsertNonConflicting(), Wikimedia\Rdbms\Database\doInsertSelectGeneric(), Wikimedia\Rdbms\Database\doReplace(), Wikimedia\Rdbms\DatabaseSqlite\doTruncate(), Wikimedia\Rdbms\Database\doUpsert(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), and Wikimedia\Rdbms\Database\unlockTables().
|
protected |
Stable to override.
string | $s | |
string | $escapeChar |
Definition at line 3167 of file Database.php.
References $s.
Referenced by Wikimedia\Rdbms\Database\buildLike(), and Wikimedia\Rdbms\DatabaseMysqlBase\tableExists().
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().
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 2037 of file Database.php.
References $res, Wikimedia\Rdbms\Database\extractSingleFieldFromList(), Wikimedia\Rdbms\IDatabase\fetchRow(), Wikimedia\Rdbms\Database\normalizeConditions(), and Wikimedia\Rdbms\Database\select().
|
finalprotected |
Execute a query, retrying it if there is a recoverable connection loss.
This is similar to query() except:
This is meant for internal use with Database subclasses.
string | $sql | Original SQL query |
string | $fname | Name of the calling function |
int | $flags | Bit field of class QUERY_* constants |
DBUnexpectedError |
Definition at line 1267 of file Database.php.
References Wikimedia\Rdbms\Database\$flags, Wikimedia\Rdbms\Database\$TEMP_NORMAL, Wikimedia\Rdbms\Database\assertHasConnectionHandle(), Wikimedia\Rdbms\Database\assertIsWritableMaster(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\fieldHasBit(), Wikimedia\Rdbms\Database\getQueryException(), Wikimedia\Rdbms\Database\getTempTableWrites(), Wikimedia\Rdbms\Database\isWriteQuery(), Wikimedia\Rdbms\Database\registerTempWrites(), Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\trxStatus().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\doSelectDomain(), and Wikimedia\Rdbms\Database\query().
|
private |
Wrapper for doQuery() that handles DBO_TRX, profiling, logging, affected row count tracking, and reconnects (without retry) on query failure due to connection loss.
string | $sql | Original SQL query |
string | $commentedSql | SQL query with debugging/trace comment |
bool | $isPermWrite | Whether the query is a (non-temporary table) write |
string | $fname | Name of the calling function |
int | $flags | Bit field of class QUERY_* constants |
DBUnexpectedError |
Definition at line 1364 of file Database.php.
References Wikimedia\Rdbms\Database\$flags, Wikimedia\Rdbms\Database\$profiler, Wikimedia\Rdbms\Database\affectedRows(), Wikimedia\Rdbms\Database\beginIfImplied(), Wikimedia\Rdbms\Database\canRecoverFromDisconnect(), Wikimedia\Rdbms\Database\doQuery(), Wikimedia\Rdbms\Database\getDomainID(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\getServer(), Wikimedia\Rdbms\IDatabase\lastErrno(), Wikimedia\Rdbms\IDatabase\lastError(), Wikimedia\Rdbms\Database\lastQuery(), Wikimedia\Rdbms\IDatabase\numRows(), Wikimedia\Rdbms\Database\replaceLostConnection(), Wikimedia\Rdbms\Database\trxLevel(), Wikimedia\Rdbms\Database\updateTrxWriteQueryTime(), Wikimedia\Rdbms\Database\wasConnectionError(), Wikimedia\Rdbms\Database\wasKnownStatementRollbackError(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().
Referenced by Wikimedia\Rdbms\Database\executeQuery().
Wikimedia\Rdbms\Database::explicitTrxActive | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4727 of file Database.php.
References Wikimedia\Rdbms\Database\$trxAutomatic, and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\assertNoOpenTransactions(), Wikimedia\Rdbms\Database\canRecoverFromDisconnect(), and Wikimedia\Rdbms\Database\flushSnapshot().
|
finalprotected |
array | string | $var | Field parameter in the style of select() |
Definition at line 2260 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\estimateRowCount(), Wikimedia\Rdbms\DatabasePostgres\estimateRowCount(), Wikimedia\Rdbms\Database\estimateRowCount(), and Wikimedia\Rdbms\Database\selectRowCount().
|
staticfinal |
Construct a Database subclass instance given a database type and parameters.
This also connects to the database immediately upon object construction
string | $type | A possible DB type (sqlite, mysql, postgres,...) |
array | $params | Parameter map with keys:
|
int | $connect | One of the class constants (NEW_CONNECTED, NEW_UNCONNECTED) [optional] |
InvalidArgumentException | If the database driver or extension cannot be found |
Definition at line 405 of file Database.php.
References Wikimedia\Rdbms\Database\$conn, $type, and Wikimedia\Rdbms\Database\getClass().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\newStandaloneInstance(), and Wikimedia\Rdbms\LoadBalancer\reallyOpenConnection().
|
abstractprotected |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Referenced by Wikimedia\Rdbms\Database\affectedRows().
Wikimedia\Rdbms\Database::fieldExists | ( | $table, | |
$field, | |||
$fname = __METHOD__ |
|||
) |
Determines whether a field exists in a table.
string | $table | Table name |
string | $field | Filed to check on that table |
string | $fname | Calling function name (optional) |
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2292 of file Database.php.
References Wikimedia\Rdbms\IMaintainableDatabase\fieldInfo().
|
finalprotected |
int | $field | |
int | $flags |
Definition at line 5457 of file Database.php.
References Wikimedia\Rdbms\Database\$flags.
Referenced by Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\Database\isWriteQuery(), and Wikimedia\Rdbms\Database\query().
|
protected |
Gets an array of aliased field names.
array | $fields | [ [alias] => field ] |
Definition at line 2999 of file Database.php.
References Wikimedia\Rdbms\Database\fieldNameWithAlias().
Referenced by Wikimedia\Rdbms\Database\selectSQLText().
|
protected |
Get an aliased field name e.g.
fieldName AS newFieldName
Stable to override
string | $name | Field name |
string | bool | $alias | Alias (optional) |
Definition at line 2985 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes().
Referenced by Wikimedia\Rdbms\Database\doInsertSelectGeneric(), and Wikimedia\Rdbms\Database\fieldNamesWithAlias().
|
private |
Definition at line 766 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\assertNoOpenTransactions(), Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\close(), and Wikimedia\Rdbms\Database\commit().
Wikimedia\Rdbms\Database::flushSnapshot | ( | $fname = __METHOD__ , |
|
$flush = self::FLUSHING_ONE |
|||
) |
Commit any transaction but error out if writes or callbacks are pending.
This is intended for clearing out REPEATABLE-READ snapshots so that callers can see a new point-in-time of the database. This is useful when one of many transaction rounds finished and significant time will pass in the script's lifetime. It is also useful to call on a replica DB after waiting on replication to catch up to the master.
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4695 of file Database.php.
References Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\explicitTrxActive(), Wikimedia\Rdbms\Database\getTransactionRoundId(), Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers(), Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().
Wikimedia\Rdbms\Database::freeResult | ( | $res | ) |
Free a result object returned by query() or select()It's usually not necessary to call this, just use unset() or let the variable holding the result object go out of scope.
mixed | $res | A SQL result |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1740 of file Database.php.
|
protected |
Get a replica DB lag estimate for this server at the start of a transaction.
This is a no-op unless the server is known a priori to be a replica DB
Stable to override
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4906 of file Database.php.
References Wikimedia\Rdbms\Database\getLag().
Referenced by Wikimedia\Rdbms\Database\begin(), and Wikimedia\Rdbms\Database\getSessionLagStatus().
|
staticprotected |
Stable to override.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 530 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().
Stable to override
DBUnexpectedError |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqli, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 5473 of file Database.php.
References Wikimedia\Rdbms\Database\$conn.
Referenced by Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabasePostgres\doQuery(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\DatabasePostgres\fetchRow(), Wikimedia\Rdbms\DatabasePostgres\getServerVersion(), Wikimedia\Rdbms\DatabasePostgres\numRows(), and Wikimedia\Rdbms\DatabasePostgres\strencode().
|
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
IDatabase | $db1 | |
IDatabase | null | $db2 | [optional] |
DBError |
Definition at line 4932 of file Database.php.
References $res, and Wikimedia\Rdbms\IDatabase\getSessionLagStatus().
|
staticprivate |
string | $dbType | A possible DB type (sqlite, mysql, postgres,...) |
string | null | $driver | Optional name of a specific DB client driver |
InvalidArgumentException |
Definition at line 478 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\attributesFromType(), and Wikimedia\Rdbms\Database\factory().
Wikimedia\Rdbms\Database::getDBname | ( | ) |
Get the current DB name.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2804 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\attachDatabasesFromTableAliases(), Wikimedia\Rdbms\Database\dbSchema(), Wikimedia\Rdbms\DatabaseMysqlBase\doSelectDomain(), Wikimedia\Rdbms\DatabasePostgres\doSelectDomain(), Wikimedia\Rdbms\DatabaseSqlite\doSelectDomain(), Wikimedia\Rdbms\DatabaseSqlite\getDbFilePath(), Wikimedia\Rdbms\Database\getLogContext(), and Wikimedia\Rdbms\DatabaseMysqlBase\listViews().
|
protected |
Get schema variables to use if none have been set via setSchemaVars().
Override this in derived classes to provide variables for tables.sql and SQL patch files.
Stable to override
Definition at line 5200 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getSchemaVars().
Wikimedia\Rdbms\Database::getDomainID | ( | ) |
Return the currently selected domain ID.
Null components (database/schema) might change once a connection is established
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 823 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\__construct(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\handleSessionLossPreconnect(), and Wikimedia\Rdbms\Database\rollback().
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\IDatabase.
Definition at line 819 of file Database.php.
Referenced by Wikimedia\Rdbms\LoadBalancer\applyTransactionRoundFlags(), Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\beginIfImplied(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\getTransactionRoundId(), Wikimedia\Rdbms\Database\lockForUpdate(), Wikimedia\Rdbms\DatabaseMysqli\mysqlConnect(), Wikimedia\Rdbms\DatabaseSqlite\open(), Wikimedia\Rdbms\DatabasePostgres\open(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), Wikimedia\Rdbms\Database\startAtomic(), and Wikimedia\Rdbms\LoadBalancer\undoTransactionRoundFlags().
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\IDatabase.
Definition at line 5387 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\decodeExpiry(), and Wikimedia\Rdbms\Database\encodeExpiry().
Wikimedia\Rdbms\Database::getLag | ( | ) |
Get the amount of replication lag for this database server.
Callers should avoid using this method while a transaction is active
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4949 of file Database.php.
References Wikimedia\Rdbms\Database\doGetLag().
Referenced by Wikimedia\Rdbms\Database\getApproximateLagStatus().
|
protected |
Definition at line 873 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\lastError(), and Wikimedia\Rdbms\Database\restoreErrorHandler().
|
protected |
Get a handle to the master server of the cluster to which this server belongs.
Definition at line 649 of file Database.php.
References Wikimedia\Rdbms\Database\$lazyMasterHandle.
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 617 of file Database.php.
References Wikimedia\Rdbms\Database\$lbInfo.
Referenced by Wikimedia\Rdbms\LoadBalancer\applyTransactionRoundFlags(), Wikimedia\Rdbms\Database\getReadOnlyReason(), Wikimedia\Rdbms\Database\getTransactionRoundId(), and Wikimedia\Rdbms\LoadBalancer\undoTransactionRoundFlags().
|
protected |
Create a log context to pass to PSR-3 logger functions.
array | $extras | Additional data to add to context |
Definition at line 901 of file Database.php.
References Wikimedia\Rdbms\Database\getDBname().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromPtHeartbeat(), Wikimedia\Rdbms\Database\getQueryExceptionAndLog(), Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait(), Wikimedia\Rdbms\Database\newExceptionAfterConnectError(), and Wikimedia\Rdbms\DatabaseSqlite\open().
Wikimedia\Rdbms\Database::getMasterPos | ( | ) |
Get the position of this master.
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3891 of file Database.php.
|
private |
string | $error | |
string | int | $errno | |
string | $sql | |
string | $fname |
Definition at line 1707 of file Database.php.
References Wikimedia\Rdbms\Database\wasConnectionError(), and Wikimedia\Rdbms\Database\wasQueryTimeout().
Referenced by Wikimedia\Rdbms\Database\executeQuery(), and Wikimedia\Rdbms\Database\getQueryExceptionAndLog().
|
private |
string | $error | |
string | int | $errno | |
string | $sql | |
string | $fname |
Definition at line 1683 of file Database.php.
References Wikimedia\Rdbms\Database\getLogContext(), and Wikimedia\Rdbms\Database\getQueryException().
Referenced by Wikimedia\Rdbms\Database\reportQueryError().
|
protected |
string | $sql |
Definition at line 1100 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\assertQueryIsCurrentlyAllowed(), Wikimedia\Rdbms\Database\isTransactableQuery(), Wikimedia\Rdbms\DatabaseSqlite\isTransactableQuery(), and Wikimedia\Rdbms\Database\updateTrxWriteQueryTime().
|
protected |
Definition at line 5420 of file Database.php.
References Wikimedia\Rdbms\Database\getLBInfo().
Referenced by Wikimedia\Rdbms\Database\assertIsWritableMaster(), and Wikimedia\Rdbms\Database\isReadOnly().
|
finalprotected |
Get the replica DB lag when the current transaction started.
This is useful when transactions might use snapshot isolation (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data is this lag plus transaction duration. If they don't, it is still safe to be pessimistic. This returns null if there is no transaction.
This returns null if the lag status for this transaction was not yet recorded.
Definition at line 4891 of file Database.php.
References Wikimedia\Rdbms\Database\$trxReplicaLag, Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\trxTimestamp().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromPtHeartbeat(), and Wikimedia\Rdbms\Database\getSessionLagStatus().
Wikimedia\Rdbms\Database::getReplicaPos | ( | ) |
Get the replication position of this replica DB.
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3882 of file Database.php.
|
protected |
Get schema variables.
If none have been set via setSchemaVars(), then use some defaults from the current object.
Definition at line 5187 of file Database.php.
References Wikimedia\Rdbms\Database\getDefaultSchemaVars().
Referenced by Wikimedia\Rdbms\Database\replaceVars().
Wikimedia\Rdbms\Database::getScopedLockAndFlush | ( | $lockKey, | |
$fname, | |||
$timeout | |||
) |
Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
Only call this from outer transcation scope and when only one DB will be affected. See https://www.mediawiki.org/wiki/Database_transactions for details.
This is suitiable for transactions that need to be serialized using cooperative locks, where each transaction can see each others' changes. Any transaction is flushed to clear out stale REPEATABLE-READ snapshot data. Once the returned object falls out of PHP scope, the lock will be released unless a transaction is active. If one is active, then the lock will be released when it either commits or rolls back.
If the lock acquisition failed, then no transaction flush happens, and null is returned.
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 5235 of file Database.php.
References Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\lock(), Wikimedia\Rdbms\Database\onTransactionResolution(), Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers(), Wikimedia\Rdbms\Database\trxLevel(), Wikimedia\Rdbms\Database\unlock(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().
Wikimedia\Rdbms\Database::getServer | ( | ) |
Get the server hostname or IP address.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2808 of file Database.php.
References Wikimedia\Rdbms\Database\$server.
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\DatabaseMysqlBase\getApproximateLagStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo(), Wikimedia\Rdbms\Database\replaceLostConnection(), and Wikimedia\Rdbms\LoadBalancer\reportConnectionError().
Wikimedia\Rdbms\Database::getServerInfo | ( | ) |
Get a human-readable string describing the current software version.
Use getServerVersion() to get machine-friendly information.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 545 of file Database.php.
References Wikimedia\Rdbms\IDatabase\getServerVersion().
Wikimedia\Rdbms\Database::getServerUptime | ( | ) |
Determines how long the server has been up.
DBError |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3764 of file Database.php.
Wikimedia\Rdbms\Database::getSessionLagStatus | ( | ) |
Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active.
This is useful when transactions might use snapshot isolation (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data is this lag plus transaction duration. If they don't, it is still safe to be pessimistic. In AUTOCOMMIT mode, this still gives an indication of the staleness of subsequent reads.
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4874 of file Database.php.
References Wikimedia\Rdbms\Database\getApproximateLagStatus(), and Wikimedia\Rdbms\Database\getRecordedTransactionLagStatus().
|
protected |
string | $sql | SQL query |
bool | $pseudoPermanent | Treat any table from CREATE TEMPORARY as pseudo-permanent |
Definition at line 1134 of file Database.php.
References Wikimedia\Rdbms\Database\$TEMP_NORMAL, and Wikimedia\Rdbms\Database\$TEMP_PSEUDO_PERMANENT.
Referenced by Wikimedia\Rdbms\Database\executeQuery().
Wikimedia\Rdbms\Database::getTopologyRole | ( | ) |
Get the replication topology role of this server.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 549 of file Database.php.
References Wikimedia\Rdbms\Database\$topologyRole.
Wikimedia\Rdbms\Database::getTopologyRootMaster | ( | ) |
Get the host (or address) of the root master server for the replication topology.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 553 of file Database.php.
References Wikimedia\Rdbms\Database\$topologyRootMaster.
|
finalprotected |
Definition at line 690 of file Database.php.
References Wikimedia\Rdbms\Database\getFlag(), and Wikimedia\Rdbms\Database\getLBInfo().
Referenced by Wikimedia\Rdbms\Database\flushSnapshot(), Wikimedia\Rdbms\Database\onTransactionCommitOrIdle(), and Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle().
|
private |
Clean things up after session (and thus transaction) loss after reconnect.
Definition at line 1614 of file Database.php.
References Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), and Wikimedia\Rdbms\Database\runTransactionListenerCallbacks().
Referenced by Wikimedia\Rdbms\Database\replaceLostConnection().
|
private |
Clean things up after session (and thus transaction) loss before reconnect.
Definition at line 1575 of file Database.php.
References Wikimedia\Rdbms\Database\consumeTrxShortId(), Wikimedia\Rdbms\Database\doHandleSessionLossPreconnect(), Wikimedia\Rdbms\Database\getDomainID(), and Wikimedia\Rdbms\Database\pendingWriteQueryDuration().
Referenced by Wikimedia\Rdbms\Database\__clone(), and Wikimedia\Rdbms\Database\replaceLostConnection().
Wikimedia\Rdbms\Database::ignoreIndexClause | ( | $index | ) |
IGNORE INDEX clause.
The inverse of Database::useIndexClause.
Stable to override
string | $index |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3242 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\makeSelectOptions(), and Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN().
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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 657 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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2298 of file Database.php.
References Wikimedia\Rdbms\Database\indexInfo(), and Wikimedia\Rdbms\Database\tableExists().
|
abstract |
Get information about an index into an object.
Stable to override
string | $table | Table name |
string | $index | Index name |
string | $fname | Calling function name |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Referenced by Wikimedia\Rdbms\Database\indexExists(), and Wikimedia\Rdbms\Database\indexUnique().
|
protected |
Allows for index remapping in queries where this is not consistent across DBMS.
string | $index |
Definition at line 3116 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\ignoreIndexClause(), Wikimedia\Rdbms\DatabaseMysqlBase\indexInfo(), Wikimedia\Rdbms\DatabaseSqlite\indexInfo(), Wikimedia\Rdbms\DatabasePostgres\indexUnique(), Wikimedia\Rdbms\DatabaseSqlite\indexUnique(), Wikimedia\Rdbms\Database\replaceVars(), and Wikimedia\Rdbms\DatabaseMysqlBase\useIndexClause().
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\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2317 of file Database.php.
References Wikimedia\Rdbms\Database\indexInfo().
|
final |
Initialize the connection to the database over the wire (or to local files)
LogicException | |
InvalidArgumentException | |
DBConnectionError |
Definition at line 314 of file Database.php.
References Wikimedia\Rdbms\Database\doInitConnection(), and Wikimedia\Rdbms\Database\isOpen().
Wikimedia\Rdbms\Database::insert | ( | $table, | |
$rows, | |||
$fname = __METHOD__ , |
|||
$options = [] |
|||
) |
Insert the given row(s) into a table.
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2327 of file Database.php.
References Wikimedia\Rdbms\Database\doInsert(), Wikimedia\Rdbms\Database\doInsertNonConflicting(), Wikimedia\Rdbms\Database\isFlagInOptions(), Wikimedia\Rdbms\Database\normalizeOptions(), and Wikimedia\Rdbms\Database\normalizeRowArray().
Referenced by Wikimedia\Rdbms\Database\doInsertSelectGeneric(), Wikimedia\Rdbms\Database\doReplace(), and Wikimedia\Rdbms\Database\doUpsert().
|
final |
INSERT SELECT wrapper.
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3470 of file Database.php.
References Wikimedia\Rdbms\Database\doInsertSelectGeneric(), Wikimedia\Rdbms\Database\doInsertSelectNative(), Wikimedia\Rdbms\Database\isInsertSelectSafe(), and Wikimedia\Rdbms\Database\normalizeOptions().
|
protected |
Set a custom error handler for logging errors during database connection.
Definition at line 850 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\DatabasePostgres\open().
|
finalprotected |
string | $option | Query option flag (e.g. "IGNORE" or "FOR UPDATE") |
array | $options | Combination option/value map and boolean option list |
Definition at line 2246 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\doInsertSelectNative(), and Wikimedia\Rdbms\Database\insert().
|
protected |
Stable to override.
array | $insertOptions | INSERT options |
array | $selectOptions | SELECT options |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3521 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\insertSelect().
Wikimedia\Rdbms\Database::isOpen | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 772 of file Database.php.
References Wikimedia\Rdbms\Database\$conn.
Referenced by Wikimedia\Rdbms\Database\__clone(), Wikimedia\Rdbms\Database\assertHasConnectionHandle(), Wikimedia\Rdbms\Database\initConnection(), Wikimedia\Rdbms\Database\ping(), and Wikimedia\Rdbms\DatabaseSqlite\setTableAliases().
|
protected |
Check if the table is both a TEMPORARY table and has not yet received CRUD operations.
string | $table |
Definition at line 1221 of file Database.php.
References Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\truncate().
Wikimedia\Rdbms\Database::isQuotedIdentifier | ( | $name | ) |
Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers.
Stable to override
string | $name |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3157 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\prependDatabaseOrSchema(), and Wikimedia\Rdbms\Database\tableName().
Wikimedia\Rdbms\Database::isReadOnly | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 5413 of file Database.php.
References Wikimedia\Rdbms\Database\getReadOnlyReason().
|
protected |
Determine whether a SQL statement is sensitive to isolation level.
A SQL statement is considered transactable if its result could vary depending on the transaction isolation level. Operational commands such as 'SET' and 'SHOW' are not considered to be transactable.
Main purpose: Used by query() to decide whether to begin a transaction before the current query (in DBO_TRX mode, on by default).
Stable to override
string | $sql |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1118 of file Database.php.
References Wikimedia\Rdbms\Database\getQueryVerb().
Referenced by Wikimedia\Rdbms\Database\beginIfImplied().
|
protected |
Determine whether a query writes to the DB.
When in doubt, this returns true.
Main use cases:
string | $sql | |
int | $flags | Query flags to query() |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1068 of file Database.php.
References Wikimedia\Rdbms\Database\$flags, and Wikimedia\Rdbms\Database\fieldHasBit().
Referenced by Wikimedia\Rdbms\Database\executeQuery().
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 665 of file Database.php.
Wikimedia\Rdbms\Database::lastQuery | ( | ) |
Get the last query that sent on account of IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 661 of file Database.php.
References Wikimedia\Rdbms\Database\$lastQuery.
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt().
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 | bool | $offset | The SQL offset (default false) |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 3637 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\selectSQLText(), and Wikimedia\Rdbms\Database\unionConditionPermutations().
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\DatabasePostgres, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 4745 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\DatabaseMysqlBase.
Definition at line 4753 of file Database.php.
Wikimedia\Rdbms\Database::lock | ( | $lockName, | |
$method, | |||
$timeout = 5 |
|||
) |
Acquire a named lock.Named locks are not related to transactions
string | $lockName | Name of lock to aquire |
string | $method | Name of the calling method |
int | $timeout | Acquisition timeout in seconds (0 means non-blocking) |
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 5219 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getScopedLockAndFlush().
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2276 of file Database.php.
References Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\selectRowCount(), and Wikimedia\Rdbms\Database\trxLevel().
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 5208 of file Database.php.
|
final |
Lock specific tables.
Any pending transaction should be resolved before calling this method, since: a) Doing so resets any REPEATABLE-READ snapshot of the data to a fresh one. b) Previous row and table locks from the transaction or session may be released by LOCK TABLES, which may be unsafe for the changes in such a transaction. c) The main use case of lockTables() is to avoid deadlocks and timeouts by locking entire tables in order to do long-running, batched, and lag-aware, updates. Batching and replication lag checks do not work when all the updates happen in a transaction.
Always get all relevant table locks up-front in one call, since LOCK TABLES might release any prior table locks on some RDBMes (e.g MySQL).
For compatibility, callers should check tableLocksHaveTransactionScope() before using this method. If locks are scoped specifically to transactions then caller must either:
If session scoped locks are not supported, then calling lockTables() will trigger startAtomic(), with unlockTables() triggering endAtomic(). This will automatically start a transaction if one is not already present and cause the locks to be released when the transaction finishes (normally during the unlockTables() call).
In any case, avoid using begin()/commit() in code that runs while such table locks are acquired, as that breaks in case when a transaction is needed. The startAtomic() and endAtomic() methods are safe, however, since they will join any existing transaction.
array | $read | Array of tables to lock for read access |
array | $write | Array of tables to lock for write access |
string | $method | Name of caller |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 5283 of file Database.php.
References Wikimedia\Rdbms\Database\doLockTables(), Wikimedia\Rdbms\Database\startAtomic(), Wikimedia\Rdbms\Database\tableLocksHaveTransactionScope(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().
|
private |
array[] | $rows | Non-empty list of rows |
string[] | $uniqueKey | List of columns that define a single unique index |
Definition at line 3299 of file Database.php.
References Wikimedia\Rdbms\Database\makeList().
Referenced by Wikimedia\Rdbms\Database\makeConditionCollidesUponKeys().
|
finalprotected |
array[] | $rows | Non-empty list of rows |
string[][] | $uniqueKeys | List of column lists that each define a unique index |
Definition at line 3340 of file Database.php.
References Wikimedia\Rdbms\Database\makeConditionCollidesUponKey(), and Wikimedia\Rdbms\Database\makeList().
Referenced by Wikimedia\Rdbms\Database\doReplace(), and Wikimedia\Rdbms\Database\doUpsert().
|
protected |
Returns an optional GROUP BY with an optional HAVING.
array | $options | Associative array of options |
Definition at line 1878 of file Database.php.
References Wikimedia\Rdbms\Database\makeList().
Referenced by Wikimedia\Rdbms\Database\makeSelectOptions(), and Wikimedia\Rdbms\DatabasePostgres\makeSelectOptions().
|
protected |
Make SQL lists of columns, row tuples for INSERT/VALUES expressions.
The tuple column order is that of the columns of the first provided row. The provided rows must have exactly the same keys and ordering thereof.
array[] | $rows | Non-empty list of (column => value) maps |
Definition at line 2397 of file Database.php.
References Wikimedia\Rdbms\Database\makeList().
Referenced by Wikimedia\Rdbms\Database\doInsert(), Wikimedia\Rdbms\Database\doInsertNonConflicting(), Wikimedia\Rdbms\DatabasePostgres\doInsertNonConflicting(), Wikimedia\Rdbms\DatabaseMysqlBase\doReplace(), Wikimedia\Rdbms\DatabaseSqlite\doReplace(), and Wikimedia\Rdbms\DatabaseMysqlBase\doUpsert().
|
protected |
Stable to override.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2383 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\doInsertNonConflicting(), and Wikimedia\Rdbms\Database\doInsertSelectNative().
Wikimedia\Rdbms\Database::makeList | ( | array | $a, |
$mode = self::LIST_COMMA |
|||
) |
Makes an encoded list of strings from an array.
These can be used to make conjunctions or disjunctions on SQL condition strings derived from an array (see IDatabase::select() $conds documentation).
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2476 of file Database.php.
References Wikimedia\Rdbms\Database\addQuotes(), and Wikimedia\Rdbms\Database\makeList().
Referenced by Wikimedia\Rdbms\Database\conditional(), Wikimedia\Rdbms\Database\delete(), Wikimedia\Rdbms\Database\deleteJoin(), Wikimedia\Rdbms\DatabaseMysqlBase\deleteJoin(), Wikimedia\Rdbms\DatabaseMysqlBase\doUpsert(), Wikimedia\Rdbms\DatabaseMysqlBase\getHeartbeatData(), Wikimedia\Rdbms\Database\makeConditionCollidesUponKey(), Wikimedia\Rdbms\Database\makeConditionCollidesUponKeys(), Wikimedia\Rdbms\Database\makeGroupByWithHaving(), Wikimedia\Rdbms\Database\makeInsertLists(), Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\makeWhereFrom2d(), Wikimedia\Rdbms\Database\selectSQLText(), Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN(), and Wikimedia\Rdbms\Database\update().
|
protected |
Returns an optional ORDER BY.
array | $options | Associative array of options |
Definition at line 1904 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\makeSelectOptions(), Wikimedia\Rdbms\DatabasePostgres\makeSelectOptions(), and Wikimedia\Rdbms\Database\unionConditionPermutations().
|
protected |
Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.
Stable to override
array | $options | Associative array of options to be turned into an SQL query, valid keys are listed in the function. |
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1807 of file Database.php.
References Wikimedia\Rdbms\Database\ignoreIndexClause(), Wikimedia\Rdbms\Database\makeGroupByWithHaving(), Wikimedia\Rdbms\Database\makeOrderBy(), and Wikimedia\Rdbms\Database\useIndexClause().
Referenced by Wikimedia\Rdbms\Database\selectSQLText().
|
protected |
Make UPDATE options for the Database::update function.
Stable to override
array | $options | The options passed to Database::update |
Definition at line 2452 of file Database.php.
References Wikimedia\Rdbms\Database\makeUpdateOptionsArray().
Referenced by Wikimedia\Rdbms\Database\update().
|
protected |
Make UPDATE options array for Database::makeUpdateOptions.
Stable to override
array | $options |
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2433 of file Database.php.
References Wikimedia\Rdbms\Database\normalizeOptions().
Referenced by Wikimedia\Rdbms\Database\makeUpdateOptions().
Wikimedia\Rdbms\Database::makeWhereFrom2d | ( | $data, | |
$baseKey, | |||
$subKey | |||
) |
Build a partial where clause from a 2-d array such as used for LinkBatch.
The keys on each level may be either integers or strings, however it's assumed that $baseKey is probably an integer-typed column (i.e. integer keys are unquoted in the SQL) and $subKey is string-typed (i.e. integer keys are quoted as strings in the SQL).
array | $data | Organized as 2-d [ baseKeyVal => [ subKeyVal => [ignored], ... ], ... ] |
string | $baseKey | Field name to match the base-level keys to (eg 'pl_namespace') |
string | $subKey | Field name to match the sub-level keys to (eg 'pl_title') |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2552 of file Database.php.
References $base, and Wikimedia\Rdbms\Database\makeList().
Wikimedia\Rdbms\Database::masterPosWait | ( | DBMasterPos | $pos, |
$timeout | |||
) |
Wait for the replica DB to catch up to a given master position.Note that this does not start any new transactions. If any existing transaction is flushed, and this is called, then queries will reflect the point the DB was synced up to (on success) without interference from REPEATABLE-READ snapshots.
DBMasterPos | $pos | |
int | $timeout | The maximum number of seconds to wait for synchronisation |
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3873 of file Database.php.
Wikimedia\Rdbms\Database::maxListLen | ( | ) |
Return the maximum number of items allowed in a list, or 0 for unlimited.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4971 of file Database.php.
|
private |
Update callbacks that were owned by cancelled atomic sections.
Callbacks for "on commit" should never be run if they're owned by a section that won't be committed.
Callbacks for "on resolution" need to reflect that the section was rolled back, even if the transaction as a whole commits successfully.
Callbacks for "on section cancel" should already have been consumed, but errors during the cancellation itself can prevent that while still destroying the section. Hoist any such callbacks to the new top section, which we assume will itself have to be cancelled or rolled back to resolve the error.
AtomicSectionIdentifier[] | $sectionIds | ID of an actual savepoint |
AtomicSectionIdentifier | null | $newSectionId | New top section ID. |
UnexpectedValueException |
Definition at line 4020 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\cancelAtomic().
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\DatabaseMysqlBase.
Definition at line 5275 of file Database.php.
|
finalprotected |
string | $error |
Definition at line 1721 of file Database.php.
References Wikimedia\Rdbms\Database\getLogContext().
Referenced by Wikimedia\Rdbms\DatabaseMysqli\mysqlConnect(), Wikimedia\Rdbms\DatabaseSqlite\open(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\DatabasePostgres\open().
Wikimedia\Rdbms\Database::newSelectQueryBuilder | ( | ) |
Create an empty SelectQueryBuilder which can be used to run queries against this connection.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1746 of file Database.php.
|
private |
string | $fname |
Definition at line 4304 of file Database.php.
References Wikimedia\Rdbms\Database\$trxAtomicCounter.
Referenced by Wikimedia\Rdbms\Database\startAtomic().
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 3212 of file Database.php.
|
finalprotected |
array | string | $conds | |
string | $fname |
Definition at line 2157 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\estimateRowCount(), Wikimedia\Rdbms\DatabasePostgres\estimateRowCount(), Wikimedia\Rdbms\Database\estimateRowCount(), and Wikimedia\Rdbms\Database\selectRowCount().
|
finalprotected |
string | array | $options |
Definition at line 2230 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\insertSelect(), Wikimedia\Rdbms\Database\makeUpdateOptionsArray(), Wikimedia\Rdbms\DatabasePostgres\makeUpdateOptionsArray(), Wikimedia\Rdbms\Database\selectField(), and Wikimedia\Rdbms\Database\selectFieldValues().
|
finalprotected |
array | $rowOrRows | A single (field => value) map or a list of such maps |
Definition at line 2131 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\replace(), and Wikimedia\Rdbms\Database\upsert().
|
finalprotected |
string | string[] | string[][] | $uniqueKeys | Unique indexes (first is identity key) |
Definition at line 2178 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\replace(), and Wikimedia\Rdbms\Database\upsert().
|
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 3950 of file Database.php.
References Wikimedia\Rdbms\Database\currentAtomicSectionId(), and Wikimedia\Rdbms\Database\trxLevel().
|
final |
Run a callback as soon as there is no transaction pending.
If there is a transaction and it is rolled back, then the callback is cancelled.
When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.
Queries in the function will run in AUTOCOMMIT mode unless there are begin() calls. Callbacks must commit any transactions that they begin.
This is useful for updates to different systems or when separate transactions are needed. For example, one might want to enqueue jobs into a system outside the database, but only after the database is updated so that the jobs will see the data when they actually run. It can also be used for updates that easily suffer from lock timeouts and deadlocks, but where atomicity is not essential.
Avoid using IDatabase instances aside from this one in the callback, unless such instances never have IDatabase::DBO_TRX set. This keeps callbacks from interfering with one another.
Updates will execute in the order they were enqueued.
The callback takes the following arguments:
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, see IDatabase::query() |
Exception | If the callback runs immediately and an error occurs in it |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3911 of file Database.php.
References Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\currentAtomicSectionId(), Wikimedia\Rdbms\Database\getTransactionRoundId(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\onTransactionIdle().
|
final |
Alias for onTransactionCommitOrIdle() for backwards-compatibility.
callable | $callback | |
string | $fname |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3924 of file Database.php.
References Wikimedia\Rdbms\Database\onTransactionCommitOrIdle().
|
final |
Run a callback before the current transaction commits or now if there is none.
If there is a transaction and it is rolled back, then the callback is cancelled.
When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just before all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.
Callbacks must not start nor commit any transactions. If no transaction is active, then a transaction will wrap the callback.
This is useful for updates that easily suffer from lock timeouts and deadlocks, but where atomicity is strongly desired for these updates and some related updates.
Updates will execute in the order they were enqueued.
The callback takes the one argument:
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, see IDatabase::query() |
Exception | If the callback runs immediately and an error occurs in it |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3928 of file Database.php.
References Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\currentAtomicSectionId(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\getTransactionRoundId(), Wikimedia\Rdbms\Database\startAtomic(), and Wikimedia\Rdbms\Database\trxLevel().
|
final |
Run a callback as soon as the current transaction commits or rolls back.
An error is thrown if no transaction is pending. Queries in the function will run in AUTOCOMMIT mode unless there are begin() calls. Callbacks must commit any transactions that they begin.
This is useful for combining cooperative locks and DB transactions.
Note this is called when the whole transaction is resolved. To take action immediately when an atomic section is cancelled, use onAtomicSectionCancel().
The callback takes the following arguments:
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, see IDatabase::query() |
Exception | If the callback runs immediately and an error occurs in it |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3904 of file Database.php.
References Wikimedia\Rdbms\Database\currentAtomicSectionId(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\getScopedLockAndFlush().
|
abstractprotected |
Open a new connection to the database (closing any existing one)
string | null | $server | Database server host |
string | null | $user | Database user name |
string | null | $password | Database user password |
string | null | $dbName | Database name |
string | null | $schema | Database schema name |
string | $tablePrefix | Table prefix |
DBConnectionError |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabasePostgres.
Referenced by Wikimedia\Rdbms\Database\__clone(), Wikimedia\Rdbms\Database\doInitConnection(), and Wikimedia\Rdbms\Database\replaceLostConnection().
Wikimedia\Rdbms\Database::pendingWriteAndCallbackCallers | ( | ) |
List the methods that have write queries or callbacks for the current transaction.
This method should not be used outside of Database/LoadBalancer
Definition at line 747 of file Database.php.
References Wikimedia\Rdbms\Database\pendingWriteCallers().
Referenced by Wikimedia\Rdbms\Database\__destruct(), Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\flushSnapshot(), and Wikimedia\Rdbms\Database\getScopedLockAndFlush().
Wikimedia\Rdbms\Database::pendingWriteCallers | ( | ) |
Get the list of method names that did write queries for this transaction.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 731 of file Database.php.
References Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers().
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 701 of file Database.php.
References Wikimedia\Rdbms\Database\$trxWriteDuration, $type, Wikimedia\Rdbms\Database\pingAndCalculateLastTrxApplyTime(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\commit(), and Wikimedia\Rdbms\Database\handleSessionLossPreconnect().
Wikimedia\Rdbms\Database::pendingWriteRowsAffected | ( | ) |
Get the number of affected rows from pending write queries.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 735 of file Database.php.
References Wikimedia\Rdbms\Database\$trxWriteAffectedRows.
Wikimedia\Rdbms\Database::ping | ( | & | $rtt = null | ) |
Ping the server and try to reconnect if it there is no connection.
float | null | &$rtt | Value to store the estimated RTT [optional] |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4810 of file Database.php.
References Wikimedia\Rdbms\Database\$flags, Wikimedia\Rdbms\Database\$lastRoundTripEstimate, Wikimedia\Rdbms\Database\isOpen(), and Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\pingAndCalculateLastTrxApplyTime().
|
private |
Definition at line 719 of file Database.php.
References Wikimedia\Rdbms\Database\$trxWriteAdjQueryCount, and Wikimedia\Rdbms\Database\ping().
Referenced by Wikimedia\Rdbms\Database\pendingWriteQueryDuration(), and Wikimedia\Rdbms\Database\rollback().
Wikimedia\Rdbms\Database::preCommitCallbacksPending | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 683 of file Database.php.
References Wikimedia\Rdbms\Database\$trxPreCommitCallbacks, and Wikimedia\Rdbms\Database\trxLevel().
|
private |
string | null | $namespace | Database or schema |
string | $relation | Name of table, view, sequence, etc... |
string | $format | One of (raw, quoted) |
Definition at line 2914 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\isQuotedIdentifier().
Referenced by Wikimedia\Rdbms\Database\tableName().
|
protected |
Get the table components needed for a query given the currently selected database.
string | $name | Table name in the form of db.schema.table, db.table, or table |
Definition at line 2874 of file Database.php.
References Wikimedia\Rdbms\Database\relationSchemaQualifier(), and Wikimedia\Rdbms\Database\tablePrefix().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\tableExists(), and Wikimedia\Rdbms\Database\tableName().
Wikimedia\Rdbms\Database::query | ( | $sql, | |
$fname = __METHOD__ , |
|||
$flags = self::QUERY_NORMAL |
|||
) |
Run an SQL query and return the result.
If a connection loss is detected, then an attempt to reconnect will be made. For queries that involve no larger transactions or locks, they will be re-issued for convenience, provided the connection was re-established.
In new code, the query wrappers select(), insert(), update(), delete(), etc. should be used where possible, since they give much better DBMS independence and automatically quote or validate user input in a variety of contexts. This function is generally only useful for queries which are explicitly DBMS-dependent and are unsupported by the query wrappers, such as CREATE TABLE.
However, the query wrappers themselves should call this function.
string | $sql | SQL query |
string | $fname | Name of the calling function, for profiling/SHOW PROCESSLIST comment (you can use METHOD or add some extra info) |
int | $flags | Bitfield of IDatabase::QUERY_* constants. Note that suppression of errors is best handled by try/catch rather than using one of these flags. |
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 1230 of file Database.php.
References Wikimedia\Rdbms\Database\$flags, Wikimedia\Rdbms\Database\assertQueryIsCurrentlyAllowed(), Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\Database\fieldHasBit(), Wikimedia\Rdbms\Database\reportQueryError(), and Wikimedia\Rdbms\Database\resultObject().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\attachDatabase(), SqliteMaintenance\backup(), Wikimedia\Rdbms\DatabasePostgres\constraintExists(), Wikimedia\Rdbms\DatabasePostgres\currentSequenceValue(), Wikimedia\Rdbms\Database\delete(), Wikimedia\Rdbms\Database\deleteJoin(), Wikimedia\Rdbms\DatabaseMysqlBase\deleteJoin(), Wikimedia\Rdbms\Database\doBegin(), Wikimedia\Rdbms\DatabaseSqlite\doBegin(), Wikimedia\Rdbms\Database\doCommit(), Wikimedia\Rdbms\Database\doDropTable(), Wikimedia\Rdbms\Database\doInsert(), Wikimedia\Rdbms\Database\doInsertNonConflicting(), Wikimedia\Rdbms\DatabasePostgres\doInsertNonConflicting(), Wikimedia\Rdbms\Database\doInsertSelectNative(), Wikimedia\Rdbms\DatabasePostgres\doInsertSelectNative(), Wikimedia\Rdbms\DatabaseMysqlBase\doLockTables(), Wikimedia\Rdbms\DatabasePostgres\doLockTables(), Wikimedia\Rdbms\Database\doReleaseSavepoint(), Wikimedia\Rdbms\DatabaseMysqlBase\doReplace(), Wikimedia\Rdbms\DatabaseSqlite\doReplace(), Wikimedia\Rdbms\Database\doRollback(), Wikimedia\Rdbms\Database\doRollbackToSavepoint(), Wikimedia\Rdbms\Database\doSavepoint(), Wikimedia\Rdbms\Database\doTruncate(), Wikimedia\Rdbms\DatabasePostgres\doTruncate(), Wikimedia\Rdbms\DatabaseSqlite\doTruncate(), Wikimedia\Rdbms\DatabaseMysqlBase\doUnlockTables(), Wikimedia\Rdbms\DatabaseMysqlBase\doUpsert(), Wikimedia\Rdbms\DatabaseSqlite\dropTable(), Wikimedia\Rdbms\DatabaseMysqlBase\duplicateTableStructure(), Wikimedia\Rdbms\DatabasePostgres\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseSqlite\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseMysqlBase\fieldInfo(), Wikimedia\Rdbms\DatabaseSqlite\fieldInfo(), Wikimedia\Rdbms\PostgresField\fromText(), Wikimedia\Rdbms\DatabasePostgres\getCoreSchemas(), Wikimedia\Rdbms\DatabasePostgres\getCurrentSchema(), Wikimedia\Rdbms\DatabaseMysqlBase\getHeartbeatData(), Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromSlaveStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getMysqlStatus(), Wikimedia\Rdbms\DatabasePostgres\getSchemas(), Wikimedia\Rdbms\DatabasePostgres\getSearchPath(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerGTIDs(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerId(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerRoleStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerUUID(), Wikimedia\Rdbms\DatabasePostgres\indexAttributes(), Wikimedia\Rdbms\DatabaseMysqlBase\indexInfo(), Wikimedia\Rdbms\DatabasePostgres\indexInfo(), Wikimedia\Rdbms\DatabaseSqlite\indexInfo(), Wikimedia\Rdbms\DatabasePostgres\indexUnique(), Wikimedia\Rdbms\DatabasePostgres\insertId(), SqliteMaintenance\integrityCheck(), Wikimedia\Rdbms\DatabasePostgres\listTables(), Wikimedia\Rdbms\DatabaseMysqlBase\listTables(), Wikimedia\Rdbms\DatabaseSqlite\listTables(), Wikimedia\Rdbms\DatabaseMysqlBase\listViews(), Wikimedia\Rdbms\DatabaseMysqlBase\lock(), Wikimedia\Rdbms\DatabasePostgres\lock(), Wikimedia\Rdbms\DatabaseMysqlBase\lockIsFree(), Wikimedia\Rdbms\DatabasePostgres\lockIsFree(), Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait(), Wikimedia\Rdbms\DatabaseSqlite\open(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), Wikimedia\Rdbms\DatabasePostgres\open(), Wikimedia\Rdbms\Database\ping(), Wikimedia\Rdbms\DatabasePostgres\relationExists(), Wikimedia\Rdbms\DatabasePostgres\roleExists(), Wikimedia\Rdbms\DatabasePostgres\schemaExists(), Wikimedia\Rdbms\Database\select(), Wikimedia\Rdbms\DatabaseMysqlBase\serverIsReadOnly(), Wikimedia\Rdbms\DatabasePostgres\serverIsReadOnly(), Wikimedia\Rdbms\DatabaseMysqlBase\setBigSelects(), Wikimedia\Rdbms\DatabasePostgres\setSearchPath(), Wikimedia\Rdbms\DatabaseMysqlBase\setSessionOptions(), Wikimedia\Rdbms\Database\sourceStream(), Wikimedia\Rdbms\DatabaseMysqlBase\tableExists(), Wikimedia\Rdbms\DatabaseSqlite\tableExists(), Wikimedia\Rdbms\Database\textFieldSize(), Wikimedia\Rdbms\DatabasePostgres\textFieldSize(), Wikimedia\Rdbms\DatabasePostgres\triggerExists(), Wikimedia\Rdbms\DatabaseMysqlBase\unlock(), Wikimedia\Rdbms\DatabasePostgres\unlock(), Wikimedia\Rdbms\Database\update(), and SqliteMaintenance\vacuum().
|
private |
Hoist callback ownership for callbacks in a section to a parent section.
All callbacks should have an owner that is present in trxAtomicLevels.
AtomicSectionIdentifier | $old | |
AtomicSectionIdentifier | $new |
Definition at line 3976 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\endAtomic().
|
protected |
IResultWrapper | bool | $ret | |
array[] | $changes | List of change n-tuples with from getTempWrites() |
Definition at line 1190 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQuery().
|
protected |
Stable to override.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 613 of file Database.php.
References Wikimedia\Rdbms\Database\dbSchema().
Referenced by Wikimedia\Rdbms\Database\qualifiedTableComponents().
Wikimedia\Rdbms\Database::replace | ( | $table, | |
$uniqueKeys, | |||
$rows, | |||
$fname = __METHOD__ |
|||
) |
Insert row(s) into a table, deleting all conflicting rows beforehand.
Note some important implications of the deletion semantics:
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. 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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3246 of file Database.php.
References Wikimedia\Rdbms\Database\doInsert(), Wikimedia\Rdbms\Database\doReplace(), Wikimedia\Rdbms\Database\normalizeRowArray(), and Wikimedia\Rdbms\Database\normalizeUpsertKeys().
|
protected |
Close any existing (dead) database connection and open a new connection.
string | $fname |
Definition at line 4835 of file Database.php.
References Wikimedia\Rdbms\Database\closeConnection(), Wikimedia\Rdbms\Database\getServer(), Wikimedia\Rdbms\Database\handleSessionLossPostconnect(), Wikimedia\Rdbms\Database\handleSessionLossPreconnect(), and Wikimedia\Rdbms\Database\open().
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt().
|
protected |
Database independent variable replacement.
Replaces a set of variables in an SQL statement with their contents as given by $this->getSchemaVars().
Supports '{$var}' {$var}
and / $var / (without the spaces) style variables.
{$var}
should be used for identifiers (e.g. table and database names). It is passed through the database's addIdentifierQuotes method which can be overridden if the database uses something other than backticks.Stable to override
string | $ins | SQL statement to replace variables in |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 5149 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\Database\addQuotes(), Wikimedia\Rdbms\Database\getSchemaVars(), Wikimedia\Rdbms\Database\indexName(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\sourceStream().
Wikimedia\Rdbms\Database::reportQueryError | ( | $error, | |
$errno, | |||
$sql, | |||
$fname, | |||
$ignore = false |
|||
) |
Report a query error.
Log the error, and if neither the object ignore flag nor the $ignoreErrors flag is set, throw a DBQueryError.
string | $error | |
int | $errno | |
string | $sql | |
string | $fname | |
bool | $ignore |
DBQueryError |
Definition at line 1668 of file Database.php.
References Wikimedia\Rdbms\Database\getQueryExceptionAndLog().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\doSelectDomain(), and Wikimedia\Rdbms\Database\query().
|
protected |
Restore the previous error handler and return the last PHP error for this DB.
Definition at line 861 of file Database.php.
References Wikimedia\Rdbms\Database\getLastPHPError().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\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\IDatabase.
Definition at line 806 of file Database.php.
Referenced by Wikimedia\Rdbms\LoadBalancer\undoTransactionRoundFlags().
|
protected |
Take a query result and wrap it in an iterable result wrapper if necessary.
Booleans are passed through as-is to indicate success/failure of write queries.
Once upon a time, Database::query() returned a bare MySQL result resource, and it was necessary to call this function to convert it to a wrapper. Nowadays, raw database objects are never exposed to external callers, so this is unnecessary in external code.
bool | IResultWrapper | resource | $result |
Definition at line 4798 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\query().
|
final |
Rollback a transaction previously started using begin()
Only call this from code with outer transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported. If a serious unexpected error occurs, throwing an Exception is preferrable, using a pre-installed error handler to trigger rollback (in any case, failure to issue COMMIT will cause rollback server-side).
Query, connection, and onTransaction* callback errors will be suppressed and logged.
string | $fname | Calling function name |
string | $flush | Flush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about calling rollback when no transaction is in progress. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context. |
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4624 of file Database.php.
References Wikimedia\Rdbms\Database\assertHasConnectionHandle(), Wikimedia\Rdbms\Database\consumeTrxShortId(), Wikimedia\Rdbms\Database\doRollback(), Wikimedia\Rdbms\Database\getDomainID(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\pingAndCalculateLastTrxApplyTime(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), Wikimedia\Rdbms\Database\runTransactionListenerCallbacks(), Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\trxStatus().
Referenced by Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\deadlockLoop(), and Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().
|
private |
Actually run any "atomic section cancel" callbacks.
int | $trigger | IDatabase::TRIGGER_* constant |
AtomicSectionIdentifier[] | null | $sectionIds | Section IDs to cancel, null on transaction rollback |
Definition at line 4189 of file Database.php.
References Wikimedia\Rdbms\Database\$errorLogger, and Wikimedia\Rdbms\Database\$trxSectionCancelCallbacks.
Referenced by Wikimedia\Rdbms\Database\cancelAtomic().
Wikimedia\Rdbms\Database::runOnTransactionIdleCallbacks | ( | $trigger | ) |
Actually consume and run any "on transaction idle/resolution" callbacks.
This method should not be used outside of Database/LoadBalancer
int | $trigger | IDatabase::TRIGGER_* constant |
Exception |
Definition at line 4085 of file Database.php.
References Wikimedia\Rdbms\Database\clearFlag(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\setFlag(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\handleSessionLossPostconnect(), Wikimedia\Rdbms\Database\onTransactionCommitOrIdle(), and Wikimedia\Rdbms\Database\rollback().
Wikimedia\Rdbms\Database::runOnTransactionPreCommitCallbacks | ( | ) |
Actually consume and run any "on transaction pre-commit" callbacks.
This method should not be used outside of Database/LoadBalancer
Exception |
Definition at line 4154 of file Database.php.
References Wikimedia\Rdbms\Database\$errorLogger, and Wikimedia\Rdbms\Database\$trxPreCommitCallbacks.
Referenced by Wikimedia\Rdbms\Database\commit(), and Wikimedia\Rdbms\LoadBalancer\finalizeMasterChanges().
Wikimedia\Rdbms\Database::runTransactionListenerCallbacks | ( | $trigger | ) |
Actually run any "transaction listener" callbacks.
This method should not be used outside of Database/LoadBalancer
int | $trigger | IDatabase::TRIGGER_* constant |
Exception |
Definition at line 4230 of file Database.php.
References Wikimedia\Rdbms\Database\$errorLogger.
Referenced by Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\handleSessionLossPostconnect(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\LoadBalancer\runMasterTransactionListenerCallbacks().
Wikimedia\Rdbms\Database::select | ( | $table, | |
$vars, | |||
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Execute a SELECT query constructed using the various parameters provided.
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.
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. In the most common case, this is unnecessary, since the join condition can be in $conds. However, it is useful for doing a LEFT JOIN.
The key of the array contains the table name or alias. The value is an array with two elements, numbered 0 and 1. The first gives the type of join, the second is the same as the $conds parameter. Thus it can be an SQL fragment, or an array where the string keys are equality and the numeric keys are SQL fragments all AND'd together. For example:
[ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1916 of file Database.php.
References Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\selectSQLText().
Referenced by Wikimedia\Rdbms\Database\doInsertSelectGeneric(), Wikimedia\Rdbms\DatabaseMysqlBase\estimateRowCount(), Wikimedia\Rdbms\DatabasePostgres\estimateRowCount(), Wikimedia\Rdbms\Database\estimateRowCount(), Wikimedia\Rdbms\Database\selectField(), Wikimedia\Rdbms\Database\selectFieldValues(), Wikimedia\Rdbms\Database\selectRow(), and Wikimedia\Rdbms\Database\selectRowCount().
|
final |
Change the current database.
This should only be called by a load balancer or if the handle is not attached to one
string | $db |
DBConnectionError | If databasesAreIndependent() is true and connection change fails |
DBError | On query error or if database changes are disallowed |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2779 of file Database.php.
References Wikimedia\Rdbms\Database\selectDomain().
|
final |
Set the current domain (database, schema, and table prefix)
This will throw an error for some database types if the database is unspecified
This should only be called by a load balancer or if the handle is not attached to one
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\IDatabase.
Definition at line 2789 of file Database.php.
References Wikimedia\Rdbms\Database\doSelectDomain(), and Wikimedia\Rdbms\DatabaseDomain\newFromId().
Referenced by Wikimedia\Rdbms\Database\selectDB().
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.
string | array | $table | Table name. See IDatabase::select() for details. |
string | $var | The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. |
string | array | $cond | The condition array. See IDatabase::select() for details. |
string | $fname | The function name of the caller. |
string | array | $options | The query options. See IDatabase::select() for details. |
string | array | $join_conds | The query join conditions. See IDatabase::select() for details. |
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1750 of file Database.php.
References $res, Wikimedia\Rdbms\IDatabase\fetchRow(), Wikimedia\Rdbms\Database\normalizeOptions(), and Wikimedia\Rdbms\Database\select().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getServerVersion(), Wikimedia\Rdbms\DatabasePostgres\ruleExists(), and Wikimedia\Rdbms\DatabaseMysqlBase\setBigSelects().
|
private |
array | string | $fields | |
array | string | $options |
Definition at line 2103 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\selectSQLText().
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.
string | array | $table | Table name. See IDatabase::select() for details. |
string | $var | The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. |
string | array | $cond | The condition array. See IDatabase::select() for details. |
string | $fname | The function name of the caller. |
string | array | $options | The query options. See IDatabase::select() for details. |
string | array | $join_conds | The query join conditions. See IDatabase::select() for details. |
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1773 of file Database.php.
References $res, Wikimedia\Rdbms\Database\normalizeOptions(), and Wikimedia\Rdbms\Database\select().
|
private |
string | array | $options |
Definition at line 2087 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\selectSQLText().
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.
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2015 of file Database.php.
References $res, Wikimedia\Rdbms\IDatabase\fetchObject(), Wikimedia\Rdbms\IDatabase\numRows(), and Wikimedia\Rdbms\Database\select().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getReplicationSafetyInfo(), Wikimedia\Rdbms\DatabaseSqlite\indexUnique(), and Wikimedia\Rdbms\DatabaseMysqlBase\wasKnownStatementRollbackError().
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().
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2054 of file Database.php.
References $res, Wikimedia\Rdbms\Database\buildSelectSubquery(), Wikimedia\Rdbms\Database\extractSingleFieldFromList(), Wikimedia\Rdbms\IDatabase\fetchRow(), Wikimedia\Rdbms\Database\normalizeConditions(), and Wikimedia\Rdbms\Database\select().
Referenced by Wikimedia\Rdbms\Database\lockForUpdate().
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 |
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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1928 of file Database.php.
References Wikimedia\Rdbms\Database\fieldNamesWithAlias(), Wikimedia\Rdbms\Database\limitResult(), Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\makeSelectOptions(), Wikimedia\Rdbms\Database\selectFieldsOrOptionsAggregate(), Wikimedia\Rdbms\Database\selectOptionsIncludeLocking(), and Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN().
Referenced by Wikimedia\Rdbms\Database\buildGroupConcatField(), Wikimedia\Rdbms\DatabaseSqlite\buildGroupConcatField(), Wikimedia\Rdbms\Database\buildSelectSubquery(), Wikimedia\Rdbms\Database\doInsertSelectNative(), Wikimedia\Rdbms\Database\select(), and Wikimedia\Rdbms\Database\unionConditionPermutations().
Wikimedia\Rdbms\Database::serverIsReadOnly | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3900 of file Database.php.
Wikimedia\Rdbms\Database::setBigSelects | ( | $value = true | ) |
Allow or deny "big selects" for this session only.This is done by setting the sql_big_selects session variable.This is a MySQL-specific feature.
bool | string | $value | True for allow, false for deny, or "default" to restore the initial value |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 5409 of file Database.php.
Wikimedia\Rdbms\Database::setFlag | ( | $flag, | |
$remember = self::REMEMBER_NOTHING |
|||
) |
Set a flag for this connection.
int | $flag | One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX) |
string | $remember | IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING] |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 776 of file Database.php.
Referenced by Wikimedia\Rdbms\LoadBalancer\applyTransactionRoundFlags(), and Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().
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\IDatabase.
Definition at line 5447 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 | null | $value | If $nameOrArray is a string, the new key value (null to unset) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 629 of file Database.php.
Referenced by Wikimedia\Rdbms\LoadBalancer\applyTransactionRoundFlags(), and Wikimedia\Rdbms\LoadBalancer\undoTransactionRoundFlags().
Wikimedia\Rdbms\Database::setLogger | ( | LoggerInterface | $logger | ) |
Set the PSR-3 logger interface to use for query logging.
(The logger interfaces for connection logging and error logging can be set with the constructor.)
LoggerInterface | $logger |
Definition at line 541 of file Database.php.
Wikimedia\Rdbms\Database::setSchemaVars | ( | $vars | ) |
Set schema variables to be used when streaming commands from SQL files or stdin.
Variables appear as SQL comments and are substituted by their corresponding values
array | null | $vars | Map of (variable => value) or null to use the defaults |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 5033 of file Database.php.
Wikimedia\Rdbms\Database::setSessionOptions | ( | array | $options | ) |
Override database's default behavior.$options include: 'connTimeout' : Set the connection timeout value in seconds. May be useful for very long batch queries such as full-wiki dumps, where a single query reads out over hours or days.
array | $options |
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 4998 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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 5439 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 4055 of file Database.php.
|
final |
Whether to disable running of post-COMMIT/ROLLBACK callbacks.
This method should not be used outside of Database/LoadBalancer
bool | $suppress |
Definition at line 4071 of file Database.php.
Referenced by Wikimedia\Rdbms\LoadBalancer\finalizeMasterChanges(), and Wikimedia\Rdbms\LoadBalancer\runMasterTransactionIdleCallbacks().
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 |
bool | string | $fname | Calling function name or false if name should be generated dynamically using $filename |
callable | null | $inputCallback | Optional function called for each complete line sent |
Exception |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 5001 of file Database.php.
References Wikimedia\Rdbms\Database\sourceStream().
Wikimedia\Rdbms\Database::sourceStream | ( | $fp, | |
callable | $lineCallback = null , |
||
callable | $resultCallback = null , |
||
$fname = __METHOD__ , |
|||
callable | $inputCallback = null |
||
) |
Read and execute commands from an open file handle.
Returns true on success, error string or exception on failure (depending on object's error ignore settings).
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 5037 of file Database.php.
References Wikimedia\Rdbms\Database\$delimiter, $line, $res, Wikimedia\Rdbms\IDatabase\lastError(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\replaceVars(), and Wikimedia\Rdbms\Database\streamStatementEnd().
Referenced by Wikimedia\Rdbms\Database\sourceFile().
|
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4319 of file Database.php.
References Wikimedia\Rdbms\Database\$NOT_APPLICABLE, Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\doSavepoint(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\nextSavepointId(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\doAtomicSection(), Wikimedia\Rdbms\DatabasePostgres\doInsertNonConflicting(), Wikimedia\Rdbms\Database\doInsertSelectGeneric(), Wikimedia\Rdbms\Database\doReplace(), Wikimedia\Rdbms\DatabaseSqlite\doTruncate(), Wikimedia\Rdbms\Database\doUpsert(), Wikimedia\Rdbms\Database\lockTables(), and Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle().
Wikimedia\Rdbms\Database::streamStatementEnd | ( | & | $sql, |
& | $newLine | ||
) |
Called by sourceStream() to check if we've reached a statement end.
Stable to override
string | &$sql | SQL assembled so far |
string | &$newLine | New line about to be added to $sql |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 5115 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\sourceStream().
|
abstract |
Wrapper for addslashes()
Stable to override
string | $s | String to be slashed. |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Referenced by Wikimedia\Rdbms\Database\addQuotes().
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\IDatabase.
Definition at line 3756 of file Database.php.
|
abstract |
Query whether a given table exists.
string | $table | |
string | $fname |
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.
Referenced by Wikimedia\Rdbms\Database\dropTable(), and Wikimedia\Rdbms\Database\indexExists().
Wikimedia\Rdbms\Database::tableLocksHaveTransactionScope | ( | ) |
Checks if table locks acquired by lockTables() are transaction-bound in their scope.
Transaction-bound table locks will be released when the current transaction terminates. Table locks that are not bound to a transaction are not effected by BEGIN/COMMIT/ROLLBACK and will last until either lockTables()/unlockTables() is called or the TCP connection to the database is closed.
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 5279 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\lockTables(), and Wikimedia\Rdbms\Database\unlockTables().
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\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2816 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\Database\isQuotedIdentifier(), Wikimedia\Rdbms\Database\prependDatabaseOrSchema(), and Wikimedia\Rdbms\Database\qualifiedTableComponents().
Referenced by Wikimedia\Rdbms\Database\delete(), Wikimedia\Rdbms\Database\deleteJoin(), Wikimedia\Rdbms\DatabaseMysqlBase\deleteJoin(), Wikimedia\Rdbms\Database\doDropTable(), Wikimedia\Rdbms\Database\doInsert(), Wikimedia\Rdbms\Database\doInsertNonConflicting(), Wikimedia\Rdbms\Database\doInsertSelectNative(), Wikimedia\Rdbms\DatabaseMysqlBase\doLockTables(), Wikimedia\Rdbms\DatabaseMysqlBase\doReplace(), Wikimedia\Rdbms\Database\doTruncate(), Wikimedia\Rdbms\DatabaseMysqlBase\doUpsert(), Wikimedia\Rdbms\DatabaseMysqlBase\fieldInfo(), Wikimedia\Rdbms\DatabaseMysqlBase\indexInfo(), Wikimedia\Rdbms\Database\isPristineTemporaryTable(), Wikimedia\Rdbms\Database\replaceVars(), Wikimedia\Rdbms\Database\tableNames(), Wikimedia\Rdbms\Database\tableNamesN(), Wikimedia\Rdbms\Database\tableNameWithAlias(), Wikimedia\Rdbms\Database\textFieldSize(), and Wikimedia\Rdbms\Database\update().
Wikimedia\Rdbms\Database::tableNames | ( | $tables | ) |
Fetch a number of table names into an array This is handy when you need to construct SQL for joins.
Example: list( $user, $watchlist ) = $dbr->tableNames( 'user', 'watchlist' ) ); $sql = "SELECT wl_namespace, wl_title FROM $watchlist, $user WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
string | ...$tables |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 2925 of file Database.php.
References Wikimedia\Rdbms\Database\tableName().
Wikimedia\Rdbms\Database::tableNamesN | ( | $tables | ) |
Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins.
Example: list( $user, $watchlist ) = $dbr->tableNamesN( 'user', 'watchlist' ); $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
string | ...$tables |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 2935 of file Database.php.
References Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\DatabasePostgres\doTruncate().
|
protected |
Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause.
array | $tables | ( [alias] => table ) |
array | $use_index | Same as for select() |
array | $ignore_index | Same as for select() |
array | $join_conds | Same as for select() |
Definition at line 3021 of file Database.php.
References Wikimedia\Rdbms\Database\ignoreIndexClause(), Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN(), Wikimedia\Rdbms\Database\tableNameWithAlias(), and Wikimedia\Rdbms\Database\useIndexClause().
Referenced by Wikimedia\Rdbms\Database\selectSQLText(), and Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN().
|
protected |
Get an aliased table name.
This returns strings like "tableName AS newTableName" for aliased tables and "(SELECT * from tableA) newTablename" for subqueries (e.g. derived tables)
string | Subquery | $table | Table name or object with a 'sql' field |
string | bool | $alias | Table alias (optional) |
Definition at line 2956 of file Database.php.
References Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN().
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\IDatabase.
Definition at line 573 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\qualifiedTableComponents().
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\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3435 of file Database.php.
References $res, Wikimedia\Rdbms\IDatabase\fetchObject(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 4761 of file Database.php.
References $t.
Referenced by Wikimedia\Rdbms\Database\encodeExpiry(), and Wikimedia\Rdbms\Database\timestampOrNull().
Wikimedia\Rdbms\Database::timestampOrNull | ( | $ts = null | ) |
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.
If NULL is input, it is passed through, allowing NULL values to be inserted into timestamp fields.
The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
string | int | null | $ts |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 4767 of file Database.php.
References Wikimedia\Rdbms\Database\timestamp().
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 5353 of file Database.php.
References Wikimedia\Rdbms\Database\doTruncate(), and Wikimedia\Rdbms\Database\isPristineTemporaryTable().
|
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 557 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\__destruct(), Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\beginIfImplied(), Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\currentAtomicSectionId(), Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema(), Wikimedia\Rdbms\Database\doCommit(), Wikimedia\Rdbms\Database\doRollback(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\explicitTrxActive(), Wikimedia\Rdbms\Database\flushSnapshot(), Wikimedia\Rdbms\Database\getRecordedTransactionLagStatus(), Wikimedia\Rdbms\Database\getScopedLockAndFlush(), Wikimedia\Rdbms\Database\lockForUpdate(), Wikimedia\Rdbms\Database\onAtomicSectionCancel(), Wikimedia\Rdbms\Database\onTransactionCommitOrIdle(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), Wikimedia\Rdbms\Database\onTransactionResolution(), Wikimedia\Rdbms\Database\pendingWriteCallers(), Wikimedia\Rdbms\Database\pendingWriteQueryDuration(), Wikimedia\Rdbms\Database\preCommitCallbacksPending(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\LoadBalancer\runMasterTransactionIdleCallbacks(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), Wikimedia\Rdbms\Database\startAtomic(), Wikimedia\Rdbms\Database\trxTimestamp(), Wikimedia\Rdbms\Database\writesOrCallbacksPending(), and Wikimedia\Rdbms\Database\writesPending().
Wikimedia\Rdbms\Database::trxStatus | ( | ) |
Definition at line 569 of file Database.php.
References Wikimedia\Rdbms\Database\$trxStatus.
Referenced by Wikimedia\Rdbms\Database\assertQueryIsCurrentlyAllowed(), Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\cancelAtomic(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\executeQuery(), and Wikimedia\Rdbms\Database\rollback().
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 561 of file Database.php.
References Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\trxTimestamp().
Referenced by Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\getRecordedTransactionLagStatus(), and Wikimedia\Rdbms\Database\trxTimestamp().
Wikimedia\Rdbms\Database::unionConditionPermutations | ( | $table, | |
$vars, | |||
array | $permute_conds, | ||
$extra_conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Construct a UNION query for permutations of conditions.
Databases sometimes have trouble with queries that have multiple values for multiple condition parameters combined with limits and ordering. This method constructs queries for the Cartesian product of the conditions and unions them all together.
string | array | $table | Table name |
string | array | $vars | Field names |
array | $permute_conds | Conditions for the Cartesian product. Keys are field names, values are arrays of the possible values for that field. |
string | array | $extra_conds | Additional conditions to include in the query. |
string | $fname | Caller function name |
string | array | $options | Query options. In addition to the options recognized by IDatabase::select(), the following may be used:
|
string | array | $join_conds | Join conditions |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3669 of file Database.php.
References Wikimedia\Rdbms\Database\limitResult(), Wikimedia\Rdbms\Database\makeOrderBy(), Wikimedia\Rdbms\Database\selectSQLText(), Wikimedia\Rdbms\Database\unionQueries(), and Wikimedia\Rdbms\Database\unionSupportsOrderAndLimit().
Wikimedia\Rdbms\Database::unionQueries | ( | $sqls, | |
$all | |||
) |
Construct a UNION query.This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.
array | $sqls | SQL statements to combine |
bool | $all | Either IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3663 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\unionConditionPermutations().
Wikimedia\Rdbms\Database::unionSupportsOrderAndLimit | ( | ) |
Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3655 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\unionConditionPermutations().
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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 5229 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getScopedLockAndFlush().
|
final |
Unlock all tables locked via lockTables()
If table locks are scoped to transactions, then locks might not be released until the transaction ends, which could happen after this method is called.
string | $method | The caller |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 5308 of file Database.php.
References Wikimedia\Rdbms\Database\doUnlockTables(), Wikimedia\Rdbms\Database\endAtomic(), and Wikimedia\Rdbms\Database\tableLocksHaveTransactionScope().
Wikimedia\Rdbms\Database::update | ( | $table, | |
$set, | |||
$conds, | |||
$fname = __METHOD__ , |
|||
$options = [] |
|||
) |
Update all rows in a table that match a given condition.
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 explicitely 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, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2458 of file Database.php.
References Wikimedia\Rdbms\Database\assertConditionIsNotEmpty(), Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\makeUpdateOptions(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\doUpsert().
|
private |
Update the estimated run-time of a query, not counting large row lock times.
LoadBalancer can be set to rollback transactions that will create huge replication lag. It bases this estimate off of pendingWriteQueryDuration(). Certain simple queries, like inserting a row can take a long time due to row locking. This method uses some simple heuristics to discount those cases.
string | $sql | A SQL write query |
float | $runtime | Total runtime, including RTT |
int | $affected | Affected row count |
Definition at line 1475 of file Database.php.
References Wikimedia\Rdbms\Database\$SMALL_WRITE_ROWS, Wikimedia\Rdbms\Database\affectedRows(), and Wikimedia\Rdbms\Database\getQueryVerb().
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt().
Wikimedia\Rdbms\Database::upsert | ( | $table, | |
array | $rows, | ||
$uniqueKeys, | |||
array | $set, | ||
$fname = __METHOD__ |
|||
) |
Upsert the given row(s) into a table.
This updates any existing rows that conflict with the provided rows and inserts any of the provided rows that do not conflict with existing rows. Conflicts are determined by the provided unique indexes.
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. 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 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 modified AUTOINCREMENT or UUID columns in assignments. |
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, see IDatabase::query() |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3355 of file Database.php.
References Wikimedia\Rdbms\Database\doInsert(), Wikimedia\Rdbms\Database\doUpsert(), Wikimedia\Rdbms\Database\normalizeRowArray(), and Wikimedia\Rdbms\Database\normalizeUpsertKeys().
Wikimedia\Rdbms\Database::useIndexClause | ( | $index | ) |
USE INDEX clause.
This can be used as optimisation in queries that affect tables with multiple indexes if the database does not pick the most optimal one by default. The "right" index might vary between database backends and versions thereof, as such in practice this is biased toward specifically improving performance of large wiki farms that use MySQL or MariaDB (like Wikipedia).
Stable to override
string | $index |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3229 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\makeSelectOptions(), and Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN().
Wikimedia\Rdbms\Database::wasConnectionError | ( | $errno | ) |
Do not use this method outside of Database/DBError classes.
Stable to override
int | string | $errno |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3815 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\getQueryException(), and Wikimedia\Rdbms\Database\wasConnectionLoss().
Wikimedia\Rdbms\Database::wasConnectionLoss | ( | ) |
Determines if the last query error was due to a dropped connection.Note that during a connection loss, the prior transaction will have been lost
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3788 of file Database.php.
References Wikimedia\Rdbms\IDatabase\lastErrno(), and Wikimedia\Rdbms\Database\wasConnectionError().
Referenced by Wikimedia\Rdbms\Database\wasErrorReissuable().
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\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3772 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\deadlockLoop(), and Wikimedia\Rdbms\Database\wasErrorReissuable().
Wikimedia\Rdbms\Database::wasErrorReissuable | ( | ) |
Determines if the last query error was due to something outside of the query itself.
Note that the transaction may have been lost, discarding prior writes and results
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3800 of file Database.php.
References Wikimedia\Rdbms\Database\wasConnectionLoss(), Wikimedia\Rdbms\Database\wasDeadlock(), and Wikimedia\Rdbms\Database\wasLockTimeout().
|
protected |
Stable to override.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3826 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt().
Wikimedia\Rdbms\Database::wasLockTimeout | ( | ) |
Determines if the last failure was due to a lock timeout.Note that during a lock wait timeout, the prior transaction will have been lost
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 3780 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\wasErrorReissuable().
|
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.
Stable to override
string | $error | Error text |
int | $errno | Error number |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 1653 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getQueryException().
Wikimedia\Rdbms\Database::wasReadOnlyError | ( | ) |
Determines if the last failure was due to the database being read-only.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3796 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 673 of file Database.php.
References Wikimedia\Rdbms\Database\$trxSectionCancelCallbacks, and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\flushSnapshot(), Wikimedia\Rdbms\Database\getScopedLockAndFlush(), and Wikimedia\Rdbms\Database\lockTables().
Wikimedia\Rdbms\Database::writesPending | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 669 of file Database.php.
References Wikimedia\Rdbms\Database\$trxDoneWrites, and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\LoadBalancer\runMasterTransactionIdleCallbacks().
|
protected |
Rows affected by the last query to query() or its CRUD wrappers.
Definition at line 177 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\affectedRows(), Wikimedia\Rdbms\DatabasePostgres\doInsertNonConflicting(), Wikimedia\Rdbms\Database\doInsertSelectGeneric(), Wikimedia\Rdbms\Database\doReplace(), and Wikimedia\Rdbms\Database\doUpsert().
|
protected |
Agent name for query profiling.
Definition at line 87 of file Database.php.
|
protected |
Whether this PHP instance is for a CLI script.
Definition at line 85 of file Database.php.
|
protected |
Database connection.
Definition at line 73 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabaseMysqli\closeConnection(), Wikimedia\Rdbms\DatabasePostgres\doQuery(), Wikimedia\Rdbms\Database\factory(), Wikimedia\Rdbms\DatabaseMysqli\fetchAffectedRowCount(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\DatabasePostgres\fetchRow(), Wikimedia\Rdbms\Database\getBindingHandle(), Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo(), Wikimedia\Rdbms\DatabasePostgres\getServerVersion(), Wikimedia\Rdbms\DatabaseMysqli\insertId(), Wikimedia\Rdbms\Database\isOpen(), Wikimedia\Rdbms\DatabaseMysqli\mysqlError(), Wikimedia\Rdbms\DatabaseMysqli\mysqlRealEscapeString(), and Wikimedia\Rdbms\DatabasePostgres\numRows().
|
protected |
Parameters used by initConnection() to establish a connection.
Definition at line 93 of file Database.php.
|
protected |
SQL variables values to use for all new connections.
Definition at line 95 of file Database.php.
|
protected |
Definition at line 54 of file Database.php.
|
protected |
Definition at line 69 of file Database.php.
|
staticprotected |
Bit field of all DBO_* flags that can be changed after connection.
Definition at line 249 of file Database.php.
|
staticprivate |
Maximum time to wait before retry.
Definition at line 227 of file Database.php.
|
staticprivate |
Minimum time to wait before retry, in microseconds.
Definition at line 225 of file Database.php.
|
staticprivate |
Number of times to re-try an operation in case of deadlock.
Definition at line 223 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\deadlockLoop().
|
protected |
Current SQL query delimiter.
Definition at line 104 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\buildGroupConcatField(), and Wikimedia\Rdbms\Database\sourceStream().
|
protected |
Deprecation logging callback.
Definition at line 62 of file Database.php.
|
protected |
Error logging callback.
Definition at line 60 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\runOnAtomicSectionCancelCallbacks(), Wikimedia\Rdbms\Database\runOnTransactionPreCommitCallbacks(), and Wikimedia\Rdbms\Database\runTransactionListenerCallbacks().
|
protected |
Current bit field of class DBO_* constants.
Definition at line 100 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\Database\fieldHasBit(), Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerGTIDs(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerId(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerRoleStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerUUID(), Wikimedia\Rdbms\DatabasePostgres\indexAttributes(), Wikimedia\Rdbms\DatabasePostgres\indexUnique(), Wikimedia\Rdbms\Database\isWriteQuery(), Wikimedia\Rdbms\DatabaseSqlite\isWriteQuery(), Wikimedia\Rdbms\DatabaseMysqlBase\lock(), Wikimedia\Rdbms\DatabaseMysqlBase\lockIsFree(), Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait(), Wikimedia\Rdbms\DatabaseSqlite\open(), Wikimedia\Rdbms\Database\ping(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\DatabaseMysqlBase\serverIsReadOnly(), Wikimedia\Rdbms\DatabaseMysqlBase\setSessionOptions(), Wikimedia\Rdbms\DatabasePostgres\textFieldSize(), and Wikimedia\Rdbms\DatabaseMysqlBase\unlock().
|
private |
Stashed value of html_errors INI setting.
Definition at line 113 of file Database.php.
|
protected |
Current map of (index alias => index)
Definition at line 108 of file Database.php.
|
private |
Definition at line 186 of file Database.php.
|
private |
UNIX timestamp.
Definition at line 180 of file Database.php.
|
private |
The last SQL query attempted.
Definition at line 182 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\lastQuery().
|
private |
Query round trip time estimate.
Definition at line 188 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\ping().
|
private |
UNIX timestamp of last write query.
Definition at line 184 of file Database.php.
|
private |
Lazy handle to the master DB this server replicates from.
Definition at line 76 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getLazyMasterHandle().
|
protected |
Current LoadBalancer tracking information.
Definition at line 102 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getLBInfo().
|
staticprotected |
List of DBO_* flags that can be changed after connection.
Definition at line 242 of file Database.php.
|
protected |
Row batch size to use for emulated INSERT SELECT queries.
Definition at line 97 of file Database.php.
|
staticprivate |
Idiom used when a cancelable atomic section started the transaction.
Definition at line 213 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\startAtomic().
|
private |
Integer ID of the managing LBFactory instance or null if none.
Definition at line 191 of file Database.php.
|
protected |
Password used to establish the current connection.
Definition at line 83 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\DatabasePostgres\open().
|
staticprivate |
Dummy SQL query.
Definition at line 232 of file Database.php.
|
staticprivate |
How long before it is worth doing a dummy query to test the connection.
Definition at line 230 of file Database.php.
|
private |
Prior flags member variable values.
Definition at line 115 of file Database.php.
|
protected |
Definition at line 64 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt().
|
protected |
Definition at line 56 of file Database.php.
|
protected |
Definition at line 58 of file Database.php.
|
staticprivate |
Prefix to the atomic section counter used to make savepoint IDs.
Definition at line 215 of file Database.php.
|
protected |
Current variables use for schema element placeholders.
Definition at line 110 of file Database.php.
|
protected |
Server that this instance is currently connected to.
Definition at line 79 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getServer(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\DatabasePostgres\open().
|
protected |
Map of (table name => 1) for current TEMPORARY tables.
Definition at line 122 of file Database.php.
|
protected |
Map of (name => 1) for locks obtained via lock()
Definition at line 118 of file Database.php.
|
protected |
Map of (table name => 1) for current TEMPORARY tables.
Definition at line 120 of file Database.php.
|
staticprivate |
Consider a write slow if it took more than this many seconds.
Definition at line 237 of file Database.php.
|
staticprivate |
Assume an insert of this many rows or less should be fast to replicate.
Definition at line 239 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\updateTrxWriteQueryTime().
|
protected |
APC cache.
Definition at line 52 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo(), and Wikimedia\Rdbms\DatabaseMysqlBase\getServerVersion().
|
protected |
Current map of (table => (dbname, schema, prefix) map)
Definition at line 106 of file Database.php.
|
staticprivate |
Writes to this temporary table do not affect lastDoneWrites()
Definition at line 218 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\executeQuery(), and Wikimedia\Rdbms\Database\getTempTableWrites().
|
staticprivate |
Writes to this temporary table effect lastDoneWrites()
Definition at line 220 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getTempTableWrites().
|
staticprivate |
Guess of how many seconds it takes to replicate a small insert.
Definition at line 235 of file Database.php.
|
protected |
Replication topology role of the server; one of the class ROLE_* constants.
Definition at line 89 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getTopologyRole().
|
protected |
Host (or address) of the root master server for the replication topology.
Definition at line 91 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getTopologyRootMaster().
|
private |
Counter for atomic savepoint identifiers (reset with each transaction)
Definition at line 143 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\nextSavepointId().
|
private |
List of (name, unique ID, savepoint ID) for each active atomic section level.
Definition at line 145 of file Database.php.
|
private |
Whether the current transaction was started implicitly due to DBO_TRX.
Definition at line 141 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\explicitTrxActive().
|
private |
Whether the current transaction was started implicitly by startAtomic()
Definition at line 147 of file Database.php.
|
private |
Whether possible write queries were done in the last transaction started.
Definition at line 139 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\writesPending().
|
private |
List of (callable, method name, atomic section id) -var array<array{0:callable,1:string,2:AtomicSectionIdentifier|null}>
Definition at line 168 of file Database.php.
|
private |
Whether to suppress triggering of transaction end callbacks.
Definition at line 174 of file Database.php.
|
private |
Name of the function that start the last transaction.
Definition at line 137 of file Database.php.
|
private |
List of (callable, method name, atomic section id)
Definition at line 161 of file Database.php.
|
private |
List of (callable, method name, atomic section id)
Definition at line 163 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\preCommitCallbacksPending(), and Wikimedia\Rdbms\Database\runOnTransactionPreCommitCallbacks().
|
protected |
Definition at line 66 of file Database.php.
|
private |
Map of (name => callable)
Definition at line 172 of file Database.php.
|
private |
Replication lag estimate at the time of BEGIN for the last transaction.
Definition at line 135 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getRecordedTransactionLagStatus().
|
private |
List of (callable, method name, atomic section id)
Definition at line 170 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\runOnAtomicSectionCancelCallbacks(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().
|
private |
ID of the active transaction or the empty string otherwise.
Definition at line 125 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\consumeTrxShortId().
|
private |
Transaction status.
Definition at line 127 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\trxStatus().
|
private |
The last error that caused the status to become STATUS_TRX_ERROR.
Definition at line 129 of file Database.php.
|
private |
Error details of the last statement-only rollback.
Definition at line 131 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\assertQueryIsCurrentlyAllowed().
|
private |
UNIX timestamp at the time of BEGIN for the last transaction.
Definition at line 133 of file Database.php.
|
private |
Like trxWriteQueryCount but excludes lock-bound, easy to replicate, queries.
Definition at line 157 of file Database.php.
|
private |
Number of write queries counted in trxWriteAdjDuration.
Definition at line 159 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\pingAndCalculateLastTrxApplyTime().
|
private |
Number of rows affected by write queries for the current transaction.
Definition at line 155 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\pendingWriteRowsAffected().
|
private |
Write query callers of the current transaction.
Definition at line 149 of file Database.php.
|
private |
Seconds spent in write queries for the current transaction.
Definition at line 151 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\pendingWriteQueryDuration().
|
private |
Number of write queries for the current transaction.
Definition at line 153 of file Database.php.
|
protected |
User that this instance is currently connected under the name of.
Definition at line 81 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\DatabasePostgres\open().