MediaWiki  master
Wikimedia\Rdbms\DatabaseMysqlBase Class Reference

Database abstraction object for MySQL. More...

Inheritance diagram for Wikimedia\Rdbms\DatabaseMysqlBase:
Collaboration diagram for Wikimedia\Rdbms\DatabaseMysqlBase:

Public Member Functions

 __construct (array $params)
 Additional $params include: More...
 
 addIdentifierQuotes ( $s)
 MySQL uses backticks for identifier quoting instead of the sql standard "double quotes". More...
 
 addQuotes ( $s)
 Adds quotes and backslashes. More...
 
 buildIntegerCast ( $field)
 
 buildStringCast ( $field)
 
 dataSeek ( $res, $row)
 
 deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
 DELETE where the condition is a join. More...
 
 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() More...
 
 fetchObject ( $res)
 
 fetchRow ( $res)
 
 fieldInfo ( $table, $field)
 
 fieldName ( $res, $n)
 
 fieldType ( $res, $n)
 mysql_field_type() wrapper More...
 
 freeResult ( $res)
 
 getLag ()
 Get the amount of replication lag for this database server. More...
 
 getMasterPos ()
 Get the position of the master from SHOW MASTER STATUS. More...
 
 getReplicaPos ()
 Get the position of the master from SHOW SLAVE STATUS. More...
 
 getServerUptime ()
 Determines how long the server has been up. More...
 
 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. More...
 
 isQuotedIdentifier ( $name)
 
 isView ( $name, $prefix=null)
 Differentiates between a TABLE and a VIEW. More...
 
 lastError ()
 
 listTables ( $prefix=null, $fname=__METHOD__)
 List all tables on the database. More...
 
 listViews ( $prefix=null, $fname=__METHOD__)
 Lists VIEWs in the database. More...
 
 lock ( $lockName, $method, $timeout=5)
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is available. More...
 
 lowPriorityOption ()
 
 masterPosWait (DBMasterPos $pos, $timeout)
 Wait for the replica DB to catch up to a given master position. More...
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues. More...
 
 numFields ( $res)
 
 numRows ( $res)
 
 replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
 REPLACE query wrapper. More...
 
 serverIsReadOnly ()
 
 setBigSelects ( $value=true)
 
 setSessionOptions (array $options)
 
 streamStatementEnd (&$sql, &$newLine)
 
 strencode ( $s)
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 tableLocksHaveTransactionScope ()
 Checks if table locks acquired by lockTables() are transaction-bound in their scope. More...
 
 unlock ( $lockName, $method)
 FROM MYSQL DOCS: https://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock. More...
 
 upsert ( $table, array $rows, $uniqueIndexes, array $set, $fname=__METHOD__)
 INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. More...
 
 useIndexClause ( $index)
 
 wasConnectionError ( $errno)
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock. More...
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout. More...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. More...
 
- Public Member Functions inherited from Wikimedia\Rdbms\Database
 __clone ()
 Make sure that copies do not share the same client binding handle. More...
 
 __destruct ()
 Run a few simple sanity checks and close dangling connections. More...
 
 __sleep ()
 Called by serialize. More...
 
 __toString ()
 
 addIdentifierQuotes ( $s)
 Quotes an identifier, in order to make user controlled input safe. More...
 
 addQuotes ( $s)
 Adds quotes and backslashes. More...
 
 affectedRows ()
 Get the number of rows affected by the last write query. More...
 
 aggregateValue ( $valuedata, $valuename='value')
 Return aggregated value alias. More...
 
 anyChar ()
 Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More...
 
 anyString ()
 Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More...
 
 assertNoOpenTransactions ()
 Assert that all explicit transactions or atomic sections have been closed. More...
 
 begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
 Begin a transaction. More...
 
 bitAnd ( $fieldLeft, $fieldRight)
 
 bitNot ( $field)
 
 bitOr ( $fieldLeft, $fieldRight)
 
 bufferResults ( $buffer=null)
 Turns buffering of SQL result sets on (true) or off (false). More...
 
 buildConcat ( $stringList)
 Build a concatenation list to feed into a SQL query. More...
 
 buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query. More...
 
 buildIntegerCast ( $field)
 
 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(). More...
 
 buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery. More...
 
 buildStringCast ( $field)
 
 buildSubstring ( $input, $startPosition, $length=null)
 
 cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
 Cancel an atomic section of SQL statements. More...
 
 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection. More...
 
 close ()
 Close the database connection. More...
 
 commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commits a transaction previously started using begin(). More...
 
 conditional ( $cond, $trueVal, $falseVal)
 Returns an SQL expression for a simple conditional. More...
 
 connectionErrorLogger ( $errno, $errstr)
 Error handler for logging errors during database connection This method should not be used outside of Database classes. More...
 
 databasesAreIndependent ()
 Returns true if DBs are assumed to be on potentially different servers. More...
 
 dbSchema ( $schema=null)
 Get/set the db schema. More...
 
 deadlockLoop ()
 Perform a deadlock-prone transaction. More...
 
 decodeBlob ( $b)
 Some DBMSs return a special placeholder object representing blob fields in result objects. More...
 
 decodeExpiry ( $expiry, $format=TS_MW)
 Decode an expiry time into a DBMS independent format. More...
 
 delete ( $table, $conds, $fname=__METHOD__)
 DELETE query wrapper. More...
 
 deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
 DELETE where the condition is a join. More...
 
 doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Perform an atomic section of reversable SQL statements from a callback. More...
 
 doneWrites ()
 Returns true if the connection may have been used for write queries. More...
 
 dropTable ( $tableName, $fName=__METHOD__)
 Delete a table. More...
 
 duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
 Creates a new table with structure copied from existing table. More...
 
 encodeBlob ( $b)
 Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted. More...
 
 encodeExpiry ( $expiry)
 Encode an expiry time into the DBMS dependent format. More...
 
 endAtomic ( $fname=__METHOD__)
 Ends an atomic section of SQL statements. More...
 
 estimateRowCount ( $table, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Estimate the number of rows in dataset. More...
 
 explicitTrxActive ()
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. More...
 
 flushSnapshot ( $fname=__METHOD__)
 Commit any transaction but error out if writes or callbacks are pending. More...
 
 freeResult ( $res)
 Free a result object returned by query() or select(). More...
 
 getDBname ()
 Get the current DB name. More...
 
 getDomainID ()
 Return the currently selected domain ID. More...
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is. More...
 
 getLag ()
 Get the amount of replication lag for this database server. More...
 
 getLBInfo ( $name=null)
 Get properties passed down from the server info array of the load balancer. More...
 
 getMasterPos ()
 Get the position of this master. More...
 
 getProperty ( $name)
 
 getReplicaPos ()
 Get the replication position of this replica DB. More...
 
 getScopedLockAndFlush ( $lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More...
 
 getServer ()
 Get the server hostname or IP address. More...
 
 getServerInfo ()
 A string describing the current software version, and possibly other details in a user-friendly way. More...
 
 getServerUptime ()
 Determines how long the server has been up. More...
 
 getSessionLagStatus ()
 Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More...
 
 getWikiID ()
 Alias for getDomainID() More...
 
 ignoreIndexClause ( $index)
 IGNORE INDEX clause. More...
 
 implicitGroupby ()
 Returns true if this database does an implicit sort when doing GROUP BY. More...
 
 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. More...
 
 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. More...
 
 indexInfo ( $table, $index, $fname=__METHOD__)
 Get information about an index into an object. More...
 
 indexUnique ( $table, $index)
 Determines if a given index is unique. More...
 
 initConnection ()
 Initialize the connection to the database over the wire (or to local files) More...
 
 insert ( $table, $a, $fname=__METHOD__, $options=[])
 INSERT wrapper, inserts an array into a table. More...
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 INSERT SELECT wrapper. More...
 
 isOpen ()
 Is a connection to the database open? More...
 
 isQuotedIdentifier ( $name)
 Returns if the given identifier looks quoted or not according to the database convention for quoting identifiers . More...
 
 isReadOnly ()
 
 lastDoneWrites ()
 Returns the last time the connection may have been used for write queries. More...
 
 lastQuery ()
 Return the last query that sent on account of IDatabase::query() More...
 
 limitResult ( $sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset. More...
 
 listTables ( $prefix=null, $fname=__METHOD__)
 List all tables on the database. More...
 
 listViews ( $prefix=null, $fname=__METHOD__)
 Lists all the VIEWs in the database. More...
 
 lock ( $lockName, $method, $timeout=5)
 Acquire a named lock. More...
 
 lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Lock all rows meeting the given conditions/options FOR UPDATE. More...
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is not locked by any thread (non-blocking) More...
 
 lockTables (array $read, array $write, $method)
 Lock specific tables. More...
 
 makeList ( $a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array. More...
 
 makeWhereFrom2d ( $data, $baseKey, $subKey)
 Build a partial where clause from a 2-d array such as used for LinkBatch. More...
 
 masterPosWait (DBMasterPos $pos, $timeout)
 Wait for the replica DB to catch up to a given master position. More...
 
 maxListLen ()
 Return the maximum number of items allowed in a list, or 0 for unlimited. More...
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues. More...
 
 nextSequenceValue ( $seqName)
 Deprecated method, calls should be removed. More...
 
 onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback as soon as there is no transaction pending. More...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Alias for onTransactionCommitOrIdle() for backwards-compatibility. More...
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none. More...
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback as soon as the current transaction commits or rolls back. More...
 
 pendingWriteAndCallbackCallers ()
 List the methods that have write queries or callbacks for the current transaction. More...
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction. More...
 
 pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction. More...
 
 pendingWriteRowsAffected ()
 Get the number of affected rows from pending write queries. More...
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection. More...
 
 preCommitCallbacksPending ()
 
 query ( $sql, $fname=__METHOD__, $flags=0)
 Run an SQL query and return the result. More...
 
 replace ( $table, $uniqueIndexes, $rows, $fname=__METHOD__)
 REPLACE query wrapper. More...
 
 reportConnectionError ( $error='Unknown error')
 
 reportQueryError ( $error, $errno, $sql, $fname, $ignore=false)
 Report a query error. More...
 
 restoreFlags ( $state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call. More...
 
 rollback ( $fname=__METHOD__, $flush='')
 Rollback a transaction previously started using begin(). More...
 
 runOnTransactionIdleCallbacks ( $trigger)
 Actually consume and run any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually consume and run any "on transaction pre-commit" callbacks. More...
 
 runTransactionListenerCallbacks ( $trigger)
 Actually run any "transaction listener" callbacks. More...
 
 select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided. More...
 
 selectDB ( $db)
 Change the current database. More...
 
 selectDomain ( $domain)
 Set the current domain (database, schema, and table prefix) More...
 
 selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a list of single field values from result rows. More...
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Single row SELECT wrapper. More...
 
 selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Get the number of rows in dataset. More...
 
 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. More...
 
 serverIsReadOnly ()
 
 setBigSelects ( $value=true)
 Allow or deny "big selects" for this session only. More...
 
 setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Set a flag for this connection. More...
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB. More...
 
 setLazyMasterHandle (IDatabase $conn)
 Set a lazy-connecting DB handle to the master DB (for replication status purposes) More...
 
 setLBInfo ( $name, $value=null)
 Set the LB info array, or a member of it. More...
 
 setLogger (LoggerInterface $logger)
 Set the PSR-3 logger interface to use for query logging. More...
 
 setSchemaVars ( $vars)
 Set variables to be used in sourceFile/sourceStream, in preference to the ones in $GLOBALS. More...
 
 setSessionOptions (array $options)
 Override database's default behavior. More...
 
 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. More...
 
 setTransactionListener ( $name, callable $callback=null)
 Run a callback after each time any transaction commits or rolls back. More...
 
 setTrxEndCallbackSuppression ( $suppress)
 Whether to disable running of post-COMMIT/ROLLBACK callbacks. More...
 
 sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
 Read and execute SQL commands from a file. More...
 
 sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
 Read and execute commands from an open file handle. More...
 
 startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Begin an atomic section of SQL statements. More...
 
 streamStatementEnd (&$sql, &$newLine)
 Called by sourceStream() to check if we've reached a statement end. More...
 
 strencode ( $s)
 Wrapper for addslashes() More...
 
 strreplace ( $orig, $old, $new)
 Returns a command for str_replace function in SQL query. More...
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 tableLocksHaveTransactionScope ()
 Checks if table locks acquired by lockTables() are transaction-bound in their scope. More...
 
 tableName ( $name, $format='quoted')
 Format a table name ready for use in constructing an SQL query. More...
 
 tableNames ()
 Fetch a number of table names into an array This is handy when you need to construct SQL for joins. More...
 
 tableNamesN ()
 Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins. More...
 
 tablePrefix ( $prefix=null)
 Get/set the table prefix. More...
 
 textFieldSize ( $table, $field)
 Returns the size of a text field, or -1 for "unlimited". More...
 
 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. More...
 
 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. More...
 
 trxLevel ()
 Gets the current transaction level. More...
 
 trxStatus ()
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established. More...
 
 unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Construct a UNION query for permutations of conditions. More...
 
 unionQueries ( $sqls, $all)
 Construct a UNION query This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax. More...
 
 unionSupportsOrderAndLimit ()
 Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries within the UNION construct. More...
 
 unlock ( $lockName, $method)
 Release a lock. More...
 
 unlockTables ( $method)
 Unlock all tables locked via lockTables() More...
 
 update ( $table, $values, $conds, $fname=__METHOD__, $options=[])
 UPDATE wrapper. More...
 
 upsert ( $table, array $rows, $uniqueIndexes, array $set, $fname=__METHOD__)
 INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table. More...
 
 useIndexClause ( $index)
 USE INDEX clause. More...
 
 wasConnectionError ( $errno)
 Do not use this method outside of Database/DBError classes. More...
 
 wasConnectionLoss ()
 Determines if the last query error was due to a dropped connection. More...
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock. More...
 
 wasErrorReissuable ()
 Determines if the last query error was due to something outside of the query itself. More...
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout. More...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. More...
 
 writesOrCallbacksPending ()
 Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. More...
 
 writesPending ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\IDatabase
 buildSubString ( $input, $startPosition, $length=null)
 Build a SUBSTRING function. More...
 
 insertId ()
 Get the inserted value of an auto-increment row. More...
 
 lastErrno ()
 Get the last error number. More...
 

Public Attributes

const SERVER_ID_CACHE_TTL = 86400
 
- Public Attributes inherited from Wikimedia\Rdbms\Database
const DEADLOCK_DELAY_MAX = 1500000
 Maximum time to wait before retry. More...
 
const DEADLOCK_DELAY_MIN = 500000
 Minimum time to wait before retry, in microseconds. More...
 
const DEADLOCK_TRIES = 4
 Number of times to re-try an operation in case of deadlock. More...
 
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. More...
 
const SLOW_WRITE_SEC = 0.500
 
const SMALL_WRITE_ROWS = 100
 
const TINY_WRITE_SEC = 0.010
 

Protected Member Functions

 connectInitCharset ()
 Set the character set information right after connection. More...
 
 doLockTables (array $read, array $write, $method)
 
 doSelectDomain (DatabaseDomain $domain)
 
 doUnlockTables ( $method)
 
 getApproximateLagStatus ()
 
 getHeartbeatData (array $conds)
 
 getLagDetectionMethod ()
 
 getLagFromPtHeartbeat ()
 
 getLagFromSlaveStatus ()
 
 getMasterServerInfo ()
 
 getReplicationSafetyInfo ()
 
 getServerGTIDs ( $fname=__METHOD__)
 
 getServerId ()
 
 getServerRoleStatus ( $role, $fname=__METHOD__)
 
 getServerUUID ()
 
 isInsertSelectSafe (array $insertOptions, array $selectOptions)
 
 isTransactableQuery ( $sql)
 
 mysqlConnect ( $realServer, $dbName)
 Open a connection to a MySQL server. More...
 
 mysqlDataSeek ( $res, $row)
 Move internal result pointer. More...
 
 mysqlError ( $conn=null)
 Returns the text of the error message from previous MySQL operation. More...
 
 mysqlFetchArray ( $res)
 Fetch a result row as an associative and numeric array. More...
 
 mysqlFetchField ( $res, $n)
 Get column information from a result. More...
 
 mysqlFetchObject ( $res)
 Fetch a result row as an object. More...
 
 mysqlFieldName ( $res, $n)
 Get the name of the specified field in a result. More...
 
 mysqlFieldType ( $res, $n)
 Get the type of the specified field in a result. More...
 
 mysqlFreeResult ( $res)
 Free result memory. More...
 
 mysqlNumFields ( $res)
 Get number of fields in result. More...
 
 mysqlNumRows ( $res)
 Get number of rows in result. More...
 
 mysqlRealEscapeString ( $s)
 
 mysqlSetCharset ( $charset)
 Set the character set of the MySQL link. More...
 
 open ( $server, $user, $password, $dbName, $schema, $tablePrefix)
 
 useGTIDs ()
 
 wasKnownStatementRollbackError ()
 
 wasQueryTimeout ( $error, $errno)
 
- Protected Member Functions inherited from Wikimedia\Rdbms\Database
 __construct (array $params)
 
 assertBuildSubstringParams ( $startPosition, $length)
 Check type and bounds for parameters to self::buildSubstring() More...
 
 assertHasConnectionHandle ()
 Make sure there is an open connection handle (alive or not) as a sanity check. More...
 
 assertIsWritableMaster ()
 Make sure that this server is not marked as a replica nor read-only as a sanity check. More...
 
 closeConnection ()
 Closes underlying database connection. More...
 
 doBegin ( $fname)
 Issues the BEGIN command to the database server. More...
 
 doCommit ( $fname)
 Issues the COMMIT command to the database server. More...
 
 doInitConnection ()
 Actually connect to the database over the wire (or to local files) More...
 
 doLockTables (array $read, array $write, $method)
 Helper function for lockTables() that handles the actual table locking. More...
 
 doQuery ( $sql)
 Run a query and return a DBMS-dependent wrapper or boolean. More...
 
 doReleaseSavepoint ( $identifier, $fname)
 Release a savepoint. More...
 
 doRollback ( $fname)
 Issues the ROLLBACK command to the database server. More...
 
 doRollbackToSavepoint ( $identifier, $fname)
 Rollback to a savepoint. More...
 
 doSavepoint ( $identifier, $fname)
 Create a savepoint. More...
 
 doSelectDomain (DatabaseDomain $domain)
 
 doUnlockTables ( $method)
 Helper function for unlockTables() that handles the actual table unlocking. More...
 
 escapeLikeInternal ( $s, $escapeChar='`')
 
 extractSingleFieldFromList ( $var)
 
 fetchAffectedRowCount ()
 
 fieldNamesWithAlias ( $fields)
 Gets an array of aliased field names. More...
 
 fieldNameWithAlias ( $name, $alias=false)
 Get an aliased field name e.g. More...
 
 getApproximateLagStatus ()
 Get a replica DB lag estimate for this server. More...
 
 getBindingHandle ()
 Get the underlying binding connection handle. More...
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars(). More...
 
 getLastPHPError ()
 
 getLazyMasterHandle ()
 
 getLogContext (array $extras=[])
 Create a log context to pass to PSR-3 logger functions. More...
 
 getQueryVerb ( $sql)
 
 getReadOnlyReason ()
 
 getRecordedTransactionLagStatus ()
 Get the replica DB lag when the current transaction started. More...
 
 getSchemaVars ()
 Get schema variables. More...
 
 getTransactionRoundId ()
 
 hasFlags ( $field, $flags)
 
 indexName ( $index)
 Allows for index remapping in queries where this is not consistent across DBMS. More...
 
 installErrorHandler ()
 Set a custom error handler for logging errors during database connection. More...
 
 isInsertSelectSafe (array $insertOptions, array $selectOptions)
 
 isTransactableQuery ( $sql)
 Determine whether a SQL statement is sensitive to isolation level. More...
 
 isWriteQuery ( $sql)
 Determine whether a query writes to the DB. More...
 
 makeGroupByWithHaving ( $options)
 Returns an optional GROUP BY with an optional HAVING. More...
 
 makeInsertOptions ( $options)
 Helper for Database::insert(). More...
 
 makeOrderBy ( $options)
 Returns an optional ORDER BY. More...
 
 makeSelectOptions ( $options)
 Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. More...
 
 makeUpdateOptions ( $options)
 Make UPDATE options for the Database::update function. More...
 
 makeUpdateOptionsArray ( $options)
 Make UPDATE options array for Database::makeUpdateOptions. More...
 
 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. More...
 
 nativeReplace ( $table, $rows, $fname)
 REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More...
 
 nonNativeInsertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 Implementation of insertSelect() based on select() and insert() More...
 
 normalizeConditions ( $conds, $fname)
 
 open ( $server, $user, $password, $dbName, $schema, $tablePrefix)
 Open a new connection to the database (closing any existing one) More...
 
 qualifiedTableComponents ( $name)
 Get the table components needed for a query given the currently selected database. More...
 
 registerTempTableWrite ( $sql, $pseudoPermanent)
 
 relationSchemaQualifier ()
 
 replaceLostConnection ( $fname)
 Close any existing (dead) database connection and open a new connection. More...
 
 replaceVars ( $ins)
 Database independent variable replacement. More...
 
 restoreErrorHandler ()
 Restore the previous error handler and return the last PHP error for this DB. More...
 
 resultObject ( $result)
 Take the result from a query, and wrap it in a ResultWrapper if necessary. More...
 
 tableNamesWithAlias ( $tables)
 Gets an array of aliased table names. More...
 
 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. More...
 
 tableNameWithAlias ( $table, $alias=false)
 Get an aliased table name. More...
 
 wasKnownStatementRollbackError ()
 
 wasQueryTimeout ( $error, $errno)
 Checks whether the cause of the error is detected to be a timeout. More...
 

Protected Attributes

bool null $defaultBigSelects = null
 
string $lagDetectionMethod
 Method to detect replica DB lag. More...
 
array $lagDetectionOptions = []
 Method to detect replica DB lag. More...
 
MysqlMasterPos $lastKnownReplicaPos
 
string $sqlMode
 sql_mode value to send on connection More...
 
string null $sslCAFile
 
string null $sslCAPath
 
string null $sslCertPath
 
string [] null $sslCiphers
 
string null $sslKeyPath
 
bool $useGTIDs = false
 bool Whether to use GTID methods More...
 
bool $utf8Mode
 Use experimental UTF-8 transmission encoding. More...
 
- Protected Attributes inherited from Wikimedia\Rdbms\Database
integer null $affectedRowCount
 Rows affected by the last query to query() or its CRUD wrappers. More...
 
string $agent
 Agent name for query profiling. More...
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
object resource null $conn = null
 Database connection. More...
 
array $connectionParams = []
 Parameters used by initConnection() to establish a connection. More...
 
LoggerInterface $connLogger
 
DatabaseDomain $currentDomain
 
string $delimiter = ';'
 
callable $deprecationLogger
 Deprecation logging callback. More...
 
callable $errorLogger
 Error logging callback. More...
 
int $flags
 
string bool null $htmlErrors
 Stashed value of html_errors INI setting. More...
 
string [] $indexAliases = []
 Map of (index alias => index) More...
 
float $lastPing = 0.0
 UNIX timestamp. More...
 
array $lbInfo = []
 
int $nonNativeInsertSelectBatchSize = 10000
 
bool $opened = false
 
string $password
 Password used to establish the current connection. More...
 
array null $preparedArgs
 
callable null $profiler
 
LoggerInterface $queryLogger
 
array bool $schemaVars = false
 
string $server
 Server that this instance is currently connected to. More...
 
array $sessionTempTables = []
 Map of (table name => 1) for TEMPORARY tables. More...
 
array $sessionVars = []
 
BagOStuff $srvCache
 APC cache. More...
 
array [] $tableAliases = []
 Map of (table => (dbname, schema, prefix) map) More...
 
array [] $trxEndCallbacks = []
 List of (callable, method name, atomic section id) More...
 
bool $trxEndCallbacksSuppressed = false
 Whether to suppress triggering of transaction end callbacks. More...
 
array [] $trxIdleCallbacks = []
 List of (callable, method name, atomic section id) More...
 
int $trxLevel = 0
 Either 1 if a transaction is active or 0 otherwise. More...
 
array [] $trxPreCommitCallbacks = []
 List of (callable, method name, atomic section id) More...
 
TransactionProfiler $trxProfiler
 
callable [] $trxRecurringCallbacks = []
 Map of (name => callable) More...
 
string $trxShortId = ''
 Either a short hexidecimal string if a transaction is active or "". More...
 
int $trxStatus = self::STATUS_TRX_NONE
 Transaction status. More...
 
Exception null $trxStatusCause
 The last error that caused the status to become STATUS_TRX_ERROR. More...
 
array null $trxStatusIgnoredCause
 If wasKnownStatementRollbackError() prevented trxStatus from being set, the relevant details are stored here. More...
 
string $user
 User that this instance is currently connected under the name of. More...
 

Private Member Functions

 getMysqlStatus ( $which="%")
 Get status information from SHOW STATUS in an associative array. More...
 
 makeLockName ( $lockName)
 

Private Attributes

bool null $insertSelectIsSafe = null
 
stdClass null $replicationInfoRow = null
 
string null $serverVersion = null
 

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. More...
 
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. More...
 
- Static Protected Member Functions inherited from Wikimedia\Rdbms\Database
static getAttributes ()
 

Detailed Description

Database abstraction object for MySQL.

Defines methods independent on used MySQL extension.

Since
1.22
See also
Database

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

Definition at line 99 of file DatabaseMysqlBase.php.

References $name, as, null, and 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

Implements Wikimedia\Rdbms\IDatabase.

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

◆ addQuotes()

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

Adds quotes and backslashes.

Parameters
string | int | null | bool | Blob$s
Returns
string|int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 716 of file DatabaseMysqlBase.php.

References $s, and string.

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

◆ buildIntegerCast()

Wikimedia\Rdbms\DatabaseMysqlBase::buildIntegerCast (   $field)
Parameters
string$fieldField or column to cast
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1580 of file DatabaseMysqlBase.php.

◆ buildStringCast()

Wikimedia\Rdbms\DatabaseMysqlBase::buildStringCast (   $field)
Parameters
string$fieldField or column to cast
Returns
string
Since
1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1572 of file DatabaseMysqlBase.php.

◆ connectInitCharset()

Wikimedia\Rdbms\DatabaseMysqlBase::connectInitCharset ( )
protected

Set the character set information right after connection.

Returns
bool

Definition at line 218 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\mysqlSetCharset().

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

◆ dataSeek()

Wikimedia\Rdbms\DatabaseMysqlBase::dataSeek (   $res,
  $row 
)
Parameters
ResultWrapper | resource$res
int$row
Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 474 of file DatabaseMysqlBase.php.

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

◆ deleteJoin()

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

DELETE where the condition is a join.

MySql uses multi-table deletes.

Parameters
string$delTable
string$joinTable
string$delVar
string$joinVar
array | string$conds
bool | string$fname
Exceptions
DBUnexpectedError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1340 of file DatabaseMysqlBase.php.

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

◆ doLockTables()

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

◆ doSelectDomain()

◆ doUnlockTables()

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

Definition at line 1305 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\query().

◆ dropTable()

Wikimedia\Rdbms\DatabaseMysqlBase::dropTable (   $tableName,
  $fName = __METHOD__ 
)
Parameters
string$tableName
string$fName
Returns
bool|ResultWrapper

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1495 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\query(), Wikimedia\Rdbms\DatabaseMysqlBase\tableExists(), 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

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1455 of file DatabaseMysqlBase.php.

References $fname, $query, 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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 586 of file DatabaseMysqlBase.php.

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

◆ fetchObject()

◆ fetchRow()

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

◆ fieldInfo()

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

◆ fieldName()

Wikimedia\Rdbms\DatabaseMysqlBase::fieldName (   $res,
  $n 
)
Parameters
ResultWrapper | resource$res
int$n
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 429 of file DatabaseMysqlBase.php.

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

◆ fieldType()

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

mysql_field_type() wrapper

Parameters
ResultWrapper | resource$res
int$n
Returns
string

Definition at line 452 of file DatabaseMysqlBase.php.

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

◆ freeResult()

Wikimedia\Rdbms\DatabaseMysqlBase::freeResult (   $res)
Parameters
ResultWrapper | resource$res
Exceptions
DBUnexpectedError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 283 of file DatabaseMysqlBase.php.

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

◆ getApproximateLagStatus()

Wikimedia\Rdbms\DatabaseMysqlBase::getApproximateLagStatus ( )
protected

◆ getHeartbeatData()

Wikimedia\Rdbms\DatabaseMysqlBase::getHeartbeatData ( array  $conds)
protected
Parameters
array$condsWHERE 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 885 of file DatabaseMysqlBase.php.

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

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

◆ getLag()

Wikimedia\Rdbms\DatabaseMysqlBase::getLag ( )

Get the amount of replication lag for this database server.

Callers should avoid using this method while a transaction is active

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 746 of file DatabaseMysqlBase.php.

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

◆ getLagDetectionMethod()

Wikimedia\Rdbms\DatabaseMysqlBase::getLagDetectionMethod ( )
protected

◆ getLagFromPtHeartbeat()

◆ getLagFromSlaveStatus()

Wikimedia\Rdbms\DatabaseMysqlBase::getLagFromSlaveStatus ( )
protected
Returns
bool|int

Definition at line 764 of file DatabaseMysqlBase.php.

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

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

◆ getMasterPos()

Wikimedia\Rdbms\DatabaseMysqlBase::getMasterPos ( )

◆ getMasterServerInfo()

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

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

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

◆ getReplicaPos()

Wikimedia\Rdbms\DatabaseMysqlBase::getReplicaPos ( )

◆ getReplicationSafetyInfo()

Wikimedia\Rdbms\DatabaseMysqlBase::getReplicationSafetyInfo ( )
protected

◆ getServerGTIDs()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerGTIDs (   $fname = __METHOD__)
protected
Parameters
string$fname
Returns
string[]

Definition at line 1100 of file DatabaseMysqlBase.php.

References $fname, $res, as, 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
DBQueryErrorIf the variable doesn't exist for some reason

Definition at line 1068 of file DatabaseMysqlBase.php.

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

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

◆ getServerRoleStatus()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerRoleStatus (   $role,
  $fname = __METHOD__ 
)
protected
Parameters
string$roleOne of "MASTER"/"SLAVE"
string$fname
Returns
string[] Latest available server status row

Definition at line 1121 of file DatabaseMysqlBase.php.

References $fname, 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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1390 of file DatabaseMysqlBase.php.

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

◆ getServerUUID()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerUUID ( )
protected

◆ getServerVersion()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerVersion ( )

◆ getSoftwareLink()

Wikimedia\Rdbms\DatabaseMysqlBase::getSoftwareLink ( )
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1158 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getServerVersion().

◆ getType()

Wikimedia\Rdbms\DatabaseMysqlBase::getType ( )
Returns
string

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 120 of file DatabaseMysqlBase.php.

◆ ignoreIndexClause()

Wikimedia\Rdbms\DatabaseMysqlBase::ignoreIndexClause (   $index)
Parameters
string$index
Returns
string

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

Definition at line 677 of file DatabaseMysqlBase.php.

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

◆ isInsertSelectSafe()

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

◆ isQuotedIdentifier()

Wikimedia\Rdbms\DatabaseMysqlBase::isQuotedIdentifier (   $name)
Parameters
string$name
Returns
bool

Definition at line 742 of file DatabaseMysqlBase.php.

References $name.

◆ isTransactableQuery()

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

Definition at line 1567 of file DatabaseMysqlBase.php.

◆ isView()

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

Differentiates between a TABLE and a VIEW.

Parameters
string$nameName of the TABLE/VIEW to test
string | null$prefix
Returns
bool
Since
1.22

Definition at line 1563 of file DatabaseMysqlBase.php.

References $name, and Wikimedia\Rdbms\DatabaseMysqlBase\listViews().

◆ lastError()

◆ listTables()

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

List all tables on the database.

Parameters
string | null$prefixOnly show tables with this prefix, e.g. mw_
string$fnameCalling function name
Returns
array

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1473 of file DatabaseMysqlBase.php.

References $fname, $vars, as, and Wikimedia\Rdbms\Database\query().

◆ listViews()

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

Lists VIEWs in the database.

Parameters
string | null$prefixOnly show VIEWs with this prefix, eg. unit_test_, or $wgDBprefix. Default: null, would return all views.
string$fnameName of calling function
Returns
array
Since
1.22

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1529 of file DatabaseMysqlBase.php.

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

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

◆ lock()

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

◆ lockIsFree()

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

Check to see if a named lock is available.

This is non-blocking.

Parameters
string$lockNameName of lock to poll
string$methodName of method calling us
Returns
bool
Since
1.20

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1220 of file DatabaseMysqlBase.php.

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

◆ lowPriorityOption()

Wikimedia\Rdbms\DatabaseMysqlBase::lowPriorityOption ( )
Returns
string

Definition at line 1151 of file DatabaseMysqlBase.php.

◆ makeLockName()

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

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 925 of file DatabaseMysqlBase.php.

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

◆ mysqlConnect()

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

Open a connection to a MySQL server.

Parameters
string$realServer
string | null$dbName
Returns
mixed Raw connection
Exceptions
DBConnectionError

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

◆ mysqlDataSeek()

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

Move internal result pointer.

Parameters
ResultWrapper | resource$res
int$row
Returns
bool

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$connRaw connection
Returns
string

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$resRaw result
Returns
array

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

◆ mysqlFetchField()

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

Get column information from a result.

Parameters
resource$resRaw result
int$n
Returns
stdClass

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

◆ mysqlFetchObject()

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

Fetch a result row as an object.

Parameters
resource$resRaw result
Returns
stdClass

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

◆ mysqlFieldName()

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

Get the name of the specified field in a result.

Parameters
ResultWrapper | resource$res
int$n
Returns
string

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

◆ mysqlFieldType()

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

Get the type of the specified field in a result.

Parameters
ResultWrapper | resource$res
int$n
Returns
string

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

◆ mysqlFreeResult()

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

Free result memory.

Parameters
resource$resRaw result
Returns
bool

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

◆ mysqlNumFields()

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

Get number of fields in result.

Parameters
resource$resRaw result
Returns
int

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$resRaw result
Returns
int

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

◆ mysqlRealEscapeString()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlRealEscapeString (   $s)
abstractprotected
Parameters
string$s
Returns
mixed

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

◆ mysqlSetCharset()

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

Set the character set of the MySQL link.

Parameters
string$charset
Returns
bool

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\connectInitCharset(), and Wikimedia\Rdbms\DatabaseMysqlBase\doSelectDomain().

◆ namedLocksEnqueue()

Wikimedia\Rdbms\DatabaseMysqlBase::namedLocksEnqueue ( )

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

Returns
bool
Since
1.26

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1282 of file DatabaseMysqlBase.php.

◆ numFields()

Wikimedia\Rdbms\DatabaseMysqlBase::numFields (   $res)
Parameters
ResultWrapper | resource$res
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 408 of file DatabaseMysqlBase.php.

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

◆ numRows()

Wikimedia\Rdbms\DatabaseMysqlBase::numRows (   $res)
Exceptions
DBUnexpectedError
Parameters
ResultWrapper | resource$res
Returns
int

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 380 of file DatabaseMysqlBase.php.

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

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

◆ open()

◆ replace()

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

REPLACE query wrapper.

REPLACE is a very handy MySQL extension, which functions like an INSERT except that when there is a duplicate key error, the old row is deleted and the new row is inserted in its place.

We simulate this with standard SQL with a DELETE followed by INSERT. To perform the delete, we need to know what the unique indexes are so that we know how to find the conflicting rows.

It may be more efficient to leave off unique indexes which are unlikely to collide. However if you do this, you run the risk of encountering errors which wouldn't have occurred in MySQL.

Parameters
string$tableThe table to replace the row(s) in.
array[]|string[]|string$uniqueIndexes All unique indexes. One of the following: a) the one unique field in the table (when no composite unique key exist) b) a list of all unique fields in the table (when no composite unique key exist) c) a list of all unique indexes in the table (each as a list of the indexed fields)
array$rowsCan be either a single row to insert, or multiple rows, in the same format as for IDatabase::insert()
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBError

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 527 of file DatabaseMysqlBase.php.

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

◆ serverIsReadOnly()

Wikimedia\Rdbms\DatabaseMysqlBase::serverIsReadOnly ( )
Returns
bool Whether the DB is marked as read-only server-side
Since
1.28

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1125 of file DatabaseMysqlBase.php.

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

◆ setBigSelects()

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

◆ setSessionOptions()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1189 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\query().

◆ streamStatementEnd()

Wikimedia\Rdbms\DatabaseMysqlBase::streamStatementEnd ( $sql,
$newLine 
)
Parameters
string&$sql
string&$newLine
Returns
bool

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1202 of file DatabaseMysqlBase.php.

◆ strencode()

Wikimedia\Rdbms\DatabaseMysqlBase::strencode (   $s)
Parameters
string$s
Returns
string

Definition at line 706 of file DatabaseMysqlBase.php.

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

◆ tableExists()

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

◆ 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

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 1286 of file DatabaseMysqlBase.php.

◆ unlock()

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

◆ upsert()

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

INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.

This updates any conflicting rows (according to the unique indexes) using the provided SET clause and inserts any remaining (non-conflicted) rows.

$rows may be either:

  • A single associative array. The array keys are the field names, and the values are the values to insert. The values are treated as data and will be quoted appropriately. If NULL is inserted, this will be converted to a database NULL.
  • An array with numeric keys, holding a list of associative arrays. This causes a multi-row INSERT on DBMSs that support it. The keys in each subarray must be identical to each other, and in the same order.

It may be more efficient to leave off unique indexes which are unlikely to collide. However if you do this, you run the risk of encountering errors which wouldn't have occurred in MySQL.

Usually throws a DBQueryError on failure. If errors are explicitly ignored, returns success.

Since
1.22
Parameters
string$tableTable name. This will be passed through Database::tableName().
array$rowsA single row or list of rows to insert
array[]|string[]|string$uniqueIndexes All unique indexes. One of the following: a) the one unique field in the table (when no composite unique key exist) b) a list of all unique fields in the table (when no composite unique key exist) c) a list of all unique indexes in the table (each as a list of the indexed fields)
array$setAn array of values to SET. For each array element, the key gives the field name, and the value gives the data to set that field to. The data will be quoted by IDatabase::addQuotes(). Values with integer keys form unquoted SET statements, which can be used for things like "field = field + 1" or similar computed values.
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBError
Returns
bool Return true if no exception was thrown (deprecated since 1.33)

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1358 of file DatabaseMysqlBase.php.

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

◆ useGTIDs()

◆ useIndexClause()

Wikimedia\Rdbms\DatabaseMysqlBase::useIndexClause (   $index)
Parameters
string$index
Returns
string

Definition at line 1136 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\indexName().

◆ wasConnectionError()

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

Definition at line 1424 of file DatabaseMysqlBase.php.

◆ wasDeadlock()

Wikimedia\Rdbms\DatabaseMysqlBase::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1401 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\IDatabase\lastErrno().

◆ wasKnownStatementRollbackError()

Wikimedia\Rdbms\DatabaseMysqlBase::wasKnownStatementRollbackError ( )
protected

◆ wasLockTimeout()

Wikimedia\Rdbms\DatabaseMysqlBase::wasLockTimeout ( )

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

Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1410 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\IDatabase\lastErrno().

◆ wasQueryTimeout()

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

Definition at line 521 of file DatabaseMysqlBase.php.

◆ wasReadOnlyError()

Wikimedia\Rdbms\DatabaseMysqlBase::wasReadOnlyError ( )

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

Returns
bool

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 1419 of file DatabaseMysqlBase.php.

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

Member Data Documentation

◆ $defaultBigSelects

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

◆ $insertSelectIsSafe

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

Definition at line 70 of file DatabaseMysqlBase.php.

◆ $lagDetectionMethod

string Wikimedia\Rdbms\DatabaseMysqlBase::$lagDetectionMethod
protected

Method to detect replica DB lag.

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

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

◆ $lastKnownReplicaPos

MysqlMasterPos Wikimedia\Rdbms\DatabaseMysqlBase::$lastKnownReplicaPos
protected

Definition at line 43 of file DatabaseMysqlBase.php.

◆ $replicationInfoRow

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

◆ $serverVersion

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

◆ $sqlMode

string Wikimedia\Rdbms\DatabaseMysqlBase::$sqlMode
protected

sql_mode value to send on connection

Definition at line 61 of file DatabaseMysqlBase.php.

◆ $sslCAFile

string null Wikimedia\Rdbms\DatabaseMysqlBase::$sslCAFile
protected

Definition at line 55 of file DatabaseMysqlBase.php.

◆ $sslCAPath

string null Wikimedia\Rdbms\DatabaseMysqlBase::$sslCAPath
protected

Definition at line 57 of file DatabaseMysqlBase.php.

◆ $sslCertPath

string null Wikimedia\Rdbms\DatabaseMysqlBase::$sslCertPath
protected

Definition at line 53 of file DatabaseMysqlBase.php.

◆ $sslCiphers

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

Definition at line 59 of file DatabaseMysqlBase.php.

◆ $sslKeyPath

string null Wikimedia\Rdbms\DatabaseMysqlBase::$sslKeyPath
protected

Definition at line 51 of file DatabaseMysqlBase.php.

◆ $useGTIDs

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

bool Whether to use GTID methods

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

◆ SERVER_ID_CACHE_TTL

const Wikimedia\Rdbms\DatabaseMysqlBase::SERVER_ID_CACHE_TTL = 86400

Definition at line 75 of file DatabaseMysqlBase.php.


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