DatabaseOracle Class Reference

Inheritance diagram for DatabaseOracle:

Collaboration diagram for DatabaseOracle:

Public Member Functions
	__construct (array $p)
	__destruct ()
	addIdentifierQuotes ($s)
	addQuotes ($s)
	affectedRows ()
	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=[])
	buildStringCast ($field)
	dataSeek ($res, $row)
	decodeBlob ($b)
	delete ($table, $conds, $fname=__METHOD__)
	dropTable ($tableName, $fName=__METHOD__)
	duplicateTableStructure ($oldName, $newName, $temporary=false, $fname=__METHOD__)
	encodeBlob ($b)
	execFlags ()
	fetchObject ($res)
	fetchRow ($res)
	fieldInfo ($table, $field)
	fieldName ($stmt, $n)
	freeResult ($res)
	Frees resources associated with the LOB descriptor. More...
	getDBname ()
	getInfinity ()
	getServer ()
	getServerVersion ()
	getSoftwareLink ()
	getType ()
	implicitGroupby ()
	implicitOrderby ()
	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=[])
	insertId ()
	This must be called after nextSequenceVal. More...
	isQuotedIdentifier ($s)
	lastErrno ()
	lastError ()
	limitResult ($sql, $limit, $offset=false)
	listTables ($prefix=null, $fname=__METHOD__)
	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=[])
	nextSequenceValue ($seqName)
	Return the next in a sequence, save the value for retrieval via insertId() More...
	numFields ($res)
	numRows ($res)
	open ($server, $user, $password, $dbName)
	Usually aborts on failure. More...
	queryIgnore ($sql, $fname= '')
	removeIdentifierQuotes ($s)
	selectDB ($db)
	selectRow ($table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
	sourceStream ($fp, $lineCallback=false, $resultCallback=false, $fname=__METHOD__, $inputCallback=false)
	defines must comply with ^define\s*([^\s=]*)\s*=\s?'\{\$([^\}]*)\}'; 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')
	tableNameInternal ($name)
	textFieldSize ($table, $field)
	Returns the size of a text field, or -1 for "unlimited". More...
	timestamp ($ts=0)
	unionQueries ($sqls, $all)
	update ($table, $values, $conds, $fname=__METHOD__, $options=[])
	upsert ($table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)
	wasDeadlock ()

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

Protected Attributes
int	$mAffectedRows
	The number of rows affected as an integer. More...
resource	$mLastResult = null

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

Private Attributes
string	$defaultCharset = 'AL32UTF8'
	Character set for Oracle database. More...
bool	$ignoreDupValOnIndex = false
array	$mFieldInfoCache = []
int	$mInsertId = null
bool array	$sequenceData = null

Detailed Description

Definition at line 134 of file DatabaseOracle.php.

Constructor & Destructor Documentation

DatabaseOracle::__construct

(

array

$p

)

Definition at line 156 of file DatabaseOracle.php.

References $wgDBprefix, global, and Hooks\run().

DatabaseOracle::__destruct

(

)

Definition at line 167 of file DatabaseOracle.php.

Member Function Documentation

DatabaseOracle::addIdentifierQuotes

(

$s

)

Definition at line 1211 of file DatabaseOracle.php.

References $s, and DBO_DDLMODE.

DatabaseOracle::addQuotes

(

$s

)

Definition at line 1202 of file DatabaseOracle.php.

References $s, $wgContLang, and global.

DatabaseOracle::affectedRows

(

)

Definition at line 463 of file DatabaseOracle.php.

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

Return aggregated value function call.

Parameters

array	$valuedata
string	$valuename

Returns

mixed

Definition at line 913 of file DatabaseOracle.php.

DatabaseOracle::bitAnd	(		$fieldLeft,
			$fieldRight
	)

Definition at line 1467 of file DatabaseOracle.php.

DatabaseOracle::bitNot

(

$field

)

Definition at line 1462 of file DatabaseOracle.php.

DatabaseOracle::bitOr	(		$fieldLeft,
			$fieldRight
	)

Definition at line 1471 of file DatabaseOracle.php.

DatabaseOracle::buildGroupConcatField	(		$delim,
			$table,
			$field,
			$conds = '',
			$join_conds = []
	)

Definition at line 1483 of file DatabaseOracle.php.

DatabaseOracle::buildStringCast

(

$field

)

Parameters

string

$field

Field or column to cast

Returns

string

Since

1.28

Definition at line 1496 of file DatabaseOracle.php.

DatabaseOracle::closeConnection ( )

protected

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

Returns

bool

Definition at line 287 of file DatabaseOracle.php.

DatabaseOracle::dataSeek	(		$res,
			$row
	)

Parameters

mixed	$res
int	$row

Definition at line 435 of file DatabaseOracle.php.

References $res.

DatabaseOracle::decodeBlob

(

$b

)

Definition at line 833 of file DatabaseOracle.php.

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

Definition at line 1314 of file DatabaseOracle.php.

References tableName().

DatabaseOracle::doBegin (   $fname = __METHOD__ )

protected

Definition at line 1064 of file DatabaseOracle.php.

DatabaseOracle::doCommit (   $fname = __METHOD__ )

protected

Definition at line 1069 of file DatabaseOracle.php.

References $ret.

DatabaseOracle::doQuery (   $sql )

protected

Definition at line 295 of file DatabaseOracle.php.

References code, DBO_DDLMODE, FROM, MWTimestamp\getLocalInstance(), StringUtils\isUtf8(), message, and wfDebug().

Referenced by open().

DatabaseOracle::doRollback (   $fname = __METHOD__ )

protected

Definition at line 1080 of file DatabaseOracle.php.

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

Definition at line 893 of file DatabaseOracle.php.

References tableName().

DatabaseOracle::duplicateTableStructure	(		$oldName,
			$newName,
			$temporary = false,
			$fname = __METHOD__
	)

Definition at line 852 of file DatabaseOracle.php.

DatabaseOracle::encodeBlob

(

$b

)

Definition at line 829 of file DatabaseOracle.php.

DatabaseOracle::execFlags

(

)

Definition at line 291 of file DatabaseOracle.php.

DatabaseOracle::fetchObject

(

$res

)

Parameters

ResultWrapper | ORAResult

$res

Returns

mixed

Definition at line 375 of file DatabaseOracle.php.

References $res.

DatabaseOracle::fetchRow

(

$res

)

Parameters

ResultWrapper | ORAResult

$res

Returns

mixed

Definition at line 387 of file DatabaseOracle.php.

References $res.

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

private

Definition at line 512 of file DatabaseOracle.php.

DatabaseOracle::fieldInfo	(		$table,
			$field
	)

Exceptions

DBUnexpectedError

Parameters

string	$table
string	$field

Returns

ORAField

Definition at line 1056 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

array | string	$table
string	$field

Returns

ORAField|ORAResult

Definition at line 998 of file DatabaseOracle.php.

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

DatabaseOracle::fieldName	(		$stmt,
			$n
	)

Definition at line 419 of file DatabaseOracle.php.

DatabaseOracle::freeResult

(

$res

)

Frees resources associated with the LOB descriptor.

Parameters

ResultWrapper | ORAResult

$res

Definition at line 363 of file DatabaseOracle.php.

References $res.

DatabaseOracle::getDBname

(

)

Definition at line 1475 of file DatabaseOracle.php.

DatabaseOracle::getInfinity

(

)

Definition at line 1500 of file DatabaseOracle.php.

DatabaseOracle::getSequenceData (   $table )

private

Return sequence_name if table has a sequence.

Parameters

string

$table

Returns

bool

Definition at line 780 of file DatabaseOracle.php.

References tableName().

DatabaseOracle::getServer

(

)

Definition at line 1479 of file DatabaseOracle.php.

DatabaseOracle::getServerVersion

(

)

Returns

string Version information from the database

Definition at line 927 of file DatabaseOracle.php.

DatabaseOracle::getSoftwareLink

(

)

Returns

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

Definition at line 920 of file DatabaseOracle.php.

DatabaseOracle::getType

(

)

Definition at line 175 of file DatabaseOracle.php.

DatabaseOracle::implicitGroupby

(

)

Definition at line 179 of file DatabaseOracle.php.

DatabaseOracle::implicitOrderby

(

)

Definition at line 183 of file DatabaseOracle.php.

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

Query whether a given index exists.

Parameters

string	$table
string	$index
string	$fname

Returns

bool

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

Parameters

string	$table
string	$index
string	$fname

Returns

bool

Definition at line 475 of file DatabaseOracle.php.

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

Definition at line 479 of file DatabaseOracle.php.

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

Definition at line 483 of file DatabaseOracle.php.

References $fname, $options, and as.

DatabaseOracle::insertId

(

)

This must be called after nextSequenceVal.

Returns

null|int

Definition at line 427 of file DatabaseOracle.php.

DatabaseOracle::insertOneRow (   $table,   $row,   $fname  )

private

Parameters

string	$table
array	$row
string	$fname

Returns

bool

Exceptions

DBUnexpectedError

Definition at line 554 of file DatabaseOracle.php.

References $e, $wgContLang, as, global, and tableName().

DatabaseOracle::isQuotedIdentifier

(

$s

)

Definition at line 1223 of file DatabaseOracle.php.

References $s.

DatabaseOracle::lastErrno

(

)

Definition at line 453 of file DatabaseOracle.php.

References $e.

DatabaseOracle::lastError

(

)

Definition at line 443 of file DatabaseOracle.php.

References $e.

Referenced by open().

DatabaseOracle::limitResult	(		$sql,
			$limit,
			$offset = false
	)

Definition at line 821 of file DatabaseOracle.php.

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

Definition at line 868 of file DatabaseOracle.php.

DatabaseOracle::makeSelectOptions

(

$options

)

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

Parameters

array

$options

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

Returns

array

Definition at line 1276 of file DatabaseOracle.php.

References $options, and as.

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

Definition at line 661 of file DatabaseOracle.php.

References list, and tableName().

DatabaseOracle::nextSequenceValue

(

$seqName

)

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

Parameters

string

$seqName

Returns

null|int

Definition at line 766 of file DatabaseOracle.php.

References $res, and query.

DatabaseOracle::numFields

(

$res

)

Parameters

ResultWrapper | ORAResult

$res

Returns

int

Definition at line 411 of file DatabaseOracle.php.

References $res.

DatabaseOracle::numRows

(

$res

)

Parameters

ResultWrapper | ORAResult

$res

Returns

int

Definition at line 399 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

resource|null

Definition at line 196 of file DatabaseOracle.php.

References $user, $wgDBOracleDRCP, DBO_DEFAULT, DBO_PERSISTENT, DBO_SYSDBA, doQuery(), e, global, is(), lastError(), selectDB(), and the.

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

Definition at line 355 of file DatabaseOracle.php.

References $fname, and query.

DatabaseOracle::removeIdentifierQuotes

(

$s

)

Definition at line 1219 of file DatabaseOracle.php.

References $s.

DatabaseOracle::selectDB

(

$db

)

Definition at line 1176 of file DatabaseOracle.php.

References $e, and $success.

Referenced by open().

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

Definition at line 1258 of file DatabaseOracle.php.

References $fname, $options, and $vars.

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

defines must comply with ^define\s*([^\s=]*)\s*=\s?'\{\$([^\}]*)\}';

Parameters

resource	$fp
bool | string	$lineCallback
bool | callable	$resultCallback
string	$fname
bool | callable	$inputCallback

Returns

bool|string

Definition at line 1098 of file DatabaseOracle.php.

References $line, $res, and as.

DatabaseOracle::strencode

(

$s

)

Definition at line 1198 of file DatabaseOracle.php.

References $s.

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

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

Parameters

string	$table
string	$fname

Returns

bool

Definition at line 971 of file DatabaseOracle.php.

References $res, and tableName().

DatabaseOracle::tableName	(		$name,
			$format = 'quoted'
	)

Definition at line 736 of file DatabaseOracle.php.

References $name.

DatabaseOracle::tableNameInternal

(

$name

)

Definition at line 754 of file DatabaseOracle.php.

References $name, and tableName().

DatabaseOracle::textFieldSize	(		$table,
			$field
	)

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

Parameters

string	$table
string	$field

Returns

mixed

Definition at line 815 of file DatabaseOracle.php.

DatabaseOracle::timestamp

(

$ts = 0

)

Definition at line 902 of file DatabaseOracle.php.

References TS_ORACLE, and wfTimestamp().

DatabaseOracle::unionQueries	(		$sqls,
			$all
	)

Definition at line 841 of file DatabaseOracle.php.

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

Parameters

string	$table
array	$values
array	$conds
string	$fname
array	$options

Returns

bool

Exceptions

DBUnexpectedError

Definition at line 1357 of file DatabaseOracle.php.

References $e, $options, $wgContLang, as, global, LIST_AND, and tableName().

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

Definition at line 710 of file DatabaseOracle.php.

DatabaseOracle::wasDeadlock

(

)

Definition at line 848 of file DatabaseOracle.php.

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

private

Definition at line 1240 of file DatabaseOracle.php.

References as.

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

private

Definition at line 1227 of file DatabaseOracle.php.

References $wgContLang, and global.

Member Data Documentation

string DatabaseOracle::$defaultCharset = 'AL32UTF8'

private

Character set for Oracle database.

Definition at line 151 of file DatabaseOracle.php.

bool DatabaseOracle::$ignoreDupValOnIndex = false

private

Definition at line 145 of file DatabaseOracle.php.

int DatabaseOracle::$mAffectedRows

protected

The number of rows affected as an integer.

Definition at line 139 of file DatabaseOracle.php.

array DatabaseOracle::$mFieldInfoCache = []

private

Definition at line 154 of file DatabaseOracle.php.

int DatabaseOracle::$mInsertId = null

private

Definition at line 142 of file DatabaseOracle.php.

resource DatabaseOracle::$mLastResult = null

protected

Definition at line 136 of file DatabaseOracle.php.

bool array DatabaseOracle::$sequenceData = null

private

Definition at line 148 of file DatabaseOracle.php.

---

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

• includes/db/DatabaseOracle.php