Database abstraction object for mySQL Inherit all methods and properties of Database::Database() More...

Inheritance diagram for DatabaseMysql:

Collaboration diagram for DatabaseMysql:

Public Member Functions
	addIdentifierQuotes ($s)
	MySQL uses `backticks` for identifier quoting instead of the sql standard "double quotes".
	affectedRows ()
	close ()
	dataSeek ($res, $row)
	deleteJoin ($delTable, $joinTable, $delVar, $joinVar, $conds, $fname= 'DatabaseBase::deleteJoin')
	DELETE where the condition is a join.
	dropTable ($tableName, $fName= 'DatabaseMysql::dropTable')
	duplicateTableStructure ($oldName, $newName, $temporary=false, $fname= 'DatabaseMysql::duplicateTableStructure')
	estimateRowCount ($table, $vars='*', $conds='', $fname= 'DatabaseMysql::estimateRowCount', $options=array())
	Estimate rows in dataset Returns estimated count, based on EXPLAIN output Takes same arguments as Database::select()
	fetchObject ($res)
	fetchRow ($res)
	fieldInfo ($table, $field)
	fieldName ($res, $n)
	freeResult ($res)
	getLag ()
	Returns slave lag.
	getLagFromProcesslist ()
	getLagFromSlaveStatus ()
	getMasterPos ()
	Get the position of the master from SHOW MASTER STATUS.
	getMysqlStatus ($which="%")
	Get status information from SHOW STATUS in an associative array.
	getSearchEngine ()
	Get search engine class.
	getServerUptime ()
	Determines how long the server has been up.
	getServerVersion ()
	getSlavePos ()
	Get the position of the master from SHOW SLAVE STATUS.
	getType ()
	indexInfo ($table, $index, $fname= 'DatabaseMysql::indexInfo')
	Get information about an index into an object Returns false if the index does not exist.
	insertId ()
	isQuotedIdentifier ($name)
	lastErrno ()
	lastError ()
	listTables ($prefix=null, $fname= 'DatabaseMysql::listTables')
	List all tables on the database.
	lock ($lockName, $method, $timeout=5)
	lockTables ($read, $write, $method, $lowPriority=true)
	lowPriorityOption ()
	masterPosWait (DBMasterPos $pos, $timeout)
	Wait for the slave to catch up to a given master position.
	numFields ($res)
	numRows ($res)
	open ($server, $user, $password, $dbName)
	ping ()
	replace ($table, $uniqueIndexes, $rows, $fname= 'DatabaseMysql::replace')
	selectDB ($db)
	setBigSelects ($value=true)
	setSessionOptions (array $options)
	standardSelectDistinct ()
	streamStatementEnd (&$sql, &$newLine)
	Called by sourceStream() to check if we've reached a statement end.
	strencode ($s)
	unlock ($lockName, $method)
	FROM MYSQL DOCS: http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock.
	unlockTables ($method)
	useIndexClause ($index)
	wasDeadlock ()
	Determines if the last failure was due to a deadlock.
	wasErrorReissuable ()
	Determines if the last query error was something that should be dealt with by pinging the connection and reissuing the query.
	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.
Static Public Member Functions
static	getSoftwareLink ()
Protected Member Functions
	doQuery ($sql)
	getDefaultSchemaVars ()

Detailed Description

Database abstraction object for mySQL Inherit all methods and properties of Database::Database()

See also:: Database

Definition at line 16 of file DatabaseMysql.php.

Member Function Documentation

DatabaseMysql::addIdentifierQuotes ( $ s )

MySQL uses `backticks` for identifier quoting instead of the sql standard "double quotes".

Parameters:

$s string

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 445 of file DatabaseMysql.php.

References strencode().

Referenced by duplicateTableStructure().

Here is the call graph for this function:

Here is the caller graph for this function:

DatabaseMysql::affectedRows ( )

Returns:: int

Implements DatabaseType.

Definition at line 316 of file DatabaseMysql.php.

DatabaseMysql::close ( )

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 157 of file DatabaseMysql.php.

References DatabaseBase\commit(), and DatabaseBase\trxLevel().

Referenced by open().

Here is the call graph for this function:

Here is the caller graph for this function:

DatabaseMysql::dataSeek	(	$	res,
		$	row
	)

Parameters:

$res	ResultWrapper
$row

Returns:: bool

Implements DatabaseType.

Definition at line 274 of file DatabaseMysql.php.

References $res.

DatabaseMysql::deleteJoin	(	$	delTable,
		$	joinTable,
		$	delVar,
		$	joinVar,
		$	conds,
		$	fname = `'DatabaseBase::deleteJoin'`
	)

DELETE where the condition is a join.

MySql uses multi-table deletes.

Parameters:

$delTable	string
$joinTable	string
$delVar	string
$joinVar	string
$conds	array\|string
$fname	bool

Returns:: bool|ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 782 of file DatabaseMysql.php.

References $fname, DatabaseBase\makeList(), DatabaseBase\query(), and DatabaseBase\tableName().

Here is the call graph for this function:

DatabaseMysql::doQuery ( $ sql ) [protected]

Parameters:

$sql string

Returns:: resource

Reimplemented from DatabaseBase.

Definition at line 29 of file DatabaseMysql.php.

References DatabaseBase\bufferResults().

Referenced by masterPosWait().

Here is the call graph for this function:

Here is the caller graph for this function:

DatabaseMysql::dropTable	(	$	tableName,
		$	fName = `'DatabaseMysql::dropTable'`
	)

Parameters:

$tableName
$fName	string

Returns:: bool|ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 889 of file DatabaseMysql.php.

References DatabaseBase\query(), DatabaseBase\tableExists(), and DatabaseBase\tableName().

Here is the call graph for this function:

DatabaseMysql::duplicateTableStructure	(	$	oldName,
		$	newName,
		$	temporary = `false`,
		$	fname = `'DatabaseMysql::duplicateTableStructure'`
	)

Parameters:

$oldName
$newName
$temporary	bool
$fname	string

Reimplemented from DatabaseBase.

Definition at line 852 of file DatabaseMysql.php.

References $fname, addIdentifierQuotes(), and DatabaseBase\query().

Here is the call graph for this function:

DatabaseMysql::estimateRowCount	(	$	table,
		$	vars = `'*'`,
		$	conds = `''`,
		$	fname = `'DatabaseMysql::estimateRowCount'`,
		$	options = `array()`
	)

Estimate rows in dataset Returns estimated count, based on EXPLAIN output Takes same arguments as Database::select()

Parameters:

$table	string\|array
$vars	string\|array
$conds	string\|array
$fname	string
$options	string\|array

Returns:: int

Reimplemented from DatabaseBase.

Definition at line 343 of file DatabaseMysql.php.

References $fname, $options, $res, $rows, numRows(), and DatabaseBase\select().

Here is the call graph for this function:

DatabaseMysql::fetchObject ( $ res )

Parameters:

$res	ResultWrapper

Returns:: object|stdClass

Exceptions:

DBUnexpectedError

Implements DatabaseType.

Definition at line 190 of file DatabaseMysql.php.

References $res, lastErrno(), lastError(), wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by getMasterPos(), getSlavePos(), lock(), and unlock().

Here is the call graph for this function:

Here is the caller graph for this function:

DatabaseMysql::fetchRow ( $ res )

Parameters:

$res	ResultWrapper

Returns:: array

Exceptions:

DBUnexpectedError

Implements DatabaseType.

Definition at line 208 of file DatabaseMysql.php.

References $res, lastErrno(), lastError(), wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by masterPosWait().

Here is the call graph for this function:

Here is the caller graph for this function:

DatabaseMysql::fieldInfo	(	$	table,
		$	field
	)

Parameters:

$table	string
$field	string

Returns:: bool|MySQLField

Implements DatabaseType.

Definition at line 365 of file DatabaseMysql.php.

References $n, $res, DatabaseBase\query(), and DatabaseBase\tableName().

Here is the call graph for this function:

DatabaseMysql::fieldName	(	$	res,
		$	n
	)

Parameters:

$res	ResultWrapper
$n	string

Returns:: string

Implements DatabaseType.

Definition at line 255 of file DatabaseMysql.php.

References $n, and $res.

DatabaseMysql::freeResult ( $ res )

Parameters:

$res	ResultWrapper

Exceptions:

DBUnexpectedError

Reimplemented from DatabaseBase.

Definition at line 173 of file DatabaseMysql.php.

References $ok, $res, wfRestoreWarnings(), and wfSuppressWarnings().

Here is the call graph for this function:

DatabaseMysql::getDefaultSchemaVars ( ) [protected]

Returns:: array

Reimplemented from DatabaseBase.

Definition at line 899 of file DatabaseMysql.php.

DatabaseMysql::getLag ( )

Returns slave lag.

This will do a SHOW SLAVE STATUS

Returns:: int

Reimplemented from DatabaseBase.

Definition at line 480 of file DatabaseMysql.php.

References getLagFromSlaveStatus(), and wfDebug().

Here is the call graph for this function:

DatabaseMysql::getLagFromProcesslist ( )

Deprecated:: in 1.19, use getLagFromSlaveStatus

Returns:: bool|int

Definition at line 513 of file DatabaseMysql.php.

References $res, DatabaseBase\query(), and wfDeprecated().

Here is the call graph for this function:

DatabaseMysql::getLagFromSlaveStatus ( )

Returns:: bool|int

Definition at line 492 of file DatabaseMysql.php.

References $res, and DatabaseBase\query().

Referenced by getLag().

Here is the call graph for this function:

Here is the caller graph for this function:

DatabaseMysql::getMasterPos ( )

Get the position of the master from SHOW MASTER STATUS.

Returns:: MySQLMasterPos|false

Reimplemented from DatabaseBase.

Definition at line 611 of file DatabaseMysql.php.

References $res, fetchObject(), and DatabaseBase\query().

Here is the call graph for this function:

DatabaseMysql::getMysqlStatus ( $ which = "%" )

Get status information from SHOW STATUS in an associative array.

Parameters:

$which string

Returns:: array

Definition at line 912 of file DatabaseMysql.php.

References $res, and DatabaseBase\query().

Referenced by getServerUptime().

Here is the call graph for this function:

Here is the caller graph for this function:

DatabaseMysql::getSearchEngine ( )

Get search engine class.

All subclasses of this need to implement this if they wish to use searching.

Returns:: String

Reimplemented from DatabaseBase.

Definition at line 749 of file DatabaseMysql.php.

DatabaseMysql::getServerUptime ( )

Determines how long the server has been up.

Returns:: int

Reimplemented from DatabaseBase.

Definition at line 803 of file DatabaseMysql.php.

References getMysqlStatus().

Here is the call graph for this function:

DatabaseMysql::getServerVersion ( )

Returns:: string

Implements DatabaseType.

Definition at line 629 of file DatabaseMysql.php.

DatabaseMysql::getSlavePos ( )

Get the position of the master from SHOW SLAVE STATUS.

Returns:: MySQLMasterPos|false

Reimplemented from DatabaseBase.

Definition at line 590 of file DatabaseMysql.php.

References $res, fetchObject(), and DatabaseBase\query().

Here is the call graph for this function:

static DatabaseMysql::getSoftwareLink ( ) [static]

Returns:: string

Implements DatabaseType.

Definition at line 651 of file DatabaseMysql.php.

DatabaseMysql::getType ( )

Returns:: string

Implements DatabaseType.

Definition at line 21 of file DatabaseMysql.php.

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

Get information about an index into an object Returns false if the index does not exist.

Parameters:

$table	string
$index	string
$fname	string

Returns:: false|array

Implements DatabaseType.

Definition at line 390 of file DatabaseMysql.php.

References $fname, $res, $result, DatabaseBase\indexName(), DatabaseBase\query(), and DatabaseBase\tableName().

Here is the call graph for this function:

DatabaseMysql::insertId ( )

Returns:: int

Implements DatabaseType.

Definition at line 265 of file DatabaseMysql.php.

DatabaseMysql::isQuotedIdentifier ( $ name )

Parameters:

$name string

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 453 of file DatabaseMysql.php.

DatabaseMysql::lastErrno ( )

Returns:: int

Implements DatabaseType.

Definition at line 284 of file DatabaseMysql.php.

Referenced by fetchObject(), fetchRow(), numRows(), wasDeadlock(), wasErrorReissuable(), wasLockTimeout(), and wasReadOnlyError().

Here is the caller graph for this function:

DatabaseMysql::lastError ( )

Returns:: string

Implements DatabaseType.

Definition at line 295 of file DatabaseMysql.php.

References wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by fetchObject(), fetchRow(), numRows(), open(), and wasReadOnlyError().

Here is the call graph for this function:

Here is the caller graph for this function:

DatabaseMysql::listTables	(	$	prefix = `null`,
		$	fname = `'DatabaseMysql::listTables'`
	)

List all tables on the database.

Parameters:

$prefix	Only show tables with this prefix, e.g. mw_
$fname	String: calling function name

Returns:: array

Reimplemented from DatabaseBase.

Definition at line 867 of file DatabaseMysql.php.

References $fname, $result, and DatabaseBase\query().

Here is the call graph for this function:

DatabaseMysql::lock	(	$	lockName,
		$	method,
		$	timeout = `5`
	)

Parameters:

$lockName	string
$method	string
$timeout	int

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 688 of file DatabaseMysql.php.

References $result, DatabaseBase\addQuotes(), fetchObject(), DatabaseBase\query(), and wfDebug().

Here is the call graph for this function:

DatabaseMysql::lockTables	(	$	read,
		$	write,
		$	method,
		$	lowPriority = `true`
	)

Parameters:

$read	array
$write	array
$method	string
$lowPriority	bool

Reimplemented from DatabaseBase.

Definition at line 720 of file DatabaseMysql.php.

References DatabaseBase\query(), and DatabaseBase\tableName().

Here is the call graph for this function:

DatabaseMysql::lowPriorityOption ( )

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 644 of file DatabaseMysql.php.

DatabaseMysql::masterPosWait	(	DBMasterPos $	pos,
		$	timeout
	)

Wait for the slave to catch up to a given master position.

Parameters:

$pos	DBMasterPos object
$timeout	Integer: the maximum number of seconds to wait for synchronisation

Returns:: bool|string

Reimplemented from DatabaseBase.

Definition at line 555 of file DatabaseMysql.php.

References $fname, $res, DatabaseBase\addQuotes(), DatabaseBase\commit(), doQuery(), fetchRow(), wfProfileIn(), and wfProfileOut().

Here is the call graph for this function:

DatabaseMysql::numFields ( $ res )

Parameters:

$res	ResultWrapper

Returns:: int

Implements DatabaseType.

Definition at line 243 of file DatabaseMysql.php.

References $res.

DatabaseMysql::numRows ( $ res )

Exceptions:

DBUnexpectedError

Parameters:

$res	ResultWrapper

Returns:: int

Implements DatabaseType.

Definition at line 226 of file DatabaseMysql.php.

References $n, $res, lastErrno(), lastError(), wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by estimateRowCount().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Parameters:

$server	string
$user	string
$password	string
$dbName	string

Returns:: bool

Exceptions:

DBConnectionError

Implements DatabaseType.

Definition at line 46 of file DatabaseMysql.php.

References $success, $user, $wgAllDBsAreLocalhost, $wgDBmysql5, $wgSQLMode, DatabaseBase\addQuotes(), close(), DatabaseBase\installErrorHandler(), lastError(), DatabaseBase\query(), DatabaseBase\reportConnectionError(), DatabaseBase\restoreErrorHandler(), wfDebug(), wfDl(), wfHostname(), wfLogDBError(), wfProfileIn(), wfProfileOut(), wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by ping().

Here is the call graph for this function:

Here is the caller graph for this function:

DatabaseMysql::ping ( )

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 460 of file DatabaseMysql.php.

References open().

Referenced by strencode().

Here is the call graph for this function:

Here is the caller graph for this function:

DatabaseMysql::replace	(	$	table,
		$	uniqueIndexes,
		$	rows,
		$	fname = `'DatabaseMysql::replace'`
	)

Parameters:

$table	string
$uniqueIndexes
$rows	array
$fname	string

Returns:: ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 327 of file DatabaseMysql.php.

References $fname, $rows, and DatabaseBase\nativeReplace().

Here is the call graph for this function:

DatabaseMysql::selectDB ( $ db )

Parameters:

$db

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 418 of file DatabaseMysql.php.

DatabaseMysql::setBigSelects ( $ value = true )

Parameters:

bool $value

Returns:: mixed

Reimplemented from DatabaseBase.

Definition at line 757 of file DatabaseMysql.php.

References DatabaseBase\query(), and DatabaseBase\selectField().

Here is the call graph for this function:

DatabaseMysql::setSessionOptions ( array $ options )

Parameters:

$options array

Reimplemented from DatabaseBase.

Definition at line 665 of file DatabaseMysql.php.

References DatabaseBase\query().

Here is the call graph for this function:

DatabaseMysql::standardSelectDistinct ( )

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 658 of file DatabaseMysql.php.

DatabaseMysql::streamStatementEnd	(	&$	sql,
		&$	newLine
	)

Called by sourceStream() to check if we've reached a statement end.

Parameters:

$sql	String SQL assembled so far
$newLine	String New line about to be added to $sql

Returns:: Bool Whether $newLine contains end of the statement

Reimplemented from DatabaseBase.

Definition at line 673 of file DatabaseMysql.php.

DatabaseMysql::strencode ( $ s )

Parameters:

$s string

Returns:: string

Implements DatabaseType.

Definition at line 428 of file DatabaseMysql.php.

References ping().

Referenced by addIdentifierQuotes().

Here is the call graph for this function:

Here is the caller graph for this function:

DatabaseMysql::unlock	(	$	lockName,
		$	method
	)

FROM MYSQL DOCS: http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock.

Parameters:

$lockName	string
$method	string

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 707 of file DatabaseMysql.php.

References $result, DatabaseBase\addQuotes(), fetchObject(), and DatabaseBase\query().

Here is the call graph for this function:

DatabaseMysql::unlockTables ( $ method )

Parameters:

$method string

Reimplemented from DatabaseBase.

Definition at line 739 of file DatabaseMysql.php.

References DatabaseBase\query().

Here is the call graph for this function:

DatabaseMysql::useIndexClause ( $ index )

Parameters:

$index

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 637 of file DatabaseMysql.php.

References DatabaseBase\indexName().

Here is the call graph for this function:

DatabaseMysql::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 813 of file DatabaseMysql.php.

References lastErrno().

Here is the call graph for this function:

DatabaseMysql::wasErrorReissuable ( )

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

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 832 of file DatabaseMysql.php.

References lastErrno().

Here is the call graph for this function:

DatabaseMysql::wasLockTimeout ( )

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

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 822 of file DatabaseMysql.php.

References lastErrno().

Here is the call graph for this function:

DatabaseMysql::wasReadOnlyError ( )

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

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 841 of file DatabaseMysql.php.

References false, lastErrno(), and lastError().

Here is the call graph for this function:

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

includes/db/DatabaseMysql.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation