MediaWiki  1.27.2
DatabaseMysqlBase Class Reference

Database abstraction object for MySQL. More...

Inheritance diagram for DatabaseMysqlBase:
Collaboration diagram for 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...
 
 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, $vars= '*', $conds= '', $fname=__METHOD__, $options=[])
 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)
 
 getApproximateLagStatus ()
 
 getLag ()
 Get slave lag. More...
 
 getMasterPos ()
 Get the position of the master from SHOW MASTER STATUS. More...
 
 getMysqlStatus ($which="%")
 Get status information from SHOW STATUS in an associative array. More...
 
 getSearchEngine ()
 Get search engine class. More...
 
 getServerUptime ()
 Determines how long the server has been up. More...
 
 getServerVersion ()
 
 getSlavePos ()
 Get the position of the master from SHOW SLAVE STATUS. More...
 
 getSoftwareLink ()
 
 getType ()
 
 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...
 
 lockTables ($read, $write, $method, $lowPriority=true)
 
 lowPriorityOption ()
 
 masterPosWait (DBMasterPos $pos, $timeout)
 Wait for the slave 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)
 
 open ($server, $user, $password, $dbName)
 
 ping ()
 
 replace ($table, $uniqueIndexes, $rows, $fname=__METHOD__)
 
 setBigSelects ($value=true)
 
 setSessionOptions (array $options)
 
 streamStatementEnd (&$sql, &$newLine)
 
 strencode ($s)
 
 unlock ($lockName, $method)
 FROM MYSQL DOCS: http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock. More...
 
 unlockTables ($method)
 
 upsert ($table, array $rows, array $uniqueIndexes, array $set, $fname=__METHOD__)
 
 useIndexClause ($index)
 
 wasConnectionError ($errno)
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock. More...
 
 wasErrorReissuable ()
 Determines if the last query error was something that should be dealt with by pinging the connection and reissuing the query. 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 DatabaseBase
 __construct (array $params)
 Constructor. More...
 
 __destruct ()
 Run a few simple sanity checks. More...
 
 __sleep ()
 Called by serialize. More...
 
 __toString ()
 
 addIdentifierQuotes ($s)
 Quotes an identifier using backticks or "double quotes" depending on the database type. More...
 
 addQuotes ($s)
 Adds quotes and backslashes. 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...
 
 begin ($fname=__METHOD__)
 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...
 
 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...
 
 cascadingDeletes ()
 Returns true if this database supports (and uses) cascading deletes. More...
 
 cleanupTriggers ()
 Returns true if this database supports (and uses) triggers (e.g. More...
 
 clearFlag ($flag)
 Clear a flag for this connection. More...
 
 clearViewsCache ()
 Reset the views process cache set by listViews() More...
 
 close ()
 Closes a database connection. More...
 
 commit ($fname=__METHOD__, $flush= '')
 Commits a transaction previously started using begin(). More...
 
 conditional ($cond, $trueVal, $falseVal)
 Returns an SQL expression for a simple conditional. More...
 
 connectionErrorHandler ($errno, $errstr)
 
 dbSchema ($schema=null)
 Get/set the db schema. More...
 
 deadlockLoop ()
 Perform a deadlock-prone transaction. More...
 
 debug ($debug=null)
 Boolean, controls output of large amounts of debug information. 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, $callback)
 Run a callback to do an atomic set of updates for this database. 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 Note that unlike most database abstraction functions, this function does not automatically append database prefix, because it works at a lower abstraction level. 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, $vars= '*', $conds= '', $fname=__METHOD__, $options=[])
 Estimate the number of rows in dataset. More...
 
 execute ($prepared, $args=null)
 Execute a prepared query with the various arguments. More...
 
 fieldExists ($table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. More...
 
 fieldNamesWithAlias ($fields)
 Gets an array of aliased field names. More...
 
 fieldNameWithAlias ($name, $alias=false)
 Get an aliased field name e.g. More...
 
 fillPrepared ($preparedQuery, $args)
 For faking prepared SQL statements on DBs that don't support it directly. More...
 
 freeResult ($res)
 Free a result object returned by query() or select(). More...
 
 functionalIndexes ()
 Returns true if this database can use functional indexes. More...
 
 getApproximateLagStatus ()
 Get a slave lag estimate for this server. More...
 
 getDBname ()
 Get the current DB name. More...
 
 getDelimiter ()
 
 getFlag ($flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is. More...
 
 getLag ()
 Get slave lag. More...
 
 getLazyMasterHandle ()
 
 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)
 General read-only accessor. More...
 
 getSchemaPath ()
 Return a path to the DBMS-specific schema file, otherwise default to tables.sql. More...
 
 getScopedLockAndFlush ($lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More...
 
 getSearchEngine ()
 Get search engine class. 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 STUB. More...
 
 getSessionLagStatus ()
 Get the slave lag when the current transaction started or a general lag estimate if not transaction is active. More...
 
 getSlavePos ()
 Get the replication position of this slave. More...
 
 getTransactionLagStatus ()
 Get the slave lag when the current transaction started. More...
 
 getUpdateKeysPath ()
 Return a path to the DBMS-specific update key file, otherwise default to update-keys.sql. More...
 
 getWikiID ()
 
 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...
 
 insert ($table, $a, $fname=__METHOD__, $options=[])
 INSERT wrapper, inserts an array into a table. More...
 
 insertSelect ($destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[])
 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 ()
 
 isView ($name)
 Differentiates between a TABLE and a VIEW. More...
 
 lastDoneWrites ()
 Returns the last time the connection may have been used for write queries. More...
 
 lastQuery ()
 Return the last query that went through 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...
 
 lockIsFree ($lockName, $method)
 Check to see if a named lock is available (non-blocking) More...
 
 lockTables ($read, $write, $method, $lowPriority=true)
 Lock specific tables. More...
 
 lowPriorityOption ()
 A string to insert into queries to show that they're low-priority, like MySQL's LOW_PRIORITY. More...
 
 makeGroupByWithHaving ($options)
 Returns an optional GROUP BY with an optional HAVING. More...
 
 makeList ($a, $mode=LIST_COMMA)
 Makes an encoded list of strings from an array. 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...
 
 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 slave 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)
 Returns an appropriately quoted sequence value for inserting a new row. More...
 
 onTransactionIdle ($callback)
 Run an anonymous function as soon as there is no transaction pending. More...
 
 onTransactionPreCommitOrIdle ($callback)
 Run an anonymous function before the current transaction commits or now if there is none. More...
 
 patchPath ($patch)
 Get the full path of a patch file. More...
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction. More...
 
 pendingWriteQueryDuration ()
 Get the time spend running write queries for this transaction. More...
 
 ping ()
 Ping the server and try to reconnect if it there is no connection. More...
 
 query ($sql, $fname=__METHOD__, $tempIgnore=false)
 Run an SQL query and return the result. More...
 
 realTimestamps ()
 Returns true if this database uses timestamps rather than integers. More...
 
 replace ($table, $uniqueIndexes, $rows, $fname=__METHOD__)
 REPLACE query wrapper. More...
 
 reportConnectionError ($error= 'Unknown error')
 
 reportQueryError ($error, $errno, $sql, $fname, $tempIgnore=false)
 Report a query error. More...
 
 rollback ($fname=__METHOD__, $flush= '')
 Rollback a transaction previously started using begin(). More...
 
 searchableIPs ()
 Returns true if this database can do a native search on IP columns e.g. 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...
 
 selectField ($table, $var, $cond= '', $fname=__METHOD__, $options=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ($table, $var, $cond= '', $fname=__METHOD__, $options=[], $join_conds=[])
 
 selectRow ($table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Single row SELECT wrapper. More...
 
 selectRowCount ($tables, $vars= '*', $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...
 
 setBigSelects ($value=true)
 Allow or deny "big selects" for this session only. More...
 
 setFileHandle ($fh)
 Set the filehandle to copy write statements to. More...
 
 setFlag ($flag)
 Set a flag for this connection. 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...
 
 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...
 
 setTransactionProfiler (TransactionProfiler $profiler)
 
 sourceFile ($filename, $lineCallback=false, $resultCallback=false, $fname=false, $inputCallback=false)
 Read and execute SQL commands from a file. More...
 
 sourceStream ($fp, $lineCallback=false, $resultCallback=false, $fname=__METHOD__, $inputCallback=false)
 Read and execute commands from an open file handle. More...
 
 startAtomic ($fname=__METHOD__)
 Begin an atomic section of statements. More...
 
 streamStatementEnd (&$sql, &$newLine)
 Called by sourceStream() to check if we've reached a statement end. More...
 
 strencode ($s)
 Wrapper for addslashes() More...
 
 strictIPs ()
 Returns true if this database is strict about what can be put into an IP field. More...
 
 strreplace ($orig, $old, $new)
 Returns a comand for str_replace function in SQL query. More...
 
 tableExists ($table, $fname=__METHOD__)
 Query whether a given table exists. 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...
 
 tableNamesWithAlias ($tables)
 Gets an array of aliased table names. More...
 
 tableNameWithAlias ($name, $alias=false)
 Get an aliased table name e.g. 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...
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established. 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 specific tables. More...
 
 update ($table, $values, $conds, $fname=__METHOD__, $options=[])
 UPDATE wrapper. More...
 
 upsert ($table, array $rows, array $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)
 Determines if the given query error was a connection drop STUB. More...
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock STUB. More...
 
 wasErrorReissuable ()
 Determines if the last query error was something that should be dealt with by pinging the connection and reissuing the query. More...
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout STUB. More...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. More...
 
 writesOrCallbacksPending ()
 Returns true if there is a transaction open with possible write queries or transaction pre-commit/idle callbacks waiting on it to finish. More...
 
 writesPending ()
 
- Public Member Functions inherited from IDatabase
 affectedRows ()
 Get the number of rows affected by the last write query. More...
 
 insertId ()
 Get the inserted value of an auto-increment row. More...
 
 lastErrno ()
 Get the last error number. More...
 
 selectFieldValues ($table, $var, $cond= '', $fname=__METHOD__, $options=[])
 A SELECT wrapper which returns a list of single field values from result rows. More...
 

Protected Member Functions

 connectInitCharset ()
 Set the character set information right after connection. More...
 
 getBindingHandle ()
 Get the underlying binding handle, mConn. More...
 
 getDefaultSchemaVars ()
 
 getHeartbeatData (array $conds)
 
 getLagDetectionMethod ()
 
 getLagFromPtHeartbeat ()
 
 getLagFromSlaveStatus ()
 
 getMasterServerInfo ()
 
 mysqlConnect ($realServer)
 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...
 
 mysqlPing ()
 Ping a server connection or reconnect if there is no connection. More...
 
 mysqlRealEscapeString ($s)
 
 mysqlSetCharset ($charset)
 Set the character set of the MySQL link. More...
 
- Protected Member Functions inherited from DatabaseBase
 assertOpen ()
 Make sure isOpen() returns true 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...
 
 doQuery ($sql)
 The DBMS-dependent part of query() More...
 
 doRollback ($fname)
 Issues the ROLLBACK command to the database server. More...
 
 escapeLikeInternal ($s)
 
 fillPreparedArg ($matches)
 preg_callback func for fillPrepared() The arguments should be in $this->preparedArgs and must not be touched while we're doing this. More...
 
 freePrepared ($prepared)
 Free a prepared query, generated by prepare(). More...
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars(). More...
 
 getLogContext (array $extras=[])
 Create a log context to pass to wfLogDBError or other logging functions. More...
 
 getReadOnlyReason ()
 
 getSchemaVars ()
 Get schema variables. More...
 
 getTransactionProfiler ()
 
 ignoreErrors ($ignoreErrors=null)
 Turns on (false) or off (true) the automatic generation and sending of a "we're sorry, but there has been a database error" page on database errors. More...
 
 indexName ($index)
 Get the name of an index in a given table. More...
 
 installErrorHandler ()
 
 isTransactableQuery ($sql)
 Determine whether a SQL statement is sensitive to isolation level. More...
 
 isWriteQuery ($sql)
 Determine whether a query writes to the DB. More...
 
 makeInsertOptions ($options)
 Helper for DatabaseBase::insert(). More...
 
 makeUpdateOptions ($options)
 Make UPDATE options for the DatabaseBase::update function. More...
 
 makeUpdateOptionsArray ($options)
 Make UPDATE options array for DatabaseBase::makeUpdateOptions. More...
 
 nativeReplace ($table, $rows, $fname)
 REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE statement. More...
 
 prepare ($sql, $func= 'DatabaseBase::prepare')
 Intended to be compatible with the PEAR::DB wrapper functions. More...
 
 replaceVars ($ins)
 Database independent variable replacement. More...
 
 restoreErrorHandler ()
 
 resultObject ($result)
 Take the result from a query, and wrap it in a ResultWrapper if necessary. More...
 
 runOnTransactionIdleCallbacks ()
 Actually any "on transaction idle" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually any "on transaction pre-commit" callbacks. More...
 
 tableNamesWithUseIndexOrJOIN ($tables, $use_index=[], $join_conds=[])
 Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX clause. More...
 

Protected Attributes

string $lagDetectionMethod
 Method to detect slave lag. More...
 
array $lagDetectionOptions = []
 Method to detect slave lag. More...
 
MysqlMasterPos $lastKnownSlavePos
 
- Protected Attributes inherited from DatabaseBase
string[] $allViews = null
 
 $delimiter = ';'
 
resource $fileHandle = null
 
 $htmlErrors
 
resource $mConn = null
 Database connection. More...
 
 $mDefaultBigSelects = null
 
 $mDoneWrites = false
 
 $mFlags
 
 $mForeign
 
 $mLastQuery = ''
 
 $mLBInfo = []
 
 $mOpened = false
 
 $mPHPError = false
 
 $mSchema
 
 $mSchemaVars = false
 
 $mServer
 
array $mSessionVars = []
 
 $mTablePrefix
 
callable[] $mTrxIdleCallbacks = []
 
int $mTrxLevel = 0
 Either 1 if a transaction is active or 0 otherwise. More...
 
callable[] $mTrxPreCommitCallbacks = []
 
string $mTrxShortId = ''
 Either a short hexidecimal string if a transaction is active or "". More...
 
 $preparedArgs
 
BagOStuff $srvCache
 APC cache. More...
 
TransactionProfiler $trxProfiler
 

Private Member Functions

 makeLockName ($lockName)
 

Private Attributes

string null $serverVersion = null
 

Additional Inherited Members

- Static Public Member Functions inherited from DatabaseBase
static factory ($dbType, $p=[])
 Given a DB type, construct the name of the appropriate child class of DatabaseBase. More...
 
static getCacheSetOptions (IDatabase $db1)
 Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination. More...
 
- Public Attributes inherited from DatabaseBase
 $mDBname
 
 $mPassword
 
 $mUser
 
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...
 
- Static Protected Member Functions inherited from DatabaseBase
static generalizeSQL ($sql)
 Removes most variables from an SQL query and replaces them with X or N for numbers. More...
 

Detailed Description

Database abstraction object for MySQL.

Defines methods independent on used MySQL extension.

Since
1.22
See also
Database

Definition at line 32 of file DatabaseMysqlBase.php.

Constructor & Destructor Documentation

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'].
    Parameters
    array$params

Definition at line 55 of file DatabaseMysqlBase.php.

Member Function Documentation

DatabaseMysqlBase::addIdentifierQuotes (   $s)

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

Parameters
string$s
Returns
string

Definition at line 591 of file DatabaseMysqlBase.php.

References $s.

Referenced by duplicateTableStructure(), and open().

DatabaseMysqlBase::connectInitCharset ( )
protected

Set the character set information right after connection.

Returns
bool

Definition at line 185 of file DatabaseMysqlBase.php.

References $wgDBmysql5, global, and mysqlSetCharset().

Referenced by open().

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

Implements IDatabase.

Definition at line 409 of file DatabaseMysqlBase.php.

References $res, and mysqlDataSeek().

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

DELETE where the condition is a join.

MySql uses multi-table deletes.

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

Implements IDatabase.

Definition at line 1074 of file DatabaseMysqlBase.php.

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

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

Definition at line 1243 of file DatabaseMysqlBase.php.

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

DatabaseMysqlBase::duplicateTableStructure (   $oldName,
  $newName,
  $temporary = false,
  $fname = __METHOD__ 
)
Parameters
string$oldName
string$newName
bool$temporary
string$fname
Returns
bool

Definition at line 1205 of file DatabaseMysqlBase.php.

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

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

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

Parameters
string | array$table
string | array$vars
string | array$conds
string$fname
string | array$options
Returns
bool|int

Implements IDatabase.

Definition at line 479 of file DatabaseMysqlBase.php.

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

DatabaseMysqlBase::fetchObject (   $res)
Parameters
ResultWrapper | resource$res
Returns
stdClass|bool
Exceptions
DBUnexpectedError

Implements IDatabase.

Definition at line 243 of file DatabaseMysqlBase.php.

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

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

DatabaseMysqlBase::fetchRow (   $res)
Parameters
ResultWrapper | resource$res
Returns
array|bool
Exceptions
DBUnexpectedError

Implements IDatabase.

Definition at line 279 of file DatabaseMysqlBase.php.

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

Referenced by listViews(), and masterPosWait().

DatabaseMysqlBase::fieldInfo (   $table,
  $field 
)
Parameters
string$table
string$field
Returns
bool|MySQLField

Implements IDatabase.

Definition at line 504 of file DatabaseMysqlBase.php.

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

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

Implements IDatabase.

Definition at line 364 of file DatabaseMysqlBase.php.

References $res, and mysqlFieldName().

DatabaseMysqlBase::fieldType (   $res,
  $n 
)

mysql_field_type() wrapper

Parameters
ResultWrapper | resource$res
int$n
Returns
string

Definition at line 387 of file DatabaseMysqlBase.php.

References $res, and mysqlFieldType().

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

Implements IDatabase.

Definition at line 218 of file DatabaseMysqlBase.php.

References $res, and mysqlFreeResult().

DatabaseMysqlBase::getApproximateLagStatus ( )

Definition at line 762 of file DatabaseMysqlBase.php.

References $key, getLagDetectionMethod(), and DatabaseBase\getServer().

DatabaseMysqlBase::getBindingHandle ( )
protected

Get the underlying binding handle, mConn.

Makes sure that mConn is set (disconnects and ping() failure can unset it). This catches broken callers than catch and ignore disconnection exceptions. Unlike checking isOpen(), this is safe to call inside of open().

Returns
resource|object
Exceptions
DBUnexpectedError
Since
1.26

Definition at line 1187 of file DatabaseMysqlBase.php.

References DatabaseBase\$mConn.

Referenced by DatabaseMysql\affectedRows(), DatabaseMysqli\affectedRows(), DatabaseMysql\closeConnection(), DatabaseMysqli\closeConnection(), DatabaseMysql\doQuery(), DatabaseMysqli\doQuery(), DatabaseMysql\insertId(), DatabaseMysqli\insertId(), DatabaseMysql\mysqlPing(), DatabaseMysqli\mysqlPing(), DatabaseMysql\mysqlRealEscapeString(), DatabaseMysqli\mysqlRealEscapeString(), DatabaseMysql\mysqlSetCharset(), DatabaseMysqli\mysqlSetCharset(), DatabaseMysql\selectDB(), and DatabaseMysqli\selectDB().

DatabaseMysqlBase::getDefaultSchemaVars ( )
protected
Returns
array

Definition at line 1254 of file DatabaseMysqlBase.php.

References $GLOBALS, and $vars.

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

References $res, LIST_AND, DatabaseBase\makeList(), and DatabaseBase\query().

Referenced by getLagFromPtHeartbeat().

DatabaseMysqlBase::getLag ( )

Get slave lag.

Currently supported only by MySQL.

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

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

Implements IDatabase.

Definition at line 632 of file DatabaseMysqlBase.php.

References getLagDetectionMethod(), getLagFromPtHeartbeat(), and getLagFromSlaveStatus().

DatabaseMysqlBase::getLagDetectionMethod ( )
protected
Returns
string

Definition at line 643 of file DatabaseMysqlBase.php.

References $lagDetectionMethod.

Referenced by getApproximateLagStatus(), and getLag().

DatabaseMysqlBase::getLagFromPtHeartbeat ( )
protected
DatabaseMysqlBase::getLagFromSlaveStatus ( )
protected
Returns
bool|int

Definition at line 650 of file DatabaseMysqlBase.php.

References $res, and DatabaseBase\query().

Referenced by getLag().

DatabaseMysqlBase::getMasterPos ( )

Get the position of the master from SHOW MASTER STATUS.

Returns
MySQLMasterPos|bool

Implements IDatabase.

Definition at line 847 of file DatabaseMysqlBase.php.

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

DatabaseMysqlBase::getMasterServerInfo ( )
protected
DatabaseMysqlBase::getMysqlStatus (   $which = "%")

Get status information from SHOW STATUS in an associative array.

Parameters
string$which
Returns
array

Definition at line 1272 of file DatabaseMysqlBase.php.

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

Referenced by getServerUptime().

DatabaseMysqlBase::getSearchEngine ( )

Get search engine class.

All subclasses of this need to implement this if they wish to use searching.

Returns
string

Definition at line 1040 of file DatabaseMysqlBase.php.

DatabaseMysqlBase::getServerUptime ( )

Determines how long the server has been up.

Returns
int

Implements IDatabase.

Definition at line 1128 of file DatabaseMysqlBase.php.

References $vars, and getMysqlStatus().

DatabaseMysqlBase::getServerVersion ( )
Returns
string

Implements IDatabase.

Definition at line 894 of file DatabaseMysqlBase.php.

References $serverVersion, and DatabaseBase\selectField().

Referenced by getSoftwareLink().

DatabaseMysqlBase::getSlavePos ( )

Get the position of the master from SHOW SLAVE STATUS.

Returns
MySQLMasterPos|bool

Implements IDatabase.

Definition at line 827 of file DatabaseMysqlBase.php.

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

Referenced by masterPosWait().

DatabaseMysqlBase::getSoftwareLink ( )
Returns
string

Implements IDatabase.

Definition at line 876 of file DatabaseMysqlBase.php.

References $version, and getServerVersion().

DatabaseMysqlBase::getType ( )
Returns
string

Implements IDatabase.

Definition at line 69 of file DatabaseMysqlBase.php.

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

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

DatabaseMysqlBase::isQuotedIdentifier (   $name)
Parameters
string$name
Returns
bool

Definition at line 601 of file DatabaseMysqlBase.php.

References $name.

DatabaseMysqlBase::isView (   $name,
  $prefix = null 
)

Differentiates between a TABLE and a VIEW.

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

Definition at line 1330 of file DatabaseMysqlBase.php.

References $name, and listViews().

DatabaseMysqlBase::lastError ( )
Returns
string

Implements IDatabase.

Definition at line 429 of file DatabaseMysqlBase.php.

References mysqlError().

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

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

List all tables on the database.

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

Implements IDatabase.

Definition at line 1221 of file DatabaseMysqlBase.php.

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

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

Lists VIEWs in the database.

Parameters
string$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

Definition at line 1292 of file DatabaseMysqlBase.php.

References DatabaseBase\$allViews, DatabaseBase\$mDBname, as, fetchRow(), and DatabaseBase\query().

Referenced by isView().

DatabaseMysqlBase::lock (   $lockName,
  $method,
  $timeout = 5 
)
Parameters
string$lockName
string$method
int$timeout
Returns
bool

Implements IDatabase.

Definition at line 952 of file DatabaseMysqlBase.php.

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

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

Definition at line 938 of file DatabaseMysqlBase.php.

References DatabaseBase\addQuotes(), fetchObject(), makeLockName(), and DatabaseBase\query().

DatabaseMysqlBase::lockTables (   $read,
  $write,
  $method,
  $lowPriority = true 
)
Parameters
array$read
array$write
string$method
bool$lowPriority
Returns
bool

Definition at line 1006 of file DatabaseMysqlBase.php.

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

DatabaseMysqlBase::lowPriorityOption ( )
Returns
string

Definition at line 869 of file DatabaseMysqlBase.php.

DatabaseMysqlBase::makeLockName (   $lockName)
private

Definition at line 989 of file DatabaseMysqlBase.php.

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

DatabaseMysqlBase::masterPosWait ( DBMasterPos  $pos,
  $timeout 
)

Wait for the slave to catch up to a given master position.

Parameters
DBMasterPos$pos
int$timeoutThe maximum number of seconds to wait for synchronisation
Returns
int|null Zero if the slave 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

Implements IDatabase.

Definition at line 780 of file DatabaseMysqlBase.php.

References $res, $status, DatabaseBase\addQuotes(), DatabaseBase\commit(), DatabaseBase\doQuery(), fetchRow(), and getSlavePos().

DatabaseMysqlBase::mysqlConnect (   $realServer)
abstractprotected

Open a connection to a MySQL server.

Parameters
string$realServer
Returns
mixed Raw connection
Exceptions
DBConnectionError

Referenced by open().

DatabaseMysqlBase::mysqlDataSeek (   $res,
  $row 
)
abstractprotected

Move internal result pointer.

Parameters
ResultWrapper | resource$res
int$row
Returns
bool

Referenced by dataSeek().

DatabaseMysqlBase::mysqlError (   $conn = null)
abstractprotected

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

Parameters
resource$connRaw connection
Returns
string

Referenced by lastError().

DatabaseMysqlBase::mysqlFetchArray (   $res)
abstractprotected

Fetch a result row as an associative and numeric array.

Parameters
resource$resRaw result
Returns
array

Referenced by fetchRow().

DatabaseMysqlBase::mysqlFetchField (   $res,
  $n 
)
abstractprotected

Get column information from a result.

Parameters
resource$resRaw result
int$n
Returns
stdClass

Referenced by fieldInfo().

DatabaseMysqlBase::mysqlFetchObject (   $res)
abstractprotected

Fetch a result row as an object.

Parameters
resource$resRaw result
Returns
stdClass

Referenced by fetchObject().

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

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

DatabaseMysqlBase::mysqlFreeResult (   $res)
abstractprotected

Free result memory.

Parameters
resource$resRaw result
Returns
bool

Referenced by freeResult().

DatabaseMysqlBase::mysqlNumFields (   $res)
abstractprotected

Get number of fields in result.

Parameters
resource$resRaw result
Returns
int

Referenced by fieldInfo(), and numFields().

DatabaseMysqlBase::mysqlNumRows (   $res)
abstractprotected

Get number of rows in result.

Parameters
resource$resRaw result
Returns
int

Referenced by numRows().

DatabaseMysqlBase::mysqlPing ( )
abstractprotected

Ping a server connection or reconnect if there is no connection.

Returns
bool

Referenced by ping().

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

Referenced by strencode().

DatabaseMysqlBase::mysqlSetCharset (   $charset)
abstractprotected

Set the character set of the MySQL link.

Parameters
string$charset
Returns
bool

Referenced by connectInitCharset().

DatabaseMysqlBase::namedLocksEnqueue ( )

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

Returns
bool
Since
1.26

Implements IDatabase.

Definition at line 995 of file DatabaseMysqlBase.php.

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

Implements IDatabase.

Definition at line 343 of file DatabaseMysqlBase.php.

References $res, and mysqlNumFields().

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

Implements IDatabase.

Definition at line 315 of file DatabaseMysqlBase.php.

References $res, and mysqlNumRows().

Referenced by estimateRowCount().

DatabaseMysqlBase::open (   $server,
  $user,
  $password,
  $dbName 
)
DatabaseMysqlBase::ping ( )
Returns
bool

Implements IDatabase.

Definition at line 608 of file DatabaseMysqlBase.php.

References DatabaseBase\closeConnection(), mysqlPing(), and open().

Referenced by strencode().

DatabaseMysqlBase::replace (   $table,
  $uniqueIndexes,
  $rows,
  $fname = __METHOD__ 
)
Parameters
string$table
array$uniqueIndexes
array$rows
string$fname
Returns
ResultWrapper

Implements IDatabase.

Definition at line 463 of file DatabaseMysqlBase.php.

References $fname, and DatabaseBase\nativeReplace().

DatabaseMysqlBase::setBigSelects (   $value = true)
Parameters
bool$value

Implements IDatabase.

Definition at line 1047 of file DatabaseMysqlBase.php.

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

DatabaseMysqlBase::setSessionOptions ( array  $options)
Parameters
array$options

Implements IDatabase.

Definition at line 907 of file DatabaseMysqlBase.php.

References DatabaseBase\query().

DatabaseMysqlBase::streamStatementEnd ( $sql,
$newLine 
)
Parameters
string$sql
string$newLine
Returns
bool

Definition at line 920 of file DatabaseMysqlBase.php.

DatabaseMysqlBase::strencode (   $s)
Parameters
string$s
Returns
string

Definition at line 568 of file DatabaseMysqlBase.php.

References $s, mysqlRealEscapeString(), and ping().

DatabaseMysqlBase::unlock (   $lockName,
  $method 
)

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

Parameters
string$lockName
string$method
Returns
bool

Implements IDatabase.

Definition at line 974 of file DatabaseMysqlBase.php.

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

DatabaseMysqlBase::unlockTables (   $method)
Parameters
string$method
Returns
bool

Definition at line 1028 of file DatabaseMysqlBase.php.

References DatabaseBase\query().

DatabaseMysqlBase::upsert (   $table,
array  $rows,
array  $uniqueIndexes,
array  $set,
  $fname = __METHOD__ 
)
Parameters
string$table
array$rows
array$uniqueIndexes
array$set
string$fname
Returns
bool

Implements IDatabase.

Definition at line 1098 of file DatabaseMysqlBase.php.

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

DatabaseMysqlBase::useIndexClause (   $index)
Parameters
string$index
Returns
string

Definition at line 862 of file DatabaseMysqlBase.php.

References DatabaseBase\indexName().

DatabaseMysqlBase::wasConnectionError (   $errno)

Definition at line 1172 of file DatabaseMysqlBase.php.

DatabaseMysqlBase::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

Returns
bool

Implements IDatabase.

Definition at line 1139 of file DatabaseMysqlBase.php.

References IDatabase\lastErrno().

DatabaseMysqlBase::wasErrorReissuable ( )

Determines if the last query error was something that should be dealt with by pinging the connection and reissuing the query.

Returns
bool

Implements IDatabase.

Definition at line 1158 of file DatabaseMysqlBase.php.

References IDatabase\lastErrno().

DatabaseMysqlBase::wasLockTimeout ( )

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

Returns
bool

Implements IDatabase.

Definition at line 1148 of file DatabaseMysqlBase.php.

References IDatabase\lastErrno().

DatabaseMysqlBase::wasReadOnlyError ( )

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

Returns
bool

Implements IDatabase.

Definition at line 1167 of file DatabaseMysqlBase.php.

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

Member Data Documentation

string DatabaseMysqlBase::$lagDetectionMethod
protected

Method to detect slave lag.

Definition at line 36 of file DatabaseMysqlBase.php.

Referenced by getLagDetectionMethod().

array DatabaseMysqlBase::$lagDetectionOptions = []
protected

Method to detect slave lag.

Definition at line 38 of file DatabaseMysqlBase.php.

Referenced by getLagFromPtHeartbeat().

MysqlMasterPos DatabaseMysqlBase::$lastKnownSlavePos
protected

Definition at line 34 of file DatabaseMysqlBase.php.

string null DatabaseMysqlBase::$serverVersion = null
private

Definition at line 41 of file DatabaseMysqlBase.php.

Referenced by getServerVersion().


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