MediaWiki
1.30.0
|
Relational database abstraction object. More...
Public Member Functions | |
__clone () | |
Make sure that copies do not share the same client binding handle. More... | |
__construct (array $params) | |
Constructor and database handle and attempt to connect to the DB server. More... | |
__destruct () | |
Run a few simple sanity checks and close dangling connections. More... | |
__sleep () | |
Called by serialize. More... | |
__toString () | |
addIdentifierQuotes ( $s) | |
Quotes an identifier using backticks or "double quotes" depending on the database type. More... | |
addQuotes ( $s) | |
Adds quotes and backslashes. More... | |
aggregateValue ( $valuedata, $valuename='value') | |
Return aggregated value alias. More... | |
anyChar () | |
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More... | |
anyString () | |
Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More... | |
begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT) | |
Begin a transaction. More... | |
bitAnd ( $fieldLeft, $fieldRight) | |
bitNot ( $field) | |
bitOr ( $fieldLeft, $fieldRight) | |
bufferResults ( $buffer=null) | |
Turns buffering of SQL result sets on (true) or off (false). More... | |
buildConcat ( $stringList) | |
Build a concatenation list to feed into a SQL query. More... | |
buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[]) | |
Build a GROUP_CONCAT or equivalent statement for a query. More... | |
buildLike () | |
LIKE statement wrapper, receives 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(). More... | |
buildStringCast ( $field) | |
clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Clear a flag for this connection. More... | |
close () | |
Closes a database connection. More... | |
commit ( $fname=__METHOD__, $flush='') | |
Commits a transaction previously started using begin(). More... | |
conditional ( $cond, $trueVal, $falseVal) | |
Returns an SQL expression for a simple conditional. More... | |
connectionErrorLogger ( $errno, $errstr) | |
Error handler for logging errors during database connection This method should not be used outside of Database classes. More... | |
databasesAreIndependent () | |
Returns true if DBs are assumed to be on potentially different servers. More... | |
dbSchema ( $schema=null) | |
Get/set the db schema. More... | |
deadlockLoop () | |
Perform a deadlock-prone transaction. More... | |
decodeBlob ( $b) | |
Some DBMSs return a special placeholder object representing blob fields in result objects. More... | |
decodeExpiry ( $expiry, $format=TS_MW) | |
Decode an expiry time into a DBMS independent format. More... | |
delete ( $table, $conds, $fname=__METHOD__) | |
DELETE query wrapper. More... | |
deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__) | |
DELETE where the condition is a join. More... | |
doAtomicSection ( $fname, callable $callback) | |
Run a callback to do an atomic set of updates for this database. More... | |
doneWrites () | |
Returns true if the connection may have been used for write queries. More... | |
dropTable ( $tableName, $fName=__METHOD__) | |
Delete a table. More... | |
duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__) | |
Creates a new table with structure copied from existing table. More... | |
encodeBlob ( $b) | |
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. More... | |
encodeExpiry ( $expiry) | |
Encode an expiry time into the DBMS dependent format. More... | |
endAtomic ( $fname=__METHOD__) | |
Ends an atomic section of SQL statements. More... | |
estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=[]) | |
Estimate the number of rows in dataset. More... | |
explicitTrxActive () | |
fieldExists ( $table, $field, $fname=__METHOD__) | |
Determines whether a field exists in a table. More... | |
flushSnapshot ( $fname=__METHOD__) | |
Commit any transaction but error out if writes or callbacks are pending. More... | |
freeResult ( $res) | |
Free a result object returned by query() or select(). More... | |
getDBname () | |
Get the current DB name. More... | |
getDomainID () | |
getFlag ( $flag) | |
Returns a boolean whether the flag $flag is set for this connection. More... | |
getInfinity () | |
Find out when 'infinity' is. More... | |
getLag () | |
Get replica DB lag. More... | |
getLBInfo ( $name=null) | |
Get properties passed down from the server info array of the load balancer. More... | |
getMasterPos () | |
Get the position of this master. More... | |
getProperty ( $name) | |
getReplicaPos () | |
Get the replication position of this replica DB. More... | |
getScopedLockAndFlush ( $lockKey, $fname, $timeout) | |
Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More... | |
getServer () | |
Get the server hostname or IP address. More... | |
getServerInfo () | |
A string describing the current software version, and possibly other details in a user-friendly way. More... | |
getServerUptime () | |
Determines how long the server has been up. More... | |
getSessionLagStatus () | |
Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More... | |
getWikiID () | |
Alias for getDomainID() More... | |
ignoreIndexClause ( $index) | |
IGNORE INDEX clause. More... | |
implicitGroupby () | |
Returns true if this database does an implicit sort when doing GROUP BY. More... | |
implicitOrderby () | |
Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1. More... | |
indexExists ( $table, $index, $fname=__METHOD__) | |
Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure. More... | |
indexInfo ( $table, $index, $fname=__METHOD__) | |
Get information about an index into an object. More... | |
indexUnique ( $table, $index) | |
Determines if a given index is unique. More... | |
insert ( $table, $a, $fname=__METHOD__, $options=[]) | |
INSERT wrapper, inserts an array into a table. More... | |
insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |
INSERT SELECT wrapper. More... | |
isOpen () | |
Is a connection to the database open? More... | |
isQuotedIdentifier ( $name) | |
Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers . More... | |
isReadOnly () | |
lastDoneWrites () | |
Returns the last time the connection may have been used for write queries. More... | |
lastQuery () | |
Return the last query that went through IDatabase::query() More... | |
limitResult ( $sql, $limit, $offset=false) | |
Construct a LIMIT query with optional offset. More... | |
listTables ( $prefix=null, $fname=__METHOD__) | |
List all tables on the database. More... | |
listViews ( $prefix=null, $fname=__METHOD__) | |
Lists all the VIEWs in the database. More... | |
lock ( $lockName, $method, $timeout=5) | |
Acquire a named lock. More... | |
lockIsFree ( $lockName, $method) | |
Check to see if a named lock is available (non-blocking) More... | |
lockTables (array $read, array $write, $method) | |
Lock specific tables. More... | |
makeList ( $a, $mode=self::LIST_COMMA) | |
Makes an encoded list of strings from an array. More... | |
makeWhereFrom2d ( $data, $baseKey, $subKey) | |
Build a partial where clause from a 2-d array such as used for LinkBatch. More... | |
masterPosWait (DBMasterPos $pos, $timeout) | |
Wait for the replica DB to catch up to a given master position. More... | |
maxListLen () | |
Return the maximum number of items allowed in a list, or 0 for unlimited. More... | |
namedLocksEnqueue () | |
Check to see if a named lock used by lock() use blocking queues. More... | |
nextSequenceValue ( $seqName) | |
Deprecated method, calls should be removed. More... | |
onTransactionIdle (callable $callback, $fname=__METHOD__) | |
Run a callback as soon as there is no transaction pending. More... | |
onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__) | |
Run a callback before the current transaction commits or now if there is none. More... | |
onTransactionResolution (callable $callback, $fname=__METHOD__) | |
Run a callback as soon as the current transaction commits or rolls back. More... | |
pendingWriteCallers () | |
Get the list of method names that did write queries for this transaction. More... | |
pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL) | |
Get the time spend running write queries for this transaction. More... | |
pendingWriteRowsAffected () | |
Get the number of affected rows from pending write queries. More... | |
ping (&$rtt=null) | |
Ping the server and try to reconnect if it there is no connection. More... | |
query ( $sql, $fname=__METHOD__, $tempIgnore=false) | |
Run an SQL query and return the result. More... | |
replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__) | |
REPLACE query wrapper. More... | |
reportConnectionError ( $error='Unknown error') | |
reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false) | |
Report a query error. More... | |
restoreFlags ( $state=self::RESTORE_PRIOR) | |
Restore the flags to their prior state before the last setFlag/clearFlag call. More... | |
rollback ( $fname=__METHOD__, $flush='') | |
Rollback a transaction previously started using begin(). More... | |
runOnTransactionIdleCallbacks ( $trigger) | |
Actually run and consume any "on transaction idle/resolution" callbacks. More... | |
runOnTransactionPreCommitCallbacks () | |
Actually run and consume any "on transaction pre-commit" callbacks. More... | |
runTransactionListenerCallbacks ( $trigger) | |
Actually run any "transaction listener" callbacks. More... | |
select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Execute a SELECT query constructed using the various parameters provided. More... | |
selectDB ( $db) | |
Change the current database. More... | |
selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
A SELECT wrapper which returns a single field from a single result row. More... | |
selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
A SELECT wrapper which returns a list of single field values from result rows. More... | |
selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[]) | |
Single row SELECT wrapper. More... | |
selectRowCount ( $tables, $vars=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Get the number of rows in dataset. More... | |
selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed. More... | |
serverIsReadOnly () | |
setBigSelects ( $value=true) | |
Allow or deny "big selects" for this session only. More... | |
setFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Set a flag for this connection. More... | |
setLazyMasterHandle (IDatabase $conn) | |
Set a lazy-connecting DB handle to the master DB (for replication status purposes) More... | |
setLBInfo ( $name, $value=null) | |
Set the LB info array, or a member of it. More... | |
setLogger (LoggerInterface $logger) | |
Set the PSR-3 logger interface to use for query logging. More... | |
setSchemaVars ( $vars) | |
Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS. More... | |
setSessionOptions (array $options) | |
Override database's default behavior. More... | |
setTableAliases (array $aliases) | |
Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. More... | |
setTransactionListener ( $name, callable $callback=null) | |
Run a callback each time any transaction commits or rolls back. More... | |
setTrxEndCallbackSuppression ( $suppress) | |
Whether to disable running of post-COMMIT/ROLLBACK callbacks. More... | |
sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null) | |
Read and execute SQL commands from a file. More... | |
sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null) | |
Read and execute commands from an open file handle. More... | |
startAtomic ( $fname=__METHOD__) | |
Begin an atomic section of statements. More... | |
streamStatementEnd (&$sql, &$newLine) | |
Called by sourceStream() to check if we've reached a statement end. More... | |
strencode ( $s) | |
Wrapper for addslashes() More... | |
strreplace ( $orig, $old, $new) | |
Returns a command for str_replace function in SQL query. More... | |
tableExists ( $table, $fname=__METHOD__) | |
Query whether a given table exists. More... | |
tableLocksHaveTransactionScope () | |
Checks if table locks acquired by lockTables() are transaction-bound in their scope. More... | |
tableName ( $name, $format='quoted') | |
Format a table name ready for use in constructing an SQL query. More... | |
tableNames () | |
Fetch a number of table names into an array This is handy when you need to construct SQL for joins. More... | |
tableNamesN () | |
Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins. More... | |
tablePrefix ( $prefix=null) | |
Get/set the table prefix. More... | |
textFieldSize ( $table, $field) | |
Returns the size of a text field, or -1 for "unlimited". More... | |
timestamp ( $ts=0) | |
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More... | |
timestampOrNull ( $ts=null) | |
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More... | |
trxLevel () | |
Gets the current transaction level. More... | |
trxTimestamp () | |
Get the UNIX timestamp of the time that the transaction was established. More... | |
unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Construct a UNION query for permutations of conditions. More... | |
unionQueries ( $sqls, $all) | |
Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax. More... | |
unionSupportsOrderAndLimit () | |
Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct. More... | |
unlock ( $lockName, $method) | |
Release a lock. More... | |
unlockTables ( $method) | |
Unlock all tables locked via lockTables() More... | |
update ( $table, $values, $conds, $fname=__METHOD__, $options=[]) | |
UPDATE wrapper. More... | |
upsert ( $table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__) | |
INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. More... | |
useIndexClause ( $index) | |
USE INDEX clause. More... | |
wasConnectionError ( $errno) | |
Do not use this method outside of Database/DBError classes. More... | |
wasDeadlock () | |
Determines if the last failure was due to a deadlock. More... | |
wasErrorReissuable () | |
Determines if the last query error was due to a dropped connection and should be dealt with by pinging the connection and reissuing the query. More... | |
wasLockTimeout () | |
Determines if the last failure was due to a lock timeout. More... | |
wasReadOnlyError () | |
Determines if the last failure was due to the database being read-only. More... | |
writesOrCallbacksPending () | |
Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. More... | |
writesPending () | |
Public Member Functions inherited from Wikimedia\Rdbms\IDatabase | |
affectedRows () | |
Get the number of rows affected by the last write query. More... | |
dataSeek ( $res, $row) | |
Change the position of the cursor in a result object. More... | |
fetchObject ( $res) | |
Fetch the next row from the given result object, in object form. More... | |
fetchRow ( $res) | |
Fetch the next row from the given result object, in associative array form. More... | |
fieldInfo ( $table, $field) | |
mysql_fetch_field() wrapper Returns false if the field doesn't exist More... | |
fieldName ( $res, $n) | |
Get a field name in a result object. More... | |
getServerVersion () | |
A string describing the current software version, like from mysql_get_server_info(). More... | |
getSoftwareLink () | |
Returns a wikitext link to the DB's website, e.g., return "[https://www.mysql.com/ MySQL]"; Should at least contain plain text, if for some reason your database has no website. More... | |
getType () | |
Get the type of the DBMS, as it appears in $wgDBtype. More... | |
insertId () | |
Get the inserted value of an auto-increment row. More... | |
lastErrno () | |
Get the last error number. More... | |
lastError () | |
Get a description of the last error. More... | |
numFields ( $res) | |
Get the number of fields in a result object. More... | |
numRows ( $res) | |
Get the number of rows in a result object. More... | |
open ( $server, $user, $password, $dbName) | |
Open a connection to the database. More... | |
Static Public Member Functions | |
static | factory ( $dbType, $p=[]) |
Construct a Database subclass instance given a database type and parameters. More... | |
static | getCacheSetOptions (IDatabase $db1) |
Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination. More... | |
Public Attributes | |
const | DEADLOCK_DELAY_MAX = 1500000 |
Maximum time to wait before retry. More... | |
const | DEADLOCK_DELAY_MIN = 500000 |
Minimum time to wait before retry, in microseconds. More... | |
const | DEADLOCK_TRIES = 4 |
Number of times to re-try an operation in case of deadlock. More... | |
const | PING_QUERY = 'SELECT 1 AS ping' |
const | PING_TTL = 1.0 |
How long before it is worth doing a dummy query to test the connection. More... | |
const | SLOW_WRITE_SEC = 0.500 |
const | SMALL_WRITE_ROWS = 100 |
const | TINY_WRITE_SEC = 0.010 |
Protected Member Functions | |
assertOpen () | |
Make sure isOpen() returns true as a sanity check. More... | |
closeConnection () | |
Closes underlying database connection. More... | |
doBegin ( $fname) | |
Issues the BEGIN command to the database server. More... | |
doCommit ( $fname) | |
Issues the COMMIT command to the database server. More... | |
doLockTables (array $read, array $write, $method) | |
Helper function for lockTables() that handles the actual table locking. More... | |
doQuery ( $sql) | |
The DBMS-dependent part of query() More... | |
doRollback ( $fname) | |
Issues the ROLLBACK command to the database server. More... | |
doUnlockTables ( $method) | |
Helper function for unlockTables() that handles the actual table unlocking. More... | |
escapeLikeInternal ( $s, $escapeChar='`') | |
fieldNamesWithAlias ( $fields) | |
Gets an array of aliased field names. More... | |
fieldNameWithAlias ( $name, $alias=false) | |
Get an aliased field name e.g. More... | |
getApproximateLagStatus () | |
Get a replica DB lag estimate for this server. More... | |
getBindingHandle () | |
Get the underlying binding handle, mConn. More... | |
getDefaultSchemaVars () | |
Get schema variables to use if none have been set via setSchemaVars(). More... | |
getLastPHPError () | |
getLazyMasterHandle () | |
getLogContext (array $extras=[]) | |
Create a log context to pass to PSR-3 logger functions. More... | |
getQueryVerb ( $sql) | |
getReadOnlyReason () | |
getSchemaVars () | |
Get schema variables. More... | |
getTransactionLagStatus () | |
Get the replica DB lag when the current transaction started. More... | |
ignoreErrors ( $ignoreErrors=null) | |
Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors. More... | |
indexName ( $index) | |
Allows for index remapping in queries where this is not consistent across DBMS. More... | |
installErrorHandler () | |
Set a custom error handler for logging errors during database connection. More... | |
isTransactableQuery ( $sql) | |
Determine whether a SQL statement is sensitive to isolation level. More... | |
isWriteQuery ( $sql) | |
Determine whether a query writes to the DB. More... | |
makeGroupByWithHaving ( $options) | |
Returns an optional GROUP BY with an optional HAVING. More... | |
makeInsertOptions ( $options) | |
Helper for Database::insert(). More... | |
makeOrderBy ( $options) | |
Returns an optional ORDER BY. More... | |
makeSelectOptions ( $options) | |
Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. More... | |
makeUpdateOptions ( $options) | |
Make UPDATE options for the Database::update function. More... | |
makeUpdateOptionsArray ( $options) | |
Make UPDATE options array for Database::makeUpdateOptions. More... | |
nativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |
Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory. More... | |
nativeReplace ( $table, $rows, $fname) | |
REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More... | |
pendingWriteAndCallbackCallers () | |
Get the list of method names that have pending write queries or callbacks for this transaction. More... | |
qualifiedTableComponents ( $name) | |
Get the table components needed for a query given the currently selected database. More... | |
reconnect () | |
Close existing database connection and open a new connection. More... | |
registerTempTableOperation ( $sql) | |
replaceVars ( $ins) | |
Database independent variable replacement. More... | |
requiresDatabaseUser () | |
restoreErrorHandler () | |
Restore the previous error handler and return the last PHP error for this DB. More... | |
resultObject ( $result) | |
Take the result from a query, and wrap it in a ResultWrapper if necessary. More... | |
tableNamesWithAlias ( $tables) | |
Gets an array of aliased table names. More... | |
tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[]) | |
Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause. More... | |
tableNameWithAlias ( $name, $alias=false) | |
Get an aliased table name e.g. More... | |
Static Protected Member Functions | |
static | generalizeSQL ( $sql) |
Removes most variables from an SQL query and replaces them with X or N for numbers. More... | |
Protected Attributes | |
string | $agent |
Agent name for query profiling. More... | |
bool | $cliMode |
Whether this PHP instance is for a CLI script. More... | |
LoggerInterface | $connLogger |
DatabaseDomain | $currentDomain |
string | $delimiter = ';' |
callback | $errorLogger |
Error logging callback. More... | |
string bool null | $htmlErrors |
Stashed value of html_errors INI setting. More... | |
float | $lastPing = 0.0 |
UNIX timestamp. More... | |
resource null | $mConn = null |
Database connection. More... | |
string | $mDBname |
bool null | $mDefaultBigSelects = null |
int | $mFlags |
string | $mLastQuery = '' |
SQL query. More... | |
float bool | $mLastWriteTime = false |
UNIX timestamp of last write query. More... | |
array | $mLBInfo = [] |
bool | $mOpened = false |
string | $mPassword |
string bool | $mPHPError = false |
string | $mSchema = '' |
array bool | $mSchemaVars = false |
string | $mServer |
array | $mSessionTempTables = [] |
Map of (table name => 1) for TEMPORARY tables. More... | |
array | $mSessionVars = [] |
string | $mTablePrefix = '' |
array[] | $mTrxEndCallbacks = [] |
List of (callable, method name) More... | |
bool | $mTrxEndCallbacksSuppressed = false |
Whether to suppress triggering of transaction end callbacks. More... | |
array[] | $mTrxIdleCallbacks = [] |
List of (callable, method name) More... | |
int | $mTrxLevel = 0 |
Either 1 if a transaction is active or 0 otherwise. More... | |
array[] | $mTrxPreCommitCallbacks = [] |
List of (callable, method name) More... | |
callable[] | $mTrxRecurringCallbacks = [] |
Map of (name => callable) More... | |
string | $mTrxShortId = '' |
Either a short hexidecimal string if a transaction is active or "". More... | |
string | $mUser |
array null | $preparedArgs |
object string | $profiler |
Class name or object With profileIn/profileOut methods. More... | |
LoggerInterface | $queryLogger |
BagOStuff | $srvCache |
APC cache. More... | |
$tableAliases = [] | |
TransactionProfiler | $trxProfiler |
Private Member Functions | |
canRecoverFromDisconnect ( $sql, $priorWritesPending) | |
Determine whether or not it is safe to retry queries after a database connection is lost. More... | |
doProfiledQuery ( $sql, $commentedSql, $isWrite, $fname) | |
Helper method for query() that handles profiling and logging and sends the query to doQuery() More... | |
handleSessionLoss () | |
Clean things up after transaction loss due to disconnection. More... | |
prependDatabaseOrSchema ( $namespace, $relation, $format) | |
updateTrxWriteQueryTime ( $sql, $runtime, $affected) | |
Update the estimated run-time of a query, not counting large row lock times. More... | |
Private Attributes | |
IDatabase null | $lazyMasterHandle |
Lazy handle to the master DB this server replicates from. More... | |
array | $mNamedLocksHeld = [] |
Map of (name => 1) for locks obtained via lock() More... | |
float | $mRTTEstimate = 0.0 |
RTT time estimate. More... | |
array | $mTrxAtomicLevels = [] |
Array of levels of atomicity within transactions. More... | |
bool | $mTrxAutomatic = false |
Record if the current transaction was started implicitly due to DBO_TRX being set. More... | |
bool | $mTrxAutomaticAtomic = false |
Record if the current transaction was started implicitly by Database::startAtomic. More... | |
bool | $mTrxDoneWrites = false |
Record if possible write queries were done in the last transaction started. More... | |
string | $mTrxFname = null |
Remembers the function name given for starting the most recent transaction via begin(). More... | |
float | $mTrxReplicaLag = null |
Lag estimate at the time of BEGIN. More... | |
float null | $mTrxTimestamp = null |
The UNIX time that the transaction started. More... | |
float | $mTrxWriteAdjDuration = 0.0 |
Like mTrxWriteQueryCount but excludes lock-bound, easy to replicate, queries. More... | |
int | $mTrxWriteAdjQueryCount = 0 |
Number of write queries counted in mTrxWriteAdjDuration. More... | |
int | $mTrxWriteAffectedRows = 0 |
Number of rows affected by write queries for the current transaction. More... | |
string[] | $mTrxWriteCallers = [] |
Track the write query callers of the current transaction. More... | |
float | $mTrxWriteDuration = 0.0 |
Seconds spent in write queries for the current transaction. More... | |
int | $mTrxWriteQueryCount = 0 |
Number of write queries for the current transaction. More... | |
int[] | $priorFlags = [] |
Prior mFlags values. More... | |
Wikimedia\Rdbms\Database::__construct | ( | array | $params | ) |
Constructor and database handle and attempt to connect to the DB server.
IDatabase classes should not be constructed directly in external code. Database::factory() should be used instead.
array | $params | Parameters passed from Database::factory() |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and DatabaseOracle.
Definition at line 247 of file Database.php.
References $params, $user, DBO_DEFAULT, DBO_TRX, Wikimedia\Rdbms\DatabaseDomain\newUnspecified(), Wikimedia\Rdbms\IDatabase\open(), and Wikimedia\Rdbms\Database\requiresDatabaseUser().
Wikimedia\Rdbms\Database::__destruct | ( | ) |
Run a few simple sanity checks and close dangling connections.
Reimplemented in DatabaseOracle.
Definition at line 3672 of file Database.php.
References Wikimedia\Rdbms\Database\closeConnection(), and Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers().
Wikimedia\Rdbms\Database::__clone | ( | ) |
Make sure that copies do not share the same client binding handle.
DBConnectionError |
Definition at line 3642 of file Database.php.
References class, Wikimedia\Rdbms\Database\handleSessionLoss(), Wikimedia\Rdbms\Database\isOpen(), and Wikimedia\Rdbms\IDatabase\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 3664 of file Database.php.
Wikimedia\Rdbms\Database::__toString | ( | ) |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMysqli.
Definition at line 3634 of file Database.php.
References Wikimedia\Rdbms\Database\$mConn.
Wikimedia\Rdbms\Database::addIdentifierQuotes | ( | $s | ) |
Quotes an identifier using backticks
or "double quotes" depending on the database type.
MySQL uses backticks
while basically everything else uses double quotes. Since MySQL is the odd one out here the double quotes are our generic and we implement backticks in DatabaseMysqlBase.
string | $s |
Reimplemented in Wikimedia\Rdbms\DatabaseMssql, DatabaseOracle, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2090 of file Database.php.
References $s.
Referenced by Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema(), Wikimedia\Rdbms\DatabasePostgres\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseSqlite\duplicateTableStructure(), Wikimedia\Rdbms\Database\fieldNameWithAlias(), Wikimedia\Rdbms\Database\prependDatabaseOrSchema(), Wikimedia\Rdbms\Database\replaceVars(), Wikimedia\Rdbms\Database\selectRowCount(), Wikimedia\Rdbms\DatabasePostgres\selectSQLText(), Wikimedia\Rdbms\Database\tableName(), and Wikimedia\Rdbms\Database\tableNameWithAlias().
Wikimedia\Rdbms\Database::addQuotes | ( | $s | ) |
Adds quotes and backslashes.
string | int | null | bool | Blob | $s |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMssql, DatabaseOracle, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2064 of file Database.php.
References $s, and Wikimedia\Rdbms\Database\strencode().
Referenced by Wikimedia\Rdbms\Database\buildGroupConcatField(), Wikimedia\Rdbms\Database\buildLike(), Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\replace(), and Wikimedia\Rdbms\Database\replaceVars().
Wikimedia\Rdbms\Database::aggregateValue | ( | $valuedata, | |
$valuename = 'value' |
|||
) |
Return aggregated value alias.
array | $valuedata | |
string | $valuename |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and DatabaseOracle.
Definition at line 1735 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 2144 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 2148 of file Database.php.
|
protected |
Make sure isOpen() returns true as a sanity check.
DBUnexpectedError |
Definition at line 780 of file Database.php.
References Wikimedia\Rdbms\Database\isOpen().
Referenced by Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\rollback().
|
final |
Begin a transaction.
If a transaction is already in progress, that transaction will be committed before the new transaction is started.
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 |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2871 of file Database.php.
References $fname, Wikimedia\Rdbms\Database\assertOpen(), DBO_TRX, Wikimedia\Rdbms\Database\doBegin(), Wikimedia\Rdbms\Database\getApproximateLagStatus(), and Wikimedia\Rdbms\Database\getFlag().
Referenced by Wikimedia\Rdbms\SavepointPostgres\__construct(), Wikimedia\Rdbms\Database\deadlockLoop(), Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\startAtomic(), and Wikimedia\Rdbms\Database\upsert().
Wikimedia\Rdbms\Database::bitAnd | ( | $fieldLeft, | |
$fieldRight | |||
) |
string | $fieldLeft | |
string | $fieldRight |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle.
Definition at line 1743 of file Database.php.
Wikimedia\Rdbms\Database::bitNot | ( | $field | ) |
string | $field |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle.
Definition at line 1739 of file Database.php.
Wikimedia\Rdbms\Database::bitOr | ( | $fieldLeft, | |
$fieldRight | |||
) |
string | $fieldLeft | |
string | $fieldRight |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle.
Definition at line 1747 of file Database.php.
Wikimedia\Rdbms\Database::bufferResults | ( | $buffer = null | ) |
Turns buffering of SQL result sets on (true) or off (false).
Default is "on".
Unbuffered queries are very troublesome in MySQL:
If you want to limit client-side memory, it's almost always better to split up queries into batches using a LIMIT clause than to switch off buffering.
null | bool | $buffer |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 438 of file Database.php.
References $buffer, $res, Wikimedia\Rdbms\Database\clearFlag(), DBO_NOBUFFER, Wikimedia\Rdbms\Database\getFlag(), and Wikimedia\Rdbms\Database\setFlag().
Referenced by Wikimedia\Rdbms\DatabaseMysql\doQuery(), and Wikimedia\Rdbms\DatabaseMysqli\doQuery().
Wikimedia\Rdbms\Database::buildConcat | ( | $stringList | ) |
Build a concatenation list to feed into a SQL query.
array | $stringList | List of raw SQL expressions; caller is responsible for any quoting |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1751 of file Database.php.
Wikimedia\Rdbms\Database::buildGroupConcatField | ( | $delim, | |
$table, | |||
$field, | |||
$conds = '' , |
|||
$join_conds = [] |
|||
) |
Build a GROUP_CONCAT or equivalent statement for a query.
This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.
string | $delim | Glue to bind the results together |
string | array | $table | Table name |
string | $field | Field name |
string | array | $conds | Conditions |
string | array | $join_conds | Join conditions |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1755 of file Database.php.
References Wikimedia\Rdbms\Database\addQuotes(), and Wikimedia\Rdbms\Database\selectSQLText().
Wikimedia\Rdbms\Database::buildLike | ( | ) |
LIKE statement wrapper, receives 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 );
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2118 of file Database.php.
References $params, $s, $value, Wikimedia\Rdbms\Database\addQuotes(), as, captcha-old\count, and Wikimedia\Rdbms\Database\escapeLikeInternal().
Wikimedia\Rdbms\Database::buildStringCast | ( | $field | ) |
string | $field | Field or column to cast |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1763 of file Database.php.
|
private |
Determine whether or not 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 1091 of file Database.php.
References Wikimedia\Rdbms\Database\explicitTrxActive().
Referenced by Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\Database::clearFlag | ( | $flag, | |
$remember = self::REMEMBER_NOTHING |
|||
) |
Clear a flag for this connection.
int | $flag | DBO_* constants from Defines.php:
|
string | $remember | IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING] |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 630 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\bufferResults(), Wikimedia\Rdbms\DatabaseMysqlBase\getHeartbeatData(), Wikimedia\Rdbms\Database\ignoreErrors(), Wikimedia\Rdbms\Database\ping(), and Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().
Wikimedia\Rdbms\Database::close | ( | ) |
Closes a database connection.
if it is open : commits any open transactions
DBError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 753 of file Database.php.
References Wikimedia\Rdbms\Database\closeConnection(), Wikimedia\Rdbms\Database\commit(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by DatabaseOracle\__destruct(), Wikimedia\Rdbms\DatabaseMssql\open(), Wikimedia\Rdbms\DatabasePostgres\open(), DatabaseOracle\open(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), Wikimedia\Rdbms\DatabaseSqlite\open(), DatabaseSqliteTest\testInsertIdType(), DatabaseSqliteTest\testNumFields(), and DatabaseSqliteTest\testUpgrades().
|
abstractprotected |
Closes underlying database connection.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, DatabaseOracle, Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysql, and FakeDatabaseMysqlBase.
Referenced by Wikimedia\Rdbms\Database\__destruct(), Wikimedia\Rdbms\Database\close(), and Wikimedia\Rdbms\Database\reconnect().
|
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.
DBUnexpectedError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2932 of file Database.php.
References Wikimedia\Rdbms\Database\assertOpen(), Wikimedia\Rdbms\Database\doCommit(), Wikimedia\Rdbms\Database\pendingWriteQueryDuration(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), Wikimedia\Rdbms\Database\runOnTransactionPreCommitCallbacks(), and Wikimedia\Rdbms\Database\runTransactionListenerCallbacks().
Referenced by Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\deadlockLoop(), Wikimedia\Rdbms\DatabasePostgres\determineCoreSchema(), Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\flushSnapshot(), Wikimedia\Rdbms\Database\getScopedLockAndFlush(), and Wikimedia\Rdbms\Database\upsert().
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 your DBMS.
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 2569 of file Database.php.
References LIST_AND, and 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 732 of file Database.php.
Wikimedia\Rdbms\Database::databasesAreIndependent | ( | ) |
Returns true if DBs are assumed to be on potentially different servers.
In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as fully separate, only allowing mechanisms like postgres_fdw to effectively "mount" foreign DBs. This is true even among DBs on the same server.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1767 of file Database.php.
Wikimedia\Rdbms\Database::dbSchema | ( | $schema = null | ) |
Get/set the db schema.
string | $schema | The database schema to set, or omitted to leave it unchanged. |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 492 of file Database.php.
References Wikimedia\Rdbms\Database\$mSchema.
Wikimedia\Rdbms\Database::deadlockLoop | ( | ) |
Perform a deadlock-prone transaction.
This function invokes a callback function to perform a set of write queries. If a deadlock occurs during the processing, the transaction will be rolled back and the callback function will be called again.
Avoid using this method outside of Job or Maintenance classes.
Usage: $dbw->deadlockLoop( callback, ... );
Extra arguments are passed through to the specified callback function. This method requires that no transactions are already active to avoid causing premature commits or exceptions.
Returns whatever the callback function returned on its successful, iteration, or false on error, for example if the retry limit was reached.
DBUnexpectedError | |
Exception |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2611 of file Database.php.
References $args, $e, Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\DEADLOCK_TRIES, 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 |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and DatabaseOracle.
Definition at line 3243 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 3571 of file Database.php.
References Wikimedia\Rdbms\Database\getInfinity().
Wikimedia\Rdbms\Database::delete | ( | $table, | |
$conds, | |||
$fname = __METHOD__ |
|||
) |
DELETE query wrapper.
string | $table | Table name |
string | array | $conds | Array of conditions. See $conds in IDatabase::select() for the format. Use $conds == "*" to delete all rows |
string | $fname | Name of the calling function |
DBUnexpectedError |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle, and Wikimedia\Rdbms\DatabaseMssql.
Definition at line 2355 of file Database.php.
References $fname, LIST_AND, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
Referenced by MediaWikiTestCase\resetDB().
Wikimedia\Rdbms\Database::deleteJoin | ( | $delTable, | |
$joinTable, | |||
$delVar, | |||
$joinVar, | |||
$conds, | |||
$fname = __METHOD__ |
|||
) |
DELETE where the condition is a join.
MySQL overrides this to use a multi-table DELETE syntax, in other databases we use sub-selects
For safety, an empty $conds will not delete everything. If you want to delete all rows where the join condition matches, set $conds='*'.
DO NOT put the join condition in $conds.
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 | $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 |
DBUnexpectedError |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseMssql.
Definition at line 2320 of file Database.php.
References $fname, LIST_AND, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
Referenced by DatabaseSqliteTest\testDeleteJoin().
|
final |
Run a callback to do an atomic set of updates for this database.
The $callback takes the following arguments:
If any exception occurs in the callback, then rollback() will be called and the error will be re-thrown. It may also be that the rollback itself fails with an exception before then. In any case, such errors are expected to terminate the request, without any outside caller attempting to catch errors and commit anyway. Note that any rollback undoes all prior atomic section and uncommitted updates, which trashes the current request, requiring an error to be displayed.
This can be an alternative to explicit startAtomic()/endAtomic() calls.
string | $fname | Caller name (usually METHOD) |
callable | $callback | Callback that issues DB updates |
DBError | |
RuntimeException | |
UnexpectedValueException |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2858 of file Database.php.
References $e, $fname, $res, Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\Database\startAtomic().
|
protected |
Issues the BEGIN command to the database server.
string | $fname |
Reimplemented in Wikimedia\Rdbms\DatabaseMssql, DatabaseOracle, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2927 of file Database.php.
References Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\begin().
|
protected |
Issues the COMMIT command to the database server.
string | $fname |
Reimplemented in Wikimedia\Rdbms\DatabaseMssql, and DatabaseOracle.
Definition at line 2991 of file Database.php.
References Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\commit().
Helper function for lockTables() that handles the actual table locking.
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\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3521 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\lockTables().
Wikimedia\Rdbms\Database::doneWrites | ( | ) |
Returns true if the connection may have been used for write queries.
Should return true if unsure.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 546 of file Database.php.
References Wikimedia\Rdbms\Database\$mLastWriteTime.
|
private |
Helper method for query() that handles profiling and logging and sends the query to doQuery()
string | $sql | Original SQL query |
string | $commentedSql | SQL query with debugging/trace comment |
bool | $isWrite | Whether the query is a (non-temporary) write operation |
string | $fname | Name of the calling function |
Definition at line 998 of file Database.php.
References $fname, $ret, Wikimedia\Rdbms\IDatabase\affectedRows(), Wikimedia\Rdbms\Database\doQuery(), Wikimedia\Rdbms\Database\getLBInfo(), and Wikimedia\Rdbms\Database\updateTrxWriteQueryTime().
Referenced by Wikimedia\Rdbms\Database\query().
|
abstractprotected |
The DBMS-dependent part of query()
string | $sql | SQL query. |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, FakeDatabaseMysqlBase, Wikimedia\Rdbms\DatabaseMysqli, and Wikimedia\Rdbms\DatabaseMysql.
Referenced by Wikimedia\Rdbms\Database\doProfiledQuery(), Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait(), and Wikimedia\Rdbms\DatabaseMysqlBase\open().
|
protected |
Issues the ROLLBACK command to the database server.
string | $fname |
Reimplemented in Wikimedia\Rdbms\DatabaseMssql, and DatabaseOracle.
Definition at line 3041 of file Database.php.
References Wikimedia\Rdbms\Database\query().
Referenced by Wikimedia\Rdbms\Database\rollback().
|
protected |
Helper function for unlockTables() that handles the actual table unlocking.
string | $method | Name of caller |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3541 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\unlockTables().
Wikimedia\Rdbms\Database::dropTable | ( | $tableName, | |
$fName = __METHOD__ |
|||
) |
Delete a table.
string | $tableName | |
string | $fName |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and DatabaseOracle.
Definition at line 3552 of file Database.php.
References Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\tableExists(), and Wikimedia\Rdbms\Database\tableName().
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\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and DatabaseOracle.
Definition at line 3067 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 |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and DatabaseOracle.
Definition at line 3239 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 3565 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 |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2843 of file Database.php.
References $fname, and Wikimedia\Rdbms\Database\commit().
Referenced by Wikimedia\Rdbms\Database\doAtomicSection(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), and Wikimedia\Rdbms\Database\unlockTables().
|
protected |
string | $s | |
string | $escapeChar |
Reimplemented in Wikimedia\Rdbms\DatabaseMssql.
Definition at line 2112 of file Database.php.
References $s.
Referenced by Wikimedia\Rdbms\Database\buildLike(), and Wikimedia\Rdbms\DatabaseMysqlBase\tableExists().
Wikimedia\Rdbms\Database::estimateRowCount | ( | $table, | |
$vars = ' *' , |
|||
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] |
|||
) |
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 | $table | Table name |
string | $vars | Unused |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1426 of file Database.php.
References $fname, $options, $res, $rows, Wikimedia\Rdbms\IDatabase\fetchRow(), and Wikimedia\Rdbms\Database\select().
Wikimedia\Rdbms\Database::explicitTrxActive | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3063 of file Database.php.
References Wikimedia\Rdbms\Database\$mTrxAutomatic.
Referenced by Wikimedia\Rdbms\Database\canRecoverFromDisconnect(), Wikimedia\Rdbms\Database\flushSnapshot(), and Wikimedia\Rdbms\Database\query().
|
staticfinal |
Construct a Database subclass instance given a database type and parameters.
This also connects to the database immediately upon object construction
string | $dbType | A possible DB type (sqlite, mysql, postgres) |
array | $p | Parameter map with keys:
|
InvalidArgumentException | If the database driver or extension cannot be found |
Definition at line 338 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\newStandaloneInstance(), and Wikimedia\Rdbms\LoadBalancer\reallyOpenConnection().
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) |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMssql.
Definition at line 1488 of file Database.php.
References Wikimedia\Rdbms\IDatabase\fieldInfo().
|
protected |
Gets an array of aliased field names.
array | $fields | [ [alias] => field ] |
Definition at line 1963 of file Database.php.
References $retval, as, and Wikimedia\Rdbms\Database\fieldNameWithAlias().
Referenced by Wikimedia\Rdbms\Database\selectSQLText().
|
protected |
Get an aliased field name e.g.
fieldName AS newFieldName
string | $name | Field name |
string | bool | $alias | Alias (optional) |
Definition at line 1949 of file Database.php.
References $name, and Wikimedia\Rdbms\Database\addIdentifierQuotes().
Referenced by Wikimedia\Rdbms\Database\fieldNamesWithAlias(), and Wikimedia\Rdbms\Database\insertSelect().
Wikimedia\Rdbms\Database::flushSnapshot | ( | $fname = __METHOD__ | ) |
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 |
DBUnexpectedError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3050 of file Database.php.
References Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\explicitTrxActive(), Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().
Referenced by Wikimedia\Rdbms\LoadBalancer\beginMasterChanges().
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\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, DatabaseOracle, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseMssql.
Definition at line 1153 of file Database.php.
|
staticprotected |
Removes most variables from an SQL query and replaces them with X or N for numbers.
It's only slightly flawed. Don't use for anything important.
string | $sql | A SQL Query |
Definition at line 1466 of file Database.php.
|
protected |
Get a replica DB lag estimate for this server.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3189 of file Database.php.
References Wikimedia\Rdbms\Database\getLag(), and Wikimedia\Rdbms\Database\getLBInfo().
Referenced by Wikimedia\Rdbms\Database\begin(), and Wikimedia\Rdbms\Database\getSessionLagStatus().
|
protected |
Get the underlying binding handle, mConn.
Makes sure that mConn is set (disconnects and ping() failure can unset it). This catches broken callers than catch and ignore disconnection exceptions. Unlike checking isOpen(), this is safe to call inside of open().
DBUnexpectedError |
Definition at line 3619 of file Database.php.
References Wikimedia\Rdbms\Database\$mConn.
Referenced by Wikimedia\Rdbms\DatabasePostgres\addQuotes(), Wikimedia\Rdbms\DatabaseMysql\affectedRows(), Wikimedia\Rdbms\DatabaseMysqli\affectedRows(), Wikimedia\Rdbms\DatabaseMysql\closeConnection(), Wikimedia\Rdbms\DatabaseMysqli\closeConnection(), Wikimedia\Rdbms\DatabaseMysql\doQuery(), Wikimedia\Rdbms\DatabaseMysqli\doQuery(), Wikimedia\Rdbms\DatabasePostgres\doQuery(), Wikimedia\Rdbms\DatabasePostgres\fetchObject(), Wikimedia\Rdbms\DatabasePostgres\fetchRow(), Wikimedia\Rdbms\DatabasePostgres\getServerVersion(), Wikimedia\Rdbms\DatabasePostgres\hasConstraint(), Wikimedia\Rdbms\DatabaseMysql\insertId(), Wikimedia\Rdbms\DatabaseMysqli\insertId(), Wikimedia\Rdbms\DatabaseMysql\mysqlRealEscapeString(), Wikimedia\Rdbms\DatabaseMysqli\mysqlRealEscapeString(), Wikimedia\Rdbms\DatabaseMysql\mysqlSetCharset(), Wikimedia\Rdbms\DatabaseMysqli\mysqlSetCharset(), Wikimedia\Rdbms\DatabasePostgres\numRows(), Wikimedia\Rdbms\DatabaseMysql\selectDB(), Wikimedia\Rdbms\DatabaseMysqli\selectDB(), 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
Definition at line 3214 of file Database.php.
References $res, as, and false.
Referenced by MediaWiki\Interwiki\ClassicInterwikiLookup\load().
Wikimedia\Rdbms\Database::getDBname | ( | ) |
Get the current DB name.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1780 of file Database.php.
References Wikimedia\Rdbms\Database\$mDBname.
|
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.
Definition at line 3438 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getSchemaVars().
Wikimedia\Rdbms\Database::getDomainID | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 663 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getWikiID().
Wikimedia\Rdbms\Database::getFlag | ( | $flag | ) |
Returns a boolean whether the flag $flag is set for this connection.
int | $flag | DBO_* constants from Defines.php:
|
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 650 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\bufferResults(), DatabaseOracle\doQuery(), Wikimedia\Rdbms\Database\ignoreErrors(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), and Wikimedia\Rdbms\Database\startAtomic().
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.
Reimplemented in DatabaseOracle.
Definition at line 3561 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\decodeExpiry(), and Wikimedia\Rdbms\Database\encodeExpiry().
Wikimedia\Rdbms\Database::getLag | ( | ) |
Get replica DB lag.
Currently supported only by MySQL.
Note that this function will generate a fatal error on many installations. Most callers should use LoadBalancer::safeGetLag() instead.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3231 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getApproximateLagStatus().
|
protected |
Definition at line 714 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\lastError(), and Wikimedia\Rdbms\Database\restoreErrorHandler().
|
protected |
Definition at line 530 of file Database.php.
References Wikimedia\Rdbms\Database\$lazyMasterHandle.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo().
Wikimedia\Rdbms\Database::getLBInfo | ( | $name = null | ) |
Get properties passed down from the server info array of the load balancer.
string | $name | The entry of the info array to get, or null to get the whole array |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 501 of file Database.php.
References Wikimedia\Rdbms\Database\$mLBInfo, and $name.
Referenced by Wikimedia\Rdbms\Database\doProfiledQuery(), Wikimedia\Rdbms\Database\getApproximateLagStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo(), Wikimedia\Rdbms\Database\getReadOnlyReason(), and Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait().
|
protected |
Create a log context to pass to PSR-3 logger functions.
array | $extras | Additional data to add to context |
Definition at line 742 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromPtHeartbeat(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\Database\reportQueryError().
Wikimedia\Rdbms\Database::getMasterPos | ( | ) |
Get the position of this master.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2657 of file Database.php.
Wikimedia\Rdbms\Database::getProperty | ( | $name | ) |
string | $name | Class field name |
Definition at line 659 of file Database.php.
|
protected |
string | $sql |
Definition at line 828 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\isTransactableQuery(), and Wikimedia\Rdbms\Database\updateTrxWriteQueryTime().
|
protected |
Definition at line 3590 of file Database.php.
References Wikimedia\Rdbms\Database\getLBInfo().
Referenced by Wikimedia\Rdbms\Database\isReadOnly(), and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\Database::getReplicaPos | ( | ) |
Get the replication position of this replica DB.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2652 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 3422 of file Database.php.
References Wikimedia\Rdbms\Database\$mSchemaVars, and 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 |
DBUnexpectedError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3458 of file Database.php.
References $fname, Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\lock(), Wikimedia\Rdbms\Database\onTransactionResolution(), Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers(), Wikimedia\Rdbms\Database\trxLevel(), Wikimedia\Rdbms\Database\unlock(), use, and Wikimedia\Rdbms\Database\writesOrCallbacksPending().
Wikimedia\Rdbms\Database::getServer | ( | ) |
Get the server hostname or IP address.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1784 of file Database.php.
References Wikimedia\Rdbms\Database\$mServer.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getApproximateLagStatus(), and Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo().
Wikimedia\Rdbms\Database::getServerInfo | ( | ) |
A string describing the current software version, and possibly other details in a user-friendly way.
Will be listed on Special:Version, etc. Use getServerVersion() to get machine-friendly information.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 434 of file Database.php.
References Wikimedia\Rdbms\IDatabase\getServerVersion().
Wikimedia\Rdbms\Database::getServerUptime | ( | ) |
Determines how long the server has been up.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2581 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 AUTO-COMMIT mode, this still gives an indication of the staleness of subsequent reads.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3162 of file Database.php.
References Wikimedia\Rdbms\Database\getApproximateLagStatus(), and Wikimedia\Rdbms\Database\getTransactionLagStatus().
|
protected |
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.
Definition at line 3177 of file Database.php.
References Wikimedia\Rdbms\Database\$mTrxReplicaLag, and Wikimedia\Rdbms\Database\trxTimestamp().
Referenced by Wikimedia\Rdbms\Database\getSessionLagStatus().
|
final |
Alias for getDomainID()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 667 of file Database.php.
References Wikimedia\Rdbms\Database\getDomainID().
|
private |
Clean things up after transaction loss due to disconnection.
Definition at line 1116 of file Database.php.
References $e, Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), and Wikimedia\Rdbms\Database\runTransactionListenerCallbacks().
Referenced by Wikimedia\Rdbms\Database\__clone(), and Wikimedia\Rdbms\Database\query().
|
protected |
Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors.
Default is on (false). When turned off, the code should use lastErrno() and lastError() to handle the situation as appropriate.
Do not use this function outside of the Database classes.
null | bool | $ignoreErrors |
Definition at line 461 of file Database.php.
References $res, Wikimedia\Rdbms\Database\clearFlag(), DBO_IGNORE, Wikimedia\Rdbms\Database\getFlag(), and Wikimedia\Rdbms\Database\setFlag().
Referenced by Wikimedia\Rdbms\Database\reportQueryError().
Wikimedia\Rdbms\Database::ignoreIndexClause | ( | $index | ) |
IGNORE INDEX clause.
Unlikely to be useful for anything but MySQL. This is only needed because a) MySQL must be as efficient as possible due to its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about which index to pick. Anyway, other databases might have different indexes on a given table. So don't bother overriding this unless you're MySQL.
string | $index |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2180 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\makeSelectOptions(), and Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN().
Wikimedia\Rdbms\Database::implicitGroupby | ( | ) |
Returns true if this database does an implicit sort when doing GROUP BY.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, DatabaseOracle, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMssql.
Definition at line 534 of file Database.php.
Wikimedia\Rdbms\Database::implicitOrderby | ( | ) |
Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMssql.
Definition at line 538 of file Database.php.
Wikimedia\Rdbms\Database::indexExists | ( | $table, | |
$index, | |||
$fname = __METHOD__ |
|||
) |
Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure.
string | $table | |
string | $index | |
string | $fname |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle.
Definition at line 1494 of file Database.php.
References $fname, Wikimedia\Rdbms\Database\indexInfo(), and Wikimedia\Rdbms\Database\tableExists().
|
abstract |
Get information about an index into an object.
string | $table | Table name |
string | $index | Index name |
string | $fname | Calling function name |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and DatabaseOracle.
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 |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2060 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\indexInfo(), Wikimedia\Rdbms\DatabasePostgres\indexUnique(), Wikimedia\Rdbms\DatabaseSqlite\indexUnique(), and Wikimedia\Rdbms\Database\replaceVars().
Wikimedia\Rdbms\Database::indexUnique | ( | $table, | |
$index | |||
) |
Determines if a given index is unique.
string | $table | |
string | $index |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1520 of file Database.php.
References Wikimedia\Rdbms\Database\indexInfo().
Wikimedia\Rdbms\Database::insert | ( | $table, | |
$a, | |||
$fname = __METHOD__ , |
|||
$options = [] |
|||
) |
INSERT wrapper, inserts an array into a table.
$a may be either:
Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns success.
$options is an array of options, with boolean options encoded as values with numeric keys, in the same style as $options in IDatabase::select(). Supported options are:
string | $table | Table name. This will be passed through Database::tableName(). |
array | $a | Array of rows to insert |
string | $fname | Calling function name (use METHOD) for logs/profiling |
array | $options | Array of options |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and DatabaseOracle.
Definition at line 1540 of file Database.php.
References $fname, $keys, $options, as, captcha-old\count, Wikimedia\Rdbms\Database\makeInsertOptions(), Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\insertSelect(), Wikimedia\Rdbms\Database\replace(), and Wikimedia\Rdbms\Database\upsert().
Wikimedia\Rdbms\Database::insertSelect | ( | $destTable, | |
$srcTable, | |||
$varMap, | |||
$conds, | |||
$fname = __METHOD__ , |
|||
$insertOptions = [] , |
|||
$selectOptions = [] , |
|||
$selectJoinConds = [] |
|||
) |
INSERT SELECT wrapper.
Takes data from a SELECT query and inserts it into another table.
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. |
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. |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2373 of file Database.php.
References $fname, $res, $rows, array(), as, Wikimedia\Rdbms\Database\fieldNameWithAlias(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\nativeInsertSelect(), and Wikimedia\Rdbms\Database\select().
|
protected |
Set a custom error handler for logging errors during database connection.
Definition at line 691 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\open(), and Wikimedia\Rdbms\DatabaseMysqlBase\open().
Wikimedia\Rdbms\Database::isOpen | ( | ) |
Is a connection to the database open?
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 619 of file Database.php.
References Wikimedia\Rdbms\Database\$mOpened.
Referenced by Wikimedia\Rdbms\Database\__clone(), Wikimedia\Rdbms\DatabaseSqlite\__construct(), Wikimedia\Rdbms\Database\assertOpen(), and Wikimedia\Rdbms\Database\ping().
Wikimedia\Rdbms\Database::isQuotedIdentifier | ( | $name | ) |
Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers .
string | $name |
Reimplemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2103 of file Database.php.
References $name.
Referenced by Wikimedia\Rdbms\Database\prependDatabaseOrSchema(), and Wikimedia\Rdbms\Database\tableName().
Wikimedia\Rdbms\Database::isReadOnly | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3583 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.
string | $sql |
Definition at line 841 of file Database.php.
References Wikimedia\Rdbms\Database\getQueryVerb().
Referenced by Wikimedia\Rdbms\Database\query().
|
protected |
Determine whether a query writes to the DB.
Should return true if unsure.
string | $sql |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 819 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\Database::lastDoneWrites | ( | ) |
Returns the last time the connection may have been used for write queries.
Should return a timestamp if unsure.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 550 of file Database.php.
Wikimedia\Rdbms\Database::lastQuery | ( | ) |
Return the last query that went through IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 542 of file Database.php.
References Wikimedia\Rdbms\Database\$mLastQuery.
Referenced by DatabaseSqliteMock\query().
Wikimedia\Rdbms\Database::limitResult | ( | $sql, | |
$limit, | |||
$offset = false |
|||
) |
Construct a LIMIT query with optional offset.
This is used for query pages. 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.
The version provided by default works in MySQL and SQLite. It will very likely need to be overridden for most other DBMSes.
string | $sql | SQL query we will append the limit too |
int | $limit | The SQL limit |
int | bool | $offset | The SQL offset (default false) |
DBUnexpectedError |
Reimplemented in Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, and DatabaseOracle.
Definition at line 2477 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 | $prefix | Only show tables with this prefix, e.g. mw_ |
string | $fname | Calling function name |
DBError |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabasePostgres, and DatabaseOracle.
Definition at line 3073 of file Database.php.
Referenced by MediaWikiTestCase\listTables().
Wikimedia\Rdbms\Database::listViews | ( | $prefix = null , |
|
$fname = __METHOD__ |
|||
) |
Lists all the VIEWs in the database.
string | $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 3077 of file Database.php.
Referenced by MediaWikiTestCase\listTables().
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 |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3446 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getScopedLockAndFlush().
Wikimedia\Rdbms\Database::lockIsFree | ( | $lockName, | |
$method | |||
) |
Check to see if a named lock is available (non-blocking)
string | $lockName | Name of lock to poll |
string | $method | Name of method calling us |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3442 of file Database.php.
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 3501 of file Database.php.
References Wikimedia\Rdbms\Database\doLockTables(), Wikimedia\Rdbms\Database\startAtomic(), Wikimedia\Rdbms\Database\tableLocksHaveTransactionScope(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().
|
protected |
Returns an optional GROUP BY with an optional HAVING.
array | $options | Associative array of options |
Definition at line 1301 of file Database.php.
References $options, LIST_AND, and Wikimedia\Rdbms\Database\makeList().
Referenced by Wikimedia\Rdbms\DatabaseMssql\makeSelectOptions(), Wikimedia\Rdbms\Database\makeSelectOptions(), and Wikimedia\Rdbms\DatabasePostgres\makeSelectOptions().
|
protected |
Helper for Database::insert().
array | $options |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1536 of file Database.php.
References $options.
Referenced by Wikimedia\Rdbms\Database\insert(), and Wikimedia\Rdbms\Database\nativeInsertSelect().
Wikimedia\Rdbms\Database::makeList | ( | $a, | |
$mode = self::LIST_COMMA |
|||
) |
Makes an encoded list of strings from an array.
These can be used to make conjunctions or disjunctions on SQL condition strings derived from an array (see IDatabase::select() $conds documentation).
Example usage:
This would set $sql to "rev_user = '$id' AND (rev_minor = '1' OR rev_len < '500')"
array | $a | Containing the data |
int | $mode | IDatabase class constant:
|
DBError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1636 of file Database.php.
References $value, Wikimedia\Rdbms\Database\addQuotes(), as, captcha-old\count, LIST_AND, LIST_NAMES, LIST_OR, and LIST_SET.
Referenced by Wikimedia\Rdbms\Database\conditional(), Wikimedia\Rdbms\Database\delete(), Wikimedia\Rdbms\DatabaseMysqlBase\deleteJoin(), Wikimedia\Rdbms\Database\deleteJoin(), Wikimedia\Rdbms\DatabaseMysqlBase\getHeartbeatData(), Wikimedia\Rdbms\DatabasePostgres\insert(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\makeGroupByWithHaving(), Wikimedia\Rdbms\Database\makeWhereFrom2d(), Wikimedia\Rdbms\Database\nativeReplace(), Wikimedia\Rdbms\Database\selectSQLText(), Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN(), Wikimedia\Rdbms\Database\update(), Wikimedia\Rdbms\DatabaseMysqlBase\upsert(), and Wikimedia\Rdbms\Database\upsert().
|
protected |
Returns an optional ORDER BY.
array | $options | Associative array of options |
Definition at line 1327 of file Database.php.
References $options.
Referenced by Wikimedia\Rdbms\DatabaseMssql\makeSelectOptions(), 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.
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, DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1218 of file Database.php.
References $options, as, 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.
array | $options | The options passed to Database::update |
Definition at line 1618 of file Database.php.
References $options, and Wikimedia\Rdbms\Database\makeUpdateOptionsArray().
Referenced by Wikimedia\Rdbms\DatabaseMssql\update(), and Wikimedia\Rdbms\Database\update().
|
protected |
Make UPDATE options array for Database::makeUpdateOptions.
array | $options |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1598 of file Database.php.
References $options.
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.
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 1716 of file Database.php.
References $base, as, captcha-old\count, LIST_AND, LIST_OR, 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.
DBMasterPos | $pos | |
int | $timeout | The maximum number of seconds to wait for synchronisation |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2647 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 3235 of file Database.php.
Wikimedia\Rdbms\Database::namedLocksEnqueue | ( | ) |
Check to see if a named lock used by lock() use blocking queues.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3493 of file Database.php.
|
protected |
Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory.
string | $destTable | |
string | array | $srcTable | |
array | $varMap | |
array | $conds | |
string | $fname | |
array | $insertOptions | |
array | $selectOptions | |
array | $selectJoinConds |
Reimplemented in Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, and DatabaseOracle.
Definition at line 2430 of file Database.php.
References $fname, Wikimedia\Rdbms\Database\makeInsertOptions(), Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\Database\selectSQLText(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\insertSelect().
|
protected |
REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement.
string | $table | Table name |
array | string | $rows | Row(s) to insert |
string | $fname | Caller function name |
Definition at line 2242 of file Database.php.
References $fname, $rows, as, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\replace(), and Wikimedia\Rdbms\DatabaseSqlite\replace().
Wikimedia\Rdbms\Database::nextSequenceValue | ( | $seqName | ) |
Deprecated method, calls should be removed.
This was formerly used for PostgreSQL and Oracle to handle self::insertId() auto-incrementing fields. It is no longer necessary since DatabasePostgres::insertId() has been reimplemented using lastval()
and Oracle has been reimplemented using triggers.
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 2152 of file Database.php.
|
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. Queries in the function will run in AUTO-COMMIT 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 cause deadlocks if locks are held too long.
Updates will execute in the order they were enqueued.
The callback takes one argument:
callable | $callback | |
string | $fname | Caller name |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2673 of file Database.php.
References $fname, and Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().
|
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. 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 cause deadlocks if locks are held too long but where atomicity is strongly desired for these updates and some related updates.
Updates will execute in the order they were enqueued.
callable | $callback | |
string | $fname | Caller name |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2680 of file Database.php.
References $e, $fname, DBO_TRX, Wikimedia\Rdbms\Database\endAtomic(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\Database\startAtomic().
|
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 AUTO-COMMIT mode unless there are begin() calls. Callbacks must commit any transactions that they begin.
This is useful for combining cooperative locks and DB transactions.
The callback takes one argument:
callable | $callback | |
string | $fname | Caller name |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2666 of file Database.php.
References $fname.
Referenced by Wikimedia\Rdbms\Database\getScopedLockAndFlush().
|
protected |
Get the list of method names that have pending write queries or callbacks for this transaction.
Definition at line 600 of file Database.php.
References Wikimedia\Rdbms\Database\$mTrxWriteCallers, and as.
Referenced by Wikimedia\Rdbms\Database\__destruct(), 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 586 of file Database.php.
Wikimedia\Rdbms\Database::pendingWriteQueryDuration | ( | $type = self::ESTIMATE_TOTAL | ) |
Get the time spend running write queries for this transaction.
High times could be due to scanning, updates, locking, and such
string | $type | IDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL] |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 564 of file Database.php.
References Wikimedia\Rdbms\Database\$mTrxWriteAdjQueryCount, Wikimedia\Rdbms\Database\$mTrxWriteDuration, $type, and Wikimedia\Rdbms\Database\ping().
Referenced by Wikimedia\Rdbms\Database\commit().
Wikimedia\Rdbms\Database::pendingWriteRowsAffected | ( | ) |
Get the number of affected rows from pending write queries.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 590 of file Database.php.
References Wikimedia\Rdbms\Database\$mTrxWriteAffectedRows.
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 3121 of file Database.php.
References Wikimedia\Rdbms\Database\$mRTTEstimate, Wikimedia\Rdbms\Database\clearFlag(), DBO_TRX, false, Wikimedia\Rdbms\Database\isOpen(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\restoreFlags().
Referenced by Wikimedia\Rdbms\Database\pendingWriteQueryDuration().
|
private |
string | null | $namespace | Database or schema |
string | $relation | Name of table, view, sequence, etc... |
string | $format | One of (raw, quoted) |
Definition at line 1874 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 1834 of file Database.php.
References Wikimedia\Rdbms\Database\$mSchema, Wikimedia\Rdbms\Database\$mTablePrefix, $name, captcha-old\count, and list.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\tableExists(), and Wikimedia\Rdbms\Database\tableName().
Wikimedia\Rdbms\Database::query | ( | $sql, | |
$fname = __METHOD__ , |
|||
$tempIgnore = false |
|||
) |
Run an SQL query and return the result.
Normally throws a DBQueryError on failure. If errors are ignored, returns false instead.
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) |
bool | $tempIgnore | Whether to avoid throwing an exception on errors... maybe best to catch the exception instead? |
DBError |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseSqliteMock.
Definition at line 888 of file Database.php.
References $fname, $res, $ret, Wikimedia\Rdbms\Database\assertOpen(), Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\canRecoverFromDisconnect(), DBO_DEBUG, DBO_TRX, Wikimedia\Rdbms\Database\doProfiledQuery(), Wikimedia\Rdbms\Database\explicitTrxActive(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\getReadOnlyReason(), Wikimedia\Rdbms\Database\handleSessionLoss(), Wikimedia\Rdbms\Database\isTransactableQuery(), Wikimedia\Rdbms\Database\isWriteQuery(), Wikimedia\Rdbms\IDatabase\lastErrno(), Wikimedia\Rdbms\IDatabase\lastError(), Wikimedia\Rdbms\Database\reconnect(), Wikimedia\Rdbms\Database\registerTempTableOperation(), Wikimedia\Rdbms\Database\reportQueryError(), Wikimedia\Rdbms\Database\resultObject(), Wikimedia\Rdbms\Database\wasDeadlock(), Wikimedia\Rdbms\Database\wasErrorReissuable(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\attachDatabase(), Wikimedia\Rdbms\DatabaseSqlite\checkForEnabledSearch(), Wikimedia\Rdbms\DatabasePostgres\constraintExists(), Wikimedia\Rdbms\DatabasePostgres\currentSequenceValue(), Wikimedia\Rdbms\Database\delete(), Wikimedia\Rdbms\DatabaseMysqlBase\deleteJoin(), Wikimedia\Rdbms\Database\deleteJoin(), Wikimedia\Rdbms\DatabaseSqlite\doBegin(), Wikimedia\Rdbms\Database\doBegin(), Wikimedia\Rdbms\Database\doCommit(), Wikimedia\Rdbms\DatabaseMysqlBase\doLockTables(), Wikimedia\Rdbms\DatabasePostgres\doLockTables(), Wikimedia\Rdbms\Database\doRollback(), Wikimedia\Rdbms\DatabaseMysqlBase\doUnlockTables(), Wikimedia\Rdbms\DatabaseSqlite\dropTable(), Wikimedia\Rdbms\DatabaseMysqlBase\dropTable(), Wikimedia\Rdbms\DatabaseMssql\dropTable(), Wikimedia\Rdbms\Database\dropTable(), Wikimedia\Rdbms\DatabasePostgres\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseSqlite\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseMysqlBase\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseMssql\fieldExists(), Wikimedia\Rdbms\DatabaseMysqlBase\fieldInfo(), Wikimedia\Rdbms\DatabaseSqlite\fieldInfo(), Wikimedia\Rdbms\DatabaseMssql\fieldInfo(), Wikimedia\Rdbms\PostgresField\fromText(), Wikimedia\Rdbms\DatabasePostgres\getCurrentSchema(), Wikimedia\Rdbms\DatabaseMysqlBase\getHeartbeatData(), Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromSlaveStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getMasterPos(), Wikimedia\Rdbms\DatabaseMysqlBase\getMysqlStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getReplicaPos(), Wikimedia\Rdbms\DatabasePostgres\getSchemas(), Wikimedia\Rdbms\DatabasePostgres\getSearchPath(), Wikimedia\Rdbms\DatabasePostgres\indexAttributes(), Wikimedia\Rdbms\DatabasePostgres\indexInfo(), Wikimedia\Rdbms\DatabaseSqlite\indexInfo(), Wikimedia\Rdbms\DatabaseMssql\indexInfo(), Wikimedia\Rdbms\DatabaseMysqlBase\indexInfo(), Wikimedia\Rdbms\DatabasePostgres\indexUnique(), Wikimedia\Rdbms\DatabaseMssql\insert(), Wikimedia\Rdbms\DatabasePostgres\insert(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\DatabasePostgres\insertId(), Wikimedia\Rdbms\DatabasePostgres\listTables(), Wikimedia\Rdbms\DatabaseMysqlBase\listTables(), Wikimedia\Rdbms\DatabaseMysqlBase\listViews(), Wikimedia\Rdbms\DatabaseMysqlBase\lock(), Wikimedia\Rdbms\DatabasePostgres\lock(), Wikimedia\Rdbms\DatabaseMysqlBase\lockIsFree(), Wikimedia\Rdbms\DatabasePostgres\lockIsFree(), Wikimedia\Rdbms\DatabaseMysql\mysqlSetCharset(), Wikimedia\Rdbms\DatabaseMysqli\mysqlSetCharset(), Wikimedia\Rdbms\Database\nativeInsertSelect(), Wikimedia\Rdbms\Database\nativeReplace(), Wikimedia\Rdbms\DatabasePostgres\open(), Wikimedia\Rdbms\DatabaseSqlite\openFile(), Wikimedia\Rdbms\Database\ping(), Wikimedia\Rdbms\DatabasePostgres\relationExists(), Wikimedia\Rdbms\Database\replace(), MediaWikiTestCase\resetDB(), Wikimedia\Rdbms\DatabaseMssql\select(), Wikimedia\Rdbms\Database\select(), Wikimedia\Rdbms\DatabaseMssql\selectDB(), Wikimedia\Rdbms\Database\selectRowCount(), Wikimedia\Rdbms\DatabaseMysqlBase\serverIsReadOnly(), Wikimedia\Rdbms\DatabasePostgres\serverIsReadOnly(), Wikimedia\Rdbms\DatabaseMysqlBase\setBigSelects(), Wikimedia\Rdbms\DatabasePostgres\setSearchPath(), Wikimedia\Rdbms\DatabaseMysqlBase\setSessionOptions(), MediaWikiTestCase\setupTestDB(), Wikimedia\Rdbms\Database\sourceStream(), Wikimedia\Rdbms\DatabaseMysqlBase\tableExists(), Wikimedia\Rdbms\DatabaseMssql\tableExists(), Wikimedia\Rdbms\Database\tableExists(), Wikimedia\Rdbms\DatabasePostgres\textFieldSize(), Wikimedia\Rdbms\DatabaseMssql\textFieldSize(), Wikimedia\Rdbms\Database\textFieldSize(), Wikimedia\Rdbms\DatabasePostgres\triggerExists(), Wikimedia\Rdbms\DatabaseMysqlBase\unlock(), Wikimedia\Rdbms\DatabasePostgres\unlock(), Wikimedia\Rdbms\DatabaseMssql\update(), Wikimedia\Rdbms\Database\update(), and Wikimedia\Rdbms\DatabaseMysqlBase\upsert().
|
protected |
Close existing database connection and open a new connection.
Definition at line 3147 of file Database.php.
References $e, Wikimedia\Rdbms\Database\closeConnection(), and Wikimedia\Rdbms\IDatabase\open().
Referenced by Wikimedia\Rdbms\Database\query().
|
protected |
string | $sql | A SQL query |
Definition at line 853 of file Database.php.
References $matches.
Referenced by Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\Database::replace | ( | $table, | |
$uniqueIndexes, | |||
$rows, | |||
$fname = __METHOD__ |
|||
) |
REPLACE query wrapper.
REPLACE is a very handy MySQL extension, which functions like an INSERT except that when there is a duplicate key error, the old row is deleted and the new row is inserted in its place.
We simulate this with standard SQL with a DELETE followed by INSERT. To perform the delete, we need to know what the unique indexes are so that we know how to find the conflicting rows.
It may be more efficient to leave off unique indexes which are unlikely to collide. However if you do this, you run the risk of encountering errors which wouldn't have occurred in MySQL.
string | $table | The table to replace the row(s) in. |
array | $uniqueIndexes | Is an array of indexes. Each element may be either a field name or an array of field names |
array | $rows | Can be either a single row to insert, or multiple rows, in the same format as for IDatabase::insert() |
string | $fname | Calling function name (use METHOD) for logs/profiling |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2184 of file Database.php.
References $fname, $rows, Wikimedia\Rdbms\Database\addQuotes(), as, captcha-old\count, Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
|
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.string | $ins | SQL statement to replace variables in |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, DatabaseSqliteMock, and Wikimedia\Rdbms\DatabasePostgres.
Definition at line 3384 of file Database.php.
References $vars, Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\Database\addQuotes(), Wikimedia\Rdbms\Database\getSchemaVars(), Wikimedia\Rdbms\Database\indexName(), Wikimedia\Rdbms\Database\tableName(), and use.
Referenced by Wikimedia\Rdbms\Database\sourceStream().
Wikimedia\Rdbms\Database::reportConnectionError | ( | $error = 'Unknown error' | ) |
string | $error | Fallback error message, used if none is given by DB |
DBConnectionError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 793 of file Database.php.
References Wikimedia\Rdbms\IDatabase\lastError().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\open().
Wikimedia\Rdbms\Database::reportQueryError | ( | $error, | |
$errno, | |||
$sql, | |||
$fname, | |||
$tempIgnore = false |
|||
) |
Report a query error.
Log the error, and if neither the object ignore flag nor the $tempIgnore flag is set, throw a DBQueryError.
string | $error | |
int | $errno | |
string | $sql | |
string | $fname | |
bool | $tempIgnore |
DBQueryError |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres.
Definition at line 1133 of file Database.php.
References $fname, Wikimedia\Rdbms\Database\getLogContext(), and Wikimedia\Rdbms\Database\ignoreErrors().
Referenced by Wikimedia\Rdbms\Database\query().
|
protected |
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3604 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\__construct().
|
protected |
Restore the previous error handler and return the last PHP error for this DB.
Definition at line 702 of file Database.php.
References Wikimedia\Rdbms\Database\getLastPHPError().
Referenced by Wikimedia\Rdbms\DatabasePostgres\open(), and Wikimedia\Rdbms\DatabaseMysqlBase\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 637 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getHeartbeatData(), and Wikimedia\Rdbms\Database\ping().
|
protected |
Take the result from a query, and wrap it in a ResultWrapper if necessary.
Boolean values are passed through as is, to indicate success of write queries or failure.
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 | ResultWrapper | resource | object | $result |
Reimplemented in Wikimedia\Rdbms\DatabaseMssql.
Definition at line 3108 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\query().
|
final |
Rollback 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. 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).
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. |
DBUnexpectedError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2998 of file Database.php.
References Wikimedia\Rdbms\Database\assertOpen(), DBO_TRX, Wikimedia\Rdbms\Database\doRollback(), Wikimedia\Rdbms\Database\getFlag(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), and Wikimedia\Rdbms\Database\runTransactionListenerCallbacks().
Referenced by Wikimedia\Rdbms\Database\deadlockLoop(), Wikimedia\Rdbms\Database\doAtomicSection(), Wikimedia\Rdbms\Database\onTransactionPreCommitOrIdle(), Wikimedia\Rdbms\DatabasePostgres\reportQueryError(), Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks(), and Wikimedia\Rdbms\Database\upsert().
Wikimedia\Rdbms\Database::runOnTransactionIdleCallbacks | ( | $trigger | ) |
Actually run and consume 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 2728 of file Database.php.
References $e, as, Wikimedia\Rdbms\Database\clearFlag(), captcha-old\count, DBO_TRX, Wikimedia\Rdbms\Database\getFlag(), list, Wikimedia\Rdbms\Database\rollback(), Wikimedia\Rdbms\Database\setFlag(), and Wikimedia\Rdbms\Database\trxLevel().
Referenced by Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\handleSessionLoss(), Wikimedia\Rdbms\Database\onTransactionIdle(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\LoadBalancer\runMasterPostTrxCallbacks().
Wikimedia\Rdbms\Database::runOnTransactionPreCommitCallbacks | ( | ) |
Actually run and consume any "on transaction pre-commit" callbacks.
This method should not be used outside of Database/LoadBalancer
Exception |
Definition at line 2778 of file Database.php.
References $e, Wikimedia\Rdbms\Database\$mTrxPreCommitCallbacks, as, captcha-old\count, and list.
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 2808 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\commit(), Wikimedia\Rdbms\Database\handleSessionLoss(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\LoadBalancer\runMasterPostTrxCallbacks().
Wikimedia\Rdbms\Database::select | ( | $table, | |
$vars, | |||
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Execute a SELECT query constructed using the various parameters provided.
See below for full details of the parameters.
string | array | $table | Table name |
string | array | $vars | Field names |
string | array | $conds | Conditions |
string | $fname | Caller function name |
array | $options | Query options |
array | $join_conds | Join conditions |
string | array | $table | 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).
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 | 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()
string | array | $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 | 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' ] ]
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMssql.
Definition at line 1339 of file Database.php.
References $fname, $options, $vars, Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\selectSQLText().
Referenced by MediaWikiTestCase\assertSelect(), Wikimedia\Rdbms\DatabasePostgres\estimateRowCount(), Wikimedia\Rdbms\DatabaseMysqlBase\estimateRowCount(), Wikimedia\Rdbms\Database\estimateRowCount(), Wikimedia\Rdbms\Database\insertSelect(), Wikimedia\Rdbms\DatabaseSqlite\listTables(), Wikimedia\Rdbms\Database\selectField(), Wikimedia\Rdbms\Database\selectFieldValues(), Wikimedia\Rdbms\Database\selectRow(), and DatabaseSqliteTest\testNumFields().
Wikimedia\Rdbms\Database::selectDB | ( | $db | ) |
Change the current database.
string | $db |
DBConnectionError | If databasesAreIndependent() is true and an error occurs |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMssql, DatabaseOracle, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysql.
Definition at line 1771 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\open().
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.
Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns false on failure.
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. |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1156 of file Database.php.
References $fname, $options, $res, Wikimedia\Rdbms\IDatabase\fetchRow(), Wikimedia\Rdbms\IDatabase\numRows(), and Wikimedia\Rdbms\Database\select().
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getServerVersion(), Wikimedia\Rdbms\DatabasePostgres\roleExists(), Wikimedia\Rdbms\DatabasePostgres\ruleExists(), Wikimedia\Rdbms\DatabasePostgres\schemaExists(), Wikimedia\Rdbms\DatabaseMysqlBase\setBigSelects(), DatabaseSqliteTest\testDuplicateTableStructure(), and DatabaseSqliteTest\testDuplicateTableStructureVirtual().
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.
Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns false on failure.
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. |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1183 of file Database.php.
References $fname, $options, $res, as, and Wikimedia\Rdbms\Database\select().
Wikimedia\Rdbms\Database::selectRow | ( | $table, | |
$vars, | |||
$conds, | |||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Single row SELECT wrapper.
Equivalent to IDatabase::select(), except that a single row object is returned. If the query returns no rows, false is returned.
string | array | $table | Table name |
string | array | $vars | Field names |
array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
array | string | $join_conds | Join conditions |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle.
Definition at line 1406 of file Database.php.
References $fname, $options, $res, $vars, array(), Wikimedia\Rdbms\IDatabase\fetchObject(), Wikimedia\Rdbms\IDatabase\numRows(), and Wikimedia\Rdbms\Database\select().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\indexUnique().
Wikimedia\Rdbms\Database::selectRowCount | ( | $tables, | |
$vars = ' *' , |
|||
$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().
array | string | $tables | Table names |
string | $vars | Unused |
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) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 1440 of file Database.php.
References $fname, $options, $res, $rows, $tables, Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\IDatabase\fetchRow(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\selectSQLText().
Wikimedia\Rdbms\Database::selectSQLText | ( | $table, | |
$vars, | |||
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed.
This can be useful for doing 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, and Wikimedia\Rdbms\DatabaseMssql.
Definition at line 1346 of file Database.php.
References $options, $vars, array(), Wikimedia\Rdbms\Database\fieldNamesWithAlias(), Wikimedia\Rdbms\Database\limitResult(), list, LIST_AND, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\makeSelectOptions(), and Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\buildGroupConcatField(), Wikimedia\Rdbms\Database\buildGroupConcatField(), Wikimedia\Rdbms\Database\nativeInsertSelect(), Wikimedia\Rdbms\Database\select(), Wikimedia\Rdbms\Database\selectRowCount(), and Wikimedia\Rdbms\Database\unionConditionPermutations().
Wikimedia\Rdbms\Database::serverIsReadOnly | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2662 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 3579 of file Database.php.
Wikimedia\Rdbms\Database::setFlag | ( | $flag, | |
$remember = self::REMEMBER_NOTHING |
|||
) |
Set a flag for this connection.
int | $flag | DBO_* constants from Defines.php:
|
string | $remember | IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING] |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 623 of file Database.php.
Referenced by DatabaseUpdater\__construct(), Wikimedia\Rdbms\Database\bufferResults(), Wikimedia\Rdbms\Database\ignoreErrors(), DatabaseOracle\open(), and Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().
Wikimedia\Rdbms\Database::setLazyMasterHandle | ( | IDatabase | $conn | ) |
Set a lazy-connecting DB handle to the master DB (for replication status purposes)
IDatabase | $conn |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 521 of file Database.php.
Wikimedia\Rdbms\Database::setLBInfo | ( | $name, | |
$value = null |
|||
) |
Set the LB info array, or a member of it.
If called with one parameter, the LB info array is set to that parameter. If it is called with two parameters, the member with the given name is set to the given value.
string | $name | |
array | $value |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 513 of file Database.php.
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 430 of file Database.php.
Wikimedia\Rdbms\Database::setSchemaVars | ( | $vars | ) |
Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS.
If an array is set here, $GLOBALS will not be used at all. If it's set to false, $GLOBALS will be used.
bool | array | $vars | Mapping variable name to value. |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3285 of file Database.php.
References $vars.
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 |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3250 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.
Definition at line 3596 of file Database.php.
|
final |
Run a callback each time any transaction commits or rolls back.
The callback takes two arguments:
Registering a callback here will not affect writesOrCallbacks() pending
string | $name | Callback name |
callable | null | $callback | Use null to unset a listener |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2699 of file Database.php.
References $name.
|
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 2715 of file Database.php.
Referenced by Wikimedia\Rdbms\LoadBalancer\beginMasterChanges(), Wikimedia\Rdbms\LoadBalancer\finalizeMasterChanges(), Wikimedia\Rdbms\LoadBalancer\runMasterPostTrxCallbacks(), and Wikimedia\Rdbms\LoadBalancer\suppressTransactionEndCallbacks().
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 3253 of file Database.php.
References $e, $fname, and Wikimedia\Rdbms\Database\sourceStream().
Referenced by DatabaseSqliteTest\prepareTestDB().
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.
Reimplemented in DatabaseOracle.
Definition at line 3289 of file Database.php.
References $fname, $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 statements.
If a transaction has been started already, just keep track of the given section name to make sure the transaction is not committed pre-maturely. This function can be used in layers (with sub-sections), so use a stack to keep track of the different atomic sections. If there is no transaction, start one implicitly.
The goal of this function is to create an atomic section of SQL queries without having to start a new transaction if it already exists.
All atomic levels must be explicitly closed using IDatabase::endAtomic(), and any database transactions cannot be began or committed until all atomic levels are closed. There is no such thing as implicitly opening or closing an atomic section.
string | $fname |
DBError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 2830 of file Database.php.
References $fname, Wikimedia\Rdbms\Database\begin(), DBO_TRX, and Wikimedia\Rdbms\Database\getFlag().
Referenced by Wikimedia\Rdbms\Database\doAtomicSection(), 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.
string | &$sql | SQL assembled so far |
string | &$newLine | New line about to be added to $sql |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 3351 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\sourceStream().
|
abstract |
Wrapper for addslashes()
string | $s | String to be slashed. |
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMssql, DatabaseOracle, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMysqlBase.
Referenced by Wikimedia\Rdbms\Database\addQuotes().
Wikimedia\Rdbms\Database::strreplace | ( | $orig, | |
$old, | |||
$new | |||
) |
Returns a command for str_replace function in SQL query.
Uses 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 2577 of file Database.php.
Wikimedia\Rdbms\Database::tableExists | ( | $table, | |
$fname = __METHOD__ |
|||
) |
Query whether a given table exists.
string | $table | |
string | $fname |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMssql, DatabaseOracle, and Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 1507 of file Database.php.
References $fname, $res, Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\DatabaseSqlite\dropTable(), 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 3497 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\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, DatabaseOracle, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 1788 of file Database.php.
References $name, Wikimedia\Rdbms\Database\addIdentifierQuotes(), Wikimedia\Rdbms\Database\isQuotedIdentifier(), list, Wikimedia\Rdbms\Database\prependDatabaseOrSchema(), and Wikimedia\Rdbms\Database\qualifiedTableComponents().
Referenced by Wikimedia\Rdbms\Database\delete(), Wikimedia\Rdbms\DatabaseMysqlBase\deleteJoin(), Wikimedia\Rdbms\Database\deleteJoin(), Wikimedia\Rdbms\DatabaseMysqlBase\doLockTables(), Wikimedia\Rdbms\DatabaseMysqlBase\dropTable(), Wikimedia\Rdbms\Database\dropTable(), Wikimedia\Rdbms\DatabaseMysqlBase\fieldInfo(), Wikimedia\Rdbms\DatabaseMysqlBase\indexInfo(), Wikimedia\Rdbms\Database\insert(), Wikimedia\Rdbms\Database\nativeInsertSelect(), Wikimedia\Rdbms\Database\nativeReplace(), Wikimedia\Rdbms\Database\replace(), Wikimedia\Rdbms\Database\replaceVars(), MediaWikiTestCase\resetDB(), Wikimedia\Rdbms\Database\tableExists(), Wikimedia\Rdbms\Database\tableNames(), Wikimedia\Rdbms\Database\tableNamesN(), Wikimedia\Rdbms\Database\tableNameWithAlias(), Wikimedia\Rdbms\Database\textFieldSize(), Wikimedia\Rdbms\Database\update(), and Wikimedia\Rdbms\DatabaseMysqlBase\upsert().
Wikimedia\Rdbms\Database::tableNames | ( | ) |
Fetch a number of table names into an array This is handy when you need to construct SQL for joins.
Example: extract( $dbr->tableNames( 'user', 'watchlist' ) ); $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 1885 of file Database.php.
References $name, as, and Wikimedia\Rdbms\Database\tableName().
Wikimedia\Rdbms\Database::tableNamesN | ( | ) |
Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins.
Example: list( $user, $watchlist ) = $dbr->tableNamesN( 'user', 'watchlist' ); $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 1896 of file Database.php.
References $name, as, and Wikimedia\Rdbms\Database\tableName().
|
protected |
Gets an array of aliased table names.
array | $tables | [ [alias] => table ] |
Definition at line 1929 of file Database.php.
References $retval, $tables, as, and Wikimedia\Rdbms\Database\tableNameWithAlias().
|
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 1985 of file Database.php.
References $ret, $tables, array(), as, Wikimedia\Rdbms\Database\ignoreIndexClause(), list, LIST_AND, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\tableNameWithAlias(), and Wikimedia\Rdbms\Database\useIndexClause().
Referenced by Wikimedia\Rdbms\Database\selectSQLText().
|
protected |
Get an aliased table name e.g.
tableName AS newTableName
string | $name | Table name, see tableName() |
string | bool | $alias | Alias (optional) |
Definition at line 1915 of file Database.php.
References $name, Wikimedia\Rdbms\Database\addIdentifierQuotes(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\tableNamesWithAlias(), and Wikimedia\Rdbms\Database\tableNamesWithIndexClauseOrJOIN().
Wikimedia\Rdbms\Database::tablePrefix | ( | $prefix = null | ) |
Get/set the table prefix.
string | $prefix | The table prefix to set, or omitted to leave it unchanged. |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 480 of file Database.php.
References Wikimedia\Rdbms\Database\$mTablePrefix, and Wikimedia\Rdbms\DatabaseDomain\newUnspecified().
Referenced by MediaWikiTestCase\listTables(), MediaWikiTestCase\setupTestDB(), and DatabaseSqliteTest\testTableName().
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\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, DatabaseOracle, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2338 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 wfTimestamp() 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, and DatabaseOracle.
Definition at line 3081 of file Database.php.
References $t.
Referenced by Wikimedia\Rdbms\Database\encodeExpiry(), User\makeUpdateConditions(), and Wikimedia\Rdbms\Database\timestampOrNull().
Wikimedia\Rdbms\Database::timestampOrNull | ( | $ts = null | ) |
Convert a timestamp in one of the formats accepted by wfTimestamp() 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 | $ts |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 3087 of file Database.php.
References Wikimedia\Rdbms\Database\timestamp().
Wikimedia\Rdbms\Database::trxLevel | ( | ) |
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 472 of file Database.php.
References Wikimedia\Rdbms\Database\$mTrxLevel.
Referenced by Wikimedia\Rdbms\SavepointPostgres\__construct(), Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\getScopedLockAndFlush(), Wikimedia\Rdbms\LoadBalancer\runMasterPostTrxCallbacks(), and Wikimedia\Rdbms\Database\runOnTransactionIdleCallbacks().
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.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 476 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getTransactionLagStatus().
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 2498 of file Database.php.
References $fname, $options, $value, $vars, array(), as, captcha-old\count, 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 | Use UNION ALL |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2492 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\unionConditionPermutations().
Wikimedia\Rdbms\Database::unionSupportsOrderAndLimit | ( | ) |
Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DatabaseMssql.
Definition at line 2488 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 |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 3452 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 3525 of file Database.php.
References Wikimedia\Rdbms\Database\doUnlockTables(), Wikimedia\Rdbms\Database\endAtomic(), and Wikimedia\Rdbms\Database\tableLocksHaveTransactionScope().
Wikimedia\Rdbms\Database::update | ( | $table, | |
$values, | |||
$conds, | |||
$fname = __METHOD__ , |
|||
$options = [] |
|||
) |
UPDATE wrapper.
Takes a condition array and a SET array.
string | $table | Name of the table to UPDATE. This will be passed through Database::tableName(). |
array | $values | An array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by IDatabase::addQuotes(). Values with integer keys form unquoted SET statements, which can be used for things like "field = field + 1" or similar computed values. |
array | $conds | An array of conditions (WHERE). See IDatabase::select() for the details of the format of condition arrays. Use '*' to update all rows. |
string | $fname | The function name of the caller (from METHOD), for logging and profiling. |
array | $options | An array of UPDATE options, can be:
|
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in DatabaseOracle, and Wikimedia\Rdbms\DatabaseMssql.
Definition at line 1624 of file Database.php.
References $fname, $options, LIST_AND, LIST_SET, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\makeUpdateOptions(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().
Referenced by Wikimedia\Rdbms\Database\upsert().
|
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 1059 of file Database.php.
References Wikimedia\Rdbms\IDatabase\affectedRows(), Wikimedia\Rdbms\Database\getQueryVerb(), and Wikimedia\Rdbms\Database\SMALL_WRITE_ROWS.
Referenced by Wikimedia\Rdbms\Database\doProfiledQuery().
Wikimedia\Rdbms\Database::upsert | ( | $table, | |
array | $rows, | ||
array | $uniqueIndexes, | ||
array | $set, | ||
$fname = __METHOD__ |
|||
) |
INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
This updates any conflicting rows (according to the unique indexes) using the provided SET clause and inserts any remaining (non-conflicted) rows.
$rows may be either:
It may be more efficient to leave off unique indexes which are unlikely to collide. However if you do this, you run the risk of encountering errors which wouldn't have occurred in MySQL.
Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns success.
string | $table | Table name. This will be passed through Database::tableName(). |
array | $rows | A single row or list of rows to insert |
array | $uniqueIndexes | List of single field names or field name tuples |
array | $set | An array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by IDatabase::addQuotes(). Values with integer keys form unquoted SET statements, which can be used for things like "field = field + 1" or similar computed values. |
string | $fname | Calling function name (use METHOD) for logs/profiling |
Exception |
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and DatabaseOracle.
Definition at line 2266 of file Database.php.
References $e, $fname, Wikimedia\Rdbms\Database\$mTrxLevel, $rows, as, Wikimedia\Rdbms\Database\begin(), Wikimedia\Rdbms\Database\commit(), captcha-old\count, Wikimedia\Rdbms\Database\insert(), LIST_AND, LIST_OR, Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\rollback(), and Wikimedia\Rdbms\Database\update().
Wikimedia\Rdbms\Database::useIndexClause | ( | $index | ) |
USE INDEX clause.
Unlikely to be useful for anything but MySQL. This is only needed because a) MySQL must be as efficient as possible due to its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about which index to pick. Anyway, other databases might have different indexes on a given table. So don't bother overriding this unless you're MySQL.
string | $index |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2166 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.
int | string | $errno |
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2607 of file Database.php.
Wikimedia\Rdbms\Database::wasDeadlock | ( | ) |
Determines if the last failure was due to a deadlock.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, DatabaseOracle, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2585 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\deadlockLoop(), and Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\Database::wasErrorReissuable | ( | ) |
Determines if the last query error was due to a dropped connection and should be dealt with by pinging the connection and reissuing the query.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DatabaseSqlite.
Definition at line 2593 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\query().
Wikimedia\Rdbms\Database::wasLockTimeout | ( | ) |
Determines if the last failure was due to a lock timeout.
Implements Wikimedia\Rdbms\IDatabase.
Reimplemented in Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 2589 of file Database.php.
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 2597 of file Database.php.
Wikimedia\Rdbms\Database::writesOrCallbacksPending | ( | ) |
Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish.
This does not count recurring callbacks, e.g. from setTransactionListener().
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 558 of file Database.php.
References Wikimedia\Rdbms\Database\$mTrxPreCommitCallbacks.
Referenced by Wikimedia\Rdbms\Database\flushSnapshot(), Wikimedia\Rdbms\Database\getScopedLockAndFlush(), Wikimedia\Rdbms\Database\lockTables(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\LoadBalancer\runMasterPostTrxCallbacks().
Wikimedia\Rdbms\Database::writesPending | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 554 of file Database.php.
References Wikimedia\Rdbms\Database\$mTrxDoneWrites.
|
protected |
Agent name for query profiling.
Definition at line 80 of file Database.php.
|
protected |
Whether this PHP instance is for a CLI script.
Definition at line 78 of file Database.php.
|
protected |
Definition at line 85 of file Database.php.
|
protected |
Definition at line 128 of file Database.php.
|
protected |
Definition at line 126 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\buildGroupConcatField().
|
protected |
Error logging callback.
Definition at line 89 of file Database.php.
|
protected |
Stashed value of html_errors INI setting.
Definition at line 124 of file Database.php.
|
protected |
UNIX timestamp.
Definition at line 229 of file Database.php.
|
private |
Lazy handle to the master DB this server replicates from.
Definition at line 226 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getLazyMasterHandle().
|
protected |
Database connection.
Definition at line 92 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqli\__toString(), Wikimedia\Rdbms\Database\__toString(), Wikimedia\Rdbms\Database\getBindingHandle(), Wikimedia\Rdbms\DatabaseMssql\open(), Wikimedia\Rdbms\DatabasePostgres\open(), and DatabaseOracle\open().
|
protected |
Definition at line 74 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseSqlite\__construct(), Wikimedia\Rdbms\DatabasePostgres\getDBname(), Wikimedia\Rdbms\Database\getDBname(), and Wikimedia\Rdbms\DatabaseMysqlBase\listViews().
|
protected |
Definition at line 116 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\setBigSelects().
|
protected |
Definition at line 112 of file Database.php.
|
protected |
SQL query.
Definition at line 62 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\lastQuery().
|
protected |
UNIX timestamp of last write query.
Definition at line 64 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\doneWrites().
|
protected |
Definition at line 114 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getLBInfo().
|
private |
Map of (name => 1) for locks obtained via lock()
Definition at line 221 of file Database.php.
|
protected |
Definition at line 94 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\isOpen().
|
protected |
Definition at line 72 of file Database.php.
Definition at line 66 of file Database.php.
|
private |
RTT time estimate.
Definition at line 218 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\ping().
|
protected |
Definition at line 110 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\dbSchema(), Wikimedia\Rdbms\Database\qualifiedTableComponents(), and Wikimedia\Rdbms\DatabaseMssql\tableExists().
Definition at line 118 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getSchemaVars().
|
protected |
Definition at line 68 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabasePostgres\getServer(), and Wikimedia\Rdbms\Database\getServer().
|
protected |
Map of (table name => 1) for TEMPORARY tables.
Definition at line 223 of file Database.php.
|
protected |
Definition at line 120 of file Database.php.
|
protected |
Definition at line 108 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\qualifiedTableComponents(), and Wikimedia\Rdbms\Database\tablePrefix().
|
private |
Array of levels of atomicity within transactions.
Definition at line 182 of file Database.php.
|
private |
Record if the current transaction was started implicitly due to DBO_TRX being set.
Definition at line 176 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\explicitTrxActive().
|
private |
Record if the current transaction was started implicitly by Database::startAtomic.
Definition at line 188 of file Database.php.
|
private |
Record if possible write queries were done in the last transaction started.
Definition at line 169 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\writesPending().
|
protected |
List of (callable, method name)
Definition at line 101 of file Database.php.
|
protected |
Whether to suppress triggering of transaction end callbacks.
Definition at line 105 of file Database.php.
|
private |
Remembers the function name given for starting the most recent transaction via begin().
Used to provide additional context for error reporting.
Definition at line 162 of file Database.php.
|
protected |
List of (callable, method name)
Definition at line 97 of file Database.php.
|
protected |
Either 1 if a transaction is active or 0 otherwise.
The other Trx fields may not be meaningfull if this is 0.
Definition at line 136 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\trxLevel(), and Wikimedia\Rdbms\Database\upsert().
|
protected |
List of (callable, method name)
Definition at line 99 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\runOnTransactionPreCommitCallbacks(), and Wikimedia\Rdbms\Database\writesOrCallbacksPending().
|
protected |
Map of (name => callable)
Definition at line 103 of file Database.php.
|
private |
Lag estimate at the time of BEGIN.
Definition at line 154 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\getTransactionLagStatus().
|
protected |
Either a short hexidecimal string if a transaction is active or "".
Definition at line 143 of file Database.php.
|
private |
The UNIX time that the transaction started.
Callers can assume that if snapshot isolation is used, then the data is at least up to date to that point (possibly more up-to-date since the first SELECT defines the snapshot).
Definition at line 152 of file Database.php.
|
private |
Like mTrxWriteQueryCount but excludes lock-bound, easy to replicate, queries.
Definition at line 210 of file Database.php.
|
private |
Number of write queries counted in mTrxWriteAdjDuration.
Definition at line 214 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\pendingWriteQueryDuration().
|
private |
Number of rows affected by write queries for the current transaction.
Definition at line 206 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\pendingWriteRowsAffected().
|
private |
Track the write query callers of the current transaction.
Definition at line 194 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\pendingWriteAndCallbackCallers().
|
private |
Seconds spent in write queries for the current transaction.
Definition at line 198 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\pendingWriteQueryDuration().
|
private |
Number of write queries for the current transaction.
Definition at line 202 of file Database.php.
|
protected |
Definition at line 70 of file Database.php.
|
protected |
Definition at line 122 of file Database.php.
|
private |
Prior mFlags values.
Definition at line 232 of file Database.php.
Class name or object With profileIn/profileOut methods.
Definition at line 235 of file Database.php.
|
protected |
Definition at line 87 of file Database.php.
|
protected |
APC cache.
Definition at line 83 of file Database.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo().
|
protected |
Definition at line 76 of file Database.php.
|
protected |
Definition at line 237 of file Database.php.
const Wikimedia\Rdbms\Database::DEADLOCK_DELAY_MAX = 1500000 |
Maximum time to wait before retry.
Definition at line 51 of file Database.php.
const Wikimedia\Rdbms\Database::DEADLOCK_DELAY_MIN = 500000 |
Minimum time to wait before retry, in microseconds.
Definition at line 49 of file Database.php.
const Wikimedia\Rdbms\Database::DEADLOCK_TRIES = 4 |
Number of times to re-try an operation in case of deadlock.
Definition at line 47 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\deadlockLoop().
const Wikimedia\Rdbms\Database::PING_QUERY = 'SELECT 1 AS ping' |
Definition at line 55 of file Database.php.
const Wikimedia\Rdbms\Database::PING_TTL = 1.0 |
How long before it is worth doing a dummy query to test the connection.
Definition at line 54 of file Database.php.
const Wikimedia\Rdbms\Database::SLOW_WRITE_SEC = 0.500 |
Definition at line 58 of file Database.php.
const Wikimedia\Rdbms\Database::SMALL_WRITE_ROWS = 100 |
Definition at line 59 of file Database.php.
Referenced by Wikimedia\Rdbms\Database\updateTrxWriteQueryTime().
const Wikimedia\Rdbms\Database::TINY_WRITE_SEC = 0.010 |
Definition at line 57 of file Database.php.