MediaWiki master
Wikimedia\Rdbms\DatabaseMySQL Class Reference

Inherits Wikimedia\Rdbms\Database.

Collaboration diagram for Wikimedia\Rdbms\DatabaseMySQL:

Public Member Functions

 __construct (array $params)
 Additional $params include:
 
 doLock (string $lockName, string $method, int $timeout)
 
 doLockIsFree (string $lockName, string $method)
 
 doUnlock (string $lockName, string $method)
 
 duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
 
 estimateRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Estimate rows in dataset Returns estimated count, based on EXPLAIN output Takes same arguments as Database::select()
 
 fieldInfo ( $table, $field)
 
 getServerVersion ()
 
 getSoftwareLink ()
 
 getType ()
 
 indexInfo ( $table, $index, $fname=__METHOD__)
 Get information about an index into an object Returns false if the index does not exist.
 
 insertId ()
 Get the sequence-based ID assigned by the last query method call.
 
 lastErrno ()
 
 lastError ()
 
 listTables ( $prefix=null, $fname=__METHOD__)
 List all tables on the database.
 
 replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__)
 Insert row(s) into a table, in the provided order, while deleting conflicting rows.
 
 selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Take the same arguments as IDatabase::select() and return the SQL it would use.
 
 serverIsReadOnly ()
 
Returns
bool Whether this DB server is running in server-side read-only mode
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.28

 
 setSessionOptions (array $options)
 
 streamStatementEnd (&$sql, &$newLine)
 
 strencode ( $s)
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists.
 
 upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__)
 Upsert row(s) into a table, in the provided order, while updating conflicting rows.
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock.
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only.
 
- Public Member Functions inherited from Wikimedia\Rdbms\Database
 __clone ()
 Make sure that copies do not share the same client binding handle.
 
 __destruct ()
 Run a few simple checks and close dangling connections.
 
 __sleep ()
 Called by serialize.
 
 __toString ()
 Get a debugging string that mentions the database type, the ID of this instance, and the ID of any underlying connection resource or driver object if one is present.
 
 addIdentifierQuotes ( $s)
 Escape a SQL identifier (e.g.
 
 addQuotes ( $s)
 Escape and quote a raw value string for use in a SQL query.
 
 affectedRows ()
 Get the number of rows affected by the last query method call.
 
 anyChar ()
 Returns a token for buildLike() that denotes a '_' to be used in a LIKE query.
 
 anyString ()
 Returns a token for buildLike() that denotes a '' to be used in a LIKE query.
 
 begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
 Begin a transaction.
 
 bitAnd ( $fieldLeft, $fieldRight)
 
 bitNot ( $field)
 
 bitOr ( $fieldLeft, $fieldRight)
 
 buildComparison (string $op, array $conds)
 Build a condition comparing multiple values, for use with indexes that cover multiple fields, common when e.g.
 
 buildConcat ( $stringList)
 Build a concatenation list to feed into a SQL query.
 
 buildExcludedValue ( $column)
 Build a reference to a column value from the conflicting proposed upsert() row.
 
 buildGreatest ( $fields, $values)
 Build a GREATEST function statement comparing columns/values.
 
 buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query.
 
 buildIntegerCast ( $field)
 
 buildLeast ( $fields, $values)
 Build a LEAST function statement comparing columns/values.
 
 buildLike ( $param,... $params)
 LIKE statement wrapper.
 
 buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery.
 
 buildStringCast ( $field)
 
 buildSubstring ( $input, $startPosition, $length=null)
 
 cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
 Cancel an atomic section of SQL statements.
 
 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection.
 
 close ( $fname=__METHOD__)
 Close the database connection.
 
 commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commits a transaction previously started using begin()
 
 conditional ( $cond, $caseTrueExpression, $caseFalseExpression)
 Returns an SQL expression for a simple conditional.
 
 connectionErrorLogger ( $errno, $errstr)
 Error handler for logging errors during database connection.
 
 databasesAreIndependent ()
 Returns true if DBs are assumed to be on potentially different servers.
 
 dbSchema ( $schema=null)
 Get/set the db schema.
 
 decodeBlob ( $b)
 Some DBMSs return a special placeholder object representing blob fields in result objects.
 
 decodeExpiry ( $expiry, $format=TS_MW)
 Decode an expiry time into a DBMS independent format.
 
 delete ( $table, $conds, $fname=__METHOD__)
 Delete all rows in a table that match a condition.
 
 deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
 Delete all rows in a table that match a condition which includes a join.
 
 doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Perform an atomic section of reversible SQL statements from a callback.
 
 dropTable ( $table, $fname=__METHOD__)
 Delete a table.
 
 encodeBlob ( $b)
 Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.
 
 encodeExpiry ( $expiry)
 Encode an expiry time into the DBMS dependent format.
 
 endAtomic ( $fname=__METHOD__)
 Ends an atomic section of SQL statements.
 
 explicitTrxActive ()
 Check whether there is a transaction open at the specific request of a caller.
 
 expr (string $field, string $op, $value)
 See Expression::__construct()
 
 factorConds ( $condsArray)
 Given an array of condition arrays representing an OR list of AND lists, for example:
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table.
 
 flushSession ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Release important session-level state (named lock, table locks) as post-rollback cleanup.
 
 flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commit any transaction but error out if writes or callbacks are pending.
 
 getDBname ()
 Get the current database name; null if there isn't one.
 
 getDomainID ()
 Return the currently selected domain ID.
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection.
 
 getInfinity ()
 Find out when 'infinity' is.
 
 getLag ()
 Get the seconds of replication lag on this database server.
 
 getLBInfo ( $name=null)
 Get properties passed down from the server info array of the load balancer.
 
 getPrimaryPos ()
 Get the replication position of this primary DB server.
 
 getScopedLockAndFlush ( $lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object.
 
 getServer ()
 Get the hostname or IP address of the server.
 
 getServerInfo ()
 Get a human-readable string describing the current software version.
 
 getServerName ()
 Get the readable name for the server.
 
 getSessionLagStatus ()
 Get a cached estimate of the seconds of replication lag on this database server, using the estimate obtained at the start of the current transaction if one is active.
 
 getTableAliases ()
 Return current table aliases.
 
 getTopologyRole ()
 Get the replication topology role of this server.
 
 implicitOrderby ()
 Returns true if this database does an implicit order by when the column has an index For example: SELECT page_title FROM page LIMIT 1.
 
 indexExists ( $table, $index, $fname=__METHOD__)
 Determines whether an index exists.
 
 indexUnique ( $table, $index, $fname=__METHOD__)
 Determines if a given index is unique.
 
 initConnection ()
 Initialize the connection to the database over the wire (or to local files)
 
 insert ( $table, $rows, $fname=__METHOD__, $options=[])
 Insert row(s) into a table, in the provided order.
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 INSERT SELECT wrapper.
 
 isOpen ()
 
 isQuotedIdentifier ( $name)
 
 isReadOnly ()
 Check if this DB server is marked as read-only according to load balancer info.
 
 lastDoneWrites ()
 Get the last time the connection may have been used for a write query.
 
 limitResult ( $sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset.
 
 lock ( $lockName, $method, $timeout=5, $flags=0)
 Acquire a named lock.Named locks are not related to transactions
Parameters
string$lockNameName of lock to acquire
string$methodName of the calling method
int$timeoutAcquisition timeout in seconds (0 means non-blocking)
int$flagsBit field of IDatabase::LOCK_* constants
Returns
bool|float|null Success (bool); acquisition time (float/null) if LOCK_TIMESTAMP
Exceptions
DBErrorIf an error occurs, {
See also
query}

 
 lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Lock all rows meeting the given conditions/options FOR UPDATE.
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is not locked by any thread (non-blocking)
Parameters
string$lockNameName of lock to poll
string$methodName of method calling us
Returns
bool
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.20

 
 makeList (array $a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array.
 
 makeWhereFrom2d ( $data, $baseKey, $subKey)
 Build a "OR" condition with pairs from a two-dimensional array.
 
 newDeleteQueryBuilder ()
 Get a DeleteQueryBuilder bound to this connection.
 
 newInsertQueryBuilder ()
 Get a InsertQueryBuilder bound to this connection.
 
 newReplaceQueryBuilder ()
 Get a ReplaceQueryBuilder bound to this connection.
 
 newSelectQueryBuilder ()
 Get a SelectQueryBuilder bound to this connection.
 
 newUnionQueryBuilder ()
 Get a UnionQueryBuilder bound to this connection.
 
 newUpdateQueryBuilder ()
 Get an UpdateQueryBuilder bound to this connection.
 
 nextSequenceValue ( $seqName)
 Deprecated method, calls should be removed.
 
 onAtomicSectionCancel (callable $callback, $fname=__METHOD__)
 Run a callback when the atomic section is cancelled.
 
 onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback when the current transaction commits or now if there is none.
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none.
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback when the current transaction commits or rolls back.
 
 pendingWriteAndCallbackCallers ()
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction.
 
 pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction.
 
 ping ()
 Ping the server and try to reconnect if it there is no connection.
 
 primaryPosWait (DBPrimaryPos $pos, $timeout)
 Wait for the replica server to catch up to a given primary server position.
 
 query ( $sql, $fname=__METHOD__, $flags=0)
 Run an SQL query statement and return the result.
 
 reportQueryError ( $error, $errno, $sql, $fname, $ignore=false)
 Report a query error.
 
 restoreFlags ( $state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call.
 
 rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Rollback a transaction previously started using begin()
 
 runOnTransactionIdleCallbacks ( $trigger, array &$errors=[])
 Consume and run any "on transaction idle/resolution" callbacks.
 
 runOnTransactionPreCommitCallbacks ()
 
 runTransactionListenerCallbacks ( $trigger, array &$errors=[])
 Actually run any "transaction listener" callbacks.
 
 select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided.
 
 selectDomain ( $domain)
 Set the current domain (database, schema, and table prefix)
 
 selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a single field from a single result row.
 
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a list of single field values from result rows.
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Wrapper to IDatabase::select() that only fetches one row (via LIMIT)
 
 selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Get the number of rows in dataset.
 
 sessionLocksPending ()
 
 setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Set a flag for this connection.
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB.
 
 setLBInfo ( $nameOrArray, $value=null)
 Set the entire array or a particular key of the managing load balancer info array.
 
 setLogger (LoggerInterface $logger)
 Set the PSR-3 logger interface to use.
 
 setSchemaVars ( $vars)
 Set schema variables to be used when streaming commands from SQL files or stdin.
 
 setTableAliases (array $aliases)
 Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.
 
 setTransactionListener ( $name, callable $callback=null)
 Run a callback after each time any transaction commits or rolls back.
 
 setTransactionManager (TransactionManager $transactionManager)
 
 setTrxEndCallbackSuppression ( $suppress)
 Whether to disable running of post-COMMIT/ROLLBACK callbacks.
 
 sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
 Read and execute SQL commands from a file.
 
 sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
 Read and execute commands from an open file handle.
 
 startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Begin an atomic section of SQL statements.
 
 strreplace ( $orig, $old, $new)
 Returns a SQL expression for simple string replacement (e.g.
 
 tableName (string $name, $format='quoted')
 Format a table name ready for use in constructing an SQL query.
 
 tableNames (... $tables)
 Fetch a number of table names into an associative array.
 
 tableNamesN (... $tables)
 Fetch a number of table names into a zero-indexed numerical array.
 
 tablePrefix ( $prefix=null)
 Get/set the table prefix.
 
 textFieldSize ( $table, $field)
 Returns the size of a text field, or -1 for "unlimited".
 
 timestamp ( $ts=0)
 Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.
 
 timestampOrNull ( $ts=null)
 Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.
 
 truncate ( $tables, $fname=__METHOD__)
 Delete all data in a table(s) and reset any sequences owned by that table(s)
 
 truncateTable ( $table, $fname=__METHOD__)
 Delete all data in a table and reset any sequences owned by that table.
 
 trxLevel ()
 Gets the current transaction level.
 
 trxStatus ()
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established.
 
 unionQueries ( $sqls, $all, $options=[])
 Construct a UNION query.
 
 unionSupportsOrderAndLimit ()
 Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.
 
 unlock ( $lockName, $method)
 Release a lock.Named locks are not related to transactions
Parameters
string$lockNameName of lock to release
string$methodName of the calling method
Returns
bool Success
Exceptions
DBErrorIf an error occurs, {
See also
query}

 
 update ( $table, $set, $conds, $fname=__METHOD__, $options=[])
 Update all rows in a table that match a given condition.
 
 writesOrCallbacksPending ()
 Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending.
 
 writesPending ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\Platform\ISQLPlatform
 buildSubString ( $input, $startPosition, $length=null)
 Build a SUBSTRING function.
 

Protected Member Functions

 checkInsertWarnings (Query $query, $fname)
 Check for warnings after performing an INSERT query, and throw exceptions if necessary.
 
 closeConnection ()
 Closes underlying database connection.
 
 doFlushSession ( $fname)
 Reset the server-side session state for named locks and table locks.
 
 doHandleSessionLossPreconnect ()
 Reset any additional subclass trx* and session* fields.
 
 doSelectDomain (DatabaseDomain $domain)
 
 doSingleStatementQuery (string $sql)
 Run a query and return a QueryStatus instance with the query result information.
 
 isConnectionError ( $errno)
 Do not use this method outside of Database/DBError classes.
 
 isInsertSelectSafe (array $insertOptions, array $selectOptions)
 
 isKnownStatementRollbackError ( $errno)
 
 isQueryTimeoutError ( $errno)
 Checks whether the cause of the error is detected to be a timeout.
 
 lastInsertId ()
 Get a row ID from the last insert statement to implicitly assign one within the session.
 
 open ( $server, $user, $password, $db, $schema, $tablePrefix)
 Open a new connection to the database (closing any existing one)
 
- Protected Member Functions inherited from Wikimedia\Rdbms\Database
 assertHasConnectionHandle ()
 Make sure there is an open connection handle (alive or not)
 
 commenceCriticalSection (string $fname)
 Demark the start of a critical section of session/transaction state changes.
 
 completeCriticalSection (string $fname, ?CriticalSectionScope $csm, Throwable $trxError=null)
 Demark the completion of a critical section of session/transaction state changes.
 
 doBegin ( $fname)
 Issues the BEGIN command to the database server.
 
 doInsertSelectNative ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds)
 Native server-side implementation of insertSelect() for situations where we don't want to select everything into memory.
 
 executeQuery ( $sql, $fname, $flags)
 Execute a query without enforcing public (non-Database) caller restrictions.
 
 getBindingHandle ()
 Get the underlying binding connection handle.
 
 getInsertIdColumnForUpsert ( $table)
 
 getLastPHPError ()
 
 getLogContext (array $extras=[])
 Create a log context to pass to PSR-3 logger functions.
 
 getReadOnlyReason ()
 
 getTransactionRoundId ()
 
 getValueTypesForWithClause ( $table)
 
 installErrorHandler ()
 Set a custom error handler for logging errors during database connection.
 
 newExceptionAfterConnectError ( $error)
 
 registerTempTables (Query $query)
 Register creation and dropping of temporary tables.
 
 replaceLostConnection ( $lastErrno, $fname)
 Close any existing (dead) database connection and open a new connection.
 
 restoreErrorHandler ()
 Restore the previous error handler and return the last PHP error for this DB.
 

Protected Attributes

SQLPlatform $platform
 
MysqlReplicationReporter $replicationReporter
 
- Protected Attributes inherited from Wikimedia\Rdbms\Database
string $agent
 Agent name for query profiling.
 
bool $cliMode
 Whether this PHP instance is for a CLI script.
 
object resource null $conn
 Database connection.
 
array< string, mixed > $connectionParams
 Connection parameters used by initConnection() and open()
 
string[] int[] float[] $connectionVariables
 SQL variables values to use for all new connections.
 
int null $connectTimeout
 Maximum seconds to wait on connection attempts.
 
CriticalSectionProvider null $csProvider
 
DatabaseDomain $currentDomain
 
string false $delimiter = ';'
 Current SQL query delimiter.
 
callable $deprecationLogger
 Deprecation logging callback.
 
callable $errorLogger
 Error logging callback.
 
DatabaseFlags $flagsHolder
 
string $lastConnectError = ''
 Last error during connection; empty string if none.
 
int null $lastEmulatedAffectedRows
 Affected row count for the last query method call; null if unspecified.
 
int null $lastEmulatedInsertId
 Insert (row) ID for the last query method call; null if unspecified.
 
int $lastQueryAffectedRows = 0
 Affected row count for the last statement to query()
 
int null $lastQueryInsertId
 Insert (row) ID for the last statement to query() (null if not supported)
 
array $lbInfo = []
 Current LoadBalancer tracking information.
 
LoggerInterface $logger
 
int $nonNativeInsertSelectBatchSize
 Row batch size to use for emulated INSERT SELECT queries.
 
SQLPlatform $platform
 
callable null $profiler
 
int null $receiveTimeout
 Maximum seconds to wait on receiving query results.
 
ReplicationReporter $replicationReporter
 
string null $serverName
 Readable name or host/IP of the database server.
 
array< string, array > $sessionNamedLocks = []
 Map of (name => (UNIX time,trx ID)) for current lock() mutexes.
 
array< string, TempTableInfo$sessionTempTables = []
 Current temp tables.
 
bool $ssl
 Whether to use SSL connections.
 
bool $strictWarnings
 Whether to check for warnings.
 
const CONN_HOST = 'host'
 Hostname or IP address to use on all connections.
 
const CONN_INITIAL_DB = 'dbname'
 Database name to use on initial connection.
 
const CONN_INITIAL_SCHEMA = 'schema'
 Schema name to use on initial connection.
 
const CONN_INITIAL_TABLE_PREFIX = 'tablePrefix'
 Table prefix to use on initial connection.
 
const CONN_PASSWORD = 'password'
 Database server password to use on all connections.
 
const CONN_USER = 'user'
 Database server username to use on all connections.
 
const DROPPED_CONN_BLAME_THRESHOLD_SEC = 3.0
 Assume that queries taking this long to yield connection loss errors are at fault.
 
const ERR_ABORT_QUERY = 2
 Abort query (no retries) due to a statement rollback (session/transaction intact)
 
const ERR_ABORT_SESSION = 8
 Abort and reset session due to server-side session-level state loss (locks, temp tables)
 
const ERR_ABORT_TRX = 4
 Abort any current transaction, by rolling it back, due to an error during the query.
 
const ERR_NONE = 0
 No errors occurred during the query.
 
const ERR_RETRY_QUERY = 1
 Retry query due to a connection loss detected while sending the query (session intact)
 

Additional Inherited Members

- Static Public Member Functions inherited from Wikimedia\Rdbms\Database
static getAttributes ()
 
static getCacheSetOptions (?IReadableDatabase ... $dbs)
 Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination.
 
- Public Attributes inherited from Wikimedia\Rdbms\IDatabase
const LOCK_TIMESTAMP = 1
 Flag to return the lock acquisition timestamp (null if not acquired)
 
- Public Attributes inherited from Wikimedia\Rdbms\Platform\ISQLPlatform
const QUERY_PSEUDO_PERMANENT = 2
 Track a TEMPORARY table CREATE as if it was for a permanent table (for testing)
 
- Public Attributes inherited from Wikimedia\Rdbms\Database\IDatabaseFlags
const DBO_COMPRESS = 512
 Enable compression in connection protocol.
 
const DBO_DDLMODE = 128
 Schema file mode; was used by Oracle.
 
const DBO_DEBUG = 1
 Enable debug logging of all SQL queries.
 
const DBO_DEFAULT = 16
 Join load balancer transaction rounds (which control DBO_TRX) in non-CLI mode.
 
const DBO_GAUGE = 1024
 Optimize connection for guaging server state (e.g.
 
const DBO_IGNORE = 4
 Unused since 1.31.
 
const DBO_NOBUFFER = 2
 Unused since 1.34.
 
const DBO_PERSISTENT = 32
 Use DB persistent connections if possible.
 
const DBO_SSL = 256
 Enable SSL/TLS in connection protocol.
 
const DBO_SYSDBA = 64
 DBA session mode; was used by Oracle.
 
const DBO_TRX = 8
 Automatically start a transaction before running a query if none is active.
 
const REMEMBER_NOTHING = ''
 Do not remember the prior flags.
 
const REMEMBER_PRIOR = 'remember'
 Remember the prior flags.
 
const RESTORE_INITIAL = 'initial'
 Restore to the initial flag state.
 
const RESTORE_PRIOR = 'prior'
 Restore to the prior flag state.
 

Detailed Description

Definition at line 42 of file DatabaseMySQL.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\DatabaseMySQL::__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. The "conds" key overrides the WHERE clause used to find the relevant row in the heartbeat table, e.g. ['shard' => 's1']. By default, the row used is the newest row having a server_id matching that of the immediate replication source server for the given replica.
  • useGTIDs : use GTID methods like MASTER_GTID_WAIT() when possible.
  • sslKeyPath : path to key file [default: null]
  • sslCertPath : path to certificate file [default: null]
  • sslCAFile: path to a single certificate authority PEM file [default: null]
  • sslCAPath : parth to certificate authority PEM directory [default: null]
  • sslCiphers : array list of allowable ciphers [default: null]
    Parameters
    array$params

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 87 of file DatabaseMySQL.php.

References $params.

Member Function Documentation

◆ checkInsertWarnings()

Wikimedia\Rdbms\DatabaseMySQL::checkInsertWarnings ( Query $query,
$fname )
protected

Check for warnings after performing an INSERT query, and throw exceptions if necessary.

Parameters
Query$query
string$fname
Returns
void

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 256 of file DatabaseMySQL.php.

References Wikimedia\Rdbms\Query\getSQL(), and Wikimedia\Rdbms\Database\reportQueryError().

◆ closeConnection()

Wikimedia\Rdbms\DatabaseMySQL::closeConnection ( )
protected

Closes underlying database connection.

Returns
bool Whether connection was closed successfully
Since
1.20

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 823 of file DatabaseMySQL.php.

◆ doFlushSession()

Wikimedia\Rdbms\DatabaseMySQL::doFlushSession ( $fname)
protected

Reset the server-side session state for named locks and table locks.

Connection and query errors will be suppressed and logged

Parameters
string$fname
Since
1.38

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 540 of file DatabaseMySQL.php.

◆ doHandleSessionLossPreconnect()

Wikimedia\Rdbms\DatabaseMySQL::doHandleSessionLossPreconnect ( )
protected

Reset any additional subclass trx* and session* fields.

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 831 of file DatabaseMySQL.php.

◆ doLock()

Wikimedia\Rdbms\DatabaseMySQL::doLock ( string $lockName,
string $method,
int $timeout )
See also
lock()
Parameters
string$lockName
string$method
int$timeout
Returns
float|null UNIX timestamp of lock acquisition; null on failure
Exceptions
DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 524 of file DatabaseMySQL.php.

◆ doLockIsFree()

Wikimedia\Rdbms\DatabaseMySQL::doLockIsFree ( string $lockName,
string $method )
See also
lockIsFree()
Parameters
string$lockName
string$method
Returns
bool Success
Exceptions
DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 516 of file DatabaseMySQL.php.

◆ doSelectDomain()

◆ doSingleStatementQuery()

Wikimedia\Rdbms\DatabaseMySQL::doSingleStatementQuery ( string $sql)
protected

Run a query and return a QueryStatus instance with the query result information.

This is meant to handle the basic command of actually sending a query to the server via the driver. No implicit transaction, reconnection, nor retry logic should happen here. The higher level query() method is designed to handle those sorts of concerns. This method should not trigger such higher level methods.

The lastError() and lastErrno() methods should meaningfully reflect what error, if any, occurred during the last call to this method. Methods like executeQuery(), query(), select(), insert(), update(), delete(), and upsert() implement their calls to doQuery() such that an immediately subsequent call to lastError()/lastErrno() meaningfully reflects any error that occurred during that public query method call.

For SELECT queries, the result field contains either:

  • a) A driver-specific IResultWrapper describing the query results
  • b) False, on any query failure

For non-SELECT queries, the result field contains either:

  • a) A driver-specific IResultWrapper, only on success
  • b) True, only on success (e.g. no meaningful result other than "OK")
  • c) False, on any query failure
Parameters
string$sqlSingle-statement SQL query
Returns
QueryStatus
Since
1.39

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 720 of file DatabaseMySQL.php.

◆ doUnlock()

Wikimedia\Rdbms\DatabaseMySQL::doUnlock ( string $lockName,
string $method )
See also
unlock()
Parameters
string$lockName
string$method
Returns
bool Success
Exceptions
DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 532 of file DatabaseMySQL.php.

◆ duplicateTableStructure()

Wikimedia\Rdbms\DatabaseMySQL::duplicateTableStructure ( $oldName,
$newName,
$temporary = false,
$fname = __METHOD__ )
Parameters
string$oldName
string$newName
bool$temporary
string$fname
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 650 of file DatabaseMySQL.php.

◆ estimateRowCount()

Wikimedia\Rdbms\DatabaseMySQL::estimateRowCount ( $tables,
$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$tables
string | array$var
string | array$conds
string$fname
string | array$options
array$join_conds
Returns
int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 298 of file DatabaseMySQL.php.

◆ fieldInfo()

Wikimedia\Rdbms\DatabaseMySQL::fieldInfo ( $table,
$field )
Parameters
string$table
string$field
Returns
MySQLField|false

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 359 of file DatabaseMySQL.php.

◆ getServerVersion()

Wikimedia\Rdbms\DatabaseMySQL::getServerVersion ( )
Returns
string

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 463 of file DatabaseMySQL.php.

◆ getSoftwareLink()

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

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 429 of file DatabaseMySQL.php.

◆ getType()

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

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 115 of file DatabaseMySQL.php.

◆ indexInfo()

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

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

Parameters
string$table
string$index
string$fname
Returns
bool|array|null False or null on failure

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 383 of file DatabaseMySQL.php.

◆ insertId()

Wikimedia\Rdbms\DatabaseMySQL::insertId ( )

Get the sequence-based ID assigned by the last query method call.

This method should only be called when all the following hold true:

  • (a) A method call was made to insert(), upsert(), replace(), or insertSelect()
  • (b) The method call attempts to insert exactly one row
  • (c) The method call omits the value of exactly one auto-increment column
  • (d) The method call succeeded
  • (e) No subsequent method calls were made, with the exception of affectedRows(), lastErrno(), lastError(), and getType()

In all other cases, the return value is unspecified.

When the query method is either insert() with "IGNORE", upsert(), or insertSelect(), callers should first check affectedRows() before calling this method, making sure that the query method actually created a row. Otherwise, an ID from a previous insert might be incorrectly assumed to belong to last insert.

Returns
int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 836 of file DatabaseMySQL.php.

◆ isConnectionError()

Wikimedia\Rdbms\DatabaseMySQL::isConnectionError ( $errno)
protected

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

Parameters
int | string$errno
Returns
bool Whether the given query error was a connection drop
Since
1.38

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 619 of file DatabaseMySQL.php.

◆ isInsertSelectSafe()

Wikimedia\Rdbms\DatabaseMySQL::isInsertSelectSafe ( array $insertOptions,
array $selectOptions )
protected
Parameters
array$insertOptions
array$selectOptions
Returns
bool Whether an INSERT SELECT with these options will be replication safe
Since
1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 233 of file DatabaseMySQL.php.

◆ isKnownStatementRollbackError()

Wikimedia\Rdbms\DatabaseMySQL::isKnownStatementRollbackError ( $errno)
protected
Parameters
int | string$errno
Returns
bool Whether it is known that the last query error only caused statement rollback
Note
This is for backwards compatibility for callers catching DBError exceptions in order to ignore problems like duplicate key errors or foreign key violations
Since
1.39

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 633 of file DatabaseMySQL.php.

◆ isQueryTimeoutError()

Wikimedia\Rdbms\DatabaseMySQL::isQueryTimeoutError ( $errno)
protected

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

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

Parameters
int | string$errnoError number
Returns
bool
Since
1.39

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 626 of file DatabaseMySQL.php.

◆ lastErrno()

Wikimedia\Rdbms\DatabaseMySQL::lastErrno ( )
Returns
int

Implements Wikimedia\Rdbms\IReadableDatabase.

Definition at line 849 of file DatabaseMySQL.php.

◆ lastError()

Wikimedia\Rdbms\DatabaseMySQL::lastError ( )

◆ lastInsertId()

Wikimedia\Rdbms\DatabaseMySQL::lastInsertId ( )
protected

Get a row ID from the last insert statement to implicitly assign one within the session.

If the statement involved assigning sequence IDs to multiple rows, then the return value will be any one of those values (database-specific). If the statement was an "UPSERT" and some existing rows were updated, then the result will either reflect only IDs of created rows or it will reflect IDs of both created and updated rows (this is database-specific).

The result is unspecified if the statement gave an error.

Returns
int Sequence ID, 0 (if none)
Exceptions
DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 827 of file DatabaseMySQL.php.

◆ listTables()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 674 of file DatabaseMySQL.php.

References Wikimedia\Rdbms\IExpression\LIKE.

◆ open()

Wikimedia\Rdbms\DatabaseMySQL::open ( $server,
$user,
$password,
$db,
$schema,
$tablePrefix )
protected

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

Parameters
string | null$serverServer host/address and optional port {
See also
connectionParams}
Parameters
string | null$userUser name {
See also
connectionParams}
Parameters
string | null$passwordUser password {
See also
connectionParams}
Parameters
string | null$dbDatabase name
string | null$schemaDatabase schema name
string$tablePrefix
Exceptions
DBConnectionError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 119 of file DatabaseMySQL.php.

References Wikimedia\Rdbms\Database\addQuotes(), Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\executeQuery(), Wikimedia\Rdbms\Database\installErrorHandler(), Wikimedia\Rdbms\DatabaseMySQL\lastError(), Wikimedia\Rdbms\Database\newExceptionAfterConnectError(), Wikimedia\Rdbms\Database\reportQueryError(), and Wikimedia\Rdbms\Database\restoreErrorHandler().

◆ replace()

Wikimedia\Rdbms\DatabaseMySQL::replace ( $table,
$uniqueKeys,
$rows,
$fname = __METHOD__ )

Insert row(s) into a table, in the provided order, while deleting conflicting rows.

Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.

Note some important implications of the deletion semantics:

  • If the table has an AUTOINCREMENT column and $rows omit that column, then any conflicting existing rows will be replaced with newer having higher values for that column, even if nothing else changed.
  • There might be worse contention than upsert() due to the use of gap-locking. This does not apply to RDBMS types that use predicate locking nor those that just lock the whole table or databases anyway.

This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.

Access: internal
callers outside of rdbms library should use ReplaceQueryBuilder instead.
Parameters
string$tableUnqualified name of table
string | string[] | string[][]$uniqueKeysColumn name or non-empty list of column name lists that define all applicable unique keys on the table. There must only be one such key. Each unique key on the table is "applicable" unless either:
  • It involves an AUTOINCREMENT column for which no values are assigned in $rows
  • It involves a UUID column for which newly generated UUIDs are assigned in $rows
array | array[]$rowsRow(s) to insert, in the form of either:
  • A string-keyed map of (column name => value) defining a new row. Values are treated as literals and quoted appropriately; null is interpreted as NULL. Columns belonging to a key in $uniqueKeys must be defined here and non-null.
  • An integer-keyed list of such string-keyed maps, defining a list of new rows. The keys in each map must be identical to each other and in the same order. The rows must not collide with each other.
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBErrorIf an error occurs, {
See also
query}

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 583 of file DatabaseMySQL.php.

◆ selectSQLText()

Wikimedia\Rdbms\DatabaseMySQL::selectSQLText ( $table,
$vars,
$conds = '',
$fname = __METHOD__,
$options = [],
$join_conds = [] )

Take the same arguments as IDatabase::select() and return the SQL it would use.

This can be useful for making UNION queries, where the SQL text of each query is needed. In general, however, callers outside of Database classes should just use select().

See also
IDatabase::select()
Parameters
string | array$tableUnqualified name of table(s)
string | array$varsField names
string|IExpression|array<string,?scalar|non-empty-array<int,?scalar>>|array<int,string|IExpression>$conds Conditions
string$fnameCaller function name
string | array$optionsQuery options
string | array$join_condsJoin conditions
Returns
string SQL query string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 691 of file DatabaseMySQL.php.

◆ serverIsReadOnly()

Wikimedia\Rdbms\DatabaseMySQL::serverIsReadOnly ( )

Returns
bool Whether this DB server is running in server-side read-only mode
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.28

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 416 of file DatabaseMySQL.php.

◆ setSessionOptions()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 479 of file DatabaseMySQL.php.

◆ streamStatementEnd()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 507 of file DatabaseMySQL.php.

◆ strencode()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 412 of file DatabaseMySQL.php.

◆ tableExists()

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

Query whether a given table exists.

Parameters
string$tableUnqualified name of table
string$fname
Returns
bool
Exceptions
DBErrorIf an error occurs, {
See also
query}

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 329 of file DatabaseMySQL.php.

◆ upsert()

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

Upsert row(s) into a table, in the provided order, while updating conflicting rows.

Conflicts are determined by the provided unique indexes. Note that it is possible for the provided rows to conflict even among themselves; it is preferable for the caller to de-duplicate such input beforehand.

This operation will be seen by affectedRows()/insertId() as one query statement, regardless of how many statements are actually sent by the class implementation.

Access: internal
callers outside of rdbms library should use InsertQueryBuilder instead.
Parameters
string$tableUnqualified name of table
array | array[]$rowsRow(s) to insert, in the form of either:
  • A string-keyed map of (column name => value) defining a new row. Values are treated as literals and quoted appropriately; null is interpreted as NULL. Columns belonging to a key in $uniqueKeys must be defined here and non-null.
  • An integer-keyed list of such string-keyed maps, defining a list of new rows. The keys in each map must be identical to each other and in the same order. The rows must not collide with each other.
string | string[] | string[][]$uniqueKeysColumn name or non-empty list of column name lists that define all applicable unique keys on the table. There must only be one such key. Each unique key on the table is "applicable" unless either:
  • It involves an AUTOINCREMENT column for which no values are assigned in $rows
  • It involves a UUID column for which newly generated UUIDs are assigned in $rows
array<string,?scalar>|array<int,string>$set Combination map/list where each string-keyed entry maps a column to a literal assigned value and each integer-keyed value is a SQL assignment expression of the form "<unquoted alphanumeric column> = <SQL expression>". The (column => value) entries are convenient due to automatic value quoting and conversion of null to NULL. The SQL assignment entries are useful for updates like "column = column + X". All of the assignments have no defined execution order, so callers should make sure that they not depend on each other. Do not modify AUTOINCREMENT or UUID columns in assignments, even if they are just "secondary" unique keys. For multi-row upserts, use buildExcludedValue() to reference the value of a column from the corresponding row in $rows that conflicts with the current row.
string$fnameCalling function name (use METHOD) for logs/profiling
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.22

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 559 of file DatabaseMySQL.php.

◆ wasDeadlock()

Wikimedia\Rdbms\DatabaseMySQL::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 605 of file DatabaseMySQL.php.

◆ wasReadOnlyError()

Wikimedia\Rdbms\DatabaseMySQL::wasReadOnlyError ( )

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

Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 614 of file DatabaseMySQL.php.

Member Data Documentation

◆ $platform

SQLPlatform Wikimedia\Rdbms\DatabaseMySQL::$platform
protected

Definition at line 61 of file DatabaseMySQL.php.

◆ $replicationReporter

MysqlReplicationReporter Wikimedia\Rdbms\DatabaseMySQL::$replicationReporter
protected

Definition at line 64 of file DatabaseMySQL.php.


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