MediaWiki REL1_35
|
Basic database interface for live and lazy-loaded relation database handles. More...
Public Member Functions | |
__toString () | |
Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present. | |
addIdentifierQuotes ( $s) | |
Escape a SQL identifier (e.g. | |
addQuotes ( $s) | |
Escape and quote a raw value string for use in a SQL query. | |
affectedRows () | |
Get the number of rows affected by the last write query. | |
aggregateValue ( $valuedata, $valuename='value') | |
Return aggregated value alias. | |
anyChar () | |
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. | |
anyString () | |
Returns a token for buildLike() that denotes a '' to be used in a LIKE query. | |
assertNoOpenTransactions () | |
Assert that all explicit transactions or atomic sections have been closed. | |
begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT) | |
Begin a transaction. | |
bitAnd ( $fieldLeft, $fieldRight) | |
bitNot ( $field) | |
bitOr ( $fieldLeft, $fieldRight) | |
buildConcat ( $stringList) | |
Build a concatenation list to feed into a SQL query. | |
buildGreatest ( $fields, $values) | |
Build a GREATEST function statement comparing columns/values. | |
buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[]) | |
Build a GROUP_CONCAT or equivalent statement for a query. | |
buildIntegerCast ( $field) | |
buildLeast ( $fields, $values) | |
Build a LEAST function statement comparing columns/values. | |
buildLike ( $param,... $params) | |
LIKE statement wrapper. | |
buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery. | |
buildStringCast ( $field) | |
buildSubString ( $input, $startPosition, $length=null) | |
Build a SUBSTRING function. | |
cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null) | |
Cancel an atomic section of SQL statements. | |
clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Clear a flag for this connection. | |
close ( $fname=__METHOD__, $owner=null) | |
Close the database connection. | |
commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |
Commits a transaction previously started using begin() | |
conditional ( $cond, $trueVal, $falseVal) | |
Returns an SQL expression for a simple conditional. | |
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 all rows in a table that match a condition. | |
deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__) | |
DELETE where the condition is a join. | |
doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |
Perform an atomic section of reversable SQL statements from a callback. | |
encodeBlob ( $b) | |
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. | |
encodeExpiry ( $expiry) | |
Encode an expiry time into the DBMS dependent format. | |
endAtomic ( $fname=__METHOD__) | |
Ends an atomic section of SQL statements. | |
estimateRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Estimate the number of rows in dataset. | |
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. | |
fieldName ( $res, $n) | |
Get a field name in a result object. | |
flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |
Commit any transaction but error out if writes or callbacks are pending. | |
freeResult ( $res) | |
Free a result object returned by query() or select() | |
getDBname () | |
Get the current DB name. | |
getDomainID () | |
Return the currently selected domain ID. | |
getFlag ( $flag) | |
Returns a boolean whether the flag $flag is set for this connection. | |
getInfinity () | |
Find out when 'infinity' is. | |
getLag () | |
Get the amount of replication lag for this database server. | |
getLBInfo ( $name=null) | |
Get properties passed down from the server info array of the load balancer. | |
getMasterPos () | |
Get the position of this master. | |
getReplicaPos () | |
Get the replication position of this replica DB. | |
getScopedLockAndFlush ( $lockKey, $fname, $timeout) | |
Acquire a named lock, flush any transaction, and return an RAII style unlocker object. | |
getServer () | |
Get the server hostname or IP address. | |
getServerInfo () | |
Get a human-readable string describing the current software version. | |
getServerUptime () | |
Determines how long the server has been up. | |
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 style link to the DB's website (e.g. | |
getTopologyRole () | |
Get the replication topology role of this server. | |
getTopologyRootMaster () | |
Get the host (or address) of the root master server for the replication topology. | |
getType () | |
Get the type of the DBMS (e.g. | |
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. | |
insert ( $table, $rows, $fname=__METHOD__, $options=[]) | |
Insert the given row(s) 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 () | |
isReadOnly () | |
lastDoneWrites () | |
Get the last time the connection may have been used for a write query. | |
lastErrno () | |
Get the last error number. | |
lastError () | |
Get a description of the last error. | |
lastQuery () | |
Get the last query that sent on account of IDatabase::query() | |
limitResult ( $sql, $limit, $offset=false) | |
Construct a LIMIT query with optional offset. | |
lock ( $lockName, $method, $timeout=5) | |
Acquire a named lock. | |
lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Lock all rows meeting the given conditions/options FOR UPDATE. | |
lockIsFree ( $lockName, $method) | |
Check to see if a named lock is not locked by any thread (non-blocking) | |
makeList (array $a, $mode=self::LIST_COMMA) | |
Makes an encoded list of strings from an array. | |
makeWhereFrom2d ( $data, $baseKey, $subKey) | |
Build a 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. | |
newSelectQueryBuilder () | |
Create an empty SelectQueryBuilder which can be used to run queries against this connection. | |
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 query result. | |
onAtomicSectionCancel (callable $callback, $fname=__METHOD__) | |
Run a callback when the atomic section is cancelled. | |
onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__) | |
Run a callback as soon as there is no transaction pending. | |
onTransactionIdle (callable $callback, $fname=__METHOD__) | |
Alias for onTransactionCommitOrIdle() for backwards-compatibility. | |
onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__) | |
Run a callback before the current transaction commits or now if there is none. | |
onTransactionResolution (callable $callback, $fname=__METHOD__) | |
Run a callback as soon as the current transaction commits or rolls back. | |
pendingWriteCallers () | |
Get the list of method names that did write queries for this transaction. | |
pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL) | |
Get the time spend running write queries for this transaction. | |
pendingWriteRowsAffected () | |
Get the number of affected rows from pending write queries. | |
ping (&$rtt=null) | |
Ping the server and try to reconnect if it there is no connection. | |
preCommitCallbacksPending () | |
query ( $sql, $fname=__METHOD__, $flags=0) | |
Run an SQL query and return the result. | |
replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__) | |
Insert row(s) into a table, deleting all conflicting rows beforehand. | |
restoreFlags ( $state=self::RESTORE_PRIOR) | |
Restore the flags to their prior state before the last setFlag/clearFlag call. | |
rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |
Rollback a transaction previously started using begin() | |
select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Execute a SELECT query constructed using the various parameters provided. | |
selectDB ( $db) | |
Change the current database. | |
selectDomain ( $domain) | |
Set the current domain (database, schema, and table prefix) | |
selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
A SELECT wrapper which returns a single field from a single result row. | |
selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
A SELECT wrapper which returns a list of single field values from result rows. | |
selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[]) | |
Wrapper to IDatabase::select() that only fetches one row (via LIMIT) | |
selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Get the number of rows in dataset. | |
selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Take the same arguments as IDatabase::select() and return the SQL it would use. | |
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. | |
setIndexAliases (array $aliases) | |
Convert certain index names to alternative names before querying the DB. | |
setLBInfo ( $nameOrArray, $value=null) | |
Set the entire array or a particular key of the managing load balancer info array. | |
setSchemaVars ( $vars) | |
Set schema variables to be used when streaming commands from SQL files or stdin. | |
setSessionOptions (array $options) | |
Override database's default behavior. | |
setTableAliases (array $aliases) | |
Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. | |
setTransactionListener ( $name, callable $callback=null) | |
Run a callback after each time any transaction commits or rolls back. | |
startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |
Begin an atomic section of SQL statements. | |
strreplace ( $orig, $old, $new) | |
Returns a SQL expression for simple string replacement (e.g. | |
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 ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. | |
timestampOrNull ( $ts=null) | |
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. | |
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. | |
unionSupportsOrderAndLimit () | |
Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION. | |
unlock ( $lockName, $method) | |
Release a lock. | |
update ( $table, $set, $conds, $fname=__METHOD__, $options=[]) | |
Update all rows in a table that match a given condition. | |
upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__) | |
Upsert the given row(s) into a table. | |
wasConnectionLoss () | |
Determines if the last query error was due to a dropped connection. | |
wasDeadlock () | |
Determines if the last failure was due to a deadlock. | |
wasErrorReissuable () | |
Determines if the last query error was due to something outside of the query itself. | |
wasLockTimeout () | |
Determines if the last failure was due to a lock timeout. | |
wasReadOnlyError () | |
Determines if the last failure was due to the database being read-only. | |
writesOrCallbacksPending () | |
Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. | |
writesPending () | |
Basic database interface for live and lazy-loaded relation database handles.
Definition at line 38 of file IDatabase.php.
Wikimedia\Rdbms\IDatabase::__toString | ( | ) |
Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::addIdentifierQuotes | ( | $s | ) |
Escape a SQL identifier (e.g.
table, column, database) for use in a SQL query
Depending on the database this will either be backticks
or "double quotes"
string | $s |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Referenced by SiteStatsUpdate\doUpdate(), and SqlBagOStuff\initSqliteDatabase().
Wikimedia\Rdbms\IDatabase::addQuotes | ( | $s | ) |
Escape and quote a raw value string for use in a SQL query.
string | int | float | null | bool | Blob | $s |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by PopulateRecentChangesSource\buildUpdateCondition(), SqlBagOStuff\deleteServerObjectsExpiringBefore(), DBFileJournal\doGetChangeEntries(), DBFileJournal\doGetPositionAtTime(), DBFileJournal\doPurgeOldLogs(), RefreshImageMetadata\execute(), WatchedItemStore\fetchWatchedItems(), RefreshImageMetadata\getConditions(), WatchedItemQueryService\getFromUntilTargetConds(), WatchedItemQueryService\getStartEndConds(), WatchedItemQueryService\getStartFromConds(), WANCacheReapUpdate\getTitleChangeEvents(), WatchedItemStore\getVisitingWatchersCondition(), WatchedItemQueryService\getWatchedItemsWithRCInfoQueryConds(), Title\invalidateCache(), PurgeJobUtils\invalidatePages(), UppercaseTitlesForUnicodeTransition\processTable(), DeleteLocalPasswords\processUsers(), UppercaseTitlesForUnicodeTransition\processUsers(), MediaWiki\Block\DatabaseBlock\purgeExpired(), Title\purgeExpiredRestrictions(), WatchedItemStore\updateNotificationTimestamp(), and MediaWiki\Revision\RevisionStore\userWasLastToEdit().
Wikimedia\Rdbms\IDatabase::affectedRows | ( | ) |
Get the number of rows affected by the last write query.
Similar to https://www.php.net/mysql_affected_rows but includes rows matched but not changed (ie. an UPDATE which sets all fields to the same value they already have). To get the old mysql_affected_rows behavior, include non-equality of the fields in WHERE.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by MigrateActors\addActorsForRows(), User\addToDatabase(), User\createNew(), SqlBagOStuff\deleteServerObjectsExpiringBefore(), ActorMigration\getNewActorId(), MigrateComments\loadCommentIDs(), DeduplicateArchiveRevId\processArRevIds(), DeleteLocalPasswords\processUsers(), PopulateArchiveRevId\reassignArRevIds(), User\saveSettings(), and WatchedItemStore\setNotificationTimestampsForUser().
Wikimedia\Rdbms\IDatabase::aggregateValue | ( | $valuedata, | |
$valuename = 'value' |
|||
) |
Return aggregated value alias.
array | $valuedata | |
string | $valuename |
Implemented in 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(), UppercaseTitlesForUnicodeTransition\getLikeBatches(), and DeleteLocalPasswords\processUsers().
Wikimedia\Rdbms\IDatabase::assertNoOpenTransactions | ( | ) |
Assert that all explicit transactions or atomic sections have been closed.
DBTransactionError |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\approveMasterChanges().
Wikimedia\Rdbms\IDatabase::begin | ( | $fname = __METHOD__ , |
|
$mode = self::TRANSACTION_EXPLICIT |
|||
) |
Begin a transaction.
Only call this from code with outer transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.
Note that when the DBO_TRX flag is set (which is usually the case for web requests, but not for maintenance scripts), any previous database query will have started a transaction automatically.
Nesting of transactions is not supported. Attempts to nest transactions will cause a warning, unless the current transaction was started automatically because of the DBO_TRX flag.
string | $fname | Calling function name |
string | $mode | A situationally valid IDatabase::TRANSACTION_* constant [optional] |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\DBConnRef, and Wikimedia\Rdbms\Database.
Referenced by Maintenance\beginTransaction(), and PopulateArchiveRevId\makeDummyRevisionRow().
Wikimedia\Rdbms\IDatabase::bitAnd | ( | $fieldLeft, | |
$fieldRight | |||
) |
string | int | $fieldLeft | |
string | int | $fieldRight |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by RevisionDeleteUser\buildSetBitDeletedField(), WatchedItemQueryService\getExtraDeletedPageLogEntryRelatedCond(), and WatchedItemQueryService\getUserRelatedConds().
Wikimedia\Rdbms\IDatabase::bitNot | ( | $field | ) |
string | int | $field |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::bitOr | ( | $fieldLeft, | |
$fieldRight | |||
) |
string | int | $fieldLeft | |
string | int | $fieldRight |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by RevisionDeleteUser\buildSetBitDeletedField().
Wikimedia\Rdbms\IDatabase::buildConcat | ( | $stringList | ) |
Build a concatenation list to feed into a SQL query.
string[] | $stringList | Raw SQL expression list; caller is responsible for escaping |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by DeleteLocalPasswords\processUsers().
Wikimedia\Rdbms\IDatabase::buildGreatest | ( | $fields, | |
$values | |||
) |
Build a GREATEST function statement comparing columns/values.
Integer and float values in $values will not be quoted
If $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
string | string[] | $fields | Name(s) of column(s) with values to compare |
string | int | float | string[] | int[] | float[] | $values | Values to compare |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by SiteStatsUpdate\doUpdate().
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 Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::buildIntegerCast | ( | $field | ) |
string | $field | Field or column to cast |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::buildLeast | ( | $fields, | |
$values | |||
) |
Build a LEAST function statement comparing columns/values.
Integer and float values in $values will not be quoted
If $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
string | string[] | $fields | Name(s) of column(s) with values to compare |
string | int | float | string[] | int[] | float[] | $values | Values to compare |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::buildLike | ( | $param, | |
$params | |||
) |
LIKE statement wrapper.
This takes a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). Alternatively, the function could be provided with an array of aforementioned parameters.
Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches for subpages of 'My page title'. Alternatively: $pattern = [ 'My_page_title/', $dbr->anyString() ]; $query .= $dbr->buildLike( $pattern );
array[] | string | LikeMatch | $param | |
string|LikeMatch | ...$params |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by RefreshImageMetadata\getConditions(), UppercaseTitlesForUnicodeTransition\getLikeBatches(), and DeleteLocalPasswords\processUsers().
Wikimedia\Rdbms\IDatabase::buildSelectSubquery | ( | $table, | |
$vars, | |||
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery.
string | array | $table | Table name |
string | array | $vars | Field names |
string | array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
string | array | $join_conds | Join conditions |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::buildStringCast | ( | $field | ) |
string | $field | Field or column to cast |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::buildSubString | ( | $input, | |
$startPosition, | |||
$length = null |
|||
) |
Build a SUBSTRING function.
Behavior for non-ASCII values is undefined.
string | $input | Field name |
int | $startPosition | Positive integer |
int | null | $length | Non-negative integer length or null for no limit |
InvalidArgumentException |
Referenced by DeleteLocalPasswords\processUsers().
Wikimedia\Rdbms\IDatabase::cancelAtomic | ( | $fname = __METHOD__ , |
|
AtomicSectionIdentifier | $sectionId = null |
||
) |
Cancel an atomic section of SQL statements.
This will roll back only the statements executed since the start of the most recent atomic section, and close that section. If a transaction was open before the corresponding startAtomic() call, any statements before that call are not rolled back and the transaction remains open. If the corresponding startAtomic() implicitly started a transaction, that transaction is rolled back.
Note that a call to IDatabase::rollback() will also roll back any open atomic sections.
string | $fname | |
AtomicSectionIdentifier | null | $sectionId | Section ID from startAtomic(); passing this enables cancellation of unclosed nested sections [optional] |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::clearFlag | ( | $flag, | |
$remember = self::REMEMBER_NOTHING |
|||
) |
Clear a flag for this connection.
int | $flag | One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX) |
string | $remember | IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING] |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\enforceConnectionFlags(), and JobQueueDB\getScopedNoTrxFlag().
Wikimedia\Rdbms\IDatabase::close | ( | $fname = __METHOD__ , |
|
$owner = null |
|||
) |
Close the database connection.
This should only be called after any transactions have been resolved, aside from read-only automatic transactions (assuming no callbacks are registered). If a transaction is still open anyway, it will be rolled back.
string | $fname | Caller name |
int | null | $owner | ID of the calling instance (e.g. the LBFactory ID) |
DBError |
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 = self::FLUSHING_ONE |
|||
) |
Commits a transaction previously started using begin()
If no transaction is in progress, a warning is issued.
Only call this from code with outer transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.
string | $fname | |
string | $flush | Flush flag, set to situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly committing implicit transactions, or calling commit when no transaction is in progress. This will trigger an exception if there is an ongoing explicit transaction. Only set the flush flag if you are sure that these warnings are not applicable, and no explicit transactions are open. |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\commitMasterChanges(), 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 the RDBMS.
string | array | $cond | SQL expression which will result in a boolean value |
string | $trueVal | SQL expression to return if true |
string | $falseVal | SQL expression to return if false |
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 logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, 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 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 | null | $schema | The database schema to set, or omitted to leave it unchanged |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\isMasterConnectionReadOnly().
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 |
DBError |
Implemented in 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 all rows in a table that match a condition.
string | $table | Table name |
string | array | $conds | Array of conditions. See $conds in IDatabase::select() In order to prevent possible performance or replication issues or damaging a data accidentally, an empty condition for 'delete' queries isn't allowed. IDatabase::ALL_ROWS should be passed explicitely in order to delete all rows. |
string | $fname | Name of the calling function |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by PopulateArchiveRevId\checkMysqlAutoIncrementBug(), SqlBagOStuff\deleteServerObjectsExpiringBefore(), DBFileJournal\doPurgeOldLogs(), LCStoreDB\finishWrite(), MediaWiki\Revision\RevisionStore\insertRevisionRowOn(), User\newSystemUser(), DeduplicateArchiveRevId\processArRevIds(), MediaWiki\Block\DatabaseBlock\purgeExpired(), Title\purgeExpiredRestrictions(), PopulateArchiveRevId\reassignArRevIds(), 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=IDatabase::ALL_ROWS.
DO NOT put the join condition in $conds.
string | $delTable | The table to delete from. |
string | $joinTable | The other table. |
string | $delVar | The variable to join on, in the first table. |
string | $joinVar | The variable to join on, in the second table. |
array | string | $conds | Condition array of field names mapped to variables, ANDed together in the WHERE clause |
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::doAtomicSection | ( | $fname, | |
callable | $callback, | ||
$cancelable = self::ATOMIC_NOT_CANCELABLE |
|||
) |
Perform an atomic section of reversable SQL statements from a callback.
The $callback takes the following arguments:
This will execute the callback inside a pair of startAtomic()/endAtomic() calls. If any exception occurs during execution of the callback, it will be handled as follows:
This method is convenient for letting calls to the caller of this method be wrapped in a try/catch blocks for exception types that imply that the caller failed but was able to properly discard the changes it made in the transaction. This method can be an alternative to explicit calls to startAtomic()/endAtomic()/cancelAtomic().
Example usage, "RecordStore::save" method:
Example usage, caller of the "RecordStore::save" method:
string | $fname | Caller name (usually METHOD) |
callable | $callback | Callback that issues DB updates |
string | $cancelable | Pass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section. |
DBError | If an error occurs, see IDatabase::query() |
Exception | If an error occurs in the callback |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by PopulateArchiveRevId\checkMysqlAutoIncrementBug(), MediaWiki\Revision\RevisionStore\insertRevisionOn(), PopulateArchiveRevId\reassignArRevIds(), and MediaWiki\Storage\NameTableStore\retryStore().
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 |
DBError |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by LCStoreDB\set().
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 MediaWiki\Block\DatabaseBlock\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 | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by JobQueueDB\doBatchPushInternal(), LCStoreDB\finishWrite(), and SqlBagOStuff\initSqliteDatabase().
Wikimedia\Rdbms\IDatabase::estimateRowCount | ( | $tables, | |
$var = ' *' , |
|||
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Estimate the number of rows in dataset.
MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.
For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).
Takes the same arguments as IDatabase::select().
string | string[] | $tables | Table name(s) |
string | $var | Column for which NULL values are not counted [default "*"] |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select |
array | string | $join_conds | Join conditions |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::explicitTrxActive | ( | ) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by 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. |
Implemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\Database\selectRow(), and 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. |
Implemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\Database\estimateRowCount(), Wikimedia\Rdbms\Database\selectField(), and Wikimedia\Rdbms\Database\selectRowCount().
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) |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
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\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::flushSnapshot | ( | $fname = __METHOD__ , |
|
$flush = self::FLUSHING_ONE |
|||
) |
Commit any transaction but error out if writes or callbacks are pending.
This is intended for clearing out REPEATABLE-READ snapshots so that callers can see a new point-in-time of the database. This is useful when one of many transaction rounds finished and significant time will pass in the script's lifetime. It is also useful to call on a replica DB after waiting on replication to catch up to the master.
string | $fname | Calling function name |
string | $flush | Flush flag, set to situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly committing implicit transactions, or calling commit when no transaction is in progress. This will trigger an exception if there is an ongoing explicit transaction. Only set the flush flag if you are sure that these warnings are not applicable, and no explicit transactions are open. |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\flushMasterSnapshots(), 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 Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getDBname | ( | ) |
Get the current DB name.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\isMasterConnectionReadOnly().
Wikimedia\Rdbms\IDatabase::getDomainID | ( | ) |
Return the currently selected domain ID.
Null components (database/schema) might change once a connection is established
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by MediaWiki\Revision\RevisionStore\checkDatabaseDomain(), MediaWiki\Revision\RevisionStore\getRevisionRowCacheKey(), Title\invalidateCache(), Wikimedia\Rdbms\LBFactorySingle\newFromConnection(), Wikimedia\Rdbms\LoadBalancerSingle\newFromConnection(), ResourceLoaderWikiModule\preloadTitleInfo(), Wikimedia\Rdbms\LoadBalancer\reuseConnection(), and WatchedItemStore\updateNotificationTimestamp().
Wikimedia\Rdbms\IDatabase::getFlag | ( | $flag | ) |
Returns a boolean whether the flag $flag is set for this connection.
int | $flag | One of the class IDatabase::DBO_* constants |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by JobQueueDB\getScopedNoTrxFlag().
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 Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getLag | ( | ) |
Get the amount of replication lag for this database server.
Callers should avoid using this method while a transaction is active
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, 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 | null | $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\closeConnection(), Wikimedia\Rdbms\LoadBalancer\reuseConnection(), Wikimedia\Rdbms\LoadBalancer\setLocalDomainPrefix(), and Wikimedia\Rdbms\LoadBalancer\waitForMasterPos().
Wikimedia\Rdbms\IDatabase::getMasterPos | ( | ) |
Get the position of this master.
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getReplicaPos | ( | ) |
Get the replication position of this replica DB.
DBError | If an error occurs, see IDatabase::query() |
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 |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by LinksUpdate\acquirePageLock().
Wikimedia\Rdbms\IDatabase::getServer | ( | ) |
Get the server hostname or IP address.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\closeAll(), Wikimedia\Rdbms\LoadBalancer\isMasterConnectionReadOnly(), and Wikimedia\Rdbms\LoadBalancer\waitForMasterPos().
Wikimedia\Rdbms\IDatabase::getServerInfo | ( | ) |
Get a human-readable string describing the current software version.
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.
DBError |
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 Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
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 AUTOCOMMIT mode, this still gives an indication of the staleness of subsequent reads.
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\Database\getCacheSetOptions().
Wikimedia\Rdbms\IDatabase::getSoftwareLink | ( | ) |
Returns a wikitext style link to the DB's website (e.g.
"[https://www.mysql.com/ MySQL]")
Should at least contain plain text, if for some reason your database has no website.
Implemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getTopologyRole | ( | ) |
Get the replication topology role of this server.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getTopologyRootMaster | ( | ) |
Get the host (or address) of the root master server for the replication topology.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::getType | ( | ) |
Get the type of the DBMS (e.g.
"mysql", "sqlite")
Implemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\Database\__toString(), PopulateArchiveRevId\checkMysqlAutoIncrementBug(), Wikimedia\Rdbms\SelectQueryBuilder\connection(), SqlBagOStuff\getConnectionFromServerInfo(), DatabaseInstaller\getSqlFilePath(), WatchedItemQueryService\getWatchedItemsWithRCInfoQueryConds(), MediaWiki\Revision\RevisionStore\insertRevisionRowOn(), DatabaseUpdater\newForDB(), and DatabaseUpdater\patchPath().
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 Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::indexExists | ( | $table, | |
$index, | |||
$fname = __METHOD__ |
|||
) |
Determines whether an index exists.
string | $table | |
string | $index | |
string | $fname |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::insert | ( | $table, | |
$rows, | |||
$fname = __METHOD__ , |
|||
$options = [] |
|||
) |
Insert the given row(s) into a table.
string | $table | Table name |
array | array[] | $rows | Row(s) to insert, as either:
|
string | $fname | Calling function name (use METHOD) for logs/profiling |
string | array | $options | Combination map/list where each string-keyed entry maps a non-boolean option to the option parameters and each integer-keyed value is the name of a boolean option. Supported options are:
|
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by MigrateActors\addActorsForRows(), User\addToDatabase(), PopulateArchiveRevId\checkMysqlAutoIncrementBug(), CommentStore\createComment(), User\createNew(), JobQueueDB\doBatchPushInternal(), DBFileJournal\doLogChangeBatch(), LCStoreDB\finishWrite(), ActorMigration\getNewActorId(), MediaWiki\Revision\RevisionStore\insertContentRowOn(), CommentStore\insertInternal(), MediaWiki\Revision\RevisionStore\insertIpChangesRow(), MediaWiki\Revision\RevisionStore\insertRevisionRowOn(), MediaWiki\Revision\RevisionStore\insertSlotRowOn(), MigrateComments\loadCommentIDs(), PopulateArchiveRevId\reassignArRevIds(), QueryPage\recache(), MediaWiki\Storage\NameTableStore\retryStore(), User\updateActorId(), and WatchedItemStore\updateExpiriesAfterMove().
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 Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by User\addToDatabase(), PopulateArchiveRevId\checkMysqlAutoIncrementBug(), CommentStore\createComment(), ActorMigration\getNewActorId(), MediaWiki\Revision\RevisionStore\insertContentRowOn(), MediaWiki\Revision\RevisionStore\insertRevisionRowOn(), and User\updateActorId().
Wikimedia\Rdbms\IDatabase::insertSelect | ( | $destTable, | |
$srcTable, | |||
$varMap, | |||
$conds, | |||
$fname = __METHOD__ , |
|||
$insertOptions = [] , |
|||
$selectOptions = [] , |
|||
$selectJoinConds = [] |
|||
) |
INSERT SELECT wrapper.
string | $destTable | The table name to insert into |
string | array | $srcTable | May be either a table name, or an array of table names to include in a join. |
array | $varMap | Must be an associative array of the form [ 'dest1' => 'source1', ... ]. Source items may be literals rather than field names, but strings should be quoted with IDatabase::addQuotes() |
array | $conds | Condition array. See $conds in IDatabase::select() for the details of the format of condition arrays. May be "*" to copy the whole table. |
string | $fname | The function name of the caller, from METHOD |
array | $insertOptions | Options for the INSERT part of the query, see IDatabase::insert() for details. Also, one additional option is available: pass 'NO_AUTO_COLUMNS' to hint that the query does not use an auto-increment or sequence to determine any column values. |
array | $selectOptions | Options for the SELECT part of the query, see IDatabase::select() for details. |
array | $selectJoinConds | Join conditions for the SELECT part of the query, see IDatabase::select() for details. |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::isOpen | ( | ) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::isReadOnly | ( | ) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by LCStoreDB\startWrite().
Wikimedia\Rdbms\IDatabase::lastDoneWrites | ( | ) |
Get the last time the connection may have been used for a write query.
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 Wikimedia\Rdbms\DatabaseMysqli, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchRow(), Wikimedia\Rdbms\Database\wasConnectionLoss(), Wikimedia\Rdbms\DatabaseMysqlBase\wasDeadlock(), Wikimedia\Rdbms\DatabaseMysqlBase\wasKnownStatementRollbackError(), Wikimedia\Rdbms\DatabaseMysqlBase\wasLockTimeout(), and Wikimedia\Rdbms\DatabaseMysqlBase\wasReadOnlyError().
Wikimedia\Rdbms\IDatabase::lastError | ( | ) |
Get a description of the last error.
Implemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt(), and Wikimedia\Rdbms\Database\sourceStream().
Wikimedia\Rdbms\IDatabase::lastQuery | ( | ) |
Get the last query that sent on account of IDatabase::query()
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::limitResult | ( | $sql, | |
$limit, | |||
$offset = false |
|||
) |
Construct a LIMIT query with optional offset.
The SQL should be adjusted so that only the first $limit rows are returned. If $offset is provided as well, then the first $offset rows should be discarded, and the next $limit rows should be returned. If the result of the query is not ordered, then the rows to be returned are theoretically arbitrary.
$sql is expected to be a SELECT, if that makes a difference.
string | $sql | SQL query we will append the limit too |
int | $limit | The SQL limit |
int | bool | $offset | The SQL offset (default false) |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
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 (0 means non-blocking) |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by MediaWiki\Revision\RevisionStore\insertRevisionRowOn().
Wikimedia\Rdbms\IDatabase::lockForUpdate | ( | $table, | |
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Lock all rows meeting the given conditions/options FOR UPDATE.
string | string[] | $table | Table name(s) |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select ("FOR UPDATE" is added automatically) |
array | $join_conds | Join conditions |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by LocalFileMoveBatch\verifyDBUpdates().
Wikimedia\Rdbms\IDatabase::lockIsFree | ( | $lockName, | |
$method | |||
) |
Check to see if a named lock is not locked by any thread (non-blocking)
string | $lockName | Name of lock to poll |
string | $method | Name of method calling us |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::makeList | ( | array | $a, |
$mode = self::LIST_COMMA |
|||
) |
Makes an encoded list of strings from an array.
These can be used to make conjunctions or disjunctions on SQL condition strings derived from an array (see IDatabase::select() $conds documentation).
Example usage:
This would set $sql to "rev_page = '$id' AND (rev_minor = '1' OR rev_len < '500')"
array | $a | Containing the data |
int | $mode | IDatabase class constant:
|
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\DependencyStore\SqlModuleDependencyStore\fetchDependencyBlobs(), WatchedItemQueryService\getExtraDeletedPageLogEntryRelatedCond(), WatchedItemQueryService\getFromUntilTargetConds(), UppercaseTitlesForUnicodeTransition\getLikeBatches(), WatchedItemQueryService\getStartFromConds(), WANCacheReapUpdate\getTitleChangeEvents(), WatchedItemStore\getVisitingWatchersCondition(), WatchedItemQueryService\getWatchedItemsWithRCInfoQueryConds(), ActorMigration\getWhere(), 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, however it's assumed that $baseKey is probably an integer-typed column (i.e. integer keys are unquoted in the SQL) and $subKey is string-typed (i.e. integer keys are quoted as strings in the SQL).
array | $data | Organized as 2-d [ baseKeyVal => [ subKeyVal => [ignored], ... ], ... ] |
string | $baseKey | Field name to match the base-level keys to (eg 'pl_namespace') |
string | $subKey | Field name to match the sub-level keys to (eg 'pl_title') |
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.
Note that this does not start any new transactions. If any existing transaction is flushed, and this is called, then queries will reflect the point the DB was synced up to (on success) without interference from REPEATABLE-READ snapshots.
DBMasterPos | $pos | |
int | $timeout | The maximum number of seconds to wait for synchronisation |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\waitForMasterPos().
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::newSelectQueryBuilder | ( | ) |
Create an empty SelectQueryBuilder which can be used to run queries against this connection.
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::nextSequenceValue | ( | $seqName | ) |
Deprecated method, calls should be removed.
This was formerly used for PostgreSQL to handle self::insertId() auto-incrementing fields. It is no longer necessary since DatabasePostgres::insertId() has been reimplemented using lastval()
Implementations should return null if inserting NULL
into an auto-incrementing field works, otherwise it should return an instance of NextSequenceValue and filter it on calls to relevant methods.
string | $seqName |
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 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 query result.
Returns zero if the query did not return any rows or was a write query.
mixed | $res | A SQL result |
Implemented in Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\Database\executeQueryAttempt(), and Wikimedia\Rdbms\Database\selectRow().
Wikimedia\Rdbms\IDatabase::onAtomicSectionCancel | ( | callable | $callback, |
$fname = __METHOD__ |
|||
) |
Run a callback when the atomic section is cancelled.
The callback is run just after the current atomic section, any outer atomic section, or the whole transaction is rolled back.
An error is thrown if no atomic section is pending. The atomic section need not have been created with the ATOMIC_CANCELABLE flag.
Queries in the function may be running in the context of an outer transaction or may be running in AUTOCOMMIT mode. The callback should use atomic sections if necessary.
The callback takes the following arguments:
callable | $callback | |
string | $fname | Caller name |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by MediaWiki\Storage\NameTableStore\retryStore().
Wikimedia\Rdbms\IDatabase::onTransactionCommitOrIdle | ( | 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.
When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.
Queries in the function will run in AUTOCOMMIT mode unless there are begin() calls. Callbacks must commit any transactions that they begin.
This is useful for updates to different systems or when separate transactions are needed. For example, one might want to enqueue jobs into a system outside the database, but only after the database is updated so that the jobs will see the data when they actually run. It can also be used for updates that easily suffer from lock timeouts and deadlocks, but where atomicity is not essential.
Avoid using IDatabase instances aside from this one in the callback, unless such instances never have IDatabase::DBO_TRX set. This keeps callbacks from interfering with one another.
Updates will execute in the order they were enqueued.
The callback takes the following arguments:
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, see IDatabase::query() |
Exception | If the callback runs immediately and an error occurs in it |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::onTransactionIdle | ( | callable | $callback, |
$fname = __METHOD__ |
|||
) |
Alias for onTransactionCommitOrIdle() for backwards-compatibility.
callable | $callback | |
string | $fname |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
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.
When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just before all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.
Callbacks must not start nor commit any transactions. If no transaction is active, then a transaction will wrap the callback.
This is useful for updates that easily suffer from lock timeouts and deadlocks, but where atomicity is strongly desired for these updates and some related updates.
Updates will execute in the order they were enqueued.
The callback takes the one argument:
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, see IDatabase::query() |
Exception | If the callback runs immediately and an error occurs in it |
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 AUTOCOMMIT mode unless there are begin() calls. Callbacks must commit any transactions that they begin.
This is useful for combining cooperative locks and DB transactions.
Note this is called when the whole transaction is resolved. To take action immediately when an atomic section is cancelled, use onAtomicSectionCancel().
The callback takes the following arguments:
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, see IDatabase::query() |
Exception | If the callback runs immediately and an error occurs in it |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by AtomicSectionUpdate\__construct(), AutoCommitUpdate\__construct(), and MediaWiki\Revision\RevisionStore\insertRevisionRowOn().
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 values 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::preCommitCallbacksPending | ( | ) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::query | ( | $sql, | |
$fname = __METHOD__ , |
|||
$flags = 0 |
|||
) |
Run an SQL query and return the result.
If a connection loss is detected, then an attempt to reconnect will be made. For queries that involve no larger transactions or locks, they will be re-issued for convenience, provided the connection was re-established.
In new code, the query wrappers select(), insert(), update(), delete(), etc. should be used where possible, since they give much better DBMS independence and automatically quote or validate user input in a variety of contexts. This function is generally only useful for queries which are explicitly DBMS-dependent and are unsupported by the query wrappers, such as CREATE TABLE.
However, the query wrappers themselves should call this function.
string | $sql | SQL query |
string | $fname | Name of the calling function, for profiling/SHOW PROCESSLIST comment (you can use METHOD or add some extra info) |
int | $flags | Bitfield of IDatabase::QUERY_* constants. Note that suppression of errors is best handled by try/catch rather than using one of these flags. |
DBQueryError | If the query is issued, fails, and QUERY_SILENCE_ERRORS is not set. |
DBExpectedError | If the query is not, and cannot, be issued yet (non-DBQueryError) |
DBError | If the query is inherently not allowed (non-DBExpectedError) |
Implemented in Wikimedia\Rdbms\DBConnRef, and Wikimedia\Rdbms\Database.
Referenced by MySqlLockManager\initConnection(), SqlBagOStuff\initSqliteDatabase(), MediaWiki\Revision\RevisionStore\insertRevisionRowOn(), and MwSql\sqlDoQuery().
Wikimedia\Rdbms\IDatabase::replace | ( | $table, | |
$uniqueKeys, | |||
$rows, | |||
$fname = __METHOD__ |
|||
) |
Insert row(s) into a table, deleting all conflicting rows beforehand.
Note some important implications of the deletion semantics:
string | $table | The table name |
string | string[] | string[][] | $uniqueKeys | Column name or non-empty list of column name lists that define all applicable unique keys on the table. Each unique key on the table is "applicable" unless either:
|
array | array[] | $rows | Row(s) to insert, in the form of either:
|
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by WatchedItemStore\duplicateEntry().
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.
Wikimedia\Rdbms\IDatabase::rollback | ( | $fname = __METHOD__ , |
|
$flush = self::FLUSHING_ONE |
|||
) |
Rollback a transaction previously started using begin()
Only call this from code with outer transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported. If a serious unexpected error occurs, throwing an Exception is preferrable, using a pre-installed error handler to trigger rollback (in any case, failure to issue COMMIT will cause rollback server-side).
Query, connection, and onTransaction* callback errors will be suppressed and logged.
string | $fname | Calling function name |
string | $flush | Flush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about calling rollback when no transaction is in progress. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context. |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by SqlBagOStuff\initSqliteDatabase(), PopulateArchiveRevId\makeDummyRevisionRow(), Wikimedia\Rdbms\LoadBalancer\rollbackMasterChanges(), and Maintenance\rollbackTransaction().
Wikimedia\Rdbms\IDatabase::select | ( | $table, | |
$vars, | |||
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Execute a SELECT query constructed using the various parameters provided.
string | array | $table | Table name(s) |
May be either an array of table names, or a single string holding a table name. If an array is given, table aliases can be specified, for example:
[ 'a' => 'user' ]
This includes the user table in the query, with the alias "a" available for use in field names (e.g. a.user_name).
A derived table, defined by the result of selectSQLText(), requires an alias key and a Subquery instance value which wraps the SQL query, for example:
[ 'c' => new Subquery( 'SELECT ...' ) ]
Joins using parentheses for grouping (since MediaWiki 1.31) may be constructed using nested arrays. For example,
[ 'tableA', 'nestedB' => [ 'tableB', 'b2' => 'tableB2' ] ]
along with $join_conds
like
[ 'b2' => [ 'JOIN', 'b_id = b2_id' ], 'nestedB' => [ 'LEFT JOIN', 'b_a = a_id' ] ]
will produce SQL something like
FROM tableA LEFT JOIN (tableB JOIN tableB2 AS b2 ON (b_id = b2_id)) ON (b_a = a_id)
All of the table names given here are automatically run through Database::tableName(), which causes the table prefix (if any) to be added, and various other table name mappings to be performed.
Do not use untrusted user input as a table name. Alias names should not have characters outside of the Basic multilingual plane.
string | array | $vars | Field name(s) |
May be either a field name or an array of field names. The field names can be complete fragments of SQL, for direct inclusion into the SELECT query. If an array is given, field aliases can be specified, for example:
[ 'maxrev' => 'MAX(rev_id)' ]
This includes an expression with the alias "maxrev" in the query.
If an expression is given, care must be taken to ensure that it is DBMS-independent.
Untrusted user input must not be passed to this parameter.
string | array | $conds |
May be either a string containing a single condition, or an array of conditions. If an array is given, the conditions constructed from each element are combined with AND.
Array elements may take one of two forms:
Note that expressions are often DBMS-dependent in their syntax. DBMS-independent wrappers are provided for constructing several types of expression commonly used in condition queries. See:
Untrusted user input is safe in the values of string keys, however untrusted input must not be used in the array key names or in the values of numeric keys. Escaping of untrusted input used in values of numeric keys should be done via IDatabase::addQuotes()
Use an empty array, string, or IDatabase::ALL_ROWS to select all rows.
string | $fname | Caller function name |
string | array | $options | Query options |
Optional: Array of query options. Boolean options are specified by including them in the array as a string value with a numeric key, for example:
[ 'FOR UPDATE' ]
The supported options are:
And also the following boolean MySQL extensions, see the MySQL manual for documentation:
string | array | $join_conds | Join conditions |
Optional associative array of table-specific join conditions. In the most common case, this is unnecessary, since the join condition can be in $conds. However, it is useful for doing a LEFT JOIN.
The key of the array contains the table name or alias. The value is an array with two elements, numbered 0 and 1. The first gives the type of join, the second is the same as the $conds parameter. Thus it can be an SQL fragment, or an array where the string keys are equality and the numeric keys are SQL fragments all AND'd together. For example:
[ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by MigrateActors\addActorsForRows(), SqlBagOStuff\deleteServerObjectsExpiringBefore(), JobQueueDB\doBatchPushInternal(), DBFileJournal\doGetChangeEntries(), RefreshImageMetadata\execute(), Wikimedia\DependencyStore\SqlModuleDependencyStore\fetchDependencyBlobs(), ResourceLoaderWikiModule\fetchTitleInfo(), WANCacheReapUpdate\getTitleChangeEvents(), MigrateComments\loadCommentIDs(), MediaWiki\Storage\NameTableStore\loadTable(), DeduplicateArchiveRevId\processArRevIds(), UppercaseTitlesForUnicodeTransition\processTable(), WatchedItemStore\updateExpiriesAfterMove(), and MediaWiki\Revision\RevisionStore\userWasLastToEdit().
Wikimedia\Rdbms\IDatabase::selectDB | ( | $db | ) |
Change the current database.
This should only be called by a load balancer or if the handle is not attached to one
string | $db |
DBConnectionError | If databasesAreIndependent() is true and connection change fails |
DBError | On query error or if database changes are disallowed |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::selectDomain | ( | $domain | ) |
Set the current domain (database, schema, and table prefix)
This will throw an error for some database types if the database is unspecified
This should only be called by a load balancer or if the handle is not attached to one
string | DatabaseDomain | $domain |
DBConnectionError | If databasesAreIndependent() is true and connection change fails |
DBError | On query error, if domain changes are disallowed, or the domain is invalid |
Implemented in Wikimedia\Rdbms\Database, 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.
If no result rows are returned from the query, false is returned.
string | array | $table | Table name. See IDatabase::select() for details. |
string | $var | The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. |
string | array | $cond | The condition array. See IDatabase::select() for details. |
string | $fname | The function name of the caller. |
string | array | $options | The query options. See IDatabase::select() for details. |
string | array | $join_conds | The query join conditions. See IDatabase::select() for details. |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by User\addToDatabase(), PopulateArchiveRevId\checkMysqlAutoIncrementBug(), CommentStore\createComment(), DBFileJournal\doGetCurrentPosition(), DBFileJournal\doGetPositionAtTime(), ActorMigration\getNewActorId(), MediaWiki\Revision\RevisionStore\getPreviousRevisionId(), MediaWiki\Revision\RevisionStore\insertRevisionRowOn(), UppercaseTitlesForUnicodeTransition\isUserPage(), PopulateArchiveRevId\makeDummyRevisionRow(), and MediaWiki\Revision\RevisionStore\newNullRevision().
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.
If no result rows are returned from the query, an empty array is returned.
string | array | $table | Table name. See IDatabase::select() for details. |
string | $var | The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. |
string | array | $cond | The condition array. See IDatabase::select() for details. |
string | $fname | The function name of the caller. |
string | array | $options | The query options. See IDatabase::select() for details. |
string | array | $join_conds | The query join conditions. See IDatabase::select() for details. |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by ChangeTags\getTags(), PurgeJobUtils\invalidatePages(), UppercaseTitlesForUnicodeTransition\processUsers(), MediaWiki\Block\DatabaseBlock\purgeExpired(), Title\purgeExpiredRestrictions(), PopulateArchiveRevId\reassignArRevIds(), and WatchedItemStore\updateNotificationTimestamp().
Wikimedia\Rdbms\IDatabase::selectRow | ( | $table, | |
$vars, | |||
$conds, | |||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Wrapper to IDatabase::select() that only fetches one row (via LIMIT)
If the query returns no rows, false is returned.
This method is convenient for fetching a row based on a unique key condition.
string | array | $table | Table name |
string | array | $vars | Field names |
string | array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
array | string | $join_conds | Join conditions |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by MediaWiki\Revision\RevisionStore\countRevisionsByPageId(), SiteStats\doLoadFromDB(), LinkCache\fetchPageRow(), MediaWiki\Revision\RevisionStore\fetchRevisionRowFromConds(), CommentStore\getCommentInternal(), ActorMigration\getExistingActorId(), PopulateArchiveRevId\makeDummyRevisionRow(), DatabaseLogEntry\newFromId(), User\newSystemUser(), and UppercaseTitlesForUnicodeTransition\shouldDelete().
Wikimedia\Rdbms\IDatabase::selectRowCount | ( | $tables, | |
$var = ' *' , |
|||
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Get the number of rows in dataset.
This is useful when trying to do COUNT(*) but with a LIMIT for performance.
Takes the same arguments as IDatabase::select().
string | string[] | $tables | Table name(s) |
string | $var | Column for which NULL values are not counted [default "*"] |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select |
array | $join_conds | Join conditions (since 1.27) |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by PopulateArchiveRevId\isNewInstall().
Wikimedia\Rdbms\IDatabase::selectSQLText | ( | $table, | |
$vars, | |||
$conds = '' , |
|||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Take the same arguments as IDatabase::select() and return the SQL it would use.
This can be useful for making UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().
string | array | $table | Table name |
string | array | $vars | Field names |
string | array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
string | array | $join_conds | Join conditions |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Referenced by MediaWiki\Revision\RevisionStore\insertRevisionRowOn().
Wikimedia\Rdbms\IDatabase::serverIsReadOnly | ( | ) |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\isMasterConnectionReadOnly().
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 | One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX) |
string | $remember | IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING] |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by DatabaseUpdater\__construct(), and JobQueueDB\getScopedNoTrxFlag().
Wikimedia\Rdbms\IDatabase::setIndexAliases | ( | array | $aliases | ) |
Convert certain index names to alternative names before querying the DB.
Note that this applies to indexes regardless of the table they belong to.
This can be employed when an index was renamed X => Y in code, but the new Y-named indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA, the aliases can be removed, and then the old X-named indexes dropped.
string[] | $aliases |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::setLBInfo | ( | $nameOrArray, | |
$value = null |
|||
) |
Set the entire array or a particular key of the managing load balancer info array.
Keys matching the IDatabase::LB_* constants are also used internally by subclasses
array | string | $nameOrArray | The new array or the name of a key to set |
array | null | $value | If $nameOrArray is a string, the new key value (null to unset) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\reuseConnection().
Wikimedia\Rdbms\IDatabase::setSchemaVars | ( | $vars | ) |
Set schema variables to be used when streaming commands from SQL files or stdin.
Variables appear as SQL comments and are substituted by their corresponding values
array | null | $vars | Map of (variable => value) or null to use the defaults |
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 |
DBError | If an error occurs, see IDatabase::query() |
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, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::setTransactionListener | ( | $name, | |
callable | $callback = null |
||
) |
Run a callback after each time any transaction commits or rolls back.
The callback takes two arguments:
Registering a callback here will not affect writesOrCallbacks() pending.
Since callbacks from this or onTransactionCommitOrIdle() can start and end transactions, a single call to IDatabase::commit might trigger multiple runs of the listener callbacks.
string | $name | Callback name |
callable | null | $callback | Use null to unset a listener |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\setTransactionListener().
Wikimedia\Rdbms\IDatabase::startAtomic | ( | $fname = __METHOD__ , |
|
$cancelable = self::ATOMIC_NOT_CANCELABLE |
|||
) |
Begin an atomic section of SQL statements.
Start an implicit transaction if no transaction is already active, set a savepoint (if $cancelable is ATOMIC_CANCELABLE), and track the given section name to enforce that the transaction is not committed prematurely. The end of the section must be signified exactly once, either by endAtomic() or cancelAtomic(). Sections can have have layers of inner sections (sub-sections), but all sections must be ended in order of innermost to outermost. Transactions cannot be started or committed until all atomic sections are closed.
ATOMIC_CANCELABLE is useful when the caller needs to handle specific failure cases by discarding the section's writes. This should not be used for failures when:
Example usage:
Example usage (atomic changes that might have to be discarded):
string | $fname | |
string | $cancelable | Pass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section. |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\DBConnRef, and Wikimedia\Rdbms\Database.
Referenced by JobQueueDB\doBatchPushInternal(), LCStoreDB\finishWrite(), MySqlLockManager\initConnection(), and SqlBagOStuff\initSqliteDatabase().
Wikimedia\Rdbms\IDatabase::strreplace | ( | $orig, | |
$old, | |||
$new | |||
) |
Returns a SQL expression for simple string replacement (e.g.
REPLACE() in mysql)
string | $orig | Column to modify |
string | $old | Column to seek |
string | $new | Column to replace with |
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 |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by SqlBagOStuff\getConnectionFromServerInfo(), and SqlBagOStuff\initSqliteDatabase().
Wikimedia\Rdbms\IDatabase::tablePrefix | ( | $prefix = null | ) |
Get/set the table prefix.
string | null | $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(), and SqlBagOStuff\initSqliteDatabase().
Wikimedia\Rdbms\IDatabase::timestamp | ( | $ts = 0 | ) |
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.
The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
string | int | $ts |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabasePostgres, and Wikimedia\Rdbms\DBConnRef.
Referenced by User\addToDatabase(), SqlBagOStuff\deleteServerObjectsExpiringBefore(), DBFileJournal\doGetPositionAtTime(), DBFileJournal\doLogChangeBatch(), DBFileJournal\doPurgeOldLogs(), WatchedItemStore\fetchWatchedItems(), MediaWiki\Revision\RevisionStore\getBaseRevisionRow(), MediaWiki\Block\DatabaseBlock\getDatabaseArray(), WatchedItemQueryService\getStartEndConds(), WatchedItemQueryService\getStartFromConds(), WANCacheReapUpdate\getTitleChangeEvents(), WatchedItemStore\getVisitingWatchersCondition(), WatchedItemQueryService\getWatchedItemsWithRCInfoQueryConds(), JobQueueDB\insertFields(), MediaWiki\Revision\RevisionStore\insertIpChangesRow(), Title\invalidateCache(), PurgeJobUtils\invalidatePages(), MediaWiki\Revision\RevisionStore\loadRevisionFromTimestamp(), PopulateArchiveRevId\makeDummyRevisionRow(), User\makeUpdateConditions(), MediaWiki\Block\DatabaseBlock\purgeExpired(), Title\purgeExpiredRestrictions(), QueryPage\recache(), User\saveSettings(), WatchedItemStore\setNotificationTimestampsForUser(), WatchedItemStore\updateNotificationTimestamp(), and MediaWiki\Revision\RevisionStore\userWasLastToEdit().
Wikimedia\Rdbms\IDatabase::timestampOrNull | ( | $ts = null | ) |
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.
If NULL is input, it is passed through, allowing NULL values to be inserted into timestamp fields.
The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
string | int | null | $ts |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by User\addToDatabase(), and User\saveSettings().
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.
Referenced by Wikimedia\Rdbms\LoadBalancer\enforceConnectionFlags().
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. Callers can assume that if a view-snapshot isolation is used, then the data read by SQL queries is at least up to date to that point (possibly more up-to-date since the first SELECT defines the snapshot).
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 | Either IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::unionSupportsOrderAndLimit | ( | ) |
Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.
Implemented in Wikimedia\Rdbms\Database, 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 |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, Wikimedia\Rdbms\DatabaseSqlite, and Wikimedia\Rdbms\DBConnRef.
Referenced by MediaWiki\Revision\RevisionStore\insertRevisionRowOn().
Wikimedia\Rdbms\IDatabase::update | ( | $table, | |
$set, | |||
$conds, | |||
$fname = __METHOD__ , |
|||
$options = [] |
|||
) |
Update all rows in a table that match a given condition.
string | $table | Table name |
array | $set | Combination map/list where each string-keyed entry maps a column to a literal assigned value and each integer-keyed value is a SQL expression in the format of a column assignment within UPDATE...SET. The (column => value) entries are convenient due to automatic value quoting and conversion of null to NULL. The SQL assignment format is useful for updates like "column = column + X". All assignments have no defined execution order, so they should not depend on each other. Do not modify AUTOINCREMENT or UUID columns in assignments. |
array | string | $conds | Condition in the format of IDatabase::select() conditions. In order to prevent possible performance or replication issues or damaging a data accidentally, an empty condition for 'update' queries isn't allowed. IDatabase::ALL_ROWS should be passed explicitely in order to update all rows. |
string | $fname | Calling function name (use METHOD) for logs/profiling |
string | array | $options | Combination map/list where each string-keyed entry maps a non-boolean option to the option parameters and each integer-keyed value is the name of a boolean option. Supported options are:
|
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by SiteStatsUpdate\cacheUpdate(), LocalFileMoveBatch\doDBUpdates(), UppercaseTitlesForUnicodeTransition\doMove(), SiteStatsUpdate\doUpdate(), UppercaseTitlesForUnicodeTransition\doUpdate(), Title\invalidateCache(), PurgeJobUtils\invalidatePages(), User\newSystemUser(), DeleteLocalPasswords\processUsers(), PopulateArchiveRevId\reassignArRevIds(), User\saveSettings(), WatchedItemStore\setNotificationTimestampsForUser(), and WatchedItemStore\updateNotificationTimestamp().
Wikimedia\Rdbms\IDatabase::upsert | ( | $table, | |
array | $rows, | ||
$uniqueKeys, | |||
array | $set, | ||
$fname = __METHOD__ |
|||
) |
Upsert the given row(s) into a table.
This updates any existing rows that conflict with the provided rows and inserts any of the provided rows that do not conflict with existing rows. Conflicts are determined by the provided unique indexes.
string | $table | Table name |
array | array[] | $rows | Row(s) to insert, in the form of either:
|
string | string[] | string[][] | $uniqueKeys | Column name or non-empty list of column name lists that define all applicable unique keys on the table. Each unique key on the table is "applicable" unless either:
|
array | $set | Combination map/list where each string-keyed entry maps a column to a literal assigned value and each integer-keyed value is a SQL expression in the format of a column assignment within UPDATE...SET. The (column => value) entries are convenient due to automatic value quoting and conversion of null to NULL. The SQL assignment format is useful for updates like "column = column + X". All assignments have no defined execution order, so they should not depend on each other. Do not modified AUTOINCREMENT or UUID columns in assignments. |
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, see IDatabase::query() |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by ActorMigration\getInsertValuesWithTempTable().
Wikimedia\Rdbms\IDatabase::wasConnectionLoss | ( | ) |
Determines if the last query error was due to a dropped connection.
Note that during a connection loss, the prior transaction will have been lost
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::wasDeadlock | ( | ) |
Determines if the last failure was due to a deadlock.
Note that during a deadlock, the prior transaction will have been lost
Implemented in 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 something outside of the query itself.
Note that the transaction may have been lost, discarding prior writes and results
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Wikimedia\Rdbms\IDatabase::wasLockTimeout | ( | ) |
Determines if the last failure was due to a lock timeout.
Note that during a lock wait timeout, the prior transaction will have been lost
Implemented in Wikimedia\Rdbms\Database, Wikimedia\Rdbms\DatabaseMysqlBase, Wikimedia\Rdbms\DatabasePostgres, 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.
Referenced by LCStoreDB\finishWrite().
Wikimedia\Rdbms\IDatabase::writesOrCallbacksPending | ( | ) |
Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending.
This does not count recurring callbacks, e.g. from setTransactionListener().
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.
Referenced by Wikimedia\Rdbms\LoadBalancer\approveMasterChanges(), DeferredUpdates\areDatabaseTransactionsActive(), and Wikimedia\Rdbms\LoadBalancer\hasMasterChanges().
Wikimedia\Rdbms\IDatabase::writesPending | ( | ) |
Implemented in Wikimedia\Rdbms\Database, and Wikimedia\Rdbms\DBConnRef.