Helper class to handle automatically marking connections as reusable (via RAII pattern) as well handling deferring the actual network connection until the handle is used. 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)

	__destruct ()
	Clean up the connection when out of scope.

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

	anyChar ()
	Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.

	anyString ()
	Returns a token for buildLike() that denotes a '' to be used in a LIKE query.

	assertNoOpenTransactions ()
	Assert that all explicit transactions or atomic sections have been closed.

	begin ( $fname=__METHOD__, $mode=IDatabase::TRANSACTION_EXPLICIT)
	Begin a transaction.

	bitAnd ( $fieldLeft, $fieldRight)

	bitNot ( $field)

	bitOr ( $fieldLeft, $fieldRight)

	bufferResults ( $buffer=null)
	Turns buffering of SQL result sets on (true) or off (false).

	buildConcat ( $stringList)
	Build a concatenation list to feed into a SQL query.

	buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
	Build a GROUP_CONCAT or equivalent statement for a query.

	buildIntegerCast ( $field)

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

	buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery.

	buildStringCast ( $field)

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

	cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
	Cancel an atomic section of SQL statements.

	clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
	Clear a flag for this connection.

	close ()
	Close the database connection.

	commit ( $fname=__METHOD__, $flush='')
	Commits a transaction previously started using begin().

	conditional ( $cond, $trueVal, $falseVal)
	Returns an SQL expression for a simple conditional.

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

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

	dbSchema ( $schema=null)
	Get/set the db schema.

	decodeBlob ( $b)
	Some DBMSs return a special placeholder object representing blob fields in result objects.

	decodeExpiry ( $expiry, $format=TS_MW)
	Decode an expiry time into a DBMS independent format.

	delete ( $table, $conds, $fname=__METHOD__)
	DELETE query wrapper.

	deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
	DELETE where the condition is a join.

	doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
	Perform an atomic section of reversable SQL statements from a callback.

	doneWrites ()
	Returns true if the connection may have been used for write queries.

	encodeBlob ( $b)
	Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.

	encodeExpiry ( $expiry)
	Encode an expiry time into the DBMS dependent format.

	endAtomic ( $fname=__METHOD__)
	Ends an atomic section of SQL statements.

	estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Estimate the number of rows in dataset.

	explicitTrxActive ()

	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.

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

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

	flushSnapshot ( $fname=__METHOD__)
	Commit any transaction but error out if writes or callbacks are pending.

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

	getDBname ()
	Get the current DB name.

	getDomainID ()
	Return the currently selected domain ID.

	getFlag ( $flag)
	Returns a boolean whether the flag $flag is set for this connection.

	getInfinity ()
	Find out when 'infinity' is.

	getLag ()
	Get the amount of replication lag for this database server.

	getLBInfo ( $name=null)
	Get properties passed down from the server info array of the load balancer.

	getMasterPos ()
	Get the position of this master.

	getProperty ( $name)

	getReplicaPos ()
	Get the replication position of this replica DB.

	getScopedLockAndFlush ( $lockKey, $fname, $timeout)
	Acquire a named lock, flush any transaction, and return an RAII style unlocker object.

	getServer ()
	Get the server hostname or IP address.

	getServerInfo ()
	A string describing the current software version, and possibly other details in a user-friendly way.

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

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

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

	getSoftwareLink ()
	Returns a wikitext link to the DB's website, e.g., return "[https://www.mysql.com/ MySQL]"; Should at least contain plain text, if for some reason your database has no website.

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

	getWikiID ()
	Alias for getDomainID()

	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__)
	Determines whether an index exists Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure.

	insert ( $table, $a, $fname=__METHOD__, $options=[])
	INSERT wrapper, inserts an array into a table.

	insertId ()
	Get the inserted value of an auto-increment row.

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

	isOpen ()
	Is a connection to the database open?

	isReadOnly ()

	lastDoneWrites ()
	Returns the last time the connection may have been used for write queries.

	lastErrno ()
	Get the last error number.

	lastError ()
	Get a description of the last error.

	lastQuery ()
	Return the last query that went through IDatabase::query()

	lock ( $lockName, $method, $timeout=5)
	Acquire a named lock.

	lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Lock all rows meeting the given conditions/options FOR UPDATE.

	lockIsFree ( $lockName, $method)
	Check to see if a named lock is not locked by any thread (non-blocking)

	makeList ( $a, $mode=self::LIST_COMMA)
	Makes an encoded list of strings from an array.

	makeWhereFrom2d ( $data, $baseKey, $subKey)
	Build a partial where clause from a 2-d array such as used for LinkBatch.

	masterPosWait (DBMasterPos $pos, $timeout)
	Wait for the replica DB to catch up to a given master position.

	maxListLen ()
	Return the maximum number of items allowed in a list, or 0 for unlimited.

	namedLocksEnqueue ()
	Check to see if a named lock used by lock() use blocking queues.

	nextSequenceValue ( $seqName)
	Deprecated method, calls should be removed.

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

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

	onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
	Run a callback as soon as there is no transaction pending.

	onTransactionIdle (callable $callback, $fname=__METHOD__)
	Alias for onTransactionCommitOrIdle() for backwards-compatibility.

	onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
	Run a callback before the current transaction commits or now if there is none.

	onTransactionResolution (callable $callback, $fname=__METHOD__)
	Run a callback as soon as the current transaction commits or rolls back.

	pendingWriteCallers ()
	Get the list of method names that did write queries for this transaction.

	pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
	Get the time spend running write queries for this transaction.

	pendingWriteRowsAffected ()
	Get the number of affected rows from pending write queries.

	ping (&$rtt=null)
	Ping the server and try to reconnect if it there is no connection.

	preCommitCallbacksPending ()

	query ( $sql, $fname=__METHOD__, $tempIgnore=false)
	Run an SQL query and return the result.

	replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
	REPLACE query wrapper.

	restoreFlags ( $state=self::RESTORE_PRIOR)
	Restore the flags to their prior state before the last setFlag/clearFlag call.

	rollback ( $fname=__METHOD__, $flush='')
	Rollback a transaction previously started using begin().

	select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Execute a SELECT query constructed using the various parameters provided.

	selectDB ( $db)
	Change the current database.

	selectDomain ( $domain)
	Set the current domain (database, schema, and table prefix)

	selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
	A SELECT wrapper which returns a single field from a single result row.

	selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
	A SELECT wrapper which returns a list of single field values from result rows.

	selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
	Single row SELECT wrapper.

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

	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.

	serverIsReadOnly ()

	setBigSelects ( $value=true)
	Allow or deny "big selects" for this session only.

	setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
	Set a flag for this connection.

	setIndexAliases (array $aliases)
	Convert certain index names to alternative names before querying the DB.

	setLazyMasterHandle (IDatabase $conn)
	Set a lazy-connecting DB handle to the master DB (for replication status purposes)

	setLBInfo ( $name, $value=null)
	Set the LB info array, or a member of it.

	setSchemaVars ( $vars)
	Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS.

	setSessionOptions (array $options)
	Override database's default behavior.

	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.

	setTransactionListener ( $name, callable $callback=null)
	Run a callback after each time any transaction commits or rolls back.

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

	strreplace ( $orig, $old, $new)
	Returns a command for str_replace function in SQL query.

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

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

	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.

	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.

	trxLevel ()
	Gets the current transaction level.

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

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

	unionQueries ( $sqls, $all)
	Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.

	unionSupportsOrderAndLimit ()
	Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct.

	unlock ( $lockName, $method)
	Release a lock.

	update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
	UPDATE wrapper.

	upsert ( $table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)
	INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.

	wasConnectionLoss ()
	Determines if the last query error was due to a dropped connection.

	wasDeadlock ()
	Determines if the last failure was due to a deadlock.

	wasErrorReissuable ()
	Determines if the last query error was due to something outside of the query itself.

	wasLockTimeout ()
	Determines if the last failure was due to a lock timeout.

	wasReadOnlyError ()
	Determines if the last failure was due to the database being read-only.

	writesOrCallbacksPending ()
	Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending.

	writesPending ()

Public Member Functions inherited from Wikimedia\Rdbms\IDatabase
	buildSubString ( $input, $startPosition, $length=null)
	Build a SUBSTRING function.

Public Attributes
const	FLD_DOMAIN = 2

const	FLD_FLAGS = 3

const	FLD_GROUP = 1

const	FLD_INDEX = 0

Private Attributes
Database null	$conn
	Live connection handle.

ILoadBalancer	$lb

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

Detailed Description

Helper class to handle automatically marking connections as reusable (via RAII pattern) as well handling deferring the actual network connection until the handle is used.

Note: : proxy methods are defined explicitly to avoid interface errors

Since: 1.22

Definition at line 15 of file DBConnRef.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ILoadBalancer	$lb	Connection manager for $conn
Database \| array	$conn	Database handle or (server index, query groups, domain, flags)

Definition at line 32 of file DBConnRef.php.

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

◆ __destruct()

Wikimedia\Rdbms\DBConnRef::__destruct ( )

Clean up the connection when out of scope.

Definition at line 650 of file DBConnRef.php.

Member Function Documentation

◆ __call()

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

Definition at line 43 of file DBConnRef.php.

References Wikimedia\Rdbms\DBConnRef\$params, and list.

◆ addQuotes()

Wikimedia\Rdbms\DBConnRef::addQuotes ( $s )

Adds quotes and backslashes.

Parameters

string | int | null | bool | Blob $s

Returns: string|int

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	DBO_* constants from Defines.php: DBO_DEBUG: output some debug info (same as debug()) DBO_NOBUFFER: don't buffer results (inverse of bufferResults()) DBO_TRX: automatically start transactions DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode and removes it in command line mode DBO_PERSISTENT: use persistant database connection
string	$remember	IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]

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

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

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

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

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ __call()

◆ addQuotes()

◆ affectedRows()

◆ aggregateValue()

◆ anyChar()

◆ anyString()

◆ assertNoOpenTransactions()

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

◆ doneWrites()

◆ encodeBlob()

◆ encodeExpiry()

◆ endAtomic()

◆ estimateRowCount()

◆ explicitTrxActive()

◆ fetchObject()

◆ fetchRow()

◆ fieldExists()

◆ fieldName()

◆ flushSnapshot()

◆ freeResult()

◆ getDBname()

◆ getDomainID()

◆ getFlag()

◆ getInfinity()

◆ getLag()

◆ getLBInfo()

◆ getMasterPos()

◆ getProperty()

◆ getReplicaPos()

◆ getScopedLockAndFlush()

◆ getServer()

◆ getServerInfo()

◆ getServerUptime()

◆ getServerVersion()

◆ getSessionLagStatus()

◆ getSoftwareLink()

◆ getType()

◆ getWikiID()

◆ implicitGroupby()

◆ implicitOrderby()

◆ indexExists()

◆ insert()

◆ insertId()

◆ insertSelect()

◆ isOpen()

◆ isReadOnly()

◆ lastDoneWrites()

◆ lastErrno()

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

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

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

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

string	$lockKey	Name of lock to release
string	$fname	Name of the calling method
int	$timeout	Acquisition timeout in seconds

Wikimedia\Rdbms\DBConnRef::indexExists	(	$table,
		$index,
		$fname = `__METHOD__`
	)

Wikimedia\Rdbms\DBConnRef::insert	(	$table,
		$a,
		$fname = `__METHOD__`,
		$options = `[]`
	)

string	$table	Table name. This will be passed through Database::tableName().
array	$a	Array of rows to insert
string	$fname	Calling function name (use METHOD) for logs/profiling
array	$options	Array of options