MediaWiki
1.30.2
|
Public Member Functions | |
__construct (array $p) | |
Constructor and database handle and attempt to connect to the DB server. More... | |
__destruct () | |
Run a few simple sanity checks and close dangling connections. More... | |
addIdentifierQuotes ( $s) | |
Quotes an identifier using backticks or "double quotes" depending on the database type. 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 function call. More... | |
bitAnd ( $fieldLeft, $fieldRight) | |
bitNot ( $field) | |
bitOr ( $fieldLeft, $fieldRight) | |
buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[]) | |
Build a GROUP_CONCAT or equivalent statement for a query. More... | |
buildStringCast ( $field) | |
dataSeek ( $res, $row) | |
decodeBlob ( $b) | |
Some DBMSs return a special placeholder object representing blob fields in result objects. More... | |
delete ( $table, $conds, $fname=__METHOD__) | |
DELETE query wrapper. More... | |
dropTable ( $tableName, $fName=__METHOD__) | |
Delete a table. More... | |
duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__) | |
Creates a new table with structure copied from existing table. More... | |
encodeBlob ( $b) | |
Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. More... | |
execFlags () | |
fetchObject ( $res) | |
fetchRow ( $res) | |
fieldInfo ( $table, $field) | |
fieldName ( $stmt, $n) | |
Get a field name in a result object. More... | |
freeResult ( $res) | |
Frees resources associated with the LOB descriptor. More... | |
getDBname () | |
Get the current DB name. More... | |
getInfinity () | |
Find out when 'infinity' is. More... | |
getServer () | |
Get the server hostname or IP address. More... | |
getServerVersion () | |
getSoftwareLink () | |
getType () | |
Get the type of the DBMS, as it appears in $wgDBtype. 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__) | |
Query whether a given index exists. More... | |
indexInfo ( $table, $index, $fname=__METHOD__) | |
Returns information about an index If errors are explicitly ignored, returns NULL on failure. More... | |
indexUnique ( $table, $index, $fname=__METHOD__) | |
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... | |
isQuotedIdentifier ( $s) | |
Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers . More... | |
lastErrno () | |
Get the last error number. More... | |
lastError () | |
Get a description of the last error. More... | |
limitResult ( $sql, $limit, $offset=false) | |
Construct a LIMIT query with optional offset. More... | |
listTables ( $prefix=null, $fname=__METHOD__) | |
List all tables on the database. More... | |
makeSelectOptions ( $options) | |
Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. More... | |
nativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |
Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory. More... | |
numFields ( $res) | |
numRows ( $res) | |
open ( $server, $user, $password, $dbName) | |
Usually aborts on failure. More... | |
queryIgnore ( $sql, $fname='') | |
removeIdentifierQuotes ( $s) | |
selectDB ( $db) | |
Change the current database. More... | |
selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[]) | |
Single row SELECT wrapper. More... | |
sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null) | |
Read and execute commands from an open file handle. More... | |
strencode ( $s) | |
Wrapper for addslashes() More... | |
tableExists ( $table, $fname=__METHOD__) | |
Query whether a given table exists (in the given schema, or the default mw one if not given) More... | |
tableName ( $name, $format='quoted') | |
Format a table name ready for use in constructing an SQL query. More... | |
tableNameInternal ( $name) | |
textFieldSize ( $table, $field) | |
Returns the size of a text field, or -1 for "unlimited". More... | |
timestamp ( $ts=0) | |
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More... | |
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... | |
update ( $table, $values, $conds, $fname=__METHOD__, $options=[]) | |
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... | |
Public Member Functions inherited from Wikimedia\Rdbms\Database | |
__clone () | |
Make sure that copies do not share the same client binding handle. More... | |
__sleep () | |
Called by serialize. More... | |
__toString () | |
anyChar () | |
Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More... | |
anyString () | |
Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More... | |
begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT) | |
Begin a transaction. More... | |
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... | |
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... | |
clearFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Clear a flag for this connection. More... | |
close () | |
Closes a database connection. More... | |
commit ( $fname=__METHOD__, $flush='') | |
Commits a transaction previously started using begin(). More... | |
conditional ( $cond, $trueVal, $falseVal) | |
Returns an SQL expression for a simple conditional. More... | |
connectionErrorLogger ( $errno, $errstr) | |
Error handler for logging errors during database connection This method should not be used outside of Database classes. More... | |
databasesAreIndependent () | |
Returns true if DBs are assumed to be on potentially different servers. More... | |
dbSchema ( $schema=null) | |
Get/set the db schema. More... | |
deadlockLoop () | |
Perform a deadlock-prone transaction. More... | |
decodeExpiry ( $expiry, $format=TS_MW) | |
Decode an expiry time into a DBMS independent format. 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... | |
encodeExpiry ( $expiry) | |
Encode an expiry time into the DBMS dependent format. More... | |
endAtomic ( $fname=__METHOD__) | |
Ends an atomic section of SQL statements. More... | |
estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=[]) | |
Estimate the number of rows in dataset. More... | |
explicitTrxActive () | |
fieldExists ( $table, $field, $fname=__METHOD__) | |
Determines whether a field exists in a table. More... | |
flushSnapshot ( $fname=__METHOD__) | |
Commit any transaction but error out if writes or callbacks are pending. More... | |
getDomainID () | |
getFlag ( $flag) | |
Returns a boolean whether the flag $flag is set for this connection. 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... | |
getServerInfo () | |
A string describing the current software version, and possibly other details in a user-friendly way. More... | |
getServerUptime () | |
Determines how long the server has been up. More... | |
getSessionLagStatus () | |
Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More... | |
getWikiID () | |
Alias for getDomainID() More... | |
ignoreIndexClause ( $index) | |
IGNORE INDEX clause. More... | |
indexUnique ( $table, $index) | |
Determines if a given index is unique. More... | |
insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[]) | |
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... | |
lastQuery () | |
Return the last query that went through IDatabase::query() More... | |
listViews ( $prefix=null, $fname=__METHOD__) | |
Lists all the VIEWs in the database. More... | |
lock ( $lockName, $method, $timeout=5) | |
Acquire a named lock. More... | |
lockIsFree ( $lockName, $method) | |
Check to see if a named lock is available (non-blocking) More... | |
lockTables (array $read, array $write, $method) | |
Lock specific tables. More... | |
makeList ( $a, $mode=self::LIST_COMMA) | |
Makes an encoded list of strings from an array. More... | |
makeWhereFrom2d ( $data, $baseKey, $subKey) | |
Build a partial where clause from a 2-d array such as used for LinkBatch. More... | |
masterPosWait (DBMasterPos $pos, $timeout) | |
Wait for the replica DB to catch up to a given master position. More... | |
maxListLen () | |
Return the maximum number of items allowed in a list, or 0 for unlimited. More... | |
namedLocksEnqueue () | |
Check to see if a named lock used by lock() use blocking queues. More... | |
nextSequenceValue ( $seqName) | |
Deprecated method, calls should be removed. More... | |
onTransactionIdle (callable $callback, $fname=__METHOD__) | |
Run a callback as soon as there is no transaction pending. More... | |
onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__) | |
Run a callback before the current transaction commits or now if there is none. More... | |
onTransactionResolution (callable $callback, $fname=__METHOD__) | |
Run a callback as soon as the current transaction commits or rolls back. More... | |
pendingWriteCallers () | |
Get the list of method names that did write queries for this transaction. More... | |
pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL) | |
Get the time spend running write queries for this transaction. More... | |
pendingWriteRowsAffected () | |
Get the number of affected rows from pending write queries. More... | |
ping (&$rtt=null) | |
Ping the server and try to reconnect if it there is no connection. More... | |
query ( $sql, $fname=__METHOD__, $tempIgnore=false) | |
Run an SQL query and return the result. More... | |
replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__) | |
REPLACE query wrapper. More... | |
reportConnectionError ( $error='Unknown error') | |
reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false) | |
Report a query error. More... | |
restoreFlags ( $state=self::RESTORE_PRIOR) | |
Restore the flags to their prior state before the last setFlag/clearFlag call. More... | |
rollback ( $fname=__METHOD__, $flush='') | |
Rollback a transaction previously started using begin(). More... | |
runOnTransactionIdleCallbacks ( $trigger) | |
Actually run and consume any "on transaction idle/resolution" callbacks. More... | |
runOnTransactionPreCommitCallbacks () | |
Actually run and consume any "on transaction pre-commit" callbacks. More... | |
runTransactionListenerCallbacks ( $trigger) | |
Actually run any "transaction listener" callbacks. More... | |
select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Execute a SELECT query constructed using the various parameters provided. More... | |
selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
A SELECT wrapper which returns a single field from a single result row. More... | |
selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
A SELECT wrapper which returns a list of single field values from result rows. More... | |
selectRowCount ( $tables, $vars=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Get the number of rows in dataset. More... | |
selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
The equivalent of IDatabase::select() except that the constructed SQL is returned, instead of being immediately executed. More... | |
serverIsReadOnly () | |
setBigSelects ( $value=true) | |
Allow or deny "big selects" for this session only. More... | |
setFlag ( $flag, $remember=self::REMEMBER_NOTHING) | |
Set a flag for this connection. More... | |
setLazyMasterHandle (IDatabase $conn) | |
Set a lazy-connecting DB handle to the master DB (for replication status purposes) More... | |
setLBInfo ( $name, $value=null) | |
Set the LB info array, or a member of it. More... | |
setLogger (LoggerInterface $logger) | |
Set the PSR-3 logger interface to use for query logging. More... | |
setSchemaVars ( $vars) | |
Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS. More... | |
setSessionOptions (array $options) | |
Override database's default behavior. More... | |
setTableAliases (array $aliases) | |
Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name. More... | |
setTransactionListener ( $name, callable $callback=null) | |
Run a callback each time any transaction commits or rolls back. More... | |
setTrxEndCallbackSuppression ( $suppress) | |
Whether to disable running of post-COMMIT/ROLLBACK callbacks. More... | |
sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null) | |
Read and execute SQL commands from a file. More... | |
startAtomic ( $fname=__METHOD__) | |
Begin an atomic section of statements. More... | |
streamStatementEnd (&$sql, &$newLine) | |
Called by sourceStream() to check if we've reached a statement end. More... | |
strreplace ( $orig, $old, $new) | |
Returns a command for str_replace function in SQL query. More... | |
tableLocksHaveTransactionScope () | |
Checks if table locks acquired by lockTables() are transaction-bound in their scope. More... | |
tableNames () | |
Fetch a number of table names into an array This is handy when you need to construct SQL for joins. More... | |
tableNamesN () | |
Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins. More... | |
tablePrefix ( $prefix=null) | |
Get/set the table prefix. More... | |
timestampOrNull ( $ts=null) | |
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS. More... | |
trxLevel () | |
Gets the current transaction level. More... | |
trxTimestamp () | |
Get the UNIX timestamp of the time that the transaction was established. More... | |
unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[]) | |
Construct a UNION query for permutations of conditions. More... | |
unionSupportsOrderAndLimit () | |
Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct. More... | |
unlock ( $lockName, $method) | |
Release a lock. More... | |
unlockTables ( $method) | |
Unlock all tables locked via lockTables() More... | |
useIndexClause ( $index) | |
USE INDEX clause. More... | |
wasConnectionError ( $errno) | |
Do not use this method outside of Database/DBError classes. 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 () | |
Protected Member Functions | |
closeConnection () | |
Closes a database connection, if it is open Returns success, true if already closed. More... | |
doBegin ( $fname=__METHOD__) | |
Issues the BEGIN command to the database server. More... | |
doCommit ( $fname=__METHOD__) | |
Issues the COMMIT command to the database server. More... | |
doQuery ( $sql) | |
The DBMS-dependent part of query() More... | |
doRollback ( $fname=__METHOD__) | |
Issues the ROLLBACK command to the database server. More... | |
Protected Member Functions inherited from Wikimedia\Rdbms\Database | |
assertOpen () | |
Make sure isOpen() returns true as a sanity check. More... | |
doLockTables (array $read, array $write, $method) | |
Helper function for lockTables() that handles the actual table locking. More... | |
doUnlockTables ( $method) | |
Helper function for unlockTables() that handles the actual table unlocking. More... | |
escapeLikeInternal ( $s, $escapeChar='`') | |
fieldNamesWithAlias ( $fields) | |
Gets an array of aliased field names. More... | |
fieldNameWithAlias ( $name, $alias=false) | |
Get an aliased field name e.g. More... | |
getApproximateLagStatus () | |
Get a replica DB lag estimate for this server. More... | |
getBindingHandle () | |
Get the underlying binding handle, mConn. More... | |
getDefaultSchemaVars () | |
Get schema variables to use if none have been set via setSchemaVars(). More... | |
getLastPHPError () | |
getLazyMasterHandle () | |
getLogContext (array $extras=[]) | |
Create a log context to pass to PSR-3 logger functions. More... | |
getQueryVerb ( $sql) | |
getReadOnlyReason () | |
getSchemaVars () | |
Get schema variables. More... | |
getTransactionLagStatus () | |
Get the replica DB lag when the current transaction started. More... | |
ignoreErrors ( $ignoreErrors=null) | |
Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors. More... | |
indexName ( $index) | |
Allows for index remapping in queries where this is not consistent across DBMS. More... | |
installErrorHandler () | |
Set a custom error handler for logging errors during database connection. More... | |
isTransactableQuery ( $sql) | |
Determine whether a SQL statement is sensitive to isolation level. More... | |
isWriteQuery ( $sql) | |
Determine whether a query writes to the DB. More... | |
makeGroupByWithHaving ( $options) | |
Returns an optional GROUP BY with an optional HAVING. More... | |
makeInsertOptions ( $options) | |
Helper for Database::insert(). More... | |
makeOrderBy ( $options) | |
Returns an optional ORDER BY. More... | |
makeUpdateOptions ( $options) | |
Make UPDATE options for the Database::update function. More... | |
makeUpdateOptionsArray ( $options) | |
Make UPDATE options array for Database::makeUpdateOptions. More... | |
nativeReplace ( $table, $rows, $fname) | |
REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More... | |
pendingWriteAndCallbackCallers () | |
Get the list of method names that have pending write queries or callbacks for this transaction. More... | |
qualifiedTableComponents ( $name) | |
Get the table components needed for a query given the currently selected database. More... | |
reconnect () | |
Close existing database connection and open a new connection. More... | |
registerTempTableOperation ( $sql) | |
replaceVars ( $ins) | |
Database independent variable replacement. More... | |
requiresDatabaseUser () | |
restoreErrorHandler () | |
Restore the previous error handler and return the last PHP error for this DB. More... | |
resultObject ( $result) | |
Take the result from a query, and wrap it in a ResultWrapper if necessary. More... | |
tableNamesWithAlias ( $tables) | |
Gets an array of aliased table names. More... | |
tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[]) | |
Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause. More... | |
tableNameWithAlias ( $name, $alias=false) | |
Get an aliased table name e.g. More... | |
Protected Attributes | |
int | $mAffectedRows |
The number of rows affected as an integer. More... | |
resource | $mLastResult = null |
Protected Attributes inherited from Wikimedia\Rdbms\Database | |
string | $agent |
Agent name for query profiling. More... | |
bool | $cliMode |
Whether this PHP instance is for a CLI script. More... | |
LoggerInterface | $connLogger |
DatabaseDomain | $currentDomain |
string | $delimiter = ';' |
callback | $errorLogger |
Error logging callback. More... | |
string bool null | $htmlErrors |
Stashed value of html_errors INI setting. More... | |
float | $lastPing = 0.0 |
UNIX timestamp. More... | |
resource null | $mConn = null |
Database connection. More... | |
string | $mDBname |
bool null | $mDefaultBigSelects = null |
int | $mFlags |
string | $mLastQuery = '' |
SQL query. More... | |
float bool | $mLastWriteTime = false |
UNIX timestamp of last write query. More... | |
array | $mLBInfo = [] |
bool | $mOpened = false |
string | $mPassword |
string bool | $mPHPError = false |
string | $mSchema = '' |
array bool | $mSchemaVars = false |
string | $mServer |
array | $mSessionTempTables = [] |
Map of (table name => 1) for TEMPORARY tables. More... | |
array | $mSessionVars = [] |
string | $mTablePrefix = '' |
array[] | $mTrxEndCallbacks = [] |
List of (callable, method name) More... | |
bool | $mTrxEndCallbacksSuppressed = false |
Whether to suppress triggering of transaction end callbacks. More... | |
array[] | $mTrxIdleCallbacks = [] |
List of (callable, method name) More... | |
int | $mTrxLevel = 0 |
Either 1 if a transaction is active or 0 otherwise. More... | |
array[] | $mTrxPreCommitCallbacks = [] |
List of (callable, method name) More... | |
callable[] | $mTrxRecurringCallbacks = [] |
Map of (name => callable) More... | |
string | $mTrxShortId = '' |
Either a short hexidecimal string if a transaction is active or "". More... | |
string | $mUser |
array null | $preparedArgs |
object string | $profiler |
Class name or object With profileIn/profileOut methods. More... | |
LoggerInterface | $queryLogger |
BagOStuff | $srvCache |
APC cache. More... | |
$tableAliases = [] | |
TransactionProfiler | $trxProfiler |
Private Member Functions | |
fieldBindStatement ( $table, $col, &$val, $includeCol=false) | |
fieldInfoMulti ( $table, $field) | |
Function translates mysql_fetch_field() functionality on ORACLE. More... | |
getSequenceData ( $table) | |
Return sequence_name if table has a sequence. More... | |
insertOneRow ( $table, $row, $fname) | |
wrapConditionsForWhere ( $table, $conds, $parentCol=null) | |
wrapFieldForWhere ( $table, &$col, &$val) | |
Private Attributes | |
string | $defaultCharset = 'AL32UTF8' |
Character set for Oracle database. More... | |
bool | $ignoreDupValOnIndex = false |
array | $mFieldInfoCache = [] |
bool array | $sequenceData = null |
Additional Inherited Members | |
Static Public Member Functions inherited from Wikimedia\Rdbms\Database | |
static | factory ( $dbType, $p=[]) |
Construct a Database subclass instance given a database type and parameters. More... | |
static | getCacheSetOptions (IDatabase $db1) |
Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination. More... | |
Public Attributes inherited from Wikimedia\Rdbms\Database | |
const | DEADLOCK_DELAY_MAX = 1500000 |
Maximum time to wait before retry. More... | |
const | DEADLOCK_DELAY_MIN = 500000 |
Minimum time to wait before retry, in microseconds. More... | |
const | DEADLOCK_TRIES = 4 |
Number of times to re-try an operation in case of deadlock. More... | |
const | PING_QUERY = 'SELECT 1 AS ping' |
const | PING_TTL = 1.0 |
How long before it is worth doing a dummy query to test the connection. More... | |
const | SLOW_WRITE_SEC = 0.500 |
const | SMALL_WRITE_ROWS = 100 |
const | TINY_WRITE_SEC = 0.010 |
Static Protected Member Functions inherited from Wikimedia\Rdbms\Database | |
static | generalizeSQL ( $sql) |
Removes most variables from an SQL query and replaces them with X or N for numbers. More... | |
Definition at line 33 of file DatabaseOracle.php.
DatabaseOracle::__construct | ( | array | $params | ) |
Constructor and database handle and attempt to connect to the DB server.
IDatabase classes should not be constructed directly in external code. Database::factory() should be used instead.
array | $params | Parameters passed from Database::factory() |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 52 of file DatabaseOracle.php.
References $wgDBprefix, global, and Hooks\run().
DatabaseOracle::__destruct | ( | ) |
Run a few simple sanity checks and close dangling connections.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 63 of file DatabaseOracle.php.
References Wikimedia\Rdbms\Database\close().
DatabaseOracle::addIdentifierQuotes | ( | $s | ) |
Quotes an identifier using backticks
or "double quotes" depending on the database type.
MySQL uses backticks
while basically everything else uses double quotes. Since MySQL is the odd one out here the double quotes are our generic and we implement backticks in DatabaseMysqlBase.
string | $s |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1078 of file DatabaseOracle.php.
References $s, and DBO_DDLMODE.
DatabaseOracle::addQuotes | ( | $s | ) |
Adds quotes and backslashes.
string | int | null | bool | Blob | $s |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1069 of file DatabaseOracle.php.
References $s, $wgContLang, and global.
DatabaseOracle::affectedRows | ( | ) |
Get the number of rows affected by the last write query.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 357 of file DatabaseOracle.php.
DatabaseOracle::aggregateValue | ( | $valuedata, | |
$valuename = 'value' |
|||
) |
Return aggregated value function call.
array | $valuedata | |
string | $valuename |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 786 of file DatabaseOracle.php.
DatabaseOracle::bitAnd | ( | $fieldLeft, | |
$fieldRight | |||
) |
string | $fieldLeft | |
string | $fieldRight |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1334 of file DatabaseOracle.php.
DatabaseOracle::bitNot | ( | $field | ) |
string | $field |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1329 of file DatabaseOracle.php.
DatabaseOracle::bitOr | ( | $fieldLeft, | |
$fieldRight | |||
) |
string | $fieldLeft | |
string | $fieldRight |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1338 of file DatabaseOracle.php.
DatabaseOracle::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 |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1350 of file DatabaseOracle.php.
DatabaseOracle::buildStringCast | ( | $field | ) |
string | $field | Field or column to cast |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1363 of file DatabaseOracle.php.
|
protected |
Closes a database connection, if it is open Returns success, true if already closed.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 183 of file DatabaseOracle.php.
DatabaseOracle::dataSeek | ( | $res, | |
$row | |||
) |
mixed | $res | |
int | $row |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 329 of file DatabaseOracle.php.
References $res.
DatabaseOracle::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 |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 706 of file DatabaseOracle.php.
DatabaseOracle::delete | ( | $table, | |
$conds, | |||
$fname = __METHOD__ |
|||
) |
DELETE query wrapper.
string | $table | Table name |
string | array | $conds | Array of conditions. See $conds in IDatabase::select() for the format. Use $conds == "*" to delete all rows |
string | $fname | Name of the calling function |
DBUnexpectedError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1181 of file DatabaseOracle.php.
References $fname, and tableName().
|
protected |
Issues the BEGIN command to the database server.
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 937 of file DatabaseOracle.php.
|
protected |
Issues the COMMIT command to the database server.
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 942 of file DatabaseOracle.php.
References $ret.
|
protected |
The DBMS-dependent part of query()
string | $sql | SQL query. |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 191 of file DatabaseOracle.php.
References code, DBO_DDLMODE, FROM, Wikimedia\Rdbms\Database\getFlag(), MWTimestamp\getLocalInstance(), StringUtils\isUtf8(), message, and wfDebug().
Referenced by open().
|
protected |
Issues the ROLLBACK command to the database server.
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 953 of file DatabaseOracle.php.
DatabaseOracle::dropTable | ( | $tableName, | |
$fName = __METHOD__ |
|||
) |
Delete a table.
string | $tableName | |
string | $fName |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 766 of file DatabaseOracle.php.
References tableName().
DatabaseOracle::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 |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 725 of file DatabaseOracle.php.
DatabaseOracle::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 |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 702 of file DatabaseOracle.php.
DatabaseOracle::execFlags | ( | ) |
Definition at line 187 of file DatabaseOracle.php.
DatabaseOracle::fetchObject | ( | $res | ) |
ResultWrapper | ORAResult | $res |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 271 of file DatabaseOracle.php.
References $res.
DatabaseOracle::fetchRow | ( | $res | ) |
ResultWrapper | ORAResult | $res |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 283 of file DatabaseOracle.php.
References $res.
|
private |
Definition at line 406 of file DatabaseOracle.php.
DatabaseOracle::fieldInfo | ( | $table, | |
$field | |||
) |
DBUnexpectedError |
string | $table | |
string | $field |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 929 of file DatabaseOracle.php.
|
private |
Function translates mysql_fetch_field() functionality on ORACLE.
Caching is present for reducing query time. For internal calls. Use fieldInfo for normal usage. Returns false if the field doesn't exist
array | string | $table | |
string | $field |
Definition at line 871 of file DatabaseOracle.php.
References $e, $res, as, and ORAField\tableName().
DatabaseOracle::fieldName | ( | $res, | |
$n | |||
) |
Get a field name in a result object.
mixed | $res | A SQL result |
int | $n |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 315 of file DatabaseOracle.php.
DatabaseOracle::freeResult | ( | $res | ) |
Frees resources associated with the LOB descriptor.
ResultWrapper | ORAResult | $res |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 259 of file DatabaseOracle.php.
References $res.
DatabaseOracle::getDBname | ( | ) |
Get the current DB name.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1342 of file DatabaseOracle.php.
DatabaseOracle::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.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1367 of file DatabaseOracle.php.
|
private |
Return sequence_name if table has a sequence.
string | $table |
Definition at line 653 of file DatabaseOracle.php.
References tableName().
DatabaseOracle::getServer | ( | ) |
Get the server hostname or IP address.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1346 of file DatabaseOracle.php.
DatabaseOracle::getServerVersion | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 800 of file DatabaseOracle.php.
DatabaseOracle::getSoftwareLink | ( | ) |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 793 of file DatabaseOracle.php.
DatabaseOracle::getType | ( | ) |
Get the type of the DBMS, as it appears in $wgDBtype.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 71 of file DatabaseOracle.php.
DatabaseOracle::implicitGroupby | ( | ) |
Returns true if this database does an implicit sort when doing GROUP BY.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 75 of file DatabaseOracle.php.
DatabaseOracle::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.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 79 of file DatabaseOracle.php.
DatabaseOracle::indexExists | ( | $table, | |
$index, | |||
$fname = __METHOD__ |
|||
) |
Query whether a given index exists.
string | $table | |
string | $index | |
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 821 of file DatabaseOracle.php.
References $res, and tableName().
DatabaseOracle::indexInfo | ( | $table, | |
$index, | |||
$fname = __METHOD__ |
|||
) |
Returns information about an index If errors are explicitly ignored, returns NULL on failure.
string | $table | |
string | $index | |
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 369 of file DatabaseOracle.php.
DatabaseOracle::indexUnique | ( | $table, | |
$index, | |||
$fname = __METHOD__ |
|||
) |
Definition at line 373 of file DatabaseOracle.php.
DatabaseOracle::insert | ( | $table, | |
$a, | |||
$fname = __METHOD__ , |
|||
$options = [] |
|||
) |
INSERT wrapper, inserts an array into a table.
$a may be either:
Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns success.
$options is an array of options, with boolean options encoded as values with numeric keys, in the same style as $options in IDatabase::select(). Supported options are:
string | $table | Table name. This will be passed through Database::tableName(). |
array | $a | Array of rows to insert |
string | $fname | Calling function name (use METHOD) for logs/profiling |
array | $options | Array of options |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 377 of file DatabaseOracle.php.
References $fname, $options, as, and captcha-old\count.
DatabaseOracle::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 319 of file DatabaseOracle.php.
|
private |
string | $table | |
array | $row | |
string | $fname |
DBUnexpectedError |
Definition at line 448 of file DatabaseOracle.php.
References $e, $wgContLang, as, global, and tableName().
DatabaseOracle::isQuotedIdentifier | ( | $name | ) |
Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers .
string | $name |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1090 of file DatabaseOracle.php.
References $s.
DatabaseOracle::lastErrno | ( | ) |
Get the last error number.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 347 of file DatabaseOracle.php.
References $e.
DatabaseOracle::lastError | ( | ) |
Get a description of the last error.
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 337 of file DatabaseOracle.php.
References $e.
Referenced by open().
DatabaseOracle::limitResult | ( | $sql, | |
$limit, | |||
$offset = false |
|||
) |
Construct a LIMIT query with optional offset.
This is used for query pages. The SQL should be adjusted so that only the first $limit rows are returned. If $offset is provided as well, then the first $offset rows should be discarded, and the next $limit rows should be returned. If the result of the query is not ordered, then the rows to be returned are theoretically arbitrary.
$sql is expected to be a SELECT, if that makes a difference.
The version provided by default works in MySQL and SQLite. It will very likely need to be overridden for most other DBMSes.
string | $sql | SQL query we will append the limit too |
int | $limit | The SQL limit |
int | bool | $offset | The SQL offset (default false) |
DBUnexpectedError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 694 of file DatabaseOracle.php.
DatabaseOracle::listTables | ( | $prefix = null , |
|
$fname = __METHOD__ |
|||
) |
List all tables on the database.
string | $prefix | Only show tables with this prefix, e.g. mw_ |
string | $fname | Calling function name |
DBError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 741 of file DatabaseOracle.php.
DatabaseOracle::makeSelectOptions | ( | $options | ) |
Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.
array | $options | An associative array of options to be turned into an SQL query, valid keys are listed in the function. |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1143 of file DatabaseOracle.php.
DatabaseOracle::nativeInsertSelect | ( | $destTable, | |
$srcTable, | |||
$varMap, | |||
$conds, | |||
$fname = __METHOD__ , |
|||
$insertOptions = [] , |
|||
$selectOptions = [] , |
|||
$selectJoinConds = [] |
|||
) |
Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory.
string | $destTable | |
string | array | $srcTable | |
array | $varMap | |
array | $conds | |
string | $fname | |
array | $insertOptions | |
array | $selectOptions | |
array | $selectJoinConds |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 555 of file DatabaseOracle.php.
References tableName().
DatabaseOracle::numFields | ( | $res | ) |
ResultWrapper | ORAResult | $res |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 307 of file DatabaseOracle.php.
References $res.
DatabaseOracle::numRows | ( | $res | ) |
ResultWrapper | ORAResult | $res |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 295 of file DatabaseOracle.php.
References $res.
DatabaseOracle::open | ( | $server, | |
$user, | |||
$password, | |||
$dbName | |||
) |
Usually aborts on failure.
string | $server | |
string | $user | |
string | $password | |
string | $dbName |
DBConnectionError |
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 92 of file DatabaseOracle.php.
References Wikimedia\Rdbms\Database\$mConn, $user, $wgDBOracleDRCP, Wikimedia\Rdbms\Database\close(), DBO_DEFAULT, DBO_PERSISTENT, DBO_SYSDBA, doQuery(), e, global, is(), lastError(), return, selectDB(), and Wikimedia\Rdbms\Database\setFlag().
DatabaseOracle::queryIgnore | ( | $sql, | |
$fname = '' |
|||
) |
Definition at line 251 of file DatabaseOracle.php.
DatabaseOracle::removeIdentifierQuotes | ( | $s | ) |
Definition at line 1086 of file DatabaseOracle.php.
References $s.
DatabaseOracle::selectDB | ( | $db | ) |
Change the current database.
string | $db |
DBConnectionError | If databasesAreIndependent() is true and an error occurs |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1043 of file DatabaseOracle.php.
Referenced by open().
DatabaseOracle::selectRow | ( | $table, | |
$vars, | |||
$conds, | |||
$fname = __METHOD__ , |
|||
$options = [] , |
|||
$join_conds = [] |
|||
) |
Single row SELECT wrapper.
Equivalent to IDatabase::select(), except that a single row object is returned. If the query returns no rows, false is returned.
string | array | $table | Table name |
string | array | $vars | Field names |
array | $conds | Conditions |
string | $fname | Caller function name |
string | array | $options | Query options |
array | string | $join_conds | Join conditions |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1125 of file DatabaseOracle.php.
DatabaseOracle::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 |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 961 of file DatabaseOracle.php.
DatabaseOracle::strencode | ( | $s | ) |
Wrapper for addslashes()
string | $s | String to be slashed. |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1065 of file DatabaseOracle.php.
References $s.
DatabaseOracle::tableExists | ( | $table, | |
$fname = __METHOD__ |
|||
) |
Query whether a given table exists (in the given schema, or the default mw one if not given)
string | $table | |
string | $fname |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 844 of file DatabaseOracle.php.
References $res, and tableName().
DatabaseOracle::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 |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 623 of file DatabaseOracle.php.
References $name.
DatabaseOracle::tableNameInternal | ( | $name | ) |
Definition at line 641 of file DatabaseOracle.php.
References $name, and tableName().
DatabaseOracle::textFieldSize | ( | $table, | |
$field | |||
) |
Returns the size of a text field, or -1 for "unlimited".
string | $table | |
string | $field |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 688 of file DatabaseOracle.php.
DatabaseOracle::timestamp | ( | $ts = 0 | ) |
Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS.
The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
string | int | $ts |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 775 of file DatabaseOracle.php.
References wfTimestamp().
DatabaseOracle::unionQueries | ( | $sqls, | |
$all | |||
) |
Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.
array | $sqls | SQL statements to combine |
bool | $all | Use UNION ALL |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 714 of file DatabaseOracle.php.
DatabaseOracle::update | ( | $table, | |
$values, | |||
$conds, | |||
$fname = __METHOD__ , |
|||
$options = [] |
|||
) |
string | $table | |
array | $values | |
array | $conds | |
string | $fname | |
array | $options |
DBUnexpectedError |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 1224 of file DatabaseOracle.php.
References $e, $options, $wgContLang, as, global, LIST_AND, and tableName().
DatabaseOracle::upsert | ( | $table, | |
array | $rows, | ||
array | $uniqueIndexes, | ||
array | $set, | ||
$fname = __METHOD__ |
|||
) |
INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
This updates any conflicting rows (according to the unique indexes) using the provided SET clause and inserts any remaining (non-conflicted) rows.
$rows may be either:
It may be more efficient to leave off unique indexes which are unlikely to collide. However if you do this, you run the risk of encountering errors which wouldn't have occurred in MySQL.
Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns success.
string | $table | Table name. This will be passed through Database::tableName(). |
array | $rows | A single row or list of rows to insert |
array | $uniqueIndexes | List of single field names or field name tuples |
array | $set | An array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by IDatabase::addQuotes(). Values with integer keys form unquoted SET statements, which can be used for things like "field = field + 1" or similar computed values. |
string | $fname | Calling function name (use METHOD) for logs/profiling |
Exception |
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 597 of file DatabaseOracle.php.
DatabaseOracle::wasDeadlock | ( | ) |
Determines if the last failure was due to a deadlock.
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 721 of file DatabaseOracle.php.
|
private |
Definition at line 1107 of file DatabaseOracle.php.
References as.
|
private |
Definition at line 1094 of file DatabaseOracle.php.
References $wgContLang, and global.
|
private |
Character set for Oracle database.
Definition at line 47 of file DatabaseOracle.php.
|
private |
Definition at line 41 of file DatabaseOracle.php.
|
protected |
The number of rows affected as an integer.
Definition at line 38 of file DatabaseOracle.php.
|
private |
Definition at line 50 of file DatabaseOracle.php.
|
protected |
Definition at line 35 of file DatabaseOracle.php.
|
private |
Definition at line 44 of file DatabaseOracle.php.