MediaWiki  master
DatabaseOracle Class Reference
Inheritance diagram for DatabaseOracle:
Collaboration diagram for DatabaseOracle:

Public Member Functions

 __construct (array $params)
 
 __destruct ()
 
 addIdentifierQuotes ( $s)
 Quotes an identifier, in order to make user controlled input safe. More...
 
 addQuotes ( $s)
 Adds quotes and backslashes. 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)
 
 buildSubstring ( $input, $startPosition, $length=null)
 
 dataSeek ( $res, $row)
 
 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...
 
 getInfinity ()
 Find out when 'infinity' is. 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)
 
 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=[])
 
 numFields ( $res)
 
 numRows ( $res)
 
 queryIgnore ( $sql, $fname='')
 
 remappedTableName ( $name)
 
 removeIdentifierQuotes ( $s)
 
 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)
 
 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, $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...
 
 __destruct ()
 Run a few simple sanity checks and close dangling connections. More...
 
 __sleep ()
 Called by serialize. More...
 
 __toString ()
 Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present. More...
 
 addIdentifierQuotes ( $s)
 Quotes an identifier, in order to make user controlled input safe. 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...
 
 assertNoOpenTransactions ()
 Assert that all explicit transactions or atomic sections have been closed. More...
 
 begin ( $fname=__METHOD__, $mode=self::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...
 
 buildIntegerCast ( $field)
 
 buildLike ( $param,... $params)
 
 buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery. More...
 
 buildStringCast ( $field)
 
 buildSubstring ( $input, $startPosition, $length=null)
 
 cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
 Cancel an atomic section of SQL statements. More...
 
 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection. More...
 
 close ()
 Close the database connection. More...
 
 commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 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...
 
 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, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Perform an atomic section of reversable SQL statements from a callback. More...
 
 doneWrites ()
 Returns true if the connection may have been used for write queries. 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...
 
 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, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 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...
 
 freeResult ( $res)
 Free a result object returned by query() or select(). More...
 
 getDBname ()
 Get the current DB name. More...
 
 getDomainID ()
 Return the currently selected domain ID. More...
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is. More...
 
 getLag ()
 Get the amount of replication lag for this database server. 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...
 
 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...
 
 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...
 
 indexInfo ( $table, $index, $fname=__METHOD__)
 Get information about an index into an object. More...
 
 indexUnique ( $table, $index)
 Determines if a given index is unique. More...
 
 initConnection ()
 Initialize the connection to the database over the wire (or to local files) More...
 
 insert ( $table, $a, $fname=__METHOD__, $options=[])
 INSERT wrapper, inserts an array into a table. More...
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 INSERT SELECT wrapper. More...
 
 isOpen ()
 Is a connection to the database open? More...
 
 isQuotedIdentifier ( $name)
 Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers . More...
 
 isReadOnly ()
 
 lastDoneWrites ()
 Returns the last time the connection may have been used for write queries. More...
 
 lastQuery ()
 Return the last query that sent on account of IDatabase::query() 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...
 
 listViews ( $prefix=null, $fname=__METHOD__)
 Lists all the VIEWs in the database. More...
 
 lock ( $lockName, $method, $timeout=5)
 Acquire a named lock. More...
 
 lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Lock all rows meeting the given conditions/options FOR UPDATE. More...
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is not locked by any thread (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...
 
 onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback as soon as there is no transaction pending. More...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Alias for onTransactionCommitOrIdle() for backwards-compatibility. 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...
 
 pendingWriteAndCallbackCallers ()
 List the methods that have write queries or callbacks for the current transaction. 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...
 
 preCommitCallbacksPending ()
 
 query ( $sql, $fname=__METHOD__, $flags=0)
 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, $ignore=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=self::FLUSHING_ONE)
 Rollback a transaction previously started using begin(). More...
 
 runOnTransactionIdleCallbacks ( $trigger)
 Actually consume and run any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually consume and run 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...
 
 selectDB ( $db)
 Change the current database. More...
 
 selectDomain ( $domain)
 Set the current domain (database, schema, and table prefix) 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...
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Single row SELECT wrapper. More...
 
 selectRowCount ( $tables, $var=' *', $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...
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB. 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 after 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...
 
 sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
 Read and execute commands from an open file handle. More...
 
 startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Begin an atomic section of SQL statements. More...
 
 streamStatementEnd (&$sql, &$newLine)
 Called by sourceStream() to check if we've reached a statement end. More...
 
 strencode ( $s)
 Wrapper for addslashes() More...
 
 strreplace ( $orig, $old, $new)
 Returns a command for str_replace function in SQL query. More...
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 tableLocksHaveTransactionScope ()
 Checks if table locks acquired by lockTables() are transaction-bound in their scope. More...
 
 tableName ( $name, $format='quoted')
 Format a table name ready for use in constructing an SQL query. 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...
 
 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...
 
 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...
 
 trxStatus ()
 
 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...
 
 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...
 
 unlockTables ( $method)
 Unlock all tables locked via lockTables() More...
 
 update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
 UPDATE wrapper. More...
 
 upsert ( $table, array $rows, $uniqueIndexes, array $set, $fname=__METHOD__)
 INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. More...
 
 useIndexClause ( $index)
 USE INDEX clause. More...
 
 wasConnectionError ( $errno)
 Do not use this method outside of Database/DBError classes. More...
 
 wasConnectionLoss ()
 Determines if the last query error was due to a dropped connection. More...
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock. More...
 
 wasErrorReissuable ()
 Determines if the last query error was due to something outside of the query itself. 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 ()
 Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. More...
 
 writesPending ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\IDatabase
 buildLike ( $param)
 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...
 
 buildSubString ( $input, $startPosition, $length=null)
 Build a SUBSTRING function. More...
 

Protected Member Functions

 closeConnection ()
 Closes a database connection, if it is open Returns success, true if already closed. More...
 
 doBegin ( $fname=__METHOD__)
 
 doCommit ( $fname=__METHOD__)
 
 doQuery ( $sql)
 
 doRollback ( $fname=__METHOD__)
 
 doSelectDomain (DatabaseDomain $domain)
 
 fetchAffectedRowCount ()
 
 open ( $server, $user, $password, $dbName, $schema, $tablePrefix)
 
- Protected Member Functions inherited from Wikimedia\Rdbms\Database
 __construct (array $params)
 
 assertBuildSubstringParams ( $startPosition, $length)
 Check type and bounds for parameters to self::buildSubstring() More...
 
 assertHasConnectionHandle ()
 Make sure there is an open connection handle (alive or not) as a sanity check. More...
 
 assertIsWritableMaster ()
 Make sure that this server is not marked as a replica nor read-only as a sanity check. More...
 
 closeConnection ()
 Closes underlying database connection. More...
 
 doBegin ( $fname)
 Issues the BEGIN command to the database server. More...
 
 doCommit ( $fname)
 Issues the COMMIT command to the database server. More...
 
 doGetLag ()
 
 doInitConnection ()
 Actually connect to the database over the wire (or to local files) More...
 
 doLockTables (array $read, array $write, $method)
 Helper function for lockTables() that handles the actual table locking. More...
 
 doQuery ( $sql)
 Run a query and return a DBMS-dependent wrapper or boolean. More...
 
 doReleaseSavepoint ( $identifier, $fname)
 Release a savepoint. More...
 
 doRollback ( $fname)
 Issues the ROLLBACK command to the database server. More...
 
 doRollbackToSavepoint ( $identifier, $fname)
 Rollback to a savepoint. More...
 
 doSavepoint ( $identifier, $fname)
 Create a savepoint. More...
 
 doSelectDomain (DatabaseDomain $domain)
 
 doUnlockTables ( $method)
 Helper function for unlockTables() that handles the actual table unlocking. More...
 
 escapeLikeInternal ( $s, $escapeChar='`')
 
 executeQuery ( $sql, $fname, $flags)
 Execute a query, retrying it if there is a recoverable connection loss. More...
 
 extractSingleFieldFromList ( $var)
 
 fetchAffectedRowCount ()
 
 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 connection handle. 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 ()
 
 getRecordedTransactionLagStatus ()
 Get the replica DB lag when the current transaction started. More...
 
 getSchemaVars ()
 Get schema variables. More...
 
 getTransactionRoundId ()
 
 hasFlags ( $field, $flags)
 
 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...
 
 isInsertSelectSafe (array $insertOptions, array $selectOptions)
 
 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...
 
 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...
 
 makeUpdateOptions ( $options)
 Make UPDATE options for the Database::update function. More...
 
 makeUpdateOptionsArray ( $options)
 Make UPDATE options array for Database::makeUpdateOptions. 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...
 
 nativeReplace ( $table, $rows, $fname)
 REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More...
 
 nonNativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 Implementation of insertSelect() based on select() and insert() More...
 
 normalizeConditions ( $conds, $fname)
 
 open ( $server, $user, $password, $dbName, $schema, $tablePrefix)
 Open a new connection to the database (closing any existing one) More...
 
 qualifiedTableComponents ( $name)
 Get the table components needed for a query given the currently selected database. More...
 
 registerTempTableWrite ( $sql, $pseudoPermanent)
 
 relationSchemaQualifier ()
 
 replaceLostConnection ( $fname)
 Close any existing (dead) database connection and open a new connection. More...
 
 replaceVars ( $ins)
 Database independent variable replacement. More...
 
 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 ( $table, $alias=false)
 Get an aliased table name. More...
 
 wasKnownStatementRollbackError ()
 
 wasQueryTimeout ( $error, $errno)
 Checks whether the cause of the error is detected to be a timeout. More...
 

Protected Attributes

int $mAffectedRows
 The number of rows affected as an integer. More...
 
resource $mLastResult = null
 
- Protected Attributes inherited from Wikimedia\Rdbms\Database
integer null $affectedRowCount
 Rows affected by the last query to query() or its CRUD wrappers. More...
 
string $agent
 Agent name for query profiling. More...
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
object resource null $conn = null
 Database connection. More...
 
array $connectionParams = []
 Parameters used by initConnection() to establish a connection. More...
 
array $connectionVariables = []
 SQL variables values to use for all new connections. More...
 
LoggerInterface $connLogger
 
DatabaseDomain $currentDomain
 
string $delimiter = ';'
 Current SQL query delimiter. More...
 
callable $deprecationLogger
 Deprecation logging callback. More...
 
callable $errorLogger
 Error logging callback. More...
 
int $flags
 Bitfield of class DBO_* constants. More...
 
string bool null $htmlErrors
 Stashed value of html_errors INI setting. More...
 
string [] $indexAliases = []
 Map of (index alias => index) More...
 
array $lbInfo = []
 LoadBalancer tracking information. More...
 
int $nonNativeInsertSelectBatchSize = 10000
 
bool $opened = false
 Whether a connection handle is open (connection itself might be dead) More...
 
string $password
 Password used to establish the current connection. More...
 
callable null $profiler
 
LoggerInterface $queryLogger
 
array bool $schemaVars = false
 Variables use for schema element placeholders. More...
 
string $server
 Server that this instance is currently connected to. More...
 
array $sessionNamedLocks = []
 Map of (name => 1) for locks obtained via lock() More...
 
array $sessionTempTables = []
 Map of (table name => 1) for TEMPORARY tables. More...
 
BagOStuff $srvCache
 APC cache. More...
 
array [] $tableAliases = []
 Map of (table => (dbname, schema, prefix) map) More...
 
int $trxLevel = 0
 Whether there is an active transaction (1 or 0) More...
 
TransactionProfiler $trxProfiler
 
string $trxShortId = ''
 Hexidecimal string if a transaction is active or empty string otherwise. More...
 
int $trxStatus = self::STATUS_TRX_NONE
 Transaction status. More...
 
Exception null $trxStatusCause
 The last error that caused the status to become STATUS_TRX_ERROR. More...
 
string $user
 User that this instance is currently connected under the name of. More...
 

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...
 
 getVerifiedUTF8 ( $s)
 
 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
 
string [] $keywordTableMap = []
 Map of (reserved table name => alternate table name) More...
 
array $mFieldInfoCache = []
 
bool array $sequenceData = null
 

Additional Inherited Members

- Static Public Member Functions inherited from Wikimedia\Rdbms\Database
static attributesFromType ( $dbType, $driver=null)
 
static factory ( $dbType, $p=[], $connect=self::NEW_CONNECTED)
 Construct a Database subclass instance given a database type and parameters. More...
 
static getCacheSetOptions (IDatabase $db1, IDatabase $db2=null)
 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...
 
- Static Protected Member Functions inherited from Wikimedia\Rdbms\Database
static getAttributes ()
 

Detailed Description

Definition at line 37 of file DatabaseOracle.php.

Constructor & Destructor Documentation

◆ __construct()

DatabaseOracle::__construct ( array  $params)
See also
Database::__construct()
Parameters
array$paramsAdditional parameters include:
  • keywordTableMap : Map of reserved table names to alternative table names to use

Definition at line 64 of file DatabaseOracle.php.

◆ __destruct()

DatabaseOracle::__destruct ( )

Definition at line 70 of file DatabaseOracle.php.

References Wikimedia\Rdbms\Database\close().

Member Function Documentation

◆ addIdentifierQuotes()

DatabaseOracle::addIdentifierQuotes (   $s)

Quotes an identifier, in order to make user controlled input safe.

Depending on the database this will either be backticks or "double quotes"

Parameters
string$s
Returns
string
Since
1.33

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1091 of file DatabaseOracle.php.

References $s, DBO_DDLMODE, and Wikimedia\Rdbms\Database\getFlag().

Referenced by doSelectDomain().

◆ addQuotes()

DatabaseOracle::addQuotes (   $s)

Adds quotes and backslashes.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1087 of file DatabaseOracle.php.

References $s, getVerifiedUTF8(), and strencode().

Referenced by buildGroupConcatField(), and tableExists().

◆ aggregateValue()

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

Return aggregated value function call.

Parameters
array$valuedata
string$valuename
Returns
mixed

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 791 of file DatabaseOracle.php.

◆ bitAnd()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1354 of file DatabaseOracle.php.

◆ bitNot()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1349 of file DatabaseOracle.php.

◆ bitOr()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1358 of file DatabaseOracle.php.

◆ buildGroupConcatField()

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.

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 Wikimedia\Rdbms\IDatabase.

Definition at line 1362 of file DatabaseOracle.php.

References addQuotes(), null, and Wikimedia\Rdbms\Database\selectSQLText().

◆ buildStringCast()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1384 of file DatabaseOracle.php.

◆ buildSubstring()

DatabaseOracle::buildSubstring (   $input,
  $startPosition,
  $length = null 
)

◆ closeConnection()

DatabaseOracle::closeConnection ( )
protected

Closes a database connection, if it is open Returns success, true if already closed.

Returns
bool

Definition at line 177 of file DatabaseOracle.php.

◆ dataSeek()

DatabaseOracle::dataSeek (   $res,
  $row 
)
Parameters
mixed$res
int$row

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 326 of file DatabaseOracle.php.

References $res.

◆ delete()

DatabaseOracle::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 Return true if no exception was thrown (deprecated since 1.33)
Exceptions
DBError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1192 of file DatabaseOracle.php.

References $wgActorTableSchemaMigrationStage, SCHEMA_COMPAT_WRITE_OLD, tableName(), update(), and wrapConditionsForWhere().

◆ doBegin()

DatabaseOracle::doBegin (   $fname = __METHOD__)
protected

Definition at line 945 of file DatabaseOracle.php.

References doQuery(), and Wikimedia\Rdbms\Database\trxLevel().

◆ doCommit()

DatabaseOracle::doCommit (   $fname = __METHOD__)
protected

Definition at line 950 of file DatabaseOracle.php.

References $ret, doQuery(), lastError(), and Wikimedia\Rdbms\Database\trxLevel().

◆ doQuery()

DatabaseOracle::doQuery (   $sql)
protected

◆ doRollback()

DatabaseOracle::doRollback (   $fname = __METHOD__)
protected

Definition at line 961 of file DatabaseOracle.php.

References doQuery(), and Wikimedia\Rdbms\Database\trxLevel().

◆ doSelectDomain()

◆ dropTable()

DatabaseOracle::dropTable (   $tableName,
  $fName = __METHOD__ 
)

Delete a table.

Parameters
string$tableName
string$fName
Returns
bool|IResultWrapper

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 769 of file DatabaseOracle.php.

References doQuery(), tableExists(), and tableName().

◆ duplicateTableStructure()

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

Parameters
string$oldNameName of table whose structure should be copied
string$newNameName of table to be created
bool$temporaryWhether the new table should be temporary
string$fnameCalling function name
Returns
bool True if operation was successful
Exceptions
RuntimeException

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 727 of file DatabaseOracle.php.

◆ encodeBlob()

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

Parameters
string$b
Returns
string|Blob

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 712 of file DatabaseOracle.php.

◆ execFlags()

DatabaseOracle::execFlags ( )

Definition at line 181 of file DatabaseOracle.php.

References Wikimedia\Rdbms\Database\trxLevel().

Referenced by fieldInfoMulti(), insertOneRow(), and update().

◆ fetchAffectedRowCount()

DatabaseOracle::fetchAffectedRowCount ( )
protected

Definition at line 354 of file DatabaseOracle.php.

References $mAffectedRows.

◆ fetchObject()

DatabaseOracle::fetchObject (   $res)
Parameters
IResultWrapper | ORAResult$res
Returns
stdClass|bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 268 of file DatabaseOracle.php.

References $res.

◆ fetchRow()

DatabaseOracle::fetchRow (   $res)
Parameters
IResultWrapper | ORAResult$res
Returns
stdClass|bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 280 of file DatabaseOracle.php.

References $res.

Referenced by insertId().

◆ fieldBindStatement()

DatabaseOracle::fieldBindStatement (   $table,
  $col,
$val,
  $includeCol = false 
)
private

Definition at line 402 of file DatabaseOracle.php.

References fieldInfoMulti(), and null.

Referenced by insertOneRow(), and update().

◆ fieldInfo()

DatabaseOracle::fieldInfo (   $table,
  $field 
)
Exceptions
DBUnexpectedError
Parameters
string$table
string$field
Returns
ORAField

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 934 of file DatabaseOracle.php.

References fieldInfoMulti().

◆ fieldInfoMulti()

DatabaseOracle::fieldInfoMulti (   $table,
  $field 
)
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

Parameters
array | string$table
string$field
Returns
ORAField|ORAResult|false

Definition at line 876 of file DatabaseOracle.php.

References $e, $res, as, execFlags(), null, removeIdentifierQuotes(), Wikimedia\Rdbms\Database\reportQueryError(), and ORAField\tableName().

Referenced by fieldBindStatement(), fieldInfo(), insertOneRow(), update(), and wrapFieldForWhere().

◆ fieldName()

DatabaseOracle::fieldName (   $res,
  $n 
)

Get a field name in a result object.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 312 of file DatabaseOracle.php.

◆ freeResult()

DatabaseOracle::freeResult (   $res)

Frees resources associated with the LOB descriptor.

Parameters
IResultWrapper | ORAResult$res

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 256 of file DatabaseOracle.php.

References $res.

◆ getInfinity()

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.

Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1388 of file DatabaseOracle.php.

Referenced by insertOneRow().

◆ getSequenceData()

DatabaseOracle::getSequenceData (   $table)
private

Return sequence_name if table has a sequence.

Parameters
string$table
Returns
string[]|bool

Definition at line 655 of file DatabaseOracle.php.

Referenced by nativeInsertSelect().

◆ getServerVersion()

DatabaseOracle::getServerVersion ( )
Returns
string Version information from the database

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 805 of file DatabaseOracle.php.

References doQuery().

◆ getSoftwareLink()

DatabaseOracle::getSoftwareLink ( )
Returns
string Wikitext of a link to the server software's web site

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 798 of file DatabaseOracle.php.

◆ getType()

DatabaseOracle::getType ( )

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

Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 78 of file DatabaseOracle.php.

◆ getVerifiedUTF8()

DatabaseOracle::getVerifiedUTF8 (   $s)
private
Parameters
string$s
Returns
string

Definition at line 1396 of file DatabaseOracle.php.

References $s.

Referenced by addQuotes(), insertOneRow(), update(), and wrapFieldForWhere().

◆ implicitGroupby()

DatabaseOracle::implicitGroupby ( )

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

Returns
bool
Deprecated:
Since 1.30; only use grouped or aggregated fields in the SELECT

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 82 of file DatabaseOracle.php.

◆ implicitOrderby()

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.

Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 86 of file DatabaseOracle.php.

◆ indexExists()

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

Query whether a given index exists.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 826 of file DatabaseOracle.php.

References $res, doQuery(), Wikimedia\Rdbms\Database\getDBname(), removeIdentifierQuotes(), and tableName().

◆ indexInfo()

DatabaseOracle::indexInfo (   $table,
  $index,
  $fname = __METHOD__ 
)

Returns information about an index If errors are explicitly ignored, returns NULL on failure.

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

Definition at line 366 of file DatabaseOracle.php.

◆ indexUnique()

DatabaseOracle::indexUnique (   $table,
  $index,
  $fname = __METHOD__ 
)

Definition at line 370 of file DatabaseOracle.php.

◆ insert()

DatabaseOracle::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 Return true if no exception was thrown (deprecated since 1.33)
Exceptions
DBError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 374 of file DatabaseOracle.php.

References $fname, $options, as, and insertOneRow().

◆ insertId()

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.

Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 316 of file DatabaseOracle.php.

References $res, fetchRow(), null, and Wikimedia\Rdbms\Database\query().

◆ insertOneRow()

DatabaseOracle::insertOneRow (   $table,
  $row,
  $fname 
)
private
Parameters
string$table
array$row
string$fname
Returns
bool
Exceptions
DBUnexpectedError

Definition at line 448 of file DatabaseOracle.php.

References $e, $fname, as, execFlags(), fieldBindStatement(), fieldInfoMulti(), getInfinity(), getVerifiedUTF8(), isQuotedIdentifier(), null, removeIdentifierQuotes(), Wikimedia\Rdbms\Database\reportQueryError(), tableName(), and Wikimedia\Rdbms\Database\trxLevel().

Referenced by insert().

◆ isQuotedIdentifier()

DatabaseOracle::isQuotedIdentifier (   $s)

Definition at line 1103 of file DatabaseOracle.php.

References $s.

Referenced by insertOneRow().

◆ lastErrno()

DatabaseOracle::lastErrno ( )

Get the last error number.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 344 of file DatabaseOracle.php.

References $e.

◆ lastError()

DatabaseOracle::lastError ( )

Get a description of the last error.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 334 of file DatabaseOracle.php.

References $e.

Referenced by doCommit(), open(), and sourceStream().

◆ limitResult()

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.

Parameters
string$sqlSQL query we will append the limit too
int$limitThe SQL limit
int | bool$offsetThe SQL offset (default false)
Exceptions
DBUnexpectedError
Returns
string
Since
1.34

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 704 of file DatabaseOracle.php.

◆ listTables()

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

List all tables on the database.

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

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 744 of file DatabaseOracle.php.

◆ makeSelectOptions()

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.

Parameters
array$optionsAn associative array of options to be turned into an SQL query, valid keys are listed in the function.
Returns
array

Definition at line 1154 of file DatabaseOracle.php.

References $options, as, Wikimedia\Rdbms\Database\ignoreIndexClause(), Wikimedia\Rdbms\Database\makeGroupByWithHaving(), Wikimedia\Rdbms\Database\makeOrderBy(), and Wikimedia\Rdbms\Database\useIndexClause().

◆ nativeInsertSelect()

DatabaseOracle::nativeInsertSelect (   $destTable,
  $srcTable,
  $varMap,
  $conds,
  $fname = __METHOD__,
  $insertOptions = [],
  $selectOptions = [],
  $selectJoinConds = [] 
)

Definition at line 559 of file DatabaseOracle.php.

References $sequenceData, getSequenceData(), and tableName().

◆ numFields()

DatabaseOracle::numFields (   $res)
Parameters
IResultWrapper | ORAResult$res
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 304 of file DatabaseOracle.php.

References $res.

◆ numRows()

DatabaseOracle::numRows (   $res)
Parameters
IResultWrapper | ORAResult$res
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 292 of file DatabaseOracle.php.

References $res.

◆ open()

DatabaseOracle::open (   $server,
  $user,
  $password,
  $dbName,
  $schema,
  $tablePrefix 
)
protected

◆ queryIgnore()

DatabaseOracle::queryIgnore (   $sql,
  $fname = '' 
)

Definition at line 248 of file DatabaseOracle.php.

References $fname, and Wikimedia\Rdbms\Database\query().

◆ remappedTableName()

DatabaseOracle::remappedTableName (   $name)
Parameters
string$name
Returns
string Value of $name or remapped name if $name is a reserved keyword

Definition at line 639 of file DatabaseOracle.php.

◆ removeIdentifierQuotes()

DatabaseOracle::removeIdentifierQuotes (   $s)

Definition at line 1099 of file DatabaseOracle.php.

References $s.

Referenced by fieldInfoMulti(), indexExists(), insertOneRow(), and tableExists().

◆ selectRow()

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.

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1136 of file DatabaseOracle.php.

References $fname, $options, $vars, and wrapConditionsForWhere().

◆ sourceStream()

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

Parameters
resource$fpFile handle
callable | null$lineCallbackOptional function called before reading each query
callable | null$resultCallbackOptional function called for each MySQL result
string$fnameCalling function name
callable | null$inputCallbackOptional function called for each complete query sent
Returns
bool|string

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 969 of file DatabaseOracle.php.

References $line, $res, as, doQuery(), lastError(), and Wikimedia\Rdbms\Database\replaceVars().

◆ strencode()

DatabaseOracle::strencode (   $s)

Definition at line 1083 of file DatabaseOracle.php.

References $s.

Referenced by addQuotes().

◆ tableExists()

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

Query whether a given table exists (in the given schema, or the default mw one if not given)

Parameters
string$table
string$fname
Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 849 of file DatabaseOracle.php.

References $res, addQuotes(), doQuery(), Wikimedia\Rdbms\Database\getDBname(), removeIdentifierQuotes(), and tableName().

Referenced by dropTable().

◆ 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.

Note
This function does not sanitize user input. It is not safe to use this function to escape user input.
Parameters
string$nameDatabase table name
string$formatOne 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
Returns
string Full database name

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 628 of file DatabaseOracle.php.

Referenced by delete(), dropTable(), indexExists(), insertOneRow(), nativeInsertSelect(), tableExists(), and update().

◆ tableNameInternal()

DatabaseOracle::tableNameInternal (   $name)

Definition at line 643 of file DatabaseOracle.php.

◆ textFieldSize()

DatabaseOracle::textFieldSize (   $table,
  $field 
)

Returns the size of a text field, or -1 for "unlimited".

Parameters
string$table
string$field
Returns
mixed

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 698 of file DatabaseOracle.php.

◆ timestamp()

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.

Parameters
string | int$ts
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 778 of file DatabaseOracle.php.

References $t.

◆ unionQueries()

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.

Parameters
array$sqlsSQL statements to combine
bool$allEither IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT
Returns
string SQL fragment

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 716 of file DatabaseOracle.php.

◆ update()

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

◆ upsert()

DatabaseOracle::upsert (   $table,
array  $rows,
  $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[]|string[]|string$uniqueIndexes All unique indexes. One of the following: a) the one unique field in the table (when no composite unique key exist) b) a list of all unique fields in the table (when no composite unique key exist) c) a list of all unique indexes in the table (each as a list of the indexed fields)
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
DBError
Returns
bool Return true if no exception was thrown (deprecated since 1.33)

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 602 of file DatabaseOracle.php.

◆ wasDeadlock()

DatabaseOracle::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

Note that during a deadlock, the prior transaction will have been lost

Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 723 of file DatabaseOracle.php.

◆ wrapConditionsForWhere()

DatabaseOracle::wrapConditionsForWhere (   $table,
  $conds,
  $parentCol = null 
)
private

Definition at line 1118 of file DatabaseOracle.php.

References as, null, and wrapFieldForWhere().

Referenced by delete(), selectRow(), and update().

◆ wrapFieldForWhere()

DatabaseOracle::wrapFieldForWhere (   $table,
$col,
$val 
)
private

Definition at line 1107 of file DatabaseOracle.php.

References fieldInfoMulti(), and getVerifiedUTF8().

Referenced by wrapConditionsForWhere().

Member Data Documentation

◆ $defaultCharset

string DatabaseOracle::$defaultCharset = 'AL32UTF8'
private

Character set for Oracle database.

Definition at line 51 of file DatabaseOracle.php.

◆ $ignoreDupValOnIndex

bool DatabaseOracle::$ignoreDupValOnIndex = false
private

Definition at line 45 of file DatabaseOracle.php.

◆ $keywordTableMap

string [] DatabaseOracle::$keywordTableMap = []
private

Map of (reserved table name => alternate table name)

Definition at line 57 of file DatabaseOracle.php.

◆ $mAffectedRows

int DatabaseOracle::$mAffectedRows
protected

The number of rows affected as an integer.

Definition at line 42 of file DatabaseOracle.php.

Referenced by fetchAffectedRowCount().

◆ $mFieldInfoCache

array DatabaseOracle::$mFieldInfoCache = []
private

Definition at line 54 of file DatabaseOracle.php.

◆ $mLastResult

resource DatabaseOracle::$mLastResult = null
protected

Definition at line 39 of file DatabaseOracle.php.

◆ $sequenceData

bool array DatabaseOracle::$sequenceData = null
private

Definition at line 48 of file DatabaseOracle.php.

Referenced by nativeInsertSelect().


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