Database abstraction object for MySQL. More...

Inheritance diagram for Wikimedia\Rdbms\DatabaseMysqlBase:

[legend]

Collaboration diagram for Wikimedia\Rdbms\DatabaseMysqlBase:

[legend]

Public Member Functions
	__construct (array $params)
	Additional $params include:

	addIdentifierQuotes ( $s)
	MySQL uses `backticks` for identifier quoting instead of the sql standard "double quotes".

	addQuotes ( $s)
	Adds quotes and backslashes.

	dataSeek ( $res, $row)

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

	dropTable ( $tableName, $fName=__METHOD__)

	duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)

	estimateRowCount ( $table, $vars=' *', $conds='', $fname=__METHOD__, $options=[])
	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)

	fieldType ( $res, $n)
	mysql_field_type() wrapper

	freeResult ( $res)

	getLag ()
	Get replica DB lag.

	getMasterPos ()
	Get the position of the master from SHOW MASTER STATUS.

	getReplicaPos ()
	Get the position of the master from SHOW SLAVE STATUS.

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

	getServerVersion ()

	getSoftwareLink ()

	getType ()

	ignoreIndexClause ( $index)

	indexInfo ( $table, $index, $fname=__METHOD__)
	Get information about an index into an object Returns false if the index does not exist.

	isQuotedIdentifier ( $name)

	isView ( $name, $prefix=null)
	Differentiates between a TABLE and a VIEW.

	lastError ()

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

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

	lock ( $lockName, $method, $timeout=5)

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

	lowPriorityOption ()

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

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

	numFields ( $res)

	numRows ( $res)

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

	replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)

	serverIsReadOnly ()

	setBigSelects ( $value=true)

	setSessionOptions (array $options)

	streamStatementEnd (&$sql, &$newLine)

	strencode ( $s)

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

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

	unlock ( $lockName, $method)
	FROM MYSQL DOCS: https://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock.

	upsert ( $table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)

	useIndexClause ( $index)

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

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

	wasErrorReissuable ()
	Determines if the last query error was due to a dropped connection and 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.

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

	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.

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

	buildStringCast ( $field)

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

	close ()
	Closes a database connection.

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

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

	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.

	doAtomicSection ( $fname, callable $callback)
	Run a callback to do an atomic set of updates for this database.

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

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

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

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

	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.

	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.

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

	getProperty ( $name)

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

	getServer ()
	Get the server hostname or IP address.

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

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

	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.

	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.

	isOpen ()
	Is a connection to the database open?

	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.

	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.

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

	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.

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

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

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

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

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

	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.

	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__)
	Begin an atomic section of statements.

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

	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.

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

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

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

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

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

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

	writesOrCallbacksPending ()
	Returns true if there is a transaction 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
	affectedRows ()
	Get the number of rows affected by the last write query.

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

	lastErrno ()
	Get the last error number.

Protected Member Functions
	connectInitCharset ()
	Set the character set information right after connection.

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

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

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

	getHeartbeatData (array $conds)

	getLagDetectionMethod ()

	getLagFromPtHeartbeat ()

	getLagFromSlaveStatus ()

	getMasterServerInfo ()

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

	mysqlConnect ( $realServer)
	Open a connection to a MySQL server.

	mysqlDataSeek ( $res, $row)
	Move internal result pointer.

	mysqlError ( $conn=null)
	Returns the text of the error message from previous MySQL operation.

	mysqlFetchArray ( $res)
	Fetch a result row as an associative and numeric array.

	mysqlFetchField ( $res, $n)
	Get column information from a result.

	mysqlFetchObject ( $res)
	Fetch a result row as an object.

	mysqlFieldName ( $res, $n)
	Get the name of the specified field in a result.

	mysqlFieldType ( $res, $n)
	Get the type of the specified field in a result.

	mysqlFreeResult ( $res)
	Free result memory.

	mysqlNumFields ( $res)
	Get number of fields in result.

	mysqlNumRows ( $res)
	Get number of rows in result.

	mysqlRealEscapeString ( $s)

	mysqlSetCharset ( $charset)
	Set the character set of the MySQL link.

Protected Member Functions inherited from Wikimedia\Rdbms\Database
	assertOpen ()
	Make sure isOpen() returns true as a sanity check.

	closeConnection ()
	Closes underlying database connection.

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

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

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

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

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

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

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

	getBindingHandle ()
	Get the underlying binding handle, mConn.

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

	getSchemaVars ()
	Get schema variables.

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

	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.

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

	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.

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

	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.

	reconnect ()
	Close existing database connection and open a new connection.

	registerTempTableOperation ( $sql)

	replaceVars ( $ins)
	Database independent variable replacement.

	requiresDatabaseUser ()

	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 ( $name, $alias=false)
	Get an aliased table name e.g.

Protected Attributes
string	$lagDetectionMethod
	Method to detect replica DB lag.

array	$lagDetectionOptions = []
	Method to detect replica DB lag.

MysqlMasterPos	$lastKnownReplicaPos

string	$sqlMode
	sql_mode value to send on connection

string null	$sslCAFile

string null	$sslCAPath

string null	$sslCertPath

string[] null	$sslCiphers

string null	$sslKeyPath

bool	$useGTIDs = false
	bool Whether to use GTID methods

bool	$utf8Mode
	Use experimental UTF-8 transmission encoding.

Protected Attributes inherited from Wikimedia\Rdbms\Database
string	$agent
	Agent name for query profiling.

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

LoggerInterface	$connLogger

DatabaseDomain	$currentDomain

string	$delimiter = ';'

callback	$errorLogger
	Error logging callback.

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

float	$lastPing = 0.0
	UNIX timestamp.

resource null	$mConn = null
	Database connection.

string	$mDBname

bool null	$mDefaultBigSelects = null

int	$mFlags

string	$mLastQuery = ''
	SQL query.

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

array	$mLBInfo = []

bool	$mOpened = false

string	$mPassword

string bool	$mPHPError = false

string	$mSchema = ''

array bool	$mSchemaVars = false

string	$mServer

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

array	$mSessionVars = []

string	$mTablePrefix = ''

array[]	$mTrxEndCallbacks = []
	List of (callable, method name)

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

array[]	$mTrxIdleCallbacks = []
	List of (callable, method name)

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

array[]	$mTrxPreCommitCallbacks = []
	List of (callable, method name)

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

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

string	$mUser

array null	$preparedArgs

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

LoggerInterface	$queryLogger

BagOStuff	$srvCache
	APC cache.

	$tableAliases = []

TransactionProfiler	$trxProfiler

Private Member Functions
	getMysqlStatus ( $which="%")
	Get status information from SHOW STATUS in an associative array.

	makeLockName ( $lockName)

Private Attributes
string null	$serverVersion = null

Additional Inherited Members
Static Public Member Functions inherited from Wikimedia\Rdbms\Database
static	factory ( $dbType, $p=[])
	Construct a Database subclass instance given a database type and parameters.

static	getCacheSetOptions (IDatabase $db1)
	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.

Detailed Description

Database abstraction object for MySQL.

Defines methods independent on used MySQL extension.

Since: 1.22

See also: Database

Definition at line 40 of file DatabaseMysqlBase.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\DatabaseMysqlBase::__construct ( array $params )

Additional $params include:

lagDetectionMethod : set to one of (Seconds_Behind_Master,pt-heartbeat). pt-heartbeat assumes the table is at heartbeat.heartbeat and uses UTC timestamps in the heartbeat.ts column. (https://www.percona.com/doc/percona-toolkit/2.2/pt-heartbeat.html)
lagDetectionOptions : if using pt-heartbeat, this can be set to an array map to change the default behavior. Normally, the heartbeat row with the server ID of this server's master will be used. Set the "conds" field to override the query conditions, e.g. ['shard' => 's1'].
useGTIDs : use GTID methods like MASTER_GTID_WAIT() when possible.
sslKeyPath : path to key file [default: null]
sslCertPath : path to certificate file [default: null]
sslCAFile: path to a single certificate authority PEM file [default: null]
sslCAPath : parth to certificate authority PEM directory [default: null]
sslCiphers : array list of allowable ciphers [default: null]
Parameters

array $params

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 85 of file DatabaseMysqlBase.php.

References $params.

Member Function Documentation

◆ addIdentifierQuotes()

Wikimedia\Rdbms\DatabaseMysqlBase::addIdentifierQuotes ( $s )

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

Parameters

string $s

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 652 of file DatabaseMysqlBase.php.

References $s.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\DatabaseMysqlBase\tableExists().

◆ addQuotes()

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

Adds quotes and backslashes.

Parameters

string | int | null | bool | Blob $s

Returns: string|int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 636 of file DatabaseMysqlBase.php.

References $s, and string.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\lock(), Wikimedia\Rdbms\DatabaseMysqlBase\lockIsFree(), Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\DatabaseMysqlBase\unlock().

◆ connectInitCharset()

Wikimedia\Rdbms\DatabaseMysqlBase::connectInitCharset ( )

protected

Set the character set information right after connection.

Returns: bool

Reimplemented in Wikimedia\Rdbms\DatabaseMysqli.

Definition at line 220 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\mysqlSetCharset().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\open().

◆ dataSeek()

Wikimedia\Rdbms\DatabaseMysqlBase::dataSeek	(		$res,
			$row )

Parameters

ResultWrapper \| resource	$res
int	$row

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 442 of file DatabaseMysqlBase.php.

References $res, and Wikimedia\Rdbms\DatabaseMysqlBase\mysqlDataSeek().

◆ deleteJoin()

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

DELETE where the condition is a join.

MySql uses multi-table deletes.

Parameters

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

Exceptions

DBUnexpectedError

Returns: bool|ResultWrapper

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1135 of file DatabaseMysqlBase.php.

References $fname, Wikimedia\Rdbms\Database\makeList(), query, and tableName().

◆ doLockTables()

Wikimedia\Rdbms\DatabaseMysqlBase::doLockTables	(	array	$read,
		array	$write,
			$method )

protected

Helper function for lockTables() that handles the actual table locking.

Parameters

array	$read	Array of tables to lock for read access
array	$write	Array of tables to lock for write access
string	$method	Name of caller

Returns: true

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1084 of file DatabaseMysqlBase.php.

References query, and tableName().

◆ doUnlockTables()

Wikimedia\Rdbms\DatabaseMysqlBase::doUnlockTables ( $method )

protected

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

Parameters

string $method Name of caller

Returns: true

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1099 of file DatabaseMysqlBase.php.

References query.

◆ dropTable()

Wikimedia\Rdbms\DatabaseMysqlBase::dropTable	(		$tableName,
			$fName = __METHOD__ )

Parameters

string	$tableName
string	$fName

Returns: bool|ResultWrapper

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1280 of file DatabaseMysqlBase.php.

References query, Wikimedia\Rdbms\DatabaseMysqlBase\tableExists(), and tableName().

◆ duplicateTableStructure()

Wikimedia\Rdbms\DatabaseMysqlBase::duplicateTableStructure	(	$oldName,
		$newName,
		$temporary = false,
		$fname = __METHOD__ )

Parameters

string	$oldName
string	$newName
bool	$temporary
string	$fname

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1240 of file DatabaseMysqlBase.php.

References $fname, $query, Wikimedia\Rdbms\DatabaseMysqlBase\addIdentifierQuotes(), and query.

◆ estimateRowCount()

Wikimedia\Rdbms\DatabaseMysqlBase::estimateRowCount	(	$table,
		$vars = '*',
		$conds = '',
		$fname = __METHOD__,
		$options = [] )

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

Parameters

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

Returns: bool|int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 512 of file DatabaseMysqlBase.php.

References $fname, $options, $res, $rows, $vars, Wikimedia\Rdbms\DatabaseMysqlBase\numRows(), and select().

◆ fetchObject()

Wikimedia\Rdbms\DatabaseMysqlBase::fetchObject ( $res )

Parameters

ResultWrapper | resource $res

Returns: stdClass|bool

Exceptions

DBUnexpectedError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 276 of file DatabaseMysqlBase.php.

References $res, Wikimedia\Rdbms\IDatabase\lastErrno(), Wikimedia\Rdbms\DatabaseMysqlBase\lastError(), and Wikimedia\Rdbms\DatabaseMysqlBase\mysqlFetchObject().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getMasterPos(), Wikimedia\Rdbms\DatabaseMysqlBase\getReplicaPos(), Wikimedia\Rdbms\DatabaseMysqlBase\lock(), Wikimedia\Rdbms\DatabaseMysqlBase\lockIsFree(), Wikimedia\Rdbms\DatabaseMysqlBase\serverIsReadOnly(), and Wikimedia\Rdbms\DatabaseMysqlBase\unlock().

◆ fetchRow()

Wikimedia\Rdbms\DatabaseMysqlBase::fetchRow ( $res )

Parameters

ResultWrapper | resource $res

Returns: array|bool

Exceptions

DBUnexpectedError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 312 of file DatabaseMysqlBase.php.

References $res, Wikimedia\Rdbms\IDatabase\lastErrno(), Wikimedia\Rdbms\DatabaseMysqlBase\lastError(), and Wikimedia\Rdbms\DatabaseMysqlBase\mysqlFetchArray().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait().

◆ fieldInfo()

Wikimedia\Rdbms\DatabaseMysqlBase::fieldInfo	(		$table,
			$field )

Parameters

string	$table
string	$field

Returns: bool|MySQLField

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 562 of file DatabaseMysqlBase.php.

References $res, Wikimedia\Rdbms\DatabaseMysqlBase\mysqlFetchField(), Wikimedia\Rdbms\DatabaseMysqlBase\mysqlNumFields(), query, and tableName().

◆ fieldName()

Wikimedia\Rdbms\DatabaseMysqlBase::fieldName	(		$res,
			$n )

Parameters

ResultWrapper \| resource	$res
int	$n

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 397 of file DatabaseMysqlBase.php.

References $res, and Wikimedia\Rdbms\DatabaseMysqlBase\mysqlFieldName().

◆ fieldType()

Wikimedia\Rdbms\DatabaseMysqlBase::fieldType	(		$res,
			$n )

mysql_field_type() wrapper

Parameters

ResultWrapper \| resource	$res
int	$n

Returns: string

Definition at line 420 of file DatabaseMysqlBase.php.

References $res, and Wikimedia\Rdbms\DatabaseMysqlBase\mysqlFieldType().

◆ freeResult()

Wikimedia\Rdbms\DatabaseMysqlBase::freeResult ( $res )

Parameters

ResultWrapper | resource $res

Exceptions

DBUnexpectedError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 251 of file DatabaseMysqlBase.php.

References $res, and Wikimedia\Rdbms\DatabaseMysqlBase\mysqlFreeResult().

◆ getApproximateLagStatus()

Wikimedia\Rdbms\DatabaseMysqlBase::getApproximateLagStatus ( )

protected

Get a replica DB lag estimate for this server.

Returns: array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)

Since: 1.27

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 804 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getLagDetectionMethod(), and Wikimedia\Rdbms\Database\getServer().

◆ getHeartbeatData()

Wikimedia\Rdbms\DatabaseMysqlBase::getHeartbeatData ( array $conds )

protected

Parameters

array $conds WHERE clause conditions to find a row

Returns: array (heartbeat ts column value or null, UNIX timestamp) for the newest beat

See also: https://www.percona.com/doc/percona-toolkit/2.1/pt-heartbeat.html

Definition at line 783 of file DatabaseMysqlBase.php.

References $res, Wikimedia\Rdbms\Database\clearFlag(), Wikimedia\Rdbms\Database\makeList(), query, and Wikimedia\Rdbms\Database\restoreFlags().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromPtHeartbeat().

◆ getLag()

Wikimedia\Rdbms\DatabaseMysqlBase::getLag ( )

Get replica DB lag.

Currently supported only by MySQL.

Note that this function will generate a fatal error on many installations. Most callers should use LoadBalancer::safeGetLag() instead.

Returns: int|bool Database replication lag in seconds or false on error

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 666 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getLagDetectionMethod(), Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromPtHeartbeat(), and Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromSlaveStatus().

◆ getLagDetectionMethod()

Wikimedia\Rdbms\DatabaseMysqlBase::getLagDetectionMethod ( )

protected

Returns: string

Definition at line 677 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\$lagDetectionMethod.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getApproximateLagStatus(), and Wikimedia\Rdbms\DatabaseMysqlBase\getLag().

◆ getLagFromPtHeartbeat()

Wikimedia\Rdbms\DatabaseMysqlBase::getLagFromPtHeartbeat ( )

protected

Returns: bool|float

Definition at line 697 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\$lagDetectionOptions, $options, $time, Wikimedia\Rdbms\DatabaseMysqlBase\getHeartbeatData(), Wikimedia\Rdbms\Database\getLogContext(), Wikimedia\Rdbms\DatabaseMysqlBase\getMasterServerInfo(), and list.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getLag().

◆ getLagFromSlaveStatus()

Wikimedia\Rdbms\DatabaseMysqlBase::getLagFromSlaveStatus ( )

protected

Returns: bool|int

Definition at line 684 of file DatabaseMysqlBase.php.

References $res, and query.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getLag().

◆ getMasterPos()

Wikimedia\Rdbms\DatabaseMysqlBase::getMasterPos ( )

Get the position of the master from SHOW MASTER STATUS.

Returns: MySQLMasterPos|bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 904 of file DatabaseMysqlBase.php.

References $res, Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), and query.

◆ getMasterServerInfo()

Wikimedia\Rdbms\DatabaseMysqlBase::getMasterServerInfo ( )

protected

Definition at line 740 of file DatabaseMysqlBase.php.

References $cache, $e, $res, Wikimedia\Rdbms\Database\$srvCache, Wikimedia\Rdbms\Database\getLazyMasterHandle(), Wikimedia\Rdbms\Database\getLBInfo(), Wikimedia\Rdbms\Database\getServer(), BagOStuff\makeGlobalKey(), and use.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromPtHeartbeat().

◆ getMysqlStatus()

Wikimedia\Rdbms\DatabaseMysqlBase::getMysqlStatus ( $which = "%" )

private

Get status information from SHOW STATUS in an associative array.

Parameters

string $which

Returns: array

Definition at line 1294 of file DatabaseMysqlBase.php.

References $res, and query.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getServerUptime().

◆ getReplicaPos()

Wikimedia\Rdbms\DatabaseMysqlBase::getReplicaPos ( )

Get the position of the master from SHOW SLAVE STATUS.

Returns: MySQLMasterPos|bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 876 of file DatabaseMysqlBase.php.

References $res, Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), and query.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\masterPosWait().

◆ getServerUptime()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerUptime ( )

Determines how long the server has been up.

Returns: int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1191 of file DatabaseMysqlBase.php.

References $vars, and Wikimedia\Rdbms\DatabaseMysqlBase\getMysqlStatus().

◆ getServerVersion()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerVersion ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Reimplemented in FakeDatabaseMysqlBase.

Definition at line 975 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\$serverVersion, and Wikimedia\Rdbms\Database\selectField().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getSoftwareLink().

◆ getSoftwareLink()

Wikimedia\Rdbms\DatabaseMysqlBase::getSoftwareLink ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 957 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getServerVersion().

◆ getType()

Wikimedia\Rdbms\DatabaseMysqlBase::getType ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 108 of file DatabaseMysqlBase.php.

◆ ignoreIndexClause()

Wikimedia\Rdbms\DatabaseMysqlBase::ignoreIndexClause ( $index )

Parameters

string $index

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 943 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\indexName().

◆ indexInfo()

Wikimedia\Rdbms\DatabaseMysqlBase::indexInfo	(	$table,
		$index,
		$fname = __METHOD__ )

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

Parameters

string	$table
string	$index
string	$fname

Returns: bool|array|null False or null on failure

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 597 of file DatabaseMysqlBase.php.

References $fname, $res, $result, false, Wikimedia\Rdbms\DatabaseMysqlBase\indexName(), query, and tableName().

◆ indexName()

Wikimedia\Rdbms\DatabaseMysqlBase::indexName ( $index )

protected

Allows for index remapping in queries where this is not consistent across DBMS.

Parameters

string $index

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1358 of file DatabaseMysqlBase.php.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\ignoreIndexClause(), Wikimedia\Rdbms\DatabaseMysqlBase\indexInfo(), and Wikimedia\Rdbms\DatabaseMysqlBase\useIndexClause().

◆ isQuotedIdentifier()

Wikimedia\Rdbms\DatabaseMysqlBase::isQuotedIdentifier ( $name )

Parameters

string $name

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 662 of file DatabaseMysqlBase.php.

◆ isView()

Wikimedia\Rdbms\DatabaseMysqlBase::isView	(		$name,
			$prefix = null )

Differentiates between a TABLE and a VIEW.

Parameters

string	$name	Name of the TABLE/VIEW to test
string	$prefix

Returns: bool

Since: 1.22

Definition at line 1348 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\listViews().

◆ lastError()

Wikimedia\Rdbms\DatabaseMysqlBase::lastError ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 462 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\mysqlError().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchRow(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\DatabaseMysqlBase\wasReadOnlyError().

◆ listTables()

Wikimedia\Rdbms\DatabaseMysqlBase::listTables	(		$prefix = null,
			$fname = __METHOD__ )

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 Wikimedia\Rdbms\Database.

Definition at line 1258 of file DatabaseMysqlBase.php.

References $fname, $vars, and query.

◆ listViews()

Wikimedia\Rdbms\DatabaseMysqlBase::listViews	(		$prefix = null,
			$fname = __METHOD__ )

Lists VIEWs in the database.

Parameters

string	$prefix	Only show VIEWs with this prefix, eg. unit_test_, or $wgDBprefix. Default: null, would return all views.
string	$fname	Name of calling function

Returns: array

Since: 1.22

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1314 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\$mDBname, $res, and query.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\isView().

◆ lock()

Wikimedia\Rdbms\DatabaseMysqlBase::lock	(	$lockName,
		$method,
		$timeout = 5 )

Parameters

string	$lockName
string	$method
int	$timeout

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1033 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\addQuotes(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), Wikimedia\Rdbms\DatabaseMysqlBase\makeLockName(), and query.

◆ lockIsFree()

Wikimedia\Rdbms\DatabaseMysqlBase::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: bool

Since: 1.20

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1019 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\addQuotes(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), Wikimedia\Rdbms\DatabaseMysqlBase\makeLockName(), and query.

◆ lowPriorityOption()

Wikimedia\Rdbms\DatabaseMysqlBase::lowPriorityOption ( )

Returns: string

Definition at line 950 of file DatabaseMysqlBase.php.

◆ makeLockName()

Wikimedia\Rdbms\DatabaseMysqlBase::makeLockName ( $lockName )

private

Definition at line 1070 of file DatabaseMysqlBase.php.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\lock(), Wikimedia\Rdbms\DatabaseMysqlBase\lockIsFree(), and Wikimedia\Rdbms\DatabaseMysqlBase\unlock().

◆ masterPosWait()

Wikimedia\Rdbms\DatabaseMysqlBase::masterPosWait	(	DBMasterPos	$pos,
			$timeout )

Wait for the replica DB to catch up to a given master position.

Parameters

DBMasterPos	$pos
int	$timeout	The maximum number of seconds to wait for synchronisation

Returns: int|null Zero if the replica DB was past that position already, greater than zero if we waited for some period of time, less than zero if it timed out, and null on error

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 822 of file DatabaseMysqlBase.php.

References $res, Wikimedia\Rdbms\DatabaseMysqlBase\addQuotes(), Wikimedia\Rdbms\Database\doQuery(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchRow(), Wikimedia\Rdbms\Database\getLBInfo(), and Wikimedia\Rdbms\DatabaseMysqlBase\getReplicaPos().

◆ mysqlConnect()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlConnect ( $realServer )

abstractprotected

Open a connection to a MySQL server.

Parameters

string $realServer

Returns: mixed Raw connection

Exceptions

DBConnectionError

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\open().

◆ mysqlDataSeek()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlDataSeek	(		$res,
			$row )

abstractprotected

Move internal result pointer.

Parameters

ResultWrapper \| resource	$res
int	$row

Returns: bool

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\dataSeek().

◆ mysqlError()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlError ( $conn = null )

abstractprotected

Returns the text of the error message from previous MySQL operation.

Parameters

resource $conn Raw connection

Returns: string

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\lastError().

◆ mysqlFetchArray()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlFetchArray ( $res )

abstractprotected

Fetch a result row as an associative and numeric array.

Parameters

resource $res Raw result

Returns: array

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\fetchRow().

◆ mysqlFetchField()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlFetchField	(		$res,
			$n )

abstractprotected

Get column information from a result.

Parameters

resource	$res	Raw result
int	$n

Returns: stdClass

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\fieldInfo().

◆ mysqlFetchObject()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlFetchObject ( $res )

abstractprotected

Fetch a result row as an object.

Parameters

resource $res Raw result

Returns: stdClass

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject().

◆ mysqlFieldName()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlFieldName	(		$res,
			$n )

abstractprotected

Get the name of the specified field in a result.

Parameters

ResultWrapper \| resource	$res
int	$n

Returns: string

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\fieldName().

◆ mysqlFieldType()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlFieldType	(		$res,
			$n )

abstractprotected

Get the type of the specified field in a result.

Parameters

ResultWrapper \| resource	$res
int	$n

Returns: string

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\fieldType().

◆ mysqlFreeResult()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlFreeResult ( $res )

abstractprotected

Free result memory.

Parameters

resource $res Raw result

Returns: bool

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\freeResult().

◆ mysqlNumFields()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlNumFields ( $res )

abstractprotected

Get number of fields in result.

Parameters

resource $res Raw result

Returns: int

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\fieldInfo(), and Wikimedia\Rdbms\DatabaseMysqlBase\numFields().

◆ mysqlNumRows()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlNumRows ( $res )

abstractprotected

Get number of rows in result.

Parameters

resource $res Raw result

Returns: int

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\numRows().

◆ mysqlRealEscapeString()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlRealEscapeString ( $s )

abstractprotected

Parameters

string $s

Returns: mixed

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\strencode().

◆ mysqlSetCharset()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlSetCharset ( $charset )

abstractprotected

Set the character set of the MySQL link.

Parameters

string $charset

Returns: bool

Reimplemented in Wikimedia\Rdbms\DatabaseMysql, Wikimedia\Rdbms\DatabaseMysqli, and FakeDatabaseMysqlBase.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\connectInitCharset().

◆ namedLocksEnqueue()

Wikimedia\Rdbms\DatabaseMysqlBase::namedLocksEnqueue ( )

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

Returns: bool

Since: 1.26

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1076 of file DatabaseMysqlBase.php.

◆ numFields()

Wikimedia\Rdbms\DatabaseMysqlBase::numFields ( $res )

Parameters

ResultWrapper | resource $res

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 376 of file DatabaseMysqlBase.php.

References $res, and Wikimedia\Rdbms\DatabaseMysqlBase\mysqlNumFields().

◆ numRows()

Wikimedia\Rdbms\DatabaseMysqlBase::numRows ( $res )

Exceptions

DBUnexpectedError

Parameters

ResultWrapper | resource $res

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 348 of file DatabaseMysqlBase.php.

References $res, and Wikimedia\Rdbms\DatabaseMysqlBase\mysqlNumRows().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\estimateRowCount().

◆ open()

Wikimedia\Rdbms\DatabaseMysqlBase::open	(	$server,
		$user,
		$password,
		$dbName )

Parameters

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

Exceptions

Exception|DBConnectionError

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 120 of file DatabaseMysqlBase.php.

◆ replace()

Wikimedia\Rdbms\DatabaseMysqlBase::replace	(	$table,
		$uniqueIndexes,
		$rows,
		$fname = __METHOD__ )

Parameters

string	$table
array	$uniqueIndexes
array	$rows
string	$fname

Returns: ResultWrapper

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 496 of file DatabaseMysqlBase.php.

References $fname, $rows, and Wikimedia\Rdbms\Database\nativeReplace().

◆ serverIsReadOnly()

Wikimedia\Rdbms\DatabaseMysqlBase::serverIsReadOnly ( )

Returns: bool Whether the DB is marked as read-only server-side

Since: 1.28

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 924 of file DatabaseMysqlBase.php.

References $res, Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), and query.

◆ setBigSelects()

Wikimedia\Rdbms\DatabaseMysqlBase::setBigSelects ( $value = true )

Parameters

bool $value

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1108 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\$mDefaultBigSelects, $value, query, and Wikimedia\Rdbms\Database\selectField().

◆ setSessionOptions()

Wikimedia\Rdbms\DatabaseMysqlBase::setSessionOptions ( array $options )

Parameters

array $options

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 988 of file DatabaseMysqlBase.php.

References $options, and query.

◆ streamStatementEnd()

Wikimedia\Rdbms\DatabaseMysqlBase::streamStatementEnd	(	&	$sql,
		&	$newLine )

Parameters

string	&$sql
string	&$newLine

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1001 of file DatabaseMysqlBase.php.

◆ strencode()

Wikimedia\Rdbms\DatabaseMysqlBase::strencode ( $s )

Parameters

string $s

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 626 of file DatabaseMysqlBase.php.

References $s, and Wikimedia\Rdbms\DatabaseMysqlBase\mysqlRealEscapeString().

◆ tableExists()

Wikimedia\Rdbms\DatabaseMysqlBase::tableExists	(		$table,
			$fname = __METHOD__ )

Query whether a given table exists.

Parameters

string	$table
string	$fname

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 532 of file DatabaseMysqlBase.php.

References $fname, $query, Wikimedia\Rdbms\DatabaseMysqlBase\addIdentifierQuotes(), Wikimedia\Rdbms\Database\escapeLikeInternal(), list, Wikimedia\Rdbms\Database\qualifiedTableComponents(), and query.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\dropTable().

◆ tableLocksHaveTransactionScope()

Wikimedia\Rdbms\DatabaseMysqlBase::tableLocksHaveTransactionScope ( )

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

Transaction-bound table locks will be released when the current transaction terminates. Table locks that are not bound to a transaction are not effected by BEGIN/COMMIT/ROLLBACK and will last until either lockTables()/unlockTables() is called or the TCP connection to the database is closed.

Returns: bool

Since: 1.29

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1080 of file DatabaseMysqlBase.php.

◆ unlock()

Wikimedia\Rdbms\DatabaseMysqlBase::unlock	(		$lockName,
			$method )

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

Parameters

string	$lockName
string	$method

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1055 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\addQuotes(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), Wikimedia\Rdbms\DatabaseMysqlBase\makeLockName(), and query.

◆ upsert()

Wikimedia\Rdbms\DatabaseMysqlBase::upsert	(		$table,
		array	$rows,
		array	$uniqueIndexes,
		array	$set,
			$fname = __METHOD__ )

Parameters

string	$table
array	$rows
array	$uniqueIndexes
array	$set
string	$fname

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1161 of file DatabaseMysqlBase.php.

References $fname, $rows, Wikimedia\Rdbms\Database\makeList(), query, and tableName().

◆ useIndexClause()

Wikimedia\Rdbms\DatabaseMysqlBase::useIndexClause ( $index )

Parameters

string $index

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 935 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\indexName().

◆ wasConnectionError()

Wikimedia\Rdbms\DatabaseMysqlBase::wasConnectionError ( $errno )

Do not use this method outside of Database/DBError classes.

Parameters

int | string $errno

Returns: bool Whether the given query error was a connection drop

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1229 of file DatabaseMysqlBase.php.

◆ wasDeadlock()

Wikimedia\Rdbms\DatabaseMysqlBase::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1202 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\IDatabase\lastErrno().

◆ wasErrorReissuable()

Wikimedia\Rdbms\DatabaseMysqlBase::wasErrorReissuable ( )

Determines if the last query error was due to a dropped connection and should be dealt with by pinging the connection and reissuing the query.

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1215 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\IDatabase\lastErrno().

◆ wasLockTimeout()

Wikimedia\Rdbms\DatabaseMysqlBase::wasLockTimeout ( )

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

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1211 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\IDatabase\lastErrno().

◆ wasReadOnlyError()

Wikimedia\Rdbms\DatabaseMysqlBase::wasReadOnlyError ( )

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

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1224 of file DatabaseMysqlBase.php.

References false, Wikimedia\Rdbms\IDatabase\lastErrno(), and Wikimedia\Rdbms\DatabaseMysqlBase\lastError().

Member Data Documentation

◆ $lagDetectionMethod

string Wikimedia\Rdbms\DatabaseMysqlBase::$lagDetectionMethod

protected

Method to detect replica DB lag.

Definition at line 44 of file DatabaseMysqlBase.php.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getLagDetectionMethod().

◆ $lagDetectionOptions

array Wikimedia\Rdbms\DatabaseMysqlBase::$lagDetectionOptions = []

protected

Method to detect replica DB lag.

Definition at line 46 of file DatabaseMysqlBase.php.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getLagFromPtHeartbeat().

◆ $lastKnownReplicaPos

MysqlMasterPos Wikimedia\Rdbms\DatabaseMysqlBase::$lastKnownReplicaPos

protected

Definition at line 42 of file DatabaseMysqlBase.php.

◆ $serverVersion

string null Wikimedia\Rdbms\DatabaseMysqlBase::$serverVersion = null

private

Definition at line 65 of file DatabaseMysqlBase.php.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getServerVersion().

◆ $sqlMode

string Wikimedia\Rdbms\DatabaseMysqlBase::$sqlMode

protected

sql_mode value to send on connection

Definition at line 60 of file DatabaseMysqlBase.php.

◆ $sslCAFile

string null Wikimedia\Rdbms\DatabaseMysqlBase::$sslCAFile

protected

Definition at line 54 of file DatabaseMysqlBase.php.

◆ $sslCAPath

string null Wikimedia\Rdbms\DatabaseMysqlBase::$sslCAPath

protected

Definition at line 56 of file DatabaseMysqlBase.php.

◆ $sslCertPath

string null Wikimedia\Rdbms\DatabaseMysqlBase::$sslCertPath

protected

Definition at line 52 of file DatabaseMysqlBase.php.

◆ $sslCiphers

string [] null Wikimedia\Rdbms\DatabaseMysqlBase::$sslCiphers

protected

Definition at line 58 of file DatabaseMysqlBase.php.

◆ $sslKeyPath

string null Wikimedia\Rdbms\DatabaseMysqlBase::$sslKeyPath

protected

Definition at line 50 of file DatabaseMysqlBase.php.

◆ $useGTIDs

bool Wikimedia\Rdbms\DatabaseMysqlBase::$useGTIDs = false

protected

bool Whether to use GTID methods

Definition at line 48 of file DatabaseMysqlBase.php.

◆ $utf8Mode

bool Wikimedia\Rdbms\DatabaseMysqlBase::$utf8Mode

protected

Use experimental UTF-8 transmission encoding.

Definition at line 62 of file DatabaseMysqlBase.php.

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

includes/libs/rdbms/database/DatabaseMysqlBase.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addIdentifierQuotes()

◆ addQuotes()

◆ connectInitCharset()

◆ dataSeek()

◆ deleteJoin()

◆ doLockTables()

◆ doUnlockTables()

◆ dropTable()

◆ duplicateTableStructure()

◆ estimateRowCount()

◆ fetchObject()

◆ fetchRow()

◆ fieldInfo()

◆ fieldName()

◆ fieldType()

◆ freeResult()

◆ getApproximateLagStatus()

◆ getHeartbeatData()

◆ getLag()

◆ getLagDetectionMethod()

◆ getLagFromPtHeartbeat()

◆ getLagFromSlaveStatus()

◆ getMasterPos()

◆ getMasterServerInfo()

◆ getMysqlStatus()

◆ getReplicaPos()

◆ getServerUptime()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getType()

◆ ignoreIndexClause()

◆ indexInfo()

◆ indexName()

◆ isQuotedIdentifier()

◆ isView()

◆ lastError()

◆ listTables()

◆ listViews()

◆ lock()

◆ lockIsFree()

◆ lowPriorityOption()

◆ makeLockName()

◆ masterPosWait()

◆ mysqlConnect()

◆ mysqlDataSeek()

◆ mysqlError()

◆ mysqlFetchArray()

◆ mysqlFetchField()

◆ mysqlFetchObject()

◆ mysqlFieldName()

◆ mysqlFieldType()

◆ mysqlFreeResult()

◆ mysqlNumFields()

◆ mysqlNumRows()

◆ mysqlRealEscapeString()

◆ mysqlSetCharset()

◆ namedLocksEnqueue()

◆ numFields()

◆ numRows()

◆ open()

◆ replace()

◆ serverIsReadOnly()

◆ setBigSelects()

◆ setSessionOptions()

◆ streamStatementEnd()

◆ strencode()

◆ tableExists()

◆ tableLocksHaveTransactionScope()

◆ unlock()

◆ upsert()