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

buildIntegerCast ( $field)

buildStringCast ( $field)

Parameters

string $field Field or column to cast

Returns: string

Since: 1.28

Stable to override Stable to override

dataSeek ( $res, $row)

deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)

DELETE where the condition is a join.

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

estimateRowCount ( $table, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

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)

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.

masterPosWait (DBMasterPos $pos, $timeout)

Wait for the replica DB to catch up to a given master position.Note that this does not start any new transactions. If any existing transaction is flushed, and this is called, then queries will reflect the point the DB was synced up to (on success) without interference from REPEATABLE-READ snapshots.

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

Exceptions

DBError If an error occurs, see IDatabase::query()

Stable to override Stable to override

namedLocksEnqueue ()

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

Returns: bool

Since: 1.26

Stable to override Stable to override

numFields ( $res)

numRows ( $res)

serverIsReadOnly ()

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

Since: 1.28

Stable to override Stable to override

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)

See https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_release-lock.

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.

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

Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present.

addQuotes ( $s)

Escape and quote a raw value string for use in a SQL query.

Parameters

Returns: string

Stable to override

affectedRows ()

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

aggregateValue ( $valuedata, $valuename='value')

Return aggregated value alias.

Parameters

array	$valuedata
string	$valuename

Returns: array|string

Deprecated:: Since 1.33

Stable to override

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.

assertNoOpenTransactions ()

Assert that all explicit transactions or atomic sections have been closed.

begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)

Begin a transaction.

bitAnd ( $fieldLeft, $fieldRight)

Parameters

string \| int	$fieldLeft
string \| int	$fieldRight

Returns: string

Stable to override

bitNot ( $field)

Parameters

string | int $field

Returns: string

Stable to override

bitOr ( $fieldLeft, $fieldRight)

Parameters

string \| int	$fieldLeft
string \| int	$fieldRight

Returns: string

Stable to override

buildConcat ( $stringList)

Build a concatenation list to feed into a SQL query.

Parameters

string[] $stringList Raw SQL expression list; caller is responsible for escaping

Returns: string

Stable to override

buildGreatest ( $fields, $values)

Build a GREATEST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.

Parameters

string \| string[]	$fields	Name(s) of column(s) with values to compare
string \| int \| float \| string[] \| int[] \| float[]	$values	Values to compare

Returns: mixed

Since: 1.35

Stable to override

buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])

Build a GROUP_CONCAT or equivalent statement for a query.This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.

Parameters

string	$delim	Glue to bind the results together
string \| array	$table	Table name
string	$field	Field name
string \| array	$conds	Conditions
string \| array	$join_conds	Join conditions

Returns: string SQL text

Since: 1.23

Stable to override

buildLeast ( $fields, $values)

Build a LEAST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.

Parameters

string \| string[]	$fields	Name(s) of column(s) with values to compare
string \| int \| float \| string[] \| int[] \| float[]	$values	Values to compare

Returns: mixed

Since: 1.35

Stable to override

buildLike ( $param,... $params)

LIKE statement wrapper.This takes 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(). Alternatively, the function could be provided with an array of aforementioned parameters.Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches for subpages of 'My page title'. Alternatively: $pattern = [ 'My_page_title/', $dbr->anyString() ]; $query .= $dbr->buildLike( $pattern );

Since: 1.16

Parameters

array[] \| string \| LikeMatch	$param
	string\|LikeMatch	...$params

Returns: string Fully built LIKE statement

Stable to override

buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery.

buildSubstring ( $input, $startPosition, $length=null)

Stable to override

cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)

Cancel an atomic section of SQL statements.

clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)

Clear a flag for this connection.

close ( $fname=__METHOD__, $owner=null)

Close the database connection.

commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)

Commits a transaction previously started using begin()

conditional ( $cond, $trueVal, $falseVal)

Returns an SQL expression for a simple conditional.This doesn't need to be overridden unless CASE isn't supported in the RDBMS.

Parameters

string \| array	$cond	SQL expression which will result in a boolean value
string	$trueVal	SQL expression to return if true
string	$falseVal	SQL expression to return if false

Returns: string SQL fragment

Stable to override

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.In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.

Returns: bool

Since: 1.29

Stable to override

dbSchema ( $schema=null)

Get/set the db schema.

deadlockLoop (... $args)

Perform a deadlock-prone transaction.This function invokes a callback function to perform a set of write queries. If a deadlock occurs during the processing, the transaction will be rolled back and the callback function will be called again.Avoid using this method outside of Job or Maintenance classes.Usage: $dbw->deadlockLoop( callback, ... );Extra arguments are passed through to the specified callback function. This method requires that no transactions are already active to avoid causing premature commits or exceptions.Returns whatever the callback function returned on its successful, iteration, or false on error, for example if the retry limit was reached.

Parameters

mixed ...$args

Returns: mixed

Exceptions

DBUnexpectedError
Exception

Stable to override

decodeBlob ( $b)

Some DBMSs return a special placeholder object representing blob fields in result objects.Pass the object through this function to return the original string.

Parameters

string | Blob $b

Returns: string

Exceptions

DBError

Stable to override

decodeExpiry ( $expiry, $format=TS_MW)

Decode an expiry time into a DBMS independent format.

delete ( $table, $conds, $fname=__METHOD__)

Delete all rows in a table that match a condition.

doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)

Perform an atomic section of reversable SQL statements from a callback.

dropTable ( $table, $fname=__METHOD__)

Delete a table.

encodeBlob ( $b)

Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.To insert into such a field, pass the data through this function before passing it to IDatabase::insert().

Parameters

string $b

Returns: string|Blob

Exceptions

DBError

Stable to override

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__, $flush=self::FLUSHING_ONE)

Commit any transaction but error out if writes or callbacks are pending.

getDBname ()

Get the current DB name.

getDomainID ()

Return the currently selected domain ID.

getFlag ( $flag)

Returns a boolean whether the flag $flag is set for this connection.

getInfinity ()

Find out when 'infinity' is.Most DBMSes support this. This is a special keyword for timestamps in PostgreSQL, and works with CHAR(14) as well because "i" sorts after all numbers.

Returns: string

Stable to override

getLag ()

Get the amount of replication lag for this database server.

getLBInfo ( $name=null)

Get properties passed down from the server info array of the load balancer.

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

Get a human-readable string describing the current software version.

getSessionLagStatus ()

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

getTopologyRole ()

Get the replication topology role of this server.

getTopologyRootMaster ()

Get the host (or address) of the root master server for the replication topology.

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.

Returns: bool

Stable to override

indexExists ( $table, $index, $fname=__METHOD__)

Determines whether an index exists.

indexUnique ( $table, $index, $fname=__METHOD__)

Determines if a given index is unique.

Parameters

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

Returns: bool

Stable to override

initConnection ()

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

insert ( $table, $rows, $fname=__METHOD__, $options=[])

Insert the given row(s) into a table.

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

INSERT SELECT wrapper.

isOpen ()

isReadOnly ()

lastDoneWrites ()

Get the last time the connection may have been used for a write query.

lastQuery ()

Get the last query that sent on account of IDatabase::query()

limitResult ( $sql, $limit, $offset=false)

Construct a LIMIT query with optional offset.The SQL should be adjusted so that only the first $limit rows are returned. If $offset is provided as well, then the first $offset rows should be discarded, and the next $limit rows should be returned. If the result of the query is not ordered, then the rows to be returned are theoretically arbitrary.$sql is expected to be a SELECT, if that makes a difference.

Parameters

string	$sql	SQL query we will append the limit too
int	$limit	The SQL limit
int \| bool	$offset	The SQL offset (default false)

Returns: string

Since: 1.34

Stable to override

lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Lock all rows meeting the given conditions/options FOR UPDATE.

lockTables (array $read, array $write, $method)

Lock specific tables.

makeList (array $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.

Returns: int

Stable to override

newSelectQueryBuilder ()

Create an empty SelectQueryBuilder which can be used to run queries against this connection.

Returns: SelectQueryBuilder

nextSequenceValue ( $seqName)

Deprecated method, calls should be removed.

onAtomicSectionCancel (callable $callback, $fname=__METHOD__)

Run a callback when the atomic section is cancelled.

onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)

Run a callback as soon as there is no transaction pending.

onTransactionIdle (callable $callback, $fname=__METHOD__)

Alias for onTransactionCommitOrIdle() for backwards-compatibility.

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.

pendingWriteAndCallbackCallers ()

List the methods that have write queries or callbacks for the current transaction.

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.

preCommitCallbacksPending ()

query ( $sql, $fname=__METHOD__, $flags=self::QUERY_NORMAL)

Run an SQL query and return the result.

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

Insert row(s) into a table, deleting all conflicting rows beforehand.

reportQueryError ( $error, $errno, $sql, $fname, $ignore=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=self::FLUSHING_ONE)

Rollback a transaction previously started using begin()

runOnTransactionIdleCallbacks ( $trigger)

Actually consume and run any "on transaction idle/resolution" callbacks.

runOnTransactionPreCommitCallbacks ()

Actually consume and run 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.

selectDomain ( $domain)

Set the current domain (database, schema, and table prefix)

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=[])

Wrapper to IDatabase::select() that only fetches one row (via LIMIT)

selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Get the number of rows in dataset.

selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Take the same arguments as IDatabase::select() and return the SQL it would use.This can be useful for making UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().

See also: IDatabase::select()

Parameters

string \| array	$table	Table name
string \| array	$vars	Field names
string \| array	$conds	Conditions
string	$fname	Caller function name
string \| array	$options	Query options
string \| array	$join_conds	Join conditions

Returns: string SQL query string

Stable to override

setFlag ( $flag, $remember=self::REMEMBER_NOTHING)

Set a flag for this connection.

setIndexAliases (array $aliases)

Convert certain index names to alternative names before querying the DB.Note that this applies to indexes regardless of the table they belong to.This can be employed when an index was renamed X => Y in code, but the new Y-named indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA, the aliases can be removed, and then the old X-named indexes dropped.

Parameters

string[] $aliases

Since: 1.31

Stable to override

setLBInfo ( $nameOrArray, $value=null)

Set the entire array or a particular key of the managing load balancer info array.

setLogger (LoggerInterface $logger)

Set the PSR-3 logger interface to use for query logging.

setSchemaVars ( $vars)

Set schema variables to be used when streaming commands from SQL files or stdin.

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.For example, "user" can be converted to "myschema.mydbname.user" for convenience. Appearances like user, somedb.user, somedb.someschema.user will used literally.Calling this twice will completely clear any old table aliases. Also, note that callers are responsible for making sure the schemas and databases actually exist.

Parameters

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

Since: 1.28

Stable to override

setTransactionListener ( $name, callable $callback=null)

Run a callback after each time any transaction commits or rolls back.

setTrxEndCallbackSuppression ( $suppress)

Whether to disable running of post-COMMIT/ROLLBACK callbacks.

sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)

Read and execute SQL commands from a file.

sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)

Read and execute commands from an open file handle.

startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)

Begin an atomic section of SQL statements.

strreplace ( $orig, $old, $new)

Returns a SQL expression for simple string replacement (e.g.REPLACE() in mysql)

Parameters

string	$orig	Column to modify
string	$old	Column to seek
string	$new	Column to replace with

Returns: string

Stable to override

tableName ( $name, $format='quoted')

Format a table name ready for use in constructing an SQL query.This does two important things: it quotes the table names to clean them up, and it adds a table prefix if only given a table name with no quotes.All functions of this object which require a table name call this function themselves. Pass the canonical name to such functions. This is only needed when calling query() directly.

Note: This function does not sanitize user input. It is not safe to use this function to escape user input.

Parameters

string	$name	Database table name
string	$format	One of: quoted - Automatically pass the table name through addIdentifierQuotes() so that it can be used in a query. raw - Do not add identifier quotes to the table name

Returns: string Full database name

Stable to override

tableNames (... $tables)

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

tableNamesN (... $tables)

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

Parameters

string	$table
string	$field

Returns: int

Stable to override

timestamp ( $ts=0)

Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.

Parameters

string | int $ts

Returns: string

Stable to override

timestampOrNull ( $ts=null)

Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.

truncate ( $tables, $fname=__METHOD__)

Delete all data in a table(s) and reset any sequences owned by that table(s)

trxLevel ()

Gets the current transaction level.

trxStatus ()

trxTimestamp ()

Get the UNIX timestamp of the time that the transaction was established.

unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])

Construct a UNION query for permutations of conditions.

unionQueries ( $sqls, $all)

Construct a UNION query.This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.

Parameters

array	$sqls	SQL statements to combine
bool	$all	Either IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT

Returns: string SQL fragment

Stable to override

unionSupportsOrderAndLimit ()

Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.

Returns: bool

Stable to override

unlockTables ( $method)

Unlock all tables locked via lockTables()

update ( $table, $set, $conds, $fname=__METHOD__, $options=[])

Update all rows in a table that match a given condition.

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

Upsert the given row(s) into a table.

wasConnectionLoss ()

Determines if the last query error was due to a dropped connection.Note that during a connection loss, the prior transaction will have been lost

Returns: bool

Since: 1.31

Stable to override

wasErrorReissuable ()

Determines if the last query error was due to something outside of the query itself.

writesOrCallbacksPending ()

Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending.

writesPending ()

Public Member Functions inherited from Wikimedia\Rdbms\IDatabase

buildSubString ( $input, $startPosition, $length=null)

Build a SUBSTRING function.

insertId ()

Get the inserted value of an auto-increment row.

lastErrno ()

Get the last error number.

Protected Member Functions
	doGetLag ()
	Stable to override Stable to override

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

	doReplace ( $table, array $uniqueKeys, array $rows, $fname)

	doSelectDomain (DatabaseDomain $domain)
	Stable to override.

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

	doUpsert ( $table, array $rows, array $uniqueKeys, array $set, $fname)

	getApproximateLagStatus ()
	Get a replica DB lag estimate for this server at the start of a transaction.

	getHeartbeatData (array $conds)

	getLagDetectionMethod ()

	getLagFromPtHeartbeat ()

	getLagFromSlaveStatus ()

	getMasterServerInfo ()

	getReplicationSafetyInfo ()

	getServerGTIDs ( $fname=__METHOD__)

	getServerId ()

	getServerRoleStatus ( $role, $fname=__METHOD__)

	getServerUUID ()

	isInsertSelectSafe (array $insertOptions, array $selectOptions)
	Stable to override.

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

	mysqlConnect ( $realServer, $dbName)
	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)

	open ( $server, $user, $password, $dbName, $schema, $tablePrefix)
	Open a new connection to the database (closing any existing one)

	useGTIDs ()

	wasKnownStatementRollbackError ()
	Stable to override.

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

Protected Member Functions inherited from Wikimedia\Rdbms\Database
	assertBuildSubstringParams ( $startPosition, $length)
	Check type and bounds for parameters to self::buildSubstring()

	assertConditionIsNotEmpty ( $conds, string $fname, bool $deprecate)
	Check type and bounds conditions parameters for update.

	assertHasConnectionHandle ()
	Make sure there is an open connection handle (alive or not) as a sanity check.

	assertIsWritableMaster ()
	Make sure that this server is not marked as a replica nor read-only as a sanity check.

	buildSuperlative ( $sqlfunc, $fields, $values)
	Build a superlative function statement comparing columns/values.

	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.

	doDropTable ( $table, $fname)

	doHandleSessionLossPreconnect ()
	Reset any additional subclass trx* and session* fields Stable to override.

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

	doInsert ( $table, array $rows, $fname)

	doInsertNonConflicting ( $table, array $rows, $fname)

	doInsertSelectGeneric ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds)
	Implementation of insertSelect() based on select() and insert()

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

	doQuery ( $sql)
	Run a query and return a DBMS-dependent wrapper or boolean.

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

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

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

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

	doTruncate (array $tables, $fname)

	escapeLikeInternal ( $s, $escapeChar='`')
	Stable to override.

	executeQuery ( $sql, $fname, $flags)
	Execute a query, retrying it if there is a recoverable connection loss.

	extractSingleFieldFromList ( $var)

	fetchAffectedRowCount ()

	fieldHasBit ( $field, $flags)

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

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

	getLastPHPError ()

	getLazyMasterHandle ()
	Get a handle to the master server of the cluster to which this server belongs.

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

	getQueryVerb ( $sql)

	getReadOnlyReason ()

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

	getSchemaVars ()
	Get schema variables.

	getTempTableWrites ( $sql, $pseudoPermanent)

	getTransactionRoundId ()

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

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

	isFlagInOptions ( $option, array $options)

	isPristineTemporaryTable ( $table)
	Check if the table is both a TEMPORARY table and has not yet received CRUD operations.

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

	makeConditionCollidesUponKeys (array $rows, array $uniqueKeys)

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

	makeInsertLists (array $rows)
	Make SQL lists of columns, row tuples for INSERT/VALUES expressions.

	makeInsertNonConflictingVerbAndOptions ()
	Stable to override.

	makeOrderBy ( $options)
	Returns an optional ORDER BY.

	makeSelectOptions (array $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.

	newExceptionAfterConnectError ( $error)

	normalizeConditions ( $conds, $fname)

	normalizeOptions ( $options)

	normalizeRowArray (array $rowOrRows)

	normalizeUpsertKeys ( $uniqueKeys)

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

	registerTempWrites ( $ret, array $changes)

	relationSchemaQualifier ()
	Stable to override.

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

	replaceVars ( $ins)
	Database independent variable replacement.

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

	resultObject ( $result)
	Take a query result and wrap it in an iterable result wrapper if necessary.

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

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

Protected Attributes
bool null	$defaultBigSelects = null

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
integer null	$affectedRowCount
	Rows affected by the last query to query() or its CRUD wrappers.

string	$agent
	Agent name for query profiling.

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

object resource null	$conn
	Database connection.

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

string[] int[] float[]	$connectionVariables
	SQL variables values to use for all new connections.

LoggerInterface	$connLogger

DatabaseDomain	$currentDomain

string	$delimiter = ';'
	Current SQL query delimiter.

callable	$deprecationLogger
	Deprecation logging callback.

callable	$errorLogger
	Error logging callback.

int	$flags
	Current bit field of class DBO_* constants.

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

array	$lbInfo = []
	Current LoadBalancer tracking information.

int	$nonNativeInsertSelectBatchSize
	Row batch size to use for emulated INSERT SELECT queries.

string	$password
	Password used to establish the current connection.

callable null	$profiler

LoggerInterface	$queryLogger

LoggerInterface	$replLogger

array null	$schemaVars
	Current variables use for schema element placeholders.

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

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

array	$sessionNamedLocks = []
	Map of (name => 1) for locks obtained via lock()

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

BagOStuff	$srvCache
	APC cache.

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

string	$topologyRole
	Replication topology role of the server; one of the class ROLE_* constants.

string null	$topologyRootMaster
	Host (or address) of the root master server for the replication topology.

TransactionProfiler	$trxProfiler

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

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

	makeLockName ( $lockName)

Private Attributes
bool null	$insertSelectIsSafe = null

stdClass null	$replicationInfoRow = null

const	SERVER_ID_CACHE_TTL = 86400

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

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

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

Static Protected Member Functions inherited from Wikimedia\Rdbms\Database
static	getAttributes ()
	Stable to override.

Static Protected Attributes inherited from Wikimedia\Rdbms\Database
static int	$DBO_MUTABLE
	Bit field of all DBO_* flags that can be changed after connection.

static string[]	$MUTABLE_FLAGS
	List of DBO_* flags that can be changed after connection.

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.
insertSelectIsSafe : force that native INSERT SELECT is or is not safe [default: null]
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 96 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\useGTIDs().

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\doSelectDomain(), Wikimedia\Rdbms\DatabaseMysqlBase\duplicateTableStructure(), Wikimedia\Rdbms\DatabaseMysqlBase\open(), and Wikimedia\Rdbms\DatabaseMysqlBase\tableExists().

◆ buildIntegerCast()

Wikimedia\Rdbms\DatabaseMysqlBase::buildIntegerCast ( $field )

Parameters

string $field Field or column to cast

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1568 of file DatabaseMysqlBase.php.

◆ buildStringCast()

Wikimedia\Rdbms\DatabaseMysqlBase::buildStringCast ( $field )

Parameters

string $field Field or column to cast

Returns: string

Since: 1.28

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1560 of file DatabaseMysqlBase.php.

◆ dataSeek()

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

Parameters

IResultWrapper \| resource	$res
int	$row

Returns: bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 403 of file DatabaseMysqlBase.php.

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

◆ 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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1331 of file DatabaseMysqlBase.php.

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

◆ doGetLag()

Wikimedia\Rdbms\DatabaseMysqlBase::doGetLag ( )

protected

Stable to override Stable to override

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

◆ doLockTables()

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

protected

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

Stable to override

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 1270 of file DatabaseMysqlBase.php.

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

◆ doReplace()

Wikimedia\Rdbms\DatabaseMysqlBase::doReplace	(		$table,
		array	$uniqueKeys,
		array	$rows,
			$fname
	)

protected

See also: Database::replace() Stable to override

Parameters

string	$table
string[][]	$uniqueKeys	Non-empty list of unique keys
array	$rows	Non-empty list of rows
string	$fname

Since: 1.35

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1361 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\makeInsertLists(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().

◆ doSelectDomain()

Wikimedia\Rdbms\DatabaseMysqlBase::doSelectDomain ( DatabaseDomain $domain )

protected

Stable to override.

Parameters

DatabaseDomain $domain

Exceptions

DBConnectionError
DBError

Since: 1.32

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 181 of file DatabaseMysqlBase.php.

References $res, Wikimedia\Rdbms\DatabaseMysqlBase\addIdentifierQuotes(), Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\DatabaseDomain\getDatabase(), Wikimedia\Rdbms\Database\getDBname(), Wikimedia\Rdbms\DatabaseDomain\getSchema(), Wikimedia\Rdbms\DatabaseDomain\getTablePrefix(), and Wikimedia\Rdbms\Database\reportQueryError().

◆ doUnlockTables()

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

protected

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

Stable to override

Parameters

string $method Name of caller

Returns: true

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1288 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\query().

◆ doUpsert()

Wikimedia\Rdbms\DatabaseMysqlBase::doUpsert	(		$table,
		array	$rows,
		array	$uniqueKeys,
		array	$set,
			$fname
	)

protected

See also: Database::upsert() Stable to override

Parameters

string	$table
array[]	$rows	Non-empty list of rows
string[][]	$uniqueKeys	Non-empty list of unique keys
array	$set
string	$fname

Since: 1.35

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1349 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\makeInsertLists(), Wikimedia\Rdbms\Database\makeList(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\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 1440 of file DatabaseMysqlBase.php.

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

◆ estimateRowCount()

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

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

Parameters

string \| array	$table
string \| array	$var
string \| array	$conds
string	$fname
string \| array	$options
array	$join_conds

Returns: bool|int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 507 of file DatabaseMysqlBase.php.

References $res, Wikimedia\Rdbms\Database\extractSingleFieldFromList(), Wikimedia\Rdbms\Database\normalizeConditions(), Wikimedia\Rdbms\DatabaseMysqlBase\numRows(), and Wikimedia\Rdbms\Database\select().

◆ fetchObject()

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

Parameters

IResultWrapper | resource $res

Returns: stdClass|bool

Exceptions

DBUnexpectedError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 254 of file DatabaseMysqlBase.php.

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

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

◆ fetchRow()

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

Parameters

IResultWrapper | resource $res

Returns: array|bool

Exceptions

DBUnexpectedError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 287 of file DatabaseMysqlBase.php.

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

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

◆ fieldInfo()

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

Parameters

string	$table
string	$field

Returns: bool|MySQLField

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 569 of file DatabaseMysqlBase.php.

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

◆ fieldName()

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

Parameters

IResultWrapper \| resource	$res
int	$n

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 366 of file DatabaseMysqlBase.php.

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

◆ fieldType()

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

mysql_field_type() wrapper

Parameters

IResultWrapper \| resource	$res
int	$n

Returns: string

Definition at line 385 of file DatabaseMysqlBase.php.

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

◆ freeResult()

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

Parameters

IResultWrapper | resource $res

Exceptions

DBUnexpectedError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 232 of file DatabaseMysqlBase.php.

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

◆ getApproximateLagStatus()

Wikimedia\Rdbms\DatabaseMysqlBase::getApproximateLagStatus ( )

protected

Get a replica DB lag estimate for this server at the start of a transaction.

This is a no-op unless the server is known a priori to be a replica DB

Stable to override

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

Since: 1.27

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 827 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 810 of file DatabaseMysqlBase.php.

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

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

◆ 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\doGetLag(), and Wikimedia\Rdbms\DatabaseMysqlBase\getApproximateLagStatus().

◆ getLagFromPtHeartbeat()

Wikimedia\Rdbms\DatabaseMysqlBase::getLagFromPtHeartbeat ( )

protected

Returns: bool|float

Definition at line 702 of file DatabaseMysqlBase.php.

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

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

◆ getLagFromSlaveStatus()

Wikimedia\Rdbms\DatabaseMysqlBase::getLagFromSlaveStatus ( )

protected

Returns: bool|int

Definition at line 684 of file DatabaseMysqlBase.php.

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

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

◆ 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 993 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getServerGTIDs(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerId(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerRoleStatus(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerUUID(), and Wikimedia\Rdbms\DatabaseMysqlBase\useGTIDs().

◆ getMasterServerInfo()

Wikimedia\Rdbms\DatabaseMysqlBase::getMasterServerInfo ( )

protected

Definition at line 765 of file DatabaseMysqlBase.php.

References $cache, Wikimedia\Rdbms\Database\$conn, Wikimedia\Rdbms\Database\$flags, $res, Wikimedia\Rdbms\Database\$srvCache, Wikimedia\Rdbms\Database\getServer(), and BagOStuff\makeGlobalKey().

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 1488 of file DatabaseMysqlBase.php.

References $res, and Wikimedia\Rdbms\Database\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 963 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getServerGTIDs(), Wikimedia\Rdbms\DatabaseMysqlBase\getServerRoleStatus(), and Wikimedia\Rdbms\DatabaseMysqlBase\useGTIDs().

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

◆ getReplicationSafetyInfo()

Wikimedia\Rdbms\DatabaseMysqlBase::getReplicationSafetyInfo ( )

protected

Returns: stdClass Process cached row

Definition at line 478 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\$replicationInfoRow, and Wikimedia\Rdbms\Database\selectRow().

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

◆ getServerGTIDs()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerGTIDs ( $fname = __METHOD__ )

protected

Parameters

string $fname

Returns: string[]

Definition at line 1067 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\$flags, $res, and Wikimedia\Rdbms\Database\query().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getMasterPos(), and Wikimedia\Rdbms\DatabaseMysqlBase\getReplicaPos().

◆ getServerId()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerId ( )

protected

Returns: int

Exceptions

DBQueryError If the variable doesn't exist for some reason

Definition at line 1031 of file DatabaseMysqlBase.php.

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

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

◆ getServerRoleStatus()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerRoleStatus	(	$role,
		$fname = `__METHOD__`
	)

protected

Parameters

string	$role	One of "MASTER"/"SLAVE"
string	$fname

Returns: string[] Latest available server status row

Definition at line 1091 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\$flags, $res, and Wikimedia\Rdbms\Database\query().

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getMasterPos(), and Wikimedia\Rdbms\DatabaseMysqlBase\getReplicaPos().

◆ getServerUptime()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerUptime ( )

Determines how long the server has been up.

Returns: int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1375 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getMysqlStatus().

◆ getServerUUID()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerUUID ( )

protected

Returns: string|null

Definition at line 1048 of file DatabaseMysqlBase.php.

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

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

◆ getServerVersion()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerVersion ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1144 of file DatabaseMysqlBase.php.

References $cache, Wikimedia\Rdbms\Database\$srvCache, BagOStuff\getWithSetCallback(), 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 1126 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getServerVersion().

◆ getType()

Wikimedia\Rdbms\DatabaseMysqlBase::getType ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 117 of file DatabaseMysqlBase.php.

◆ ignoreIndexClause()

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

Parameters

string $index

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1119 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\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 607 of file DatabaseMysqlBase.php.

References $res, Wikimedia\Rdbms\Database\indexName(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\tableName().

◆ isInsertSelectSafe()

Wikimedia\Rdbms\DatabaseMysqlBase::isInsertSelectSafe	(	array	$insertOptions,
		array	$selectOptions
	)

protected

Stable to override.

Parameters

array	$insertOptions	INSERT options
array	$selectOptions	SELECT options

Returns: bool Whether an INSERT SELECT with these options will be replication safe

Since: 1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 452 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getReplicationSafetyInfo().

◆ isQuotedIdentifier()

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

Parameters

string $name

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 662 of file DatabaseMysqlBase.php.

◆ isTransactableQuery()

Wikimedia\Rdbms\DatabaseMysqlBase::isTransactableQuery ( $sql )

protected

Determine whether a SQL statement is sensitive to isolation level.

A SQL statement is considered transactable if its result could vary depending on the transaction isolation level. Operational commands such as 'SET' and 'SHOW' are not considered to be transactable.

Main purpose: Used by query() to decide whether to begin a transaction before the current query (in DBO_TRX mode, on by default).

Stable to override

Parameters

string $sql

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1555 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 \| null	$prefix

Returns: bool

Since: 1.22

Definition at line 1551 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\listViews().

◆ lastError()

Wikimedia\Rdbms\DatabaseMysqlBase::lastError ( )

Returns: string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 419 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 \| null	$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 1461 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\query().

◆ listViews()

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

Lists VIEWs in the database.

Parameters

string \| null	$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 1512 of file DatabaseMysqlBase.php.

References $res, Wikimedia\Rdbms\Database\getDBname(), and Wikimedia\Rdbms\Database\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 1214 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\$flags, $res, Wikimedia\Rdbms\Database\addQuotes(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), Wikimedia\Rdbms\DatabaseMysqlBase\makeLockName(), and Wikimedia\Rdbms\Database\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 1194 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\$flags, $res, Wikimedia\Rdbms\Database\addQuotes(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), Wikimedia\Rdbms\DatabaseMysqlBase\makeLockName(), and Wikimedia\Rdbms\Database\query().

◆ makeLockName()

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

private

Definition at line 1256 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.Note that this does not start any new transactions. If any existing transaction is flushed, and this is called, then queries will reflect the point the DB was synced up to (on success) without interference from REPEATABLE-READ snapshots.

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

Exceptions

DBError If an error occurs, see IDatabase::query()

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 845 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\$flags, $res, Wikimedia\Rdbms\DBMasterPos\__toString(), Wikimedia\Rdbms\Database\addQuotes(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchRow(), Wikimedia\Rdbms\Database\getLogContext(), Wikimedia\Rdbms\DatabaseMysqlBase\getReplicaPos(), and Wikimedia\Rdbms\Database\query().

◆ mysqlConnect()

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

abstractprotected

Open a connection to a MySQL server.

Parameters

string	$realServer
string \| null	$dbName

Returns: mixed|null Driver connection handle

Exceptions

DBConnectionError

Reimplemented in Wikimedia\Rdbms\DatabaseMysqli.

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

◆ mysqlDataSeek()

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

abstractprotected

Move internal result pointer.

Parameters

IResultWrapper \| resource	$res
int	$row

Returns: bool

Reimplemented in Wikimedia\Rdbms\DatabaseMysqli.

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 | null $conn Raw connection

Returns: string

Reimplemented in Wikimedia\Rdbms\DatabaseMysqli.

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

Reimplemented in Wikimedia\Rdbms\DatabaseMysqli.

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

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

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

IResultWrapper \| resource	$res
int	$n

Returns: string

Reimplemented in Wikimedia\Rdbms\DatabaseMysqli.

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

IResultWrapper \| resource	$res
int	$n

Returns: string

Reimplemented in Wikimedia\Rdbms\DatabaseMysqli.

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

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

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

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

◆ mysqlRealEscapeString()

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

abstractprotected

Parameters

string $s

Returns: mixed

Reimplemented in Wikimedia\Rdbms\DatabaseMysqli.

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

◆ namedLocksEnqueue()

Wikimedia\Rdbms\DatabaseMysqlBase::namedLocksEnqueue ( )

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

Returns: bool

Since: 1.26

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1262 of file DatabaseMysqlBase.php.

◆ numFields()

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

Parameters

IResultWrapper | resource $res

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 349 of file DatabaseMysqlBase.php.

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

◆ numRows()

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

Exceptions

DBUnexpectedError

Parameters

IResultWrapper | resource $res

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 320 of file DatabaseMysqlBase.php.

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

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

◆ open()

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

protected

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

Parameters

string \| null	$server	Database server host
string \| null	$user	Database user name
string \| null	$password	Database user password
string \| null	$dbName	Database name
string \| null	$schema	Database schema name
string	$tablePrefix	Table prefix

Exceptions

DBConnectionError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 121 of file DatabaseMysqlBase.php.

◆ serverIsReadOnly()

Wikimedia\Rdbms\DatabaseMysqlBase::serverIsReadOnly ( )

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

Since: 1.28

Stable to override Stable to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1098 of file DatabaseMysqlBase.php.

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

◆ setBigSelects()

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

Parameters

bool $value

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1301 of file DatabaseMysqlBase.php.

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

◆ setSessionOptions()

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

Parameters

array $options

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1163 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\$flags, and Wikimedia\Rdbms\Database\query().

◆ streamStatementEnd()

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

Parameters

string	&$sql
string	&$newLine

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1177 of file DatabaseMysqlBase.php.

◆ strencode()

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

Parameters

string $s

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 636 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

Exceptions

DBError If an error occurs, see IDatabase::query()

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 533 of file DatabaseMysqlBase.php.

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

◆ 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 1266 of file DatabaseMysqlBase.php.

◆ unlock()

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

See https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_release-lock.

Parameters

string	$lockName
string	$method

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1239 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\$flags, $res, Wikimedia\Rdbms\Database\addQuotes(), Wikimedia\Rdbms\DatabaseMysqlBase\fetchObject(), Wikimedia\Rdbms\DatabaseMysqlBase\makeLockName(), and Wikimedia\Rdbms\Database\query().

◆ useGTIDs()

Wikimedia\Rdbms\DatabaseMysqlBase::useGTIDs ( )

protected

Definition at line 1575 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\$useGTIDs.

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\__construct(), Wikimedia\Rdbms\DatabaseMysqlBase\getMasterPos(), and Wikimedia\Rdbms\DatabaseMysqlBase\getReplicaPos().

◆ useIndexClause()

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

Parameters

string $index

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1111 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\indexName().

◆ wasConnectionError()

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

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

Stable to override

Parameters

int | string $errno

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1409 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 1386 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\IDatabase\lastErrno().

◆ wasKnownStatementRollbackError()

Wikimedia\Rdbms\DatabaseMysqlBase::wasKnownStatementRollbackError ( )

protected

Stable to override.

Returns: bool Whether it is known that the last query error only caused statement rollback

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

Since: 1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1413 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\IDatabase\lastErrno(), and Wikimedia\Rdbms\Database\selectRow().

◆ 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 1395 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\IDatabase\lastErrno().

◆ wasQueryTimeout()

Wikimedia\Rdbms\DatabaseMysqlBase::wasQueryTimeout	(	$error,
		$errno
	)

protected

Checks whether the cause of the error is detected to be a timeout.

It returns false by default, and not all engines support detecting this yet. If this returns false, it will be treated as a generic query error.

Stable to override

Parameters

string	$error	Error text
int	$errno	Error number

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 446 of file DatabaseMysqlBase.php.

◆ 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 1404 of file DatabaseMysqlBase.php.

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

Member Data Documentation

◆ $defaultBigSelects

bool null Wikimedia\Rdbms\DatabaseMysqlBase::$defaultBigSelects = null

protected

Definition at line 64 of file DatabaseMysqlBase.php.

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

◆ $insertSelectIsSafe

bool null Wikimedia\Rdbms\DatabaseMysqlBase::$insertSelectIsSafe = null

private

Definition at line 67 of file DatabaseMysqlBase.php.

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

◆ $replicationInfoRow

stdClass null Wikimedia\Rdbms\DatabaseMysqlBase::$replicationInfoRow = null

private

Definition at line 69 of file DatabaseMysqlBase.php.

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

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

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

◆ $utf8Mode

bool Wikimedia\Rdbms\DatabaseMysqlBase::$utf8Mode

protected

Use experimental UTF-8 transmission encoding.

Definition at line 62 of file DatabaseMysqlBase.php.

◆ SERVER_ID_CACHE_TTL

const Wikimedia\Rdbms\DatabaseMysqlBase::SERVER_ID_CACHE_TTL = 86400

private

Definition at line 72 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()

◆ buildIntegerCast()

◆ buildStringCast()

◆ dataSeek()

◆ deleteJoin()

◆ doGetLag()

◆ doLockTables()

◆ doReplace()

◆ doSelectDomain()

◆ doUnlockTables()

◆ doUpsert()

◆ duplicateTableStructure()

◆ estimateRowCount()

◆ fetchObject()

◆ fetchRow()

◆ fieldInfo()

◆ fieldName()

◆ fieldType()

◆ freeResult()

◆ getApproximateLagStatus()

◆ getHeartbeatData()

◆ getLagDetectionMethod()

◆ getLagFromPtHeartbeat()

◆ getLagFromSlaveStatus()

◆ getMasterPos()

◆ getMasterServerInfo()

◆ getMysqlStatus()

◆ getReplicaPos()

◆ getReplicationSafetyInfo()

◆ getServerGTIDs()

◆ getServerId()

◆ getServerRoleStatus()

◆ getServerUptime()

◆ getServerUUID()

◆ getServerVersion()

◆ getSoftwareLink()

◆ getType()

◆ ignoreIndexClause()

◆ indexInfo()

◆ isInsertSelectSafe()

◆ isQuotedIdentifier()

◆ isTransactableQuery()

◆ isView()

◆ lastError()

◆ listTables()

◆ listViews()

◆ lock()

◆ lockIsFree()

◆ makeLockName()

◆ masterPosWait()

◆ mysqlConnect()

◆ mysqlDataSeek()

◆ mysqlError()

◆ mysqlFetchArray()

◆ mysqlFetchField()

◆ mysqlFetchObject()

◆ mysqlFieldName()

◆ mysqlFieldType()

◆ mysqlFreeResult()

◆ mysqlNumFields()

◆ mysqlNumRows()

◆ mysqlRealEscapeString()

◆ namedLocksEnqueue()

◆ numFields()

◆ numRows()

◆ open()

◆ serverIsReadOnly()

◆ setBigSelects()

◆ setSessionOptions()

◆ streamStatementEnd()