Helper class used for automatically marking an IDatabase connection as reusable (once it no longer matters which DB domain is selected) and for deferring the actual network connection. More...

Inheritance diagram for Wikimedia\Rdbms\DBConnRef:

[legend]

Collaboration diagram for Wikimedia\Rdbms\DBConnRef:

[legend]

Public Member Functions
	__call ( $name, array $arguments)

	__construct (ILoadBalancer $lb, $conn, $role)

	__destruct ()
	Clean up the connection when out of scope. 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)
	Escape a SQL identifier (e.g. More...

	addQuotes ( $s)
	Escape and quote a raw value string for use in a SQL query. 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=IDatabase::TRANSACTION_EXPLICIT)
	Begin a transaction. More...

	bitAnd ( $fieldLeft, $fieldRight)

	bitNot ( $field)

	bitOr ( $fieldLeft, $fieldRight)

	bufferResults ( $buffer=null)

	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)
	LIKE statement wrapper. More...

	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 ( $fname=__METHOD__, $owner=null)
	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...

	databasesAreIndependent ()
	Returns true if DBs are assumed to be on potentially different servers. More...

	dataSeek ( $res, $row)
	Change the position of the cursor in a result object. More...

	dbSchema ( $schema=null)
	Get/set the db schema. 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...

	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, $vars=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Estimate the number of rows in dataset. More...

	explicitTrxActive ()

	fetchObject ( $res)
	Fetch the next row from the given result object, in object form. More...

	fetchRow ( $res)
	Fetch the next row from the given result object, in associative array form. More...

	fieldExists ( $table, $field, $fname=__METHOD__)
	Determines whether a field exists in a table. More...

	fieldName ( $res, $n)
	Get a field name in a result object. More...

	flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
	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)

	getReferenceRole ()

	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 ()
	Get a human-readable string describing the current software version. More...

	getServerUptime ()
	Determines how long the server has been up. More...

	getServerVersion ()
	A string describing the current software version, like from mysql_get_server_info() More...

	getSessionLagStatus ()
	Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More...

	getSoftwareLink ()
	Returns a wikitext style link to the DB's website (e.g. More...

	getType ()
	Get the type of the DBMS (e.g. 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. More...

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

	insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
	INSERT SELECT wrapper. More...

	isOpen ()

	isReadOnly ()

	lastDoneWrites ()
	Get the last time the connection may have been used for a write query. More...

	lastErrno ()
	Get the last error number. More...

	lastError ()
	Get a description of the last error. More...

	lastQuery ()
	Get the last query that sent on account of IDatabase::query() More...

	limitResult ( $sql, $limit, $offset=false)
	Construct a LIMIT query with optional offset. 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...

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

	numFields ( $res)
	Get the number of fields in a result object. More...

	numRows ( $res)
	Get the number of rows in a query result. More...

	onAtomicSectionCancel (callable $callback, $fname=__METHOD__)
	Run a callback when the atomic section is cancelled. 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...

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

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

	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=[])
	Wrapper to IDatabase::select() that only fetches one row (via LIMIT) More...

	selectRowCount ( $tables, $vars=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Get the number of rows in dataset. More...

	selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Take the same arguments as IDatabase::select() and return the SQL it would use. 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 ( $nameOrArray, $value=null)
	Set the entire array or a particular key of the managing load balancer info array. 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...

	startAtomic ( $fname=__METHOD__, $cancelable=IDatabase::ATOMIC_NOT_CANCELABLE)
	Begin an atomic section of SQL statements. More...

	strreplace ( $orig, $old, $new)
	Returns a SQL expression for simple string replacement (e.g. More...

	tableExists ( $table, $fname=__METHOD__)
	Query whether a given table exists. More...

	tablePrefix ( $prefix=null)
	Get/set the table prefix. More...

	timestamp ( $ts=0)
	Convert a timestamp in one of the formats accepted by ConvertibleTimestamp 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 ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS. More...

	trxLevel ()
	Gets the current transaction level. More...

	trxTimestamp ()
	Get the UNIX timestamp of the time that the transaction was established. More...

	unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Construct a UNION query for permutations of conditions. More...

	unionQueries ( $sqls, $all)
	Construct a UNION query. More...

	unionSupportsOrderAndLimit ()
	Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION. More...

	unlock ( $lockName, $method)
	Release a lock. 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...

	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
	buildSubString ( $input, $startPosition, $length=null)
	Build a SUBSTRING function. More...

Public Attributes
const	FLD_DOMAIN = 2

const	FLD_FLAGS = 3

const	FLD_GROUP = 1

const	FLD_INDEX = 0

Protected Member Functions
	assertRoleAllowsWrites ()
	Error out if the role is not DB_MASTER. More...

Private Attributes
Database null	$conn
	Live connection handle. More...

ILoadBalancer	$lb

array null	$params
	N-tuple of (server index, group, DatabaseDomain\|string) More...

int	$role
	One of DB_MASTER/DB_REPLICA. More...

Detailed Description

Helper class used for automatically marking an IDatabase connection as reusable (once it no longer matters which DB domain is selected) and for deferring the actual network connection.

This uses an RAII-style pattern where calling code is expected to keep the returned reference handle as a function variable that falls out of scope when no longer needed. This avoids the need for matching reuseConnection() calls for every "return" statement as well as the tedious use of try/finally.

Example:: function getRowData() {

$conn = $this->lb->getConnectedRef( DB_REPLICA );

$row = $conn->select( ... );

return $row ? (array)$row : false;

// $conn falls out of scope and $this->lb->reuseConnection() gets called

}

Since: 1.22

Definition at line 29 of file DBConnRef.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\DBConnRef::__construct	(	ILoadBalancer	$lb,
			$conn,
			$role
	)

Parameters

ILoadBalancer	$lb	Connection manager for $conn
IDatabase \| array	$conn	Database or (server index, query groups, domain, flags)
int	$role	The type of connection asked for; one of DB_MASTER/DB_REPLICA

Definition at line 50 of file DBConnRef.php.

References Wikimedia\Rdbms\DBConnRef\$conn, Wikimedia\Rdbms\DBConnRef\$lb, and Wikimedia\Rdbms\DBConnRef\$role.

◆ __destruct()

Wikimedia\Rdbms\DBConnRef::__destruct ( )

Clean up the connection when out of scope.

Definition at line 788 of file DBConnRef.php.

Member Function Documentation

◆ __call()

Wikimedia\Rdbms\DBConnRef::__call	(		$name,
		array	$arguments
	)

Definition at line 62 of file DBConnRef.php.

References Wikimedia\Rdbms\DBConnRef\$params.

◆ __toString()

Wikimedia\Rdbms\DBConnRef::__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.

Returns: string "<db type> object #<X>" or "<db type> object #<X> (resource/handle id #<Y>)"

Since: 1.34

Wikimedia\Rdbms\DBConnRef::aggregateValue	(	$valuedata,
		$valuename = `'value'`
	)

Wikimedia\Rdbms\DBConnRef::begin	(	$fname = `__METHOD__`,
		$mode = `IDatabase::TRANSACTION_EXPLICIT`
	)

string	$fname	Calling function name
string	$mode	A situationally valid IDatabase::TRANSACTION_* constant [optional]

Wikimedia\Rdbms\DBConnRef::bitAnd	(	$fieldLeft,
		$fieldRight
	)

Wikimedia\Rdbms\DBConnRef::bitOr	(	$fieldLeft,
		$fieldRight
	)

Wikimedia\Rdbms\DBConnRef::buildGroupConcatField	(	$delim,
		$table,
		$field,
		$conds = `''`,
		$join_conds = `[]`
	)

string	$delim	Glue to bind the results together
string \| array	$table	Table name
string	$field	Field name
string \| array	$conds	Conditions
string \| array	$join_conds	Join conditions

Wikimedia\Rdbms\DBConnRef::buildSelectSubquery	(	$table,
		$vars,
		$conds = `''`,
		$fname = `__METHOD__`,
		$options = `[]`,
		$join_conds = `[]`
	)

Wikimedia\Rdbms\DBConnRef::buildSubstring	(	$input,
		$startPosition,
		$length = `null`
	)

Wikimedia\Rdbms\DBConnRef::cancelAtomic	(		$fname = `__METHOD__`,
		AtomicSectionIdentifier	$sectionId = `null`
	)

array	$valuedata
string	$valuename

string	$fieldLeft
string	$fieldRight

string	$fieldLeft
string	$fieldRight

string	$fname
AtomicSectionIdentifier \| null	$sectionId	Section ID from startAtomic(); passing this enables cancellation of unclosed nested sections [optional]

Wikimedia\Rdbms\DBConnRef::clearFlag	(	$flag,
		$remember = `self::REMEMBER_NOTHING`
	)

int	$flag	One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX)
string	$remember	IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]

Wikimedia\Rdbms\DBConnRef::close	(	$fname = `__METHOD__`,
		$owner = `null`
	)

string	$fname	Caller name
int \| null	$owner	ID of the calling instance (e.g. the LBFactory ID)

Wikimedia\Rdbms\DBConnRef::commit	(	$fname = `__METHOD__`,
		$flush = `self::FLUSHING_ONE`
	)

Wikimedia\Rdbms\DBConnRef::conditional	(	$cond,
		$trueVal,
		$falseVal
	)

string \| array	$cond	SQL expression which will result in a boolean value
string	$trueVal	SQL expression to return if true
string	$falseVal	SQL expression to return if false

Wikimedia\Rdbms\DBConnRef::decodeExpiry	(	$expiry,
		$format = `TS_MW`
	)

string	$expiry	DB timestamp field value for expiry
int	$format	TS_* constant, defaults to TS_MW

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ __call()

◆ __toString()

◆ addIdentifierQuotes()

◆ addQuotes()

◆ affectedRows()

◆ aggregateValue()

◆ anyChar()

◆ anyString()

◆ assertNoOpenTransactions()

◆ assertRoleAllowsWrites()

◆ begin()

◆ bitAnd()

◆ bitNot()

◆ bitOr()

◆ bufferResults()

◆ buildConcat()

◆ buildGroupConcatField()

◆ buildIntegerCast()

◆ buildLike()

◆ buildSelectSubquery()

◆ buildStringCast()

◆ buildSubstring()

◆ cancelAtomic()

◆ clearFlag()

◆ close()

◆ commit()

◆ conditional()

◆ databasesAreIndependent()

◆ dataSeek()

◆ dbSchema()

◆ decodeBlob()

◆ decodeExpiry()

◆ delete()

◆ deleteJoin()

◆ doAtomicSection()

◆ encodeBlob()

◆ encodeExpiry()

◆ endAtomic()

◆ estimateRowCount()

◆ explicitTrxActive()

◆ fetchObject()

◆ fetchRow()

◆ fieldExists()

◆ fieldName()

◆ flushSnapshot()

◆ freeResult()

◆ getDBname()

◆ getDomainID()

◆ getFlag()

◆ getInfinity()

◆ getLag()

◆ getLBInfo()

◆ getMasterPos()

◆ getProperty()

◆ getReferenceRole()

◆ getReplicaPos()

◆ getScopedLockAndFlush()

◆ getServer()

◆ getServerInfo()

◆ getServerUptime()

◆ getServerVersion()

◆ getSessionLagStatus()

◆ getSoftwareLink()

◆ getType()

◆ implicitOrderby()

◆ indexExists()

◆ insert()

◆ insertId()

◆ insertSelect()

◆ isOpen()

◆ isReadOnly()

Wikimedia\Rdbms\DBConnRef::delete	(	$table,
		$conds,
		$fname = `__METHOD__`
	)

Wikimedia\Rdbms\DBConnRef::deleteJoin	(	$delTable,
		$joinTable,
		$delVar,
		$joinVar,
		$conds,
		$fname = `__METHOD__`
	)

string	$delTable	The table to delete from.
string	$joinTable	The other table.
string	$delVar	The variable to join on, in the first table.
string	$joinVar	The variable to join on, in the second table.
array \| string	$conds	Condition array of field names mapped to variables, ANDed together in the WHERE clause
string	$fname	Calling function name (use METHOD) for logs/profiling

Wikimedia\Rdbms\DBConnRef::doAtomicSection	(		$fname,
		callable	$callback,
			$cancelable = `self::ATOMIC_NOT_CANCELABLE`
	)

string	$fname	Caller name (usually METHOD)
callable	$callback	Callback that issues DB updates
string	$cancelable	Pass self::ATOMIC_CANCELABLE to use a savepoint and enable self::cancelAtomic() for this section.

DBError	If an error occurs, see IDatabase::query()
Exception	If an error occurs in the callback

Wikimedia\Rdbms\DBConnRef::estimateRowCount	(	$table,
		$var = `' *'`,
		$conds = `''`,
		$fname = `__METHOD__`,
		$options = `[]`,
		$join_conds = `[]`
	)

Wikimedia\Rdbms\DBConnRef::fieldExists	(	$table,
		$field,
		$fname = `__METHOD__`
	)

Wikimedia\Rdbms\DBConnRef::flushSnapshot	(	$fname = `__METHOD__`,
		$flush = `self::FLUSHING_ONE`
	)

Wikimedia\Rdbms\DBConnRef::getScopedLockAndFlush	(	$lockKey,
		$fname,
		$timeout
	)