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) | |||||||||||||||||||
| buildIntegerCast ( $field) | |||||||||||||||||||
| buildStringCast ( $field) | |||||||||||||||||||
| |||||||||||||||||||
| 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) | |||||||||||||||||||
| 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... | |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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().
| |||||||||||||||||||
| serverIsReadOnly () | |||||||||||||||||||
| |||||||||||||||||||
| setBigSelects ( $value=true) | |||||||||||||||||||
| setSessionOptions (array $options) | |||||||||||||||||||
| streamStatementEnd (&$sql, &$newLine) | |||||||||||||||||||
| strencode ( $s) | |||||||||||||||||||
| tableExists ( $table, $fname=__METHOD__) | |||||||||||||||||||
| Query whether a given table exists. More... | |||||||||||||||||||
| useIndexClause ( $index) | |||||||||||||||||||
| 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 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.
| |||||||||||||||||||
| affectedRows () | |||||||||||||||||||
| Get the number of rows affected by the last write query. More... | |||||||||||||||||||
| anyChar () | |||||||||||||||||||
| Returns a token for buildLike() that denotes a '_' to be used in a LIKE query. More... | |||||||||||||||||||
| anyString () | |||||||||||||||||||
| Returns a token for buildLike() that denotes a '' to be used in a LIKE query. More... | |||||||||||||||||||
| begin ( $fname=__METHOD__, $mode=self::TRANSACTION_EXPLICIT) | |||||||||||||||||||
| Begin a transaction. More... | |||||||||||||||||||
| bitAnd ( $fieldLeft, $fieldRight) | |||||||||||||||||||
| |||||||||||||||||||
| bitNot ( $field) | |||||||||||||||||||
| |||||||||||||||||||
| bitOr ( $fieldLeft, $fieldRight) | |||||||||||||||||||
| |||||||||||||||||||
| buildConcat ( $stringList) | |||||||||||||||||||
Build a concatenation list to feed into a SQL query.
| |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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 );
| |||||||||||||||||||
| 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__) | |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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 reversible 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().
| |||||||||||||||||||
| encodeExpiry ( $expiry) | |||||||||||||||||||
| Encode an expiry time into the DBMS dependent format. More... | |||||||||||||||||||
| endAtomic ( $fname=__METHOD__) | |||||||||||||||||||
| Ends an atomic section of SQL statements. More... | |||||||||||||||||||
| explicitTrxActive () | |||||||||||||||||||
| Check whether there is a transaction open at the specific request of a caller. More... | |||||||||||||||||||
| factorConds ( $condsArray) | |||||||||||||||||||
| Given an array of condition arrays representing an OR list of AND lists, for example: More... | |||||||||||||||||||
| fieldExists ( $table, $field, $fname=__METHOD__) | |||||||||||||||||||
| Determines whether a field exists in a table. More... | |||||||||||||||||||
| flushSession ( $fname=__METHOD__) | |||||||||||||||||||
| Release important session-level state (named lock, table locks) as post-rollback cleanup. 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 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.
| |||||||||||||||||||
| 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... | |||||||||||||||||||
| 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.
| |||||||||||||||||||
| indexExists ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||
| Determines whether an index exists. More... | |||||||||||||||||||
| indexUnique ( $table, $index, $fname=__METHOD__) | |||||||||||||||||||
Determines if a given index is unique.
| |||||||||||||||||||
| initConnection () | |||||||||||||||||||
| Initialize the connection to the database over the wire (or to local files) More... | |||||||||||||||||||
| insert ( $table, $rows, $fname=__METHOD__, $options=[]) | |||||||||||||||||||
| Insert row(s) into a table, in the provided order. 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.
| |||||||||||||||||||
| lock ( $lockName, $method, $timeout=5, $flags=0) | |||||||||||||||||||
Acquire a named lock.Named locks are not related to transactions
| |||||||||||||||||||
| 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)
| |||||||||||||||||||
| 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... | |||||||||||||||||||
| newSelectQueryBuilder () | |||||||||||||||||||
Create an empty SelectQueryBuilder which can be used to run queries against this connection.
| |||||||||||||||||||
| 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 when the current transaction commits or now if there is none. 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... | |||||||||||||||||||
| ping (&$rtt=null) | |||||||||||||||||||
| Ping the server and try to reconnect if it there is no connection. More... | |||||||||||||||||||
| query ( $sql, $fname=__METHOD__, $flags=self::QUERY_NORMAL) | |||||||||||||||||||
| Run an SQL query statement and return the result. More... | |||||||||||||||||||
| replace ( $table, $uniqueKeys, $rows, $fname=__METHOD__) | |||||||||||||||||||
| Insert row(s) into a table, in the provided order, while deleting conflicting rows. 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... | |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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.
| |||||||||||||||||||
| setTransactionListener ( $name, callable $callback=null) | |||||||||||||||||||
| Run a callback after each time any transaction commits or rolls back. More... | |||||||||||||||||||
| setTransactionManager (TransactionManager $transactionManager) | |||||||||||||||||||
| 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)
| |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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".
| |||||||||||||||||||
| 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.
| |||||||||||||||||||
| 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 () | |||||||||||||||||||
| Get the status of the current transaction. More... | |||||||||||||||||||
| 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.
| |||||||||||||||||||
| unionSupportsOrderAndLimit () | |||||||||||||||||||
Determine if the RDBMS supports ORDER BY and LIMIT for separate subqueries within UNION.
| |||||||||||||||||||
| unlock ( $lockName, $method) | |||||||||||||||||||
Release a lock.Named locks are not related to transactions
| |||||||||||||||||||
| 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 row(s) into a table, in the provided order, while updating conflicting rows. 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
| |||||||||||||||||||
| 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 ( $server, $user, $password, $db) | |
| mysqlError ( $conn=null) | |
| mysqlRealEscapeString ( $s) | |
| Escapes special characters in a string for use in an SQL statement. More... | |
| Protected Member Functions inherited from Wikimedia\Rdbms\DatabaseMysqlBase | |
| doFlushSession ( $fname) | |
| Reset the server-side session state for named locks and table locks. More... | |
| doGetLag () | |
| Get the amount of replication lag for this database server. More... | |
| doReplace ( $table, array $identityKey, array $rows, $fname) | |
| doSelectDomain (DatabaseDomain $domain) | |
| 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 () | |
| isConnectionError ( $errno) | |
| Do not use this method outside of Database/DBError classes. More... | |
| isInsertSelectSafe (array $insertOptions, array $selectOptions) | |
| isKnownStatementRollbackError ( $errno) | |
| isQueryTimeoutError ( $errno) | |
| Checks whether the cause of the error is detected to be a timeout. More... | |
| isTransactableQuery ( $sql) | |
| Determine whether a SQL statement is sensitive to isolation level. More... | |
| normalizeJoinType (string $joinType) | |
| Validate and normalize a join type. More... | |
| open ( $server, $user, $password, $db, $schema, $tablePrefix) | |
| Open a new connection to the database (closing any existing one) More... | |
| useGTIDs () | |
| 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) More... | |
| assertIsWritablePrimary () | |
| Make sure that this server is not marked as a replica nor read-only. More... | |
| assertValidUpsertRowArray (array $rows, array $identityKey) | |
| assertValidUpsertSetArray (array $set, array $identityKey, array $rows) | |
| 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... | |
| 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) | |
| executeQuery ( $sql, $fname, $flags) | |
| Execute a query, retrying it if there is a recoverable connection loss. More... | |
| extractSingleFieldFromList ( $var) | |
| 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... | |
| 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 ( $lastErrno, $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... | |
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 acquisition timestamp (null if not acquired) More... | |
| const | QUERY_PSEUDO_PERMANENT = 2 |
| Track a TEMPORARY table CREATE as if it was for a permanent table (for testing) More... | |
| Static Protected Member Functions inherited from Wikimedia\Rdbms\Database | |
| static | getAttributes () |
| Protected Attributes inherited from Wikimedia\Rdbms\DatabaseMysqlBase | |
| bool null | $defaultBigSelects |
| string | $lagDetectionMethod |
| Method to detect replica DB lag. More... | |
| array | $lagDetectionOptions = [] |
| Method to detect replica DB lag. More... | |
| MySQLPrimaryPos | $lastKnownReplicaPos |
| ISQLPlatform | $platform |
| 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 false | $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... | |
| ISQLPlatform | $platform |
| 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 |
| Readable name or host/IP of the database server. More... | |
| array< string, array > | $sessionNamedLocks = [] |
| Map of (name => (UNIX time,trx ID)) for current lock() mutexes. More... | |
| array< string, array > | $sessionTempTables = [] |
| Map of (name => (type,pristine,trx ID)) for current temp 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... | |
| 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... | |
| const | DROPPED_CONN_BLAME_THRESHOLD_SEC = 3.0 |
| Assume that queries taking this long to yield connection loss errors are at fault. More... | |
| const | ERR_ABORT_QUERY = 2 |
| Abort query (no retries) due to a statement rollback (session/transaction intact) More... | |
| const | ERR_ABORT_SESSION = 8 |
| Abort and reset session due to server-side session-level state loss (locks, temp tables) More... | |
| const | ERR_ABORT_TRX = 4 |
| Abort any current transaction, by rolling it back, due to an error during the query. More... | |
| const | ERR_NONE = 0 |
| No errors occurred during the query. More... | |
| const | ERR_RETRY_QUERY = 1 |
| Retry query due to a connection loss detected while sending the query (session intact) More... | |
Detailed Description
Database abstraction object for PHP extension mysqli.
TODO: This could probably be merged with DatabaseMysqlBase. 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 42 of file DatabaseMysqli.php.
Member Function Documentation
◆ closeConnection()
|
protected |
- Returns
- bool
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 137 of file DatabaseMysqli.php.
References Wikimedia\Rdbms\Database\$conn, and Wikimedia\Rdbms\DatabaseMysqli\getBindingHandle().
◆ doQuery()
|
protected |
- Parameters
-
string $sql
- Returns
- MysqliResultWrapper|bool
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 47 of file DatabaseMysqli.php.
References $res, and Wikimedia\Rdbms\DatabaseMysqli\getBindingHandle().
◆ fetchAffectedRowCount()
|
protected |
- Returns
- int
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 166 of file DatabaseMysqli.php.
References Wikimedia\Rdbms\Database\$conn, and Wikimedia\Rdbms\DatabaseMysqli\getBindingHandle().
◆ getBindingHandle()
|
protected |
- Returns
- mysqli
Reimplemented from Wikimedia\Rdbms\Database.
Definition at line 198 of file DatabaseMysqli.php.
Referenced by Wikimedia\Rdbms\DatabaseMysqli\closeConnection(), Wikimedia\Rdbms\DatabaseMysqli\doQuery(), Wikimedia\Rdbms\DatabaseMysqli\fetchAffectedRowCount(), Wikimedia\Rdbms\DatabaseMysqli\insertId(), and Wikimedia\Rdbms\DatabaseMysqli\mysqlRealEscapeString().
◆ insertId()
| Wikimedia\Rdbms\DatabaseMysqli::insertId | ( | ) |
- Returns
- int
Implements Wikimedia\Rdbms\IDatabase.
Definition at line 146 of file DatabaseMysqli.php.
References Wikimedia\Rdbms\Database\$conn, and Wikimedia\Rdbms\DatabaseMysqli\getBindingHandle().
◆ lastErrno()
| Wikimedia\Rdbms\DatabaseMysqli::lastErrno | ( | ) |
◆ mysqlConnect()
|
protected |
- Parameters
-
string | null $server string | null $user string | null $password string | null $db
- Returns
- mysqli|null
- Exceptions
-
DBConnectionError
Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 63 of file DatabaseMysqli.php.
References Wikimedia\Rdbms\Database\$flags, Wikimedia\Rdbms\Database\$password, Wikimedia\Rdbms\Database\$server, Wikimedia\Rdbms\Database\$user, DBO_COMPRESS, DBO_PERSISTENT, DBO_SSL, Wikimedia\Rdbms\Database\getFlag(), and Wikimedia\Rdbms\Database\newExceptionAfterConnectError().
◆ mysqlError()
|
protected |
- Parameters
-
mysqli | null $conn Optional connection object
- Returns
- string
Reimplemented from Wikimedia\Rdbms\DatabaseMysqlBase.
Definition at line 176 of file DatabaseMysqli.php.
References Wikimedia\Rdbms\Database\$conn.
◆ mysqlRealEscapeString()
|
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 189 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:
- includes/libs/rdbms/database/DatabaseMysqli.php
