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 Unused since 1.34 */
93 const DBO_NOBUFFER
= 2;
94 /** @var int Unused since 1.31 */
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 * Gets the current transaction level.
144 * Historically, transactions were allowed to be "nested". This is no
145 * longer supported, so this function really only returns a boolean.
147 * @return int The previous value
149 public function trxLevel();
152 * Get the UNIX timestamp of the time that the transaction was established
154 * This can be used to reason about the staleness of SELECT data in REPEATABLE-READ
155 * transaction isolation level. Callers can assume that if a view-snapshot isolation
156 * is used, then the data read by SQL queries is *at least* up to date to that point
157 * (possibly more up-to-date since the first SELECT defines the snapshot).
159 * @return float|null Returns null if there is not active transaction
162 public function trxTimestamp();
165 * @return bool Whether an explicit transaction or atomic sections are still open
168 public function explicitTrxActive();
171 * Assert that all explicit transactions or atomic sections have been closed.
172 * @throws DBTransactionError
175 public function assertNoOpenTransactions();
178 * Get/set the table prefix.
179 * @param string|null $prefix The table prefix to set, or omitted to leave it unchanged.
180 * @return string The previous table prefix
181 * @throws DBUnexpectedError
183 public function tablePrefix( $prefix = null );
186 * Get/set the db schema.
187 * @param string|null $schema The database schema to set, or omitted to leave it unchanged.
188 * @return string The previous db schema
190 public function dbSchema( $schema = null );
193 * Get properties passed down from the server info array of the load
196 * @param string|null $name The entry of the info array to get, or null to get the
199 * @return array|mixed|null
201 public function getLBInfo( $name = null );
204 * Set the entire array or a particular key of the managing load balancer info array
206 * @param array|string $nameOrArray The new array or the name of a key to set
207 * @param array|null $value If $nameOrArray is a string, the new key value (null to unset)
209 public function setLBInfo( $nameOrArray, $value = null );
212 * Set a lazy-connecting DB handle to the master DB (for replication status purposes)
214 * @param IDatabase $conn
217 public function setLazyMasterHandle( IDatabase
$conn );
220 * Returns true if this database does an implicit order by when the column has an index
221 * For example: SELECT page_title FROM page LIMIT 1
225 public function implicitOrderby();
228 * Return the last query that sent on account of IDatabase::query()
229 * @return string SQL text or empty string if there was no such query
231 public function lastQuery();
234 * Returns the last time the connection may have been used for write queries.
235 * Should return a timestamp if unsure.
237 * @return int|float UNIX timestamp or false
240 public function lastDoneWrites();
243 * @return bool Whether there is a transaction open with possible write queries
246 public function writesPending();
249 * @return bool Whether there is a transaction open with pre-commit callbacks pending
252 public function preCommitCallbacksPending();
255 * Whether there is a transaction open with either possible write queries
256 * or unresolved pre-commit/commit/resolution callbacks pending
258 * This does *not* count recurring callbacks, e.g. from setTransactionListener().
262 public function writesOrCallbacksPending();
265 * Get the time spend running write queries for this transaction
267 * High times could be due to scanning, updates, locking, and such
269 * @param string $type IDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL]
270 * @return float|bool Returns false if not transaction is active
273 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
);
276 * Get the list of method names that did write queries for this transaction
281 public function pendingWriteCallers();
284 * Get the number of affected rows from pending write queries
289 public function pendingWriteRowsAffected();
292 * Is a connection to the database open?
295 public function isOpen();
298 * Set a flag for this connection
300 * @param int $flag One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX)
301 * @param string $remember IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]
303 public function setFlag( $flag, $remember = self
::REMEMBER_NOTHING
);
306 * Clear a flag for this connection
308 * @param int $flag One of (IDatabase::DBO_DEBUG, IDatabase::DBO_TRX)
309 * @param string $remember IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]
311 public function clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
);
314 * Restore the flags to their prior state before the last setFlag/clearFlag call
316 * @param string $state IDatabase::RESTORE_* constant. [default: RESTORE_PRIOR]
319 public function restoreFlags( $state = self
::RESTORE_PRIOR
);
322 * Returns a boolean whether the flag $flag is set for this connection
324 * @param int $flag One of the class IDatabase::DBO_* constants
327 public function getFlag( $flag );
330 * Return the currently selected domain ID
332 * Null components (database/schema) might change once a connection is established
336 public function getDomainID();
339 * Get the type of the DBMS, as it appears in $wgDBtype.
343 public function getType();
346 * Fetch the next row from the given result object, in object form.
347 * Fields can be retrieved with $row->fieldname, with fields acting like
349 * If no more rows are available, false is returned.
351 * @param IResultWrapper|stdClass $res Object as returned from IDatabase::query(), etc.
352 * @return stdClass|bool
353 * @throws DBUnexpectedError Thrown if the database returns an error
355 public function fetchObject( $res );
358 * Fetch the next row from the given result object, in associative array
359 * form. Fields are retrieved with $row['fieldname'].
360 * If no more rows are available, false is returned.
362 * @param IResultWrapper $res Result object as returned from IDatabase::query(), etc.
364 * @throws DBUnexpectedError Thrown if the database returns an error
366 public function fetchRow( $res );
369 * Get the number of rows in a query result. If the query did not return
370 * any rows (for example, if it was a write query), this returns zero.
372 * @param mixed $res A SQL result
375 public function numRows( $res );
378 * Get the number of fields in a result object
379 * @see https://www.php.net/mysql_num_fields
381 * @param mixed $res A SQL result
384 public function numFields( $res );
387 * Get a field name in a result object
388 * @see https://www.php.net/mysql_field_name
390 * @param mixed $res A SQL result
394 public function fieldName( $res, $n );
397 * Get the inserted value of an auto-increment row
399 * This should only be called after an insert that used an auto-incremented
400 * value. If no such insert was previously done in the current database
401 * session, the return value is undefined.
405 public function insertId();
408 * Change the position of the cursor in a result object
409 * @see https://www.php.net/mysql_data_seek
411 * @param mixed $res A SQL result
414 public function dataSeek( $res, $row );
417 * Get the last error number
418 * @see https://www.php.net/mysql_errno
422 public function lastErrno();
425 * Get a description of the last error
426 * @see https://www.php.net/mysql_error
430 public function lastError();
433 * Get the number of rows affected by the last write query.
434 * Similar to https://www.php.net/mysql_affected_rows but includes rows matched
435 * but not changed (ie. an UPDATE which sets all fields to the same value they already have).
436 * To get the old mysql_affected_rows behavior, include non-equality of the fields in WHERE.
440 public function affectedRows();
443 * Returns a wikitext link to the DB's website, e.g.,
444 * return "[https://www.mysql.com/ MySQL]";
445 * Should at least contain plain text, if for some reason
446 * your database has no website.
448 * @return string Wikitext of a link to the server software's web site
450 public function getSoftwareLink();
453 * A string describing the current software version, like from
454 * mysql_get_server_info().
456 * @return string Version information from the database server.
458 public function getServerVersion();
461 * Close the database connection
463 * This should only be called after any transactions have been resolved,
464 * aside from read-only automatic transactions (assuming no callbacks are registered).
465 * If a transaction is still open anyway, it will be rolled back.
468 * @return bool Operation success. true if already closed.
470 public function close();
473 * Run an SQL query and return the result. Normally throws a DBQueryError
474 * on failure. If errors are ignored, returns false instead.
476 * If a connection loss is detected, then an attempt to reconnect will be made.
477 * For queries that involve no larger transactions or locks, they will be re-issued
478 * for convenience, provided the connection was re-established.
480 * In new code, the query wrappers select(), insert(), update(), delete(),
481 * etc. should be used where possible, since they give much better DBMS
482 * independence and automatically quote or validate user input in a variety
483 * of contexts. This function is generally only useful for queries which are
484 * explicitly DBMS-dependent and are unsupported by the query wrappers, such
487 * However, the query wrappers themselves should call this function.
489 * @param string $sql SQL query
490 * @param string $fname Name of the calling function, for profiling/SHOW PROCESSLIST
491 * comment (you can use __METHOD__ or add some extra info)
492 * @param int $flags Bitfield of IDatabase::QUERY_* constants. Note that suppression
493 * of errors is best handled by try/catch rather than using one of these flags.
494 * @return bool|IResultWrapper True for a successful write query, IResultWrapper object
495 * for a successful read query, or false on failure if QUERY_SILENCE_ERRORS is set.
498 public function query( $sql, $fname = __METHOD__
, $flags = 0 );
501 * Free a result object returned by query() or select(). It's usually not
502 * necessary to call this, just use unset() or let the variable holding
503 * the result object go out of scope.
505 * @param mixed $res A SQL result
507 public function freeResult( $res );
510 * A SELECT wrapper which returns a single field from a single result row.
512 * Usually throws a DBQueryError on failure. If errors are explicitly
513 * ignored, returns false on failure.
515 * If no result rows are returned from the query, false is returned.
517 * @param string|array $table Table name. See IDatabase::select() for details.
518 * @param string $var The field name to select. This must be a valid SQL
519 * fragment: do not use unvalidated user input.
520 * @param string|array $cond The condition array. See IDatabase::select() for details.
521 * @param string $fname The function name of the caller.
522 * @param string|array $options The query options. See IDatabase::select() for details.
523 * @param string|array $join_conds The query join conditions. See IDatabase::select() for details.
525 * @return mixed The value from the field
528 public function selectField(
529 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
533 * A SELECT wrapper which returns a list of single field values from result rows.
535 * Usually throws a DBQueryError on failure. If errors are explicitly
536 * ignored, returns false on failure.
538 * If no result rows are returned from the query, false is returned.
540 * @param string|array $table Table name. See IDatabase::select() for details.
541 * @param string $var The field name to select. This must be a valid SQL
542 * fragment: do not use unvalidated user input.
543 * @param string|array $cond The condition array. See IDatabase::select() for details.
544 * @param string $fname The function name of the caller.
545 * @param string|array $options The query options. See IDatabase::select() for details.
546 * @param string|array $join_conds The query join conditions. See IDatabase::select() for details.
548 * @return array The values from the field in the order they were returned from the DB
552 public function selectFieldValues(
553 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
557 * Execute a SELECT query constructed using the various parameters provided.
558 * See below for full details of the parameters.
560 * @param string|array $table Table name(s)
562 * May be either an array of table names, or a single string holding a table
563 * name. If an array is given, table aliases can be specified, for example:
567 * This includes the user table in the query, with the alias "a" available
568 * for use in field names (e.g. a.user_name).
570 * A derived table, defined by the result of selectSQLText(), requires an alias
571 * key and a Subquery instance value which wraps the SQL query, for example:
573 * [ 'c' => new Subquery( 'SELECT ...' ) ]
575 * Joins using parentheses for grouping (since MediaWiki 1.31) may be
576 * constructed using nested arrays. For example,
578 * [ 'tableA', 'nestedB' => [ 'tableB', 'b2' => 'tableB2' ] ]
580 * along with `$join_conds` like
582 * [ 'b2' => [ 'JOIN', 'b_id = b2_id' ], 'nestedB' => [ 'LEFT JOIN', 'b_a = a_id' ] ]
584 * will produce SQL something like
586 * FROM tableA LEFT JOIN (tableB JOIN tableB2 AS b2 ON (b_id = b2_id)) ON (b_a = a_id)
588 * All of the table names given here are automatically run through
589 * Database::tableName(), which causes the table prefix (if any) to be
590 * added, and various other table name mappings to be performed.
592 * Do not use untrusted user input as a table name. Alias names should
593 * not have characters outside of the Basic multilingual plane.
595 * @param string|array $vars Field name(s)
597 * May be either a field name or an array of field names. The field names
598 * can be complete fragments of SQL, for direct inclusion into the SELECT
599 * query. If an array is given, field aliases can be specified, for example:
601 * [ 'maxrev' => 'MAX(rev_id)' ]
603 * This includes an expression with the alias "maxrev" in the query.
605 * If an expression is given, care must be taken to ensure that it is
608 * Untrusted user input must not be passed to this parameter.
610 * @param string|array $conds
612 * May be either a string containing a single condition, or an array of
613 * conditions. If an array is given, the conditions constructed from each
614 * element are combined with AND.
616 * Array elements may take one of two forms:
618 * - Elements with a numeric key are interpreted as raw SQL fragments.
619 * - Elements with a string key are interpreted as equality conditions,
620 * where the key is the field name.
621 * - If the value of such an array element is a scalar (such as a
622 * string), it will be treated as data and thus quoted appropriately.
623 * If it is null, an IS NULL clause will be added.
624 * - If the value is an array, an IN (...) clause will be constructed
625 * from its non-null elements, and an IS NULL clause will be added
626 * if null is present, such that the field may match any of the
627 * elements in the array. The non-null elements will be quoted.
629 * Note that expressions are often DBMS-dependent in their syntax.
630 * DBMS-independent wrappers are provided for constructing several types of
631 * expression commonly used in condition queries. See:
632 * - IDatabase::buildLike()
633 * - IDatabase::conditional()
635 * Untrusted user input is safe in the values of string keys, however untrusted
636 * input must not be used in the array key names or in the values of numeric keys.
637 * Escaping of untrusted input used in values of numeric keys should be done via
638 * IDatabase::addQuotes()
640 * Use an empty array, string, or '*' to update all rows.
642 * @param string $fname Caller function name
644 * @param string|array $options Query options
646 * Optional: Array of query options. Boolean options are specified by
647 * including them in the array as a string value with a numeric key, for
652 * The supported options are:
654 * - OFFSET: Skip this many rows at the start of the result set. OFFSET
655 * with LIMIT can theoretically be used for paging through a result set,
656 * but this is discouraged for performance reasons.
658 * - LIMIT: Integer: return at most this many rows. The rows are sorted
659 * and then the first rows are taken until the limit is reached. LIMIT
660 * is applied to a result set after OFFSET.
662 * - LOCK IN SHARE MODE: Boolean: lock the returned rows so that they can't be
663 * changed until the next COMMIT. Cannot be used with aggregate functions
664 * (COUNT, MAX, etc., but also DISTINCT).
666 * - FOR UPDATE: Boolean: lock the returned rows so that they can't be
667 * changed nor read with LOCK IN SHARE MODE until the next COMMIT.
668 * Cannot be used with aggregate functions (COUNT, MAX, etc., but also DISTINCT).
670 * - DISTINCT: Boolean: return only unique result rows.
672 * - GROUP BY: May be either an SQL fragment string naming a field or
673 * expression to group by, or an array of such SQL fragments.
675 * - HAVING: May be either an string containing a HAVING clause or an array of
676 * conditions building the HAVING clause. If an array is given, the conditions
677 * constructed from each element are combined with AND.
679 * - ORDER BY: May be either an SQL fragment giving a field name or
680 * expression to order by, or an array of such SQL fragments.
682 * - USE INDEX: This may be either a string giving the index name to use
683 * for the query, or an array. If it is an associative array, each key
684 * gives the table name (or alias), each value gives the index name to
685 * use for that table. All strings are SQL fragments and so should be
686 * validated by the caller.
688 * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run,
691 * And also the following boolean MySQL extensions, see the MySQL manual
696 * - SQL_BUFFER_RESULT
698 * - SQL_CALC_FOUND_ROWS
700 * @param string|array $join_conds Join conditions
702 * Optional associative array of table-specific join conditions. In the
703 * most common case, this is unnecessary, since the join condition can be
704 * in $conds. However, it is useful for doing a LEFT JOIN.
706 * The key of the array contains the table name or alias. The value is an
707 * array with two elements, numbered 0 and 1. The first gives the type of
708 * join, the second is the same as the $conds parameter. Thus it can be
709 * an SQL fragment, or an array where the string keys are equality and the
710 * numeric keys are SQL fragments all AND'd together. For example:
712 * [ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]
714 * @return IResultWrapper Resulting rows
717 public function select(
718 $table, $vars, $conds = '', $fname = __METHOD__
,
719 $options = [], $join_conds = []
723 * The equivalent of IDatabase::select() except that the constructed SQL
724 * is returned, instead of being immediately executed. This can be useful for
725 * doing UNION queries, where the SQL text of each query is needed. In general,
726 * however, callers outside of Database classes should just use select().
728 * @see IDatabase::select()
730 * @param string|array $table Table name
731 * @param string|array $vars Field names
732 * @param string|array $conds Conditions
733 * @param string $fname Caller function name
734 * @param string|array $options Query options
735 * @param string|array $join_conds Join conditions
736 * @return string SQL query string
738 public function selectSQLText(
739 $table, $vars, $conds = '', $fname = __METHOD__
,
740 $options = [], $join_conds = []
744 * Single row SELECT wrapper. Equivalent to IDatabase::select(), except
745 * that a single row object is returned. If the query returns no rows,
748 * @param string|array $table Table name
749 * @param string|array $vars Field names
750 * @param string|array $conds Conditions
751 * @param string $fname Caller function name
752 * @param string|array $options Query options
753 * @param array|string $join_conds Join conditions
755 * @return stdClass|bool
758 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
759 $options = [], $join_conds = []
763 * Estimate the number of rows in dataset
765 * MySQL allows you to estimate the number of rows that would be returned
766 * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using
767 * index cardinality statistics, and is notoriously inaccurate, especially
768 * when large numbers of rows have recently been added or deleted.
770 * For DBMSs that don't support fast result size estimation, this function
771 * will actually perform the SELECT COUNT(*).
773 * Takes the same arguments as IDatabase::select().
775 * @param string $table Table name
776 * @param string $var Column for which NULL values are not counted [default "*"]
777 * @param array|string $conds Filters on the table
778 * @param string $fname Function name for profiling
779 * @param array $options Options for select
780 * @param array|string $join_conds Join conditions
781 * @return int Row count
784 public function estimateRowCount(
785 $table, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
789 * Get the number of rows in dataset
791 * This is useful when trying to do COUNT(*) but with a LIMIT for performance.
793 * Takes the same arguments as IDatabase::select().
795 * @since 1.27 Added $join_conds parameter
797 * @param array|string $tables Table names
798 * @param string $var Column for which NULL values are not counted [default "*"]
799 * @param array|string $conds Filters on the table
800 * @param string $fname Function name for profiling
801 * @param array $options Options for select
802 * @param array $join_conds Join conditions (since 1.27)
803 * @return int Row count
806 public function selectRowCount(
807 $tables, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
811 * Lock all rows meeting the given conditions/options FOR UPDATE
813 * @param array|string $table Table names
814 * @param array|string $conds Filters on the table
815 * @param string $fname Function name for profiling
816 * @param array $options Options for select ("FOR UPDATE" is added automatically)
817 * @param array $join_conds Join conditions
818 * @return int Number of matching rows found (and locked)
821 public function lockForUpdate(
822 $table, $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
826 * Determines whether a field exists in a table
828 * @param string $table Table name
829 * @param string $field Filed to check on that table
830 * @param string $fname Calling function name (optional)
831 * @return bool Whether $table has filed $field
834 public function fieldExists( $table, $field, $fname = __METHOD__
);
837 * Determines whether an index exists
838 * Usually throws a DBQueryError on failure
839 * If errors are explicitly ignored, returns NULL on failure
841 * @param string $table
842 * @param string $index
843 * @param string $fname
847 public function indexExists( $table, $index, $fname = __METHOD__
);
850 * Query whether a given table exists
852 * @param string $table
853 * @param string $fname
857 public function tableExists( $table, $fname = __METHOD__
);
860 * INSERT wrapper, inserts an array into a table.
864 * - A single associative array. The array keys are the field names, and
865 * the values are the values to insert. The values are treated as data
866 * and will be quoted appropriately. If NULL is inserted, this will be
867 * converted to a database NULL.
868 * - An array with numeric keys, holding a list of associative arrays.
869 * This causes a multi-row INSERT on DBMSs that support it. The keys in
870 * each subarray must be identical to each other, and in the same order.
872 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
875 * $options is an array of options, with boolean options encoded as values
876 * with numeric keys, in the same style as $options in
877 * IDatabase::select(). Supported options are:
879 * - IGNORE: Boolean: if present, duplicate key errors are ignored, and
880 * any rows which cause duplicate key errors are not inserted. It's
881 * possible to determine how many rows were successfully inserted using
882 * IDatabase::affectedRows().
884 * @param string $table Table name. This will be passed through
885 * Database::tableName().
886 * @param array $a Array of rows to insert
887 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
888 * @param array $options Array of options
889 * @return bool Return true if no exception was thrown (deprecated since 1.33)
892 public function insert( $table, $a, $fname = __METHOD__
, $options = [] );
895 * UPDATE wrapper. Takes a condition array and a SET array.
897 * @param string $table Name of the table to UPDATE. This will be passed through
898 * Database::tableName().
899 * @param array $values An array of values to SET. For each array element,
900 * the key gives the field name, and the value gives the data to set
901 * that field to. The data will be quoted by IDatabase::addQuotes().
902 * Values with integer keys form unquoted SET statements, which can be used for
903 * things like "field = field + 1" or similar computed values.
904 * @param array $conds An array of conditions (WHERE). See
905 * IDatabase::select() for the details of the format of condition
906 * arrays. Use '*' to update all rows.
907 * @param string $fname The function name of the caller (from __METHOD__),
908 * for logging and profiling.
909 * @param array $options An array of UPDATE options, can be:
910 * - IGNORE: Ignore unique key conflicts
911 * @return bool Return true if no exception was thrown (deprecated since 1.33)
914 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] );
917 * Makes an encoded list of strings from an array
919 * These can be used to make conjunctions or disjunctions on SQL condition strings
920 * derived from an array (see IDatabase::select() $conds documentation).
924 * $sql = $db->makeList( [
926 * $db->makeList( [ 'rev_minor' => 1, 'rev_len' < 500 ], $db::LIST_OR ] )
927 * ], $db::LIST_AND );
929 * This would set $sql to "rev_page = '$id' AND (rev_minor = '1' OR rev_len < '500')"
931 * @param array $a Containing the data
932 * @param int $mode IDatabase class constant:
933 * - IDatabase::LIST_COMMA: Comma separated, no field names
934 * - IDatabase::LIST_AND: ANDed WHERE clause (without the WHERE).
935 * - IDatabase::LIST_OR: ORed WHERE clause (without the WHERE)
936 * - IDatabase::LIST_SET: Comma separated with field names, like a SET clause
937 * - IDatabase::LIST_NAMES: Comma separated field names
941 public function makeList( $a, $mode = self
::LIST_COMMA
);
944 * Build a partial where clause from a 2-d array such as used for LinkBatch.
945 * The keys on each level may be either integers or strings.
947 * @param array $data Organized as 2-d
948 * [ baseKeyVal => [ subKeyVal => [ignored], ... ], ... ]
949 * @param string $baseKey Field name to match the base-level keys to (eg 'pl_namespace')
950 * @param string $subKey Field name to match the sub-level keys to (eg 'pl_title')
951 * @return string|bool SQL fragment, or false if no items in array
953 public function makeWhereFrom2d( $data, $baseKey, $subKey );
956 * Return aggregated value alias
958 * @param array $valuedata
959 * @param string $valuename
962 * @deprecated Since 1.33
964 public function aggregateValue( $valuedata, $valuename = 'value' );
967 * @param string $field
970 public function bitNot( $field );
973 * @param string $fieldLeft
974 * @param string $fieldRight
977 public function bitAnd( $fieldLeft, $fieldRight );
980 * @param string $fieldLeft
981 * @param string $fieldRight
984 public function bitOr( $fieldLeft, $fieldRight );
987 * Build a concatenation list to feed into a SQL query
988 * @param array $stringList List of raw SQL expressions; caller is
989 * responsible for any quoting
992 public function buildConcat( $stringList );
995 * Build a GROUP_CONCAT or equivalent statement for a query.
997 * This is useful for combining a field for several rows into a single string.
998 * NULL values will not appear in the output, duplicated values will appear,
999 * and the resulting delimiter-separated values have no defined sort order.
1000 * Code using the results may need to use the PHP unique() or sort() methods.
1002 * @param string $delim Glue to bind the results together
1003 * @param string|array $table Table name
1004 * @param string $field Field name
1005 * @param string|array $conds Conditions
1006 * @param string|array $join_conds Join conditions
1007 * @return string SQL text
1010 public function buildGroupConcatField(
1011 $delim, $table, $field, $conds = '', $join_conds = []
1015 * Build a SUBSTRING function.
1017 * Behavior for non-ASCII values is undefined.
1019 * @param string $input Field name
1020 * @param int $startPosition Positive integer
1021 * @param int|null $length Non-negative integer length or null for no limit
1022 * @throws InvalidArgumentException
1023 * @return string SQL text
1026 public function buildSubString( $input, $startPosition, $length = null );
1029 * @param string $field Field or column to cast
1033 public function buildStringCast( $field );
1036 * @param string $field Field or column to cast
1040 public function buildIntegerCast( $field );
1043 * Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery
1045 * @see IDatabase::selectSQLText()
1047 * @param string|array $table Table name
1048 * @param string|array $vars Field names
1049 * @param string|array $conds Conditions
1050 * @param string $fname Caller function name
1051 * @param string|array $options Query options
1052 * @param string|array $join_conds Join conditions
1056 public function buildSelectSubquery(
1057 $table, $vars, $conds = '', $fname = __METHOD__
,
1058 $options = [], $join_conds = []
1062 * Construct a LIMIT query with optional offset. This is used for query
1063 * pages. The SQL should be adjusted so that only the first $limit rows
1064 * are returned. If $offset is provided as well, then the first $offset
1065 * rows should be discarded, and the next $limit rows should be returned.
1066 * If the result of the query is not ordered, then the rows to be returned
1067 * are theoretically arbitrary.
1069 * $sql is expected to be a SELECT, if that makes a difference.
1071 * @param string $sql SQL query we will append the limit too
1072 * @param int $limit The SQL limit
1073 * @param int|bool $offset The SQL offset (default false)
1074 * @throws DBUnexpectedError
1078 public function limitResult( $sql, $limit, $offset = false );
1081 * Returns true if DBs are assumed to be on potentially different servers
1083 * In systems like mysql/mariadb, different databases can easily be referenced on a single
1084 * connection merely by name, even in a single query via JOIN. On the other hand, Postgres
1085 * treats databases as fully separate, only allowing mechanisms like postgres_fdw to
1086 * effectively "mount" foreign DBs. This is true even among DBs on the same server.
1091 public function databasesAreIndependent();
1094 * Change the current database
1096 * This should only be called by a load balancer or if the handle is not attached to one
1099 * @return bool True unless an exception was thrown
1100 * @throws DBConnectionError If databasesAreIndependent() is true and connection change fails
1101 * @throws DBError On query error or if database changes are disallowed
1102 * @deprecated Since 1.32 Use selectDomain() instead
1104 public function selectDB( $db );
1107 * Set the current domain (database, schema, and table prefix)
1109 * This will throw an error for some database types if the database is unspecified
1111 * This should only be called by a load balancer or if the handle is not attached to one
1113 * @param string|DatabaseDomain $domain
1114 * @throws DBConnectionError If databasesAreIndependent() is true and connection change fails
1115 * @throws DBError On query error, if domain changes are disallowed, or the domain is invalid
1118 public function selectDomain( $domain );
1121 * Get the current DB name
1122 * @return string|null
1124 public function getDBname();
1127 * Get the server hostname or IP address
1130 public function getServer();
1133 * Adds quotes and backslashes.
1135 * @param string|int|null|bool|Blob $s
1136 * @return string|int
1138 public function addQuotes( $s );
1141 * Quotes an identifier, in order to make user controlled input safe
1143 * Depending on the database this will either be `backticks` or "double quotes"
1149 public function addIdentifierQuotes( $s );
1152 * LIKE statement wrapper, receives a variable-length argument list with
1153 * parts of pattern to match containing either string literals that will be
1154 * escaped or tokens returned by anyChar() or anyString(). Alternatively,
1155 * the function could be provided with an array of aforementioned
1158 * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns
1159 * a LIKE clause that searches for subpages of 'My page title'.
1161 * $pattern = [ 'My_page_title/', $dbr->anyString() ];
1162 * $query .= $dbr->buildLike( $pattern );
1165 * @param array[]|string|LikeMatch $param
1166 * @return string Fully built LIKE statement
1167 * @phan-suppress-next-line PhanMismatchVariadicComment
1168 * @phan-param array|string|LikeMatch ...$param T226223
1170 public function buildLike( $param );
1173 * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
1177 public function anyChar();
1180 * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
1184 public function anyString();
1187 * Deprecated method, calls should be removed.
1189 * This was formerly used for PostgreSQL and Oracle to handle
1190 * self::insertId() auto-incrementing fields. It is no longer necessary
1191 * since DatabasePostgres::insertId() has been reimplemented using
1192 * `lastval()` and Oracle has been reimplemented using triggers.
1194 * Implementations should return null if inserting `NULL` into an
1195 * auto-incrementing field works, otherwise it should return an instance of
1196 * NextSequenceValue and filter it on calls to relevant methods.
1198 * @deprecated since 1.30, no longer needed
1199 * @param string $seqName
1200 * @return null|NextSequenceValue
1202 public function nextSequenceValue( $seqName );
1205 * REPLACE query wrapper.
1207 * REPLACE is a very handy MySQL extension, which functions like an INSERT
1208 * except that when there is a duplicate key error, the old row is deleted
1209 * and the new row is inserted in its place.
1211 * We simulate this with standard SQL with a DELETE followed by INSERT. To
1212 * perform the delete, we need to know what the unique indexes are so that
1213 * we know how to find the conflicting rows.
1215 * It may be more efficient to leave off unique indexes which are unlikely
1216 * to collide. However if you do this, you run the risk of encountering
1217 * errors which wouldn't have occurred in MySQL.
1219 * @param string $table The table to replace the row(s) in.
1220 * @param array[]|string[]|string $uniqueIndexes All unique indexes. One of the following:
1221 * a) the one unique field in the table (when no composite unique key exist)
1222 * b) a list of all unique fields in the table (when no composite unique key exist)
1223 * c) a list of all unique indexes in the table (each as a list of the indexed fields)
1224 * @param array $rows Can be either a single row to insert, or multiple rows,
1225 * in the same format as for IDatabase::insert()
1226 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1229 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
);
1232 * INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
1234 * This updates any conflicting rows (according to the unique indexes) using
1235 * the provided SET clause and inserts any remaining (non-conflicted) rows.
1237 * $rows may be either:
1238 * - A single associative array. The array keys are the field names, and
1239 * the values are the values to insert. The values are treated as data
1240 * and will be quoted appropriately. If NULL is inserted, this will be
1241 * converted to a database NULL.
1242 * - An array with numeric keys, holding a list of associative arrays.
1243 * This causes a multi-row INSERT on DBMSs that support it. The keys in
1244 * each subarray must be identical to each other, and in the same order.
1246 * It may be more efficient to leave off unique indexes which are unlikely
1247 * to collide. However if you do this, you run the risk of encountering
1248 * errors which wouldn't have occurred in MySQL.
1250 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
1255 * @param string $table Table name. This will be passed through Database::tableName().
1256 * @param array $rows A single row or list of rows to insert
1257 * @param array[]|string[]|string $uniqueIndexes All unique indexes. One of the following:
1258 * a) the one unique field in the table (when no composite unique key exist)
1259 * b) a list of all unique fields in the table (when no composite unique key exist)
1260 * c) a list of all unique indexes in the table (each as a list of the indexed fields)
1261 * @param array $set An array of values to SET. For each array element, the
1262 * key gives the field name, and the value gives the data to set that
1263 * field to. The data will be quoted by IDatabase::addQuotes().
1264 * Values with integer keys form unquoted SET statements, which can be used for
1265 * things like "field = field + 1" or similar computed values.
1266 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1268 * @return bool Return true if no exception was thrown (deprecated since 1.33)
1270 public function upsert(
1271 $table, array $rows, $uniqueIndexes, array $set, $fname = __METHOD__
1275 * DELETE where the condition is a join.
1277 * MySQL overrides this to use a multi-table DELETE syntax, in other databases
1278 * we use sub-selects
1280 * For safety, an empty $conds will not delete everything. If you want to
1281 * delete all rows where the join condition matches, set $conds='*'.
1283 * DO NOT put the join condition in $conds.
1285 * @param string $delTable The table to delete from.
1286 * @param string $joinTable The other table.
1287 * @param string $delVar The variable to join on, in the first table.
1288 * @param string $joinVar The variable to join on, in the second table.
1289 * @param array $conds Condition array of field names mapped to variables,
1290 * ANDed together in the WHERE clause
1291 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1294 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
1299 * DELETE query wrapper.
1301 * @param string $table Table name
1302 * @param string|array $conds Array of conditions. See $conds in IDatabase::select()
1303 * for the format. Use $conds == "*" to delete all rows
1304 * @param string $fname Name of the calling function
1305 * @throws DBUnexpectedError
1306 * @return bool Return true if no exception was thrown (deprecated since 1.33)
1309 public function delete( $table, $conds, $fname = __METHOD__
);
1312 * INSERT SELECT wrapper. Takes data from a SELECT query and inserts it
1313 * into another table.
1315 * @warning If the insert will use an auto-increment or sequence to
1316 * determine the value of a column, this may break replication on
1317 * databases using statement-based replication if the SELECT is not
1318 * deterministically ordered.
1320 * @param string $destTable The table name to insert into
1321 * @param string|array $srcTable May be either a table name, or an array of table names
1322 * to include in a join.
1324 * @param array $varMap Must be an associative array of the form
1325 * [ 'dest1' => 'source1', ... ]. Source items may be literals
1326 * rather than field names, but strings should be quoted with
1327 * IDatabase::addQuotes()
1329 * @param array $conds Condition array. See $conds in IDatabase::select() for
1330 * the details of the format of condition arrays. May be "*" to copy the
1333 * @param string $fname The function name of the caller, from __METHOD__
1335 * @param array $insertOptions Options for the INSERT part of the query, see
1336 * IDatabase::insert() for details. Also, one additional option is
1337 * available: pass 'NO_AUTO_COLUMNS' to hint that the query does not use
1338 * an auto-increment or sequence to determine any column values.
1339 * @param array $selectOptions Options for the SELECT part of the query, see
1340 * IDatabase::select() for details.
1341 * @param array $selectJoinConds Join conditions for the SELECT part of the query, see
1342 * IDatabase::select() for details.
1344 * @return bool Return true if no exception was thrown (deprecated since 1.33)
1347 public function insertSelect( $destTable, $srcTable, $varMap, $conds,
1348 $fname = __METHOD__
,
1349 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
1353 * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
1354 * within the UNION construct.
1357 public function unionSupportsOrderAndLimit();
1360 * Construct a UNION query
1361 * This is used for providing overload point for other DB abstractions
1362 * not compatible with the MySQL syntax.
1363 * @param array $sqls SQL statements to combine
1364 * @param bool $all Either IDatabase::UNION_ALL or IDatabase::UNION_DISTINCT
1365 * @return string SQL fragment
1367 public function unionQueries( $sqls, $all );
1370 * Construct a UNION query for permutations of conditions
1372 * Databases sometimes have trouble with queries that have multiple values
1373 * for multiple condition parameters combined with limits and ordering.
1374 * This method constructs queries for the Cartesian product of the
1375 * conditions and unions them all together.
1377 * @see IDatabase::select()
1379 * @param string|array $table Table name
1380 * @param string|array $vars Field names
1381 * @param array $permute_conds Conditions for the Cartesian product. Keys
1382 * are field names, values are arrays of the possible values for that
1384 * @param string|array $extra_conds Additional conditions to include in the
1386 * @param string $fname Caller function name
1387 * @param string|array $options Query options. In addition to the options
1388 * recognized by IDatabase::select(), the following may be used:
1389 * - NOTALL: Set to use UNION instead of UNION ALL.
1390 * - INNER ORDER BY: If specified and supported, subqueries will use this
1391 * instead of ORDER BY.
1392 * @param string|array $join_conds Join conditions
1393 * @return string SQL query string.
1395 public function unionConditionPermutations(
1396 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__
,
1397 $options = [], $join_conds = []
1401 * Returns an SQL expression for a simple conditional. This doesn't need
1402 * to be overridden unless CASE isn't supported in your DBMS.
1404 * @param string|array $cond SQL expression which will result in a boolean value
1405 * @param string $trueVal SQL expression to return if true
1406 * @param string $falseVal SQL expression to return if false
1407 * @return string SQL fragment
1409 public function conditional( $cond, $trueVal, $falseVal );
1412 * Returns a command for str_replace function in SQL query.
1413 * Uses REPLACE() in MySQL
1415 * @param string $orig Column to modify
1416 * @param string $old Column to seek
1417 * @param string $new Column to replace with
1421 public function strreplace( $orig, $old, $new );
1424 * Determines how long the server has been up
1429 public function getServerUptime();
1432 * Determines if the last failure was due to a deadlock
1434 * Note that during a deadlock, the prior transaction will have been lost
1438 public function wasDeadlock();
1441 * Determines if the last failure was due to a lock timeout
1443 * Note that during a lock wait timeout, the prior transaction will have been lost
1447 public function wasLockTimeout();
1450 * Determines if the last query error was due to a dropped connection
1452 * Note that during a connection loss, the prior transaction will have been lost
1457 public function wasConnectionLoss();
1460 * Determines if the last failure was due to the database being read-only.
1464 public function wasReadOnlyError();
1467 * Determines if the last query error was due to something outside of the query itself
1469 * Note that the transaction may have been lost, discarding prior writes and results
1473 public function wasErrorReissuable();
1476 * Wait for the replica DB to catch up to a given master position
1478 * Note that this does not start any new transactions. If any existing transaction
1479 * is flushed, and this is called, then queries will reflect the point the DB was synced
1480 * up to (on success) without interference from REPEATABLE-READ snapshots.
1482 * @param DBMasterPos $pos
1483 * @param int $timeout The maximum number of seconds to wait for synchronisation
1484 * @return int|null Zero if the replica DB was past that position already,
1485 * greater than zero if we waited for some period of time, less than
1486 * zero if it timed out, and null on error
1489 public function masterPosWait( DBMasterPos
$pos, $timeout );
1492 * Get the replication position of this replica DB
1494 * @return DBMasterPos|bool False if this is not a replica DB
1497 public function getReplicaPos();
1500 * Get the position of this master
1502 * @return DBMasterPos|bool False if this is not a master
1505 public function getMasterPos();
1508 * @return bool Whether the DB is marked as read-only server-side
1511 public function serverIsReadOnly();
1514 * Run a callback as soon as the current transaction commits or rolls back.
1515 * An error is thrown if no transaction is pending. Queries in the function will run in
1516 * AUTOCOMMIT mode unless there are begin() calls. Callbacks must commit any transactions
1519 * This is useful for combining cooperative locks and DB transactions.
1521 * Note this is called when the whole transaction is resolved. To take action immediately
1522 * when an atomic section is cancelled, use onAtomicSectionCancel().
1524 * @note do not assume that *other* IDatabase instances will be AUTOCOMMIT mode
1526 * The callback takes the following arguments:
1527 * - How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK)
1528 * - This IDatabase instance (since 1.32)
1530 * @param callable $callback
1531 * @param string $fname Caller name
1534 public function onTransactionResolution( callable
$callback, $fname = __METHOD__
);
1537 * Run a callback as soon as there is no transaction pending.
1538 * If there is a transaction and it is rolled back, then the callback is cancelled.
1540 * When transaction round mode (DBO_TRX) is set, the callback will run at the end
1541 * of the round, just after all peer transactions COMMIT. If the transaction round
1542 * is rolled back, then the callback is cancelled.
1544 * Queries in the function will run in AUTOCOMMIT mode unless there are begin() calls.
1545 * Callbacks must commit any transactions that they begin.
1547 * This is useful for updates to different systems or when separate transactions are needed.
1548 * For example, one might want to enqueue jobs into a system outside the database, but only
1549 * after the database is updated so that the jobs will see the data when they actually run.
1550 * It can also be used for updates that easily suffer from lock timeouts and deadlocks,
1551 * but where atomicity is not essential.
1553 * Avoid using IDatabase instances aside from this one in the callback, unless such instances
1554 * never have IDatabase::DBO_TRX set. This keeps callbacks from interfering with one another.
1556 * Updates will execute in the order they were enqueued.
1558 * @note do not assume that *other* IDatabase instances will be AUTOCOMMIT mode
1560 * The callback takes the following arguments:
1561 * - How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_IDLE)
1562 * - This IDatabase instance (since 1.32)
1564 * @param callable $callback
1565 * @param string $fname Caller name
1568 public function onTransactionCommitOrIdle( callable
$callback, $fname = __METHOD__
);
1571 * Alias for onTransactionCommitOrIdle() for backwards-compatibility
1573 * @param callable $callback
1574 * @param string $fname
1576 * @deprecated Since 1.32
1578 public function onTransactionIdle( callable
$callback, $fname = __METHOD__
);
1581 * Run a callback before the current transaction commits or now if there is none.
1582 * If there is a transaction and it is rolled back, then the callback is cancelled.
1584 * When transaction round mode (DBO_TRX) is set, the callback will run at the end
1585 * of the round, just before all peer transactions COMMIT. If the transaction round
1586 * is rolled back, then the callback is cancelled.
1588 * Callbacks must not start nor commit any transactions. If no transaction is active,
1589 * then a transaction will wrap the callback.
1591 * This is useful for updates that easily suffer from lock timeouts and deadlocks,
1592 * but where atomicity is strongly desired for these updates and some related updates.
1594 * Updates will execute in the order they were enqueued.
1596 * The callback takes the one argument:
1597 * - This IDatabase instance (since 1.32)
1599 * @param callable $callback
1600 * @param string $fname Caller name
1603 public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
);
1606 * Run a callback when the atomic section is cancelled.
1608 * The callback is run just after the current atomic section, any outer
1609 * atomic section, or the whole transaction is rolled back.
1611 * An error is thrown if no atomic section is pending. The atomic section
1612 * need not have been created with the ATOMIC_CANCELABLE flag.
1614 * Queries in the function may be running in the context of an outer
1615 * transaction or may be running in AUTOCOMMIT mode. The callback should
1616 * use atomic sections if necessary.
1618 * @note do not assume that *other* IDatabase instances will be AUTOCOMMIT mode
1620 * The callback takes the following arguments:
1621 * - IDatabase::TRIGGER_CANCEL or IDatabase::TRIGGER_ROLLBACK
1622 * - This IDatabase instance
1624 * @param callable $callback
1625 * @param string $fname Caller name
1628 public function onAtomicSectionCancel( callable
$callback, $fname = __METHOD__
);
1631 * Run a callback after each time any transaction commits or rolls back
1633 * The callback takes two arguments:
1634 * - IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK
1635 * - This IDatabase object
1636 * Callbacks must commit any transactions that they begin.
1638 * Registering a callback here will not affect writesOrCallbacks() pending.
1640 * Since callbacks from this or onTransactionCommitOrIdle() can start and end transactions,
1641 * a single call to IDatabase::commit might trigger multiple runs of the listener callbacks.
1643 * @param string $name Callback name
1644 * @param callable|null $callback Use null to unset a listener
1647 public function setTransactionListener( $name, callable
$callback = null );
1650 * Begin an atomic section of SQL statements
1652 * Start an implicit transaction if no transaction is already active, set a savepoint
1653 * (if $cancelable is ATOMIC_CANCELABLE), and track the given section name to enforce
1654 * that the transaction is not committed prematurely. The end of the section must be
1655 * signified exactly once, either by endAtomic() or cancelAtomic(). Sections can have
1656 * have layers of inner sections (sub-sections), but all sections must be ended in order
1657 * of innermost to outermost. Transactions cannot be started or committed until all
1658 * atomic sections are closed.
1660 * ATOMIC_CANCELABLE is useful when the caller needs to handle specific failure cases
1661 * by discarding the section's writes. This should not be used for failures when:
1662 * - upsert() could easily be used instead
1663 * - insert() with IGNORE could easily be used instead
1664 * - select() with FOR UPDATE could be checked before issuing writes instead
1665 * - The failure is from code that runs after the first write but doesn't need to
1666 * - The failures are from contention solvable via onTransactionPreCommitOrIdle()
1667 * - The failures are deadlocks; the RDBMs usually discard the whole transaction
1669 * @note callers must use additional measures for situations involving two or more
1670 * (peer) transactions (e.g. updating two database servers at once). The transaction
1671 * and savepoint logic of this method only applies to this specific IDatabase instance.
1675 * // Start a transaction if there isn't one already
1676 * $dbw->startAtomic( __METHOD__ );
1677 * // Serialize these thread table updates
1678 * $dbw->select( 'thread', '1', [ 'td_id' => $tid ], __METHOD__, 'FOR UPDATE' );
1679 * // Add a new comment for the thread
1680 * $dbw->insert( 'comment', $row, __METHOD__ );
1681 * $cid = $db->insertId();
1682 * // Update thread reference to last comment
1683 * $dbw->update( 'thread', [ 'td_latest' => $cid ], [ 'td_id' => $tid ], __METHOD__ );
1684 * // Demark the end of this conceptual unit of updates
1685 * $dbw->endAtomic( __METHOD__ );
1688 * Example usage (atomic changes that might have to be discarded):
1690 * // Start a transaction if there isn't one already
1691 * $sectionId = $dbw->startAtomic( __METHOD__, $dbw::ATOMIC_CANCELABLE );
1692 * // Create new record metadata row
1693 * $dbw->insert( 'records', $row, __METHOD__ );
1694 * // Figure out where to store the data based on the new row's ID
1695 * $path = $recordDirectory . '/' . $dbw->insertId();
1696 * // Write the record data to the storage system
1697 * $status = $fileBackend->create( [ 'dst' => $path, 'content' => $data ] );
1698 * if ( $status->isOK() ) {
1699 * // Try to cleanup files orphaned by transaction rollback
1700 * $dbw->onTransactionResolution(
1701 * function ( $type ) use ( $fileBackend, $path ) {
1702 * if ( $type === IDatabase::TRIGGER_ROLLBACK ) {
1703 * $fileBackend->delete( [ 'src' => $path ] );
1708 * // Demark the end of this conceptual unit of updates
1709 * $dbw->endAtomic( __METHOD__ );
1711 * // Discard these writes from the transaction (preserving prior writes)
1712 * $dbw->cancelAtomic( __METHOD__, $sectionId );
1717 * @param string $fname
1718 * @param string $cancelable Pass self::ATOMIC_CANCELABLE to use a
1719 * savepoint and enable self::cancelAtomic() for this section.
1720 * @return AtomicSectionIdentifier section ID token
1723 public function startAtomic( $fname = __METHOD__
, $cancelable = self
::ATOMIC_NOT_CANCELABLE
);
1726 * Ends an atomic section of SQL statements
1728 * Ends the next section of atomic SQL statements and commits the transaction
1732 * @see IDatabase::startAtomic
1733 * @param string $fname
1736 public function endAtomic( $fname = __METHOD__
);
1739 * Cancel an atomic section of SQL statements
1741 * This will roll back only the statements executed since the start of the
1742 * most recent atomic section, and close that section. If a transaction was
1743 * open before the corresponding startAtomic() call, any statements before
1744 * that call are *not* rolled back and the transaction remains open. If the
1745 * corresponding startAtomic() implicitly started a transaction, that
1746 * transaction is rolled back.
1748 * @note callers must use additional measures for situations involving two or more
1749 * (peer) transactions (e.g. updating two database servers at once). The transaction
1750 * and savepoint logic of startAtomic() are bound to specific IDatabase instances.
1752 * Note that a call to IDatabase::rollback() will also roll back any open atomic sections.
1754 * @note As a micro-optimization to save a few DB calls, this method may only
1755 * be called when startAtomic() was called with the ATOMIC_CANCELABLE flag.
1757 * @see IDatabase::startAtomic
1758 * @param string $fname
1759 * @param AtomicSectionIdentifier|null $sectionId Section ID from startAtomic();
1760 * passing this enables cancellation of unclosed nested sections [optional]
1763 public function cancelAtomic( $fname = __METHOD__
, AtomicSectionIdentifier
$sectionId = null );
1766 * Perform an atomic section of reversable SQL statements from a callback
1768 * The $callback takes the following arguments:
1769 * - This database object
1770 * - The value of $fname
1772 * This will execute the callback inside a pair of startAtomic()/endAtomic() calls.
1773 * If any exception occurs during execution of the callback, it will be handled as follows:
1774 * - If $cancelable is ATOMIC_CANCELABLE, cancelAtomic() will be called to back out any
1775 * (and only) statements executed during the atomic section. If that succeeds, then the
1776 * exception will be re-thrown; if it fails, then a different exception will be thrown
1777 * and any further query attempts will fail until rollback() is called.
1778 * - If $cancelable is ATOMIC_NOT_CANCELABLE, cancelAtomic() will be called to mark the
1779 * end of the section and the error will be re-thrown. Any further query attempts will
1780 * fail until rollback() is called.
1782 * This method is convenient for letting calls to the caller of this method be wrapped
1783 * in a try/catch blocks for exception types that imply that the caller failed but was
1784 * able to properly discard the changes it made in the transaction. This method can be
1785 * an alternative to explicit calls to startAtomic()/endAtomic()/cancelAtomic().
1787 * Example usage, "RecordStore::save" method:
1789 * $dbw->doAtomicSection( __METHOD__, function ( $dbw ) use ( $record ) {
1790 * // Create new record metadata row
1791 * $dbw->insert( 'records', $record->toArray(), __METHOD__ );
1792 * // Figure out where to store the data based on the new row's ID
1793 * $path = $this->recordDirectory . '/' . $dbw->insertId();
1794 * // Write the record data to the storage system;
1795 * // blob store throughs StoreFailureException on failure
1796 * $this->blobStore->create( $path, $record->getJSON() );
1797 * // Try to cleanup files orphaned by transaction rollback
1798 * $dbw->onTransactionResolution(
1799 * function ( $type ) use ( $path ) {
1800 * if ( $type === IDatabase::TRIGGER_ROLLBACK ) {
1801 * $this->blobStore->delete( $path );
1806 * }, $dbw::ATOMIC_CANCELABLE );
1809 * Example usage, caller of the "RecordStore::save" method:
1811 * $dbw->startAtomic( __METHOD__ );
1812 * // ...various SQL writes happen...
1814 * $recordStore->save( $record );
1815 * } catch ( StoreFailureException $e ) {
1816 * // ...various SQL writes happen...
1818 * // ...various SQL writes happen...
1819 * $dbw->endAtomic( __METHOD__ );
1822 * @see Database::startAtomic
1823 * @see Database::endAtomic
1824 * @see Database::cancelAtomic
1826 * @param string $fname Caller name (usually __METHOD__)
1827 * @param callable $callback Callback that issues DB updates
1828 * @param string $cancelable Pass self::ATOMIC_CANCELABLE to use a
1829 * savepoint and enable self::cancelAtomic() for this section.
1830 * @return mixed $res Result of the callback (since 1.28)
1832 * @throws RuntimeException
1833 * @since 1.27; prior to 1.31 this did a rollback() instead of
1834 * cancelAtomic(), and assumed no callers up the stack would ever try to
1835 * catch the exception.
1837 public function doAtomicSection(
1838 $fname, callable
$callback, $cancelable = self
::ATOMIC_NOT_CANCELABLE
1842 * Begin a transaction. If a transaction is already in progress,
1843 * that transaction will be committed before the new transaction is started.
1845 * Only call this from code with outer transcation scope.
1846 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1847 * Nesting of transactions is not supported.
1849 * Note that when the DBO_TRX flag is set (which is usually the case for web
1850 * requests, but not for maintenance scripts), any previous database query
1851 * will have started a transaction automatically.
1853 * Nesting of transactions is not supported. Attempts to nest transactions
1854 * will cause a warning, unless the current transaction was started
1855 * automatically because of the DBO_TRX flag.
1857 * @param string $fname Calling function name
1858 * @param string $mode A situationally valid IDatabase::TRANSACTION_* constant [optional]
1861 public function begin( $fname = __METHOD__
, $mode = self
::TRANSACTION_EXPLICIT
);
1864 * Commits a transaction previously started using begin().
1865 * If no transaction is in progress, a warning is issued.
1867 * Only call this from code with outer transcation scope.
1868 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1869 * Nesting of transactions is not supported.
1871 * @param string $fname
1872 * @param string $flush Flush flag, set to situationally valid IDatabase::FLUSHING_*
1873 * constant to disable warnings about explicitly committing implicit transactions,
1874 * or calling commit when no transaction is in progress.
1876 * This will trigger an exception if there is an ongoing explicit transaction.
1878 * Only set the flush flag if you are sure that these warnings are not applicable,
1879 * and no explicit transactions are open.
1883 public function commit( $fname = __METHOD__
, $flush = self
::FLUSHING_ONE
);
1886 * Rollback a transaction previously started using begin().
1887 * If no transaction is in progress, a warning is issued.
1889 * Only call this from code with outer transcation scope.
1890 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1891 * Nesting of transactions is not supported. If a serious unexpected error occurs,
1892 * throwing an Exception is preferrable, using a pre-installed error handler to trigger
1893 * rollback (in any case, failure to issue COMMIT will cause rollback server-side).
1895 * Query, connection, and onTransaction* callback errors will be suppressed and logged.
1897 * @param string $fname Calling function name
1898 * @param string $flush Flush flag, set to a situationally valid IDatabase::FLUSHING_*
1899 * constant to disable warnings about calling rollback when no transaction is in
1900 * progress. This will silently break any ongoing explicit transaction. Only set the
1901 * flush flag if you are sure that it is safe to ignore these warnings in your context.
1903 * @since 1.23 Added $flush parameter
1905 public function rollback( $fname = __METHOD__
, $flush = self
::FLUSHING_ONE
);
1908 * Commit any transaction but error out if writes or callbacks are pending
1910 * This is intended for clearing out REPEATABLE-READ snapshots so that callers can
1911 * see a new point-in-time of the database. This is useful when one of many transaction
1912 * rounds finished and significant time will pass in the script's lifetime. It is also
1913 * useful to call on a replica DB after waiting on replication to catch up to the master.
1915 * @param string $fname Calling function name
1916 * @param string $flush Flush flag, set to situationally valid IDatabase::FLUSHING_*
1917 * constant to disable warnings about explicitly committing implicit transactions,
1918 * or calling commit when no transaction is in progress.
1920 * This will trigger an exception if there is an ongoing explicit transaction.
1922 * Only set the flush flag if you are sure that these warnings are not applicable,
1923 * and no explicit transactions are open.
1927 * @since 1.34 Added $flush parameter
1929 public function flushSnapshot( $fname = __METHOD__
, $flush = self
::FLUSHING_ONE
);
1932 * Convert a timestamp in one of the formats accepted by wfTimestamp()
1933 * to the format used for inserting into timestamp fields in this DBMS.
1935 * The result is unquoted, and needs to be passed through addQuotes()
1936 * before it can be included in raw SQL.
1938 * @param string|int $ts
1942 public function timestamp( $ts = 0 );
1945 * Convert a timestamp in one of the formats accepted by wfTimestamp()
1946 * to the format used for inserting into timestamp fields in this DBMS. If
1947 * NULL is input, it is passed through, allowing NULL values to be inserted
1948 * into timestamp fields.
1950 * The result is unquoted, and needs to be passed through addQuotes()
1951 * before it can be included in raw SQL.
1953 * @param string|int|null $ts
1957 public function timestampOrNull( $ts = null );
1960 * Ping the server and try to reconnect if it there is no connection
1962 * @param float|null &$rtt Value to store the estimated RTT [optional]
1963 * @return bool Success or failure
1965 public function ping( &$rtt = null );
1968 * Get the amount of replication lag for this database server
1970 * Callers should avoid using this method while a transaction is active
1972 * @return int|bool Database replication lag in seconds or false on error
1975 public function getLag();
1978 * Get the replica DB lag when the current transaction started
1979 * or a general lag estimate if not transaction is active
1981 * This is useful when transactions might use snapshot isolation
1982 * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
1983 * is this lag plus transaction duration. If they don't, it is still
1984 * safe to be pessimistic. In AUTOCOMMIT mode, this still gives an
1985 * indication of the staleness of subsequent reads.
1987 * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
1991 public function getSessionLagStatus();
1994 * Return the maximum number of items allowed in a list, or 0 for unlimited.
1998 public function maxListLen();
2001 * Some DBMSs have a special format for inserting into blob fields, they
2002 * don't allow simple quoted strings to be inserted. To insert into such
2003 * a field, pass the data through this function before passing it to
2004 * IDatabase::insert().
2007 * @return string|Blob
2009 public function encodeBlob( $b );
2012 * Some DBMSs return a special placeholder object representing blob fields
2013 * in result objects. Pass the object through this function to return the
2016 * @param string|Blob $b
2019 public function decodeBlob( $b );
2022 * Override database's default behavior. $options include:
2023 * 'connTimeout' : Set the connection timeout value in seconds.
2024 * May be useful for very long batch queries such as
2025 * full-wiki dumps, where a single query reads out over
2028 * @param array $options
2032 public function setSessionOptions( array $options );
2035 * Set variables to be used in sourceFile/sourceStream, in preference to the
2036 * ones in $GLOBALS. If an array is set here, $GLOBALS will not be used at
2037 * all. If it's set to false, $GLOBALS will be used.
2039 * @param bool|array $vars Mapping variable name to value.
2041 public function setSchemaVars( $vars );
2044 * Check to see if a named lock is not locked by any thread (non-blocking)
2046 * @param string $lockName Name of lock to poll
2047 * @param string $method Name of method calling us
2052 public function lockIsFree( $lockName, $method );
2055 * Acquire a named lock
2057 * Named locks are not related to transactions
2059 * @param string $lockName Name of lock to aquire
2060 * @param string $method Name of the calling method
2061 * @param int $timeout Acquisition timeout in seconds (0 means non-blocking)
2065 public function lock( $lockName, $method, $timeout = 5 );
2070 * Named locks are not related to transactions
2072 * @param string $lockName Name of lock to release
2073 * @param string $method Name of the calling method
2075 * @return int Returns 1 if the lock was released, 0 if the lock was not established
2076 * by this thread (in which case the lock is not released), and NULL if the named lock
2081 public function unlock( $lockName, $method );
2084 * Acquire a named lock, flush any transaction, and return an RAII style unlocker object
2086 * Only call this from outer transcation scope and when only one DB will be affected.
2087 * See https://www.mediawiki.org/wiki/Database_transactions for details.
2089 * This is suitiable for transactions that need to be serialized using cooperative locks,
2090 * where each transaction can see each others' changes. Any transaction is flushed to clear
2091 * out stale REPEATABLE-READ snapshot data. Once the returned object falls out of PHP scope,
2092 * the lock will be released unless a transaction is active. If one is active, then the lock
2093 * will be released when it either commits or rolls back.
2095 * If the lock acquisition failed, then no transaction flush happens, and null is returned.
2097 * @param string $lockKey Name of lock to release
2098 * @param string $fname Name of the calling method
2099 * @param int $timeout Acquisition timeout in seconds
2100 * @return ScopedCallback|null
2104 public function getScopedLockAndFlush( $lockKey, $fname, $timeout );
2107 * Check to see if a named lock used by lock() use blocking queues
2112 public function namedLocksEnqueue();
2115 * Find out when 'infinity' is. Most DBMSes support this. This is a special
2116 * keyword for timestamps in PostgreSQL, and works with CHAR(14) as well
2117 * because "i" sorts after all numbers.
2121 public function getInfinity();
2124 * Encode an expiry time into the DBMS dependent format
2126 * @param string $expiry Timestamp for expiry, or the 'infinity' string
2129 public function encodeExpiry( $expiry );
2132 * Decode an expiry time into a DBMS independent format
2134 * @param string $expiry DB timestamp field value for expiry
2135 * @param int $format TS_* constant, defaults to TS_MW
2138 public function decodeExpiry( $expiry, $format = TS_MW
);
2141 * Allow or deny "big selects" for this session only. This is done by setting
2142 * the sql_big_selects session variable.
2144 * This is a MySQL-specific feature.
2146 * @param bool|string $value True for allow, false for deny, or "default" to
2147 * restore the initial value
2149 public function setBigSelects( $value = true );
2152 * @return bool Whether this DB is read-only
2155 public function isReadOnly();
2158 * Make certain table names use their own database, schema, and table prefix
2159 * when passed into SQL queries pre-escaped and without a qualified database name
2161 * For example, "user" can be converted to "myschema.mydbname.user" for convenience.
2162 * Appearances like `user`, somedb.user, somedb.someschema.user will used literally.
2164 * Calling this twice will completely clear any old table aliases. Also, note that
2165 * callers are responsible for making sure the schemas and databases actually exist.
2167 * @param array[] $aliases Map of (table => (dbname, schema, prefix) map)
2170 public function setTableAliases( array $aliases );
2173 * Convert certain index names to alternative names before querying the DB
2175 * Note that this applies to indexes regardless of the table they belong to.
2177 * This can be employed when an index was renamed X => Y in code, but the new Y-named
2178 * indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA,
2179 * the aliases can be removed, and then the old X-named indexes dropped.
2181 * @param string[] $aliases
2184 public function setIndexAliases( array $aliases );
2187 * Get a debugging string that mentions the database type, the ID of this instance,
2188 * and the ID of any underlying connection resource or driver object if one is present
2190 * @return string "<db type> object #<X>" or "<db type> object #<X> (resource/handle id #<Y>)"
2193 public function __toString();
2197 * @deprecated since 1.29
2199 class_alias( IDatabase
::class, 'IDatabase' );