SMW\MediaWiki\Connection\Database Class Reference

Public Member Functions
	__construct (ConnRef $connRef, TransactionHandler $transactionHandler)
	releaseConnection ()
	ping ()
	newQuery ()
	isType ( $type)
	getInfo ()
	getType ()
	tableName ( $tableName)
	timestamp ( $ts=0)
	tablePrefix ( $prefix=null)
	addQuotes ( $value)
	fetchObject ( $res)
	numRows ( $results)
	freeResult ( $res)
	select ( $tableName, $fields, $conditions, $fname, array $options=[], $joinConditions=[])
	query ( $sql, $fname=__METHOD__, $ignoreException=false)
	selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $joinConditions=[])
	affectedRows ()
	makeSelectOptions ( $options)
	nextSequenceValue ( $seqName)
	insertId ()
	clearFlag ( $flag)
	getFlag ( $flag)
	setFlag ( $flag)
	insert ( $table, $rows, $fname=__METHOD__, $options=[])
	update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
	upsert ( $table, array $rows, $uniqueIndexes, array $set, $fname=__METHOD__)
	delete ( $table, $conds, $fname=__METHOD__)
	replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
	makeList ( $data, $mode=self::LIST_COMMA)
	tableExists ( $table, $fname=__METHOD__)
	listTables ( $prefix=null, $fname=__METHOD__)
	selectField ( $table, $fieldName, $conditions='', $fname=__METHOD__, $options=[])
	estimateRowCount ( $table, $vars=' *', $conditions='', $fname=__METHOD__, $options=[])
	getEmptyTransactionTicket ( $fname=__METHOD__)
	commitAndWaitForReplication ( $fname, $ticket, array $opts=[])
	beginSectionTransaction ( $fname=__METHOD__)
	endSectionTransaction ( $fname=__METHOD__)
	inSectionTransaction ( $fname=__METHOD__)
	beginAtomicTransaction ( $fname=__METHOD__)
	endAtomicTransaction ( $fname=__METHOD__)
	onTransactionResolution (callable $callback, $fname=__METHOD__)
	onTransactionIdle (callable $callback)
	escape_bytea ( $text)
	unescape_bytea ( $text)

Public Attributes
const	AUTO_COMMIT = 'auto.commit'
const	TRIGGER_ROLLBACK = 3
const	LIST_COMMA = 0

Detailed Description

This adapter class covers MW DB specific operations. Changes to the interface are likely therefore this class should not be used other than by SMW itself.

GNU GPL v2+

Since

1.9

Author

mwjames

Constructor & Destructor Documentation

__construct()

SMW\MediaWiki\Connection\Database::__construct	(	ConnRef	$connRef,
		TransactionHandler	$transactionHandler
	)

Since

1.9

Parameters

ConnRef	$connRef
TransactionHandler	$transactionHandler

Member Function Documentation

addQuotes()

SMW\MediaWiki\Connection\Database::addQuotes

(

$value

)

See also

DatabaseBase::addQuotes

Since

1.9

Parameters

string

$tableName

Returns

string

affectedRows()

SMW\MediaWiki\Connection\Database::affectedRows

(

)

See also

DatabaseBase::affectedRows

Since

1.9

Returns

int

beginAtomicTransaction()

SMW\MediaWiki\Connection\Database::beginAtomicTransaction

(

$fname = __METHOD__

)

Since

2.3

Parameters

string

$fname

beginSectionTransaction()

SMW\MediaWiki\Connection\Database::beginSectionTransaction

(

$fname = __METHOD__

)

::beginSectionTransaction

Since

3.1

Parameters

string

$fname

Exceptions

RuntimeException

clearFlag()

SMW\MediaWiki\Connection\Database::clearFlag

(

$flag

)

See also

DatabaseBase::clearFlag

Since

2.4

commitAndWaitForReplication()

SMW\MediaWiki\Connection\Database::commitAndWaitForReplication	(		$fname,
			$ticket,
		array	$opts = []
	)

Convenience method for safely running commitMasterChanges/waitForReplication where it will allow to commit and wait for whena TransactionTicket is available.

Note

Only supported with 1.28+

Since

3.0

Parameters

string	$fname	Caller name (e.g. METHOD)
mixed	$ticket	Result of Database::getEmptyTransactionTicket
array	$opts	Options to waitForReplication

delete()

SMW\MediaWiki\Connection\Database::delete	(		$table,
			$conds,
			$fname = __METHOD__
	)

See also

DatabaseBase::delete

Since

1.9

endAtomicTransaction()

SMW\MediaWiki\Connection\Database::endAtomicTransaction

(

$fname = __METHOD__

)

Since

2.3

Parameters

string

$fname

Returns

void

endSectionTransaction()

SMW\MediaWiki\Connection\Database::endSectionTransaction

(

$fname = __METHOD__

)

Since

3.1

Parameters

string

$fname

escape_bytea()

SMW\MediaWiki\Connection\Database::escape_bytea

(

$text

)

Since

3.1

Parameters

string

$text

Returns

string

estimateRowCount()

SMW\MediaWiki\Connection\Database::estimateRowCount	(		$table,
			$vars = '*',
			$conditions = '',
			$fname = __METHOD__,
			$options = []
	)

See also

DatabaseBase::estimateRowCount

Since

2.1

fetchObject()

SMW\MediaWiki\Connection\Database::fetchObject

(

$res

)

See also

DatabaseBase::fetchObject

Since

1.9

Parameters

ResultWrapper

$res

Returns

string

freeResult()

SMW\MediaWiki\Connection\Database::freeResult

(

$res

)

See also

DatabaseBase::freeResult

Since

1.9

Parameters

ResultWrapper

$res

getEmptyTransactionTicket()

SMW\MediaWiki\Connection\Database::getEmptyTransactionTicket

(

$fname = __METHOD__

)

Note

Only supported with 1.28+

Since

3.0

Parameters

string

$fname

Caller name (e.g. METHOD)

Returns

mixed A value to pass to commitAndWaitForReplication

getFlag()

SMW\MediaWiki\Connection\Database::getFlag

(

$flag

)

See also

DatabaseBase::getFlag

Since

2.4

getInfo()

SMW\MediaWiki\Connection\Database::getInfo

(

)

See also

DatabaseBase::getServerInfo

Since

3.0

Returns

array

getType()

SMW\MediaWiki\Connection\Database::getType

(

)

See also

DatabaseBase::getType

Since

1.9

Returns

string

inSectionTransaction()

SMW\MediaWiki\Connection\Database::inSectionTransaction

(

$fname = __METHOD__

)

Since

3.1

Parameters

string

$fname

Returns

boolean

insert()

SMW\MediaWiki\Connection\Database::insert	(		$table,
			$rows,
			$fname = __METHOD__,
			$options = []
	)

See also

DatabaseBase::insert

Since

1.9

insertId()

SMW\MediaWiki\Connection\Database::insertId

(

)

See also

DatabaseBase::insertId

Since

1.9

Returns

int

isType()

SMW\MediaWiki\Connection\Database::isType

(

$type

)

Since

2.5

Parameters

string

$type

Returns

boolean

listTables()

SMW\MediaWiki\Connection\Database::listTables	(		$prefix = null,
			$fname = __METHOD__
	)

See also

DatabaseBase::listTables

Since

3.1

Parameters

string | null	$prefix
string	$fname

Returns

[]

makeList()

SMW\MediaWiki\Connection\Database::makeList	(		$data,
			$mode = self::LIST_COMMA
	)

See also

DatabaseBase::makeList

Since

1.9

makeSelectOptions()

SMW\MediaWiki\Connection\Database::makeSelectOptions

(

$options

)

Note

Method was made protected in 1.28, hence the need for the DatabaseHelper that copies the functionality.

See also

DatabaseBase::makeSelectOptions

Since

1.9

Parameters

array

$options

Returns

array

newQuery()

SMW\MediaWiki\Connection\Database::newQuery

(

)

Since

3.0

Returns

Query

nextSequenceValue()

SMW\MediaWiki\Connection\Database::nextSequenceValue

(

$seqName

)

See also

DatabaseBase::nextSequenceValue

Since

1.9

Parameters

string

$seqName

Returns

int|null

numRows()

SMW\MediaWiki\Connection\Database::numRows

(

$results

)

See also

DatabaseBase::numRows

Since

1.9

Parameters

mixed

$results

Returns

integer

onTransactionIdle()

SMW\MediaWiki\Connection\Database::onTransactionIdle

(

callable

$callback

)

Since

2.3

Parameters

callable

$callback

onTransactionResolution()

SMW\MediaWiki\Connection\Database::onTransactionResolution	(	callable	$callback,
			$fname = __METHOD__
	)

Since

3.0

Parameters

callable

$callback

ping()

SMW\MediaWiki\Connection\Database::ping

(

)

Since

3.0

Returns

boolean

query()

SMW\MediaWiki\Connection\Database::query	(		$sql,
			$fname = __METHOD__,
			$ignoreException = false
	)

See also

DatabaseBase::query

Since

1.9

Parameters

Query | string	$sql
string	$fname
boolean	$ignoreException

Returns

ResultWrapper

Exceptions

RuntimeException

releaseConnection()

SMW\MediaWiki\Connection\Database::releaseConnection

(

)

Since

2.5

Parameters

string

$type

Returns

boolean

replace()

SMW\MediaWiki\Connection\Database::replace	(		$table,
			$uniqueIndexes,
			$rows,
			$fname = __METHOD__
	)

See also

DatabaseBase::replace

Since

2.5

select()

SMW\MediaWiki\Connection\Database::select	(		$tableName,
			$fields,
			$conditions,
			$fname,
		array	$options = [],
			$joinConditions = []
	)

See also

DatabaseBase::select

Since

1.9

Parameters

string	$tableName
	$fields
array | string	$conditions
array	$options
array	$joinConditions

Returns

ResultWrapper

Exceptions

UnexpectedValueException

selectField()

SMW\MediaWiki\Connection\Database::selectField	(		$table,
			$fieldName,
			$conditions = '',
			$fname = __METHOD__,
			$options = []
	)

See also

DatabaseBase::selectField

Since

1.9.2

selectRow()

SMW\MediaWiki\Connection\Database::selectRow	(		$table,
			$vars,
			$conds,
			$fname = __METHOD__,
			$options = [],
			$joinConditions = []
	)

See also

DatabaseBase::selectRow

Since

1.9

setFlag()

SMW\MediaWiki\Connection\Database::setFlag

(

$flag

)

See also

DatabaseBase::setFlag

Since

2.4

tableExists()

SMW\MediaWiki\Connection\Database::tableExists	(		$table,
			$fname = __METHOD__
	)

See also

DatabaseBase::tableExists

Since

1.9

Parameters

string	$table
string	$fname

Returns

bool

tableName()

SMW\MediaWiki\Connection\Database::tableName

(

$tableName

)

See also

DatabaseBase::tableName

Since

1.9

Parameters

string

$tableName

Returns

string

tablePrefix()

SMW\MediaWiki\Connection\Database::tablePrefix

(

$prefix = null

)

See also

DatabaseBase::tablePrefix

Since

3.0

Parameters

string

$prefix

Returns

string

timestamp()

SMW\MediaWiki\Connection\Database::timestamp

(

$ts = 0

)

See also

DatabaseBase::timestamp

Since

3.0

Parameters

integer

$ts

Returns

string

unescape_bytea()

SMW\MediaWiki\Connection\Database::unescape_bytea

(

$text

)

Since

3.1

Parameters

string

$text

Returns

string

update()

SMW\MediaWiki\Connection\Database::update	(		$table,
			$values,
			$conds,
			$fname = __METHOD__,
			$options = []
	)

See also

DatabaseBase::update

Since

1.9

upsert()

SMW\MediaWiki\Connection\Database::upsert	(		$table,
		array	$rows,
			$uniqueIndexes,
		array	$set,
			$fname = __METHOD__
	)

See also

DatabaseBase::upsert

Since

3.1

Member Data Documentation

AUTO_COMMIT

const SMW\MediaWiki\Connection\Database::AUTO_COMMIT = 'auto.commit'

Identifies a request to be executed using an auto commit state

Note

(#1605 "... creating temporary tables in a transaction is not replication-safe and causes errors in MySQL 5.6. ...")

TRIGGER_ROLLBACK

const SMW\MediaWiki\Connection\Database::TRIGGER_ROLLBACK = 3

See also

IDatabase::TRIGGER_ROLLBACK

---

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

• Database.php