MediaWiki REL1_30
|
Basic database interface for live and lazy-loaded relation database handles. More...
Public Member Functions | |
addQuotes ( $s) | |
Adds quotes and backslashes. | |
affectedRows () | |
Get the number of rows affected by the last write query. | |
aggregateValue ( $valuedata, $valuename='value') | |
Return aggregated value alias. | |
anyChar () | |
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. | |
anyString () | |
Returns a token for buildLike() that denotes a '' to be used in a LIKE query. | |
begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT) | |
Begin a transaction. | |
bitAnd ( $fieldLeft, $fieldRight) | |
bitNot ( $field) | |
bitOr ( $fieldLeft, $fieldRight) | |
bufferResults ( $buffer=null) | |
Turns buffering of SQL result sets on (true) or off (false). | |
buildConcat ( $stringList) | |
Build a concatenation list to feed into a SQL query. | |
buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[]) | |
Build a GROUP_CONCAT or equivalent statement for a query. | |
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(). | |
buildStringCast ( $field) | |
clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Clear a flag for this connection. | |
close () | |
Closes a database connection. | |
commit ( $fname=__METHOD__, $flush='') | |
Commits a transaction previously started using begin(). | |
conditional ( $cond, $trueVal, $falseVal) | |
Returns an SQL expression for a simple conditional. | |
databasesAreIndependent () | |
Returns true if DBs are assumed to be on potentially different servers. | |
dataSeek ( $res, $row) | |
Change the position of the cursor in a result object. | |
dbSchema ( $schema=null) | |
Get/set the db schema. | |
decodeBlob ( $b) | |
Some DBMSs return a special placeholder object representing blob fields in result objects. | |
decodeExpiry ( $expiry, $format=TS_MW) | |
Decode an expiry time into a DBMS independent format. | |
delete ( $table, $conds, $fname=__METHOD__) | |
DELETE query wrapper. | |
deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__) | |
DELETE where the condition is a join. | |
doAtomicSection ( $fname, callable $callback) | |
Run a callback to do an atomic set of updates for this database. | |
doneWrites () | |
Returns true if the connection may have been used for write queries. | |
encodeBlob ( $b) | |
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. | |
encodeExpiry ( $expiry) | |
Encode an expiry time into the DBMS dependent format. | |
endAtomic ( $fname=__METHOD__) | |
Ends an atomic section of SQL statements. | |
estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=[]) | |
Estimate the number of rows in dataset. | |
explicitTrxActive () | |
fetchObject ( $res) | |
Fetch the next row from the given result object, in object form. | |
fetchRow ( $res) | |
Fetch the next row from the given result object, in associative array form. | |
fieldExists ( $table, $field, $fname=__METHOD__) | |
Determines whether a field exists in a table. | |
fieldInfo ( $table, $field) | |
mysql_fetch_field() wrapper Returns false if the field doesn't exist | |
fieldName ( $res, $n) | |
Get a field name in a result object. | |
flushSnapshot ( $fname=__METHOD__) | |
Commit any transaction but error out if writes or callbacks are pending. | |
freeResult ( $res) | |
Free a result object returned by query() or select(). | |
getDBname () | |
Get the current DB name. | |
getDomainID () | |
getFlag ( $flag) | |
Returns a boolean whether the flag $flag is set for this connection. | |
getInfinity () | |
Find out when 'infinity' is. | |
getLag () | |
Get replica DB lag. | |
getLBInfo ( $name=null) | |
Get properties passed down from the server info array of the load balancer. | |
getMasterPos () | |
Get the position of this master. | |
getReplicaPos () | |
Get the replication position of this replica DB. | |
getScopedLockAndFlush ( $lockKey, $fname, $timeout) | |
Acquire a named lock, flush any transaction, and return an RAII style unlocker object. | |
getServer () | |
Get the server hostname or IP address. | |
getServerInfo () | |
A string describing the current software version, and possibly other details in a user-friendly way. | |
getServerUptime () | |
Determines how long the server has been up. | |
getServerVersion () | |
A string describing the current software version, like from mysql_get_server_info(). | |
getSessionLagStatus () | |
Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. | |
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. | |
getType () | |
Get the type of the DBMS, as it appears in $wgDBtype. | |
getWikiID () | |
Alias for getDomainID() | |
implicitGroupby () | |
Returns true if this database does an implicit sort when doing GROUP BY. | |
implicitOrderby () | |
Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1. | |
indexExists ( $table, $index, $fname=__METHOD__) | |
Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure. | |
indexUnique ( $table, $index) | |
Determines if a given index is unique. | |
insert ( $table, $a, $fname=__METHOD__, $options=[]) | |
INSERT wrapper, inserts an array into a table. | |
insertId () | |
Get the inserted value of an auto-increment row. | |
insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |
INSERT SELECT wrapper. | |
isOpen () | |
Is a connection to the database open? | |
isReadOnly () | |
lastDoneWrites () | |
Returns the last time the connection may have been used for write queries. | |
lastErrno () | |
Get the last error number. | |
lastError () | |
Get a description of the last error. | |
lastQuery () | |
Return the last query that went through IDatabase::query() | |
listTables ( $prefix=null, $fname=__METHOD__) | |
List all tables on the database. | |
lock ( $lockName, $method, $timeout=5) | |
Acquire a named lock. | |
lockIsFree ( $lockName, $method) | |
Check to see if a named lock is available (non-blocking) | |
makeList ( $a, $mode=self::LIST_COMMA) | |
Makes an encoded list of strings from an array. | |
makeWhereFrom2d ( $data, $baseKey, $subKey) | |
Build a partial where clause from a 2-d array such as used for LinkBatch. | |
masterPosWait (DBMasterPos $pos, $timeout) | |
Wait for the replica DB to catch up to a given master position. | |
maxListLen () | |
Return the maximum number of items allowed in a list, or 0 for unlimited. | |
namedLocksEnqueue () | |
Check to see if a named lock used by lock() use blocking queues. | |
nextSequenceValue ( $seqName) | |
Deprecated method, calls should be removed. | |
numFields ( $res) | |
Get the number of fields in a result object. | |
numRows ( $res) | |
Get the number of rows in a result object. | |
onTransactionIdle (callable $callback, $fname=__METHOD__) | |
Run a callback as soon as there is no transaction pending. | |
onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__) | |
Run a callback before the current transaction commits or now if there is none. | |
onTransactionResolution (callable $callback, $fname=__METHOD__) | |
Run a callback as soon as the current transaction commits or rolls back. | |
open ( $server, $user, $password, $dbName) | |
Open a connection to the database. | |
pendingWriteCallers () | |
Get the list of method names that did write queries for this transaction. | |
pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL) | |
Get the time spend running write queries for this transaction. | |
pendingWriteRowsAffected () | |
Get the number of affected rows from pending write queries. | |
ping (&$rtt=null) | |
Ping the server and try to reconnect if it there is no connection. | |
query ( $sql, $fname=__METHOD__, $tempIgnore=false) | |
Run an SQL query and return the result. | |
replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__) | |
REPLACE query wrapper. | |
reportConnectionError ( $error='Unknown error') | |
reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false) | |
Report a query error. | |
restoreFlags ( $state=self::RESTORE_PRIOR) | |
Restore the flags to their prior state before the last setFlag/clearFlag call. | |
rollback ( $fname=__METHOD__, $flush='') | |
Rollback a transaction previously started using begin(). | |
select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Execute a SELECT query constructed using the various parameters provided. | |
selectDB ( $db) | |
Change the current database. | |
selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
A SELECT wrapper which returns a single field from a single result row. | |
selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
A SELECT wrapper which returns a list of single field values from result rows. | |
selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[]) | |
Single row SELECT wrapper. | |
selectRowCount ( $tables, $vars=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Get the number of rows in dataset. | |
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. | |
serverIsReadOnly () | |
setBigSelects ( $value=true) | |
Allow or deny "big selects" for this session only. | |
setFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Set a flag for this connection. | |
setLazyMasterHandle (IDatabase $conn) | |
Set a lazy-connecting DB handle to the master DB (for replication status purposes) | |
setLBInfo ( $name, $value=null) | |
Set the LB info array, or a member of it. | |
setSchemaVars ( $vars) | |
Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS. | |
setSessionOptions (array $options) | |
Override database's default behavior. | |
setTableAliases (array $aliases) | |
Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. | |
setTransactionListener ( $name, callable $callback=null) | |
Run a callback each time any transaction commits or rolls back. | |
startAtomic ( $fname=__METHOD__) | |
Begin an atomic section of statements. | |
strreplace ( $orig, $old, $new) | |
Returns a command for str_replace function in SQL query. | |
tableExists ( $table, $fname=__METHOD__) | |
Query whether a given table exists. | |
tablePrefix ( $prefix=null) | |
Get/set the table prefix. | |
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. | |
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. | |
trxLevel () | |
Gets the current transaction level. | |
trxTimestamp () | |
Get the UNIX timestamp of the time that the transaction was established. | |
unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Construct a UNION query for permutations of conditions. | |
unionQueries ( $sqls, $all) | |
Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax. | |
unionSupportsOrderAndLimit () | |
Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct. | |
unlock ( $lockName, $method) | |
Release a lock. | |
update ( $table, $values, $conds, $fname=__METHOD__, $options=[]) | |
UPDATE wrapper. | |
upsert ( $table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__) | |
INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. | |
wasDeadlock () | |
Determines if the last failure was due to a deadlock. | |
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. | |
wasLockTimeout () | |
Determines if the last failure was due to a lock timeout. | |
wasReadOnlyError () | |
Determines if the last failure was due to the database being read-only. | |
writesOrCallbacksPending () | |
Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. | |
writesPending () | |
Basic database interface for live and lazy-loaded relation database handles.
Definition at line 40 of file IDatabase.php.
Wikimedia\Rdbms\IDatabase::addQuotes | ( | $s | ) |
Adds quotes and backslashes.
string | int | null | bool | Blob | $s |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by PopulateRecentChangesSource\buildUpdateCondition(), DBFileJournal\doGetChangeEntries(), DBFileJournal\doGetPositionAtTime(), DBFileJournal\doPurgeOldLogs(), RefreshImageMetadata\execute(), RefreshImageMetadata\getConditions(), WatchedItemQueryService\getFromUntilTargetConds(), WatchedItemQueryService\getStartEndConds(), WatchedItemQueryService\getStartFromConds(), WANCacheReapUpdate\getTitleChangeEvents(), WatchedItemQueryService\getUserRelatedConds(), WatchedItemStore\getVisitingWatchersCondition(), WatchedItemQueryService\getWatchedItemsWithRCInfoQueryConds(), UserGroupMembership\insert(), Title\invalidateCache(), PurgeJobUtils\invalidatePages(), PopulateContentModel\populatePage(), PopulateContentModel\populateRevisionOrArchive(), Block\purgeExpired(), UserGroupMembership\purgeExpired(), and Title\purgeExpiredRestrictions().
Wikimedia\Rdbms\IDatabase::affectedRows | ( | ) |
Get the number of rows affected by the last write query.
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and FakeDatabaseMysqlBase.
Referenced by UserGroupMembership\delete(), UserGroupMembership\insert(), and MigrateComments\loadCommentIDs().
Wikimedia\Rdbms\IDatabase::aggregateValue | ( | $valuedata, | |
$valuename = 'value' |
|||
) |
Return aggregated value alias.
array | $valuedata | |
string | $valuename |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::anyChar | ( | ) |
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::anyString | ( | ) |
Returns a token for buildLike() that denotes a '' to be used in a LIKE query.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by RefreshImageMetadata\getConditions().
Wikimedia\Rdbms\IDatabase::begin | ( | $fname = __METHOD__ , |
|
$mode = self::TRANSACTION_EXPLICIT |
|||
) |
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 |
Implemented in Wikimedia\Rdbms\DBConnRef, and Wikimedia\Rdbms\Database.
Referenced by DatabaseTest\badLockingMethodExplicit(), and Maintenance\beginTransaction().
Wikimedia\Rdbms\IDatabase::bitAnd | ( | $fieldLeft, | |
$fieldRight | |||
) |
string | $fieldLeft | |
string | $fieldRight |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by WatchedItemQueryService\getExtraDeletedPageLogEntryRelatedCond(), and WatchedItemQueryService\getUserRelatedConds().
Wikimedia\Rdbms\IDatabase::bitNot | ( | $field | ) |
string | $field |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::bitOr | ( | $fieldLeft, | |
$fieldRight | |||
) |
string | $fieldLeft | |
string | $fieldRight |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 );
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by RefreshImageMetadata\getConditions().
Wikimedia\Rdbms\IDatabase::buildStringCast | ( | $field | ) |
string | $field | Field or column to cast |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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] |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::close | ( | ) |
Closes a database connection.
if it is open : commits any open transactions
DBError |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\closeAll(), and Wikimedia\Rdbms\LoadBalancer\closeConnection().
Wikimedia\Rdbms\IDatabase::commit | ( | $fname = __METHOD__ , |
|
$flush = '' |
|||
) |
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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\commitAll(), and Maintenance\commitTransaction().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::dataSeek | ( | $res, | |
$row | |||
) |
Change the position of the cursor in a result object.
mixed | $res | A SQL result |
int | $row |
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::dbSchema | ( | $schema = null | ) |
Get/set the db schema.
string | $schema | The database schema to set, or omitted to leave it unchanged. |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DBConnRef.
Referenced by UserGroupMembership\delete(), DBFileJournal\doPurgeOldLogs(), Block\purgeExpired(), UserGroupMembership\purgeExpired(), Title\purgeExpiredRestrictions(), and QueryPage\recache().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::doAtomicSection | ( | $fname, | |
callable | $callback | ||
) |
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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::doneWrites | ( | ) |
Returns true if the connection may have been used for write queries.
Should return true if unsure.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::encodeExpiry | ( | $expiry | ) |
Encode an expiry time into the DBMS dependent format.
string | $expiry | Timestamp for expiry, or the 'infinity' string |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Block\getDatabaseArray().
Wikimedia\Rdbms\IDatabase::endAtomic | ( | $fname = __METHOD__ | ) |
Ends an atomic section of SQL statements.
Ends the next section of atomic SQL statements and commits the transaction if necessary.
string | $fname |
DBError |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by JobQueueDB\doBatchPushInternal().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::explicitTrxActive | ( | ) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\approveMasterChanges(), and DeferredUpdates\areDatabaseTransactionsActive().
Wikimedia\Rdbms\IDatabase::fetchObject | ( | $res | ) |
Fetch the next row from the given result object, in object form.
Fields can be retrieved with $row->fieldname, with fields acting like member variables. If no more rows are available, false is returned.
IResultWrapper | stdClass | $res | Object as returned from IDatabase::query(), etc. |
DBUnexpectedError | Thrown if the database returns an error |
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\Database\textFieldSize().
Wikimedia\Rdbms\IDatabase::fetchRow | ( | $res | ) |
Fetch the next row from the given result object, in associative array form.
Fields are retrieved with $row['fieldname']. If no more rows are available, false is returned.
IResultWrapper | $res | Result object as returned from IDatabase::query(), etc. |
DBUnexpectedError | Thrown if the database returns an error |
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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) |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::fieldInfo | ( | $table, | |
$field | |||
) |
mysql_fetch_field() wrapper Returns false if the field doesn't exist
string | $table | Table name |
string | $field | Field name |
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\Database\fieldExists().
Wikimedia\Rdbms\IDatabase::fieldName | ( | $res, | |
$n | |||
) |
Get a field name in a result object.
mixed | $res | A SQL result |
int | $n |
Implemented in Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and DatabaseOracle.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\commitMasterChanges(), and Wikimedia\Rdbms\LoadBalancer\flushReplicaSnapshots().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getDBname | ( | ) |
Get the current DB name.
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getDomainID | ( | ) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Revision\newKnownCurrent(), and ResourceLoaderWikiModule\preloadTitleInfo().
Wikimedia\Rdbms\IDatabase::getFlag | ( | $flag | ) |
Returns a boolean whether the flag $flag is set for this connection.
int | $flag | DBO_* constants from Defines.php:
|
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\applyTransactionRoundFlags(), and Wikimedia\Rdbms\LoadBalancer\undoTransactionRoundFlags().
Wikimedia\Rdbms\IDatabase::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.
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\safeGetLag().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\applyTransactionRoundFlags(), Wikimedia\Rdbms\LoadBalancer\closeConnection(), Wikimedia\Rdbms\LoadBalancer\commitAll(), Wikimedia\Rdbms\LoadBalancer\safeWaitForMasterPos(), Wikimedia\Rdbms\LoadBalancer\setDomainPrefix(), and Wikimedia\Rdbms\LoadBalancer\undoTransactionRoundFlags().
Wikimedia\Rdbms\IDatabase::getMasterPos | ( | ) |
Get the position of this master.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getReplicaPos | ( | ) |
Get the replication position of this replica DB.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by LinksUpdate\acquirePageLock(), DatabaseTest\badLockingMethodExplicit(), and DatabaseTest\badLockingMethodImplicit().
Wikimedia\Rdbms\IDatabase::getServer | ( | ) |
Get the server hostname or IP address.
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\closeAll().
Wikimedia\Rdbms\IDatabase::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.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getServerUptime | ( | ) |
Determines how long the server has been up.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getServerVersion | ( | ) |
A string describing the current software version, like from mysql_get_server_info().
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and FakeDatabaseMysqlBase.
Referenced by Wikimedia\Rdbms\Database\getServerInfo().
Wikimedia\Rdbms\IDatabase::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.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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.
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getType | ( | ) |
Get the type of the DBMS, as it appears in $wgDBtype.
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by SearchEngineFactory\getSearchEngineClass(), DatabaseInstaller\getSqlFilePath(), WatchedItemQueryService\getWatchedItemsWithRCInfoQueryConds(), MediaWikiTestCase\listTables(), DatabaseUpdater\newForDB(), DatabaseUpdater\patchPath(), LBFactoryTest\quoteTable(), MediaWikiTestCase\resetDB(), MediaWikiTestCase\setupDatabaseWithTestPrefix(), and MediaWikiTestCase\setupTestDB().
Wikimedia\Rdbms\IDatabase::getWikiID | ( | ) |
Alias for getDomainID()
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::implicitGroupby | ( | ) |
Returns true if this database does an implicit sort when doing GROUP BY.
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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.
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::indexUnique | ( | $table, | |
$index | |||
) |
Determines if a given index is unique.
string | $table | |
string | $index |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DatabaseMssql.
Referenced by CommentStore\createComment(), UserGroupMembership\delete(), JobQueueDB\doBatchPushInternal(), DBFileJournal\doLogChangeBatch(), UserGroupMembership\insert(), CommentStore\insertInternal(), MigrateComments\loadCommentIDs(), UserGroupMembership\purgeExpired(), and QueryPage\recache().
Wikimedia\Rdbms\IDatabase::insertId | ( | ) |
Get the inserted value of an auto-increment row.
This should only be called after an insert that used an auto-incremented value. If no such insert was previously done in the current database session, the return value is undefined.
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and FakeDatabaseMysqlBase.
Referenced by CommentStore\createComment().
Wikimedia\Rdbms\IDatabase::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. |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::isOpen | ( | ) |
Is a connection to the database open?
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\openConnection().
Wikimedia\Rdbms\IDatabase::isReadOnly | ( | ) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::lastDoneWrites | ( | ) |
Returns the last time the connection may have been used for write queries.
Should return a timestamp if unsure.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\lastMasterChangeTimestamp().
Wikimedia\Rdbms\IDatabase::lastErrno | ( | ) |
Get the last error number.
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, Wikimedia\Rdbms\DBConnRef, and FakeDatabaseMysqlBase.
Referenced by OracleInstaller\doOpenConnection(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchRow(), Wikimedia\Rdbms\DatabaseMysqlBase\wasDeadlock(), Wikimedia\Rdbms\DatabaseMysqlBase\wasErrorReissuable(), Wikimedia\Rdbms\DatabaseMysqlBase\wasLockTimeout(), and Wikimedia\Rdbms\DatabaseMysqlBase\wasReadOnlyError().
Wikimedia\Rdbms\IDatabase::lastError | ( | ) |
Get a description of the last error.
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by MediaWikiTestCase\assertSelect(), Wikimedia\Rdbms\Database\reportConnectionError(), and Wikimedia\Rdbms\Database\sourceStream().
Wikimedia\Rdbms\IDatabase::lastQuery | ( | ) |
Return the last query that went through IDatabase::query()
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by MediaWikiTestCase\listTables().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by WatchedItemQueryService\getExtraDeletedPageLogEntryRelatedCond(), WatchedItemQueryService\getFromUntilTargetConds(), WatchedItemQueryService\getStartFromConds(), WANCacheReapUpdate\getTitleChangeEvents(), WatchedItemStore\getVisitingWatchersCondition(), WatchedItemQueryService\getWatchedItemsWithRCInfoQueryConds(), and MigrateComments\loadCommentIDs().
Wikimedia\Rdbms\IDatabase::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') |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\safeWaitForMasterPos().
Wikimedia\Rdbms\IDatabase::maxListLen | ( | ) |
Return the maximum number of items allowed in a list, or 0 for unlimited.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::namedLocksEnqueue | ( | ) |
Check to see if a named lock used by lock() use blocking queues.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::numFields | ( | $res | ) |
Get the number of fields in a result object.
mixed | $res | A SQL result |
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::numRows | ( | $res | ) |
Get the number of rows in a result object.
mixed | $res | A SQL result |
Implemented in DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::onTransactionIdle | ( | callable | $callback, |
$fname = __METHOD__ |
|||
) |
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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by PurgeJobUtils\invalidatePages().
Wikimedia\Rdbms\IDatabase::onTransactionPreCommitOrIdle | ( | callable | $callback, |
$fname = __METHOD__ |
|||
) |
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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::onTransactionResolution | ( | callable | $callback, |
$fname = __METHOD__ |
|||
) |
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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by AtomicSectionUpdate\__construct(), and AutoCommitUpdate\__construct().
Wikimedia\Rdbms\IDatabase::open | ( | $server, | |
$user, | |||
$password, | |||
$dbName | |||
) |
Open a connection to the database.
Usually aborts on failure
string | $server | Database server host |
string | $user | Database user name |
string | $password | Database user password |
string | $dbName | Database name |
DBConnectionError |
Implemented in Wikimedia\Rdbms\DatabaseSqlite, DatabaseOracle, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\Database\__clone(), Wikimedia\Rdbms\Database\__construct(), and Wikimedia\Rdbms\Database\reconnect().
Wikimedia\Rdbms\IDatabase::pendingWriteCallers | ( | ) |
Get the list of method names that did write queries for this transaction.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\pendingMasterChangeCallers().
Wikimedia\Rdbms\IDatabase::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] |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\approveMasterChanges().
Wikimedia\Rdbms\IDatabase::pendingWriteRowsAffected | ( | ) |
Get the number of affected rows from pending write queries.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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] |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\approveMasterChanges(), and Wikimedia\Rdbms\LoadBalancer\pingAll().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseSqliteMock, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by DatabaseTest\badLockingMethodImplicit(), MySqlLockManager\initConnection(), and MwSql\sqlDoQuery().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::reportConnectionError | ( | $error = 'Unknown error' | ) |
string | $error | Fallback error message, used if none is given by DB |
DBConnectionError |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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] |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\undoTransactionRoundFlags().
Wikimedia\Rdbms\IDatabase::rollback | ( | $fname = __METHOD__ , |
|
$flush = '' |
|||
) |
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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Maintenance\rollbackTransaction().
Wikimedia\Rdbms\IDatabase::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' ] ]
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DBConnRef.
Referenced by JobQueueDB\doBatchPushInternal(), DBFileJournal\doGetChangeEntries(), RefreshImageMetadata\execute(), ResourceLoaderWikiModule\fetchTitleInfo(), WANCacheReapUpdate\getTitleChangeEvents(), MigrateComments\loadCommentIDs(), PopulateContentModel\populatePage(), PopulateContentModel\populateRevisionOrArchive(), and UserGroupMembership\purgeExpired().
Wikimedia\Rdbms\IDatabase::selectDB | ( | $db | ) |
Change the current database.
string | $db |
DBConnectionError | If databasesAreIndependent() is true and an error occurs |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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. |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by CommentStore\createComment(), DBFileJournal\doGetCurrentPosition(), DBFileJournal\doGetPositionAtTime(), and LocalFileMoveBatch\verifyDBUpdates().
Wikimedia\Rdbms\IDatabase::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. |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by PurgeJobUtils\invalidatePages(), and Title\purgeExpiredRestrictions().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by LinkCache\fetchPageRow(), and UserGroupMembership\insert().
Wikimedia\Rdbms\IDatabase::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) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::serverIsReadOnly | ( | ) |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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] |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\applyTransactionRoundFlags().
Wikimedia\Rdbms\IDatabase::setLazyMasterHandle | ( | IDatabase | $conn | ) |
Set a lazy-connecting DB handle to the master DB (for replication status purposes)
IDatabase | $conn |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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. |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Referenced by BackupDumper\backupDb().
Wikimedia\Rdbms\IDatabase::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) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::setTransactionListener | ( | $name, | |
callable | $callback = null |
||
) |
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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\setTransactionListener().
Wikimedia\Rdbms\IDatabase::startAtomic | ( | $fname = __METHOD__ | ) |
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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by JobQueueDB\doBatchPushInternal(), and MySqlLockManager\initConnection().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::tableExists | ( | $table, | |
$fname = __METHOD__ |
|||
) |
Query whether a given table exists.
string | $table | |
string | $fname |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::tablePrefix | ( | $prefix = null | ) |
Get/set the table prefix.
string | $prefix | The table prefix to set, or omitted to leave it unchanged. |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by CloneDatabase\__construct(), MediaWikiTestCase\listTables(), and Wikimedia\Rdbms\LoadBalancer\setDomainPrefix().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Referenced by DBFileJournal\doGetPositionAtTime(), DBFileJournal\doLogChangeBatch(), DBFileJournal\doPurgeOldLogs(), UserGroupMembership\getDatabaseArray(), Block\getDatabaseArray(), WatchedItemQueryService\getStartEndConds(), WatchedItemQueryService\getStartFromConds(), WANCacheReapUpdate\getTitleChangeEvents(), WatchedItemStore\getVisitingWatchersCondition(), UserGroupMembership\insert(), Title\invalidateCache(), PurgeJobUtils\invalidatePages(), Block\purgeExpired(), UserGroupMembership\purgeExpired(), Title\purgeExpiredRestrictions(), and QueryPage\recache().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::unionSupportsOrderAndLimit | ( | ) |
Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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 |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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:
|
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMssql, and Wikimedia\Rdbms\DBConnRef.
Referenced by LocalFileMoveBatch\doDBUpdates(), UserGroupMembership\insert(), Title\invalidateCache(), PurgeJobUtils\invalidatePages(), PopulateContentModel\updatePageRows(), and PopulateContentModel\updateRevisionOrArchiveRows().
Wikimedia\Rdbms\IDatabase::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 |
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::wasDeadlock | ( | ) |
Determines if the last failure was due to a deadlock.
Implemented in DatabaseOracle, Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::wasLockTimeout | ( | ) |
Determines if the last failure was due to a lock timeout.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::wasReadOnlyError | ( | ) |
Determines if the last failure was due to the database being read-only.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::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().
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\approveMasterChanges(), DeferredUpdates\areDatabaseTransactionsActive(), Wikimedia\Rdbms\LoadBalancer\commitMasterChanges(), Wikimedia\Rdbms\LoadBalancer\hasMasterChanges(), and Wikimedia\Rdbms\LoadBalancer\rollbackMasterChanges().
Wikimedia\Rdbms\IDatabase::writesPending | ( | ) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.