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

List of all members.

Public Member Functions

 __construct ($server=false, $user=false, $password=false, $dbName=false, $flags=0, $tablePrefix= 'get from global')
 __destruct ()
 Run a few simple sanity checks.
 addIdentifierQuotes ($s)
 Quotes an identifier using `backticks` or "double quotes" depending on the database type.
 addQuotes ($s)
 Adds quotes and backslashes.
 affectedRows ()
 Get the number of rows affected by the last write query.
 aggregateValue ($valuedata, $valuename= 'value')
 Return aggregated value function call.
 bitAnd ($fieldLeft, $fieldRight)
 bitNot ($field)
 bitOr ($fieldLeft, $fieldRight)
 cascadingDeletes ()
 Returns true if this database supports (and uses) cascading deletes.
 cleanupTriggers ()
 Returns true if this database supports (and uses) triggers (e.g.
 dataSeek ($res, $row)
 Change the position of the cursor in a result object.
 decodeBlob ($b)
 Some DBMSs return a special placeholder object representing blob fields in result objects.
 delete ($table, $conds, $fname=__METHOD__)
 DELETE query wrapper.
 dropTable ($tableName, $fName=__METHOD__)
 Delete a table.
 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.
 encodeBlob ($b)
 Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.
 execFlags ()
 fetchObject ($res)
 Fetch the next row from the given result object, in object form.
 fetchRow ($res)
 Fetch the next row from the given result object, in associative array form.
 fieldInfo ($table, $field)
 fieldName ($stmt, $n)
 Get a field name in a result object.
 freeResult ($res)
 Free a result object returned by query() or select().
 getDBname ()
 Get the current DB name.
 getInfinity ()
 Find out when 'infinity' is.
 getSearchEngine ()
 Get search engine class.
 getServer ()
 Get the server hostname or IP address.
 getServerVersion ()
 getSoftwareLink ()
 getType ()
 Get the type of the DBMS, as it appears in $wgDBtype.
 implicitGroupby ()
 Returns true if this database does an implicit sort when doing GROUP BY.
 implicitOrderby ()
 Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1.
 indexExists ($table, $index, $fname=__METHOD__)
 Query whether a given index exists.
 indexInfo ($table, $index, $fname=__METHOD__)
 Returns information about an index If errors are explicitly ignored, returns NULL on failure.
 indexUnique ($table, $index, $fname=__METHOD__)
 insert ($table, $a, $fname=__METHOD__, $options=array())
 INSERT wrapper, inserts an array into a table.
 insertId ()
 This must be called after nextSequenceVal.
 insertSelect ($destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=array(), $selectOptions=array())
 INSERT SELECT wrapper.
 isQuotedIdentifier ($s)
 Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers .
 lastErrno ()
 Get the last error number.
 lastError ()
 Get a description of the last error.
 limitResult ($sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset.
 listTables ($prefix=null, $fname=__METHOD__)
 List all tables on the database.
 makeSelectOptions ($options)
 Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.
 nextSequenceValue ($seqName)
 Return the next in a sequence, save the value for retrieval via insertId()
 numFields ($res)
 Get the number of fields in a result object.
 numRows ($res)
 Get the number of rows in a result object.
 open ($server, $user, $password, $dbName)
 Usually aborts on failure.
 queryIgnore ($sql, $fname= '')
 realTimestamps ()
 Returns true if this database uses timestamps rather than integers.
 removeIdentifierQuotes ($s)
 reportQueryError ($error, $errno, $sql, $fname, $tempIgnore=false)
 Report a query error.
 searchableIPs ()
 Returns true if this database can do a native search on IP columns e.g.
 selectDB ($db)
 Change the current database.
 selectRow ($table, $vars, $conds, $fname=__METHOD__, $options=array(), $join_conds=array())
 Single row SELECT wrapper.
 setFakeMaster ($enabled=true)
 Make this connection a fake master.
 sourceStream ($fp, $lineCallback=false, $resultCallback=false, $fname=__METHOD__, $inputCallback=false)
 Read and execute commands from an open file handle.
 strencode ($s)
 Wrapper for addslashes()
 strictIPs ()
 Returns true if this database is strict about what can be put into an IP field.
 tableExists ($table, $fname=__METHOD__)
 Query whether a given table exists (in the given schema, or the default mw one if not given)
 tableName ($name, $format= 'quoted')
 Format a table name ready for use in constructing an SQL query.
 tableNameInternal ($name)
 textFieldSize ($table, $field)
 Returns the size of a text field, or -1 for "unlimited".
 timestamp ($ts=0)
 Convert a timestamp in one of the formats accepted by wfTimestamp() to the format used for inserting into timestamp fields in this DBMS.
 unionQueries ($sqls, $all)
 Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.
 update ($table, $values, $conds, $fname=__METHOD__, $options=array())
 UPDATE wrapper.
 upsert ($table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)
 INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
 wasDeadlock ()
 Determines if the last failure was due to a deadlock STUB.

Public Attributes

 $cursor = 0
 $defaultCharset = 'AL32UTF8'
 $ignore_DUP_VAL_ON_INDEX = false
 $lastResult = null
 $mAffectedRows
 $mFieldInfoCache = array()
 $mInsertId = null
 $mLastResult = null
 $sequenceData = null

Protected Member Functions

 closeConnection ()
 Closes a database connection, if it is open Returns success, true if already closed.
 doBegin ($fname=__METHOD__)
 Issues the BEGIN command to the database server.
 doCommit ($fname=__METHOD__)
 Issues the COMMIT command to the database server.
 doQuery ($sql)
 The DBMS-dependent part of query()
 doRollback ($fname=__METHOD__)
 Issues the ROLLBACK command to the database server.

Private Member Functions

 fieldBindStatement ($table, $col, &$val, $includeCol=false)
 fieldInfoMulti ($table, $field)
 Function translates mysql_fetch_field() functionality on ORACLE.
 getSequenceData ($table)
 Return sequence_name if table has a sequence.
 insertOneRow ($table, $row, $fname)
 wrapConditionsForWhere ($table, $conds, $parentCol=null)
 wrapFieldForWhere ($table, &$col, &$val)

Detailed Description

Definition at line 185 of file DatabaseOracle.php.


Constructor & Destructor Documentation

DatabaseOracle::__construct ( server = false,
user = false,
password = false,
dbName = false,
flags = 0,
tablePrefix = 'get from global' 
)

Definition at line 199 of file DatabaseOracle.php.

References $flags, $password, $user, array(), global, and wfRunHooks().

Run a few simple sanity checks.

Reimplemented from DatabaseBase.

Definition at line 208 of file DatabaseOracle.php.

References DatabaseBase\close(), wfRestoreWarnings(), and wfSuppressWarnings().


Member Function Documentation

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

Parameters:
$sstring
Returns:
string

Reimplemented from DatabaseBase.

Definition at line 1134 of file DatabaseOracle.php.

References $s.

Adds quotes and backslashes.

Parameters:
$sstring
Returns:
string

Reimplemented from DatabaseBase.

Definition at line 1126 of file DatabaseOracle.php.

References $s, $wgContLang, and global.

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

See also:
http://www.php.net/mysql_affected_rows
Returns:
int

Implements DatabaseType.

Definition at line 458 of file DatabaseOracle.php.

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

Return aggregated value function call.

Reimplemented from DatabaseBase.

Definition at line 855 of file DatabaseOracle.php.

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

Reimplemented from DatabaseBase.

Definition at line 1355 of file DatabaseOracle.php.

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

Reimplemented from DatabaseBase.

Definition at line 1350 of file DatabaseOracle.php.

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

Reimplemented from DatabaseBase.

Definition at line 1359 of file DatabaseOracle.php.

Returns true if this database supports (and uses) cascading deletes.

Returns:
bool

Reimplemented from DatabaseBase.

Definition at line 220 of file DatabaseOracle.php.

Returns true if this database supports (and uses) triggers (e.g.

on the page table)

Returns:
bool

Reimplemented from DatabaseBase.

Definition at line 223 of file DatabaseOracle.php.

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

Returns:
bool

Reimplemented from DatabaseBase.

Definition at line 319 of file DatabaseOracle.php.

DatabaseOracle::dataSeek ( res,
row 
)

Change the position of the cursor in a result object.

See also:
http://www.php.net/mysql_data_seek
Parameters:
$resMixed: A SQL result
$rowMixed: Either MySQL row or ResultWrapper

Implements DatabaseType.

Definition at line 432 of file DatabaseOracle.php.

References $res.

Some DBMSs return a special placeholder object representing blob fields in result objects.

Pass the object through this function to return the original string.

Parameters:
$bstring
Returns:
string

Reimplemented from DatabaseBase.

Definition at line 786 of file DatabaseOracle.php.

DatabaseOracle::delete ( table,
conds,
fname = __METHOD__ 
)

DELETE query wrapper.

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

Reimplemented from DatabaseBase.

Definition at line 1228 of file DatabaseOracle.php.

References array(), and tableName().

DatabaseOracle::doBegin ( fname = __METHOD__) [protected]

Issues the BEGIN command to the database server.

See also:
DatabaseBase::begin()
Parameters:
type$fname

Reimplemented from DatabaseBase.

Definition at line 1001 of file DatabaseOracle.php.

DatabaseOracle::doCommit ( fname = __METHOD__) [protected]

Issues the COMMIT command to the database server.

See also:
DatabaseBase::commit()
Parameters:
type$fname

Reimplemented from DatabaseBase.

Definition at line 1006 of file DatabaseOracle.php.

References $ret.

DatabaseOracle::doQuery ( sql) [protected]

The DBMS-dependent part of query()

Parameters:
$sqlString: SQL query.
Returns:
ResultWrapper Result object to feed to fetchObject, fetchRow, ...; or false on failure

Reimplemented from DatabaseBase.

Definition at line 327 of file DatabaseOracle.php.

References code, DatabaseBase\getFlag(), MWTimestamp\getLocalInstance(), StringUtils\isUtf8(), message, and wfDebug().

Referenced by open().

DatabaseOracle::doRollback ( fname = __METHOD__) [protected]

Issues the ROLLBACK command to the database server.

See also:
DatabaseBase::rollback()
Parameters:
type$fname

Reimplemented from DatabaseBase.

Definition at line 1017 of file DatabaseOracle.php.

DatabaseOracle::dropTable ( tableName,
fName = __METHOD__ 
)

Delete a table.

Parameters:
$tableNamestring
$fNamestring
Returns:
bool|ResultWrapper
Since:
1.18

Reimplemented from DatabaseBase.

Definition at line 839 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).

Parameters:
string$oldNamename of table whose structure should be copied
string$newNamename of table to be created
$temporaryBoolean: whether the new table should be temporary
string$fnamecalling function name
Exceptions:
MWException
Returns:
Boolean: true if operation was successful

Reimplemented from DatabaseBase.

Definition at line 802 of file DatabaseOracle.php.

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 DatabaseBase::insert().

Parameters:
$bstring
Returns:
string

Reimplemented from DatabaseBase.

Definition at line 782 of file DatabaseOracle.php.

Definition at line 323 of file DatabaseOracle.php.

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

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

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

Implements DatabaseType.

Definition at line 388 of file DatabaseOracle.php.

References $res.

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

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

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

Implements DatabaseType.

Definition at line 396 of file DatabaseOracle.php.

References $res.

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

Definition at line 504 of file DatabaseOracle.php.

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

Implements DatabaseType.

Definition at line 994 of file DatabaseOracle.php.

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:
$tableArray
$fieldString
Returns:
ORAField|ORAResult

Definition at line 942 of file DatabaseOracle.php.

References $res, array(), as, and ORAField\tableName().

DatabaseOracle::fieldName ( res,
n 
)

Get a field name in a result object.

See also:
http://www.php.net/mysql_field_name
Parameters:
$resMixed: A SQL result
$nInteger
Returns:
string

Implements DatabaseType.

Definition at line 420 of file DatabaseOracle.php.

References $n.

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

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

Parameters:
$resMixed: A SQL result

Reimplemented from DatabaseBase.

Definition at line 380 of file DatabaseOracle.php.

References $res.

Get the current DB name.

Reimplemented from DatabaseBase.

Definition at line 1366 of file DatabaseOracle.php.

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

Reimplemented from DatabaseBase.

Definition at line 1378 of file DatabaseOracle.php.

Get search engine class.

All subclasses of this need to implement this if they wish to use searching.

Returns:
String

Reimplemented from DatabaseBase.

Definition at line 1374 of file DatabaseOracle.php.

DatabaseOracle::getSequenceData ( table) [private]

Return sequence_name if table has a sequence.

Returns:
bool

Definition at line 747 of file DatabaseOracle.php.

References $result, array(), and tableName().

Get the server hostname or IP address.

Reimplemented from DatabaseBase.

Definition at line 1370 of file DatabaseOracle.php.

Returns:
string Version information from the database

Implements DatabaseType.

Definition at line 883 of file DatabaseOracle.php.

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

Implements DatabaseType.

Definition at line 876 of file DatabaseOracle.php.

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

Returns:
string

Implements DatabaseType.

Definition at line 216 of file DatabaseOracle.php.

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

Returns:
bool

Reimplemented from DatabaseBase.

Definition at line 232 of file DatabaseOracle.php.

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

Reimplemented from DatabaseBase.

Definition at line 235 of file DatabaseOracle.php.

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

Query whether a given index exists.

Returns:
bool

Reimplemented from DatabaseBase.

Definition at line 896 of file DatabaseOracle.php.

References $count, $res, and tableName().

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

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

Returns:
bool

Implements DatabaseType.

Definition at line 467 of file DatabaseOracle.php.

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

Definition at line 471 of file DatabaseOracle.php.

DatabaseOracle::insert ( table,
a,
fname = __METHOD__,
options = array() 
)

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 DatabaseBase::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 DatabaseBase::affectedRows().
Parameters:
$tableString Table name. This will be passed through DatabaseBase::tableName().
$aArray of rows to insert
$fnameString Calling function name (use __METHOD__) for logs/profiling
array$optionsof options
Returns:
bool

Reimplemented from DatabaseBase.

Definition at line 475 of file DatabaseOracle.php.

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

This must be called after nextSequenceVal.

Returns:
null

Implements DatabaseType.

Definition at line 428 of file DatabaseOracle.php.

DatabaseOracle::insertOneRow ( table,
row,
fname 
) [private]
DatabaseOracle::insertSelect ( destTable,
srcTable,
varMap,
conds,
fname = __METHOD__,
insertOptions = array(),
selectOptions = array() 
)

INSERT SELECT wrapper.

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

Parameters:
string$destTableThe table name to insert into
string | array$srcTableMay be either a table name, or an array of table names to include in a join.
array$varMapmust be an associative array of the form array( 'dest1' => 'source1', ...). Source items may be literals rather than field names, but strings should be quoted with DatabaseBase::addQuotes()
array$condsCondition array. See $conds in DatabaseBase::select() for the details of the format of condition arrays. May be "*" to copy the whole table.
string$fnameThe function name of the caller, from __METHOD__
array$insertOptionsOptions for the INSERT part of the query, see DatabaseBase::insert() for details.
array$selectOptionsOptions for the SELECT part of the query, see DatabaseBase::select() for details.
Returns:
ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 639 of file DatabaseOracle.php.

References array(), list, and tableName().

Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers .

Parameters:
$namestring
Returns:
boolean

Reimplemented from DatabaseBase.

Definition at line 1145 of file DatabaseOracle.php.

References $s.

Get the last error number.

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

Implements DatabaseType.

Definition at line 449 of file DatabaseOracle.php.

Get a description of the last error.

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

Implements DatabaseType.

Definition at line 440 of file DatabaseOracle.php.

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.

Parameters:
string$sqlSQL query we will append the limit too
$limitInteger the SQL limit
$offsetInteger|bool the SQL offset (default false)
Exceptions:
DBUnexpectedError
Returns:
string

Reimplemented from DatabaseBase.

Definition at line 775 of file DatabaseOracle.php.

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

List all tables on the database.

Parameters:
string$prefixOnly show tables with this prefix, e.g. mw_
string$fnamecalling function name
Exceptions:
MWException

Reimplemented from DatabaseBase.

Definition at line 815 of file DatabaseOracle.php.

References $result, array(), and empty.

Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query.

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

Reimplemented from DatabaseBase.

Definition at line 1196 of file DatabaseOracle.php.

References $key, $options, array(), and as.

Return the next in a sequence, save the value for retrieval via insertId()

Returns:
null

Reimplemented from DatabaseBase.

Definition at line 736 of file DatabaseOracle.php.

References $res, and query.

Get the number of fields in a result object.

See also:
http://www.php.net/mysql_num_fields
Parameters:
$resMixed: A SQL result
Returns:
int

Implements DatabaseType.

Definition at line 412 of file DatabaseOracle.php.

References $res.

Get the number of rows in a result object.

Parameters:
$resMixed: A SQL result
Returns:
int

Implements DatabaseType.

Definition at line 404 of file DatabaseOracle.php.

References $res.

DatabaseOracle::open ( server,
user,
password,
dbName 
)

Usually aborts on failure.

Parameters:
string$server
string$user
string$password
string$dbName
Exceptions:
DBConnectionError
Returns:
DatabaseBase|null

Implements DatabaseType.

Definition at line 251 of file DatabaseOracle.php.

References $password, $user, DatabaseBase\close(), doQuery(), e, global, is, lastError(), selectDB(), DatabaseBase\setFlag(), wfRestoreWarnings(), and wfSuppressWarnings().

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

Definition at line 376 of file DatabaseOracle.php.

References $fname, and query.

Returns true if this database uses timestamps rather than integers.

Returns:
bool

Reimplemented from DatabaseBase.

Definition at line 229 of file DatabaseOracle.php.

Definition at line 1141 of file DatabaseOracle.php.

References $s.

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

Report a query error.

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

Parameters:
$errorString
$errnoInteger
$sqlString
$fnameString
$tempIgnoreBoolean
Exceptions:
DBQueryError

Reimplemented from DatabaseBase.

Definition at line 859 of file DatabaseOracle.php.

References $error, $fname, $ignore, and wfDebug().

Returns true if this database can do a native search on IP columns e.g.

this works as expected: .. WHERE rc_ip = '127.42.12.102/32';

Returns:
bool

Reimplemented from DatabaseBase.

Definition at line 238 of file DatabaseOracle.php.

Change the current database.

Todo:
Explain what exactly will fail if this is not overridden.
Parameters:
$db
Returns:
bool Success or failure

Reimplemented from DatabaseBase.

Definition at line 1102 of file DatabaseOracle.php.

References $success, wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by open().

DatabaseOracle::selectRow ( table,
vars,
conds,
fname = __METHOD__,
options = array(),
join_conds = array() 
)

Single row SELECT wrapper.

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

Parameters:
string | array$tableTable name
string | array$varsField names
array$condsConditions
string$fnameCaller function name
string | array$optionsQuery options
$join_condsarray|string Join conditions
Returns:
object|bool

Reimplemented from DatabaseBase.

Definition at line 1179 of file DatabaseOracle.php.

References $fname, $options, and $vars.

Make this connection a fake master.

Parameters:
$enabledbool

Reimplemented from DatabaseBase.

Definition at line 1363 of file DatabaseOracle.php.

DatabaseOracle::sourceStream ( fp,
lineCallback = false,
resultCallback = false,
fname = __METHOD__,
inputCallback = false 
)

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:
$fpResource: File handle
$lineCallbackCallback: Optional function called before reading each query
$resultCallbackCallback: Optional function called for each MySQL result
string$fnameCalling function name
$inputCallbackCallback: Optional function called for each complete query sent
Returns:
bool|string

Reimplemented from DatabaseBase.

Definition at line 1026 of file DatabaseOracle.php.

References $res, array(), and as.

Wrapper for addslashes()

Parameters:
string$sto be slashed.
Returns:
string: slashed string.

Implements DatabaseType.

Definition at line 1122 of file DatabaseOracle.php.

References $s.

Returns true if this database is strict about what can be put into an IP field.

Specifically, it uses a NULL value instead of an empty string.

Returns:
bool

Reimplemented from DatabaseBase.

Definition at line 226 of file DatabaseOracle.php.

DatabaseOracle::tableExists ( table,
fname = __METHOD__ 
)

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

Returns:
bool

Reimplemented from DatabaseBase.

Definition at line 916 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.

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

Reimplemented from DatabaseBase.

Definition at line 710 of file DatabaseOracle.php.

References $name.

Definition at line 728 of file DatabaseOracle.php.

References $name, and tableName().

DatabaseOracle::textFieldSize ( table,
field 
)

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

Parameters:
$tablestring
$fieldstring
Returns:
int

Reimplemented from DatabaseBase.

Definition at line 770 of file DatabaseOracle.php.

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:
$tsstring|int
Returns:
string

Reimplemented from DatabaseBase.

Definition at line 848 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.

Parameters:
array$sqlsSQL statements to combine
$allBoolean: use UNION ALL
Returns:
String: SQL fragment

Reimplemented from DatabaseBase.

Definition at line 793 of file DatabaseOracle.php.

DatabaseOracle::update ( table,
values,
conds,
fname = __METHOD__,
options = array() 
)

UPDATE wrapper.

Takes a condition array and a SET array.

Parameters:
$tableString name of the table to UPDATE. This will be passed through DatabaseBase::tableName().
array$valuesAn array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by DatabaseBase::addQuotes().
$condsArray: An array of conditions (WHERE). See DatabaseBase::select() for the details of the format of condition arrays. Use '*' to update all rows.
$fnameString: The function name of the caller (from __METHOD__), for logging and profiling.
array$optionsAn array of UPDATE options, can be:
  • IGNORE: Ignore unique key conflicts
  • LOW_PRIORITY: MySQL-specific, see MySQL manual.
Returns:
Boolean

Reimplemented from DatabaseBase.

Definition at line 1251 of file DatabaseOracle.php.

References $options, $wgContLang, array(), as, global, tableName(), wfRestoreWarnings(), and wfSuppressWarnings().

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:

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

Parameters:
string$tableTable name. This will be passed through DatabaseBase::tableName().
array$rowsA single row or list of rows to insert
array$uniqueIndexesList of single field names or field name tuples
array$setAn array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by DatabaseBase::addQuotes().
string$fnameCalling function name (use __METHOD__) for logs/profiling
array$optionsof options
Returns:
bool
Since:
1.22

Reimplemented from DatabaseBase.

Definition at line 686 of file DatabaseOracle.php.

Determines if the last failure was due to a deadlock STUB.

Returns:
bool

Reimplemented from DatabaseBase.

Definition at line 798 of file DatabaseOracle.php.

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

Definition at line 1162 of file DatabaseOracle.php.

References array(), and as.

DatabaseOracle::wrapFieldForWhere ( table,
&$  col,
&$  val 
) [private]

Definition at line 1149 of file DatabaseOracle.php.

References $wgContLang, and global.


Member Data Documentation

DatabaseOracle::$cursor = 0

Definition at line 189 of file DatabaseOracle.php.

DatabaseOracle::$defaultCharset = 'AL32UTF8'

Definition at line 195 of file DatabaseOracle.php.

DatabaseOracle::$ignore_DUP_VAL_ON_INDEX = false

Definition at line 192 of file DatabaseOracle.php.

DatabaseOracle::$lastResult = null

Definition at line 188 of file DatabaseOracle.php.

DatabaseOracle::$mAffectedRows

Definition at line 190 of file DatabaseOracle.php.

DatabaseOracle::$mFieldInfoCache = array()

Definition at line 197 of file DatabaseOracle.php.

DatabaseOracle::$mInsertId = null

Definition at line 186 of file DatabaseOracle.php.

DatabaseOracle::$mLastResult = null

Definition at line 187 of file DatabaseOracle.php.

DatabaseOracle::$sequenceData = null

Definition at line 193 of file DatabaseOracle.php.


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