Database abstraction object for PHP extension mysqli. More...

Inheritance diagram for Wikimedia\Rdbms\DatabaseMysqli:

[legend]

Collaboration diagram for Wikimedia\Rdbms\DatabaseMysqli:

[legend]

Public Member Functions
	__toString ()
	Give an id for the connection.

	insertId ()

	lastErrno ()

Public Member Functions inherited from Wikimedia\Rdbms\DatabaseMysqlBase
	__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.

	buildIntegerCast ( $field)

	buildStringCast ( $field)

	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, $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)

	getLag ()
	Get the amount of replication lag for this database server.

	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)

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

	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, $uniqueIndexes, array $set, $fname=__METHOD__)
	INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.

	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.

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

	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.

	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)

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

	buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
	Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery.

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

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

	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, $cancelable=self::ATOMIC_NOT_CANCELABLE)
	Perform an atomic section of reversable SQL statements from a callback.

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

	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.

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

	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.

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

	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=0)
	Run an SQL query and return the result.

	reportConnectionError ( $error='Unknown error')

	reportQueryError ( $error, $errno, $sql, $fname, $ignoreErrors=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 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=[])
	Single row SELECT wrapper.

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

	setIndexAliases (array $aliases)
	Convert certain index names to alternative names before querying the DB.

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

	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.

	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.

	wasConnectionLoss ()
	Determines if the last query error was due to a dropped connection.

	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.

Protected Member Functions
	closeConnection ()

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

	doQuery ( $sql)

	fetchAffectedRowCount ()

	getBindingHandle ()

	mysqlConnect ( $realServer, $dbName)

	mysqlDataSeek ( $res, $row)

	mysqlError ( $conn=null)

	mysqlFetchArray ( $res)

	mysqlFetchField ( $res, $n)

	mysqlFetchObject ( $res)

	mysqlFieldName ( $res, $n)

	mysqlFieldType ( $res, $n)

	mysqlFreeResult ( $res)

	mysqlNumFields ( $res)

	mysqlNumRows ( $res)

	mysqlRealEscapeString ( $s)
	Escapes special characters in a string for use in an SQL statement.

	mysqlSetCharset ( $charset)

Protected Member Functions inherited from Wikimedia\Rdbms\DatabaseMysqlBase
	doLockTables (array $read, array $write, $method)
	Helper function for lockTables() that handles the actual table locking.

	doSelectDomain (DatabaseDomain $domain)

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

	getReplicationSafetyInfo ()

	getServerGTIDs ( $fname=__METHOD__)

	getServerId ()

	getServerRoleStatus ( $role, $fname=__METHOD__)

	getServerUUID ()

	isInsertSelectSafe (array $insertOptions, array $selectOptions)

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

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

	useGTIDs ()

	wasKnownStatementRollbackError ()

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

	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.

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

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

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

	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.

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

	extractSingleFieldFromList ( $var)

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

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

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

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

	getSchemaVars ()
	Get schema variables.

	getTransactionRoundId ()

	hasFlags ( $field, $flags)

	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.

	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.

	nonNativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
	Implementation of insertSelect() based on select() and insert()

	normalizeConditions ( $conds, $fname)

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

	registerTempTableWrite ( $sql, $pseudoPermanent)

	relationSchemaQualifier ()

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

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

static	factory ( $dbType, $p=[], $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.

Public Attributes inherited from Wikimedia\Rdbms\DatabaseMysqlBase
const	SERVER_ID_CACHE_TTL = 86400

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.

static	getAttributes ()

Protected Attributes inherited from Wikimedia\Rdbms\DatabaseMysqlBase
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 = null
	Database connection.

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

LoggerInterface	$connLogger

DatabaseDomain	$currentDomain

string	$delimiter = ';'

callable	$deprecationLogger
	Deprecation logging callback.

callable	$errorLogger
	Error logging callback.

int	$flags

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

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

float	$lastPing = 0.0
	UNIX timestamp.

string	$lastQuery = ''
	SQL query.

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

array	$lbInfo = []

int	$nonNativeInsertSelectBatchSize = 10000

bool	$opened = false

string	$password
	Password used to establish the current connection.

string bool	$phpError = false

array null	$preparedArgs

callable null	$profiler

LoggerInterface	$queryLogger

array bool	$schemaVars = false

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

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

array	$sessionVars = []

BagOStuff	$srvCache
	APC cache.

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

array[]	$trxEndCallbacks = []
	List of (callable, method name, atomic section id)

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

array[]	$trxIdleCallbacks = []
	List of (callable, method name, atomic section id)

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

array[]	$trxPreCommitCallbacks = []
	List of (callable, method name, atomic section id)

TransactionProfiler	$trxProfiler

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

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

int	$trxStatus = self::STATUS_TRX_NONE
	Transaction status.

Exception null	$trxStatusCause
	The last error that caused the status to become STATUS_TRX_ERROR.

array null	$trxStatusIgnoredCause
	If wasKnownStatementRollbackError() prevented trxStatus from being set, the relevant details are stored here.

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

Detailed Description

Database abstraction object for PHP extension mysqli.

Since: 1.22

See also: Database

Definition at line 37 of file DatabaseMysqli.php.

Member Function Documentation

◆ __toString()

Wikimedia\Rdbms\DatabaseMysqli::__toString ( )

Give an id for the connection.

mysql driver used resource id, but mysqli objects cannot be cast to string.

Returns: string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 316 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\$conn.

◆ closeConnection()

Wikimedia\Rdbms\DatabaseMysqli::closeConnection ( )

protected

Returns: bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 146 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\$conn, and Wikimedia\Rdbms\DatabaseMysqli\getBindingHandle().

◆ connectInitCharset()

Wikimedia\Rdbms\DatabaseMysqli::connectInitCharset ( )

protected

Set the character set information right after connection.

Returns: bool

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 128 of file DatabaseMysqli.php.

◆ doQuery()

Wikimedia\Rdbms\DatabaseMysqli::doQuery ( $sql )

protected

Parameters

string $sql

Returns: mysqli_result|bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 42 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\$conn, $ret, Wikimedia\Rdbms\Database\bufferResults(), and Wikimedia\Rdbms\DatabaseMysqli\getBindingHandle().

◆ fetchAffectedRowCount()

Wikimedia\Rdbms\DatabaseMysqli::fetchAffectedRowCount ( )

protected

Returns: int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 175 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\$conn, and Wikimedia\Rdbms\DatabaseMysqli\getBindingHandle().

◆ getBindingHandle()

Wikimedia\Rdbms\DatabaseMysqli::getBindingHandle ( )

protected

Returns: mysqli

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 328 of file DatabaseMysqli.php.

Referenced by Wikimedia\Rdbms\DatabaseMysqli\closeConnection(), Wikimedia\Rdbms\DatabaseMysqli\doQuery(), Wikimedia\Rdbms\DatabaseMysqli\fetchAffectedRowCount(), Wikimedia\Rdbms\DatabaseMysqli\insertId(), Wikimedia\Rdbms\DatabaseMysqli\mysqlRealEscapeString(), and Wikimedia\Rdbms\DatabaseMysqli\mysqlSetCharset().

◆ insertId()

Wikimedia\Rdbms\DatabaseMysqli::insertId ( )

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 155 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\$conn, and Wikimedia\Rdbms\DatabaseMysqli\getBindingHandle().

◆ lastErrno()

Wikimedia\Rdbms\DatabaseMysqli::lastErrno ( )

Returns: int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 164 of file DatabaseMysqli.php.

◆ mysqlConnect()

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

protected

Parameters

string	$realServer
string \| null	$dbName

Returns: bool|mysqli

Exceptions

DBConnectionError

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 60 of file DatabaseMysqli.php.

References list, and IP\splitHostAndPort().

◆ mysqlDataSeek()

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

protected

Parameters

mysqli_result	$res
int	$row

Returns: mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 283 of file DatabaseMysqli.php.

References $res.

◆ mysqlError()

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

protected

Parameters

mysqli | null $conn Optional connection object

Returns: string

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 291 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\$conn.

◆ mysqlFetchArray()

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

protected

Parameters

mysqli_result $res

Returns: bool

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 208 of file DatabaseMysqli.php.

References $res.

◆ mysqlFetchField()

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

protected

Parameters

mysqli_result	$res
int	$n

Returns: mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 238 of file DatabaseMysqli.php.

References $res.

◆ mysqlFetchObject()

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

protected

Parameters

mysqli_result $res

Returns: stdClass|bool

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 195 of file DatabaseMysqli.php.

References $res.

◆ mysqlFieldName()

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

protected

Parameters

mysqli_result	$res
int	$n

Returns: mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 261 of file DatabaseMysqli.php.

References $res.

◆ mysqlFieldType()

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

protected

Parameters

mysqli_result	$res
int	$n

Returns: mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 272 of file DatabaseMysqli.php.

References $res.

◆ mysqlFreeResult()

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

protected

Parameters

mysqli_result $res

Returns: bool

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 185 of file DatabaseMysqli.php.

References $res.

◆ mysqlNumFields()

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

protected

Parameters

mysqli_result $res

Returns: mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 229 of file DatabaseMysqli.php.

References $res.

◆ mysqlNumRows()

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

protected

Parameters

mysqli_result $res

Returns: mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 221 of file DatabaseMysqli.php.

References $res.

◆ mysqlRealEscapeString()

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

protected

Escapes special characters in a string for use in an SQL statement.

Parameters

string $s

Returns: string

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 304 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\$conn, $s, and Wikimedia\Rdbms\DatabaseMysqli\getBindingHandle().

◆ mysqlSetCharset()

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

protected

Parameters

string $charset

Returns: bool

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 137 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\$conn, and Wikimedia\Rdbms\DatabaseMysqli\getBindingHandle().

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

includes/libs/rdbms/database/DatabaseMysqli.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ __toString()

◆ closeConnection()

◆ connectInitCharset()

◆ doQuery()

◆ fetchAffectedRowCount()

◆ getBindingHandle()

◆ insertId()

◆ lastErrno()

◆ mysqlConnect()

◆ mysqlDataSeek()

◆ mysqlError()

◆ mysqlFetchArray()

◆ mysqlFetchField()

◆ mysqlFetchObject()

◆ mysqlFieldName()

◆ mysqlFieldType()

◆ mysqlFreeResult()

◆ mysqlNumFields()

◆ mysqlNumRows()

◆ mysqlRealEscapeString()

◆ mysqlSetCharset()