3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
20 namespace Wikimedia\Rdbms
;
22 use InvalidArgumentException
;
23 use Wikimedia\ScopedCallback
;
28 * @defgroup Database Database
29 * This group deals with database interface functions
30 * and query specifics/optimisations.
33 * Basic database interface for live and lazy-loaded relation database handles
35 * @note IDatabase and DBConnRef should be updated to reflect any changes
39 /** @var int Callback triggered immediately due to no active transaction */
40 const TRIGGER_IDLE
= 1;
41 /** @var int Callback triggered by COMMIT */
42 const TRIGGER_COMMIT
= 2;
43 /** @var int Callback triggered by ROLLBACK */
44 const TRIGGER_ROLLBACK
= 3;
45 /** @var int Callback triggered by atomic section cancel (ROLLBACK TO SAVEPOINT) */
46 const TRIGGER_CANCEL
= 4;
48 /** @var string Transaction is requested by regular caller outside of the DB layer */
49 const TRANSACTION_EXPLICIT
= '';
50 /** @var string Transaction is requested internally via DBO_TRX/startAtomic() */
51 const TRANSACTION_INTERNAL
= 'implicit';
53 /** @var string Atomic section is not cancelable */
54 const ATOMIC_NOT_CANCELABLE
= '';
55 /** @var string Atomic section is cancelable */
56 const ATOMIC_CANCELABLE
= 'cancelable';
58 /** @var string Commit/rollback is from outside the IDatabase handle and connection manager */
59 const FLUSHING_ONE
= '';
60 /** @var string Commit/rollback is from the connection manager for the IDatabase handle */
61 const FLUSHING_ALL_PEERS
= 'flush';
62 /** @var string Commit/rollback is from the IDatabase handle internally */
63 const FLUSHING_INTERNAL
= 'flush-internal';
65 /** @var string Do not remember the prior flags */
66 const REMEMBER_NOTHING
= '';
67 /** @var string Remember the prior flags */
68 const REMEMBER_PRIOR
= 'remember';
69 /** @var string Restore to the prior flag state */
70 const RESTORE_PRIOR
= 'prior';
71 /** @var string Restore to the initial flag state */
72 const RESTORE_INITIAL
= 'initial';
74 /** @var string Estimate total time (RTT, scanning, waiting on locks, applying) */
75 const ESTIMATE_TOTAL
= 'total';
76 /** @var string Estimate time to apply (scanning, applying) */
77 const ESTIMATE_DB_APPLY
= 'apply';
79 /** @var int Combine list with comma delimeters */
81 /** @var int Combine list with AND clauses */
83 /** @var int Convert map into a SET clause */
85 /** @var int Treat as field name and do not apply value escaping */
87 /** @var int Combine list with OR clauses */
90 /** @var int Enable debug logging of all SQL queries */
92 /** @var int Disable query buffering (only one result set can be iterated at a time) */
93 const DBO_NOBUFFER
= 2;
94 /** @var int Ignore query errors (internal use only!) */
96 /** @var int Automatically start a transaction before running a query if none is active */
98 /** @var int Use DBO_TRX in non-CLI mode */
99 const DBO_DEFAULT
= 16;
100 /** @var int Use DB persistent connections if possible */
101 const DBO_PERSISTENT
= 32;
102 /** @var int DBA session mode; mostly for Oracle */
103 const DBO_SYSDBA
= 64;
104 /** @var int Schema file mode; mostly for Oracle */
105 const DBO_DDLMODE
= 128;
106 /** @var int Enable SSL/TLS in connection protocol */
108 /** @var int Enable compression in connection protocol */
109 const DBO_COMPRESS
= 512;
111 /** @var int Idiom for "no special flags" */
112 const QUERY_NORMAL
= 0;
113 /** @var int Ignore query errors and return false when they happen */
114 const QUERY_SILENCE_ERRORS
= 1; // b/c for 1.32 query() argument; note that (int)true = 1
116 * @var int Treat the TEMPORARY table from the given CREATE query as if it is
117 * permanent as far as write tracking is concerned. This is useful for testing.
119 const QUERY_PSEUDO_PERMANENT
= 2;
120 /** @var int Enforce that a query does not make effective writes */
121 const QUERY_REPLICA_ROLE
= 4;
122 /** @var int Ignore the current presence of any DBO_TRX flag */
123 const QUERY_IGNORE_DBO_TRX
= 8;
124 /** @var int Do not try to retry the query if the connection was lost */
125 const QUERY_NO_RETRY
= 16;
127 /** @var bool Parameter to unionQueries() for UNION ALL */
128 const UNION_ALL
= true;
129 /** @var bool Parameter to unionQueries() for UNION DISTINCT */
130 const UNION_DISTINCT
= false;
133 * A string describing the current software version, and possibly
134 * other details in a user-friendly way. Will be listed on Special:Version, etc.
135 * Use getServerVersion() to get machine-friendly information.
137 * @return string Version information from the database server
139 public function getServerInfo();
142 * Turns buffering of SQL result sets on (true) or off (false). Default is "on".
144 * Unbuffered queries are very troublesome in MySQL:
146 * - If another query is executed while the first query is being read
147 * out, the first query is killed. This means you can't call normal
148 * Database functions while you are reading an unbuffered query result
149 * from a normal Database connection.
151 * - Unbuffered queries cause the MySQL server to use large amounts of
152 * memory and to hold broad locks which block other queries.
154 * If you want to limit client-side memory, it's almost always better to
155 * split up queries into batches using a LIMIT clause than to switch off
158 * @param null|bool $buffer
159 * @return null|bool The previous value of the flag
161 public function bufferResults( $buffer = null );
164 * Gets the current transaction level.
166 * Historically, transactions were allowed to be "nested". This is no
167 * longer supported, so this function really only returns a boolean.
169 * @return int The previous value
171 public function trxLevel();
174 * Get the UNIX timestamp of the time that the transaction was established
176 * This can be used to reason about the staleness of SELECT data in REPEATABLE-READ
177 * transaction isolation level. Callers can assume that if a view-snapshot isolation
178 * is used, then the data read by SQL queries is *at least* up to date to that point
179 * (possibly more up-to-date since the first SELECT defines the snapshot).
181 * @return float|null Returns null if there is not active transaction
184 public function trxTimestamp();
187 * @return bool Whether an explicit transaction or atomic sections are still open
190 public function explicitTrxActive();
193 * Assert that all explicit transactions or atomic sections have been closed.
194 * @throws DBTransactionError
197 public function assertNoOpenTransactions();
200 * Get/set the table prefix.
201 * @param string|null $prefix The table prefix to set, or omitted to leave it unchanged.
202 * @return string The previous table prefix
203 * @throws DBUnexpectedError
205 public function tablePrefix( $prefix = null );
208 * Get/set the db schema.
209 * @param string|null $schema The database schema to set, or omitted to leave it unchanged.
210 * @return string The previous db schema
212 public function dbSchema( $schema = null );
215 * Get properties passed down from the server info array of the load
218 * @param string|null $name The entry of the info array to get, or null to get the
221 * @return array|mixed|null
223 public function getLBInfo( $name = null );
226 * Set the entire array or a particular key of the managing load balancer info array
228 * @param array|string $nameOrArray The new array or the name of a key to set
229 * @param array|null $value If $nameOrArray is a string, the new key value (null to unset)
231 public function setLBInfo( $nameOrArray, $value = null );
234 * Set a lazy-connecting DB handle to the master DB (for replication status purposes)
236 * @param IDatabase $conn
239 public function setLazyMasterHandle( IDatabase
$conn );
242 * Returns true if this database does an implicit order by when the column has an index
243 * For example: SELECT page_title FROM page LIMIT 1
247 public function implicitOrderby();
250 * Return the last query that sent on account of IDatabase::query()
251 * @return string SQL text or empty string if there was no such query
253 public function lastQuery();
256 * Returns the last time the connection may have been used for write queries.
257 * Should return a timestamp if unsure.
259 * @return int|float UNIX timestamp or false
262 public function lastDoneWrites();
265 * @return bool Whether there is a transaction open with possible write queries
268 public function writesPending();
271 * @return bool Whether there is a transaction open with pre-commit callbacks pending
274 public function preCommitCallbacksPending();
277 * Whether there is a transaction open with either possible write queries
278 * or unresolved pre-commit/commit/resolution callbacks pending
280 * This does *not* count recurring callbacks, e.g. from setTransactionListener().
284 public function writesOrCallbacksPending();
287 * Get the time spend running write queries for this transaction
289 * High times could be due to scanning, updates, locking, and such
291 * @param string $type IDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL]
292 * @return float|bool Returns false if not transaction is active
295 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
);
298 * Get the list of method names that did write queries for this transaction
303 public function pendingWriteCallers();
306 * Get the number of affected rows from pending write queries
311 public function pendingWriteRowsAffected();
314 * Is a connection to the database open?
317 public function isOpen();
320 * Set a flag for this connection
322 * @param int $flag IDatabase::DBO_DEBUG, IDatabase::DBO_NOBUFFER, or IDatabase::DBO_TRX
323 * @param string $remember IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]
325 public function setFlag( $flag, $remember = self
::REMEMBER_NOTHING
);
328 * Clear a flag for this connection
330 * @param int $flag IDatabase::DBO_DEBUG, IDatabase::DBO_NOBUFFER, or IDatabase::DBO_TRX
331 * @param string $remember IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]
333 public function clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
);
336 * Restore the flags to their prior state before the last setFlag/clearFlag call
338 * @param string $state IDatabase::RESTORE_* constant. [default: RESTORE_PRIOR]
341 public function restoreFlags( $state = self
::RESTORE_PRIOR
);
344 * Returns a boolean whether the flag $flag is set for this connection
346 * @param int $flag One of the class IDatabase::DBO_* constants
349 public function getFlag( $flag );
352 * Return the currently selected domain ID
354 * Null components (database/schema) might change once a connection is established
358 public function getDomainID();
361 * Get the type of the DBMS, as it appears in $wgDBtype.
365 public function getType();
368 * Fetch the next row from the given result object, in object form.
369 * Fields can be retrieved with $row->fieldname, with fields acting like
371 * If no more rows are available, false is returned.
373 * @param IResultWrapper|stdClass $res Object as returned from IDatabase::query(), etc.
374 * @return stdClass|bool
375 * @throws DBUnexpectedError Thrown if the database returns an error
377 public function fetchObject( $res );
380 * Fetch the next row from the given result object, in associative array
381 * form. Fields are retrieved with $row['fieldname'].
382 * If no more rows are available, false is returned.
384 * @param IResultWrapper $res Result object as returned from IDatabase::query(), etc.
386 * @throws DBUnexpectedError Thrown if the database returns an error
388 public function fetchRow( $res );
391 * Get the number of rows in a query result. If the query did not return
392 * any rows (for example, if it was a write query), this returns zero.
394 * @param mixed $res A SQL result
397 public function numRows( $res );
400 * Get the number of fields in a result object
401 * @see https://www.php.net/mysql_num_fields
403 * @param mixed $res A SQL result
406 public function numFields( $res );
409 * Get a field name in a result object
410 * @see https://www.php.net/mysql_field_name
412 * @param mixed $res A SQL result
416 public function fieldName( $res, $n );
419 * Get the inserted value of an auto-increment row
421 * This should only be called after an insert that used an auto-incremented
422 * value. If no such insert was previously done in the current database
423 * session, the return value is undefined.
427 public function insertId();
430 * Change the position of the cursor in a result object
431 * @see https://www.php.net/mysql_data_seek
433 * @param mixed $res A SQL result
436 public function dataSeek( $res, $row );
439 * Get the last error number
440 * @see https://www.php.net/mysql_errno
444 public function lastErrno();
447 * Get a description of the last error
448 * @see https://www.php.net/mysql_error
452 public function lastError();
455 * Get the number of rows affected by the last write query
456 * @see https://www.php.net/mysql_affected_rows
460 public function affectedRows();
463 * Returns a wikitext link to the DB's website, e.g.,
464 * return "[https://www.mysql.com/ MySQL]";
465 * Should at least contain plain text, if for some reason
466 * your database has no website.
468 * @return string Wikitext of a link to the server software's web site
470 public function getSoftwareLink();
473 * A string describing the current software version, like from
474 * mysql_get_server_info().
476 * @return string Version information from the database server.
478 public function getServerVersion();
481 * Close the database connection
483 * This should only be called after any transactions have been resolved,
484 * aside from read-only automatic transactions (assuming no callbacks are registered).
485 * If a transaction is still open anyway, it will be rolled back.
488 * @return bool Operation success. true if already closed.
490 public function close();
493 * Run an SQL query and return the result. Normally throws a DBQueryError
494 * on failure. If errors are ignored, returns false instead.
496 * If a connection loss is detected, then an attempt to reconnect will be made.
497 * For queries that involve no larger transactions or locks, they will be re-issued
498 * for convenience, provided the connection was re-established.
500 * In new code, the query wrappers select(), insert(), update(), delete(),
501 * etc. should be used where possible, since they give much better DBMS
502 * independence and automatically quote or validate user input in a variety
503 * of contexts. This function is generally only useful for queries which are
504 * explicitly DBMS-dependent and are unsupported by the query wrappers, such
507 * However, the query wrappers themselves should call this function.
509 * @param string $sql SQL query
510 * @param string $fname Name of the calling function, for profiling/SHOW PROCESSLIST
511 * comment (you can use __METHOD__ or add some extra info)
512 * @param int $flags Bitfield of IDatabase::QUERY_* constants. Note that suppression
513 * of errors is best handled by try/catch rather than using one of these flags.
514 * @return bool|IResultWrapper True for a successful write query, IResultWrapper object
515 * for a successful read query, or false on failure if QUERY_SILENCE_ERRORS is set.
518 public function query( $sql, $fname = __METHOD__
, $flags = 0 );
521 * Free a result object returned by query() or select(). It's usually not
522 * necessary to call this, just use unset() or let the variable holding
523 * the result object go out of scope.
525 * @param mixed $res A SQL result
527 public function freeResult( $res );
530 * A SELECT wrapper which returns a single field from a single result row.
532 * Usually throws a DBQueryError on failure. If errors are explicitly
533 * ignored, returns false on failure.
535 * If no result rows are returned from the query, false is returned.
537 * @param string|array $table Table name. See IDatabase::select() for details.
538 * @param string $var The field name to select. This must be a valid SQL
539 * fragment: do not use unvalidated user input.
540 * @param string|array $cond The condition array. See IDatabase::select() for details.
541 * @param string $fname The function name of the caller.
542 * @param string|array $options The query options. See IDatabase::select() for details.
543 * @param string|array $join_conds The query join conditions. See IDatabase::select() for details.
545 * @return mixed The value from the field
548 public function selectField(
549 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
553 * A SELECT wrapper which returns a list of single field values from result rows.
555 * Usually throws a DBQueryError on failure. If errors are explicitly
556 * ignored, returns false on failure.
558 * If no result rows are returned from the query, false is returned.
560 * @param string|array $table Table name. See IDatabase::select() for details.
561 * @param string $var The field name to select. This must be a valid SQL
562 * fragment: do not use unvalidated user input.
563 * @param string|array $cond The condition array. See IDatabase::select() for details.
564 * @param string $fname The function name of the caller.
565 * @param string|array $options The query options. See IDatabase::select() for details.
566 * @param string|array $join_conds The query join conditions. See IDatabase::select() for details.
568 * @return array The values from the field in the order they were returned from the DB
572 public function selectFieldValues(
573 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
577 * Execute a SELECT query constructed using the various parameters provided.
578 * See below for full details of the parameters.
580 * @param string|array $table Table name(s)
582 * May be either an array of table names, or a single string holding a table
583 * name. If an array is given, table aliases can be specified, for example:
587 * This includes the user table in the query, with the alias "a" available
588 * for use in field names (e.g. a.user_name).
590 * A derived table, defined by the result of selectSQLText(), requires an alias
591 * key and a Subquery instance value which wraps the SQL query, for example:
593 * [ 'c' => new Subquery( 'SELECT ...' ) ]
595 * Joins using parentheses for grouping (since MediaWiki 1.31) may be
596 * constructed using nested arrays. For example,
598 * [ 'tableA', 'nestedB' => [ 'tableB', 'b2' => 'tableB2' ] ]
600 * along with `$join_conds` like
602 * [ 'b2' => [ 'JOIN', 'b_id = b2_id' ], 'nestedB' => [ 'LEFT JOIN', 'b_a = a_id' ] ]
604 * will produce SQL something like
606 * FROM tableA LEFT JOIN (tableB JOIN tableB2 AS b2 ON (b_id = b2_id)) ON (b_a = a_id)
608 * All of the table names given here are automatically run through
609 * Database::tableName(), which causes the table prefix (if any) to be
610 * added, and various other table name mappings to be performed.
612 * Do not use untrusted user input as a table name. Alias names should
613 * not have characters outside of the Basic multilingual plane.
615 * @param string|array $vars Field name(s)
617 * May be either a field name or an array of field names. The field names
618 * can be complete fragments of SQL, for direct inclusion into the SELECT
619 * query. If an array is given, field aliases can be specified, for example:
621 * [ 'maxrev' => 'MAX(rev_id)' ]
623 * This includes an expression with the alias "maxrev" in the query.
625 * If an expression is given, care must be taken to ensure that it is
628 * Untrusted user input must not be passed to this parameter.
630 * @param string|array $conds
632 * May be either a string containing a single condition, or an array of
633 * conditions. If an array is given, the conditions constructed from each
634 * element are combined with AND.
636 * Array elements may take one of two forms:
638 * - Elements with a numeric key are interpreted as raw SQL fragments.
639 * - Elements with a string key are interpreted as equality conditions,
640 * where the key is the field name.
641 * - If the value of such an array element is a scalar (such as a
642 * string), it will be treated as data and thus quoted appropriately.
643 * If it is null, an IS NULL clause will be added.
644 * - If the value is an array, an IN (...) clause will be constructed
645 * from its non-null elements, and an IS NULL clause will be added
646 * if null is present, such that the field may match any of the
647 * elements in the array. The non-null elements will be quoted.
649 * Note that expressions are often DBMS-dependent in their syntax.
650 * DBMS-independent wrappers are provided for constructing several types of
651 * expression commonly used in condition queries. See:
652 * - IDatabase::buildLike()
653 * - IDatabase::conditional()
655 * Untrusted user input is safe in the values of string keys, however untrusted
656 * input must not be used in the array key names or in the values of numeric keys.
657 * Escaping of untrusted input used in values of numeric keys should be done via
658 * IDatabase::addQuotes()
660 * Use an empty array, string, or '*' to update all rows.
662 * @param string $fname Caller function name
664 * @param string|array $options Query options
666 * Optional: Array of query options. Boolean options are specified by
667 * including them in the array as a string value with a numeric key, for
672 * The supported options are:
674 * - OFFSET: Skip this many rows at the start of the result set. OFFSET
675 * with LIMIT can theoretically be used for paging through a result set,
676 * but this is discouraged for performance reasons.
678 * - LIMIT: Integer: return at most this many rows. The rows are sorted
679 * and then the first rows are taken until the limit is reached. LIMIT
680 * is applied to a result set after OFFSET.
682 * - LOCK IN SHARE MODE: Boolean: lock the returned rows so that they can't be
683 * changed until the next COMMIT. Cannot be used with aggregate functions
684 * (COUNT, MAX, etc., but also DISTINCT).
686 * - FOR UPDATE: Boolean: lock the returned rows so that they can't be
687 * changed nor read with LOCK IN SHARE MODE until the next COMMIT.
688 * Cannot be used with aggregate functions (COUNT, MAX, etc., but also DISTINCT).
690 * - DISTINCT: Boolean: return only unique result rows.
692 * - GROUP BY: May be either an SQL fragment string naming a field or
693 * expression to group by, or an array of such SQL fragments.
695 * - HAVING: May be either an string containing a HAVING clause or an array of
696 * conditions building the HAVING clause. If an array is given, the conditions
697 * constructed from each element are combined with AND.
699 * - ORDER BY: May be either an SQL fragment giving a field name or
700 * expression to order by, or an array of such SQL fragments.
702 * - USE INDEX: This may be either a string giving the index name to use
703 * for the query, or an array. If it is an associative array, each key
704 * gives the table name (or alias), each value gives the index name to
705 * use for that table. All strings are SQL fragments and so should be
706 * validated by the caller.
708 * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run,
711 * And also the following boolean MySQL extensions, see the MySQL manual
716 * - SQL_BUFFER_RESULT
718 * - SQL_CALC_FOUND_ROWS
720 * @param string|array $join_conds Join conditions
722 * Optional associative array of table-specific join conditions. In the
723 * most common case, this is unnecessary, since the join condition can be
724 * in $conds. However, it is useful for doing a LEFT JOIN.
726 * The key of the array contains the table name or alias. The value is an
727 * array with two elements, numbered 0 and 1. The first gives the type of
728 * join, the second is the same as the $conds parameter. Thus it can be
729 * an SQL fragment, or an array where the string keys are equality and the
730 * numeric keys are SQL fragments all AND'd together. For example:
732 * [ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]
734 * @return IResultWrapper Resulting rows
737 public function select(
738 $table, $vars, $conds = '', $fname = __METHOD__
,
739 $options = [], $join_conds = []
743 * The equivalent of IDatabase::select() except that the constructed SQL
744 * is returned, instead of being immediately executed. This can be useful for
745 * doing UNION queries, where the SQL text of each query is needed. In general,
746 * however, callers outside of Database classes should just use select().
748 * @see IDatabase::select()
750 * @param string|array $table Table name
751 * @param string|array $vars Field names
752 * @param string|array $conds Conditions
753 * @param string $fname Caller function name
754 * @param string|array $options Query options
755 * @param string|array $join_conds Join conditions
756 * @return string SQL query string
758 public function selectSQLText(
759 $table, $vars, $conds = '', $fname = __METHOD__
,
760 $options = [], $join_conds = []
764 * Single row SELECT wrapper. Equivalent to IDatabase::select(), except
765 * that a single row object is returned. If the query returns no rows,
768 * @param string|array $table Table name
769 * @param string|array $vars Field names
770 * @param string|array $conds Conditions
771 * @param string $fname Caller function name
772 * @param string|array $options Query options
773 * @param array|string $join_conds Join conditions
775 * @return stdClass|bool
778 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
779 $options = [], $join_conds = []
783 * Estimate the number of rows in dataset
785 * MySQL allows you to estimate the number of rows that would be returned
786 * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using
787 * index cardinality statistics, and is notoriously inaccurate, especially
788 * when large numbers of rows have recently been added or deleted.
790 * For DBMSs that don't support fast result size estimation, this function
791 * will actually perform the SELECT COUNT(*).
793 * Takes the same arguments as IDatabase::select().
795 * @param string $table Table name
796 * @param string $var Column for which NULL values are not counted [default "*"]
797 * @param array|string $conds Filters on the table
798 * @param string $fname Function name for profiling
799 * @param array $options Options for select
800 * @param array|string $join_conds Join conditions
801 * @return int Row count
804 public function estimateRowCount(
805 $table, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
809 * Get the number of rows in dataset
811 * This is useful when trying to do COUNT(*) but with a LIMIT for performance.
813 * Takes the same arguments as IDatabase::select().
815 * @since 1.27 Added $join_conds parameter
817 * @param array|string $tables Table names
818 * @param string $var Column for which NULL values are not counted [default "*"]
819 * @param array|string $conds Filters on the table
820 * @param string $fname Function name for profiling
821 * @param array $options Options for select
822 * @param array $join_conds Join conditions (since 1.27)
823 * @return int Row count
826 public function selectRowCount(
827 $tables, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
831 * Lock all rows meeting the given conditions/options FOR UPDATE
833 * @param array|string $table Table names
834 * @param array|string $conds Filters on the table
835 * @param string $fname Function name for profiling
836 * @param array $options Options for select ("FOR UPDATE" is added automatically)
837 * @param array $join_conds Join conditions
838 * @return int Number of matching rows found (and locked)
841 public function lockForUpdate(
842 $table, $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
846 * Determines whether a field exists in a table
848 * @param string $table Table name
849 * @param string $field Filed to check on that table
850 * @param string $fname Calling function name (optional)
851 * @return bool Whether $table has filed $field
854 public function fieldExists( $table, $field, $fname = __METHOD__
);
857 * Determines whether an index exists
858 * Usually throws a DBQueryError on failure
859 * If errors are explicitly ignored, returns NULL on failure
861 * @param string $table
862 * @param string $index
863 * @param string $fname
867 public function indexExists( $table, $index, $fname = __METHOD__
);
870 * Query whether a given table exists
872 * @param string $table
873 * @param string $fname
877 public function tableExists( $table, $fname = __METHOD__
);
880 * INSERT wrapper, inserts an array into a table.
884 * - A single associative array. The array keys are the field names, and
885 * the values are the values to insert. The values are treated as data
886 * and will be quoted appropriately. If NULL is inserted, this will be
887 * converted to a database NULL.
888 * - An array with numeric keys, holding a list of associative arrays.
889 * This causes a multi-row INSERT on DBMSs that support it. The keys in
890 * each subarray must be identical to each other, and in the same order.
892 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
895 * $options is an array of options, with boolean options encoded as values
896 * with numeric keys, in the same style as $options in
897 * IDatabase::select(). Supported options are:
899 * - IGNORE: Boolean: if present, duplicate key errors are ignored, and
900 * any rows which cause duplicate key errors are not inserted. It's
901 * possible to determine how many rows were successfully inserted using
902 * IDatabase::affectedRows().
904 * @param string $table Table name. This will be passed through
905 * Database::tableName().
906 * @param array $a Array of rows to insert
907 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
908 * @param array $options Array of options
909 * @return bool Return true if no exception was thrown (deprecated since 1.33)
912 public function insert( $table, $a, $fname = __METHOD__
, $options = [] );
915 * UPDATE wrapper. Takes a condition array and a SET array.
917 * @param string $table Name of the table to UPDATE. This will be passed through
918 * Database::tableName().
919 * @param array $values An array of values to SET. For each array element,
920 * the key gives the field name, and the value gives the data to set
921 * that field to. The data will be quoted by IDatabase::addQuotes().
922 * Values with integer keys form unquoted SET statements, which can be used for
923 * things like "field = field + 1" or similar computed values.
924 * @param array $conds An array of conditions (WHERE). See
925 * IDatabase::select() for the details of the format of condition
926 * arrays. Use '*' to update all rows.
927 * @param string $fname The function name of the caller (from __METHOD__),
928 * for logging and profiling.
929 * @param array $options An array of UPDATE options, can be:
930 * - IGNORE: Ignore unique key conflicts
931 * @return bool Return true if no exception was thrown (deprecated since 1.33)
934 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] );
937 * Makes an encoded list of strings from an array
939 * These can be used to make conjunctions or disjunctions on SQL condition strings
940 * derived from an array (see IDatabase::select() $conds documentation).
944 * $sql = $db->makeList( [
946 * $db->makeList( [ 'rev_minor' => 1, 'rev_len' < 500 ], $db::LIST_OR ] )
947 * ], $db::LIST_AND );
949 * This would set $sql to "rev_page = '$id' AND (rev_minor = '1' OR rev_len < '500')"
951 * @param array $a Containing the data
952 * @param int $mode IDatabase class constant:
953 * - IDatabase::LIST_COMMA: Comma separated, no field names
954 * - IDatabase::LIST_AND: ANDed WHERE clause (without the WHERE).
955 * - IDatabase::LIST_OR: ORed WHERE clause (without the WHERE)
956 * - IDatabase::LIST_SET: Comma separated with field names, like a SET clause
957 * - IDatabase::LIST_NAMES: Comma separated field names
961 public function makeList( $a, $mode = self
::LIST_COMMA
);
964 * Build a partial where clause from a 2-d array such as used for LinkBatch.
965 * The keys on each level may be either integers or strings.
967 * @param array $data Organized as 2-d
968 * [ baseKeyVal => [ subKeyVal => [ignored], ... ], ... ]
969 * @param string $baseKey Field name to match the base-level keys to (eg 'pl_namespace')
970 * @param string $subKey Field name to match the sub-level keys to (eg 'pl_title')
971 * @return string|bool SQL fragment, or false if no items in array
973 public function makeWhereFrom2d( $data, $baseKey, $subKey );
976 * Return aggregated value alias
978 * @param array $valuedata
979 * @param string $valuename
982 * @deprecated Since 1.33
984 public function aggregateValue( $valuedata, $valuename = 'value' );
987 * @param string $field
990 public function bitNot( $field );
993 * @param string $fieldLeft
994 * @param string $fieldRight
997 public function bitAnd( $fieldLeft, $fieldRight );
1000 * @param string $fieldLeft
1001 * @param string $fieldRight
1004 public function bitOr( $fieldLeft, $fieldRight );
1007 * Build a concatenation list to feed into a SQL query
1008 * @param array $stringList List of raw SQL expressions; caller is
1009 * responsible for any quoting
1012 public function buildConcat( $stringList );
1015 * Build a GROUP_CONCAT or equivalent statement for a query.
1017 * This is useful for combining a field for several rows into a single string.
1018 * NULL values will not appear in the output, duplicated values will appear,
1019 * and the resulting delimiter-separated values have no defined sort order.
1020 * Code using the results may need to use the PHP unique() or sort() methods.
1022 * @param string $delim Glue to bind the results together
1023 * @param string|array $table Table name
1024 * @param string $field Field name
1025 * @param string|array $conds Conditions
1026 * @param string|array $join_conds Join conditions
1027 * @return string SQL text
1030 public function buildGroupConcatField(
1031 $delim, $table, $field, $conds = '', $join_conds = []
1035 * Build a SUBSTRING function.
1037 * Behavior for non-ASCII values is undefined.
1039 * @param string $input Field name
1040 * @param int $startPosition Positive integer
1041 * @param int|null $length Non-negative integer length or null for no limit
1042 * @throws InvalidArgumentException
1043 * @return string SQL text
1046 public function buildSubString( $input, $startPosition, $length = null );
1049 * @param string $field Field or column to cast
1053 public function buildStringCast( $field );
1056 * @param string $field Field or column to cast
1060 public function buildIntegerCast( $field );
1063 * Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery
1065 * @see IDatabase::selectSQLText()
1067 * @param string|array $table Table name
1068 * @param string|array $vars Field names
1069 * @param string|array $conds Conditions
1070 * @param string $fname Caller function name
1071 * @param string|array $options Query options
1072 * @param string|array $join_conds Join conditions
1076 public function buildSelectSubquery(
1077 $table, $vars, $conds = '', $fname = __METHOD__
,
1078 $options = [], $join_conds = []
1082 * Construct a LIMIT query with optional offset. This is used for query
1083 * pages. The SQL should be adjusted so that only the first $limit rows
1084 * are returned. If $offset is provided as well, then the first $offset
1085 * rows should be discarded, and the next $limit rows should be returned.
1086 * If the result of the query is not ordered, then the rows to be returned
1087 * are theoretically arbitrary.
1089 * $sql is expected to be a SELECT, if that makes a difference.
1091 * @param string $sql SQL query we will append the limit too
1092 * @param int $limit The SQL limit
1093 * @param int|bool $offset The SQL offset (default false)
1094 * @throws DBUnexpectedError
1098 public function limitResult( $sql, $limit, $offset = false );
1101 * Returns true if DBs are assumed to be on potentially different servers
1103 * In systems like mysql/mariadb, different databases can easily be referenced on a single
1104 * connection merely by name, even in a single query via JOIN. On the other hand, Postgres
1105 * treats databases as fully separate, only allowing mechanisms like postgres_fdw to
1106 * effectively "mount" foreign DBs. This is true even among DBs on the same server.
1111 public function databasesAreIndependent();
1114 * Change the current database
1116 * This should only be called by a load balancer or if the handle is not attached to one
1119 * @return bool True unless an exception was thrown
1120 * @throws DBConnectionError If databasesAreIndependent() is true and connection change fails
1121 * @throws DBError On query error or if database changes are disallowed
1122 * @deprecated Since 1.32 Use selectDomain() instead
1124 public function selectDB( $db );
1127 * Set the current domain (database, schema, and table prefix)
1129 * This will throw an error for some database types if the database is unspecified
1131 * This should only be called by a load balancer or if the handle is not attached to one
1133 * @param string|DatabaseDomain $domain
1134 * @throws DBConnectionError If databasesAreIndependent() is true and connection change fails
1135 * @throws DBError On query error, if domain changes are disallowed, or the domain is invalid
1138 public function selectDomain( $domain );
1141 * Get the current DB name
1142 * @return string|null
1144 public function getDBname();
1147 * Get the server hostname or IP address
1150 public function getServer();
1153 * Adds quotes and backslashes.
1155 * @param string|int|null|bool|Blob $s
1156 * @return string|int
1158 public function addQuotes( $s );
1161 * Quotes an identifier, in order to make user controlled input safe
1163 * Depending on the database this will either be `backticks` or "double quotes"
1169 public function addIdentifierQuotes( $s );
1172 * LIKE statement wrapper, receives a variable-length argument list with
1173 * parts of pattern to match containing either string literals that will be
1174 * escaped or tokens returned by anyChar() or anyString(). Alternatively,
1175 * the function could be provided with an array of aforementioned
1178 * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns
1179 * a LIKE clause that searches for subpages of 'My page title'.
1181 * $pattern = [ 'My_page_title/', $dbr->anyString() ];
1182 * $query .= $dbr->buildLike( $pattern );
1185 * @param array[]|string|LikeMatch $param
1186 * @return string Fully built LIKE statement
1187 * @phan-suppress-next-line PhanMismatchVariadicComment
1188 * @phan-param array|string|LikeMatch ...$param T226223
1190 public function buildLike( $param );
1193 * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
1197 public function anyChar();
1200 * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
1204 public function anyString();
1207 * Deprecated method, calls should be removed.
1209 * This was formerly used for PostgreSQL and Oracle to handle
1210 * self::insertId() auto-incrementing fields. It is no longer necessary
1211 * since DatabasePostgres::insertId() has been reimplemented using
1212 * `lastval()` and Oracle has been reimplemented using triggers.
1214 * Implementations should return null if inserting `NULL` into an
1215 * auto-incrementing field works, otherwise it should return an instance of
1216 * NextSequenceValue and filter it on calls to relevant methods.
1218 * @deprecated since 1.30, no longer needed
1219 * @param string $seqName
1220 * @return null|NextSequenceValue
1222 public function nextSequenceValue( $seqName );
1225 * REPLACE query wrapper.
1227 * REPLACE is a very handy MySQL extension, which functions like an INSERT
1228 * except that when there is a duplicate key error, the old row is deleted
1229 * and the new row is inserted in its place.
1231 * We simulate this with standard SQL with a DELETE followed by INSERT. To
1232 * perform the delete, we need to know what the unique indexes are so that
1233 * we know how to find the conflicting rows.
1235 * It may be more efficient to leave off unique indexes which are unlikely
1236 * to collide. However if you do this, you run the risk of encountering
1237 * errors which wouldn't have occurred in MySQL.
1239 * @param string $table The table to replace the row(s) in.
1240 * @param array[]|string[]|string $uniqueIndexes All unique indexes. One of the following:
1241 * a) the one unique field in the table (when no composite unique key exist)
1242 * b) a list of all unique fields in the table (when no composite unique key exist)
1243 * c) a list of all unique indexes in the table (each as a list of the indexed fields)
1244 * @param array $rows Can be either a single row to insert, or multiple rows,
1245 * in the same format as for IDatabase::insert()
1246 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1249 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
);
1252 * INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
1254 * This updates any conflicting rows (according to the unique indexes) using
1255 * the provided SET clause and inserts any remaining (non-conflicted) rows.
1257 * $rows may be either:
1258 * - A single associative array. The array keys are the field names, and
1259 * the values are the values to insert. The values are treated as data
1260 * and will be quoted appropriately. If NULL is inserted, this will be
1261 * converted to a database NULL.
1262 * - An array with numeric keys, holding a list of associative arrays.
1263 * This causes a multi-row INSERT on DBMSs that support it. The keys in
1264 * each subarray must be identical to each other, and in the same order.
1266 * It may be more efficient to leave off unique indexes which are unlikely
1267 * to collide. However if you do this, you run the risk of encountering
1268 * errors which wouldn't have occurred in MySQL.
1270 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
1275 * @param string $table Table name. This will be passed through Database::tableName().
1276 * @param array $rows A single row or list of rows to insert
1277 * @param array[]|string[]|string $uniqueIndexes All unique indexes. One of the following:
1278 * a) the one unique field in the table (when no composite unique key exist)
1279 * b) a list of all unique fields in the table (when no composite unique key exist)
1280 * c) a list of all unique indexes in the table (each as a list of the indexed fields)
1281 * @param array $set An array of values to SET. For each array element, the
1282 * key gives the field name, and the value gives the data to set that
1283 * field to. The data will be quoted by IDatabase::addQuotes().
1284 * Values with integer keys form unquoted SET statements, which can be used for
1285 * things like "field = field + 1" or similar computed values.
1286 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1288 * @return bool Return true if no exception was thrown (deprecated since 1.33)
1290 public function upsert(
1291 $table, array $rows, $uniqueIndexes, array $set, $fname = __METHOD__
1295 * DELETE where the condition is a join.
1297 * MySQL overrides this to use a multi-table DELETE syntax, in other databases
1298 * we use sub-selects
1300 * For safety, an empty $conds will not delete everything. If you want to
1301 * delete all rows where the join condition matches, set $conds='*'.
1303 * DO NOT put the join condition in $conds.
1305 * @param string $delTable The table to delete from.
1306 * @param string $joinTable The other table.
1307 * @param string $delVar The variable to join on, in the first table.
1308 * @param string $joinVar The variable to join on, in the second table.
1309 * @param array $conds Condition array of field names mapped to variables,
1310 * ANDed together in the WHERE clause
1311 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1314 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
1319 * DELETE query wrapper.
1321 * @param string $table Table name
1322 * @param string|array $conds Array of conditions. See $conds in IDatabase::select()
1323 * for the format. Use $conds == "*" to delete all rows
1324 * @param string $fname Name of the calling function
1325 * @throws DBUnexpectedError
1326 * @return bool Return true if no exception was thrown (deprecated since 1.33)
1329 public function delete( $table, $conds, $fname = __METHOD__
);
1332 * INSERT SELECT wrapper. Takes data from a SELECT query and inserts it
1333 * into another table.
1335 * @warning If the insert will use an auto-increment or sequence to
1336 * determine the value of a column, this may break replication on
1337 * databases using statement-based replication if the SELECT is not
1338 * deterministically ordered.
1340 * @param string $destTable The table name to insert into
1341 * @param string|array $srcTable May be either a table name, or an array of table names
1342 * to include in a join.
1344 * @param array $varMap Must be an associative array of the form
1345 * [ 'dest1' => 'source1', ... ]. Source items may be literals
1346 * rather than field names, but strings should be quoted with
1347 * IDatabase::addQuotes()
1349 * @param array $conds Condition array. See $conds in IDatabase::select() for
1350 * the details of the format of condition arrays. May be "*" to copy the
1353 * @param string $fname The function name of the caller, from __METHOD__
1355 * @param array $insertOptions Options for the INSERT part of the query, see
1356 * IDatabase::insert() for details. Also, one additional option is
1357 * available: pass 'NO_AUTO_COLUMNS' to hint that the query does not use
1358 * an auto-increment or sequence to determine any column values.
1359 * @param array $selectOptions Options for the SELECT part of the query, see
1360 * IDatabase::select() for details.
1361 * @param array $selectJoinConds Join conditions for the SELECT part of the query, see
1362 * IDatabase::select() for details.
1364 * @return bool Return true if no exception was thrown (deprecated since 1.33)
1367 public function insertSelect( $destTable, $srcTable, $varMap, $conds,
1368 $fname = __METHOD__
,
1369 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
1373 * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
1374 * within the UNION construct.
1377 public function unionSupportsOrderAndLimit();
1380 * Construct a UNION query
1381 * This is used for providing overload point for other DB abstractions
1382 * not compatible with the MySQL syntax.
1383 * @param array $sqls SQL statements to combine
1384 * @param bool $all Either IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT
1385 * @return string SQL fragment
1387 public function unionQueries( $sqls, $all );
1390 * Construct a UNION query for permutations of conditions
1392 * Databases sometimes have trouble with queries that have multiple values
1393 * for multiple condition parameters combined with limits and ordering.
1394 * This method constructs queries for the Cartesian product of the
1395 * conditions and unions them all together.
1397 * @see IDatabase::select()
1399 * @param string|array $table Table name
1400 * @param string|array $vars Field names
1401 * @param array $permute_conds Conditions for the Cartesian product. Keys
1402 * are field names, values are arrays of the possible values for that
1404 * @param string|array $extra_conds Additional conditions to include in the
1406 * @param string $fname Caller function name
1407 * @param string|array $options Query options. In addition to the options
1408 * recognized by IDatabase::select(), the following may be used:
1409 * - NOTALL: Set to use UNION instead of UNION ALL.
1410 * - INNER ORDER BY: If specified and supported, subqueries will use this
1411 * instead of ORDER BY.
1412 * @param string|array $join_conds Join conditions
1413 * @return string SQL query string.
1415 public function unionConditionPermutations(
1416 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__
,
1417 $options = [], $join_conds = []
1421 * Returns an SQL expression for a simple conditional. This doesn't need
1422 * to be overridden unless CASE isn't supported in your DBMS.
1424 * @param string|array $cond SQL expression which will result in a boolean value
1425 * @param string $trueVal SQL expression to return if true
1426 * @param string $falseVal SQL expression to return if false
1427 * @return string SQL fragment
1429 public function conditional( $cond, $trueVal, $falseVal );
1432 * Returns a command for str_replace function in SQL query.
1433 * Uses REPLACE() in MySQL
1435 * @param string $orig Column to modify
1436 * @param string $old Column to seek
1437 * @param string $new Column to replace with
1441 public function strreplace( $orig, $old, $new );
1444 * Determines how long the server has been up
1449 public function getServerUptime();
1452 * Determines if the last failure was due to a deadlock
1454 * Note that during a deadlock, the prior transaction will have been lost
1458 public function wasDeadlock();
1461 * Determines if the last failure was due to a lock timeout
1463 * Note that during a lock wait timeout, the prior transaction will have been lost
1467 public function wasLockTimeout();
1470 * Determines if the last query error was due to a dropped connection
1472 * Note that during a connection loss, the prior transaction will have been lost
1477 public function wasConnectionLoss();
1480 * Determines if the last failure was due to the database being read-only.
1484 public function wasReadOnlyError();
1487 * Determines if the last query error was due to something outside of the query itself
1489 * Note that the transaction may have been lost, discarding prior writes and results
1493 public function wasErrorReissuable();
1496 * Wait for the replica DB to catch up to a given master position
1498 * Note that this does not start any new transactions. If any existing transaction
1499 * is flushed, and this is called, then queries will reflect the point the DB was synced
1500 * up to (on success) without interference from REPEATABLE-READ snapshots.
1502 * @param DBMasterPos $pos
1503 * @param int $timeout The maximum number of seconds to wait for synchronisation
1504 * @return int|null Zero if the replica DB was past that position already,
1505 * greater than zero if we waited for some period of time, less than
1506 * zero if it timed out, and null on error
1509 public function masterPosWait( DBMasterPos
$pos, $timeout );
1512 * Get the replication position of this replica DB
1514 * @return DBMasterPos|bool False if this is not a replica DB
1517 public function getReplicaPos();
1520 * Get the position of this master
1522 * @return DBMasterPos|bool False if this is not a master
1525 public function getMasterPos();
1528 * @return bool Whether the DB is marked as read-only server-side
1531 public function serverIsReadOnly();
1534 * Run a callback as soon as the current transaction commits or rolls back.
1535 * An error is thrown if no transaction is pending. Queries in the function will run in
1536 * AUTOCOMMIT mode unless there are begin() calls. Callbacks must commit any transactions
1539 * This is useful for combining cooperative locks and DB transactions.
1541 * Note this is called when the whole transaction is resolved. To take action immediately
1542 * when an atomic section is cancelled, use onAtomicSectionCancel().
1544 * @note do not assume that *other* IDatabase instances will be AUTOCOMMIT mode
1546 * The callback takes the following arguments:
1547 * - How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK)
1548 * - This IDatabase instance (since 1.32)
1550 * @param callable $callback
1551 * @param string $fname Caller name
1554 public function onTransactionResolution( callable
$callback, $fname = __METHOD__
);
1557 * Run a callback as soon as there is no transaction pending.
1558 * If there is a transaction and it is rolled back, then the callback is cancelled.
1560 * When transaction round mode (DBO_TRX) is set, the callback will run at the end
1561 * of the round, just after all peer transactions COMMIT. If the transaction round
1562 * is rolled back, then the callback is cancelled.
1564 * Queries in the function will run in AUTOCOMMIT mode unless there are begin() calls.
1565 * Callbacks must commit any transactions that they begin.
1567 * This is useful for updates to different systems or when separate transactions are needed.
1568 * For example, one might want to enqueue jobs into a system outside the database, but only
1569 * after the database is updated so that the jobs will see the data when they actually run.
1570 * It can also be used for updates that easily suffer from lock timeouts and deadlocks,
1571 * but where atomicity is not essential.
1573 * Avoid using IDatabase instances aside from this one in the callback, unless such instances
1574 * never have IDatabase::DBO_TRX set. This keeps callbacks from interfering with one another.
1576 * Updates will execute in the order they were enqueued.
1578 * @note do not assume that *other* IDatabase instances will be AUTOCOMMIT mode
1580 * The callback takes the following arguments:
1581 * - How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_IDLE)
1582 * - This IDatabase instance (since 1.32)
1584 * @param callable $callback
1585 * @param string $fname Caller name
1588 public function onTransactionCommitOrIdle( callable
$callback, $fname = __METHOD__
);
1591 * Alias for onTransactionCommitOrIdle() for backwards-compatibility
1593 * @param callable $callback
1594 * @param string $fname
1596 * @deprecated Since 1.32
1598 public function onTransactionIdle( callable
$callback, $fname = __METHOD__
);
1601 * Run a callback before the current transaction commits or now if there is none.
1602 * If there is a transaction and it is rolled back, then the callback is cancelled.
1604 * When transaction round mode (DBO_TRX) is set, the callback will run at the end
1605 * of the round, just before all peer transactions COMMIT. If the transaction round
1606 * is rolled back, then the callback is cancelled.
1608 * Callbacks must not start nor commit any transactions. If no transaction is active,
1609 * then a transaction will wrap the callback.
1611 * This is useful for updates that easily suffer from lock timeouts and deadlocks,
1612 * but where atomicity is strongly desired for these updates and some related updates.
1614 * Updates will execute in the order they were enqueued.
1616 * The callback takes the one argument:
1617 * - This IDatabase instance (since 1.32)
1619 * @param callable $callback
1620 * @param string $fname Caller name
1623 public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
);
1626 * Run a callback when the atomic section is cancelled.
1628 * The callback is run just after the current atomic section, any outer
1629 * atomic section, or the whole transaction is rolled back.
1631 * An error is thrown if no atomic section is pending. The atomic section
1632 * need not have been created with the ATOMIC_CANCELABLE flag.
1634 * Queries in the function may be running in the context of an outer
1635 * transaction or may be running in AUTOCOMMIT mode. The callback should
1636 * use atomic sections if necessary.
1638 * @note do not assume that *other* IDatabase instances will be AUTOCOMMIT mode
1640 * The callback takes the following arguments:
1641 * - IDatabase::TRIGGER_CANCEL or IDatabase::TRIGGER_ROLLBACK
1642 * - This IDatabase instance
1644 * @param callable $callback
1645 * @param string $fname Caller name
1648 public function onAtomicSectionCancel( callable
$callback, $fname = __METHOD__
);
1651 * Run a callback after each time any transaction commits or rolls back
1653 * The callback takes two arguments:
1654 * - IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK
1655 * - This IDatabase object
1656 * Callbacks must commit any transactions that they begin.
1658 * Registering a callback here will not affect writesOrCallbacks() pending.
1660 * Since callbacks from this or onTransactionCommitOrIdle() can start and end transactions,
1661 * a single call to IDatabase::commit might trigger multiple runs of the listener callbacks.
1663 * @param string $name Callback name
1664 * @param callable|null $callback Use null to unset a listener
1667 public function setTransactionListener( $name, callable
$callback = null );
1670 * Begin an atomic section of SQL statements
1672 * Start an implicit transaction if no transaction is already active, set a savepoint
1673 * (if $cancelable is ATOMIC_CANCELABLE), and track the given section name to enforce
1674 * that the transaction is not committed prematurely. The end of the section must be
1675 * signified exactly once, either by endAtomic() or cancelAtomic(). Sections can have
1676 * have layers of inner sections (sub-sections), but all sections must be ended in order
1677 * of innermost to outermost. Transactions cannot be started or committed until all
1678 * atomic sections are closed.
1680 * ATOMIC_CANCELABLE is useful when the caller needs to handle specific failure cases
1681 * by discarding the section's writes. This should not be used for failures when:
1682 * - upsert() could easily be used instead
1683 * - insert() with IGNORE could easily be used instead
1684 * - select() with FOR UPDATE could be checked before issuing writes instead
1685 * - The failure is from code that runs after the first write but doesn't need to
1686 * - The failures are from contention solvable via onTransactionPreCommitOrIdle()
1687 * - The failures are deadlocks; the RDBMs usually discard the whole transaction
1689 * @note callers must use additional measures for situations involving two or more
1690 * (peer) transactions (e.g. updating two database servers at once). The transaction
1691 * and savepoint logic of this method only applies to this specific IDatabase instance.
1695 * // Start a transaction if there isn't one already
1696 * $dbw->startAtomic( __METHOD__ );
1697 * // Serialize these thread table updates
1698 * $dbw->select( 'thread', '1', [ 'td_id' => $tid ], __METHOD__, 'FOR UPDATE' );
1699 * // Add a new comment for the thread
1700 * $dbw->insert( 'comment', $row, __METHOD__ );
1701 * $cid = $db->insertId();
1702 * // Update thread reference to last comment
1703 * $dbw->update( 'thread', [ 'td_latest' => $cid ], [ 'td_id' => $tid ], __METHOD__ );
1704 * // Demark the end of this conceptual unit of updates
1705 * $dbw->endAtomic( __METHOD__ );
1708 * Example usage (atomic changes that might have to be discarded):
1710 * // Start a transaction if there isn't one already
1711 * $sectionId = $dbw->startAtomic( __METHOD__, $dbw::ATOMIC_CANCELABLE );
1712 * // Create new record metadata row
1713 * $dbw->insert( 'records', $row, __METHOD__ );
1714 * // Figure out where to store the data based on the new row's ID
1715 * $path = $recordDirectory . '/' . $dbw->insertId();
1716 * // Write the record data to the storage system
1717 * $status = $fileBackend->create( [ 'dst' => $path, 'content' => $data ] );
1718 * if ( $status->isOK() ) {
1719 * // Try to cleanup files orphaned by transaction rollback
1720 * $dbw->onTransactionResolution(
1721 * function ( $type ) use ( $fileBackend, $path ) {
1722 * if ( $type === IDatabase::TRIGGER_ROLLBACK ) {
1723 * $fileBackend->delete( [ 'src' => $path ] );
1728 * // Demark the end of this conceptual unit of updates
1729 * $dbw->endAtomic( __METHOD__ );
1731 * // Discard these writes from the transaction (preserving prior writes)
1732 * $dbw->cancelAtomic( __METHOD__, $sectionId );
1737 * @param string $fname
1738 * @param string $cancelable Pass self::ATOMIC_CANCELABLE to use a
1739 * savepoint and enable self::cancelAtomic() for this section.
1740 * @return AtomicSectionIdentifier section ID token
1743 public function startAtomic( $fname = __METHOD__
, $cancelable = self
::ATOMIC_NOT_CANCELABLE
);
1746 * Ends an atomic section of SQL statements
1748 * Ends the next section of atomic SQL statements and commits the transaction
1752 * @see IDatabase::startAtomic
1753 * @param string $fname
1756 public function endAtomic( $fname = __METHOD__
);
1759 * Cancel an atomic section of SQL statements
1761 * This will roll back only the statements executed since the start of the
1762 * most recent atomic section, and close that section. If a transaction was
1763 * open before the corresponding startAtomic() call, any statements before
1764 * that call are *not* rolled back and the transaction remains open. If the
1765 * corresponding startAtomic() implicitly started a transaction, that
1766 * transaction is rolled back.
1768 * @note callers must use additional measures for situations involving two or more
1769 * (peer) transactions (e.g. updating two database servers at once). The transaction
1770 * and savepoint logic of startAtomic() are bound to specific IDatabase instances.
1772 * Note that a call to IDatabase::rollback() will also roll back any open atomic sections.
1774 * @note As a micro-optimization to save a few DB calls, this method may only
1775 * be called when startAtomic() was called with the ATOMIC_CANCELABLE flag.
1777 * @see IDatabase::startAtomic
1778 * @param string $fname
1779 * @param AtomicSectionIdentifier|null $sectionId Section ID from startAtomic();
1780 * passing this enables cancellation of unclosed nested sections [optional]
1783 public function cancelAtomic( $fname = __METHOD__
, AtomicSectionIdentifier
$sectionId = null );
1786 * Perform an atomic section of reversable SQL statements from a callback
1788 * The $callback takes the following arguments:
1789 * - This database object
1790 * - The value of $fname
1792 * This will execute the callback inside a pair of startAtomic()/endAtomic() calls.
1793 * If any exception occurs during execution of the callback, it will be handled as follows:
1794 * - If $cancelable is ATOMIC_CANCELABLE, cancelAtomic() will be called to back out any
1795 * (and only) statements executed during the atomic section. If that succeeds, then the
1796 * exception will be re-thrown; if it fails, then a different exception will be thrown
1797 * and any further query attempts will fail until rollback() is called.
1798 * - If $cancelable is ATOMIC_NOT_CANCELABLE, cancelAtomic() will be called to mark the
1799 * end of the section and the error will be re-thrown. Any further query attempts will
1800 * fail until rollback() is called.
1802 * This method is convenient for letting calls to the caller of this method be wrapped
1803 * in a try/catch blocks for exception types that imply that the caller failed but was
1804 * able to properly discard the changes it made in the transaction. This method can be
1805 * an alternative to explicit calls to startAtomic()/endAtomic()/cancelAtomic().
1807 * Example usage, "RecordStore::save" method:
1809 * $dbw->doAtomicSection( __METHOD__, function ( $dbw ) use ( $record ) {
1810 * // Create new record metadata row
1811 * $dbw->insert( 'records', $record->toArray(), __METHOD__ );
1812 * // Figure out where to store the data based on the new row's ID
1813 * $path = $this->recordDirectory . '/' . $dbw->insertId();
1814 * // Write the record data to the storage system;
1815 * // blob store throughs StoreFailureException on failure
1816 * $this->blobStore->create( $path, $record->getJSON() );
1817 * // Try to cleanup files orphaned by transaction rollback
1818 * $dbw->onTransactionResolution(
1819 * function ( $type ) use ( $path ) {
1820 * if ( $type === IDatabase::TRIGGER_ROLLBACK ) {
1821 * $this->blobStore->delete( $path );
1826 * }, $dbw::ATOMIC_CANCELABLE );
1829 * Example usage, caller of the "RecordStore::save" method:
1831 * $dbw->startAtomic( __METHOD__ );
1832 * // ...various SQL writes happen...
1834 * $recordStore->save( $record );
1835 * } catch ( StoreFailureException $e ) {
1836 * // ...various SQL writes happen...
1838 * // ...various SQL writes happen...
1839 * $dbw->endAtomic( __METHOD__ );
1842 * @see Database::startAtomic
1843 * @see Database::endAtomic
1844 * @see Database::cancelAtomic
1846 * @param string $fname Caller name (usually __METHOD__)
1847 * @param callable $callback Callback that issues DB updates
1848 * @param string $cancelable Pass self::ATOMIC_CANCELABLE to use a
1849 * savepoint and enable self::cancelAtomic() for this section.
1850 * @return mixed $res Result of the callback (since 1.28)
1852 * @throws RuntimeException
1853 * @since 1.27; prior to 1.31 this did a rollback() instead of
1854 * cancelAtomic(), and assumed no callers up the stack would ever try to
1855 * catch the exception.
1857 public function doAtomicSection(
1858 $fname, callable
$callback, $cancelable = self
::ATOMIC_NOT_CANCELABLE
1862 * Begin a transaction. If a transaction is already in progress,
1863 * that transaction will be committed before the new transaction is started.
1865 * Only call this from code with outer transcation scope.
1866 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1867 * Nesting of transactions is not supported.
1869 * Note that when the DBO_TRX flag is set (which is usually the case for web
1870 * requests, but not for maintenance scripts), any previous database query
1871 * will have started a transaction automatically.
1873 * Nesting of transactions is not supported. Attempts to nest transactions
1874 * will cause a warning, unless the current transaction was started
1875 * automatically because of the DBO_TRX flag.
1877 * @param string $fname Calling function name
1878 * @param string $mode A situationally valid IDatabase::TRANSACTION_* constant [optional]
1881 public function begin( $fname = __METHOD__
, $mode = self
::TRANSACTION_EXPLICIT
);
1884 * Commits a transaction previously started using begin().
1885 * If no transaction is in progress, a warning is issued.
1887 * Only call this from code with outer transcation scope.
1888 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1889 * Nesting of transactions is not supported.
1891 * @param string $fname
1892 * @param string $flush Flush flag, set to situationally valid IDatabase::FLUSHING_*
1893 * constant to disable warnings about explicitly committing implicit transactions,
1894 * or calling commit when no transaction is in progress.
1896 * This will trigger an exception if there is an ongoing explicit transaction.
1898 * Only set the flush flag if you are sure that these warnings are not applicable,
1899 * and no explicit transactions are open.
1903 public function commit( $fname = __METHOD__
, $flush = self
::FLUSHING_ONE
);
1906 * Rollback a transaction previously started using begin().
1907 * If no transaction is in progress, a warning is issued.
1909 * Only call this from code with outer transcation scope.
1910 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1911 * Nesting of transactions is not supported. If a serious unexpected error occurs,
1912 * throwing an Exception is preferrable, using a pre-installed error handler to trigger
1913 * rollback (in any case, failure to issue COMMIT will cause rollback server-side).
1915 * Query, connection, and onTransaction* callback errors will be suppressed and logged.
1917 * @param string $fname Calling function name
1918 * @param string $flush Flush flag, set to a situationally valid IDatabase::FLUSHING_*
1919 * constant to disable warnings about calling rollback when no transaction is in
1920 * progress. This will silently break any ongoing explicit transaction. Only set the
1921 * flush flag if you are sure that it is safe to ignore these warnings in your context.
1923 * @since 1.23 Added $flush parameter
1925 public function rollback( $fname = __METHOD__
, $flush = self
::FLUSHING_ONE
);
1928 * Commit any transaction but error out if writes or callbacks are pending
1930 * This is intended for clearing out REPEATABLE-READ snapshots so that callers can
1931 * see a new point-in-time of the database. This is useful when one of many transaction
1932 * rounds finished and significant time will pass in the script's lifetime. It is also
1933 * useful to call on a replica DB after waiting on replication to catch up to the master.
1935 * @param string $fname Calling function name
1936 * @param string $flush Flush flag, set to situationally valid IDatabase::FLUSHING_*
1937 * constant to disable warnings about explicitly committing implicit transactions,
1938 * or calling commit when no transaction is in progress.
1940 * This will trigger an exception if there is an ongoing explicit transaction.
1942 * Only set the flush flag if you are sure that these warnings are not applicable,
1943 * and no explicit transactions are open.
1947 * @since 1.34 Added $flush parameter
1949 public function flushSnapshot( $fname = __METHOD__
, $flush = self
::FLUSHING_ONE
);
1952 * Convert a timestamp in one of the formats accepted by wfTimestamp()
1953 * to the format used for inserting into timestamp fields in this DBMS.
1955 * The result is unquoted, and needs to be passed through addQuotes()
1956 * before it can be included in raw SQL.
1958 * @param string|int $ts
1962 public function timestamp( $ts = 0 );
1965 * Convert a timestamp in one of the formats accepted by wfTimestamp()
1966 * to the format used for inserting into timestamp fields in this DBMS. If
1967 * NULL is input, it is passed through, allowing NULL values to be inserted
1968 * into timestamp fields.
1970 * The result is unquoted, and needs to be passed through addQuotes()
1971 * before it can be included in raw SQL.
1973 * @param string|int|null $ts
1977 public function timestampOrNull( $ts = null );
1980 * Ping the server and try to reconnect if it there is no connection
1982 * @param float|null &$rtt Value to store the estimated RTT [optional]
1983 * @return bool Success or failure
1985 public function ping( &$rtt = null );
1988 * Get the amount of replication lag for this database server
1990 * Callers should avoid using this method while a transaction is active
1992 * @return int|bool Database replication lag in seconds or false on error
1995 public function getLag();
1998 * Get the replica DB lag when the current transaction started
1999 * or a general lag estimate if not transaction is active
2001 * This is useful when transactions might use snapshot isolation
2002 * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
2003 * is this lag plus transaction duration. If they don't, it is still
2004 * safe to be pessimistic. In AUTOCOMMIT mode, this still gives an
2005 * indication of the staleness of subsequent reads.
2007 * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
2011 public function getSessionLagStatus();
2014 * Return the maximum number of items allowed in a list, or 0 for unlimited.
2018 public function maxListLen();
2021 * Some DBMSs have a special format for inserting into blob fields, they
2022 * don't allow simple quoted strings to be inserted. To insert into such
2023 * a field, pass the data through this function before passing it to
2024 * IDatabase::insert().
2027 * @return string|Blob
2029 public function encodeBlob( $b );
2032 * Some DBMSs return a special placeholder object representing blob fields
2033 * in result objects. Pass the object through this function to return the
2036 * @param string|Blob $b
2039 public function decodeBlob( $b );
2042 * Override database's default behavior. $options include:
2043 * 'connTimeout' : Set the connection timeout value in seconds.
2044 * May be useful for very long batch queries such as
2045 * full-wiki dumps, where a single query reads out over
2048 * @param array $options
2052 public function setSessionOptions( array $options );
2055 * Set variables to be used in sourceFile/sourceStream, in preference to the
2056 * ones in $GLOBALS. If an array is set here, $GLOBALS will not be used at
2057 * all. If it's set to false, $GLOBALS will be used.
2059 * @param bool|array $vars Mapping variable name to value.
2061 public function setSchemaVars( $vars );
2064 * Check to see if a named lock is not locked by any thread (non-blocking)
2066 * @param string $lockName Name of lock to poll
2067 * @param string $method Name of method calling us
2072 public function lockIsFree( $lockName, $method );
2075 * Acquire a named lock
2077 * Named locks are not related to transactions
2079 * @param string $lockName Name of lock to aquire
2080 * @param string $method Name of the calling method
2081 * @param int $timeout Acquisition timeout in seconds (0 means non-blocking)
2085 public function lock( $lockName, $method, $timeout = 5 );
2090 * Named locks are not related to transactions
2092 * @param string $lockName Name of lock to release
2093 * @param string $method Name of the calling method
2095 * @return int Returns 1 if the lock was released, 0 if the lock was not established
2096 * by this thread (in which case the lock is not released), and NULL if the named lock
2101 public function unlock( $lockName, $method );
2104 * Acquire a named lock, flush any transaction, and return an RAII style unlocker object
2106 * Only call this from outer transcation scope and when only one DB will be affected.
2107 * See https://www.mediawiki.org/wiki/Database_transactions for details.
2109 * This is suitiable for transactions that need to be serialized using cooperative locks,
2110 * where each transaction can see each others' changes. Any transaction is flushed to clear
2111 * out stale REPEATABLE-READ snapshot data. Once the returned object falls out of PHP scope,
2112 * the lock will be released unless a transaction is active. If one is active, then the lock
2113 * will be released when it either commits or rolls back.
2115 * If the lock acquisition failed, then no transaction flush happens, and null is returned.
2117 * @param string $lockKey Name of lock to release
2118 * @param string $fname Name of the calling method
2119 * @param int $timeout Acquisition timeout in seconds
2120 * @return ScopedCallback|null
2124 public function getScopedLockAndFlush( $lockKey, $fname, $timeout );
2127 * Check to see if a named lock used by lock() use blocking queues
2132 public function namedLocksEnqueue();
2135 * Find out when 'infinity' is. Most DBMSes support this. This is a special
2136 * keyword for timestamps in PostgreSQL, and works with CHAR(14) as well
2137 * because "i" sorts after all numbers.
2141 public function getInfinity();
2144 * Encode an expiry time into the DBMS dependent format
2146 * @param string $expiry Timestamp for expiry, or the 'infinity' string
2149 public function encodeExpiry( $expiry );
2152 * Decode an expiry time into a DBMS independent format
2154 * @param string $expiry DB timestamp field value for expiry
2155 * @param int $format TS_* constant, defaults to TS_MW
2158 public function decodeExpiry( $expiry, $format = TS_MW
);
2161 * Allow or deny "big selects" for this session only. This is done by setting
2162 * the sql_big_selects session variable.
2164 * This is a MySQL-specific feature.
2166 * @param bool|string $value True for allow, false for deny, or "default" to
2167 * restore the initial value
2169 public function setBigSelects( $value = true );
2172 * @return bool Whether this DB is read-only
2175 public function isReadOnly();
2178 * Make certain table names use their own database, schema, and table prefix
2179 * when passed into SQL queries pre-escaped and without a qualified database name
2181 * For example, "user" can be converted to "myschema.mydbname.user" for convenience.
2182 * Appearances like `user`, somedb.user, somedb.someschema.user will used literally.
2184 * Calling this twice will completely clear any old table aliases. Also, note that
2185 * callers are responsible for making sure the schemas and databases actually exist.
2187 * @param array[] $aliases Map of (table => (dbname, schema, prefix) map)
2190 public function setTableAliases( array $aliases );
2193 * Convert certain index names to alternative names before querying the DB
2195 * Note that this applies to indexes regardless of the table they belong to.
2197 * This can be employed when an index was renamed X => Y in code, but the new Y-named
2198 * indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA,
2199 * the aliases can be removed, and then the old X-named indexes dropped.
2201 * @param string[] $aliases
2204 public function setIndexAliases( array $aliases );
2207 * Get a debugging string that mentions the database type, the ID of this instance,
2208 * and the ID of any underlying connection resource or driver object if one is present
2210 * @return string "<db type> object #<X>" or "<db type> object #<X> (resource/handle id #<Y>)"
2213 public function __toString();
2217 * @deprecated since 1.29
2219 class_alias( IDatabase
::class, 'IDatabase' );