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

Inheritance diagram for DatabaseTestHelper:

[legend]

Collaboration diagram for DatabaseTestHelper:

[legend]

Public Member Functions
	__construct ( $testName)
	Constructor. More...

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

	affectedRows ()
	Get the number of rows affected by the last write query. More...

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

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

	fieldInfo ( $table, $field)
	mysql_fetch_field() wrapper Returns false if the field doesn't exist More...

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

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

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

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

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

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

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

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

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

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

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

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

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

	open ( $server, $user, $password, $dbName)
	Open a connection to the database. More...

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

	setExistingTables ( $tablesExists)

	strencode ( $s)
	Wrapper for addslashes() More...

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

Public Member Functions inherited from DatabaseBase
	__destruct ()
	Run a few simple sanity checks. More...

	__sleep ()
	Called by serialize. More...

	__toString ()

	addQuotes ( $s)
	Adds quotes and backslashes. 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...

	begin ( $fname=__METHOD__)
	Begin a transaction. More...

	bitAnd ( $fieldLeft, $fieldRight)

	bitNot ( $field)

	bitOr ( $fieldLeft, $fieldRight)

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

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

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

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

	cascadingDeletes ()
	Returns true if this database supports (and uses) cascading deletes. More...

	cleanupTriggers ()
	Returns true if this database supports (and uses) triggers (e.g. More...

	clearFlag ( $flag)
	Clear a flag for this connection. More...

	clearViewsCache ()
	Reset the views process cache set by listViews() More...

	close ()
	Closes a database connection. More...

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

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

	connectionErrorHandler ( $errno, $errstr)

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

	deadlockLoop ()
	Perform a deadlock-prone transaction. More...

	debug ( $debug=null)
	Boolean, controls output of large amounts of debug information. 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...

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

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

	duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
	Creates a new table with structure copied from existing table Note that unlike most database abstraction functions, this function does not automatically append database prefix, because it works at a lower abstraction level. 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...

	errorCount ( $count=null)
	Get/set the number of errors logged. More...

	estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=array())
	Estimate rows in dataset. More...

	execute ( $prepared, $args=null)
	Execute a prepared query with the various arguments. More...

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

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

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

	fillPrepared ( $preparedQuery, $args)
	For faking prepared SQL statements on DBs that don't support it directly. More...

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

	functionalIndexes ()
	Returns true if this database can use functional indexes. More...

	getDBname ()
	Get the current DB name. More...

	getDelimiter ()

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

	getInfinity ()
	Find out when 'infinity' is. More...

	getLag ()
	Get slave lag. 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)
	General read-only accessor. More...

	getSchemaPath ()
	Return a path to the DBMS-specific schema file, otherwise default to tables.sql. More...

	getSearchEngine ()
	Get search engine class. More...

	getServer ()
	Get the server hostname or IP address. More...

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

	getSlavePos ()
	Get the replication position of this slave. More...

	getWikiID ()

	ignoreErrors ( $ignoreErrors=null)
	Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors. More...

	implicitGroupby ()
	Returns true if this database does an implicit sort when doing GROUP BY. 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 Usually throws a DBQueryError on failure If errors are explicitly ignored, returns NULL on failure. More...

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

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

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

	isOpen ()
	Is a connection to the database open? More...

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

	isView ( $name)
	Differentiates between a TABLE and a VIEW. More...

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

	lastQuery ()
	Return the last query that went through DatabaseBase::query() More...

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

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

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

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

	lockIsFree ( $lockName, $method)
	Check to see if a named lock is available. More...

	lockTables ( $read, $write, $method, $lowPriority=true)
	Lock specific tables. More...

	lowPriorityOption ()
	A string to insert into queries to show that they're low-priority, like MySQL's LOW_PRIORITY. More...

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

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

	makeOrderBy ( $options)
	Returns an optional ORDER BY. More...

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

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

	nextSequenceValue ( $seqName)
	Returns an appropriately quoted sequence value for inserting a new row. More...

	onTransactionIdle ( $callback)
	Run an anonymous function as soon as there is no transaction pending. More...

	onTransactionPreCommitOrIdle ( $callback)
	Run an anonymous function before the current transaction commits or now if there is none. More...

	patchPath ( $patch)
	Get the full path of a patch file. More...

	ping ()
	Ping the server and try to reconnect if it there is no connection. More...

	realTimestamps ()
	Returns true if this database uses timestamps rather than integers. More...

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

	reportConnectionError ( $error='Unknown error')

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

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

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

	searchableIPs ()
	Returns true if this database can do a native search on IP columns e.g. More...

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

	selectDB ( $db)
	Change the current database. More...

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

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

	selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=array(), $join_conds=array())
	The equivalent of DatabaseBase::select() except that the constructed SQL is returned, instead of being immediately executed. More...

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

	setFakeMaster ( $enabled=true)
	Make this connection a fake master. More...

	setFakeSlaveLag ( $lag)
	Set lag time in seconds for a fake slave. More...

	setFileHandle ( $fh)
	Set the filehandle to copy write statements to. More...

	setFlag ( $flag)
	Set a flag for this connection. More...

	setLBInfo ( $name, $value=null)
	Set the LB info array, or a member of it. 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...

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

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

	startAtomic ( $fname=__METHOD__)
	Begin an atomic section of statements. More...

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

	strictIPs ()
	Returns true if this database is strict about what can be put into an IP field. More...

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

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

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

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

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

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

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

	textFieldSize ( $table, $field)
	Returns the size of a text field, or -1 for "unlimited". More...

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

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

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

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

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

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

	unlockTables ( $method)
	Unlock specific tables. More...

	update ( $table, $values, $conds, $fname=__METHOD__, $options=array())
	UPDATE wrapper. More...

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

	useIndexClause ( $index)
	USE INDEX clause. More...

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

	wasErrorReissuable ()
	Determines if the last query error was something that should be dealt with by pinging the connection and reissuing the query. More...

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

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

	writesOrCallbacksPending ()
	Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. More...

Protected Member Functions
	addSql ( $sql)

	checkFunctionName ( $fname)

	closeConnection ()
	Closes underlying database connection. More...

	doQuery ( $sql)
	The DBMS-dependent part of query() More...

Protected Member Functions inherited from DatabaseBase
	doBegin ( $fname)
	Issues the BEGIN command to the database server. More...

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

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

	escapeLikeInternal ( $s)

	fillPreparedArg ( $matches)
	preg_callback func for fillPrepared() The arguments should be in $this->preparedArgs and must not be touched while we're doing this. More...

	freePrepared ( $prepared)
	Free a prepared query, generated by prepare(). More...

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

	getSchemaVars ()
	Get schema variables. More...

	indexName ( $index)
	Get the name of an index in a given table. More...

	indexNameCallback ( $matches)
	Index name callback. More...

	installErrorHandler ()

	makeInsertOptions ( $options)
	Helper for DatabaseBase::insert(). More...

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

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

	prepare ( $sql, $func='DatabaseBase::prepare')
	Intended to be compatible with the PEAR::DB wrapper functions. More...

	replaceSchemaVars ( $ins)
	Database independent variable replacement. More...

	replaceVars ( $ins)
	Replace variables in sourced SQL. More...

	restoreErrorHandler ()

	runOnTransactionIdleCallbacks ()
	Actually any "on transaction idle" callbacks. More...

	runOnTransactionPreCommitCallbacks ()
	Actually any "on transaction pre-commit" callbacks. More...

	tableNameCallback ( $matches)
	Table name callback. More...

	tableNamesWithUseIndexOrJOIN ( $tables, $use_index=array(), $join_conds=array())
	Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX clause. More...

Protected Attributes
	$lastSqls = array()
	Array of lastSqls passed to query(), This is an array since some methods in DatabaseBase can do more than one query. More...

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

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

Protected Attributes inherited from DatabaseBase
string[]	$allViews = null

	$delimiter = ';'

resource	$fileHandle = null

	$htmlErrors

resource	$mConn = null
	Database connection *. More...

	$mDefaultBigSelects = null

	$mDoneWrites = false

	$mErrorCount = 0

	$mFlags

	$mForeign

	$mLastQuery = ''

	$mLBInfo = array()

	$mOpened = false

	$mPHPError = false

	$mSchema

	$mSchemaVars = false

	$mServer

	$mTablePrefix

callable[]	$mTrxIdleCallbacks = array()

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

callable[]	$mTrxPreCommitCallbacks = array()

	$preparedArgs

Additional Inherited Members
Static Public Member Functions inherited from DatabaseBase
static	factory ( $dbType, $p=array())
	Given a DB type, construct the name of the appropriate child class of DatabaseBase. More...

static	generalizeSQL ( $sql)
	Removes most variables from an SQL query and replaces them with X or N for numbers. More...

Public Attributes inherited from DatabaseBase
	$mDBname

	$mPassword

	$mUser

const	DEADLOCK_DELAY_MAX = 1500000
	Maximum time to wait before retry. More...

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

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

Detailed Description

Helper for testing the methods from the DatabaseBase class.

Since: 1.22

Definition at line 7 of file DatabaseTestHelper.php.

Constructor & Destructor Documentation

◆ __construct()

DatabaseTestHelper::__construct ( $params )

Constructor.

FIXME: It is possible to construct a Database object with no associated connection object, by specifying no parameters to __construct(). This feature is deprecated and should be removed.

DatabaseBase subclasses should not be constructed directly in external code. DatabaseBase::factory() should be used instead.

Parameters

array $params Parameters passed from DatabaseBase::factory()

Reimplemented from DatabaseBase.

Definition at line 28 of file DatabaseTestHelper.php.

References $testName.

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

Parameters

string $s

Returns: string

Reimplemented from DatabaseBase.

Definition at line 68 of file DatabaseTestHelper.php.

References $s.

◆ addSql()

DatabaseTestHelper::addSql ( $sql )

protected

Definition at line 47 of file DatabaseTestHelper.php.

Referenced by query().

◆ affectedRows()

DatabaseTestHelper::affectedRows ( )

Get the number of rows affected by the last write query.

See also: http://www.php.net/mysql_affected_rows

Returns: int

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

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

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

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

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

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

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?

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

DatabaseTestHelper::dataSeek	(	$res,
		$row
	)

mixed	$res	A SQL result
int	$row

DatabaseTestHelper::fieldInfo	(	$table,
		$field
	)

DatabaseTestHelper::fieldName	(	$res,
		$n
	)

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addIdentifierQuotes()

◆ addSql()

◆ affectedRows()

◆ checkFunctionName()

◆ closeConnection()

◆ dataSeek()

◆ doQuery()

◆ fetchObject()

◆ fetchRow()

◆ fieldInfo()

◆ fieldName()

◆ getLastSqls()

◆ getServerInfo()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getType()

◆ indexInfo()

◆ insertId()

◆ lastErrno()

◆ lastError()

◆ nativeReplace()

◆ numFields()

◆ numRows()

◆ open()

◆ query()

◆ setExistingTables()

◆ strencode()

◆ tableExists()

Member Data Documentation

◆ $lastSqls

◆ $tablesExists

◆ $testName