MediaWiki  master
Wikimedia\Rdbms\DatabaseMysqli Class Reference

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

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

Public Member Functions

 insertId ()
 
 lastErrno ()
 
- Public Member Functions inherited from Wikimedia\Rdbms\DatabaseMysqlBase
 __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
Stable to override Stable to override More...
 
 dataSeek ( $res, $row)
 
 deleteJoin ( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname=__METHOD__)
 DELETE where the condition is a join. More...
 
 duplicateTableStructure ( $oldName, $newName, $temporary=false, $fname=__METHOD__)
 
 estimateRowCount ( $table, $var=' *', $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Estimate rows in dataset Returns estimated count, based on EXPLAIN output Takes same arguments as Database::select() More...
 
 fetchObject ( $res)
 
 fetchRow ( $res)
 
 fieldInfo ( $table, $field)
 
 fieldName ( $res, $n)
 
 fieldType ( $res, $n)
 mysql_field_type() wrapper More...
 
 freeResult ( $res)
 
 getMasterPos ()
 Get the position of the master from SHOW MASTER STATUS. More...
 
 getReplicaPos ()
 Get the position of the master from SHOW SLAVE STATUS. More...
 
 getServerUptime ()
 Determines how long the server has been up. More...
 
 getServerVersion ()
 
 getSoftwareLink ()
 
 getType ()
 
 ignoreIndexClause ( $index)
 
 indexInfo ( $table, $index, $fname=__METHOD__)
 Get information about an index into an object Returns false if the index does not exist. More...
 
 isQuotedIdentifier ( $name)
 
 isView ( $name, $prefix=null)
 Differentiates between a TABLE and a VIEW. More...
 
 lastError ()
 
 listTables ( $prefix=null, $fname=__METHOD__)
 List all tables on the database. More...
 
 listViews ( $prefix=null, $fname=__METHOD__)
 Lists VIEWs in the database. More...
 
 lock ( $lockName, $method, $timeout=5)
 
 lockIsFree ( $lockName, $method)
 Check to see if a named lock is available. More...
 
 masterPosWait (DBMasterPos $pos, $timeout)
 Wait for the replica DB to catch up to a given master position.Note that this does not start any new transactions. If any existing transaction is flushed, and this is called, then queries will reflect the point the DB was synced up to (on success) without interference from REPEATABLE-READ snapshots.
Parameters
DBMasterPos$pos
int$timeoutThe maximum number of seconds to wait for synchronisation
Returns
int|null Zero if the replica DB was past that position already, greater than zero if we waited for some period of time, less than zero if it timed out, and null on error
Exceptions
DBErrorIf an error occurs, see IDatabase::query()
Stable to override Stable to override More...
 
 namedLocksEnqueue ()
 Check to see if a named lock used by lock() use blocking queues.
Returns
bool
Since
1.26
Stable to override Stable to override More...
 
 numFields ( $res)
 
 numRows ( $res)
 
 serverIsReadOnly ()
 
Returns
bool Whether the DB is marked as read-only server-side
Since
1.28
Stable to override 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...
 
 unlock ( $lockName, $method)
 FROM MYSQL DOCS: https://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock. 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
Stable to override 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
Stable to override 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
Stable to override More...
 
 bitNot ( $field)
 
Parameters
string | int$field
Returns
string
Stable to override More...
 
 bitOr ( $fieldLeft, $fieldRight)
 
Parameters
string | int$fieldLeft
string | int$fieldRight
Returns
string
Stable to override 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
Stable to override 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
Stable to override 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
Stable to override 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
Stable to override 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
Stable to override 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)
 Stable to override More...
 
 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, $trueVal, $falseVal)
 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 expression which will result in a boolean value
string$trueValSQL expression to return if true
string$falseValSQL expression to return if false
Returns
string SQL fragment
Stable to override More...
 
 connectionErrorLogger ( $errno, $errstr)
 Error handler for logging errors during database connection This method should not be used outside of Database classes. More...
 
 databasesAreIndependent ()
 Returns true if DBs are assumed to be on potentially different servers.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
Stable to override 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
Stable to override 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
Stable to override 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
Stable to override 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 ()
 
 fieldExists ( $table, $field, $fname=__METHOD__)
 Determines whether a field exists in a table. More...
 
 flushSnapshot ( $fname=__METHOD__, $flush=self::FLUSHING_ONE)
 Commit any transaction but error out if writes or callbacks are pending. More...
 
 getDBname ()
 Get the current DB name. More...
 
 getDomainID ()
 Return the currently selected domain ID. More...
 
 getFlag ( $flag)
 Returns a boolean whether the flag $flag is set for this connection. More...
 
 getInfinity ()
 Find out when 'infinity' is.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
Stable to override 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 server hostname or IP address. More...
 
 getServerInfo ()
 Get a human-readable string describing the current software version. 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 ()
 Get the host (or address) of the root master 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
Stable to override 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
Stable to override 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
Stable to override More...
 
 lockForUpdate ( $table, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Lock all rows meeting the given conditions/options FOR UPDATE. 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...
 
 maxListLen ()
 Return the maximum number of items allowed in a list, or 0 for unlimited.
Returns
int
Stable to override 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...
 
 onAtomicSectionCancel (callable $callback, $fname=__METHOD__)
 Run a callback when the atomic section is cancelled. More...
 
 onTransactionCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback as soon as there is no transaction pending. More...
 
 onTransactionIdle (callable $callback, $fname=__METHOD__)
 Alias for onTransactionCommitOrIdle() for backwards-compatibility. More...
 
 onTransactionPreCommitOrIdle (callable $callback, $fname=__METHOD__)
 Run a callback before the current transaction commits or now if there is none. More...
 
 onTransactionResolution (callable $callback, $fname=__METHOD__)
 Run a callback as soon as the current transaction commits or rolls back. More...
 
 pendingWriteAndCallbackCallers ()
 List the methods that have write queries or callbacks for the current transaction. More...
 
 pendingWriteCallers ()
 Get the list of method names that did write queries for this transaction. More...
 
 pendingWriteQueryDuration ( $type=self::ESTIMATE_TOTAL)
 Get the time spend running write queries for this transaction. More...
 
 pendingWriteRowsAffected ()
 Get the number of affected rows from pending write queries. More...
 
 ping (&$rtt=null)
 Ping the server and try to reconnect if it there is no connection. More...
 
 preCommitCallbacksPending ()
 
 query ( $sql, $fname=__METHOD__, $flags=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)
 Actually consume and run any "on transaction idle/resolution" callbacks. More...
 
 runOnTransactionPreCommitCallbacks ()
 Actually consume and run any "on transaction pre-commit" callbacks. More...
 
 runTransactionListenerCallbacks ( $trigger)
 Actually run any "transaction listener" callbacks. More...
 
 select ( $table, $vars, $conds='', $fname=__METHOD__, $options=[], $join_conds=[])
 Execute a SELECT query constructed using the various parameters provided. More...
 
 selectDB ( $db)
 Change the current database. More...
 
 selectDomain ( $domain)
 Set the current domain (database, schema, and table prefix) More...
 
 selectField ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a single field from a single result row. More...
 
 selectFieldValues ( $table, $var, $cond='', $fname=__METHOD__, $options=[], $join_conds=[])
 A SELECT wrapper which returns a list of single field values from result rows. More...
 
 selectRow ( $table, $vars, $conds, $fname=__METHOD__, $options=[], $join_conds=[])
 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
Stable to override 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
Stable to override 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
Stable to override 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
Stable to override 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
Stable to override 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
Stable to override 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
Stable to override 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
Stable to override More...
 
 unionSupportsOrderAndLimit ()
 Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.
Returns
bool
Stable to override 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
Stable to override 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...
 

Protected Member Functions

 closeConnection ()
 
 doQuery ( $sql)
 
 fetchAffectedRowCount ()
 
 getBindingHandle ()
 
 mysqlConnect ( $realServer, $dbName)
 
 mysqlDataSeek ( $res, $row)
 
 mysqlError ( $conn=null)
 
 mysqlFetchArray ( $res)
 
 mysqlFetchField ( $res, $n)
 
 mysqlFetchObject ( $res)
 
 mysqlFieldName ( $res, $n)
 
 mysqlFieldType ( $res, $n)
 
 mysqlFreeResult ( $res)
 
 mysqlNumFields ( $res)
 
 mysqlNumRows ( $res)
 
 mysqlRealEscapeString ( $s)
 Escapes special characters in a string for use in an SQL statement. More...
 
- Protected Member Functions inherited from Wikimedia\Rdbms\DatabaseMysqlBase
 doGetLag ()
 Stable to override Stable to override More...
 
 doLockTables (array $read, array $write, $method)
 Helper function for lockTables() that handles the actual table locking. More...
 
 doReplace ( $table, array $uniqueKeys, array $rows, $fname)
 
 doSelectDomain (DatabaseDomain $domain)
 Stable to override. More...
 
 doUnlockTables ( $method)
 Helper function for unlockTables() that handles the actual table unlocking. More...
 
 doUpsert ( $table, array $rows, array $uniqueKeys, array $set, $fname)
 
 getApproximateLagStatus ()
 Get a replica DB lag estimate for this server at the start of a transaction. More...
 
 getHeartbeatData (array $conds)
 
 getLagDetectionMethod ()
 
 getLagFromPtHeartbeat ()
 
 getLagFromSlaveStatus ()
 
 getMasterServerInfo ()
 
 getReplicationSafetyInfo ()
 
 getServerGTIDs ( $fname=__METHOD__)
 
 getServerId ()
 
 getServerRoleStatus ( $role, $fname=__METHOD__)
 
 getServerUUID ()
 
 isInsertSelectSafe (array $insertOptions, array $selectOptions)
 Stable to override. More...
 
 isTransactableQuery ( $sql)
 Determine whether a SQL statement is sensitive to isolation level. More...
 
 open ( $server, $user, $password, $dbName, $schema, $tablePrefix)
 Open a new connection to the database (closing any existing one) More...
 
 useGTIDs ()
 
 wasKnownStatementRollbackError ()
 Stable to override. More...
 
 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 ()
 Make sure that this server is not marked as a replica nor read-only as a sanity check. More...
 
 buildSuperlative ( $sqlfunc, $fields, $values)
 Build a superlative function statement comparing columns/values. 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 Stable to override. 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...
 
 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='`')
 Stable to override. More...
 
 executeQuery ( $sql, $fname, $flags)
 Execute a query, retrying it if there is a recoverable connection loss. More...
 
 extractSingleFieldFromList ( $var)
 
 fieldHasBit ( $field, $flags)
 
 fieldNamesWithAlias ( $fields)
 Gets an array of aliased field names. More...
 
 fieldNameWithAlias ( $name, $alias=false)
 Get an aliased field name e.g. More...
 
 getDefaultSchemaVars ()
 Get schema variables to use if none have been set via setSchemaVars(). More...
 
 getLastPHPError ()
 
 getLazyMasterHandle ()
 Get a handle to the master 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...
 
 makeConditionCollidesUponKeys (array $rows, array $uniqueKeys)
 
 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 ()
 Stable to override. More...
 
 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)
 
 normalizeUpsertKeys ( $uniqueKeys)
 
 qualifiedTableComponents ( $name)
 Get the table components needed for a query given the currently selected database. More...
 
 registerTempWrites ( $ret, array $changes)
 
 relationSchemaQualifier ()
 Stable to override. More...
 
 replaceLostConnection ( $fname)
 Close any existing (dead) database connection and open a new connection. More...
 
 replaceVars ( $ins)
 Database independent variable replacement. More...
 
 restoreErrorHandler ()
 Restore the previous error handler and return the last PHP error for this DB. More...
 
 resultObject ( $result)
 Take a query result and wrap it in an iterable result wrapper if necessary. 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...
 

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 $db1, IDatabase $db2=null)
 Merge the result of getSessionLagStatus() for several DBs using the most pessimistic values to estimate the lag of any data derived from them in combination. More...
 
- Static Protected Member Functions inherited from Wikimedia\Rdbms\Database
static getAttributes ()
 Stable to override. More...
 
- Protected Attributes inherited from Wikimedia\Rdbms\DatabaseMysqlBase
bool null $defaultBigSelects = null
 
string $lagDetectionMethod
 Method to detect replica DB lag. More...
 
array $lagDetectionOptions = []
 Method to detect replica DB lag. More...
 
MySQLMasterPos $lastKnownReplicaPos
 
string $sqlMode
 sql_mode value to send on connection More...
 
string null $sslCAFile
 
string null $sslCAPath
 
string null $sslCertPath
 
string[] null $sslCiphers
 
string null $sslKeyPath
 
bool $useGTIDs = false
 bool Whether to use GTID methods More...
 
bool $utf8Mode
 Use experimental UTF-8 transmission encoding. More...
 
- Protected Attributes inherited from Wikimedia\Rdbms\Database
integer null $affectedRowCount
 Rows affected by the last query to query() or its CRUD wrappers. More...
 
string $agent
 Agent name for query profiling. More...
 
bool $cliMode
 Whether this PHP instance is for a CLI script. More...
 
object resource null $conn
 Database connection. More...
 
array $connectionParams
 Parameters used by initConnection() to establish a connection. More...
 
string[] int[] float[] $connectionVariables
 SQL variables values to use for all new connections. More...
 
LoggerInterface $connLogger
 
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 $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 $server
 Server that this instance is currently connected to. More...
 
array $sessionDirtyTempTables = []
 Map of (table name => 1) for current TEMPORARY tables. More...
 
array $sessionNamedLocks = []
 Map of (name => 1) 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 master server for the replication topology. More...
 
TransactionProfiler $trxProfiler
 
string $user
 User that this instance is currently connected under the name of. More...
 
- 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 PHP extension mysqli.

Since
1.22
See also
Database -file-suppress PhanParamSignatureMismatch resource vs mysqli_result

Definition at line 39 of file DatabaseMysqli.php.

Member Function Documentation

◆ closeConnection()

Wikimedia\Rdbms\DatabaseMysqli::closeConnection ( )
protected
Returns
bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 136 of file DatabaseMysqli.php.

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

◆ doQuery()

Wikimedia\Rdbms\DatabaseMysqli::doQuery (   $sql)
protected
Parameters
string$sql
Returns
mysqli_result|bool

Reimplemented from Wikimedia\Rdbms\Database.

Definition at line 44 of file DatabaseMysqli.php.

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

◆ fetchAffectedRowCount()

Wikimedia\Rdbms\DatabaseMysqli::fetchAffectedRowCount ( )
protected

◆ getBindingHandle()

◆ insertId()

Wikimedia\Rdbms\DatabaseMysqli::insertId ( )

◆ lastErrno()

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

Implements Wikimedia\Rdbms\IDatabase.

Definition at line 154 of file DatabaseMysqli.php.

◆ mysqlConnect()

Wikimedia\Rdbms\DatabaseMysqli::mysqlConnect (   $realServer,
  $dbName 
)
protected
Parameters
string$realServer
string | null$dbName
Returns
mysqli|null
Exceptions
DBConnectionError

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 58 of file DatabaseMysqli.php.

References DBO_COMPRESS, DBO_PERSISTENT, DBO_SSL, Wikimedia\Rdbms\Database\getFlag(), and Wikimedia\Rdbms\Database\newExceptionAfterConnectError().

◆ mysqlDataSeek()

Wikimedia\Rdbms\DatabaseMysqli::mysqlDataSeek (   $res,
  $row 
)
protected
Parameters
mysqli_result$res
int$row
Returns
mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 273 of file DatabaseMysqli.php.

References $res.

◆ mysqlError()

Wikimedia\Rdbms\DatabaseMysqli::mysqlError (   $conn = null)
protected
Parameters
mysqli | null$connOptional connection object
Returns
string

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 281 of file DatabaseMysqli.php.

References Wikimedia\Rdbms\Database\$conn.

◆ mysqlFetchArray()

Wikimedia\Rdbms\DatabaseMysqli::mysqlFetchArray (   $res)
protected
Parameters
mysqli_result$res
Returns
array|false

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 198 of file DatabaseMysqli.php.

References $res.

◆ mysqlFetchField()

Wikimedia\Rdbms\DatabaseMysqli::mysqlFetchField (   $res,
  $n 
)
protected
Parameters
mysqli_result$res
int$n
Returns
mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 228 of file DatabaseMysqli.php.

References $res.

◆ mysqlFetchObject()

Wikimedia\Rdbms\DatabaseMysqli::mysqlFetchObject (   $res)
protected
Parameters
mysqli_result$res
Returns
stdClass|bool

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 185 of file DatabaseMysqli.php.

References $res.

◆ mysqlFieldName()

Wikimedia\Rdbms\DatabaseMysqli::mysqlFieldName (   $res,
  $n 
)
protected
Parameters
mysqli_result$res
int$n
Returns
mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 251 of file DatabaseMysqli.php.

References $res.

◆ mysqlFieldType()

Wikimedia\Rdbms\DatabaseMysqli::mysqlFieldType (   $res,
  $n 
)
protected
Parameters
mysqli_result$res
int$n
Returns
mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 262 of file DatabaseMysqli.php.

References $res.

◆ mysqlFreeResult()

Wikimedia\Rdbms\DatabaseMysqli::mysqlFreeResult (   $res)
protected
Parameters
mysqli_result$res
Returns
bool

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 175 of file DatabaseMysqli.php.

References $res.

◆ mysqlNumFields()

Wikimedia\Rdbms\DatabaseMysqli::mysqlNumFields (   $res)
protected
Parameters
mysqli_result$res
Returns
mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 219 of file DatabaseMysqli.php.

References $res.

◆ mysqlNumRows()

Wikimedia\Rdbms\DatabaseMysqli::mysqlNumRows (   $res)
protected
Parameters
mysqli_result$res
Returns
mixed

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 211 of file DatabaseMysqli.php.

References $res.

◆ mysqlRealEscapeString()

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

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

Parameters
string$s
Returns
string

Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.

Definition at line 294 of file DatabaseMysqli.php.

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


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