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 ()
	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)
	lockIsFree ($lockName, $method)
	Check to see if a named lock is available.
	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)
	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
	closeConnection ()
	doQuery ($sql)
	getDefaultSchemaVars ()

Detailed Description

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

See also:: Database

Definition at line 31 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 468 of file DatabaseMysql.php.

References $s, and strencode().

Referenced by duplicateTableStructure().

DatabaseMysql::affectedRows ( )

Returns:: int

Implements DatabaseType.

Definition at line 339 of file DatabaseMysql.php.

DatabaseMysql::closeConnection ( ) [protected]

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 174 of file DatabaseMysql.php.

DatabaseMysql::dataSeek	(	$	res,
		$	row
	)

Parameters:

$res	ResultWrapper
$row

Returns:: bool

Implements DatabaseType.

Definition at line 297 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
bool \| string	$fname	bool

Exceptions:

DBUnexpectedError

Returns:: bool|ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 817 of file DatabaseMysql.php.

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

DatabaseMysql::doQuery ( $ sql ) [protected]

Parameters:

$sql string

Returns:: resource

Reimplemented from DatabaseBase.

Definition at line 44 of file DatabaseMysql.php.

References $ret, and DatabaseBase\bufferResults().

Referenced by masterPosWait().

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

Parameters:

$tableName
$fName	string

Returns:: bool|ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 924 of file DatabaseMysql.php.

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

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

Parameters:

$oldName
$newName
$temporary	bool
$fname	string

Reimplemented from DatabaseBase.

Definition at line 887 of file DatabaseMysql.php.

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

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 366 of file DatabaseMysql.php.

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

DatabaseMysql::fetchObject ( $ res )

Parameters:

$res	ResultWrapper

Returns:: object|bool

Exceptions:

DBUnexpectedError

Implements DatabaseType.

Definition at line 199 of file DatabaseMysql.php.

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

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

DatabaseMysql::fetchRow ( $ res )

Parameters:

$res	ResultWrapper

Returns:: array|bool

Exceptions:

DBUnexpectedError

Implements DatabaseType.

Definition at line 223 of file DatabaseMysql.php.

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

Referenced by masterPosWait().

DatabaseMysql::fieldInfo	(	$	table,
		$	field
	)

Parameters:

$table	string
$field	string

Returns:: bool|MySQLField

Implements DatabaseType.

Definition at line 388 of file DatabaseMysql.php.

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

DatabaseMysql::fieldName	(	$	res,
		$	n
	)

Parameters:

$res	ResultWrapper
$n	string

Returns:: string

Implements DatabaseType.

Definition at line 278 of file DatabaseMysql.php.

References $n, and $res.

DatabaseMysql::freeResult ( $ res )

Parameters:

$res	ResultWrapper

Exceptions:

DBUnexpectedError

Reimplemented from DatabaseBase.

Definition at line 182 of file DatabaseMysql.php.

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

DatabaseMysql::getDefaultSchemaVars ( ) [protected]

Returns:: array

Reimplemented from DatabaseBase.

Definition at line 934 of file DatabaseMysql.php.

References $vars.

DatabaseMysql::getLag ( )

Returns slave lag.

This will do a SHOW SLAVE STATUS

Returns:: int

Reimplemented from DatabaseBase.

Definition at line 503 of file DatabaseMysql.php.

References getLagFromSlaveStatus(), and wfDebug().

DatabaseMysql::getLagFromProcesslist ( )

Deprecated:: in 1.19, use getLagFromSlaveStatus

Returns:: bool|int

Definition at line 536 of file DatabaseMysql.php.

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

DatabaseMysql::getLagFromSlaveStatus ( )

Returns:: bool|int

Definition at line 515 of file DatabaseMysql.php.

References $res, and DatabaseBase\query().

Referenced by getLag().

DatabaseMysql::getMasterPos ( )

Get the position of the master from SHOW MASTER STATUS.

Returns:: MySQLMasterPos|bool

Reimplemented from DatabaseBase.

Definition at line 633 of file DatabaseMysql.php.

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

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

Get status information from SHOW STATUS in an associative array.

Parameters:

$which string

Returns:: array

Definition at line 947 of file DatabaseMysql.php.

References $res, array(), as, and DatabaseBase\query().

Referenced by getServerUptime().

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 783 of file DatabaseMysql.php.

DatabaseMysql::getServerUptime ( )

Determines how long the server has been up.

Returns:: int

Reimplemented from DatabaseBase.

Definition at line 838 of file DatabaseMysql.php.

References $vars, and getMysqlStatus().

DatabaseMysql::getServerVersion ( )

Returns:: string

Implements DatabaseType.

Definition at line 651 of file DatabaseMysql.php.

DatabaseMysql::getSlavePos ( )

Get the position of the master from SHOW SLAVE STATUS.

Returns:: MySQLMasterPos|bool

Reimplemented from DatabaseBase.

Definition at line 612 of file DatabaseMysql.php.

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

static DatabaseMysql::getSoftwareLink ( ) [static]

Returns:: string

Implements DatabaseType.

Definition at line 673 of file DatabaseMysql.php.

DatabaseMysql::getType ( )

Returns:: string

Implements DatabaseType.

Definition at line 36 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:: bool|array|null False or null on failure

Implements DatabaseType.

Definition at line 413 of file DatabaseMysql.php.

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

DatabaseMysql::insertId ( )

Returns:: int

Implements DatabaseType.

Definition at line 288 of file DatabaseMysql.php.

DatabaseMysql::isQuotedIdentifier ( $ name )

Parameters:

$name string

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 476 of file DatabaseMysql.php.

References $name.

DatabaseMysql::lastErrno ( )

Returns:: int

Implements DatabaseType.

Definition at line 307 of file DatabaseMysql.php.

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

DatabaseMysql::lastError ( )

Returns:: string

Implements DatabaseType.

Definition at line 318 of file DatabaseMysql.php.

References $error, wfRestoreWarnings(), and wfSuppressWarnings().

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

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

List all tables on the database.

Parameters:

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

Returns:: array

Reimplemented from DatabaseBase.

Definition at line 902 of file DatabaseMysql.php.

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

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

Parameters:

$lockName	string
$method	string
$timeout	int

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 718 of file DatabaseMysql.php.

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

DatabaseMysql::lockIsFree	(	$	lockName,
		$	method
	)

Check to see if a named lock is available.

This is non-blocking.

Parameters:

string	$lockName	name of lock to poll
string	$method	name of method calling us

Returns:: Boolean

Since:: 1.20

Reimplemented from DatabaseBase.

Definition at line 705 of file DatabaseMysql.php.

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

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

Parameters:

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

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 751 of file DatabaseMysql.php.

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

DatabaseMysql::lowPriorityOption ( )

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 666 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 578 of file DatabaseMysql.php.

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

DatabaseMysql::numFields ( $ res )

Parameters:

$res	ResultWrapper

Returns:: int

Implements DatabaseType.

Definition at line 266 of file DatabaseMysql.php.

References $res.

DatabaseMysql::numRows ( $ res )

Exceptions:

DBUnexpectedError

Parameters:

$res	ResultWrapper

Returns:: int

Implements DatabaseType.

Definition at line 247 of file DatabaseMysql.php.

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

Referenced by estimateRowCount().

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

Parameters:

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

Returns:: bool

Exceptions:

DBConnectionError

Implements DatabaseType.

Definition at line 61 of file DatabaseMysql.php.

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

Referenced by ping().

DatabaseMysql::ping ( )

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 483 of file DatabaseMysql.php.

References open().

Referenced by strencode().

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

Parameters:

$table	string
$uniqueIndexes
$rows	array
$fname	string

Returns:: ResultWrapper

Reimplemented from DatabaseBase.

Definition at line 350 of file DatabaseMysql.php.

References $fname, and DatabaseBase\nativeReplace().

DatabaseMysql::selectDB ( $ db )

Parameters:

$db

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 441 of file DatabaseMysql.php.

DatabaseMysql::setBigSelects ( $ value = true )

Parameters:

bool $value

Returns:: mixed

Reimplemented from DatabaseBase.

Definition at line 791 of file DatabaseMysql.php.

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

DatabaseMysql::setSessionOptions ( array $ options )

Parameters:

$options array

Reimplemented from DatabaseBase.

Definition at line 680 of file DatabaseMysql.php.

References DatabaseBase\query().

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

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

Parameters:

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

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

Reimplemented from DatabaseBase.

Definition at line 688 of file DatabaseMysql.php.

DatabaseMysql::strencode ( $ s )

Parameters:

$s string

Returns:: string

Implements DatabaseType.

Definition at line 451 of file DatabaseMysql.php.

References $s, and ping().

Referenced by addIdentifierQuotes().

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 737 of file DatabaseMysql.php.

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

DatabaseMysql::unlockTables ( $ method )

Parameters:

$method string

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 772 of file DatabaseMysql.php.

References DatabaseBase\query().

DatabaseMysql::useIndexClause ( $ index )

Parameters:

$index

Returns:: string

Reimplemented from DatabaseBase.

Definition at line 659 of file DatabaseMysql.php.

References DatabaseBase\indexName().

DatabaseMysql::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 848 of file DatabaseMysql.php.

References lastErrno().

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 867 of file DatabaseMysql.php.

References lastErrno().

DatabaseMysql::wasLockTimeout ( )

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

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 857 of file DatabaseMysql.php.

References lastErrno().

DatabaseMysql::wasReadOnlyError ( )

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

Returns:: bool

Reimplemented from DatabaseBase.

Definition at line 876 of file DatabaseMysql.php.

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

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