Helper for testing the methods from the Database class. More...

Inheritance diagram for DatabaseTestHelper:

[legend]

Collaboration diagram for DatabaseTestHelper:

[legend]

Public Member Functions
	__construct ( $testName, array $opts=[])

	addIdentifierQuotes ( $s)
	Quotes an identifier using `backticks` or "double quotes" depending on the database type.

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

	fetchAffectedRowCount ()

	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)
	mysql_fetch_field() wrapper Returns false if the field doesn't exist

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

	forceNextQueryError ( $errno, $error, $options=[])

	forceNextResult ( $res)

	getLastSqls ()
	Returns SQL queries grouped by '; ' Clear the list of queries that have been done so far.

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

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

	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.

	indexInfo ( $table, $index, $fname='Database::indexInfo')
	Get information about an index into an object.

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

	isOpen ()
	Is a connection to the database open?

	lastErrno ()
	Get the last error number.

	lastError ()
	Get a description of the last error.

	nativeReplace ( $table, $rows, $fname)
	REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement.

	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)
	Open a new connection to the database (closing any existing one)

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

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

	setExistingTables ( $tablesExists)

	setUnionSupportsOrderAndLimit ( $v)

	strencode ( $s)
	Wrapper for addslashes()

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

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

Public Member Functions inherited from Wikimedia\Rdbms\Database
	__clone ()
	Make sure that copies do not share the same client binding handle.

	__destruct ()
	Run a few simple sanity checks and close dangling connections.

	__sleep ()
	Called by serialize.

	__toString ()

	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.

	begin ( $fname=__METHOD__, $mode=self::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=self::FLUSHING_ONE)
	Commits a transaction previously started using begin().

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

	connectionErrorLogger ( $errno, $errstr)
	Error handler for logging errors during database connection This method should not be used outside of Database classes.

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

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

	deadlockLoop ()
	Perform a deadlock-prone transaction.

	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.

	dropTable ( $tableName, $fName=__METHOD__)
	Delete a table.

	duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
	Creates a new table with structure copied from existing table.

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

	explicitTrxActive ()

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

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

	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.

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

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

	getWikiID ()
	Alias for getDomainID()

	ignoreIndexClause ( $index)
	IGNORE INDEX clause.

	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.

	indexUnique ( $table, $index)
	Determines if a given index is unique.

	initConnection ()
	Initialize the connection to the database over the wire (or to local files)

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

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

	isQuotedIdentifier ( $name)
	Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers .

	isReadOnly ()

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

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

	limitResult ( $sql, $limit, $offset=false)
	Construct a LIMIT query with optional offset.

	listTables ( $prefix=null, $fname=__METHOD__)
	List all tables on the database.

	listViews ( $prefix=null, $fname=__METHOD__)
	Lists all the VIEWs in the database.

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

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

	lockTables (array $read, array $write, $method)
	Lock specific tables.

	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.

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

	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.

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

	reportConnectionError ( $error='Unknown error')

	reportQueryError ( $error, $errno, $sql, $fname, $tempIgnore=false)
	Report a query error.

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

	runOnTransactionIdleCallbacks ( $trigger)
	Actually run and consume any "on transaction idle/resolution" callbacks.

	runOnTransactionPreCommitCallbacks ()
	Actually run and consume any "on transaction pre-commit" callbacks.

	runTransactionListenerCallbacks ( $trigger)
	Actually run any "transaction listener" callbacks.

	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.

	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, $var=' *', $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.

	setLogger (LoggerInterface $logger)
	Set the PSR-3 logger interface to use for query logging.

	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 each time any transaction commits or rolls back.

	setTrxEndCallbackSuppression ( $suppress)
	Whether to disable running of post-COMMIT/ROLLBACK callbacks.

	sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
	Read and execute SQL commands from a file.

	sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
	Read and execute commands from an open file handle.

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

	streamStatementEnd (&$sql, &$newLine)
	Called by sourceStream() to check if we've reached a statement end.

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

	tableLocksHaveTransactionScope ()
	Checks if table locks acquired by lockTables() are transaction-bound in their scope.

	tableName ( $name, $format='quoted')
	Format a table name ready for use in constructing an SQL query.

	tableNames ()
	Fetch a number of table names into an array This is handy when you need to construct SQL for joins.

	tableNamesN ()
	Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins.

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

	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.

	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.

	trxStatus ()

	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.

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

	unlockTables ( $method)
	Unlock all tables locked via lockTables()

	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.

	useIndexClause ( $index)
	USE INDEX clause.

	wasConnectionError ( $errno)
	Do not use this method outside of Database/DBError classes.

	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 ()
	Returns true if there is a transaction/round open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish.

	writesPending ()

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

Protected Member Functions
	addSql ( $sql)

	checkFunctionName ( $fname)

	closeConnection ()
	Closes underlying database connection.

	doQuery ( $sql)
	Run a query and return a DBMS-dependent wrapper (that has all IResultWrapper methods)

	wasKnownStatementRollbackError ()

Protected Member Functions inherited from Wikimedia\Rdbms\Database
	__construct (array $params)

	assertBuildSubstringParams ( $startPosition, $length)
	Check type and bounds for parameters to self::buildSubstring()

	assertOpen ()
	Make sure isOpen() returns true as a sanity check.

	doBegin ( $fname)
	Issues the BEGIN command to the database server.

	doCommit ( $fname)
	Issues the COMMIT command to the database server.

	doInitConnection ()
	Actually connect to the database over the wire (or to local files)

	doLockTables (array $read, array $write, $method)
	Helper function for lockTables() that handles the actual table locking.

	doReleaseSavepoint ( $identifier, $fname)
	Release a savepoint.

	doRollback ( $fname)
	Issues the ROLLBACK command to the database server.

	doRollbackToSavepoint ( $identifier, $fname)
	Rollback to a savepoint.

	doSavepoint ( $identifier, $fname)
	Create a savepoint.

	doUnlockTables ( $method)
	Helper function for unlockTables() that handles the actual table unlocking.

	escapeLikeInternal ( $s, $escapeChar='`')

	extractSingleFieldFromList ( $var)

	fieldNamesWithAlias ( $fields)
	Gets an array of aliased field names.

	fieldNameWithAlias ( $name, $alias=false)
	Get an aliased field name e.g.

	getApproximateLagStatus ()
	Get a replica DB lag estimate for this server.

	getBindingHandle ()
	Get the underlying binding connection handle.

	getDefaultSchemaVars ()
	Get schema variables to use if none have been set via setSchemaVars().

	getLastPHPError ()

	getLazyMasterHandle ()

	getLogContext (array $extras=[])
	Create a log context to pass to PSR-3 logger functions.

	getQueryVerb ( $sql)

	getReadOnlyReason ()

	getRecordedTransactionLagStatus ()
	Get the replica DB lag when the current transaction started.

	getSchemaVars ()
	Get schema variables.

	getTransactionRoundId ()

	indexName ( $index)
	Allows for index remapping in queries where this is not consistent across DBMS.

	installErrorHandler ()
	Set a custom error handler for logging errors during database connection.

	isInsertSelectSafe (array $insertOptions, array $selectOptions)

	isTransactableQuery ( $sql)
	Determine whether a SQL statement is sensitive to isolation level.

	isWriteQuery ( $sql)
	Determine whether a query writes to the DB.

	makeGroupByWithHaving ( $options)
	Returns an optional GROUP BY with an optional HAVING.

	makeInsertOptions ( $options)
	Helper for Database::insert().

	makeOrderBy ( $options)
	Returns an optional ORDER BY.

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

	makeUpdateOptions ( $options)
	Make UPDATE options for the Database::update function.

	makeUpdateOptionsArray ( $options)
	Make UPDATE options array for Database::makeUpdateOptions.

	nativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
	Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory.

	nonNativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
	Implementation of insertSelect() based on select() and insert()

	normalizeConditions ( $conds, $fname)

	pendingWriteAndCallbackCallers ()
	Get the list of method names that have pending write queries or callbacks for this transaction.

	qualifiedTableComponents ( $name)
	Get the table components needed for a query given the currently selected database.

	registerTempTableOperation ( $sql)

	replaceLostConnection ( $fname)
	Close any existing (dead) database connection and open a new connection.

	replaceVars ( $ins)
	Database independent variable replacement.

	restoreErrorHandler ()
	Restore the previous error handler and return the last PHP error for this DB.

	resultObject ( $result)
	Take the result from a query, and wrap it in a ResultWrapper if necessary.

	tableNamesWithAlias ( $tables)
	Gets an array of aliased table names.

	tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[])
	Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause.

	tableNameWithAlias ( $table, $alias=false)
	Get an aliased table name.

	wasQueryTimeout ( $error, $errno)
	Checks whether the cause of the error is detected to be a timeout.

Protected Attributes
array null	$lastError = null

	$lastSqls = []
	Array of lastSqls passed to query(), This is an array since some methods in Database can do more than one query.

array null	$nextError = null

array	$nextResult = []
	List of row arrays.

	$tablesExists
	Array of tables to be considered as existing by tableExist() Use setExistingTables() to alter.

	$testName = []
	CLASS of the test suite, used to determine, if the function name is passed every time to query()

	$unionSupportsOrderAndLimit = true
	Value to return from unionSupportsOrderAndLimit()

Protected Attributes inherited from Wikimedia\Rdbms\Database
integer null	$affectedRowCount
	Rows affected by the last query to query() or its CRUD wrappers.

string	$agent
	Agent name for query profiling.

bool	$cliMode
	Whether this PHP instance is for a CLI script.

resource null	$conn = null
	Database connection.

array	$connectionParams = []
	Parameters used by initConnection() to establish a connection.

LoggerInterface	$connLogger

DatabaseDomain	$currentDomain

string	$dbName
	Database that this instance is currently connected to.

string	$delimiter = ';'

callback	$deprecationLogger
	Deprecation logging callback.

callback	$errorLogger
	Error logging callback.

int	$flags

string bool null	$htmlErrors
	Stashed value of html_errors INI setting.

string[]	$indexAliases = []
	Map of (index alias => index)

float	$lastPing = 0.0
	UNIX timestamp.

string	$lastQuery = ''
	SQL query.

float bool	$lastWriteTime = false
	UNIX timestamp of last write query.

array	$lbInfo = []

int	$nonNativeInsertSelectBatchSize = 10000

bool	$opened = false

string	$password
	Password used to establish the current connection.

string bool	$phpError = false

array null	$preparedArgs

object string	$profiler
	Class name or object With profileIn/profileOut methods.

LoggerInterface	$queryLogger

string	$schema = ''

array bool	$schemaVars = false

string	$server
	Server that this instance is currently connected to.

array	$sessionTempTables = []
	Map of (table name => 1) for TEMPORARY tables.

array	$sessionVars = []

BagOStuff	$srvCache
	APC cache.

array[]	$tableAliases = []
	Map of (table => (dbname, schema, prefix) map)

string	$tablePrefix = ''

array[]	$trxEndCallbacks = []
	List of (callable, method name, atomic section id)

bool	$trxEndCallbacksSuppressed = false
	Whether to suppress triggering of transaction end callbacks.

array[]	$trxIdleCallbacks = []
	List of (callable, method name, atomic section id)

int	$trxLevel = 0
	Either 1 if a transaction is active or 0 otherwise.

array[]	$trxPreCommitCallbacks = []
	List of (callable, method name, atomic section id)

TransactionProfiler	$trxProfiler

callable[]	$trxRecurringCallbacks = []
	Map of (name => callable)

string	$trxShortId = ''
	Either a short hexidecimal string if a transaction is active or "".

int	$trxStatus = self::STATUS_TRX_NONE
	Transaction status.

Exception null	$trxStatusCause
	The last error that caused the status to become STATUS_TRX_ERROR.

array null	$trxStatusIgnoredCause
	If wasKnownStatementRollbackError() prevented trxStatus from being set, the relevant details are stored here.

string	$user
	User that this instance is currently connected under the name of.

Additional Inherited Members
Static Public Member Functions inherited from Wikimedia\Rdbms\Database
static	attributesFromType ( $dbType, $driver=null)

static	factory ( $dbType, $p=[], $connect=self::NEW_CONNECTED)
	Construct a Database subclass instance given a database type and parameters.

static	getCacheSetOptions (IDatabase $db1, IDatabase $db2=null)
	Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination.

Public Attributes inherited from Wikimedia\Rdbms\Database
const	DEADLOCK_DELAY_MAX = 1500000
	Maximum time to wait before retry.

const	DEADLOCK_DELAY_MIN = 500000
	Minimum time to wait before retry, in microseconds.

const	DEADLOCK_TRIES = 4
	Number of times to re-try an operation in case of deadlock.

const	PING_QUERY = 'SELECT 1 AS ping'

const	PING_TTL = 1.0
	How long before it is worth doing a dummy query to test the connection.

const	SLOW_WRITE_SEC = 0.500

const	SMALL_WRITE_ROWS = 100

const	TINY_WRITE_SEC = 0.010

Static Protected Member Functions inherited from Wikimedia\Rdbms\Database
static	generalizeSQL ( $sql)
	Removes most variables from an SQL query and replaces them with X or N for numbers.

static	getAttributes ()

Detailed Description

Helper for testing the methods from the Database class.

Since: 1.22

Definition at line 11 of file DatabaseTestHelper.php.

Constructor & Destructor Documentation

◆ __construct()

DatabaseTestHelper::__construct	(		$testName,
		array	$opts = [] )

Definition at line 45 of file DatabaseTestHelper.php.

References $e, $testName, open(), and wfWarn().

Member Function Documentation

◆ addIdentifierQuotes()

DatabaseTestHelper::addIdentifierQuotes ( $s )

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

Parameters

string $s

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 127 of file DatabaseTestHelper.php.

References $s.

◆ addSql()

DatabaseTestHelper::addSql ( $sql )

protected

Definition at line 96 of file DatabaseTestHelper.php.

Referenced by doQuery().

◆ checkFunctionName()

DatabaseTestHelper::checkFunctionName ( $fname )

protected

Definition at line 104 of file DatabaseTestHelper.php.

References $fname.

Referenced by query(), and tableExists().

◆ closeConnection()

DatabaseTestHelper::closeConnection ( )

protected

Closes underlying database connection.

Since: 1.20

Returns: bool Whether connection was closed successfully

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 239 of file DatabaseTestHelper.php.

◆ dataSeek()

DatabaseTestHelper::dataSeek	(		$res,
			$row )

Change the position of the cursor in a result object.

See also: https://secure.php.net/mysql_data_seek

Parameters

mixed	$res	A SQL result
int	$row

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 188 of file DatabaseTestHelper.php.

◆ doQuery()

DatabaseTestHelper::doQuery ( $sql )

protected

Run a query and return a DBMS-dependent wrapper (that has all IResultWrapper methods)

This might return things, such as mysqli_result, that do not formally implement IResultWrapper, but nonetheless implement all of its methods correctly

Parameters

string $sql SQL query.

Returns: IResultWrapper|bool Iterator to feed to fetchObject/fetchRow; false on failure

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 243 of file DatabaseTestHelper.php.

References $nextError, $nextResult, $res, addSql(), and lastError().

◆ fetchAffectedRowCount()

DatabaseTestHelper::fetchAffectedRowCount ( )

Returns: int Number of retrieved rows according to the driver

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 214 of file DatabaseTestHelper.php.

◆ fetchObject()

DatabaseTestHelper::fetchObject ( $res )

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

IResultWrapper | stdClass $res Object as returned from IDatabase::query(), etc.

Returns: stdClass|bool

Exceptions

DBUnexpectedError Thrown if the database returns an error

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 164 of file DatabaseTestHelper.php.

◆ fetchRow()

DatabaseTestHelper::fetchRow ( $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

IResultWrapper $res Result object as returned from IDatabase::query(), etc.

Returns: array|bool

Exceptions

DBUnexpectedError Thrown if the database returns an error

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 168 of file DatabaseTestHelper.php.

◆ fieldInfo()

DatabaseTestHelper::fieldInfo	(		$table,
			$field )

mysql_fetch_field() wrapper Returns false if the field doesn't exist

Parameters

string	$table	Table name
string	$field	Field name

Returns: Field

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 206 of file DatabaseTestHelper.php.

◆ fieldName()

DatabaseTestHelper::fieldName	(		$res,
			$n )

Get a field name in a result object.

See also: https://secure.php.net/mysql_field_name

Parameters

mixed	$res	A SQL result
int	$n

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 180 of file DatabaseTestHelper.php.

◆ forceNextQueryError()

DatabaseTestHelper::forceNextQueryError	(	$errno,
		$error,
		$options = [] )

Parameters

int	$errno	Error number
string	$error	Error text
array	$options	wasKnownStatementRollbackError: Return value for wasKnownStatementRollbackError()

Definition at line 92 of file DatabaseTestHelper.php.

References $options.

◆ forceNextResult()

DatabaseTestHelper::forceNextResult ( $res )

Parameters

mixed $res Use an array of row arrays to set row result

Definition at line 82 of file DatabaseTestHelper.php.

References $res.

◆ getLastSqls()

DatabaseTestHelper::getLastSqls ( )

Returns SQL queries grouped by '; ' Clear the list of queries that have been done so far.

Returns: string

Definition at line 68 of file DatabaseTestHelper.php.

References $lastSqls.

Referenced by DatabaseSQLTest\assertLastSqlDb().

◆ getServerInfo()

DatabaseTestHelper::getServerInfo ( )

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

Will be listed on Special:Version, etc. Use getServerVersion() to get machine-friendly information.

Returns: string Version information from the database server

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 226 of file DatabaseTestHelper.php.

◆ getServerVersion()

DatabaseTestHelper::getServerVersion ( )

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

Returns: string Version information from the database server.

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 222 of file DatabaseTestHelper.php.

◆ getSoftwareLink()

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

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 218 of file DatabaseTestHelper.php.

◆ getType()

DatabaseTestHelper::getType ( )

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

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 154 of file DatabaseTestHelper.php.

◆ indexInfo()

DatabaseTestHelper::indexInfo	(	$table,
		$index,
		$fname = 'Database::indexInfo' )

Get information about an index into an object.

Parameters

string	$table	Table name
string	$index	Index name
string	$fname	Calling function name

Returns: mixed Database-specific index description class or false if the index does not exist

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 210 of file DatabaseTestHelper.php.

◆ insertId()

DatabaseTestHelper::insertId ( )

Get the inserted value of an auto-increment row.

This should only be called after an insert that used an auto-incremented value. If no such insert was previously done in the current database session, the return value is undefined.

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 184 of file DatabaseTestHelper.php.

◆ isOpen()

DatabaseTestHelper::isOpen ( )

Is a connection to the database open?

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 230 of file DatabaseTestHelper.php.

References true.

◆ lastErrno()

DatabaseTestHelper::lastErrno ( )

Get the last error number.

See also: https://secure.php.net/mysql_errno

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 192 of file DatabaseTestHelper.php.

References lastError().

◆ lastError()

DatabaseTestHelper::lastError ( )

Get a description of the last error.

See also: https://secure.php.net/mysql_error

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 196 of file DatabaseTestHelper.php.

References lastError().

Referenced by doQuery(), lastErrno(), lastError(), and wasKnownStatementRollbackError().

◆ nativeReplace()

DatabaseTestHelper::nativeReplace	(	$table,
		$rows,
		$fname )

REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement.

Parameters

string	$table	Table name
array \| string	$rows	Row(s) to insert
string	$fname	Caller function name

Returns: ResultWrapper

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 150 of file DatabaseTestHelper.php.

References $fname, and $rows.

◆ numFields()

DatabaseTestHelper::numFields ( $res )

Get the number of fields in a result object.

See also: https://secure.php.net/mysql_num_fields

Parameters

mixed $res A SQL result

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 176 of file DatabaseTestHelper.php.

◆ numRows()

DatabaseTestHelper::numRows ( $res )

Get the number of rows in a result object.

Parameters

mixed $res A SQL result

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 172 of file DatabaseTestHelper.php.

◆ open()

DatabaseTestHelper::open	(	$server,
		$user,
		$password,
		$dbName )

Open a new connection to the database (closing any existing one)

Parameters

string	$server	Database server host
string	$user	Database user name
string	$password	Database user password
string	$dbName	Database name

Returns: bool

Exceptions

DBConnectionError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 158 of file DatabaseTestHelper.php.

References object.

Referenced by __construct().

◆ ping()

DatabaseTestHelper::ping ( & $rtt = null )

Ping the server and try to reconnect if it there is no connection.

Parameters

float | null &$rtt Value to store the estimated RTT [optional]

Returns: bool Success or failure

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 234 of file DatabaseTestHelper.php.

◆ query()

DatabaseTestHelper::query	(	$sql,
		$fname = '',
		$tempIgnore = false )

Run an SQL query and return the result.

Normally throws a DBQueryError on failure. If errors are ignored, returns false instead.

If a connection loss is detected, then an attempt to reconnect will be made. For queries that involve no larger transactions or locks, they will be re-issued for convenience, provided the connection was re-established.

In new code, the query wrappers select(), insert(), update(), delete(), etc. should be used where possible, since they give much better DBMS independence and automatically quote or validate user input in a variety of contexts. This function is generally only useful for queries which are explicitly DBMS-dependent and are unsupported by the query wrappers, such as CREATE TABLE.

However, the query wrappers themselves should call this function.

Parameters

string	$sql	SQL query
string	$fname	Name of the calling function, for profiling/SHOW PROCESSLIST comment (you can use METHOD or add some extra info)
bool	$tempIgnore	Whether to avoid throwing an exception on errors... maybe best to catch the exception instead?

Returns: bool|IResultWrapper True for a successful write query, IResultWrapper object for a successful read query, or false on failure if $tempIgnore set

Exceptions

DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 132 of file DatabaseTestHelper.php.

References $fname, and checkFunctionName().

◆ setExistingTables()

DatabaseTestHelper::setExistingTables ( $tablesExists )

Definition at line 75 of file DatabaseTestHelper.php.

References $tablesExists, and array().

◆ setUnionSupportsOrderAndLimit()

DatabaseTestHelper::setUnionSupportsOrderAndLimit ( $v )

Definition at line 264 of file DatabaseTestHelper.php.

References unionSupportsOrderAndLimit().

◆ strencode()

DatabaseTestHelper::strencode ( $s )

Wrapper for addslashes()

Parameters

string $s String to be slashed.

Returns: string Slashed string.

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 122 of file DatabaseTestHelper.php.

References $s.

◆ tableExists()

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

Query whether a given table exists.

Parameters

string	$table
string	$fname

Returns: bool

Exceptions

DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 138 of file DatabaseTestHelper.php.

References $fname, checkFunctionName(), and tableName().

◆ unionSupportsOrderAndLimit()

DatabaseTestHelper::unionSupportsOrderAndLimit ( )

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

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 260 of file DatabaseTestHelper.php.

References $unionSupportsOrderAndLimit.

Referenced by setUnionSupportsOrderAndLimit().

◆ wasKnownStatementRollbackError()

DatabaseTestHelper::wasKnownStatementRollbackError ( )

protected

Returns: bool Whether it is safe to assume the given error only caused statement rollback

Note: This is for backwards compatibility for callers catching DBError exceptions in order to ignore problems like duplicate key errors or foriegn key violations

Since: 1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 200 of file DatabaseTestHelper.php.

References lastError().

Member Data Documentation

◆ $lastError

array null DatabaseTestHelper::$lastError = null

protected

Definition at line 32 of file DatabaseTestHelper.php.

◆ $lastSqls

DatabaseTestHelper::$lastSqls = []

protected

Array of lastSqls passed to query(), This is an array since some methods in Database can do more than one query.

Cleared when calling getLastSqls().

Definition at line 24 of file DatabaseTestHelper.php.

Referenced by getLastSqls().

◆ $nextError

array null DatabaseTestHelper::$nextError = null

protected

Definition at line 30 of file DatabaseTestHelper.php.

Referenced by doQuery().

◆ $nextResult

array DatabaseTestHelper::$nextResult = []

protected

List of row arrays.

Definition at line 27 of file DatabaseTestHelper.php.

Referenced by doQuery().

◆ $tablesExists

DatabaseTestHelper::$tablesExists

protected

Array of tables to be considered as existing by tableExist() Use setExistingTables() to alter.

Definition at line 38 of file DatabaseTestHelper.php.

Referenced by setExistingTables().

◆ $testName

DatabaseTestHelper::$testName = []

protected

CLASS of the test suite, used to determine, if the function name is passed every time to query()

Definition at line 17 of file DatabaseTestHelper.php.

Referenced by __construct().

◆ $unionSupportsOrderAndLimit

DatabaseTestHelper::$unionSupportsOrderAndLimit = true

protected

Value to return from unionSupportsOrderAndLimit()

Definition at line 43 of file DatabaseTestHelper.php.

Referenced by unionSupportsOrderAndLimit().

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

tests/phpunit/includes/db/DatabaseTestHelper.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addIdentifierQuotes()

◆ addSql()

◆ checkFunctionName()

◆ closeConnection()

◆ dataSeek()

◆ doQuery()

◆ fetchAffectedRowCount()

◆ fetchObject()

◆ fetchRow()

◆ fieldInfo()

◆ fieldName()

◆ forceNextQueryError()

◆ forceNextResult()

◆ getLastSqls()

◆ getServerInfo()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getType()

◆ indexInfo()

◆ insertId()

◆ isOpen()

◆ lastErrno()

◆ lastError()

◆ nativeReplace()

◆ numFields()

◆ numRows()

◆ open()

◆ ping()

◆ query()

◆ setExistingTables()

◆ setUnionSupportsOrderAndLimit()

◆ strencode()

◆ tableExists()

◆ unionSupportsOrderAndLimit()

◆ wasKnownStatementRollbackError()

Member Data Documentation

◆ $lastError

◆ $lastSqls

◆ $nextError

◆ $nextResult

◆ $tablesExists

◆ $testName

◆ $unionSupportsOrderAndLimit