MediaWiki REL1_39
|
Helper class used for automatically marking an IDatabase connection as reusable (once it no longer matters which DB domain is selected) and for deferring the actual network connection. More...
Public Member Functions | |
__call ( $name, array $arguments) | |
__construct (ILoadBalancer $lb, $params, $role, &$modcount=0) | |
__destruct () | |
Clean up the connection when out of scope. | |
__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. | |
anyChar () | |
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. | |
anyString () | |
Returns a token for buildLike() that denotes a '' to be used in a LIKE query. | |
begin ( $fname=__METHOD__, $mode=IDatabase::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. | |
buildExcludedValue ( $column) | |
Build a reference to a column value from the conflicting proposed upsert() row. | |
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) | |
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__) | |
Close the database connection. | |
commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |
Commits a transaction previously started using begin() | |
conditional ( $cond, $caseTrueExpression, $caseFalseExpression) | |
Returns an SQL expression for a simple conditional. | |
databasesAreIndependent () | |
Returns true if DBs are assumed to be on potentially different servers. | |
dbSchema ( $schema=null) | |
Get/set the db schema. | |
deadlockLoop (... $args) | |
Perform a deadlock-prone transaction. | |
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 all rows in a table that match a condition which includes a join. | |
doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE) | |
Perform an atomic section of reversible SQL statements from a callback. | |
dropTable ( $table, $fname=__METHOD__) | |
Delete a table. | |
duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__) | |
Creates a new table with structure copied from existing table. | |
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. | |
ensureConnection () | |
Connect to the database if we are not already connected. | |
estimateRowCount ( $tables, $vars=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Estimate the number of rows in dataset. | |
explicitTrxActive () | |
Check whether there is a transaction open at the specific request of a caller. | |
factorConds ( $condsArray) | |
Given an array of condition arrays representing an OR list of AND lists, for example: | |
fieldExists ( $table, $field, $fname=__METHOD__) | |
Determines whether a field exists in a table. | |
fieldInfo ( $table, $field) | |
Get information about a field Returns false if the field doesn't exist. | |
flushSession ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |
Release important session-level state (named lock, table locks) as post-rollback cleanup. | |
flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE) | |
Commit any transaction but error out if writes or callbacks are pending. | |
getDBname () | |
Get the current database name; null if there isn't one. | |
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. | |
getPrimaryPos () | |
Get the position of this primary DB. | |
getProperty ( $name) | |
getReferenceRole () | |
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 hostname or IP address of the server. | |
getServerInfo () | |
Get a human-readable string describing the current software version. | |
getServerName () | |
Get the readable name for the server. | |
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. | |
getTableAliases () | |
Return current table aliases. | |
getTopologyBasedServerId () | |
Get a non-recycled ID that uniquely identifies this server within the replication topology. | |
getTopologyRole () | |
Get the replication topology role of this server. | |
getType () | |
Get the RDBMS type of the server (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. | |
indexUnique ( $table, $index, $fname=__METHOD__) | |
Determines if a given index is unique. | |
insert ( $table, $rows, $fname=__METHOD__, $options=[]) | |
Insert row(s) into a table, in the provided order. | |
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 RDBMS-specific error code from the last query statement. | |
lastError () | |
Get the RDBMS-specific error description from the last query statement. | |
lastQuery () | |
Get the last query that sent on account of IDatabase::query() | |
limitResult ( $sql, $limit, $offset=false) | |
Construct a LIMIT query with optional offset. | |
listTables ( $prefix=null, $fname=__METHOD__) | |
List all tables on the database. | |
listViews ( $prefix=null, $fname=__METHOD__) | |
Lists all the VIEWs in the database. | |
lock ( $lockName, $method, $timeout=5, $flags=0) | |
Acquire a named lock. | |
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. | |
namedLocksEnqueue () | |
Check to see if a named lock used by lock() use blocking queues. | |
newSelectQueryBuilder () | |
Create an empty SelectQueryBuilder which can be used to run queries against this connection. | |
nextSequenceValue ( $seqName) | |
Deprecated method, calls should be removed. | |
onAtomicSectionCancel (callable $callback, $fname=__METHOD__) | |
Run a callback when the atomic section is cancelled. | |
onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__) | |
Run a callback when the current transaction commits or now if there is none. | |
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 when 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. | |
ping (&$rtt=null) | |
Ping the server and try to reconnect if it there is no connection. | |
primaryPosWait (DBPrimaryPos $pos, $timeout) | |
Wait for the replica DB to catch up to a given primary DB position. | |
query ( $sql, $fname=__METHOD__, $flags=0) | |
Run an SQL query statement and return the result. | |
queryMulti (array $sqls, string $fname=__METHOD__, int $flags=0, ?string $summarySql=null) | |
Run a batch of SQL query statements and return the results. | |
replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__) | |
Insert row(s) into a table, in the provided order, while deleting conflicting rows. | |
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, $vars=' *', $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. | |
sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null) | |
Read and execute SQL commands from a file. | |
sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null) | |
Read and execute commands from an open file handle. | |
startAtomic ( $fname=__METHOD__, $cancelable=IDatabase::ATOMIC_NOT_CANCELABLE) | |
Begin an atomic section of SQL statements. | |
streamStatementEnd (&$sql, &$newLine) | |
Called by sourceStream() to check if we've reached a statement end. | |
strreplace ( $orig, $old, $new) | |
Returns a SQL expression for simple string replacement (e.g. | |
tableExists ( $table, $fname=__METHOD__) | |
Query whether a given table exists. | |
tableName ( $name, $format='quoted') | |
Format a table name ready for use in constructing an SQL query. | |
tableNames (... $tables) | |
Fetch a number of table names into an associative array. | |
tableNamesN (... $tables) | |
Fetch a number of table names into a zero-indexed numerical array. | |
tablePrefix ( $prefix=null) | |
Get/set the table prefix. | |
textFieldSize ( $table, $field) | |
Returns the size of a text field, or -1 for "unlimited". | |
timestamp ( $ts=0) | |
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. | |
timestampOrNull ( $ts=null) | |
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. | |
truncate ( $tables, $fname=__METHOD__) | |
Delete all data in a table(s) and reset any sequences owned by that table(s) | |
trxLevel () | |
Gets the current transaction level. | |
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 row(s) into a table, in the provided order, while updating conflicting rows. | |
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 () | |
Public Member Functions inherited from Wikimedia\Rdbms\Platform\ISQLPlatform | |
buildSubString ( $input, $startPosition, $length=null) | |
Build a SUBSTRING function. | |
Protected Member Functions | |
assertRoleAllowsWrites () | |
Error out if the role is not DB_PRIMARY. | |
getDomainChangeException () | |
normalizeServerIndex ( $i) | |
Additional Inherited Members | |
Public Attributes inherited from Wikimedia\Rdbms\IDatabase | |
const | LOCK_TIMESTAMP = 1 |
Flag to return the lock acquisition timestamp (null if not acquired) | |
Public Attributes inherited from Wikimedia\Rdbms\Platform\ISQLPlatform | |
const | QUERY_PSEUDO_PERMANENT = 2 |
Track a TEMPORARY table CREATE as if it was for a permanent table (for testing) | |
Helper class used for automatically marking an IDatabase connection as reusable (once it no longer matters which DB domain is selected) and for deferring the actual network connection.
This uses an RAII-style pattern where calling code is expected to keep the returned reference handle as a function variable that falls out of scope when no longer needed. This avoids the need for matching reuseConnection() calls for every "return" statement as well as the tedious use of try/finally.
Definition at line 29 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::__construct | ( | ILoadBalancer | $lb, |
$params, | |||
$role, | |||
& | $modcount = 0 ) |
ILoadBalancer | $lb | Connection manager for $conn |
array | $params | [server index, query groups, domain, flags] |
int | $role | The type of connection asked for; one of DB_PRIMARY/DB_REPLICA |
null | int | &$modcount | Reference to a modification counter. This is for LoadBalancer::reconfigure to indicate that a new connection should be acquired. |
Definition at line 64 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::__destruct | ( | ) |
Clean up the connection when out of scope.
Definition at line 923 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::__call | ( | $name, | |
array | $arguments ) |
Definition at line 100 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\ensureConnection().
Referenced by Wikimedia\Rdbms\DBConnRef\affectedRows(), Wikimedia\Rdbms\DBConnRef\clearFlag(), Wikimedia\Rdbms\DBConnRef\dbSchema(), Wikimedia\Rdbms\DBConnRef\explicitTrxActive(), Wikimedia\Rdbms\DBConnRef\getDomainID(), Wikimedia\Rdbms\DBConnRef\getFlag(), Wikimedia\Rdbms\DBConnRef\getLBInfo(), Wikimedia\Rdbms\DBConnRef\getProperty(), Wikimedia\Rdbms\DBConnRef\getServerInfo(), Wikimedia\Rdbms\DBConnRef\getServerVersion(), Wikimedia\Rdbms\DBConnRef\getSoftwareLink(), Wikimedia\Rdbms\DBConnRef\getTopologyBasedServerId(), Wikimedia\Rdbms\DBConnRef\getTopologyRole(), Wikimedia\Rdbms\DBConnRef\getType(), Wikimedia\Rdbms\DBConnRef\implicitOrderby(), Wikimedia\Rdbms\DBConnRef\insertId(), Wikimedia\Rdbms\DBConnRef\isOpen(), Wikimedia\Rdbms\DBConnRef\lastDoneWrites(), Wikimedia\Rdbms\DBConnRef\lastErrno(), Wikimedia\Rdbms\DBConnRef\lastError(), Wikimedia\Rdbms\DBConnRef\lastQuery(), Wikimedia\Rdbms\DBConnRef\pendingWriteCallers(), Wikimedia\Rdbms\DBConnRef\pendingWriteQueryDuration(), Wikimedia\Rdbms\DBConnRef\query(), Wikimedia\Rdbms\DBConnRef\queryMulti(), Wikimedia\Rdbms\DBConnRef\restoreFlags(), Wikimedia\Rdbms\DBConnRef\setFlag(), Wikimedia\Rdbms\DBConnRef\tablePrefix(), Wikimedia\Rdbms\DBConnRef\trxLevel(), Wikimedia\Rdbms\DBConnRef\trxTimestamp(), Wikimedia\Rdbms\DBConnRef\writesOrCallbacksPending(), and Wikimedia\Rdbms\DBConnRef\writesPending().
Wikimedia\Rdbms\DBConnRef::__toString | ( | ) |
Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 872 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::addIdentifierQuotes | ( | $s | ) |
Escape a SQL identifier (e.g.
table, column, database) for use in a SQL query
Depending on the database this will either be backticks
or "double quotes"
string | $s |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 503 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::addQuotes | ( | $s | ) |
Escape and quote a raw value string for use in a SQL query.
string | int | float | null | bool | Blob | $s |
Implements Wikimedia\Rdbms\Database\DbQuoter.
Definition at line 499 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::affectedRows | ( | ) |
Get the number of rows affected by the last write query.
Similar to https://www.php.net/mysql_affected_rows but includes rows matched but not changed (ie. an UPDATE which sets all fields to the same value they already have). To get the old mysql_affected_rows behavior, include non-equality of the fields in WHERE.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 271 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::anyChar | ( | ) |
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 511 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::anyString | ( | ) |
Returns a token for buildLike() that denotes a '' to be used in a LIKE query.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 515 of file DBConnRef.php.
|
protected |
Error out if the role is not DB_PRIMARY.
Note that the underlying connection may or may not itself be read-only. It could even be to a writable primary (both server-side and to the application). This error is meant for the case when a DB_REPLICA handle was requested but a a write was attempted on that handle regardless.
In configurations where the primary DB has some generic read load or is the only server, DB_PRIMARY/DB_REPLICA will sometimes (or always) use the same connection to the primary DB. This does not effect the role of DBConnRef instances.
DBReadOnlyRoleError |
Definition at line 893 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::begin | ( | $fname = __METHOD__, | |
$mode = IDatabase::TRANSACTION_EXPLICIT ) |
Begin a transaction.
Only call this from code with outer transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.
Note that when the DBO_TRX flag is set (which is usually the case for web requests, but not for maintenance scripts), any previous database query will have started a transaction automatically.
Nesting of transactions is not supported. Attempts to nest transactions will cause a warning, unless the current transaction was started automatically because of the DBO_TRX flag.
string | $fname | Calling function name |
string | $mode | A situationally valid IDatabase::TRANSACTION_* constant [optional] |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 668 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::bitAnd | ( | $fieldLeft, | |
$fieldRight ) |
string | int | $fieldLeft | |
string | int | $fieldRight |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 407 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::bitNot | ( | $field | ) |
string | int | $field |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 403 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::bitOr | ( | $fieldLeft, | |
$fieldRight ) |
string | int | $fieldLeft | |
string | int | $fieldRight |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 411 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::buildConcat | ( | $stringList | ) |
Build a concatenation list to feed into a SQL query.
string[] | $stringList | Raw SQL expression list; caller is responsible for escaping |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 415 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::buildExcludedValue | ( | $column | ) |
Build a reference to a column value from the conflicting proposed upsert() row.
The reference comes in the form of an alias, function, or parenthesized SQL expression. It can be used in upsert() SET expressions to handle the merging of column values between each conflicting pair of existing and proposed rows. Such proposed rows are said to have been "excluded" from insertion in favor of updating the existing row.
This is useful for multi-row upserts() since the proposed values cannot just be included as literals in the SET expressions.
string | $column | Column name |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 445 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::buildGreatest | ( | $fields, | |
$values ) |
Build a GREATEST function statement comparing columns/values.
Integer and float values in $values will not be quoted
If $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
string | string[] | $fields | Name(s) of column(s) with values to compare |
string | int | float | string[] | int[] | float[] | $values | Values to compare |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 425 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::buildGroupConcatField | ( | $delim, | |
$table, | |||
$field, | |||
$conds = '', | |||
$join_conds = [] ) |
Build a GROUP_CONCAT or equivalent statement for a query.
This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.
string | $delim | Glue to bind the results together |
string | array | $table | Table name |
string | $field | Field name |
string | array | $conds | Conditions |
string | array | $join_conds | Join conditions |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 419 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::buildIntegerCast | ( | $field | ) |
string | $field | Field or column to cast |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 441 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::buildLeast | ( | $fields, | |
$values ) |
Build a LEAST function statement comparing columns/values.
Integer and float values in $values will not be quoted
If $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
string | string[] | $fields | Name(s) of column(s) with values to compare |
string | int | float | string[] | int[] | float[] | $values | Values to compare |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 429 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::buildLike | ( | $param, | |
$params ) |
LIKE statement wrapper.
This takes a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). Alternatively, the function could be provided with an array of aforementioned parameters.
Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches for subpages of 'My page title'. Alternatively: $pattern = [ 'My_page_title/', $dbr->anyString() ]; $query .= $dbr->buildLike( $pattern );
array[] | string | LikeMatch | $param | |
string|LikeMatch | ...$params |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 507 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::buildSelectSubquery | ( | $table, | |
$vars, | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery.
string | array | $table | Table name |
string | array | $vars | Field names |
string | array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
string | array | $join_conds | Join conditions |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 449 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::buildStringCast | ( | $field | ) |
string | $field | Field or column to cast |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 437 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::buildSubstring | ( | $input, | |
$startPosition, | |||
$length = null ) |
Definition at line 433 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 656 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::clearFlag | ( | $flag, | |
$remember = self::REMEMBER_NOTHING ) |
Clear a flag for this connection.
int | $flag | One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX) |
string | $remember | IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING] |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 220 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::close | ( | $fname = __METHOD__ | ) |
Close the database connection.
This should only be called after any transactions have been resolved, aside from read-only automatic transactions (assuming no callbacks are registered). If a transaction is still open anyway, it will be rolled back.
string | $fname | Caller name |
DBError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 283 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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 transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.
string | $fname | |
string | $flush | Flush flag, set to situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly committing implicit transactions, or calling commit when no transaction is in progress. This will trigger an exception if there is an ongoing explicit transaction. Only set the flush flag if you are sure that these warnings are not applicable, and no explicit transactions are open. |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 672 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::conditional | ( | $cond, | |
$caseTrueExpression, | |||
$caseFalseExpression ) |
Returns an SQL expression for a simple conditional.
This doesn't need to be overridden unless CASE isn't supported in the RDBMS.
string | array | $cond | SQL condition expression (yields a boolean) |
string | $caseTrueExpression | SQL expression to return when the condition is true |
string | $caseFalseExpression | SQL expression to return when the condition is false |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 577 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::databasesAreIndependent | ( | ) |
Returns true if DBs are assumed to be on potentially different servers.
In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 456 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::dbSchema | ( | $schema = null | ) |
Get/set the db schema.
string | null | $schema | The database schema to set, or omitted to leave it unchanged |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 156 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call(), Wikimedia\Rdbms\DBConnRef\getDomainChangeException(), and Wikimedia\Rdbms\DatabaseDomain\newFromId().
Wikimedia\Rdbms\DBConnRef::deadlockLoop | ( | $args | ) |
Perform a deadlock-prone transaction.
This function invokes a callback function to perform a set of write queries. If a deadlock occurs during the processing, the transaction will be rolled back and the callback function will be called again.
Avoid using this method outside of Job or Maintenance classes.
Usage: $dbw->deadlockLoop( callback, ... );
Extra arguments are passed through to the specified callback function. This method requires that no transactions are already active to avoid causing premature commits or exceptions.
Returns whatever the callback function returned on its successful, iteration, or false on error, for example if the retry limit was reached.
mixed | ...$args |
DBUnexpectedError | |
Exception |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 834 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::decodeBlob | ( | $b | ) |
Some DBMSs return a special placeholder object representing blob fields in result objects.
Pass the object through this function to return the original string.
string | Blob | $b |
DBError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 714 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::decodeExpiry | ( | $expiry, | |
$format = TS_MW ) |
Decode an expiry time into a DBMS independent format.
string | $expiry | DB timestamp field value for expiry |
int | $format | TS_* constant, defaults to TS_MW |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 762 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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 explicitly in order to delete all rows. |
string | $fname | Name of the calling function |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 547 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::deleteJoin | ( | $delTable, | |
$joinTable, | |||
$delVar, | |||
$joinVar, | |||
$conds, | |||
$fname = __METHOD__ ) |
Delete all rows in a table that match a condition which includes a join.
For safety, an empty $conds will not delete everything. If you want to delete all rows where the join condition matches, set $conds=IDatabase::ALL_ROWS.
DO NOT put the join condition in $conds.
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, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 539 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::doAtomicSection | ( | $fname, | |
callable | $callback, | ||
$cancelable = self::ATOMIC_NOT_CANCELABLE ) |
Perform an atomic section of reversible SQL statements from a callback.
The $callback takes the following arguments:
This will execute the callback inside a pair of startAtomic()/endAtomic() calls. If any exception occurs during execution of the callback, it will be handled as follows:
This method is convenient for letting calls to the caller of this method be wrapped in a try/catch blocks for exception types that imply that the caller failed but was able to properly discard the changes it made in the transaction. This method can be an alternative to explicit calls to startAtomic()/endAtomic()/cancelAtomic().
Example usage, "RecordStore::save" method:
Example usage, caller of the "RecordStore::save" method:
string | $fname | Caller name (usually METHOD) |
callable | $callback | Callback that issues DB updates |
string | $cancelable | Pass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section. |
DBError | If an error occurs, { |
Exception | If an error occurs in the callback |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 661 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::dropTable | ( | $table, | |
$fname = __METHOD__ ) |
Delete a table.
string | $table | |
string | $fname |
DBError | If an error occurs |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 822 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::duplicateTableStructure | ( | $oldName, | |
$newName, | |||
$temporary = false, | |||
$fname = __METHOD__ ) |
Creates a new table with structure copied from existing table.
Note that unlike most database abstraction functions, this function does not automatically append database prefix, because it works at a lower abstraction level. The table names passed to this function shall not be quoted (this function calls addIdentifierQuotes() when needed).
string | $oldName | Name of table whose structure should be copied |
string | $newName | Name of table to be created |
bool | $temporary | Whether the new table should be temporary |
string | $fname | Calling function name |
RuntimeException |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 852 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::encodeBlob | ( | $b | ) |
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.
To insert into such a field, pass the data through this function before passing it to IDatabase::insert().
string | $b |
DBError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 710 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::encodeExpiry | ( | $expiry | ) |
Encode an expiry time into the DBMS dependent format.
string | $expiry | Timestamp for expiry, or the 'infinity' string |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 758 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 651 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::ensureConnection | ( | ) |
Connect to the database if we are not already connected.
Definition at line 81 of file DBConnRef.php.
Referenced by Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::estimateRowCount | ( | $tables, | |
$var = ' *', | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Estimate the number of rows in dataset.
MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.
For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).
Takes the same arguments as IDatabase::select().
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::estimateRowCount
instead, which is more readable and less error-prone.
string | string[] | $tables | Table name(s) |
string | $var | Column for which NULL values are not counted [default "*"] |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select |
array | string | $join_conds | Join conditions |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 347 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::explicitTrxActive | ( | ) |
Check whether there is a transaction open at the specific request of a caller.
Explicit transactions are spawned by begin(), startAtomic(), and doAtomicSection(). Note that explicit transactions should not be confused with explicit transaction rounds.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 134 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::factorConds | ( | $condsArray | ) |
Given an array of condition arrays representing an OR list of AND lists, for example:
(A=1 AND B=2) OR (A=1 AND B=3)
produce an SQL expression in which the conditions are factored:
(A=1 AND (B=2 OR B=3))
We also use IN() to simplify further:
(A=1 AND (B IN (2,3))
More compactly, in boolean algebra notation, a sum of products, e.g. AB + AC is factored to produce A(B+C). Factoring proceeds recursively to reduce expressions with any number of variables, for example AEP + AEQ + AFP + AFQ = A(E(P+Q) + F(P+Q))
The algorithm is simple and will not necessarily find the shortest possible expression. For the best results, fields should be given in a consistent order, and the fields with values likely to be shared should be leftmost in the associative arrays.
array | $condsArray | An array of associative arrays. The associative array keys represent field names, and the values represent the field values to compare against. |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 399 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::fieldExists | ( | $table, | |
$field, | |||
$fname = __METHOD__ ) |
Determines whether a field exists in a table.
string | $table | Table name |
string | $field | Field to check on that table |
string | $fname | Calling function name (optional) |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 367 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::fieldInfo | ( | $table, | |
$field ) |
Get information about a field Returns false if the field doesn't exist.
string | $table | Table name |
string | $field | Field name |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 868 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::flushSession | ( | $fname = __METHOD__, | |
$flush = self::FLUSHING_ONE ) |
Release important session-level state (named lock, table locks) as post-rollback cleanup.
This should only be called by a load balancer or if the handle is not attached to one. Also, there must be no chance that a future caller will still be expecting some of the lost session state.
Connection and query errors will be suppressed and logged
string | $fname | Calling function name |
string | $flush | Flush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly rolling back implicit transactions. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context. |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 680 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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 primary DB.
string | $fname | Calling function name |
string | $flush | Flush flag, set to situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly committing implicit transactions, or calling commit when no transaction is in progress. This will trigger an exception if there is an ongoing explicit transaction. Only set the flush flag if you are sure that these warnings are not applicable, and no explicit transactions are open. |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 684 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::getDBname | ( | ) |
Get the current database name; null if there isn't one.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 472 of file DBConnRef.php.
|
protected |
Definition at line 903 of file DBConnRef.php.
Referenced by Wikimedia\Rdbms\DBConnRef\dbSchema(), Wikimedia\Rdbms\DBConnRef\setLBInfo(), and Wikimedia\Rdbms\DBConnRef\tablePrefix().
Wikimedia\Rdbms\DBConnRef::getDomainID | ( | ) |
Return the currently selected domain ID.
Null components (database/schema) might change once a connection is established
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 236 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call(), and Wikimedia\Rdbms\DatabaseDomain\getId().
Wikimedia\Rdbms\DBConnRef::getFlag | ( | $flag | ) |
Returns a boolean whether the flag $flag is set for this connection.
int | $flag | One of the class IDatabase::DBO_* constants |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 228 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::getInfinity | ( | ) |
Find out when 'infinity' is.
Most DBMSes support this. This is a special keyword for timestamps in PostgreSQL, and works with CHAR(14) as well because "i" sorts after all numbers.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 754 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 702 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::getLBInfo | ( | $name = null | ) |
Get properties passed down from the server info array of the load balancer.
string | null | $name | The entry of the info array to get, or null to get the whole array |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 174 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::getPrimaryPos | ( | ) |
Get the position of this primary DB.
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 613 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::getProperty | ( | $name | ) |
Definition at line 232 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::getReferenceRole | ( | ) |
Definition at line 110 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::getReplicaPos | ( | ) |
Get the replication position of this replica DB.
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 609 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::getScopedLockAndFlush | ( | $lockKey, | |
$fname, | |||
$timeout ) |
Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
Only call this from outer transaction scope and when only one DB will be affected. See https://www.mediawiki.org/wiki/Database_transactions for details.
This is suitable for transactions that need to be serialized using cooperative locks, where each transaction can see each others' changes. Any transaction is flushed to clear out stale REPEATABLE-READ snapshot data. Once the returned object falls out of PHP scope, the lock will be released unless a transaction is active. If one is active, then the lock will be released when it either commits or rolls back.
If the lock acquisition failed, then no transaction flush happens, and null is returned.
string | $lockKey | Name of lock to release |
string | $fname | Name of the calling method |
int | $timeout | Acquisition timeout in seconds |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 744 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::getServer | ( | ) |
Get the hostname or IP address of the server.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 482 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::getServerInfo | ( | ) |
Get a human-readable string describing the current software version.
Use getServerVersion() to get machine-friendly information.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 114 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::getServerName | ( | ) |
Get the readable name for the server.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 486 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::getServerVersion | ( | ) |
A string describing the current software version, like from mysql_get_server_info()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 279 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::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, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 706 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 275 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::getTableAliases | ( | ) |
Return current table aliases.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 778 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::getTopologyBasedServerId | ( | ) |
Get a non-recycled ID that uniquely identifies this server within the replication topology.
A replication topology defines which servers can originate changes to a given dataset and how those changes propagate among database servers. It is assumed that the server only participates in the replication of a single relevant dataset.
DBQueryError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 118 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::getTopologyRole | ( | ) |
Get the replication topology role of this server.
A replication topology defines which servers can originate changes to a given dataset and how those changes propagate among database servers. It is assumed that the server only participates in the replication of a single relevant dataset.
DBQueryError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 122 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::getType | ( | ) |
Get the RDBMS type of the server (e.g.
"mysql", "sqlite")
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 246 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call(), and Wikimedia\Rdbms\DBConnRef\normalizeServerIndex().
Wikimedia\Rdbms\DBConnRef::implicitOrderby | ( | ) |
Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 184 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::indexExists | ( | $table, | |
$index, | |||
$fname = __METHOD__ ) |
Determines whether an index exists.
string | $table | |
string | $index | |
string | $fname |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 371 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::indexUnique | ( | $table, | |
$index, | |||
$fname = __METHOD__ ) |
Determines if a given index is unique.
string | $table | |
string | $index | |
string | $fname | Calling function name |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 860 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::insert | ( | $table, | |
$rows, | |||
$fname = __METHOD__, | |||
$options = [] ) |
Insert row(s) into a table, in the provided order.
string | $table | Table name |
array | array[] | $rows | Row(s) to insert, as either:
|
string | $fname | Calling function name (use METHOD) for logs/profiling |
string | array | $options | Combination map/list where each string-keyed entry maps a non-boolean option to the option parameters and each integer-keyed value is the name of a boolean option. Supported options are:
|
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 379 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 259 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::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, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 553 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::isOpen | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 212 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::isReadOnly | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 770 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::lastDoneWrites | ( | ) |
Get the last time the connection may have been used for a write query.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 192 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::lastErrno | ( | ) |
Get the RDBMS-specific error code from the last query statement.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 263 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::lastError | ( | ) |
Get the RDBMS-specific error description from the last query statement.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 267 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::lastQuery | ( | ) |
Get the last query that sent on account of IDatabase::query()
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 188 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::limitResult | ( | $sql, | |
$limit, | |||
$offset = false ) |
Construct a LIMIT query with optional offset.
The SQL should be adjusted so that only the first $limit rows are returned. If $offset is provided as well, then the first $offset rows should be discarded, and the next $limit rows should be returned. If the result of the query is not ordered, then the rows to be returned are theoretically arbitrary.
$sql is expected to be a SELECT, if that makes a difference.
string | $sql | SQL query we will append the limit too |
int | $limit | The SQL limit |
int | false | $offset | The SQL offset (default false) |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 336 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::listTables | ( | $prefix = null, | |
$fname = __METHOD__ ) |
List all tables on the database.
string | null | $prefix | Only show tables with this prefix, e.g. mw_ |
string | $fname | Calling function name |
DBError |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 864 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::listViews | ( | $prefix = null, | |
$fname = __METHOD__ ) |
Lists all the VIEWs in the database.
string | null | $prefix | Only show VIEWs with this prefix, eg. unit_test_ |
string | $fname | Name of calling function |
RuntimeException |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 840 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::lock | ( | $lockName, | |
$method, | |||
$timeout = 5, | |||
$flags = 0 ) |
Acquire a named lock.
Named locks are not related to transactions
string | $lockName | Name of lock to acquire |
string | $method | Name of the calling method |
int | $timeout | Acquisition timeout in seconds (0 means non-blocking) |
int | $flags | Bit field of IDatabase::LOCK_* constants |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 732 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::lockForUpdate | ( | $table, | |
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Lock all rows meeting the given conditions/options FOR UPDATE.
string | string[] | $table | Table name(s) |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select ("FOR UPDATE" is added automatically) |
array | $join_conds | Join conditions |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 359 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::lockIsFree | ( | $lockName, | |
$method ) |
Check to see if a named lock is not locked by any thread (non-blocking)
string | $lockName | Name of lock to poll |
string | $method | Name of method calling us |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 726 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::makeList | ( | array | $a, |
$mode = self::LIST_COMMA ) |
Makes an encoded list of strings from an array.
These can be used to make conjunctions or disjunctions on SQL condition strings derived from an array ({
Example usage:
This would set $sql to "rev_page = '$id' AND (rev_minor = 1 OR rev_len < 500)"
array | $a | Containing the data |
int | $mode | IDatabase class constant:
|
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 391 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::makeWhereFrom2d | ( | $data, | |
$baseKey, | |||
$subKey ) |
Build a partial where clause from a 2-d array such as used for LinkBatch.
The keys on each level may be either integers or strings, however it's assumed that $baseKey is probably an integer-typed column (i.e. integer keys are unquoted in the SQL) and $subKey is string-typed (i.e. integer keys are quoted as strings in the SQL).
array | $data | Organized as 2-d [ baseKeyVal => [ subKeyVal => [ignored], ... ], ... ] |
string | $baseKey | Field name to match the base-level keys to (eg 'pl_namespace') |
string | $subKey | Field name to match the sub-level keys to (eg 'pl_title') |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 395 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::namedLocksEnqueue | ( | ) |
Check to see if a named lock used by lock() use blocking queues.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 750 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::newSelectQueryBuilder | ( | ) |
Create an empty SelectQueryBuilder which can be used to run queries against this connection.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 305 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::nextSequenceValue | ( | $seqName | ) |
Deprecated method, calls should be removed.
This was formerly used for PostgreSQL to handle self::insertId() auto-incrementing fields. It is no longer necessary since DatabasePostgres::insertId() has been reimplemented using lastval()
Implementations should return null if inserting NULL
into an auto-incrementing field works, otherwise it should return an instance of NextSequenceValue and filter it on calls to relevant methods.
string | $seqName |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 519 of file DBConnRef.php.
|
protected |
int | $i | Specific or virtual (DB_PRIMARY/DB_REPLICA) server index |
Definition at line 916 of file DBConnRef.php.
Referenced by Wikimedia\Rdbms\DBConnRef\getType().
Wikimedia\Rdbms\DBConnRef::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 |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 636 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::onTransactionCommitOrIdle | ( | callable | $callback, |
$fname = __METHOD__ ) |
Run a callback when the current transaction commits or now if there is none.
If there is a transaction and it is rolled back, then the callback is cancelled.
When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.
This IDatabase instance will start off in auto-commit mode when the callback starts. The use of other IDatabase handles from the callback should be avoided unless they are known to be in auto-commit mode. Callbacks that create transactions via begin() or startAtomic() must have matching calls to commit()/endAtomic().
Use this method only for the following purposes:
The callback takes the following arguments:
Callbacks will execute in the order they were enqueued.
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, { |
Exception | If the callback runs immediately and an error occurs in it |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 626 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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 after all peer transactions COMMIT. If the transaction round is rolled back, then the callback is cancelled.
If there is no current transaction, one will be created to wrap the callback. Callbacks cannot use begin()/commit() to manage transactions. The use of other IDatabase handles from the callback should be avoided.
Use this method only for the following purposes:
The callback takes the one argument:
Callbacks will execute in the order they were enqueued.
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, { |
Exception | If the callback runs immediately and an error occurs in it |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 631 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::onTransactionResolution | ( | callable | $callback, |
$fname = __METHOD__ ) |
Run a callback when the current transaction commits or rolls back.
An error is thrown if no transaction is pending.
When transaction round mode (DBO_TRX) is set, the callback will run at the end of the round, just after all peer transactions COMMIT/ROLLBACK.
This IDatabase instance will start off in auto-commit mode when the callback starts. The use of other IDatabase handles from the callback should be avoided unless they are known to be in auto-commit mode. Callbacks that create transactions via begin() or startAtomic() must have matching calls to commit()/endAtomic().
Use this method only for the following purposes:
The callback takes the following arguments:
Callbacks will execute in the order they were enqueued.
callable | $callback | |
string | $fname | Caller name |
DBError | If an error occurs, { |
Exception | If the callback runs immediately and an error occurs in it |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 621 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::pendingWriteCallers | ( | ) |
Get the list of method names that did write queries for this transaction.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 208 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::pendingWriteQueryDuration | ( | $type = self::ESTIMATE_TOTAL | ) |
Get the time spend running write queries for this transaction.
High values could be due to scanning, updates, locking, and such.
string | $type | IDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL] |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 204 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::ping | ( | & | $rtt = null | ) |
Ping the server and try to reconnect if it there is no connection.
float | null | &$rtt | Value to store the estimated RTT [optional] |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 696 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::primaryPosWait | ( | DBPrimaryPos | $pos, |
$timeout ) |
Wait for the replica DB to catch up to a given primary DB 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.
DBPrimaryPos | $pos | |
int | $timeout | The maximum number of seconds to wait for synchronisation |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 605 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::query | ( | $sql, | |
$fname = __METHOD__, | |||
$flags = 0 ) |
Run an SQL query statement and return the result.
If a connection loss is detected, then an attempt to reconnect will be made. For queries that involve no larger transactions or locks, they will be re-issued for convenience, provided the connection was re-established.
In new code, the query wrappers select(), insert(), update(), delete(), etc. should be used where possible, since they give much better DBMS independence and automatically quote or validate user input in a variety of contexts. This function is generally only useful for queries which are explicitly DBMS-dependent and are unsupported by the query wrappers, such as CREATE TABLE.
However, the query wrappers themselves should call this function.
string | $sql | Single-statement SQL query |
string | $fname | Caller name; used for profiling/SHOW PROCESSLIST comments |
int | $flags | Bit field of IDatabase::QUERY_* constants. |
DBQueryError | If the query is issued, fails, and QUERY_SILENCE_ERRORS is not set. |
DBExpectedError | If the query is not, and cannot, be issued yet (non-DBQueryError) |
DBError | If the query is inherently not allowed (non-DBExpectedError) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 288 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call(), and Wikimedia\Rdbms\ILoadBalancer\DB_PRIMARY.
Wikimedia\Rdbms\DBConnRef::queryMulti | ( | array | $sqls, |
string | $fname = __METHOD__, | ||
int | $flags = 0, | ||
?string | $summarySql = null ) |
Run a batch of SQL query statements and return the results.
string[] | $sqls | Map of (statement ID => SQL statement) |
string | $fname | Name of the calling function |
int | $flags | Bit field of IDatabase::QUERY_* constants |
string | null | $summarySql | Virtual SQL for profiling (e.g. "UPSERT INTO TABLE 'x'") |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 296 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call(), and Wikimedia\Rdbms\ILoadBalancer\DB_PRIMARY.
Wikimedia\Rdbms\DBConnRef::replace | ( | $table, | |
$uniqueKeys, | |||
$rows, | |||
$fname = __METHOD__ ) |
Insert row(s) into a table, in the provided order, while deleting conflicting rows.
Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.
Note some important implications of the deletion semantics:
string | $table | The table name |
string | string[] | string[][] | $uniqueKeys | Column name or non-empty list of column name lists that define all applicable unique keys on the table. There must only be one such key. Each unique key on the table is "applicable" unless either:
|
array | array[] | $rows | Row(s) to insert, in the form of either:
|
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 525 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::restoreFlags | ( | $state = self::RESTORE_PRIOR | ) |
Restore the flags to their prior state before the last setFlag/clearFlag call.
string | $state | IDatabase::RESTORE_* constant. [default: RESTORE_PRIOR] |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 224 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::rollback | ( | $fname = __METHOD__, | |
$flush = self::FLUSHING_ONE ) |
Rollback a transaction previously started using begin()
Only call this from code with outer transaction scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported. If a serious unexpected error occurs, throwing an Exception is preferable, using a pre-installed error handler to trigger rollback (in any case, failure to issue COMMIT will cause rollback server-side).
Query, connection, and onTransaction* callback errors will be suppressed and logged.
string | $fname | Calling function name |
string | $flush | Flush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about explicitly rolling back implicit transactions. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context. |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 676 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::select | ( | $table, | |
$vars, | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Execute a SELECT query constructed using the various parameters provided.
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchResultSet
instead, which is more readable and less error-prone.
string | array | $table | Table name(s) |
May be either an array of table names, or a single string holding a table name. If an array is given, table aliases can be specified, for example:
[ 'a' => 'user' ]
This includes the user table in the query, with the alias "a" available for use in field names (e.g. a.user_name).
A derived table, defined by the result of selectSQLText(), requires an alias key and a Subquery instance value which wraps the SQL query, for example:
[ 'c' => new Subquery( 'SELECT ...' ) ]
Joins using parentheses for grouping (since MediaWiki 1.31) may be constructed using nested arrays. For example,
[ 'tableA', 'nestedB' => [ 'tableB', 'b2' => 'tableB2' ] ]
along with $join_conds
like
[ 'b2' => [ 'JOIN', 'b_id = b2_id' ], 'nestedB' => [ 'LEFT JOIN', 'b_a = a_id' ] ]
will produce SQL something like
FROM tableA LEFT JOIN (tableB JOIN tableB2 AS b2 ON (b_id = b2_id)) ON (b_a = a_id)
All of the table names given here are automatically run through Database::tableName(), which causes the table prefix (if any) to be added, and various other table name mappings to be performed.
Do not use untrusted user input as a table name. Alias names should not have characters outside of the Basic multilingual plane.
string | array | $vars | Field name(s) |
May be either a field name or an array of field names. The field names can be complete fragments of SQL, for direct inclusion into the SELECT query. If an array is given, field aliases can be specified, for example:
[ 'maxrev' => 'MAX(rev_id)' ]
This includes an expression with the alias "maxrev" in the query.
If an expression is given, care must be taken to ensure that it is DBMS-independent.
Untrusted user input must not be passed to this parameter.
string | array | $conds |
May be either a string containing a single condition, or an array of conditions. If an array is given, the conditions constructed from each element are combined with AND.
Array elements may take one of two forms:
Note that expressions are often DBMS-dependent in their syntax. DBMS-independent wrappers are provided for constructing several types of expression commonly used in condition queries. See:
Untrusted user input is safe in the values of string keys, however untrusted input must not be used in the array key names or in the values of numeric keys. Escaping of untrusted input used in values of numeric keys should be done via IDatabase::addQuotes()
Use an empty array, string, or IDatabase::ALL_ROWS to select all rows.
You can put simple join conditions here, but this is strongly discouraged. Instead of
// $conds... 'rev_actor = actor_id',
use (see below for $join_conds):
// $join_conds... 'actor' => [ 'JOIN', 'rev_actor = actor_id' ],
string | $fname | Caller function name |
string | array | $options | Query options |
Optional: Array of query options. Boolean options are specified by including them in the array as a string value with a numeric key, for example:
[ 'FOR UPDATE' ]
The supported options are:
And also the following boolean MySQL extensions, see the MySQL manual for documentation:
string | array | $join_conds | Join conditions |
Optional associative array of table-specific join conditions. Simple conditions can also be specified in the regular $conds, but this is strongly discouraged in favor of the more explicit syntax here.
The key of the array contains the table name or alias. The value is an array with two elements, numbered 0 and 1. The first gives the type of join, the second is the same as the $conds parameter. Thus it can be an SQL fragment, or an array where the string keys are equality and the numeric keys are SQL fragments all AND'd together. For example:
[ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 322 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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 |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 460 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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 |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 466 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::selectField | ( | $table, | |
$var, | |||
$cond = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
A SELECT wrapper which returns a single field from a single result row.
If no result rows are returned from the query, false is returned.
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchField
instead, which is more readable and less error-prone.
string | array | $table | Table name. { |
string | array | $var | The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. Can be an array, but must contain exactly 1 element then. { |
string | array | $cond | The condition array. { |
string | $fname | The function name of the caller. |
string | array | $options | The query options. { |
string | array | $join_conds | The query join conditions. { |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 310 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::selectFieldValues | ( | $table, | |
$var, | |||
$cond = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
A SELECT wrapper which returns a list of single field values from result rows.
If no result rows are returned from the query, an empty array is returned.
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchFieldValues
instead, which is more readable and less error-prone.
string | array | $table | Table name. { |
string | $var | The field name to select. This must be a valid SQL fragment: do not use unvalidated user input. |
string | array | $cond | The condition array. { |
string | $fname | The function name of the caller. |
string | array | $options | The query options. { |
string | array | $join_conds | The query join conditions. { |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 316 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::selectRow | ( | $table, | |
$vars, | |||
$conds, | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Wrapper to IDatabase::select() that only fetches one row (via LIMIT)
If the query returns no rows, false is returned.
This method is convenient for fetching a row based on a unique key condition.
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchRow
instead, which is more readable and less error-prone.
string | array | $table | Table name |
string | array | $vars | Field names |
string | array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
array | string | $join_conds | Join conditions |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 340 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::selectRowCount | ( | $tables, | |
$var = ' *', | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Get the number of rows in dataset.
This is useful when trying to do COUNT(*) but with a LIMIT for performance.
Takes the same arguments as IDatabase::select().
New callers should use newSelectQueryBuilder
with SelectQueryBuilder::fetchRowCount
instead, which is more readable and less error-prone.
string | string[] | $tables | Table name(s) |
string | $var | Column for which NULL values are not counted [default "*"] |
array | string | $conds | Filters on the table |
string | $fname | Function name for profiling |
array | $options | Options for select |
array | $join_conds | Join conditions (since 1.27) |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 353 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::selectSQLText | ( | $table, | |
$vars, | |||
$conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Take the same arguments as IDatabase::select() and return the SQL it would use.
This can be useful for making UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().
string | array | $table | Table name(s) |
string | array | $vars | Field names |
string | array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
string | array | $join_conds | Join conditions |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 329 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::serverIsReadOnly | ( | ) |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 617 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::setBigSelects | ( | $value = true | ) |
Allow or deny "big selects" for this session only.
This is done by setting the sql_big_selects session variable.
This is a MySQL-specific feature.
bool | string | $value | True for allow, false for deny, or "default" to restore the initial value |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 766 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::setFlag | ( | $flag, | |
$remember = self::REMEMBER_NOTHING ) |
Set a flag for this connection.
int | $flag | One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX) |
string | $remember | IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING] |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 216 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::setIndexAliases | ( | array | $aliases | ) |
Convert certain index names to alternative names before querying the DB.
Note that this applies to indexes regardless of the table they belong to.
This can be employed when an index was renamed X => Y in code, but the new Y-named indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA, the aliases can be removed, and then the old X-named indexes dropped.
string[] | $aliases |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 782 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::setLBInfo | ( | $nameOrArray, | |
$value = null ) |
Set the entire array or a particular key of the managing load balancer info array.
Keys matching the IDatabase::LB_* constants are also used internally by subclasses
array | string | $nameOrArray | The new array or the name of a key to set |
array | mixed | null | $value | If $nameOrArray is a string, the new key value (null to unset) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 178 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\getDomainChangeException().
Wikimedia\Rdbms\DBConnRef::setSchemaVars | ( | $vars | ) |
Set schema variables to be used when streaming commands from SQL files or stdin.
Variables appear as SQL comments and are substituted by their corresponding values
array | null | $vars | Map of (variable => value) or null to use the defaults |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 722 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 718 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::setTableAliases | ( | array | $aliases | ) |
Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.
For example, "user" can be converted to "myschema.mydbname.user" for convenience. Appearances like user
, somedb.user, somedb.someschema.user will used literally.
Calling this twice will completely clear any old table aliases. Also, note that callers are responsible for making sure the schemas and databases actually exist.
array[] | $aliases | Map of (table => (dbname, schema, prefix) map) |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 774 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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 |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 640 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::sourceFile | ( | $filename, | |
callable | $lineCallback = null, | ||
callable | $resultCallback = null, | ||
$fname = false, | |||
callable | $inputCallback = null ) |
Read and execute SQL commands from a file.
Returns true on success, error string or exception on failure (depending on object's error ignore settings).
string | $filename | File name to open |
callable | null | $lineCallback | Optional function called before reading each line |
callable | null | $resultCallback | Optional function called for each MySQL result |
string | false | $fname | Calling function name or false if name should be generated dynamically using $filename |
callable | null | $inputCallback | Optional function called for each complete line sent |
Exception |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 798 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::sourceStream | ( | $fp, | |
callable | $lineCallback = null, | ||
callable | $resultCallback = null, | ||
$fname = __METHOD__, | |||
callable | $inputCallback = null ) |
Read and execute commands from an open file handle.
Returns true on success, error string or exception on failure (depending on object's error ignore settings).
resource | $fp | File handle |
callable | null | $lineCallback | Optional function called before reading each query |
callable | null | $resultCallback | Optional function called for each MySQL result |
string | $fname | Calling function name |
callable | null | $inputCallback | Optional function called for each complete query sent |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 810 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::startAtomic | ( | $fname = __METHOD__, | |
$cancelable = IDatabase::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, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 644 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::streamStatementEnd | ( | & | $sql, |
& | $newLine ) |
Called by sourceStream() to check if we've reached a statement end.
string | &$sql | SQL assembled so far |
string | &$newLine | New line about to be added to $sql |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 848 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::strreplace | ( | $orig, | |
$old, | |||
$new ) |
Returns a SQL expression for simple string replacement (e.g.
REPLACE() in mysql)
string | $orig | Column to modify |
string | $old | Column to seek |
string | $new | Column to replace with |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 581 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::tableExists | ( | $table, | |
$fname = __METHOD__ ) |
Query whether a given table exists.
string | $table | |
string | $fname |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 375 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::tableName | ( | $name, | |
$format = 'quoted' ) |
Format a table name ready for use in constructing an SQL query.
This does two important things: it quotes the table names to clean them up, and it adds a table prefix if only given a table name with no quotes.
All functions of this object which require a table name call this function themselves. Pass the canonical name to such functions. This is only needed when calling query() directly.
string | $name | Database table name |
string | $format | One of: quoted - Automatically pass the table name through addIdentifierQuotes() so that it can be used in a query. raw - Do not add identifier quotes to the table name |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 786 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::tableNames | ( | $tables | ) |
Fetch a number of table names into an associative array.
Much like tableName()
, this is only needed when calling query()
directly. Prefer calling other methods, or using SelectQueryBuilder
.
Theoretical example (which really does not require raw SQL): [ 'user' => $user, 'watchlist' => $watchlist ] = $dbr->tableNames( 'user', 'watchlist' ); $sql = "SELECT wl_namespace, wl_title FROM $watchlist, $user WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
string | ...$tables |
tableName
or use tableNamesN
instead of calling this function. Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 790 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::tableNamesN | ( | $tables | ) |
Fetch a number of table names into a zero-indexed numerical array.
Much like tableName()
, this is only needed when calling query()
directly. It is slightly more convenient than tableNames()
, but you should still prefer calling other methods, or using SelectQueryBuilder
.
Theoretical example (which really does not require raw SQL): [ $user, $watchlist ] = $dbr->tableNamesN( 'user', 'watchlist' ); $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
string | ...$tables |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 794 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::tablePrefix | ( | $prefix = null | ) |
Get/set the table prefix.
string | null | $prefix | The table prefix to set, or omitted to leave it unchanged |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 138 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call(), Wikimedia\Rdbms\DBConnRef\getDomainChangeException(), and Wikimedia\Rdbms\DatabaseDomain\newFromId().
Wikimedia\Rdbms\DBConnRef::textFieldSize | ( | $table, | |
$field ) |
Returns the size of a text field, or -1 for "unlimited".
string | $table | |
string | $field |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 844 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::timestamp | ( | $ts = 0 | ) |
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.
The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
string | int | $ts |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 688 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::timestampOrNull | ( | $ts = null | ) |
Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.
If NULL is input, it is passed through, allowing NULL values to be inserted into timestamp fields.
The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
string | int | null | $ts |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 692 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::truncate | ( | $tables, | |
$fname = __METHOD__ ) |
Delete all data in a table(s) and reset any sequences owned by that table(s)
string | string[] | $tables | |
string | $fname |
DBError | If an error occurs |
Implements Wikimedia\Rdbms\IMaintainableDatabase.
Definition at line 828 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::trxLevel | ( | ) |
Gets the current transaction level.
Historically, transactions were allowed to be "nested". This is no longer supported, so this function really only returns a boolean.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 126 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::trxTimestamp | ( | ) |
Get the UNIX timestamp of the time that the transaction was established.
This can be used to reason about the staleness of SELECT data in REPEATABLE-READ transaction isolation level. Callers can assume that if a view-snapshot isolation is used, then the data read by SQL queries is at least up to date to that point (possibly more up-to-date since the first SELECT defines the snapshot).
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 130 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::unionConditionPermutations | ( | $table, | |
$vars, | |||
array | $permute_conds, | ||
$extra_conds = '', | |||
$fname = __METHOD__, | |||
$options = [], | |||
$join_conds = [] ) |
Construct a UNION query for permutations of conditions.
Databases sometimes have trouble with queries that have multiple values for multiple condition parameters combined with limits and ordering. This method constructs queries for the Cartesian product of the conditions and unions them all together.
string | array | $table | Table name |
string | array | $vars | Field names |
array | $permute_conds | Conditions for the Cartesian product. Keys are field names, values are arrays of the possible values for that field. |
string | array | $extra_conds | Additional conditions to include in the query. |
string | $fname | Caller function name |
string | array | $options | Query options. In addition to the options recognized by IDatabase::select(), the following may be used:
|
string | array | $join_conds | Join conditions |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 570 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::unionQueries | ( | $sqls, | |
$all ) |
Construct a UNION query.
This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.
array | $sqls | SQL statements to combine |
bool | $all | Either IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT |
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 566 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::unionSupportsOrderAndLimit | ( | ) |
Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.
Implements Wikimedia\Rdbms\Platform\ISQLPlatform.
Definition at line 562 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::unlock | ( | $lockName, | |
$method ) |
Release a lock.
Named locks are not related to transactions
string | $lockName | Name of lock to release |
string | $method | Name of the calling method |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 738 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::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 explicitly in order to update all rows. |
string | $fname | Calling function name (use METHOD) for logs/profiling |
string | array | $options | Combination map/list where each string-keyed entry maps a non-boolean option to the option parameters and each integer-keyed value is the name of a boolean option. Supported options are:
|
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 385 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::upsert | ( | $table, | |
array | $rows, | ||
$uniqueKeys, | |||
array | $set, | ||
$fname = __METHOD__ ) |
Upsert row(s) into a table, in the provided order, while updating conflicting rows.
Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.
string | $table | Table name |
array | array[] | $rows | Row(s) to insert, in the form of either:
|
string | string[] | string[][] | $uniqueKeys | Column name or non-empty list of column name lists that define all applicable unique keys on the table. There must only be one such key. Each unique key on the table is "applicable" unless either:
|
array | $set | Combination map/list where each string-keyed entry maps a column to a literal assigned value and each integer-keyed value is a SQL assignment expression of the form "<unquoted alphanumeric column> = <SQL expression>". The (column => value) entries are convenient due to automatic value quoting and conversion of null to NULL. The SQL assignment entries are useful for updates like "column = column + X". All of the assignments have no defined execution order, so callers should make sure that they not depend on each other. Do not modify AUTOINCREMENT or UUID columns in assignments, even if they are just "secondary" unique keys. For multi-row upserts, use buildExcludedValue() to reference the value of a column from the corresponding row in $rows that conflicts with the current row. |
string | $fname | Calling function name (use METHOD) for logs/profiling |
DBError | If an error occurs, { |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 531 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::wasConnectionLoss | ( | ) |
Determines if the last query error was due to a dropped connection.
Note that during a connection loss, the prior transaction will have been lost
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 593 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::wasDeadlock | ( | ) |
Determines if the last failure was due to a deadlock.
Note that during a deadlock, the prior transaction will have been lost
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 585 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::wasErrorReissuable | ( | ) |
Determines if the last query error was due to something outside of the query itself.
Note that the transaction may have been lost, discarding prior writes and results
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 601 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::wasLockTimeout | ( | ) |
Determines if the last failure was due to a lock timeout.
Note that during a lock wait timeout, the prior transaction will have been lost
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 589 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::wasReadOnlyError | ( | ) |
Determines if the last failure was due to the database being read-only.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 597 of file DBConnRef.php.
Wikimedia\Rdbms\DBConnRef::writesOrCallbacksPending | ( | ) |
Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending.
This does not count recurring callbacks, e.g. from setTransactionListener().
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 200 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().
Wikimedia\Rdbms\DBConnRef::writesPending | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 196 of file DBConnRef.php.
References Wikimedia\Rdbms\DBConnRef\__call().