MediaWiki  master
DBConnRef Class Reference

Helper class to handle automatically marking connections as reusable (via RAII pattern) as well handling deferring the actual network connection until the handle is used. More...

Inheritance diagram for DBConnRef:
Collaboration diagram for DBConnRef:

Public Member Functions

 __call ($name, array $arguments)
 
 __construct (ILoadBalancer $lb, $conn)
 
 __destruct ()
 Clean up the connection when out of scope. More...
 
 addQuotes ($s)
 Adds quotes and backslashes. More...
 
 affectedRows ()
 Get the number of rows affected by the last write query. More...
 
 aggregateValue ($valuedata, $valuename= 'value')
 Return aggregated value alias. More...
 
 anyChar ()
 Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More...
 
 anyString ()
 Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More...
 
 begin ($fname=__METHOD__, $mode=IDatabase::TRANSACTION_EXPLICIT)
 Begin a transaction. More...
 
 bitAnd ($fieldLeft, $fieldRight)
 
 bitNot ($field)
 
 bitOr ($fieldLeft, $fieldRight)
 
 bufferResults ($buffer=null)
 Turns buffering of SQL result sets on (true) or off (false). More...
 
 buildConcat ($stringList)
 Build a concatenation list to feed into a SQL query. More...
 
 buildGroupConcatField ($delim, $table, $field, $conds= '', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query. More...
 
 buildLike ()
 LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). More...
 
 buildStringCast ($field)
 
 clearFlag ($flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection. More...
 
 close ()
 Closes a database connection. More...
 
 commit ($fname=__METHOD__, $flush= '')
 Commits a transaction previously started using begin(). More...
 
 conditional ($cond, $trueVal, $falseVal)
 Returns an SQL expression for a simple conditional. More...
 
 dataSeek ($res, $row)
 Change the position of the cursor in a result object. More...
 
 dbSchema ($schema=null)
 Get/set the db schema. More...
 
 decodeBlob ($b)
 Some DBMSs return a special placeholder object representing blob fields in result objects. More...
 
 decodeExpiry ($expiry, $format=TS_MW)
 Decode an expiry time into a DBMS independent format. More...
 
 delete ($table, $conds, $fname=__METHOD__)
 DELETE query wrapper. More...
 
 deleteJoin ($delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
 DELETE where the condition is a join. More...
 
 doAtomicSection ($fname, callable $callback)
 Run a callback to do an atomic set of updates for this database. More...
 
 doneWrites ()
 Returns true if the connection may have been used for write queries. More...
 
 encodeBlob ($b)
 Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. More...
 
 encodeExpiry ($expiry)
 Encode an expiry time into the DBMS dependent format. More...
 
 endAtomic ($fname=__METHOD__)
 Ends an atomic section of SQL statements. More...
 
 estimateRowCount ($table, $vars= '*', $conds= '', $fname=__METHOD__, $options=[])
 Estimate the number of rows in dataset. More...
 
 explicitTrxActive ()
 
 fetchObject ($res)
 Fetch the next row from the given result object, in object form. More...
 
 fetchRow ($res)
 Fetch the next row from the given result object, in associative array form. More...
 
 fieldExists ($table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. More...
 
 fieldInfo ($table, $field)
 mysql_fetch_field() wrapper Returns false if the field doesn't exist More...
 
 fieldName ($res, $n)
 Get a field name in a result object. More...
 
 flushSnapshot ($fname=__METHOD__)
 Commit any transaction but error out if writes or callbacks are pending. More...
 
 freeResult ($res)
 Free a result object returned by query() or select(). More...
 
 getDBname ()
 Get the current DB name. More...
 
 getDomainID ()
 
 getFlag ($flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is. More...
 
 getLag ()
 Get replica DB lag. More...
 
 getLBInfo ($name=null)
 Get properties passed down from the server info array of the load balancer. More...
 
 getMasterPos ()
 Get the position of this master. More...
 
 getProperty ($name)
 
 getReplicaPos ()
 Get the replication position of this replica DB. More...
 
 getScopedLockAndFlush ($lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More...
 
 getServer ()
 Get the server hostname or IP address. More...
 
 getServerInfo ()
 A string describing the current software version, and possibly other details in a user-friendly way. More...
 
 getServerUptime ()
 Determines how long the server has been up. More...
 
 getServerVersion ()
 A string describing the current software version, like from mysql_get_server_info(). More...
 
 getSessionLagStatus ()
 Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More...
 
 getSoftwareLink ()
 Returns a wikitext link to the DB's website, e.g., return "[https://www.mysql.com/ MySQL]"; Should at least contain plain text, if for some reason your database has no website. More...
 
 getType ()
 Get the type of the DBMS, as it appears in $wgDBtype. More...
 
 getWikiID ()
 Alias for getDomainID() More...
 
 implicitGroupby ()
 Returns true if this database does an implicit sort when doing GROUP BY. More...
 
 implicitOrderby ()
 Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1. More...
 
 indexExists ($table, $index, $fname=__METHOD__)
 Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure. More...
 
 indexUnique ($table, $index)
 Determines if a given index is unique. More...
 
 insert ($table, $a, $fname=__METHOD__, $options=[])
 INSERT wrapper, inserts an array into a table. More...
 
 insertId ()
 Get the inserted value of an auto-increment row. More...
 
 insertSelect ($destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
 INSERT SELECT wrapper. More...
 
 isOpen ()
 Is a connection to the database open? More...
 
 isReadOnly ()
 
 lastDoneWrites ()
 Returns the last time the connection may have been used for write queries. More...
 
 lastErrno ()
 Get the last error number. More...
 
 lastError ()
 Get a description of the last error. More...
 
 lastQuery ()
 Return the last query that went through IDatabase::query() More...
 
 listTables ($prefix=null, $fname=__METHOD__)
 List all tables on the database. More...
 
 lock ($lockName, $method, $timeout=5)
 Acquire a named lock. More...
 
 lockIsFree ($lockName, $method)
 Check to see if a named lock is available (non-blocking) More...
 
 makeList ($a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array. More...
 
 makeWhereFrom2d ($data, $baseKey, $subKey)
 Build a partial where clause from a 2-d array such as used for LinkBatch. More...
 
 masterPosWait (DBMasterPos $pos, $timeout)
 Wait for the replica DB to catch up to a given master position. More...
 
 maxListLen ()
 Return the maximum number of items allowed in a list, or 0 for unlimited. More...
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues. More...
 
 nextSequenceValue ($seqName)
 Returns an appropriately quoted sequence value for inserting a new row. More...
 
 numFields ($res)
 Get the number of fields in a result object. More...
 
 numRows ($res)
 Get the number of rows in a result object. More...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Run a callback as soon as there is no transaction pending. More...
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none. More...
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback as soon as the current transaction commits or rolls back. More...
 
 open ($server, $user, $password, $dbName)
 Open a connection to the database. More...
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction. More...
 
 pendingWriteQueryDuration ($type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction. More...
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection. More...
 
 query ($sql, $fname=__METHOD__, $tempIgnore=false)
 Run an SQL query and return the result. More...
 
 replace ($table, $uniqueIndexes, $rows, $fname=__METHOD__)
 REPLACE query wrapper. More...
 
 reportConnectionError ($error= 'Unknown error')
 
 reportQueryError ($error, $errno, $sql, $fname, $tempIgnore=false)
 Report a query error. More...
 
 restoreFlags ($state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call. More...
 
 rollback ($fname=__METHOD__, $flush= '')
 Rollback a transaction previously started using begin(). More...
 
 select ($table, $vars, $conds= '', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided. More...
 
 selectDB ($db)
 Change the current database. More...
 
 selectField ($table, $var, $cond= '', $fname=__METHOD__, $options=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ($table, $var, $cond= '', $fname=__METHOD__, $options=[])
 A SELECT wrapper which returns a list of single field values from result rows. More...
 
 selectRow ($table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Single row SELECT wrapper. More...
 
 selectRowCount ($tables, $vars= '*', $conds= '', $fname=__METHOD__, $options=[], $join_conds=[])
 Get the number of rows in dataset. More...
 
 selectSQLText ($table, $vars, $conds= '', $fname=__METHOD__, $options=[], $join_conds=[])
 The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed. More...
 
 serverIsReadOnly ()
 
 setBigSelects ($value=true)
 Allow or deny "big selects" for this session only. More...
 
 setFlag ($flag, $remember=self::REMEMBER_NOTHING)
 Set a flag for this connection. More...
 
 setLazyMasterHandle (IDatabase $conn)
 Set a lazy-connecting DB handle to the master DB (for replication status purposes) More...
 
 setLBInfo ($name, $value=null)
 Set the LB info array, or a member of it. More...
 
 setSchemaVars ($vars)
 Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS. More...
 
 setSessionOptions (array $options)
 Override database's default behavior. More...
 
 setTableAliases (array $aliases)
 Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. More...
 
 setTransactionListener ($name, callable $callback=null)
 Run a callback each time any transaction commits or rolls back. More...
 
 startAtomic ($fname=__METHOD__)
 Begin an atomic section of statements. More...
 
 strreplace ($orig, $old, $new)
 Returns a comand for str_replace function in SQL query. More...
 
 tableExists ($table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 tablePrefix ($prefix=null)
 Get/set the table prefix. More...
 
 timestamp ($ts=0)
 Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More...
 
 timestampOrNull ($ts=null)
 Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More...
 
 trxLevel ()
 Gets the current transaction level. More...
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established. More...
 
 unionQueries ($sqls, $all)
 Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax. More...
 
 unionSupportsOrderAndLimit ()
 Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct. More...
 
 unlock ($lockName, $method)
 Release a lock. More...
 
 update ($table, $values, $conds, $fname=__METHOD__, $options=[])
 UPDATE wrapper. More...
 
 upsert ($table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)
 INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. More...
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock. More...
 
 wasErrorReissuable ()
 Determines if the last query error was due to a dropped connection and should be dealt with by pinging the connection and reissuing the query. More...
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout. More...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. More...
 
 writesOrCallbacksPending ()
 Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. More...
 
 writesPending ()
 

Public Attributes

const FLD_DOMAIN = 2
 
const FLD_GROUP = 1
 
const FLD_INDEX = 0
 

Private Attributes

Database null $conn
 Live connection handle. More...
 
ILoadBalancer $lb
 
array null $params
 N-tuple of (server index, group, DatabaseDomain|string) More...
 

Detailed Description

Helper class to handle automatically marking connections as reusable (via RAII pattern) as well handling deferring the actual network connection until the handle is used.

Note
: proxy methods are defined explicity to avoid interface errors
Since
1.22

Definition at line 15 of file DBConnRef.php.

Constructor & Destructor Documentation

DBConnRef::__construct ( ILoadBalancer  $lb,
  $conn 
)
Parameters
ILoadBalancer$lbConnection manager for $conn
Database | array$connNew connection handle or (server index, query groups, domain)

Definition at line 31 of file DBConnRef.php.

References $conn, and $lb.

DBConnRef::__destruct ( )

Clean up the connection when out of scope.

Definition at line 600 of file DBConnRef.php.

Member Function Documentation

DBConnRef::__call (   $name,
array  $arguments 
)

Definition at line 42 of file DBConnRef.php.

References $name, $params, and list.

Referenced by addQuotes(), affectedRows(), aggregateValue(), anyChar(), anyString(), begin(), bitAnd(), bitNot(), bitOr(), bufferResults(), buildConcat(), buildGroupConcatField(), buildLike(), buildStringCast(), clearFlag(), close(), commit(), conditional(), dataSeek(), dbSchema(), MaintainableDBConnRef\deadlockLoop(), decodeBlob(), decodeExpiry(), delete(), deleteJoin(), doAtomicSection(), doneWrites(), MaintainableDBConnRef\dropTable(), MaintainableDBConnRef\duplicateTableStructure(), encodeBlob(), encodeExpiry(), endAtomic(), estimateRowCount(), explicitTrxActive(), fetchObject(), fetchRow(), fieldExists(), fieldInfo(), fieldName(), flushSnapshot(), freeResult(), getDBname(), getDomainID(), getFlag(), getInfinity(), getLag(), getLBInfo(), getMasterPos(), getProperty(), getReplicaPos(), getScopedLockAndFlush(), getServer(), getServerInfo(), getServerUptime(), getServerVersion(), getSessionLagStatus(), getSoftwareLink(), getType(), implicitGroupby(), implicitOrderby(), indexExists(), indexUnique(), insert(), insertId(), insertSelect(), isOpen(), isReadOnly(), lastDoneWrites(), lastErrno(), lastError(), lastQuery(), listTables(), MaintainableDBConnRef\listViews(), lock(), lockIsFree(), makeList(), makeWhereFrom2d(), masterPosWait(), maxListLen(), namedLocksEnqueue(), nextSequenceValue(), numFields(), numRows(), onTransactionIdle(), onTransactionPreCommitOrIdle(), onTransactionResolution(), open(), pendingWriteCallers(), pendingWriteQueryDuration(), ping(), query(), replace(), reportConnectionError(), reportQueryError(), restoreFlags(), rollback(), select(), selectDB(), selectField(), selectFieldValues(), selectRow(), selectRowCount(), selectSQLText(), serverIsReadOnly(), setBigSelects(), setFlag(), setLazyMasterHandle(), setLBInfo(), setSchemaVars(), setSessionOptions(), setTableAliases(), setTransactionListener(), MaintainableDBConnRef\sourceFile(), MaintainableDBConnRef\sourceStream(), startAtomic(), MaintainableDBConnRef\streamStatementEnd(), strreplace(), tableExists(), MaintainableDBConnRef\tableName(), MaintainableDBConnRef\tableNames(), MaintainableDBConnRef\tableNamesN(), tablePrefix(), MaintainableDBConnRef\textFieldSize(), timestamp(), timestampOrNull(), trxLevel(), trxTimestamp(), unionQueries(), unionSupportsOrderAndLimit(), unlock(), update(), upsert(), wasDeadlock(), wasErrorReissuable(), wasLockTimeout(), wasReadOnlyError(), writesOrCallbacksPending(), and writesPending().

DBConnRef::addQuotes (   $s)

Adds quotes and backslashes.

Parameters
string | int | null | bool | Blob$s
Returns
string|int

Implements IDatabase.

Definition at line 364 of file DBConnRef.php.

References __call().

DBConnRef::affectedRows ( )

Get the number of rows affected by the last write query.

See also
https://secure.php.net/mysql_affected_rows
Returns
int

Implements IDatabase.

Definition at line 213 of file DBConnRef.php.

References __call().

DBConnRef::aggregateValue (   $valuedata,
  $valuename = 'value' 
)

Return aggregated value alias.

Parameters
array$valuedata
string$valuename
Returns
string

Implements IDatabase.

Definition at line 322 of file DBConnRef.php.

References __call().

DBConnRef::anyChar ( )

Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.

Returns
LikeMatch

Implements IDatabase.

Definition at line 372 of file DBConnRef.php.

References __call().

DBConnRef::anyString ( )

Returns a token for buildLike() that denotes a '' to be used in a LIKE query.

Returns
LikeMatch

Implements IDatabase.

Definition at line 376 of file DBConnRef.php.

References __call().

DBConnRef::begin (   $fname = __METHOD__,
  $mode = IDatabase::TRANSACTION_EXPLICIT 
)

Begin a transaction.

If a transaction is already in progress, that transaction will be committed before the new transaction is started.

Only call this from code with outer transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.

Note that when the DBO_TRX flag is set (which is usually the case for web requests, but not for maintenance scripts), any previous database query will have started a transaction automatically.

Nesting of transactions is not supported. Attempts to nest transactions will cause a warning, unless the current transaction was started automatically because of the DBO_TRX flag.

Parameters
string$fnameCalling function name
string$modeA situationally valid IDatabase::TRANSACTION_* constant [optional]
Exceptions
DBError

Implements IDatabase.

Definition at line 491 of file DBConnRef.php.

References __call().

DBConnRef::bitAnd (   $fieldLeft,
  $fieldRight 
)
Parameters
string$fieldLeft
string$fieldRight
Returns
string

Implements IDatabase.

Definition at line 330 of file DBConnRef.php.

References __call().

DBConnRef::bitNot (   $field)
Parameters
string$field
Returns
string

Implements IDatabase.

Definition at line 326 of file DBConnRef.php.

References __call().

DBConnRef::bitOr (   $fieldLeft,
  $fieldRight 
)
Parameters
string$fieldLeft
string$fieldRight
Returns
string

Implements IDatabase.

Definition at line 334 of file DBConnRef.php.

References __call().

DBConnRef::bufferResults (   $buffer = null)

Turns buffering of SQL result sets on (true) or off (false).

Default is "on".

Unbuffered queries are very troublesome in MySQL:

  • If another query is executed while the first query is being read out, the first query is killed. This means you can't call normal Database functions while you are reading an unbuffered query result from a normal Database connection.
  • Unbuffered queries cause the MySQL server to use large amounts of memory and to hold broad locks which block other queries.

If you want to limit client-side memory, it's almost always better to split up queries into batches using a LIMIT clause than to switch off buffering.

Parameters
null | bool$buffer
Returns
null|bool The previous value of the flag

Implements IDatabase.

Definition at line 55 of file DBConnRef.php.

References __call().

DBConnRef::buildConcat (   $stringList)

Build a concatenation list to feed into a SQL query.

Parameters
array$stringListList of raw SQL expressions; caller is responsible for any quoting
Returns
string

Implements IDatabase.

Definition at line 338 of file DBConnRef.php.

References __call().

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.

Parameters
string$delimGlue to bind the results together
string | array$tableTable name
string$fieldField name
string | array$condsConditions
string | array$join_condsJoin conditions
Returns
string SQL text
Since
1.23

Implements IDatabase.

Definition at line 342 of file DBConnRef.php.

References __call().

DBConnRef::buildLike ( )

LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString().

Alternatively, the function could be provided with an array of aforementioned parameters.

Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches for subpages of 'My page title'. Alternatively: $pattern = [ 'My_page_title/', $dbr->anyString() ]; $query .= $dbr->buildLike( $pattern );

Since
1.16
Returns
string Fully built LIKE statement

Implements IDatabase.

Definition at line 368 of file DBConnRef.php.

References __call().

DBConnRef::buildStringCast (   $field)
Parameters
string$fieldField or column to cast
Returns
string
Since
1.28

Implements IDatabase.

Definition at line 348 of file DBConnRef.php.

References __call().

DBConnRef::clearFlag (   $flag,
  $remember = self::REMEMBER_NOTHING 
)

Clear a flag for this connection.

Parameters
int$flagDBO_* constants from Defines.php:
  • DBO_DEBUG: output some debug info (same as debug())
  • DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
  • DBO_TRX: automatically start transactions
  • DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode and removes it in command line mode
  • DBO_PERSISTENT: use persistant database connection
string$rememberIDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]

Implements IDatabase.

Definition at line 135 of file DBConnRef.php.

References __call().

DBConnRef::close ( )

Closes a database connection.

if it is open : commits any open transactions

Exceptions
DBError
Returns
bool Operation success. true if already closed.

Implements IDatabase.

Definition at line 225 of file DBConnRef.php.

References __call().

DBConnRef::commit (   $fname = __METHOD__,
  $flush = '' 
)

Commits a transaction previously started using begin().

If no transaction is in progress, a warning is issued.

Only call this from code with outer transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported.

Parameters
string$fname
string$flushFlush 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.

Exceptions
DBUnexpectedError

Implements IDatabase.

Definition at line 495 of file DBConnRef.php.

References __call().

DBConnRef::conditional (   $cond,
  $trueVal,
  $falseVal 
)

Returns an SQL expression for a simple conditional.

This doesn't need to be overridden unless CASE isn't supported in your DBMS.

Parameters
string | array$condSQL expression which will result in a boolean value
string$trueValSQL expression to return if true
string$falseValSQL expression to return if false
Returns
string SQL fragment

Implements IDatabase.

Definition at line 419 of file DBConnRef.php.

References __call().

DBConnRef::dataSeek (   $res,
  $row 
)

Change the position of the cursor in a result object.

See also
https://secure.php.net/mysql_data_seek
Parameters
mixed$resA SQL result
int$row

Implements IDatabase.

Definition at line 197 of file DBConnRef.php.

References __call().

DBConnRef::dbSchema (   $schema = null)

Get/set the db schema.

Parameters
string$schemaThe database schema to set, or omitted to leave it unchanged.
Returns
string The previous db schema.

Implements IDatabase.

Definition at line 75 of file DBConnRef.php.

References __call().

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.

Parameters
string | Blob$b
Returns
string

Implements IDatabase.

Definition at line 541 of file DBConnRef.php.

References __call().

DBConnRef::decodeExpiry (   $expiry,
  $format = TS_MW 
)

Decode an expiry time into a DBMS independent format.

Parameters
string$expiryDB timestamp field value for expiry
int$formatTS_* constant, defaults to TS_MW
Returns
string

Implements IDatabase.

Definition at line 581 of file DBConnRef.php.

References __call().

DBConnRef::delete (   $table,
  $conds,
  $fname = __METHOD__ 
)

DELETE query wrapper.

Parameters
string$tableTable name
string | array$condsArray of conditions. See $conds in IDatabase::select() for the format. Use $conds == "*" to delete all rows
string$fnameName of the calling function
Exceptions
DBUnexpectedError
Returns
bool|ResultWrapper

Implements IDatabase.

Definition at line 400 of file DBConnRef.php.

References __call().

DBConnRef::deleteJoin (   $delTable,
  $joinTable,
  $delVar,
  $joinVar,
  $conds,
  $fname = __METHOD__ 
)

DELETE where the condition is a join.

MySQL overrides this to use a multi-table DELETE syntax, in other databases we use sub-selects

For safety, an empty $conds will not delete everything. If you want to delete all rows where the join condition matches, set $conds='*'.

DO NOT put the join condition in $conds.

Parameters
string$delTableThe table to delete from.
string$joinTableThe other table.
string$delVarThe variable to join on, in the first table.
string$joinVarThe variable to join on, in the second table.
array$condsCondition array of field names mapped to variables, ANDed together in the WHERE clause
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBUnexpectedError

Implements IDatabase.

Definition at line 394 of file DBConnRef.php.

References __call().

DBConnRef::doAtomicSection (   $fname,
callable  $callback 
)

Run a callback to do an atomic set of updates for this database.

The $callback takes the following arguments:

  • This database object
  • The value of $fname

If any exception occurs in the callback, then rollback() will be called and the error will be re-thrown. It may also be that the rollback itself fails with an exception before then. In any case, such errors are expected to terminate the request, without any outside caller attempting to catch errors and commit anyway. Note that any rollback undoes all prior atomic section and uncommitted updates, which trashes the current request, requiring an error to be displayed.

This can be an alternative to explicit startAtomic()/endAtomic() calls.

See also
Database::startAtomic
Database::endAtomic
Parameters
string$fnameCaller name (usually METHOD)
callable$callbackCallback that issues DB updates
Returns
mixed $res Result of the callback (since 1.28)
Exceptions
DBError
RuntimeException
UnexpectedValueException
Since
1.27

Implements IDatabase.

Definition at line 487 of file DBConnRef.php.

References __call().

DBConnRef::doneWrites ( )

Returns true if the connection may have been used for write queries.

Should return true if unsure.

Returns
bool

Implements IDatabase.

Definition at line 103 of file DBConnRef.php.

References __call().

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().

Parameters
string$b
Returns
string|Blob

Implements IDatabase.

Definition at line 537 of file DBConnRef.php.

References __call().

DBConnRef::encodeExpiry (   $expiry)

Encode an expiry time into the DBMS dependent format.

Parameters
string$expiryTimestamp for expiry, or the 'infinity' string
Returns
string

Implements IDatabase.

Definition at line 577 of file DBConnRef.php.

References __call().

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.

Since
1.23
See also
IDatabase::startAtomic
Parameters
string$fname
Exceptions
DBError

Implements IDatabase.

Definition at line 483 of file DBConnRef.php.

References __call().

DBConnRef::estimateRowCount (   $table,
  $vars = '*',
  $conds = '',
  $fname = __METHOD__,
  $options = [] 
)

Estimate the number of rows in dataset.

MySQL allows you to estimate the number of rows that would be returned by a SELECT query, using EXPLAIN SELECT. The estimate is provided using index cardinality statistics, and is notoriously inaccurate, especially when large numbers of rows have recently been added or deleted.

For DBMSs that don't support fast result size estimation, this function will actually perform the SELECT COUNT(*).

Takes the same arguments as IDatabase::select().

Parameters
string$tableTable name
string$varsUnused
array | string$condsFilters on the table
string$fnameFunction name for profiling
array$optionsOptions for select
Returns
int Row count

Implements IDatabase.

Definition at line 278 of file DBConnRef.php.

References __call().

DBConnRef::explicitTrxActive ( )
Returns
bool Whether an explicit transaction or atomic sections are still open
Since
1.28

Implements IDatabase.

Definition at line 67 of file DBConnRef.php.

References __call().

DBConnRef::fetchObject (   $res)

Fetch the next row from the given result object, in object form.

Fields can be retrieved with $row->fieldname, with fields acting like member variables. If no more rows are available, false is returned.

Parameters
ResultWrapper | stdClass$resObject as returned from IDatabase::query(), etc.
Returns
stdClass|bool
Exceptions
DBUnexpectedErrorThrown if the database returns an error

Implements IDatabase.

Definition at line 173 of file DBConnRef.php.

References __call().

DBConnRef::fetchRow (   $res)

Fetch the next row from the given result object, in associative array form.

Fields are retrieved with $row['fieldname']. If no more rows are available, false is returned.

Parameters
ResultWrapper$resResult object as returned from IDatabase::query(), etc.
Returns
array|bool
Exceptions
DBUnexpectedErrorThrown if the database returns an error

Implements IDatabase.

Definition at line 177 of file DBConnRef.php.

References __call().

DBConnRef::fieldExists (   $table,
  $field,
  $fname = __METHOD__ 
)

Determines whether a field exists in a table.

Parameters
string$tableTable name
string$fieldFiled to check on that table
string$fnameCalling function name (optional)
Returns
bool Whether $table has filed $field

Implements IDatabase.

Definition at line 290 of file DBConnRef.php.

References __call().

DBConnRef::fieldInfo (   $table,
  $field 
)

mysql_fetch_field() wrapper Returns false if the field doesn't exist

Parameters
string$tableTable name
string$fieldField name
Returns
Field

Implements IDatabase.

Definition at line 209 of file DBConnRef.php.

References __call().

DBConnRef::fieldName (   $res,
  $n 
)

Get a field name in a result object.

See also
https://secure.php.net/mysql_field_name
Parameters
mixed$resA SQL result
int$n
Returns
string

Implements IDatabase.

Definition at line 189 of file DBConnRef.php.

References __call().

DBConnRef::flushSnapshot (   $fname = __METHOD__)

Commit any transaction but error out if writes or callbacks are pending.

This is intended for clearing out REPEATABLE-READ snapshots so that callers can see a new point-in-time of the database. This is useful when one of many transaction rounds finished and significant time will pass in the script's lifetime. It is also useful to call on a replica DB after waiting on replication to catch up to the master.

Parameters
string$fnameCalling function name
Exceptions
DBUnexpectedError
Since
1.28

Implements IDatabase.

Definition at line 503 of file DBConnRef.php.

References __call().

DBConnRef::freeResult (   $res)

Free a result object returned by query() or select().

It's usually not necessary to call this, just use unset() or let the variable holding the result object go out of scope.

Parameters
mixed$resA SQL result

Implements IDatabase.

Definition at line 241 of file DBConnRef.php.

References __call().

DBConnRef::getDBname ( )

Get the current DB name.

Returns
string

Implements IDatabase.

Definition at line 356 of file DBConnRef.php.

References __call().

DBConnRef::getDomainID ( )
Returns
string

Implements IDatabase.

Definition at line 151 of file DBConnRef.php.

References __call(), and Wikimedia\Rdbms\DatabaseDomain\getId().

Referenced by getWikiID().

DBConnRef::getFlag (   $flag)

Returns a boolean whether the flag $flag is set for this connection.

Parameters
int$flagDBO_* constants from Defines.php:
  • DBO_DEBUG: output some debug info (same as debug())
  • DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
  • DBO_TRX: automatically start transactions
  • DBO_PERSISTENT: use persistant database connection
Returns
bool

Implements IDatabase.

Definition at line 143 of file DBConnRef.php.

References __call().

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.

Returns
string

Implements IDatabase.

Definition at line 573 of file DBConnRef.php.

References __call().

DBConnRef::getLag ( )

Get replica DB lag.

Currently supported only by MySQL.

Note that this function will generate a fatal error on many installations. Most callers should use LoadBalancer::safeGetLag() instead.

Returns
int|bool Database replication lag in seconds or false on error

Implements IDatabase.

Definition at line 525 of file DBConnRef.php.

References __call().

DBConnRef::getLBInfo (   $name = null)

Get properties passed down from the server info array of the load balancer.

Parameters
string$nameThe entry of the info array to get, or null to get the whole array
Returns
array|mixed|null

Implements IDatabase.

Definition at line 79 of file DBConnRef.php.

References __call().

DBConnRef::getMasterPos ( )

Get the position of this master.

Returns
DBMasterPos|bool False if this is not a master

Implements IDatabase.

Definition at line 455 of file DBConnRef.php.

References __call().

DBConnRef::getProperty (   $name)

Definition at line 147 of file DBConnRef.php.

References __call().

DBConnRef::getReplicaPos ( )

Get the replication position of this replica DB.

Returns
DBMasterPos|bool False if this is not a replica DB.

Implements IDatabase.

Definition at line 451 of file DBConnRef.php.

References __call().

DBConnRef::getScopedLockAndFlush (   $lockKey,
  $fname,
  $timeout 
)

Acquire a named lock, flush any transaction, and return an RAII style unlocker object.

Only call this from outer transcation scope and when only one DB will be affected. See https://www.mediawiki.org/wiki/Database_transactions for details.

This is suitiable for transactions that need to be serialized using cooperative locks, where each transaction can see each others' changes. Any transaction is flushed to clear out stale REPEATABLE-READ snapshot data. Once the returned object falls out of PHP scope, the lock will be released unless a transaction is active. If one is active, then the lock will be released when it either commits or rolls back.

If the lock acquisition failed, then no transaction flush happens, and null is returned.

Parameters
string$lockKeyName of lock to release
string$fnameName of the calling method
int$timeoutAcquisition timeout in seconds
Returns
ScopedCallback|null
Exceptions
DBUnexpectedError
Since
1.27

Implements IDatabase.

Definition at line 565 of file DBConnRef.php.

References __call().

DBConnRef::getServer ( )

Get the server hostname or IP address.

Returns
string

Implements IDatabase.

Definition at line 360 of file DBConnRef.php.

References __call().

DBConnRef::getServerInfo ( )

A string describing the current software version, and possibly other details in a user-friendly way.

Will be listed on Special:Version, etc. Use getServerVersion() to get machine-friendly information.

Returns
string Version information from the database server

Implements IDatabase.

Definition at line 51 of file DBConnRef.php.

References __call().

DBConnRef::getServerUptime ( )

Determines how long the server has been up.

Returns
int

Implements IDatabase.

Definition at line 427 of file DBConnRef.php.

References __call().

DBConnRef::getServerVersion ( )

A string describing the current software version, like from mysql_get_server_info().

Returns
string Version information from the database server.

Implements IDatabase.

Definition at line 221 of file DBConnRef.php.

References __call().

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 AUTO-COMMIT mode, this still gives an indication of the staleness of subsequent reads.

Returns
array ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
Since
1.27

Implements IDatabase.

Definition at line 529 of file DBConnRef.php.

References __call().

DBConnRef::getSoftwareLink ( )

Returns a wikitext link to the DB's website, e.g., return "[https://www.mysql.com/ MySQL]"; Should at least contain plain text, if for some reason your database has no website.

Returns
string Wikitext of a link to the server software's web site

Implements IDatabase.

Definition at line 217 of file DBConnRef.php.

References __call().

DBConnRef::getType ( )

Get the type of the DBMS, as it appears in $wgDBtype.

Returns
string

Implements IDatabase.

Definition at line 165 of file DBConnRef.php.

References __call().

DBConnRef::getWikiID ( )

Alias for getDomainID()

Returns
string

Implements IDatabase.

Definition at line 161 of file DBConnRef.php.

References getDomainID().

DBConnRef::implicitGroupby ( )

Returns true if this database does an implicit sort when doing GROUP BY.

Returns
bool

Implements IDatabase.

Definition at line 91 of file DBConnRef.php.

References __call().

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.

Returns
bool

Implements IDatabase.

Definition at line 95 of file DBConnRef.php.

References __call().

DBConnRef::indexExists (   $table,
  $index,
  $fname = __METHOD__ 
)

Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure.

Parameters
string$table
string$index
string$fname
Returns
bool|null

Implements IDatabase.

Definition at line 294 of file DBConnRef.php.

References __call().

DBConnRef::indexUnique (   $table,
  $index 
)

Determines if a given index is unique.

Parameters
string$table
string$index
Returns
bool

Implements IDatabase.

Definition at line 302 of file DBConnRef.php.

References __call().

DBConnRef::insert (   $table,
  $a,
  $fname = __METHOD__,
  $options = [] 
)

INSERT wrapper, inserts an array into a table.

$a may be either:

  • A single associative array. The array keys are the field names, and the values are the values to insert. The values are treated as data and will be quoted appropriately. If NULL is inserted, this will be converted to a database NULL.
  • An array with numeric keys, holding a list of associative arrays. This causes a multi-row INSERT on DBMSs that support it. The keys in each subarray must be identical to each other, and in the same order.

Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns success.

$options is an array of options, with boolean options encoded as values with numeric keys, in the same style as $options in IDatabase::select(). Supported options are:

  • IGNORE: Boolean: if present, duplicate key errors are ignored, and any rows which cause duplicate key errors are not inserted. It's possible to determine how many rows were successfully inserted using IDatabase::affectedRows().
Parameters
string$tableTable name. This will be passed through Database::tableName().
array$aArray of rows to insert
string$fnameCalling function name (use METHOD) for logs/profiling
array$optionsArray of options
Returns
bool

Implements IDatabase.

Definition at line 306 of file DBConnRef.php.

References __call().

DBConnRef::insertId ( )

Get the inserted value of an auto-increment row.

The value inserted should be fetched from nextSequenceValue()

Example: $id = $dbw->nextSequenceValue( 'page_page_id_seq' ); $dbw->insert( 'page', [ 'page_id' => $id ] ); $id = $dbw->insertId();

Returns
int

Implements IDatabase.

Definition at line 193 of file DBConnRef.php.

References __call().

DBConnRef::insertSelect (   $destTable,
  $srcTable,
  $varMap,
  $conds,
  $fname = __METHOD__,
  $insertOptions = [],
  $selectOptions = [] 
)

INSERT SELECT wrapper.

Takes data from a SELECT query and inserts it into another table.

Parameters
string$destTableThe table name to insert into
string | array$srcTableMay be either a table name, or an array of table names to include in a join.
array$varMapMust 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$condsCondition array. See $conds in IDatabase::select() for the details of the format of condition arrays. May be "*" to copy the whole table.
string$fnameThe function name of the caller, from METHOD
array$insertOptionsOptions for the INSERT part of the query, see IDatabase::insert() for details.
array$selectOptionsOptions for the SELECT part of the query, see IDatabase::select() for details.
Returns
ResultWrapper

Implements IDatabase.

Definition at line 404 of file DBConnRef.php.

References __call().

DBConnRef::isOpen ( )

Is a connection to the database open?

Returns
bool

Implements IDatabase.

Definition at line 127 of file DBConnRef.php.

References __call().

DBConnRef::isReadOnly ( )
Returns
bool Whether this DB is read-only
Since
1.27

Implements IDatabase.

Definition at line 589 of file DBConnRef.php.

References __call().

DBConnRef::lastDoneWrites ( )

Returns the last time the connection may have been used for write queries.

Should return a timestamp if unsure.

Returns
int|float UNIX timestamp or false
Since
1.24

Implements IDatabase.

Definition at line 107 of file DBConnRef.php.

References __call().

DBConnRef::lastErrno ( )

Get the last error number.

See also
https://secure.php.net/mysql_errno
Returns
int

Implements IDatabase.

Definition at line 201 of file DBConnRef.php.

References __call().

DBConnRef::lastError ( )

Get a description of the last error.

See also
https://secure.php.net/mysql_error
Returns
string

Implements IDatabase.

Definition at line 205 of file DBConnRef.php.

References __call().

DBConnRef::lastQuery ( )

Return the last query that went through IDatabase::query()

Returns
string

Implements IDatabase.

Definition at line 99 of file DBConnRef.php.

References __call().

DBConnRef::listTables (   $prefix = null,
  $fname = __METHOD__ 
)

List all tables on the database.

Parameters
string$prefixOnly show tables with this prefix, e.g. mw_
string$fnameCalling function name
Exceptions
DBError
Returns
array

Implements IDatabase.

Definition at line 507 of file DBConnRef.php.

References __call().

DBConnRef::lock (   $lockName,
  $method,
  $timeout = 5 
)

Acquire a named lock.

Named locks are not related to transactions

Parameters
string$lockNameName of lock to aquire
string$methodName of the calling method
int$timeoutAcquisition timeout in seconds
Returns
bool

Implements IDatabase.

Definition at line 557 of file DBConnRef.php.

References __call().

DBConnRef::lockIsFree (   $lockName,
  $method 
)

Check to see if a named lock is available (non-blocking)

Parameters
string$lockNameName of lock to poll
string$methodName of method calling us
Returns
bool
Since
1.20

Implements IDatabase.

Definition at line 553 of file DBConnRef.php.

References __call().

DBConnRef::makeList (   $a,
  $mode = self::LIST_COMMA 
)

Makes an encoded list of strings from an array.

These can be used to make conjunctions or disjunctions on SQL condition strings derived from an array (see IDatabase::select() $conds documentation).

Example usage:

$sql = $db->makeList( [
'rev_user' => $id,
$db->makeList( [ 'rev_minor' => 1, 'rev_len' < 500 ], $db::LIST_OR ] )

This would set $sql to "rev_user = '$id' AND (rev_minor = '1' OR rev_len < '500')"

Parameters
array$aContaining the data
int$modeIDatabase class constant:
  • IDatabase::LIST_COMMA: Comma separated, no field names
  • IDatabase::LIST_AND: ANDed WHERE clause (without the WHERE).
  • IDatabase::LIST_OR: ORed WHERE clause (without the WHERE)
  • IDatabase::LIST_SET: Comma separated with field names, like a SET clause
  • IDatabase::LIST_NAMES: Comma separated field names
Exceptions
DBError
Returns
string

Implements IDatabase.

Definition at line 314 of file DBConnRef.php.

References __call().

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.

Parameters
array$dataOrganized as 2-d [ baseKeyVal => [ subKeyVal => [ignored], ... ], ... ]
string$baseKeyField name to match the base-level keys to (eg 'pl_namespace')
string$subKeyField name to match the sub-level keys to (eg 'pl_title')
Returns
string|bool SQL fragment, or false if no items in array

Implements IDatabase.

Definition at line 318 of file DBConnRef.php.

References __call().

DBConnRef::masterPosWait ( DBMasterPos  $pos,
  $timeout 
)

Wait for the replica DB to catch up to a given master position.

Parameters
DBMasterPos$pos
int$timeoutThe maximum number of seconds to wait for synchronisation
Returns
int|null Zero if the replica DB was past that position already, greater than zero if we waited for some period of time, less than zero if it timed out, and null on error

Implements IDatabase.

Definition at line 447 of file DBConnRef.php.

References __call().

DBConnRef::maxListLen ( )

Return the maximum number of items allowed in a list, or 0 for unlimited.

Returns
int

Implements IDatabase.

Definition at line 533 of file DBConnRef.php.

References __call().

DBConnRef::namedLocksEnqueue ( )

Check to see if a named lock used by lock() use blocking queues.

Returns
bool
Since
1.26

Implements IDatabase.

Definition at line 569 of file DBConnRef.php.

References __call().

DBConnRef::nextSequenceValue (   $seqName)

Returns an appropriately quoted sequence value for inserting a new row.

MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL subclass will return an integer, and save the value for insertId()

Any implementation of this function should not involve reusing sequence numbers created for rolled-back transactions. See https://bugs.mysql.com/bug.php?id=30767 for details.

Parameters
string$seqName
Returns
null|int

Implements IDatabase.

Definition at line 380 of file DBConnRef.php.

References __call().

DBConnRef::numFields (   $res)

Get the number of fields in a result object.

See also
https://secure.php.net/mysql_num_fields
Parameters
mixed$resA SQL result
Returns
int

Implements IDatabase.

Definition at line 185 of file DBConnRef.php.

References __call().

DBConnRef::numRows (   $res)

Get the number of rows in a result object.

Parameters
mixed$resA SQL result
Returns
int

Implements IDatabase.

Definition at line 181 of file DBConnRef.php.

References __call().

DBConnRef::onTransactionIdle ( callable  $callback,
  $fname = __METHOD__ 
)

Run a callback as soon as there is no transaction pending.

If there is a transaction and it is rolled back, then the callback is cancelled. Queries in the function will run in AUTO-COMMIT mode unless there are begin() calls. Callbacks must commit any transactions that they begin.

This is useful for updates to different systems or when separate transactions are needed. For example, one might want to enqueue jobs into a system outside the database, but only after the database is updated so that the jobs will see the data when they actually run. It can also be used for updates that easily cause deadlocks if locks are held too long.

Updates will execute in the order they were enqueued.

The callback takes one argument:

  • How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_IDLE)
Parameters
callable$callback
string$fnameCaller name
Since
1.20

Implements IDatabase.

Definition at line 467 of file DBConnRef.php.

References __call().

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. Callbacks must not start nor commit any transactions. If no transaction is active, then a transaction will wrap the callback.

This is useful for updates that easily cause deadlocks if locks are held too long but where atomicity is strongly desired for these updates and some related updates.

Updates will execute in the order they were enqueued.

Parameters
callable$callback
string$fnameCaller name
Since
1.22

Implements IDatabase.

Definition at line 471 of file DBConnRef.php.

References __call().

DBConnRef::onTransactionResolution ( callable  $callback,
  $fname = __METHOD__ 
)

Run a callback as soon as the current transaction commits or rolls back.

An error is thrown if no transaction is pending. Queries in the function will run in AUTO-COMMIT mode unless there are begin() calls. Callbacks must commit any transactions that they begin.

This is useful for combining cooperative locks and DB transactions.

The callback takes one argument:

  • How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK)
Parameters
callable$callback
string$fnameCaller name
Returns
mixed
Since
1.28

Implements IDatabase.

Definition at line 463 of file DBConnRef.php.

References __call().

DBConnRef::open (   $server,
  $user,
  $password,
  $dbName 
)

Open a connection to the database.

Usually aborts on failure

Parameters
string$serverDatabase server host
string$userDatabase user name
string$passwordDatabase user password
string$dbNameDatabase name
Returns
bool
Exceptions
DBConnectionError

Implements IDatabase.

Definition at line 169 of file DBConnRef.php.

References __call().

DBConnRef::pendingWriteCallers ( )

Get the list of method names that did write queries for this transaction.

Returns
array
Since
1.27

Implements IDatabase.

Definition at line 123 of file DBConnRef.php.

References __call().

DBConnRef::pendingWriteQueryDuration (   $type = self::ESTIMATE_TOTAL)

Get the time spend running write queries for this transaction.

High times could be due to scanning, updates, locking, and such

Parameters
string$typeIDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL]
Returns
float|bool Returns false if not transaction is active
Since
1.26

Implements IDatabase.

Definition at line 119 of file DBConnRef.php.

References __call().

DBConnRef::ping ( $rtt = null)

Ping the server and try to reconnect if it there is no connection.

Parameters
float | null&$rttValue to store the estimated RTT [optional]
Returns
bool Success or failure

Implements IDatabase.

Definition at line 519 of file DBConnRef.php.

References __call().

DBConnRef::query (   $sql,
  $fname = __METHOD__,
  $tempIgnore = false 
)

Run an SQL query and return the result.

Normally throws a DBQueryError on failure. If errors are ignored, returns false instead.

In new code, the query wrappers select(), insert(), update(), delete(), etc. should be used where possible, since they give much better DBMS independence and automatically quote or validate user input in a variety of contexts. This function is generally only useful for queries which are explicitly DBMS-dependent and are unsupported by the query wrappers, such as CREATE TABLE.

However, the query wrappers themselves should call this function.

Parameters
string$sqlSQL query
string$fnameName of the calling function, for profiling/SHOW PROCESSLIST comment (you can use METHOD or add some extra info)
bool$tempIgnoreWhether to avoid throwing an exception on errors... maybe best to catch the exception instead?
Exceptions
DBError
Returns
bool|ResultWrapper True for a successful write query, ResultWrapper object for a successful read query, or false on failure if $tempIgnore set

Implements IDatabase.

Definition at line 233 of file DBConnRef.php.

References __call().

DBConnRef::replace (   $table,
  $uniqueIndexes,
  $rows,
  $fname = __METHOD__ 
)

REPLACE query wrapper.

REPLACE is a very handy MySQL extension, which functions like an INSERT except that when there is a duplicate key error, the old row is deleted and the new row is inserted in its place.

We simulate this with standard SQL with a DELETE followed by INSERT. To perform the delete, we need to know what the unique indexes are so that we know how to find the conflicting rows.

It may be more efficient to leave off unique indexes which are unlikely to collide. However if you do this, you run the risk of encountering errors which wouldn't have occurred in MySQL.

Parameters
string$tableThe table to replace the row(s) in.
array$uniqueIndexesIs an array of indexes. Each element may be either a field name or an array of field names
array$rowsCan be either a single row to insert, or multiple rows, in the same format as for IDatabase::insert()
string$fnameCalling function name (use METHOD) for logs/profiling

Implements IDatabase.

Definition at line 384 of file DBConnRef.php.

References __call().

DBConnRef::reportConnectionError (   $error = 'Unknown error')
Parameters
string$errorFallback error message, used if none is given by DB
Exceptions
DBConnectionError

Implements IDatabase.

Definition at line 229 of file DBConnRef.php.

References __call().

DBConnRef::reportQueryError (   $error,
  $errno,
  $sql,
  $fname,
  $tempIgnore = false 
)

Report a query error.

Log the error, and if neither the object ignore flag nor the $tempIgnore flag is set, throw a DBQueryError.

Parameters
string$error
int$errno
string$sql
string$fname
bool$tempIgnore
Exceptions
DBQueryError

Implements IDatabase.

Definition at line 237 of file DBConnRef.php.

References __call().

DBConnRef::restoreFlags (   $state = self::RESTORE_PRIOR)

Restore the flags to their prior state before the last setFlag/clearFlag call.

Parameters
string$stateIDatabase::RESTORE_* constant. [default: RESTORE_PRIOR]
Since
1.28

Implements IDatabase.

Definition at line 139 of file DBConnRef.php.

References __call().

DBConnRef::rollback (   $fname = __METHOD__,
  $flush = '' 
)

Rollback a transaction previously started using begin().

If no transaction is in progress, a warning is issued.

Only call this from code with outer transcation scope. See https://www.mediawiki.org/wiki/Database_transactions for details. Nesting of transactions is not supported. If a serious unexpected error occurs, throwing an Exception is preferrable, using a pre-installed error handler to trigger rollback (in any case, failure to issue COMMIT will cause rollback server-side).

Parameters
string$fnameCalling function name
string$flushFlush flag, set to a situationally valid IDatabase::FLUSHING_* constant to disable warnings about calling rollback when no transaction is in progress. This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure that it is safe to ignore these warnings in your context.
Exceptions
DBUnexpectedError
Since
1.23 Added $flush parameter

Implements IDatabase.

Definition at line 499 of file DBConnRef.php.

References __call().

DBConnRef::select (   $table,
  $vars,
  $conds = '',
  $fname = __METHOD__,
  $options = [],
  $join_conds = [] 
)

Execute a SELECT query constructed using the various parameters provided.

See below for full details of the parameters.

Parameters
string | array$tableTable name
string | array$varsField names
string | array$condsConditions
string$fnameCaller function name
array$optionsQuery options
array$join_condsJoin conditions
string | array$tableMay be either an array of table names, or a single string holding a table name. If an array is given, table aliases can be specified, for example:

[ 'a' => 'user' ]

This includes the user table in the query, with the alias "a" available for use in field names (e.g. a.user_name).

All of the table names given here are automatically run through Database::tableName(), which causes the table prefix (if any) to be added, and various other table name mappings to be performed.

Do not use untrusted user input as a table name. Alias names should not have characters outside of the Basic multilingual plane.

Parameters
string | array$varsMay 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.

Parameters
string | array$condsMay 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:

  • Elements with a numeric key are interpreted as raw SQL fragments.
  • Elements with a string key are interpreted as equality conditions, where the key is the field name.
    • If the value of such an array element is a scalar (such as a string), it will be treated as data and thus quoted appropriately. If it is null, an IS NULL clause will be added.
    • If the value is an array, an IN (...) clause will be constructed from its non-null elements, and an IS NULL clause will be added if null is present, such that the field may match any of the elements in the array. The non-null elements will be quoted.

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()

Parameters
string | array$optionsOptional: 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:

  • OFFSET: Skip this many rows at the start of the result set. OFFSET with LIMIT can theoretically be used for paging through a result set, but this is discouraged for performance reasons.
  • LIMIT: Integer: return at most this many rows. The rows are sorted and then the first rows are taken until the limit is reached. LIMIT is applied to a result set after OFFSET.
  • FOR UPDATE: Boolean: lock the returned rows so that they can't be changed until the next COMMIT.
  • DISTINCT: Boolean: return only unique result rows.
  • GROUP BY: May be either an SQL fragment string naming a field or expression to group by, or an array of such SQL fragments.
  • HAVING: May be either an string containing a HAVING clause or an array of conditions building the HAVING clause. If an array is given, the conditions constructed from each element are combined with AND.
  • ORDER BY: May be either an SQL fragment giving a field name or expression to order by, or an array of such SQL fragments.
  • USE INDEX: This may be either a string giving the index name to use for the query, or an array. If it is an associative array, each key gives the table name (or alias), each value gives the index name to use for that table. All strings are SQL fragments and so should be validated by the caller.
  • EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run, instead of SELECT.

And also the following boolean MySQL extensions, see the MySQL manual for documentation:

  • LOCK IN SHARE MODE
  • STRAIGHT_JOIN
  • HIGH_PRIORITY
  • SQL_BIG_RESULT
  • SQL_BUFFER_RESULT
  • SQL_SMALL_RESULT
  • SQL_CALC_FOUND_ROWS
  • SQL_CACHE
  • SQL_NO_CACHE
Parameters
string | array$join_condsOptional associative array of table-specific join conditions. In the most common case, this is unnecessary, since the join condition can be in $conds. However, it is useful for doing a LEFT JOIN.

The key of the array contains the table name or alias. The value is an array with two elements, numbered 0 and 1. The first gives the type of join, the second is the same as the $conds parameter. Thus it can be an SQL fragment, or an array where the string keys are equality and the numeric keys are SQL fragments all AND'd together. For example:

[ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]

Returns
ResultWrapper|bool If the query returned no rows, a ResultWrapper with no rows in it will be returned. If there was a query error, a DBQueryError exception will be thrown, except if the "ignore errors" option was set, in which case false will be returned.

Implements IDatabase.

Definition at line 257 of file DBConnRef.php.

References __call().

DBConnRef::selectDB (   $db)

Change the current database.

Parameters
string$db
Returns
bool Success or failure

Implements IDatabase.

Definition at line 352 of file DBConnRef.php.

References __call().

DBConnRef::selectField (   $table,
  $var,
  $cond = '',
  $fname = __METHOD__,
  $options = [] 
)

A SELECT wrapper which returns a single field from a single result row.

Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns false on failure.

If no result rows are returned from the query, false is returned.

Parameters
string | array$tableTable name. See IDatabase::select() for details.
string$varThe field name to select. This must be a valid SQL fragment: do not use unvalidated user input.
string | array$condThe condition array. See IDatabase::select() for details.
string$fnameThe function name of the caller.
string | array$optionsThe query options. See IDatabase::select() for details.
Returns
bool|mixed The value from the field, or false on failure.

Implements IDatabase.

Definition at line 245 of file DBConnRef.php.

References __call().

DBConnRef::selectFieldValues (   $table,
  $var,
  $cond = '',
  $fname = __METHOD__,
  $options = [] 
)

A SELECT wrapper which returns a list of single field values from result rows.

Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns false on failure.

If no result rows are returned from the query, false is returned.

Parameters
string | array$tableTable name. See IDatabase::select() for details.
string$varThe field name to select. This must be a valid SQL fragment: do not use unvalidated user input.
string | array$condThe condition array. See IDatabase::select() for details.
string$fnameThe function name of the caller.
string | array$optionsThe query options. See IDatabase::select() for details.
Returns
bool|array The values from the field, or false on failure
Since
1.25

Implements IDatabase.

Definition at line 251 of file DBConnRef.php.

References __call().

DBConnRef::selectRow (   $table,
  $vars,
  $conds,
  $fname = __METHOD__,
  $options = [],
  $join_conds = [] 
)

Single row SELECT wrapper.

Equivalent to IDatabase::select(), except that a single row object is returned. If the query returns no rows, false is returned.

Parameters
string | array$tableTable name
string | array$varsField names
array$condsConditions
string$fnameCaller function name
string | array$optionsQuery options
array | string$join_condsJoin conditions
Returns
stdClass|bool

Implements IDatabase.

Definition at line 271 of file DBConnRef.php.

References __call().

DBConnRef::selectRowCount (   $tables,
  $vars = '*',
  $conds = '',
  $fname = __METHOD__,
  $options = [],
  $join_conds = [] 
)

Get the number of rows in dataset.

This is useful when trying to do COUNT(*) but with a LIMIT for performance.

Takes the same arguments as IDatabase::select().

Since
1.27 Added $join_conds parameter
Parameters
array | string$tablesTable names
string$varsUnused
array | string$condsFilters on the table
string$fnameFunction name for profiling
array$optionsOptions for select
array$join_condsJoin conditions (since 1.27)
Returns
int Row count

Implements IDatabase.

Definition at line 284 of file DBConnRef.php.

References __call().

DBConnRef::selectSQLText (   $table,
  $vars,
  $conds = '',
  $fname = __METHOD__,
  $options = [],
  $join_conds = [] 
)

The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed.

This can be useful for doing UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().

Parameters
string | array$tableTable name
string | array$varsField names
string | array$condsConditions
string$fnameCaller function name
string | array$optionsQuery options
string | array$join_condsJoin conditions
Returns
string SQL query string.
See also
IDatabase::select()

Implements IDatabase.

Definition at line 264 of file DBConnRef.php.

References __call().

DBConnRef::serverIsReadOnly ( )
Returns
bool Whether the DB is marked as read-only server-side
Since
1.28

Implements IDatabase.

Definition at line 459 of file DBConnRef.php.

References __call().

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.

Parameters
bool | string$valueTrue for allow, false for deny, or "default" to restore the initial value

Implements IDatabase.

Definition at line 585 of file DBConnRef.php.

References __call().

DBConnRef::setFlag (   $flag,
  $remember = self::REMEMBER_NOTHING 
)

Set a flag for this connection.

Parameters
int$flagDBO_* constants from Defines.php:
  • DBO_DEBUG: output some debug info (same as debug())
  • DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
  • DBO_TRX: automatically start transactions
  • DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode and removes it in command line mode
  • DBO_PERSISTENT: use persistant database connection
string$rememberIDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]

Implements IDatabase.

Definition at line 131 of file DBConnRef.php.

References __call().

DBConnRef::setLazyMasterHandle ( IDatabase  $conn)

Set a lazy-connecting DB handle to the master DB (for replication status purposes)

Parameters
IDatabase$conn
Since
1.27

Implements IDatabase.

Definition at line 87 of file DBConnRef.php.

References __call().

DBConnRef::setLBInfo (   $name,
  $value = null 
)

Set the LB info array, or a member of it.

If called with one parameter, the LB info array is set to that parameter. If it is called with two parameters, the member with the given name is set to the given value.

Parameters
string$name
array$value

Implements IDatabase.

Definition at line 83 of file DBConnRef.php.

References __call().

DBConnRef::setSchemaVars (   $vars)

Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS.

If an array is set here, $GLOBALS will not be used at all. If it's set to false, $GLOBALS will be used.

Parameters
bool | array$varsMapping variable name to value.

Implements IDatabase.

Definition at line 549 of file DBConnRef.php.

References __call().

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.

Parameters
array$options
Returns
void

Implements IDatabase.

Definition at line 545 of file DBConnRef.php.

References __call().

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.

Parameters
array[]$aliases Map of (table => (dbname, schema, prefix) map)
Since
1.28

Implements IDatabase.

Definition at line 593 of file DBConnRef.php.

References __call().

DBConnRef::setTransactionListener (   $name,
callable  $callback = null 
)

Run a callback each time any transaction commits or rolls back.

The callback takes two arguments:

  • IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK
  • This IDatabase object Callbacks must commit any transactions that they begin.

Registering a callback here will not affect writesOrCallbacks() pending

Parameters
string$nameCallback name
callable | null$callbackUse null to unset a listener
Returns
mixed
Since
1.28

Implements IDatabase.

Definition at line 475 of file DBConnRef.php.

References __call().

DBConnRef::startAtomic (   $fname = __METHOD__)

Begin an atomic section of statements.

If a transaction has been started already, just keep track of the given section name to make sure the transaction is not committed pre-maturely. This function can be used in layers (with sub-sections), so use a stack to keep track of the different atomic sections. If there is no transaction, start one implicitly.

The goal of this function is to create an atomic section of SQL queries without having to start a new transaction if it already exists.

All atomic levels must be explicitly closed using IDatabase::endAtomic(), and any database transactions cannot be began or committed until all atomic levels are closed. There is no such thing as implicitly opening or closing an atomic section.

Since
1.23
Parameters
string$fname
Exceptions
DBError

Implements IDatabase.

Definition at line 479 of file DBConnRef.php.

References __call().

DBConnRef::strreplace (   $orig,
  $old,
  $new 
)

Returns a comand for str_replace function in SQL query.

Uses REPLACE() in MySQL

Parameters
string$origColumn to modify
string$oldColumn to seek
string$newColumn to replace with
Returns
string

Implements IDatabase.

Definition at line 423 of file DBConnRef.php.

References __call().

DBConnRef::tableExists (   $table,
  $fname = __METHOD__ 
)

Query whether a given table exists.

Parameters
string$table
string$fname
Returns
bool

Implements IDatabase.

Definition at line 298 of file DBConnRef.php.

References __call().

DBConnRef::tablePrefix (   $prefix = null)

Get/set the table prefix.

Parameters
string$prefixThe table prefix to set, or omitted to leave it unchanged.
Returns
string The previous table prefix.

Implements IDatabase.

Definition at line 71 of file DBConnRef.php.

References __call().

DBConnRef::timestamp (   $ts = 0)

Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS.

The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.

Parameters
string | int$ts
Returns
string

Implements IDatabase.

Definition at line 511 of file DBConnRef.php.

References __call().

DBConnRef::timestampOrNull (   $ts = null)

Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS.

If NULL is input, it is passed through, allowing NULL values to be inserted into timestamp fields.

The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.

Parameters
string | int$ts
Returns
string

Implements IDatabase.

Definition at line 515 of file DBConnRef.php.

References __call().

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.

Returns
int The previous value

Implements IDatabase.

Definition at line 59 of file DBConnRef.php.

References __call().

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.

Returns
float|null Returns null if there is not active transaction
Since
1.25

Implements IDatabase.

Definition at line 63 of file DBConnRef.php.

References __call().

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.

Parameters
array$sqlsSQL statements to combine
bool$allUse UNION ALL
Returns
string SQL fragment

Implements IDatabase.

Definition at line 415 of file DBConnRef.php.

References __call().

DBConnRef::unionSupportsOrderAndLimit ( )

Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct.

Returns
bool

Implements IDatabase.

Definition at line 411 of file DBConnRef.php.

References __call().

DBConnRef::unlock (   $lockName,
  $method 
)

Release a lock.

Named locks are not related to transactions

Parameters
string$lockNameName of lock to release
string$methodName of the calling method
Returns
int Returns 1 if the lock was released, 0 if the lock was not established by this thread (in which case the lock is not released), and NULL if the named lock did not exist

Implements IDatabase.

Definition at line 561 of file DBConnRef.php.

References __call().

DBConnRef::update (   $table,
  $values,
  $conds,
  $fname = __METHOD__,
  $options = [] 
)

UPDATE wrapper.

Takes a condition array and a SET array.

Parameters
string$tableName of the table to UPDATE. This will be passed through Database::tableName().
array$valuesAn array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by IDatabase::addQuotes(). Values with integer keys form unquoted SET statements, which can be used for things like "field = field + 1" or similar computed values.
array$condsAn array of conditions (WHERE). See IDatabase::select() for the details of the format of condition arrays. Use '*' to update all rows.
string$fnameThe function name of the caller (from METHOD), for logging and profiling.
array$optionsAn array of UPDATE options, can be:
  • IGNORE: Ignore unique key conflicts
  • LOW_PRIORITY: MySQL-specific, see MySQL manual.
Returns
bool

Implements IDatabase.

Definition at line 310 of file DBConnRef.php.

References __call().

DBConnRef::upsert (   $table,
array  $rows,
array  $uniqueIndexes,
array  $set,
  $fname = __METHOD__ 
)

INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.

This updates any conflicting rows (according to the unique indexes) using the provided SET clause and inserts any remaining (non-conflicted) rows.

$rows may be either:

  • A single associative array. The array keys are the field names, and the values are the values to insert. The values are treated as data and will be quoted appropriately. If NULL is inserted, this will be converted to a database NULL.
  • An array with numeric keys, holding a list of associative arrays. This causes a multi-row INSERT on DBMSs that support it. The keys in each subarray must be identical to each other, and in the same order.

It may be more efficient to leave off unique indexes which are unlikely to collide. However if you do this, you run the risk of encountering errors which wouldn't have occurred in MySQL.

Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns success.

Since
1.22
Parameters
string$tableTable name. This will be passed through Database::tableName().
array$rowsA single row or list of rows to insert
array$uniqueIndexesList of single field names or field name tuples
array$setAn array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by IDatabase::addQuotes(). Values with integer keys form unquoted SET statements, which can be used for things like "field = field + 1" or similar computed values.
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
Exception
Returns
bool

Implements IDatabase.

Definition at line 388 of file DBConnRef.php.

References __call().

DBConnRef::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

Returns
bool

Implements IDatabase.

Definition at line 431 of file DBConnRef.php.

References __call().

DBConnRef::wasErrorReissuable ( )

Determines if the last query error was due to a dropped connection and should be dealt with by pinging the connection and reissuing the query.

Returns
bool

Implements IDatabase.

Definition at line 439 of file DBConnRef.php.

References __call().

DBConnRef::wasLockTimeout ( )

Determines if the last failure was due to a lock timeout.

Returns
bool

Implements IDatabase.

Definition at line 435 of file DBConnRef.php.

References __call().

DBConnRef::wasReadOnlyError ( )

Determines if the last failure was due to the database being read-only.

Returns
bool

Implements IDatabase.

Definition at line 443 of file DBConnRef.php.

References __call().

DBConnRef::writesOrCallbacksPending ( )

Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish.

This does not count recurring callbacks, e.g. from setTransactionListener().

Returns
bool

Implements IDatabase.

Definition at line 115 of file DBConnRef.php.

References __call().

DBConnRef::writesPending ( )
Returns
bool Whether there is a transaction open with possible write queries
Since
1.27

Implements IDatabase.

Definition at line 111 of file DBConnRef.php.

References __call().

Member Data Documentation

Database null DBConnRef::$conn
private

Live connection handle.

Definition at line 19 of file DBConnRef.php.

Referenced by __construct().

ILoadBalancer DBConnRef::$lb
private

Definition at line 17 of file DBConnRef.php.

Referenced by __construct().

array null DBConnRef::$params
private

N-tuple of (server index, group, DatabaseDomain|string)

Definition at line 21 of file DBConnRef.php.

Referenced by __call().

const DBConnRef::FLD_DOMAIN = 2

Definition at line 25 of file DBConnRef.php.

const DBConnRef::FLD_GROUP = 1

Definition at line 24 of file DBConnRef.php.

const DBConnRef::FLD_INDEX = 0

Definition at line 23 of file DBConnRef.php.


The documentation for this class was generated from the following file: