MediaWiki  master
Wikimedia\Rdbms\DatabaseMysqlBase Class Reference

Database abstraction object for MySQL. More...

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

Public Member Functions

 __construct (array $params)
 Additional $params include: More...
 
 addIdentifierQuotes ( $s)
 MySQL uses backticks for identifier quoting instead of the sql standard "double quotes". More...
 
 buildIntegerCast ( $field)
 
 buildStringCast ( $field)
 
Parameters
string$fieldField or column to cast
Returns
string
Since
1.28
Stability: stable
to override
More...
 
 deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
 DELETE where the condition is a join. More...
 
 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() More...
 
 fieldInfo ( $table, $field)
 
 fieldType ( $res, $n)
 mysql_field_type() wrapper More...
 
 getMasterPos ()
 
 getPrimaryPos ()
 Get the position of the primary DB from SHOW MASTER STATUS. More...
 
 getReplicaPos ()
 Get the position of the primary DB from SHOW SLAVE STATUS. More...
 
 getServerUptime ()
 Determines how long the server has been up. More...
 
 getServerVersion ()
 
 getSoftwareLink ()
 
 getTopologyBasedServerId ()
 Get a non-recycled ID that uniquely identifies this server within the replication topology.A replication topology defines which servers can originate changes to a given dataset and how those changes propagate among database servers. It is assumed that the server only participates in the replication of a single relevant dataset.
Returns
string|null 32, 64, or 128 bit integer ID; null if not applicable or unknown
Exceptions
DBQueryError
Since
1.37
More...
 
 getType ()
 
 ignoreIndexClause ( $index)
 
 indexInfo ( $table, $index, $fname=__METHOD__)
 Get information about an index into an object Returns false if the index does not exist. More...
 
 isQuotedIdentifier ( $name)
 
 isView ( $name, $prefix=null)
 Differentiates between a TABLE and a VIEW. More...
 
 lastError ()
 
 listTables ( $prefix=null, $fname=__METHOD__)
 List all tables on the database. More...
 
 listViews ( $prefix=null, $fname=__METHOD__)
 Lists VIEWs in the database. More...
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues.
Returns
bool
Since
1.26
Stability: stable
to override
More...
 
 primaryPosWait (DBPrimaryPos $pos, $timeout)
 Wait for the replica DB to catch up to a given primary DB position.Note that this does not start any new transactions. If any existing transaction is flushed, and this is called, then queries will reflect the point the DB was synced up to (on success) without interference from REPEATABLE-READ snapshots.
Parameters
DBPrimaryPos$pos
int$timeoutThe maximum number of seconds to wait for synchronisation
Returns
int|null Zero if the replica DB was past that position already, greater than zero if we waited for some period of time, less than zero if it timed out, and null on error
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.37
Since
1.37
Stability: stable
to override
More...
 
 serverIsReadOnly ()
 
Returns
bool Whether the DB is marked as read-only server-side
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.28
Stability: stable
to override
More...
 
 setBigSelects ( $value=true)
 
 setSessionOptions (array $options)
 
 streamStatementEnd (&$sql, &$newLine)
 
 strencode ( $s)
 
 tableExists ( $table, $fname=__METHOD__)
 Query whether a given table exists. More...
 
 tableLocksHaveTransactionScope ()
 Checks if table locks acquired by lockTables() are transaction-bound in their scope. More...
 
 useIndexClause ( $index)
 
 wasConnectionError ( $errno)
 Do not use this method outside of Database/DBError classes. More...
 
 wasDeadlock ()
 Determines if the last failure was due to a deadlock. More...
 
 wasLockTimeout ()
 Determines if the last failure was due to a lock timeout. More...
 
 wasReadOnlyError ()
 Determines if the last failure was due to the database being read-only. More...
 
- Public Member Functions inherited from Wikimedia\Rdbms\Database
 __clone ()
 Make sure that copies do not share the same client binding handle. More...
 
 __destruct ()
 Run a few simple sanity checks and close dangling connections. More...
 
 __sleep ()
 Called by serialize. More...
 
 __toString ()
 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. More...
 
 addQuotes ( $s)
 Escape and quote a raw value string for use in a SQL query.
Parameters
string | int | float | null | bool | Blob$s
Returns
string
More...
 
 affectedRows ()
 Get the number of rows affected by the last write query. More...
 
 aggregateValue ( $valuedata, $valuename='value')
 Return aggregated value alias.
Parameters
array$valuedata
string$valuename
Returns
array|string
Deprecated:
Since 1.33
More...
 
 anyChar ()
 Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More...
 
 anyString ()
 Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More...
 
 assertNoOpenTransactions ()
 Assert that all explicit transactions or atomic sections have been closed. More...
 
 begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT)
 Begin a transaction. More...
 
 bitAnd ( $fieldLeft, $fieldRight)
 
Parameters
string | int$fieldLeft
string | int$fieldRight
Returns
string
More...
 
 bitNot ( $field)
 
Parameters
string | int$field
Returns
string
More...
 
 bitOr ( $fieldLeft, $fieldRight)
 
Parameters
string | int$fieldLeft
string | int$fieldRight
Returns
string
More...
 
 buildConcat ( $stringList)
 Build a concatenation list to feed into a SQL query.
Parameters
string[]$stringListRaw SQL expression list; caller is responsible for escaping
Returns
string
More...
 
 buildGreatest ( $fields, $values)
 Build a GREATEST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
Parameters
string | string[]$fieldsName(s) of column(s) with values to compare
string | int | float | string[] | int[] | float[]$valuesValues to compare
Returns
mixed
Since
1.35
More...
 
 buildGroupConcatField ( $delim, $table, $field, $conds='', $join_conds=[])
 Build a GROUP_CONCAT or equivalent statement for a query.This is useful for combining a field for several rows into a single string. NULL values will not appear in the output, duplicated values will appear, and the resulting delimiter-separated values have no defined sort order. Code using the results may need to use the PHP unique() or sort() methods.
Parameters
string$delimGlue to bind the results together
string | array$tableTable name
string$fieldField name
string | array$condsConditions
string | array$join_condsJoin conditions
Returns
string SQL text
Since
1.23
More...
 
 buildLeast ( $fields, $values)
 Build a LEAST function statement comparing columns/values.Integer and float values in $values will not be quotedIf $fields is an array, then each value with a string key is treated as an expression (which must be manually quoted); such string keys do not appear in the SQL and are only descriptive aliases.
Parameters
string | string[]$fieldsName(s) of column(s) with values to compare
string | int | float | string[] | int[] | float[]$valuesValues to compare
Returns
mixed
Since
1.35
More...
 
 buildLike ( $param,... $params)
 LIKE statement wrapper.This takes a variable-length argument list with parts of pattern to match containing either string literals that will be escaped or tokens returned by anyChar() or anyString(). Alternatively, the function could be provided with an array of aforementioned parameters.Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches for subpages of 'My page title'. Alternatively: $pattern = [ 'My_page_title/', $dbr->anyString() ]; $query .= $dbr->buildLike( $pattern );
Since
1.16
Parameters
array[] | string | LikeMatch$param
string|LikeMatch...$params
Returns
string Fully built LIKE statement
More...
 
 buildSelectSubquery ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Equivalent to IDatabase::selectSQLText() except wraps the result in Subquery. More...
 
 buildSubstring ( $input, $startPosition, $length=null)
 
 cancelAtomic ( $fname=__METHOD__, AtomicSectionIdentifier $sectionId=null)
 Cancel an atomic section of SQL statements. More...
 
 clearFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Clear a flag for this connection. More...
 
 close ( $fname=__METHOD__, $owner=null)
 Close the database connection. More...
 
 commit ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commits a transaction previously started using begin() More...
 
 conditional ( $cond, $caseTrueExpression, $caseFalseExpression)
 Returns an SQL expression for a simple conditional.This doesn't need to be overridden unless CASE isn't supported in the RDBMS.
Parameters
string | array$condSQL condition expression (yields a boolean)
string$caseTrueExpressionSQL expression to return when the condition is true
string$caseFalseExpressionSQL expression to return when the condition is false
Returns
string SQL fragment
More...
 
 connectionErrorLogger ( $errno, $errstr)
 Error handler for logging errors during database connection. More...
 
 databasesAreIndependent ()
 Returns true if DBs are assumed to be on potentially different servers.In systems like mysql/mariadb, different databases can easily be referenced on a single connection merely by name, even in a single query via JOIN. On the other hand, Postgres treats databases as logically separate, with different database users, requiring special mechanisms like postgres_fdw to "mount" foreign DBs. This is true even among DBs on the same server. Changing the selected database via selectDomain() requires a new connection.
Returns
bool
Since
1.29
More...
 
 dataSeek (IResultWrapper $res, $pos)
 Change the position of the cursor in a result object. More...
 
 dbSchema ( $schema=null)
 Get/set the db schema. More...
 
 deadlockLoop (... $args)
 Perform a deadlock-prone transaction.This function invokes a callback function to perform a set of write queries. If a deadlock occurs during the processing, the transaction will be rolled back and the callback function will be called again.Avoid using this method outside of Job or Maintenance classes.Usage: $dbw->deadlockLoop( callback, ... );Extra arguments are passed through to the specified callback function. This method requires that no transactions are already active to avoid causing premature commits or exceptions.Returns whatever the callback function returned on its successful, iteration, or false on error, for example if the retry limit was reached.
Parameters
mixed...$args
Returns
mixed
Exceptions
DBUnexpectedError
Exception
More...
 
 decodeBlob ( $b)
 Some DBMSs return a special placeholder object representing blob fields in result objects.Pass the object through this function to return the original string.
Parameters
string | Blob$b
Returns
string
Exceptions
DBError
More...
 
 decodeExpiry ( $expiry, $format=TS_MW)
 Decode an expiry time into a DBMS independent format. More...
 
 delete ( $table, $conds, $fname=__METHOD__)
 Delete all rows in a table that match a condition. More...
 
 doAtomicSection ( $fname, callable $callback, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Perform an atomic section of reversable SQL statements from a callback. More...
 
 dropTable ( $table, $fname=__METHOD__)
 Delete a table. More...
 
 encodeBlob ( $b)
 Some DBMSs have a special format for inserting into blob fields, they don't allow simple quoted strings to be inserted.To insert into such a field, pass the data through this function before passing it to IDatabase::insert().
Parameters
string$b
Returns
string|Blob
Exceptions
DBError
More...
 
 encodeExpiry ( $expiry)
 Encode an expiry time into the DBMS dependent format. More...
 
 endAtomic ( $fname=__METHOD__)
 Ends an atomic section of SQL statements. More...
 
 explicitTrxActive ()
 
 fetchObject (IResultWrapper $res)
 Fetch the next row from the given result object, in object form. More...
 
 fetchRow (IResultWrapper $res)
 Fetch the next row from the given result object, in associative array form. More...
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. More...
 
 fieldName (IResultWrapper $res, $n)
 Get a field name in a result object. More...
 
 flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commit any transaction but error out if writes or callbacks are pending. More...
 
 freeResult (IResultWrapper $res)
 Free a result object returned by query() or select() More...
 
 getDBname ()
 Get the current database name; null if there isn't one. More...
 
 getDomainID ()
 Return the currently selected domain ID. More...
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is.Most DBMSes support this. This is a special keyword for timestamps in PostgreSQL, and works with CHAR(14) as well because "i" sorts after all numbers.
Returns
string
More...
 
 getLag ()
 Get the amount of replication lag for this database server. More...
 
 getLBInfo ( $name=null)
 Get properties passed down from the server info array of the load balancer. More...
 
 getScopedLockAndFlush ( $lockKey, $fname, $timeout)
 Acquire a named lock, flush any transaction, and return an RAII style unlocker object. More...
 
 getServer ()
 Get the hostname or IP address of the server. More...
 
 getServerInfo ()
 Get a human-readable string describing the current software version. More...
 
 getServerName ()
 Get the readable name for the server. More...
 
 getSessionLagStatus ()
 Get the replica DB lag when the current transaction started or a general lag estimate if not transaction is active. More...
 
 getTopologyRole ()
 Get the replication topology role of this server. More...
 
 getTopologyRootMaster ()
 
 getTopologyRootPrimary ()
 Get the readable name of the sole root primary DB server for the replication topology. 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.
Returns
bool
More...
 
 indexExists ( $table, $index, $fname=__METHOD__)
 Determines whether an index exists. More...
 
 indexUnique ( $table, $index, $fname=__METHOD__)
 Determines if a given index is unique.
Parameters
string$table
string$index
string$fnameCalling function name
Returns
bool
More...
 
 initConnection ()
 Initialize the connection to the database over the wire (or to local files) More...
 
 insert ( $table, $rows, $fname=__METHOD__, $options=[])
 Insert the given row(s) into a table. More...
 
 insertSelect ( $destTable, $srcTable, $varMap, $conds, $fname=__METHOD__, $insertOptions=[], $selectOptions=[], $selectJoinConds=[])
 INSERT SELECT wrapper. More...
 
 isOpen ()
 
 isReadOnly ()
 
 lastDoneWrites ()
 Get the last time the connection may have been used for a write query. More...
 
 lastQuery ()
 Get the last query that sent on account of IDatabase::query() More...
 
 limitResult ( $sql, $limit, $offset=false)
 Construct a LIMIT query with optional offset.The SQL should be adjusted so that only the first $limit rows are returned. If $offset is provided as well, then the first $offset rows should be discarded, and the next $limit rows should be returned. If the result of the query is not ordered, then the rows to be returned are theoretically arbitrary.$sql is expected to be a SELECT, if that makes a difference.
Parameters
string$sqlSQL query we will append the limit too
int$limitThe SQL limit
int | bool$offsetThe SQL offset (default false)
Returns
string
Since
1.34
More...
 
 lock ( $lockName, $method, $timeout=5, $flags=0)
 Acquire a named lock.Named locks are not related to transactions
Parameters
string$lockNameName of lock to aquire
string$methodName of the calling method
int$timeoutAcquisition timeout in seconds (0 means non-blocking)
int$flagsBit field of IDatabase::LOCK_* constants
Returns
bool Success
Exceptions
DBErrorIf an error occurs, {
See also
query}
More...
 
 lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Lock all rows meeting the given conditions/options FOR UPDATE. More...
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is not locked by any thread (non-blocking)
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
More...
 
 lockTables (array $read, array $write, $method)
 Lock specific tables. More...
 
 makeList (array $a, $mode=self::LIST_COMMA)
 Makes an encoded list of strings from an array. More...
 
 makeWhereFrom2d ( $data, $baseKey, $subKey)
 Build a partial where clause from a 2-d array such as used for LinkBatch. More...
 
 masterPosWait (DBPrimaryPos $pos, $timeout)
 
Deprecated:
since 1.37; use primaryPosWait() instead.
Parameters
DBPrimaryPos$pos
int$timeoutThe maximum number of seconds to wait for synchronisation
Returns
int|null Zero if the replica DB was past that position already, greater than zero if we waited for some period of time, less than zero if it timed out, and null on error
Exceptions
DBErrorIf an error occurs, {
See also
query}
More...
 
 maxListLen ()
 Return the maximum number of items allowed in a list, or 0 for unlimited.
Returns
int
More...
 
 newSelectQueryBuilder ()
 Create an empty SelectQueryBuilder which can be used to run queries against this connection.
Returns
SelectQueryBuilder
More...
 
 nextSequenceValue ( $seqName)
 Deprecated method, calls should be removed. More...
 
 numFields (IResultWrapper $res)
 Get the number of fields in a result object. More...
 
 numRows ( $res)
 Get the number of rows in a query result. More...
 
 onAtomicSectionCancel (callable $callback, $fname=__METHOD__)
 Run a callback when the atomic section is cancelled. More...
 
 onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback when the current transaction commits or now if there is none. More...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Alias for onTransactionCommitOrIdle() for backwards-compatibility. More...
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none. More...
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback when the current transaction commits or rolls back. More...
 
 pendingWriteAndCallbackCallers ()
 List the methods that have write queries or callbacks for the current transaction. More...
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction. More...
 
 pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction. More...
 
 pendingWriteRowsAffected ()
 Get the number of affected rows from pending write queries. More...
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection. More...
 
 preCommitCallbacksPending ()
 
 query ( $sql, $fname=__METHOD__, $flags=self::QUERY_NORMAL)
 Run an SQL query and return the result. More...
 
 replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__)
 Insert row(s) into a table, deleting all conflicting rows beforehand. More...
 
 reportQueryError ( $error, $errno, $sql, $fname, $ignore=false)
 Report a query error. More...
 
 restoreFlags ( $state=self::RESTORE_PRIOR)
 Restore the flags to their prior state before the last setFlag/clearFlag call. More...
 
 rollback ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Rollback a transaction previously started using begin() More...
 
 runOnTransactionIdleCallbacks ( $trigger, array &$errors=[])
 Consume and run any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Consume and run any "on transaction pre-commit" callbacks. More...
 
 runTransactionListenerCallbacks ( $trigger, array &$errors=[])
 Actually run any "transaction listener" callbacks. More...
 
 select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided. More...
 
 selectDB ( $db)
 Change the current database. More...
 
 selectDomain ( $domain)
 Set the current domain (database, schema, and table prefix) More...
 
 selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a list of single field values from result rows. More...
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 Wrapper to IDatabase::select() that only fetches one row (via LIMIT) More...
 
 selectRowCount ( $tables, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Get the number of rows in dataset. More...
 
 selectSQLText ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 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$tableTable name
string | array$varsField names
string | array$condsConditions
string$fnameCaller function name
string | array$optionsQuery options
string | array$join_condsJoin conditions
Returns
string SQL query string
More...
 
 setFlag ( $flag, $remember=self::REMEMBER_NOTHING)
 Set a flag for this connection. More...
 
 setIndexAliases (array $aliases)
 Convert certain index names to alternative names before querying the DB.Note that this applies to indexes regardless of the table they belong to.This can be employed when an index was renamed X => Y in code, but the new Y-named indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA, the aliases can be removed, and then the old X-named indexes dropped.
Parameters
string[]$aliases
Since
1.31
More...
 
 setLBInfo ( $nameOrArray, $value=null)
 Set the entire array or a particular key of the managing load balancer info array. More...
 
 setLogger (LoggerInterface $logger)
 Set the PSR-3 logger interface to use for query logging. More...
 
 setSchemaVars ( $vars)
 Set schema variables to be used when streaming commands from SQL files or stdin. More...
 
 setTableAliases (array $aliases)
 Make certain table names use their own database, schema, and table prefix when passed into SQL queries pre-escaped and without a qualified database name.For example, "user" can be converted to "myschema.mydbname.user" for convenience. Appearances like user, somedb.user, somedb.someschema.user will used literally.Calling this twice will completely clear any old table aliases. Also, note that callers are responsible for making sure the schemas and databases actually exist.
Parameters
array[]$aliasesMap of (table => (dbname, schema, prefix) map)
Since
1.28
More...
 
 setTransactionListener ( $name, callable $callback=null)
 Run a callback after each time any transaction commits or rolls back. More...
 
 setTrxEndCallbackSuppression ( $suppress)
 Whether to disable running of post-COMMIT/ROLLBACK callbacks. More...
 
 sourceFile ( $filename, callable $lineCallback=null, callable $resultCallback=null, $fname=false, callable $inputCallback=null)
 Read and execute SQL commands from a file. More...
 
 sourceStream ( $fp, callable $lineCallback=null, callable $resultCallback=null, $fname=__METHOD__, callable $inputCallback=null)
 Read and execute commands from an open file handle. More...
 
 startAtomic ( $fname=__METHOD__, $cancelable=self::ATOMIC_NOT_CANCELABLE)
 Begin an atomic section of SQL statements. More...
 
 strreplace ( $orig, $old, $new)
 Returns a SQL expression for simple string replacement (e.g.REPLACE() in mysql)
Parameters
string$origColumn to modify
string$oldColumn to seek
string$newColumn to replace with
Returns
string
More...
 
 tableName ( $name, $format='quoted')
 Format a table name ready for use in constructing an SQL query.This does two important things: it quotes the table names to clean them up, and it adds a table prefix if only given a table name with no quotes.All functions of this object which require a table name call this function themselves. Pass the canonical name to such functions. This is only needed when calling query() directly.
Note
This function does not sanitize user input. It is not safe to use this function to escape user input.
Parameters
string$nameDatabase table name
string$formatOne of: quoted - Automatically pass the table name through addIdentifierQuotes() so that it can be used in a query. raw - Do not add identifier quotes to the table name
Returns
string Full database name
More...
 
 tableNames (... $tables)
 Fetch a number of table names into an array This is handy when you need to construct SQL for joins. More...
 
 tableNamesN (... $tables)
 Fetch a number of table names into an zero-indexed numerical array This is handy when you need to construct SQL for joins. More...
 
 tablePrefix ( $prefix=null)
 Get/set the table prefix. More...
 
 textFieldSize ( $table, $field)
 Returns the size of a text field, or -1 for "unlimited".
Parameters
string$table
string$field
Returns
int
More...
 
 timestamp ( $ts=0)
 Convert a timestamp in one of the formats accepted by ConvertibleTimestamp to the format used for inserting into timestamp fields in this DBMS.The result is unquoted, and needs to be passed through addQuotes() before it can be included in raw SQL.
Parameters
string | int$ts
Returns
string
More...
 
 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. More...
 
 truncate ( $tables, $fname=__METHOD__)
 Delete all data in a table(s) and reset any sequences owned by that table(s) More...
 
 trxLevel ()
 Gets the current transaction level. More...
 
 trxStatus ()
 
 trxTimestamp ()
 Get the UNIX timestamp of the time that the transaction was established. More...
 
 unionConditionPermutations ( $table, $vars, array $permute_conds, $extra_conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Construct a UNION query for permutations of conditions. More...
 
 unionQueries ( $sqls, $all)
 Construct a UNION query.This is used for providing overload point for other DB abstractions not compatible with the MySQL syntax.

Parameters
array$sqlsSQL statements to combine
bool$allEither IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT
Returns
string SQL fragment
More...
 
 unionSupportsOrderAndLimit ()
 Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.
Returns
bool
More...
 
 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}
More...
 
 unlockTables ( $method)
 Unlock all tables locked via lockTables() More...
 
 update ( $table, $set, $conds, $fname=__METHOD__, $options=[])
 Update all rows in a table that match a given condition. More...
 
 upsert ( $table, array $rows, $uniqueKeys, array $set, $fname=__METHOD__)
 Upsert the given row(s) into a table. More...
 
 wasConnectionLoss ()
 Determines if the last query error was due to a dropped connection.Note that during a connection loss, the prior transaction will have been lost
Returns
bool
Since
1.31
More...
 
 wasErrorReissuable ()
 Determines if the last query error was due to something outside of the query itself. More...
 
 writesOrCallbacksPending ()
 Whether there is a transaction open with either possible write queries or unresolved pre-commit/commit/resolution callbacks pending. More...
 
 writesPending ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\IDatabase
 buildSubString ( $input, $startPosition, $length=null)
 Build a SUBSTRING function. More...
 
 insertId ()
 Get the inserted value of an auto-increment row. More...
 
 lastErrno ()
 Get the last error number. More...
 

Protected Member Functions

 doGetLag ()
 Get the amount of replication lag for this database server. More...
 
 doLockTables (array $read, array $write, $method)
 Helper function for lockTables() that handles the actual table locking. More...
 
 doReplace ( $table, array $identityKey, array $rows, $fname)
 
 doSelectDomain (DatabaseDomain $domain)
 
 doUnlockTables ( $method)
 Helper function for unlockTables() that handles the actual table unlocking. More...
 
 doUpsert (string $table, array $rows, array $identityKey, array $set, string $fname)
 
 fetchSecondsSinceHeartbeat (array $conds)
 
 getApproximateLagStatus ()
 Get a replica DB lag estimate for this server at the start of a transaction. More...
 
 getLagDetectionMethod ()
 
 getLagFromPtHeartbeat ()
 
 getLagFromSlaveStatus ()
 
 getMasterServerInfo ()
 
 getMySqlServerVariant ()
 
 getPrimaryServerInfo ()
 
 getReplicationSafetyInfo ()
 
 getServerGTIDs ( $fname=__METHOD__)
 
 getServerId ()
 
 getServerRoleStatus ( $role, $fname=__METHOD__)
 
 getServerUUID ()
 
 isInsertSelectSafe (array $insertOptions, array $selectOptions)
 
 isTransactableQuery ( $sql)
 Determine whether a SQL statement is sensitive to isolation level. More...
 
 mysqlConnect ( $server, $user, $password, $db)
 Open a connection to a MySQL server. More...
 
 mysqlError ( $conn=null)
 Returns the text of the error message from previous MySQL operation. More...
 
 mysqlFieldType ( $res, $n)
 Get the type of the specified field in a result. More...
 
 mysqlRealEscapeString ( $s)
 
 open ( $server, $user, $password, $db, $schema, $tablePrefix)
 Open a new connection to the database (closing any existing one) More...
 
 useGTIDs ()
 
 wasKnownStatementRollbackError ()
 
 wasQueryTimeout ( $error, $errno)
 Checks whether the cause of the error is detected to be a timeout. More...
 
- Protected Member Functions inherited from Wikimedia\Rdbms\Database
 assertBuildSubstringParams ( $startPosition, $length)
 Check type and bounds for parameters to self::buildSubstring() More...
 
 assertConditionIsNotEmpty ( $conds, string $fname, bool $deprecate)
 Check type and bounds conditions parameters for update. More...
 
 assertHasConnectionHandle ()
 Make sure there is an open connection handle (alive or not) as a sanity check. More...
 
 assertIsWritableMaster ()
 
 assertIsWritablePrimary ()
 Make sure that this server is not marked as a replica nor read-only as a sanity check. More...
 
 assertValidUpsertRowArray (array $rows, array $identityKey)
 
 assertValidUpsertSetArray (array $set, array $identityKey, array $rows)
 
 buildSuperlative ( $sqlfunc, $fields, $values)
 Build a superlative function statement comparing columns/values. More...
 
 closeConnection ()
 Closes underlying database connection. More...
 
 commenceCriticalSection (string $fname)
 Demark the start of a critical section of session/transaction state changes. More...
 
 completeCriticalSection (string $fname, ?CriticalSectionScope $csm, Throwable $trxError=null)
 Demark the completion of a critical section of session/transaction state changes. More...
 
 doBegin ( $fname)
 Issues the BEGIN command to the database server. More...
 
 doCommit ( $fname)
 Issues the COMMIT command to the database server. More...
 
 doDropTable ( $table, $fname)
 
 doHandleSessionLossPreconnect ()
 Reset any additional subclass trx* and session* fields. More...
 
 doInitConnection ()
 Actually connect to the database over the wire (or to local files) More...
 
 doInsert ( $table, array $rows, $fname)
 
 doInsertNonConflicting ( $table, array $rows, $fname)
 
 doInsertSelectGeneric ( $destTable, $srcTable, array $varMap, $conds, $fname, array $insertOptions, array $selectOptions, $selectJoinConds)
 Implementation of insertSelect() based on select() and insert() More...
 
 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. More...
 
 doQuery ( $sql)
 Run a query and return a DBMS-dependent wrapper or boolean. More...
 
 doReleaseSavepoint ( $identifier, $fname)
 Release a savepoint. More...
 
 doRollback ( $fname)
 Issues the ROLLBACK command to the database server. More...
 
 doRollbackToSavepoint ( $identifier, $fname)
 Rollback to a savepoint. More...
 
 doSavepoint ( $identifier, $fname)
 Create a savepoint. More...
 
 doTruncate (array $tables, $fname)
 
 escapeLikeInternal ( $s, $escapeChar='`')
 
 executeQuery ( $sql, $fname, $flags)
 Execute a query, retrying it if there is a recoverable connection loss. More...
 
 extractSingleFieldFromList ( $var)
 
 fetchAffectedRowCount ()
 
 fieldHasBit (int $flags, int $bit)
 
 fieldNamesWithAlias ( $fields)
 Gets an array of aliased field names. More...
 
 fieldNameWithAlias ( $name, $alias=false)
 Get an aliased field name e.g. More...
 
 getBindingHandle ()
 Get the underlying binding connection handle. More...
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars(). More...
 
 getLastPHPError ()
 
 getLazyMasterHandle ()
 Get a handle to the primary DB server of the cluster to which this server belongs. More...
 
 getLogContext (array $extras=[])
 Create a log context to pass to PSR-3 logger functions. More...
 
 getQueryVerb ( $sql)
 
 getReadOnlyReason ()
 
 getRecordedTransactionLagStatus ()
 Get the replica DB lag when the current transaction started. More...
 
 getSchemaVars ()
 Get schema variables. More...
 
 getTempTableWrites ( $sql, $pseudoPermanent)
 
 getTransactionRoundId ()
 
 indexName ( $index)
 Allows for index remapping in queries where this is not consistent across DBMS. More...
 
 installErrorHandler ()
 Set a custom error handler for logging errors during database connection. More...
 
 isFlagInOptions ( $option, array $options)
 
 isPristineTemporaryTable ( $table)
 Check if the table is both a TEMPORARY table and has not yet received CRUD operations. More...
 
 isWriteQuery ( $sql, $flags)
 Determine whether a query writes to the DB. More...
 
 makeGroupByWithHaving ( $options)
 Returns an optional GROUP BY with an optional HAVING. More...
 
 makeInsertLists (array $rows)
 Make SQL lists of columns, row tuples for INSERT/VALUES expressions. More...
 
 makeInsertNonConflictingVerbAndOptions ()
 
 makeOrderBy ( $options)
 Returns an optional ORDER BY. More...
 
 makeSelectOptions (array $options)
 Returns an optional USE INDEX clause to go after the table, and a string to go at the end of the query. More...
 
 makeUpdateOptions ( $options)
 Make UPDATE options for the Database::update function. More...
 
 makeUpdateOptionsArray ( $options)
 Make UPDATE options array for Database::makeUpdateOptions. More...
 
 newExceptionAfterConnectError ( $error)
 
 normalizeConditions ( $conds, $fname)
 
 normalizeOptions ( $options)
 
 normalizeRowArray (array $rowOrRows)
 
 normalizeUpsertParams ( $uniqueKeys, &$rows)
 Validate and normalize parameters to upsert() or replace() More...
 
 qualifiedTableComponents ( $name)
 Get the table components needed for a query given the currently selected database. More...
 
 registerTempWrites ( $ret, array $changes)
 
 relationSchemaQualifier ()
 
 replaceLostConnection ( $fname)
 Close any existing (dead) database connection and open a new connection. More...
 
 replaceVars ( $ins)
 Database-independent variable replacement. More...
 
 restoreErrorHandler ()
 Restore the previous error handler and return the last PHP error for this DB. More...
 
 tableNamesWithIndexClauseOrJOIN ( $tables, $use_index=[], $ignore_index=[], $join_conds=[])
 Get the aliased table name clause for a FROM clause which might have a JOIN and/or USE INDEX or IGNORE INDEX clause. More...
 
 tableNameWithAlias ( $table, $alias=false)
 Get an aliased table name. More...
 

Protected Attributes

bool null $defaultBigSelects
 
string $lagDetectionMethod
 Method to detect replica DB lag. More...
 
array $lagDetectionOptions = []
 Method to detect replica DB lag. More...
 
MySQLPrimaryPos $lastKnownReplicaPos
 
string $sqlMode
 sql_mode value to send on connection More...
 
string null $sslCAFile
 
string null $sslCAPath
 
string null $sslCertPath
 
string null $sslCiphers
 Open SSL cipher list string. More...
 
string null $sslKeyPath
 
bool $useGTIDs = false
 bool Whether to use GTID methods More...
 
bool $utf8Mode
 Use experimental UTF-8 transmission encoding. More...
 
- Protected Attributes inherited from Wikimedia\Rdbms\Database
int null $affectedRowCount
 Rows affected by the last query to query() or its CRUD wrappers. More...
 
string $agent
 Agent name for query profiling. More...
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
object resource null $conn
 Database connection. More...
 
array< string, mixed > $connectionParams
 Connection parameters used by initConnection() and open() More...
 
string[] int[] float[] $connectionVariables
 SQL variables values to use for all new connections. More...
 
LoggerInterface $connLogger
 
CriticalSectionProvider null $csProvider
 
DatabaseDomain $currentDomain
 
string $delimiter = ';'
 Current SQL query delimiter. More...
 
callable $deprecationLogger
 Deprecation logging callback. More...
 
callable $errorLogger
 Error logging callback. More...
 
int $flags
 Current bit field of class DBO_* constants. More...
 
string[] $indexAliases = []
 Current map of (index alias => index) More...
 
array $lbInfo = []
 Current LoadBalancer tracking information. More...
 
int $nonNativeInsertSelectBatchSize
 Row batch size to use for emulated INSERT SELECT queries. More...
 
string null $password
 Password used to establish the current connection. More...
 
callable null $profiler
 
LoggerInterface $queryLogger
 
LoggerInterface $replLogger
 
array null $schemaVars
 Current variables use for schema element placeholders. More...
 
string null $server
 Server that this instance is currently connected to. More...
 
string null $serverName
 Readible name or host/IP of the database server. More...
 
array $sessionDirtyTempTables = []
 Map of (table name => 1) for current TEMPORARY tables. More...
 
array< string, float > $sessionNamedLocks = []
 Map of (name => UNIX timestamp) for locks obtained via lock() More...
 
array $sessionTempTables = []
 Map of (table name => 1) for current TEMPORARY tables. More...
 
BagOStuff $srvCache
 APC cache. More...
 
array[] $tableAliases = []
 Current map of (table => (dbname, schema, prefix) map) More...
 
string $topologyRole
 Replication topology role of the server; one of the class ROLE_* constants. More...
 
string null $topologyRootMaster
 Host (or address) of the root primary server for the replication topology. More...
 
TransactionProfiler $trxProfiler
 
string null $user
 User that this instance is currently connected under the name of. More...
 
const CONN_HOST = 'host'
 Hostname or IP address to use on all connections. More...
 
const CONN_INITIAL_DB = 'dbname'
 Database name to use on initial connection. More...
 
const CONN_INITIAL_SCHEMA = 'schema'
 Schema name to use on initial connection. More...
 
const CONN_INITIAL_TABLE_PREFIX = 'tablePrefix'
 Table prefix to use on initial connection. More...
 
const CONN_PASSWORD = 'password'
 Database server password to use on all connections. More...
 
const CONN_USER = 'user'
 Database server username to use on all connections. More...
 

Private Member Functions

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

Private Attributes

bool null $insertSelectIsSafe
 
stdClass null $replicationInfoRow
 
const SERVER_ID_CACHE_TTL = 86400
 

Additional Inherited Members

- Static Public Member Functions inherited from Wikimedia\Rdbms\Database
static attributesFromType ( $dbType, $driver=null)
 
static factory ( $type, $params=[], $connect=self::NEW_CONNECTED)
 Construct a Database subclass instance given a database type and parameters. More...
 
static getCacheSetOptions (?IDatabase ... $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. More...
 
- Public Attributes inherited from Wikimedia\Rdbms\IDatabase
const LOCK_TIMESTAMP = 1
 Flag to return the lock acquision timestamp (null if not acquired) More...
 
- Static Protected Member Functions inherited from Wikimedia\Rdbms\Database
static getAttributes ()
 
- Static Protected Attributes inherited from Wikimedia\Rdbms\Database
static int $DBO_MUTABLE
 Bit field of all DBO_* flags that can be changed after connection. More...
 
static string[] $MUTABLE_FLAGS
 List of DBO_* flags that can be changed after connection. More...
 

Detailed Description

Database abstraction object for MySQL.

Defines methods independent on used MySQL extension.

TODO: This could probably be merged with DatabaseMysqli. The split was created to support a transition from the old "mysql" extension to mysqli, and there may be an argument for retaining it in order to support some future transition to something else, but it's complexity and YAGNI.

Since
1.22
See also
Database

Definition at line 44 of file DatabaseMysqlBase.php.

Constructor & Destructor Documentation

◆ __construct()

Wikimedia\Rdbms\DatabaseMysqlBase::__construct ( array  $params)

Additional $params include:

  • lagDetectionMethod : set to one of (Seconds_Behind_Master,pt-heartbeat). pt-heartbeat assumes the table is at heartbeat.heartbeat and uses UTC timestamps in the heartbeat.ts column. (https://www.percona.com/doc/percona-toolkit/2.2/pt-heartbeat.html)
  • lagDetectionOptions : if using pt-heartbeat, this can be set to an array map to change the default behavior. Normally, the heartbeat row with the server ID of this server's primary DB will be used. Set the "conds" field to override the query conditions, e.g. ['shard' => 's1'].
  • useGTIDs : use GTID methods like MASTER_GTID_WAIT() when possible.
  • insertSelectIsSafe : force that native INSERT SELECT is or is not safe [default: null]
  • sslKeyPath : path to key file [default: null]
  • sslCertPath : path to certificate file [default: null]
  • sslCAFile: path to a single certificate authority PEM file [default: null]
  • sslCAPath : parth to certificate authority PEM directory [default: null]
  • sslCiphers : array list of allowable ciphers [default: null]
    Parameters
    array$params

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 104 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\useGTIDs().

Member Function Documentation

◆ addIdentifierQuotes()

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

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

Parameters
string$s
Returns
string

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 487 of file DatabaseMysqlBase.php.

References $s.

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

◆ buildIntegerCast()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1411 of file DatabaseMysqlBase.php.

◆ buildStringCast()

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

Parameters
string$fieldField or column to cast
Returns
string
Since
1.28
Stability: stable
to override

Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1403 of file DatabaseMysqlBase.php.

◆ deleteJoin()

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

DELETE where the condition is a join.

MySql uses multi-table deletes.

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1168 of file DatabaseMysqlBase.php.

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

◆ doGetLag()

Wikimedia\Rdbms\DatabaseMysqlBase::doGetLag ( )
protected

Get the amount of replication lag for this database server.

Callers should avoid using this method while a transaction is active

See also
getLag()
Stability: stable
to override
Returns
float|int|false Database replication lag in seconds or false on error
Exceptions
DBError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 501 of file DatabaseMysqlBase.php.

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

◆ doLock()

Wikimedia\Rdbms\DatabaseMysqlBase::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
Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1064 of file DatabaseMysqlBase.php.

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

◆ doLockIsFree()

Wikimedia\Rdbms\DatabaseMysqlBase::doLockIsFree ( string  $lockName,
string  $method 
)
See also
lockIsFree()
Parameters
string$lockName
string$method
Returns
bool Success
Exceptions
DBError
Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1051 of file DatabaseMysqlBase.php.

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

◆ doLockTables()

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

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

Stability: stable
to override
Parameters
array$readArray of tables to lock for read access
array$writeArray of tables to lock for write access
string$methodName of caller
Returns
true

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1107 of file DatabaseMysqlBase.php.

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

◆ doReplace()

Wikimedia\Rdbms\DatabaseMysqlBase::doReplace (   $table,
array  $identityKey,
array  $rows,
  $fname 
)
protected
Parameters
string$table
string[]$identityKeyList of columns defining a unique key
array$rowsNon-empty list of rows
string$fname
See also
Database::replace()
Stability: stable
to override
Since
1.35

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1204 of file DatabaseMysqlBase.php.

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

◆ doSelectDomain()

◆ doUnlock()

Wikimedia\Rdbms\DatabaseMysqlBase::doUnlock ( string  $lockName,
string  $method 
)
See also
unlock()
Parameters
string$lockName
string$method
Returns
bool Success
Exceptions
DBError
Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1080 of file DatabaseMysqlBase.php.

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

◆ doUnlockTables()

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

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

Stability: stable
to override
Parameters
string$methodName of caller
Returns
true

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1125 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\query().

◆ doUpsert()

Wikimedia\Rdbms\DatabaseMysqlBase::doUpsert ( string  $table,
array  $rows,
array  $identityKey,
array  $set,
string  $fname 
)
protected
Parameters
string$table
array[]$rowsNon-empty list of rows
string[]$identityKeyList of columns defining a unique key
string[]$setNon-empty combined column/literal map and SQL assignment list
string$fname
See also
Database::upsert()
Stability: stable
to override
Since
1.35

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1186 of file DatabaseMysqlBase.php.

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

◆ duplicateTableStructure()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1283 of file DatabaseMysqlBase.php.

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

◆ estimateRowCount()

Wikimedia\Rdbms\DatabaseMysqlBase::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
bool|int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 352 of file DatabaseMysqlBase.php.

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

◆ fetchSecondsSinceHeartbeat()

Wikimedia\Rdbms\DatabaseMysqlBase::fetchSecondsSinceHeartbeat ( array  $conds)
protected
Parameters
array$condsWHERE clause conditions to find a row
Returns
float|null Elapsed seconds since the newest beat or null if none was found
See also
https://www.percona.com/doc/percona-toolkit/2.1/pt-heartbeat.html

Definition at line 647 of file DatabaseMysqlBase.php.

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

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

◆ fieldInfo()

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

Implements Wikimedia\Rdbms\IMaintainableDatabase.

Definition at line 419 of file DatabaseMysqlBase.php.

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

◆ fieldType()

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

mysql_field_type() wrapper

Not part of the interface and apparently not called by anything.

Deprecated:
since 1.37
Parameters
MysqliResultWrapper$res
int$n
Returns
string

Definition at line 245 of file DatabaseMysqlBase.php.

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

◆ getApproximateLagStatus()

Wikimedia\Rdbms\DatabaseMysqlBase::getApproximateLagStatus ( )
protected

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

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

Stability: stable
to override
Returns
array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)
Since
1.27

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 662 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getLagDetectionMethod(), and Wikimedia\Rdbms\Database\getServerName().

◆ getLagDetectionMethod()

Wikimedia\Rdbms\DatabaseMysqlBase::getLagDetectionMethod ( )
protected

◆ getLagFromPtHeartbeat()

◆ getLagFromSlaveStatus()

Wikimedia\Rdbms\DatabaseMysqlBase::getLagFromSlaveStatus ( )
protected
Returns
int|false Second of lag

Definition at line 519 of file DatabaseMysqlBase.php.

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

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

◆ getMasterPos()

Wikimedia\Rdbms\DatabaseMysqlBase::getMasterPos ( )
Deprecated:
since 1.37; use getPrimaryPos() instead.
Returns
DBPrimaryPos|bool False if this is not a primary DB
Exceptions
DBErrorIf an error occurs, {
See also
query}

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 862 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getPrimaryPos(), and wfDeprecated().

◆ getMasterServerInfo()

Wikimedia\Rdbms\DatabaseMysqlBase::getMasterServerInfo ( )
protected

◆ getMySqlServerVariant()

Wikimedia\Rdbms\DatabaseMysqlBase::getMySqlServerVariant ( )
protected
Returns
string[] (one of ("MariaDB","MySQL"), x.y.z version string)

Definition at line 987 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getServerVersion().

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

◆ getMysqlStatus()

Wikimedia\Rdbms\DatabaseMysqlBase::getMysqlStatus (   $which = "%")
private

Get status information from SHOW STATUS in an associative array.

Parameters
string$which
Returns
array

Definition at line 1331 of file DatabaseMysqlBase.php.

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

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

◆ getPrimaryPos()

Wikimedia\Rdbms\DatabaseMysqlBase::getPrimaryPos ( )

◆ getPrimaryServerInfo()

◆ getReplicaPos()

Wikimedia\Rdbms\DatabaseMysqlBase::getReplicaPos ( )

Get the position of the primary DB from SHOW SLAVE STATUS.

Returns
MySQLPrimaryPos|bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 798 of file DatabaseMysqlBase.php.

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

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

◆ getReplicationSafetyInfo()

Wikimedia\Rdbms\DatabaseMysqlBase::getReplicationSafetyInfo ( )
protected

◆ getServerGTIDs()

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

◆ getServerId()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerId ( )
protected
Returns
string Value of server_id (32-bit integer, unique to the replication topology)
Exceptions
DBQueryError

Definition at line 879 of file DatabaseMysqlBase.php.

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

Referenced by Wikimedia\Rdbms\DatabaseMysqlBase\getPrimaryPos(), and Wikimedia\Rdbms\DatabaseMysqlBase\getTopologyBasedServerId().

◆ getServerRoleStatus()

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

Definition at line 940 of file DatabaseMysqlBase.php.

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

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

◆ getServerUptime()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerUptime ( )

Determines how long the server has been up.

Returns
int

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1218 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getMysqlStatus().

◆ getServerUUID()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerUUID ( )
protected
Returns
string|null Value of server_uuid (hyphenated 128-bit hex string, globally unique)
Exceptions
DBQueryError

Definition at line 897 of file DatabaseMysqlBase.php.

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

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

◆ getServerVersion()

Wikimedia\Rdbms\DatabaseMysqlBase::getServerVersion ( )

◆ getSoftwareLink()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 975 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getMySqlServerVariant().

◆ getTopologyBasedServerId()

Wikimedia\Rdbms\DatabaseMysqlBase::getTopologyBasedServerId ( )

Get a non-recycled ID that uniquely identifies this server within the replication topology.A replication topology defines which servers can originate changes to a given dataset and how those changes propagate among database servers. It is assumed that the server only participates in the replication of a single relevant dataset.

Returns
string|null 32, 64, or 128 bit integer ID; null if not applicable or unknown
Exceptions
DBQueryError
Since
1.37

Returns
string|null 32 bit integer ID; null if not applicable or unknown

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 871 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getServerId().

◆ getType()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 125 of file DatabaseMysqlBase.php.

◆ ignoreIndexClause()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 968 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\indexName().

◆ indexInfo()

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

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

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 442 of file DatabaseMysqlBase.php.

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

◆ isInsertSelectSafe()

Wikimedia\Rdbms\DatabaseMysqlBase::isInsertSelectSafe ( array  $insertOptions,
array  $selectOptions 
)
protected
Stability: stable
to override
Parameters
array$insertOptionsINSERT options
array$selectOptionsSELECT options
Returns
bool Whether an INSERT SELECT with these options will be replication safe
Since
1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 297 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\getReplicationSafetyInfo().

◆ isQuotedIdentifier()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 497 of file DatabaseMysqlBase.php.

◆ isTransactableQuery()

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

Determine whether a SQL statement is sensitive to isolation level.

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

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

Stability: stable
to override
Parameters
string$sql
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1398 of file DatabaseMysqlBase.php.

◆ isView()

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

Differentiates between a TABLE and a VIEW.

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

Definition at line 1394 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\DatabaseMysqlBase\listViews().

◆ lastError()

◆ listTables()

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

List all tables on the database.

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1304 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\query().

◆ listViews()

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

Lists VIEWs in the database.

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1355 of file DatabaseMysqlBase.php.

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

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

◆ makeLockName()

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

◆ mysqlConnect()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlConnect (   $server,
  $user,
  $password,
  $db 
)
abstractprotected

Open a connection to a MySQL server.

Parameters
string | null$server
string | null$user
string | null$password
string | null$db
Returns
mixed|null Driver connection handle
Exceptions
DBConnectionError

Reimplemented in Wikimedia\Rdbms\DatabaseMysqli.

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

◆ mysqlError()

Wikimedia\Rdbms\DatabaseMysqlBase::mysqlError (   $conn = null)
abstractprotected

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

Parameters
resource | null$connRaw connection
Returns
string

Reimplemented in Wikimedia\Rdbms\DatabaseMysqli.

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

◆ mysqlFieldType()

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

Get the type of the specified field in a result.

Deprecated:
since 1.37
Parameters
mysqli_result$res
int$n
Returns
string

Reimplemented in Wikimedia\Rdbms\DatabaseMysqli.

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

◆ mysqlRealEscapeString()

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

Reimplemented in Wikimedia\Rdbms\DatabaseMysqli.

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

◆ namedLocksEnqueue()

Wikimedia\Rdbms\DatabaseMysqlBase::namedLocksEnqueue ( )

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

Returns
bool
Since
1.26
Stability: stable
to override

Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1099 of file DatabaseMysqlBase.php.

◆ open()

Wikimedia\Rdbms\DatabaseMysqlBase::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$tablePrefixTable prefix
Exceptions
DBConnectionError

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 129 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\$password, Wikimedia\Rdbms\Database\$server, Wikimedia\Rdbms\Database\$user, Wikimedia\Rdbms\DatabaseMysqlBase\addIdentifierQuotes(), Wikimedia\Rdbms\Database\addQuotes(), Wikimedia\Rdbms\Database\close(), Wikimedia\Rdbms\Database\installErrorHandler(), Wikimedia\Rdbms\DatabaseMysqlBase\lastError(), Wikimedia\Rdbms\DatabaseMysqlBase\mysqlConnect(), Wikimedia\Rdbms\Database\newExceptionAfterConnectError(), Wikimedia\Rdbms\Database\query(), and Wikimedia\Rdbms\Database\restoreErrorHandler().

◆ primaryPosWait()

Wikimedia\Rdbms\DatabaseMysqlBase::primaryPosWait ( DBPrimaryPos  $pos,
  $timeout 
)

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

Parameters
DBPrimaryPos$pos
int$timeoutThe maximum number of seconds to wait for synchronisation
Returns
int|null Zero if the replica DB was past that position already, greater than zero if we waited for some period of time, less than zero if it timed out, and null on error
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.37
Since
1.37
Stability: stable
to override

Since
1.37
Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 680 of file DatabaseMysqlBase.php.

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

◆ serverIsReadOnly()

Wikimedia\Rdbms\DatabaseMysqlBase::serverIsReadOnly ( )

Returns
bool Whether the DB is marked as read-only server-side
Exceptions
DBErrorIf an error occurs, {
See also
query}
Since
1.28
Stability: stable
to override

Stability: stable
to override

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 947 of file DatabaseMysqlBase.php.

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

◆ setBigSelects()

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

◆ setSessionOptions()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1028 of file DatabaseMysqlBase.php.

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

◆ streamStatementEnd()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1042 of file DatabaseMysqlBase.php.

◆ strencode()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 471 of file DatabaseMysqlBase.php.

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

◆ tableExists()

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

Query whether a given table exists.

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 383 of file DatabaseMysqlBase.php.

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

◆ tableLocksHaveTransactionScope()

Wikimedia\Rdbms\DatabaseMysqlBase::tableLocksHaveTransactionScope ( )

Checks if table locks acquired by lockTables() are transaction-bound in their scope.

Transaction-bound table locks will be released when the current transaction terminates. Table locks that are not bound to a transaction are not effected by BEGIN/COMMIT/ROLLBACK and will last until either lockTables()/unlockTables() is called or the TCP connection to the database is closed.

Returns
bool
Since
1.29

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1103 of file DatabaseMysqlBase.php.

◆ useGTIDs()

Wikimedia\Rdbms\DatabaseMysqlBase::useGTIDs ( )
protected

◆ useIndexClause()

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

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 960 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\Database\indexName().

◆ wasConnectionError()

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

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

Stability: stable
to override
Parameters
int | string$errno
Returns
bool Whether the given query error was a connection drop

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1252 of file DatabaseMysqlBase.php.

◆ wasDeadlock()

Wikimedia\Rdbms\DatabaseMysqlBase::wasDeadlock ( )

Determines if the last failure was due to a deadlock.

Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1229 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\IDatabase\lastErrno().

◆ wasKnownStatementRollbackError()

Wikimedia\Rdbms\DatabaseMysqlBase::wasKnownStatementRollbackError ( )
protected
Stability: stable
to override
Returns
bool Whether it is known that the last query error only caused statement rollback
Note
This is for backwards compatibility for callers catching DBError exceptions in order to ignore problems like duplicate key errors or foriegn key violations
Since
1.31

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1256 of file DatabaseMysqlBase.php.

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

◆ wasLockTimeout()

Wikimedia\Rdbms\DatabaseMysqlBase::wasLockTimeout ( )

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

Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1238 of file DatabaseMysqlBase.php.

References Wikimedia\Rdbms\IDatabase\lastErrno().

◆ wasQueryTimeout()

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

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

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

Stability: stable
to override
Parameters
string$errorError text
int$errnoError number
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 291 of file DatabaseMysqlBase.php.

◆ wasReadOnlyError()

Wikimedia\Rdbms\DatabaseMysqlBase::wasReadOnlyError ( )

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

Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 1247 of file DatabaseMysqlBase.php.

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

Member Data Documentation

◆ $defaultBigSelects

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

◆ $insertSelectIsSafe

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

Definition at line 75 of file DatabaseMysqlBase.php.

◆ $lagDetectionMethod

string Wikimedia\Rdbms\DatabaseMysqlBase::$lagDetectionMethod
protected

Method to detect replica DB lag.

Definition at line 48 of file DatabaseMysqlBase.php.

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

◆ $lagDetectionOptions

array Wikimedia\Rdbms\DatabaseMysqlBase::$lagDetectionOptions = []
protected

Method to detect replica DB lag.

Definition at line 50 of file DatabaseMysqlBase.php.

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

◆ $lastKnownReplicaPos

MySQLPrimaryPos Wikimedia\Rdbms\DatabaseMysqlBase::$lastKnownReplicaPos
protected

Definition at line 46 of file DatabaseMysqlBase.php.

◆ $replicationInfoRow

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

◆ $sqlMode

string Wikimedia\Rdbms\DatabaseMysqlBase::$sqlMode
protected

sql_mode value to send on connection

Definition at line 68 of file DatabaseMysqlBase.php.

◆ $sslCAFile

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

Definition at line 58 of file DatabaseMysqlBase.php.

◆ $sslCAPath

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

Definition at line 60 of file DatabaseMysqlBase.php.

◆ $sslCertPath

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

Definition at line 56 of file DatabaseMysqlBase.php.

◆ $sslCiphers

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

Open SSL cipher list string.

See also
https://www.openssl.org/docs/man1.0.2/man1/ciphers.html

Definition at line 66 of file DatabaseMysqlBase.php.

◆ $sslKeyPath

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

Definition at line 54 of file DatabaseMysqlBase.php.

◆ $useGTIDs

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

bool Whether to use GTID methods

Definition at line 52 of file DatabaseMysqlBase.php.

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

◆ $utf8Mode

bool Wikimedia\Rdbms\DatabaseMysqlBase::$utf8Mode
protected

Use experimental UTF-8 transmission encoding.

Definition at line 70 of file DatabaseMysqlBase.php.

◆ SERVER_ID_CACHE_TTL

const Wikimedia\Rdbms\DatabaseMysqlBase::SERVER_ID_CACHE_TTL = 86400
private

Definition at line 80 of file DatabaseMysqlBase.php.


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