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;
46 /** @var string Transaction is requested by regular caller outside of the DB layer */
47 const TRANSACTION_EXPLICIT
= '';
48 /** @var string Transaction is requested internally via DBO_TRX/startAtomic() */
49 const TRANSACTION_INTERNAL
= 'implicit';
51 /** @var string Atomic section is not cancelable */
52 const ATOMIC_NOT_CANCELABLE
= '';
53 /** @var string Atomic section is cancelable */
54 const ATOMIC_CANCELABLE
= 'cancelable';
56 /** @var string Commit/rollback is from outside the IDatabase handle and connection manager */
57 const FLUSHING_ONE
= '';
58 /** @var string Commit/rollback is from the connection manager for the IDatabase handle */
59 const FLUSHING_ALL_PEERS
= 'flush';
60 /** @var string Commit/rollback is from the IDatabase handle internally */
61 const FLUSHING_INTERNAL
= 'flush-internal';
63 /** @var string Do not remember the prior flags */
64 const REMEMBER_NOTHING
= '';
65 /** @var string Remember the prior flags */
66 const REMEMBER_PRIOR
= 'remember';
67 /** @var string Restore to the prior flag state */
68 const RESTORE_PRIOR
= 'prior';
69 /** @var string Restore to the initial flag state */
70 const RESTORE_INITIAL
= 'initial';
72 /** @var string Estimate total time (RTT, scanning, waiting on locks, applying) */
73 const ESTIMATE_TOTAL
= 'total';
74 /** @var string Estimate time to apply (scanning, applying) */
75 const ESTIMATE_DB_APPLY
= 'apply';
77 /** @var int Combine list with comma delimeters */
79 /** @var int Combine list with AND clauses */
81 /** @var int Convert map into a SET clause */
83 /** @var int Treat as field name and do not apply value escaping */
85 /** @var int Combine list with OR clauses */
88 /** @var int Enable debug logging */
90 /** @var int Disable query buffering (only one result set can be iterated at a time) */
91 const DBO_NOBUFFER
= 2;
92 /** @var int Ignore query errors (internal use only!) */
94 /** @var int Automatically start a transaction before running a query if none is active */
96 /** @var int Use DBO_TRX in non-CLI mode */
97 const DBO_DEFAULT
= 16;
98 /** @var int Use DB persistent connections if possible */
99 const DBO_PERSISTENT
= 32;
100 /** @var int DBA session mode; mostly for Oracle */
101 const DBO_SYSDBA
= 64;
102 /** @var int Schema file mode; mostly for Oracle */
103 const DBO_DDLMODE
= 128;
104 /** @var int Enable SSL/TLS in connection protocol */
106 /** @var int Enable compression in connection protocol */
107 const DBO_COMPRESS
= 512;
110 * A string describing the current software version, and possibly
111 * other details in a user-friendly way. Will be listed on Special:Version, etc.
112 * Use getServerVersion() to get machine-friendly information.
114 * @return string Version information from the database server
116 public function getServerInfo();
119 * Turns buffering of SQL result sets on (true) or off (false). Default is "on".
121 * Unbuffered queries are very troublesome in MySQL:
123 * - If another query is executed while the first query is being read
124 * out, the first query is killed. This means you can't call normal
125 * Database functions while you are reading an unbuffered query result
126 * from a normal Database connection.
128 * - Unbuffered queries cause the MySQL server to use large amounts of
129 * memory and to hold broad locks which block other queries.
131 * If you want to limit client-side memory, it's almost always better to
132 * split up queries into batches using a LIMIT clause than to switch off
135 * @param null|bool $buffer
136 * @return null|bool The previous value of the flag
138 public function bufferResults( $buffer = null );
141 * Gets the current transaction level.
143 * Historically, transactions were allowed to be "nested". This is no
144 * longer supported, so this function really only returns a boolean.
146 * @return int The previous value
148 public function trxLevel();
151 * Get the UNIX timestamp of the time that the transaction was established
153 * This can be used to reason about the staleness of SELECT data
154 * in REPEATABLE-READ transaction isolation level.
156 * @return float|null Returns null if there is not active transaction
159 public function trxTimestamp();
162 * @return bool Whether an explicit transaction or atomic sections are still open
165 public function explicitTrxActive();
168 * Get/set the table prefix.
169 * @param string|null $prefix The table prefix to set, or omitted to leave it unchanged.
170 * @return string The previous table prefix.
172 public function tablePrefix( $prefix = null );
175 * Get/set the db schema.
176 * @param string|null $schema The database schema to set, or omitted to leave it unchanged.
177 * @return string The previous db schema.
179 public function dbSchema( $schema = null );
182 * Get properties passed down from the server info array of the load
185 * @param string|null $name The entry of the info array to get, or null to get the
188 * @return array|mixed|null
190 public function getLBInfo( $name = null );
193 * Set the LB info array, or a member of it. If called with one parameter,
194 * the LB info array is set to that parameter. If it is called with two
195 * parameters, the member with the given name is set to the given value.
197 * @param string $name
198 * @param array|null $value
200 public function setLBInfo( $name, $value = null );
203 * Set a lazy-connecting DB handle to the master DB (for replication status purposes)
205 * @param IDatabase $conn
208 public function setLazyMasterHandle( IDatabase
$conn );
211 * Returns true if this database does an implicit sort when doing GROUP BY
214 * @deprecated Since 1.30; only use grouped or aggregated fields in the SELECT
216 public function implicitGroupby();
219 * Returns true if this database does an implicit order by when the column has an index
220 * For example: SELECT page_title FROM page LIMIT 1
224 public function implicitOrderby();
227 * Return the last query that went through IDatabase::query()
230 public function lastQuery();
233 * Returns true if the connection may have been used for write queries.
234 * Should return true if unsure.
237 * @deprecated Since 1.31; use lastDoneWrites()
239 public function doneWrites();
242 * Returns the last time the connection may have been used for write queries.
243 * Should return a timestamp if unsure.
245 * @return int|float UNIX timestamp or false
248 public function lastDoneWrites();
251 * @return bool Whether there is a transaction open with possible write queries
254 public function writesPending();
257 * @return bool Whether there is a transaction open with pre-commit callbacks pending
260 public function preCommitCallbacksPending();
263 * Whether there is a transaction open with either possible write queries
264 * or unresolved pre-commit/commit/resolution callbacks pending
266 * This does *not* count recurring callbacks, e.g. from setTransactionListener().
270 public function writesOrCallbacksPending();
273 * Get the time spend running write queries for this transaction
275 * High times could be due to scanning, updates, locking, and such
277 * @param string $type IDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL]
278 * @return float|bool Returns false if not transaction is active
281 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
);
284 * Get the list of method names that did write queries for this transaction
289 public function pendingWriteCallers();
292 * Get the number of affected rows from pending write queries
297 public function pendingWriteRowsAffected();
300 * Is a connection to the database open?
303 public function isOpen();
306 * Set a flag for this connection
308 * @param int $flag DBO_* constants from Defines.php:
309 * - DBO_DEBUG: output some debug info (same as debug())
310 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
311 * - DBO_TRX: automatically start transactions
312 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
313 * and removes it in command line mode
314 * - DBO_PERSISTENT: use persistant database connection
315 * @param string $remember IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]
317 public function setFlag( $flag, $remember = self
::REMEMBER_NOTHING
);
320 * Clear a flag for this connection
322 * @param int $flag DBO_* constants from Defines.php:
323 * - DBO_DEBUG: output some debug info (same as debug())
324 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
325 * - DBO_TRX: automatically start transactions
326 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
327 * and removes it in command line mode
328 * - DBO_PERSISTENT: use persistant database connection
329 * @param string $remember IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]
331 public function clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
);
334 * Restore the flags to their prior state before the last setFlag/clearFlag call
336 * @param string $state IDatabase::RESTORE_* constant. [default: RESTORE_PRIOR]
339 public function restoreFlags( $state = self
::RESTORE_PRIOR
);
342 * Returns a boolean whether the flag $flag is set for this connection
344 * @param int $flag DBO_* constants from Defines.php:
345 * - DBO_DEBUG: output some debug info (same as debug())
346 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
347 * - DBO_TRX: automatically start transactions
348 * - DBO_PERSISTENT: use persistant database connection
351 public function getFlag( $flag );
356 public function getDomainID();
359 * Alias for getDomainID()
364 public function getWikiID();
367 * Get the type of the DBMS, as it appears in $wgDBtype.
371 public function getType();
374 * Open a new connection to the database (closing any existing one)
376 * @param string $server Database server host
377 * @param string $user Database user name
378 * @param string $password Database user password
379 * @param string $dbName Database name
381 * @throws DBConnectionError
383 public function open( $server, $user, $password, $dbName );
386 * Fetch the next row from the given result object, in object form.
387 * Fields can be retrieved with $row->fieldname, with fields acting like
389 * If no more rows are available, false is returned.
391 * @param IResultWrapper|stdClass $res Object as returned from IDatabase::query(), etc.
392 * @return stdClass|bool
393 * @throws DBUnexpectedError Thrown if the database returns an error
395 public function fetchObject( $res );
398 * Fetch the next row from the given result object, in associative array
399 * form. Fields are retrieved with $row['fieldname'].
400 * If no more rows are available, false is returned.
402 * @param IResultWrapper $res Result object as returned from IDatabase::query(), etc.
404 * @throws DBUnexpectedError Thrown if the database returns an error
406 public function fetchRow( $res );
409 * Get the number of rows in a result object
411 * @param mixed $res A SQL result
414 public function numRows( $res );
417 * Get the number of fields in a result object
418 * @see https://secure.php.net/mysql_num_fields
420 * @param mixed $res A SQL result
423 public function numFields( $res );
426 * Get a field name in a result object
427 * @see https://secure.php.net/mysql_field_name
429 * @param mixed $res A SQL result
433 public function fieldName( $res, $n );
436 * Get the inserted value of an auto-increment row
438 * This should only be called after an insert that used an auto-incremented
439 * value. If no such insert was previously done in the current database
440 * session, the return value is undefined.
444 public function insertId();
447 * Change the position of the cursor in a result object
448 * @see https://secure.php.net/mysql_data_seek
450 * @param mixed $res A SQL result
453 public function dataSeek( $res, $row );
456 * Get the last error number
457 * @see https://secure.php.net/mysql_errno
461 public function lastErrno();
464 * Get a description of the last error
465 * @see https://secure.php.net/mysql_error
469 public function lastError();
472 * Get the number of rows affected by the last write query
473 * @see https://secure.php.net/mysql_affected_rows
477 public function affectedRows();
480 * Returns a wikitext link to the DB's website, e.g.,
481 * return "[https://www.mysql.com/ MySQL]";
482 * Should at least contain plain text, if for some reason
483 * your database has no website.
485 * @return string Wikitext of a link to the server software's web site
487 public function getSoftwareLink();
490 * A string describing the current software version, like from
491 * mysql_get_server_info().
493 * @return string Version information from the database server.
495 public function getServerVersion();
498 * Close the database connection
500 * This should only be called after any transactions have been resolved,
501 * aside from read-only transactions (assuming no callbacks are registered).
502 * If a transaction is still open anyway, it will be committed if possible.
505 * @return bool Operation success. true if already closed.
507 public function close();
510 * Run an SQL query and return the result. Normally throws a DBQueryError
511 * on failure. If errors are ignored, returns false instead.
513 * If a connection loss is detected, then an attempt to reconnect will be made.
514 * For queries that involve no larger transactions or locks, they will be re-issued
515 * for convenience, provided the connection was re-established.
517 * In new code, the query wrappers select(), insert(), update(), delete(),
518 * etc. should be used where possible, since they give much better DBMS
519 * independence and automatically quote or validate user input in a variety
520 * of contexts. This function is generally only useful for queries which are
521 * explicitly DBMS-dependent and are unsupported by the query wrappers, such
524 * However, the query wrappers themselves should call this function.
526 * @param string $sql SQL query
527 * @param string $fname Name of the calling function, for profiling/SHOW PROCESSLIST
528 * comment (you can use __METHOD__ or add some extra info)
529 * @param bool $tempIgnore Whether to avoid throwing an exception on errors...
530 * maybe best to catch the exception instead?
531 * @return bool|IResultWrapper True for a successful write query, IResultWrapper object
532 * for a successful read query, or false on failure if $tempIgnore set
535 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false );
538 * Free a result object returned by query() or select(). It's usually not
539 * necessary to call this, just use unset() or let the variable holding
540 * the result object go out of scope.
542 * @param mixed $res A SQL result
544 public function freeResult( $res );
547 * A SELECT wrapper which returns a single field from a single result row.
549 * Usually throws a DBQueryError on failure. If errors are explicitly
550 * ignored, returns false on failure.
552 * If no result rows are returned from the query, false is returned.
554 * @param string|array $table Table name. See IDatabase::select() for details.
555 * @param string $var The field name to select. This must be a valid SQL
556 * fragment: do not use unvalidated user input.
557 * @param string|array $cond The condition array. See IDatabase::select() for details.
558 * @param string $fname The function name of the caller.
559 * @param string|array $options The query options. See IDatabase::select() for details.
560 * @param string|array $join_conds The query join conditions. See IDatabase::select() for details.
562 * @return mixed The value from the field
565 public function selectField(
566 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
570 * A SELECT wrapper which returns a list of single field values from result rows.
572 * Usually throws a DBQueryError on failure. If errors are explicitly
573 * ignored, returns false on failure.
575 * If no result rows are returned from the query, false is returned.
577 * @param string|array $table Table name. See IDatabase::select() for details.
578 * @param string $var The field name to select. This must be a valid SQL
579 * fragment: do not use unvalidated user input.
580 * @param string|array $cond The condition array. See IDatabase::select() for details.
581 * @param string $fname The function name of the caller.
582 * @param string|array $options The query options. See IDatabase::select() for details.
583 * @param string|array $join_conds The query join conditions. See IDatabase::select() for details.
585 * @return array The values from the field
589 public function selectFieldValues(
590 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
594 * Execute a SELECT query constructed using the various parameters provided.
595 * See below for full details of the parameters.
597 * @param string|array $table Table name
598 * @param string|array $vars Field names
599 * @param string|array $conds Conditions
600 * @param string $fname Caller function name
601 * @param array $options Query options
602 * @param array $join_conds Join conditions
605 * @param string|array $table
607 * May be either an array of table names, or a single string holding a table
608 * name. If an array is given, table aliases can be specified, for example:
612 * This includes the user table in the query, with the alias "a" available
613 * for use in field names (e.g. a.user_name).
615 * A derived table, defined by the result of selectSQLText(), requires an alias
616 * key and a Subquery instance value which wraps the SQL query, for example:
618 * [ 'c' => new Subquery( 'SELECT ...' ) ]
620 * Joins using parentheses for grouping (since MediaWiki 1.31) may be
621 * constructed using nested arrays. For example,
623 * [ 'tableA', 'nestedB' => [ 'tableB', 'b2' => 'tableB2' ] ]
625 * along with `$join_conds` like
627 * [ 'b2' => [ 'JOIN', 'b_id = b2_id' ], 'nestedB' => [ 'LEFT JOIN', 'b_a = a_id' ] ]
629 * will produce SQL something like
631 * FROM tableA LEFT JOIN (tableB JOIN tableB2 AS b2 ON (b_id = b2_id)) ON (b_a = a_id)
633 * All of the table names given here are automatically run through
634 * Database::tableName(), which causes the table prefix (if any) to be
635 * added, and various other table name mappings to be performed.
637 * Do not use untrusted user input as a table name. Alias names should
638 * not have characters outside of the Basic multilingual plane.
640 * @param string|array $vars
642 * May be either a field name or an array of field names. The field names
643 * can be complete fragments of SQL, for direct inclusion into the SELECT
644 * query. If an array is given, field aliases can be specified, for example:
646 * [ 'maxrev' => 'MAX(rev_id)' ]
648 * This includes an expression with the alias "maxrev" in the query.
650 * If an expression is given, care must be taken to ensure that it is
653 * Untrusted user input must not be passed to this parameter.
655 * @param string|array $conds
657 * May be either a string containing a single condition, or an array of
658 * conditions. If an array is given, the conditions constructed from each
659 * element are combined with AND.
661 * Array elements may take one of two forms:
663 * - Elements with a numeric key are interpreted as raw SQL fragments.
664 * - Elements with a string key are interpreted as equality conditions,
665 * where the key is the field name.
666 * - If the value of such an array element is a scalar (such as a
667 * string), it will be treated as data and thus quoted appropriately.
668 * If it is null, an IS NULL clause will be added.
669 * - If the value is an array, an IN (...) clause will be constructed
670 * from its non-null elements, and an IS NULL clause will be added
671 * if null is present, such that the field may match any of the
672 * elements in the array. The non-null elements will be quoted.
674 * Note that expressions are often DBMS-dependent in their syntax.
675 * DBMS-independent wrappers are provided for constructing several types of
676 * expression commonly used in condition queries. See:
677 * - IDatabase::buildLike()
678 * - IDatabase::conditional()
680 * Untrusted user input is safe in the values of string keys, however untrusted
681 * input must not be used in the array key names or in the values of numeric keys.
682 * Escaping of untrusted input used in values of numeric keys should be done via
683 * IDatabase::addQuotes()
685 * @param string|array $options
687 * Optional: Array of query options. Boolean options are specified by
688 * including them in the array as a string value with a numeric key, for
693 * The supported options are:
695 * - OFFSET: Skip this many rows at the start of the result set. OFFSET
696 * with LIMIT can theoretically be used for paging through a result set,
697 * but this is discouraged for performance reasons.
699 * - LIMIT: Integer: return at most this many rows. The rows are sorted
700 * and then the first rows are taken until the limit is reached. LIMIT
701 * is applied to a result set after OFFSET.
703 * - FOR UPDATE: Boolean: lock the returned rows so that they can't be
704 * changed until the next COMMIT.
706 * - DISTINCT: Boolean: return only unique result rows.
708 * - GROUP BY: May be either an SQL fragment string naming a field or
709 * expression to group by, or an array of such SQL fragments.
711 * - HAVING: May be either an string containing a HAVING clause or an array of
712 * conditions building the HAVING clause. If an array is given, the conditions
713 * constructed from each element are combined with AND.
715 * - ORDER BY: May be either an SQL fragment giving a field name or
716 * expression to order by, or an array of such SQL fragments.
718 * - USE INDEX: This may be either a string giving the index name to use
719 * for the query, or an array. If it is an associative array, each key
720 * gives the table name (or alias), each value gives the index name to
721 * use for that table. All strings are SQL fragments and so should be
722 * validated by the caller.
724 * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run,
727 * And also the following boolean MySQL extensions, see the MySQL manual
730 * - LOCK IN SHARE MODE
734 * - SQL_BUFFER_RESULT
736 * - SQL_CALC_FOUND_ROWS
741 * @param string|array $join_conds
743 * Optional associative array of table-specific join conditions. In the
744 * most common case, this is unnecessary, since the join condition can be
745 * in $conds. However, it is useful for doing a LEFT JOIN.
747 * The key of the array contains the table name or alias. The value is an
748 * array with two elements, numbered 0 and 1. The first gives the type of
749 * join, the second is the same as the $conds parameter. Thus it can be
750 * an SQL fragment, or an array where the string keys are equality and the
751 * numeric keys are SQL fragments all AND'd together. For example:
753 * [ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]
755 * @return IResultWrapper Resulting rows
758 public function select(
759 $table, $vars, $conds = '', $fname = __METHOD__
,
760 $options = [], $join_conds = []
764 * The equivalent of IDatabase::select() except that the constructed SQL
765 * is returned, instead of being immediately executed. This can be useful for
766 * doing UNION queries, where the SQL text of each query is needed. In general,
767 * however, callers outside of Database classes should just use select().
769 * @see IDatabase::select()
771 * @param string|array $table Table name
772 * @param string|array $vars Field names
773 * @param string|array $conds Conditions
774 * @param string $fname Caller function name
775 * @param string|array $options Query options
776 * @param string|array $join_conds Join conditions
777 * @return string SQL query string
779 public function selectSQLText(
780 $table, $vars, $conds = '', $fname = __METHOD__
,
781 $options = [], $join_conds = []
785 * Single row SELECT wrapper. Equivalent to IDatabase::select(), except
786 * that a single row object is returned. If the query returns no rows,
789 * @param string|array $table Table name
790 * @param string|array $vars Field names
791 * @param array $conds Conditions
792 * @param string $fname Caller function name
793 * @param string|array $options Query options
794 * @param array|string $join_conds Join conditions
796 * @return stdClass|bool
799 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
800 $options = [], $join_conds = []
804 * Estimate the number of rows in dataset
806 * MySQL allows you to estimate the number of rows that would be returned
807 * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using
808 * index cardinality statistics, and is notoriously inaccurate, especially
809 * when large numbers of rows have recently been added or deleted.
811 * For DBMSs that don't support fast result size estimation, this function
812 * will actually perform the SELECT COUNT(*).
814 * Takes the same arguments as IDatabase::select().
816 * @param string $table Table name
817 * @param string $var Column for which NULL values are not counted [default "*"]
818 * @param array|string $conds Filters on the table
819 * @param string $fname Function name for profiling
820 * @param array $options Options for select
821 * @param array|string $join_conds Join conditions
822 * @return int Row count
825 public function estimateRowCount(
826 $table, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
830 * Get the number of rows in dataset
832 * This is useful when trying to do COUNT(*) but with a LIMIT for performance.
834 * Takes the same arguments as IDatabase::select().
836 * @since 1.27 Added $join_conds parameter
838 * @param array|string $tables Table names
839 * @param string $var Column for which NULL values are not counted [default "*"]
840 * @param array|string $conds Filters on the table
841 * @param string $fname Function name for profiling
842 * @param array $options Options for select
843 * @param array $join_conds Join conditions (since 1.27)
844 * @return int Row count
847 public function selectRowCount(
848 $tables, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
852 * Lock all rows meeting the given conditions/options FOR UPDATE
854 * @param array|string $table Table names
855 * @param array|string $conds Filters on the table
856 * @param string $fname Function name for profiling
857 * @param array $options Options for select ("FOR UPDATE" is added automatically)
858 * @param array $join_conds Join conditions
859 * @return int Number of matching rows found (and locked)
862 public function lockForUpdate(
863 $table, $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
867 * Determines whether a field exists in a table
869 * @param string $table Table name
870 * @param string $field Filed to check on that table
871 * @param string $fname Calling function name (optional)
872 * @return bool Whether $table has filed $field
875 public function fieldExists( $table, $field, $fname = __METHOD__
);
878 * Determines whether an index exists
879 * Usually throws a DBQueryError on failure
880 * If errors are explicitly ignored, returns NULL on failure
882 * @param string $table
883 * @param string $index
884 * @param string $fname
888 public function indexExists( $table, $index, $fname = __METHOD__
);
891 * Query whether a given table exists
893 * @param string $table
894 * @param string $fname
898 public function tableExists( $table, $fname = __METHOD__
);
901 * INSERT wrapper, inserts an array into a table.
905 * - A single associative array. The array keys are the field names, and
906 * the values are the values to insert. The values are treated as data
907 * and will be quoted appropriately. If NULL is inserted, this will be
908 * converted to a database NULL.
909 * - An array with numeric keys, holding a list of associative arrays.
910 * This causes a multi-row INSERT on DBMSs that support it. The keys in
911 * each subarray must be identical to each other, and in the same order.
913 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
916 * $options is an array of options, with boolean options encoded as values
917 * with numeric keys, in the same style as $options in
918 * IDatabase::select(). Supported options are:
920 * - IGNORE: Boolean: if present, duplicate key errors are ignored, and
921 * any rows which cause duplicate key errors are not inserted. It's
922 * possible to determine how many rows were successfully inserted using
923 * IDatabase::affectedRows().
925 * @param string $table Table name. This will be passed through
926 * Database::tableName().
927 * @param array $a Array of rows to insert
928 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
929 * @param array $options Array of options
934 public function insert( $table, $a, $fname = __METHOD__
, $options = [] );
937 * UPDATE wrapper. Takes a condition array and a SET array.
939 * @param string $table Name of the table to UPDATE. This will be passed through
940 * Database::tableName().
941 * @param array $values An array of values to SET. For each array element,
942 * the key gives the field name, and the value gives the data to set
943 * that field to. The data will be quoted by IDatabase::addQuotes().
944 * Values with integer keys form unquoted SET statements, which can be used for
945 * things like "field = field + 1" or similar computed values.
946 * @param array $conds An array of conditions (WHERE). See
947 * IDatabase::select() for the details of the format of condition
948 * arrays. Use '*' to update all rows.
949 * @param string $fname The function name of the caller (from __METHOD__),
950 * for logging and profiling.
951 * @param array $options An array of UPDATE options, can be:
952 * - IGNORE: Ignore unique key conflicts
953 * - LOW_PRIORITY: MySQL-specific, see MySQL manual.
957 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] );
960 * Makes an encoded list of strings from an array
962 * These can be used to make conjunctions or disjunctions on SQL condition strings
963 * derived from an array (see IDatabase::select() $conds documentation).
967 * $sql = $db->makeList( [
969 * $db->makeList( [ 'rev_minor' => 1, 'rev_len' < 500 ], $db::LIST_OR ] )
970 * ], $db::LIST_AND );
972 * This would set $sql to "rev_page = '$id' AND (rev_minor = '1' OR rev_len < '500')"
974 * @param array $a Containing the data
975 * @param int $mode IDatabase class constant:
976 * - IDatabase::LIST_COMMA: Comma separated, no field names
977 * - IDatabase::LIST_AND: ANDed WHERE clause (without the WHERE).
978 * - IDatabase::LIST_OR: ORed WHERE clause (without the WHERE)
979 * - IDatabase::LIST_SET: Comma separated with field names, like a SET clause
980 * - IDatabase::LIST_NAMES: Comma separated field names
984 public function makeList( $a, $mode = self
::LIST_COMMA
);
987 * Build a partial where clause from a 2-d array such as used for LinkBatch.
988 * The keys on each level may be either integers or strings.
990 * @param array $data Organized as 2-d
991 * [ baseKeyVal => [ subKeyVal => [ignored], ... ], ... ]
992 * @param string $baseKey Field name to match the base-level keys to (eg 'pl_namespace')
993 * @param string $subKey Field name to match the sub-level keys to (eg 'pl_title')
994 * @return string|bool SQL fragment, or false if no items in array
996 public function makeWhereFrom2d( $data, $baseKey, $subKey );
999 * Return aggregated value alias
1001 * @param array $valuedata
1002 * @param string $valuename
1006 public function aggregateValue( $valuedata, $valuename = 'value' );
1009 * @param string $field
1012 public function bitNot( $field );
1015 * @param string $fieldLeft
1016 * @param string $fieldRight
1019 public function bitAnd( $fieldLeft, $fieldRight );
1022 * @param string $fieldLeft
1023 * @param string $fieldRight
1026 public function bitOr( $fieldLeft, $fieldRight );
1029 * Build a concatenation list to feed into a SQL query
1030 * @param array $stringList List of raw SQL expressions; caller is
1031 * responsible for any quoting
1034 public function buildConcat( $stringList );
1037 * Build a GROUP_CONCAT or equivalent statement for a query.
1039 * This is useful for combining a field for several rows into a single string.
1040 * NULL values will not appear in the output, duplicated values will appear,
1041 * and the resulting delimiter-separated values have no defined sort order.
1042 * Code using the results may need to use the PHP unique() or sort() methods.
1044 * @param string $delim Glue to bind the results together
1045 * @param string|array $table Table name
1046 * @param string $field Field name
1047 * @param string|array $conds Conditions
1048 * @param string|array $join_conds Join conditions
1049 * @return string SQL text
1052 public function buildGroupConcatField(
1053 $delim, $table, $field, $conds = '', $join_conds = []
1057 * Build a SUBSTRING function.
1059 * Behavior for non-ASCII values is undefined.
1061 * @param string $input Field name
1062 * @param int $startPosition Positive integer
1063 * @param int|null $length Non-negative integer length or null for no limit
1064 * @throws InvalidArgumentException
1065 * @return string SQL text
1068 public function buildSubString( $input, $startPosition, $length = null );
1071 * @param string $field Field or column to cast
1075 public function buildStringCast( $field );
1078 * @param string $field Field or column to cast
1082 public function buildIntegerCast( $field );
1085 * Equivalent to IDatabase::selectSQLText() except wraps the result in Subqyery
1087 * @see IDatabase::selectSQLText()
1089 * @param string|array $table Table name
1090 * @param string|array $vars Field names
1091 * @param string|array $conds Conditions
1092 * @param string $fname Caller function name
1093 * @param string|array $options Query options
1094 * @param string|array $join_conds Join conditions
1098 public function buildSelectSubquery(
1099 $table, $vars, $conds = '', $fname = __METHOD__
,
1100 $options = [], $join_conds = []
1104 * Returns true if DBs are assumed to be on potentially different servers
1106 * In systems like mysql/mariadb, different databases can easily be referenced on a single
1107 * connection merely by name, even in a single query via JOIN. On the other hand, Postgres
1108 * treats databases as fully separate, only allowing mechanisms like postgres_fdw to
1109 * effectively "mount" foreign DBs. This is true even among DBs on the same server.
1114 public function databasesAreIndependent();
1117 * Change the current database
1120 * @return bool Success or failure
1121 * @throws DBConnectionError If databasesAreIndependent() is true and an error occurs
1123 public function selectDB( $db );
1126 * Get the current DB name
1129 public function getDBname();
1132 * Get the server hostname or IP address
1135 public function getServer();
1138 * Adds quotes and backslashes.
1140 * @param string|int|null|bool|Blob $s
1141 * @return string|int
1143 public function addQuotes( $s );
1146 * LIKE statement wrapper, receives a variable-length argument list with
1147 * parts of pattern to match containing either string literals that will be
1148 * escaped or tokens returned by anyChar() or anyString(). Alternatively,
1149 * the function could be provided with an array of aforementioned
1152 * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns
1153 * a LIKE clause that searches for subpages of 'My page title'.
1155 * $pattern = [ 'My_page_title/', $dbr->anyString() ];
1156 * $query .= $dbr->buildLike( $pattern );
1159 * @return string Fully built LIKE statement
1161 public function buildLike();
1164 * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
1168 public function anyChar();
1171 * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
1175 public function anyString();
1178 * Deprecated method, calls should be removed.
1180 * This was formerly used for PostgreSQL and Oracle to handle
1181 * self::insertId() auto-incrementing fields. It is no longer necessary
1182 * since DatabasePostgres::insertId() has been reimplemented using
1183 * `lastval()` and Oracle has been reimplemented using triggers.
1185 * Implementations should return null if inserting `NULL` into an
1186 * auto-incrementing field works, otherwise it should return an instance of
1187 * NextSequenceValue and filter it on calls to relevant methods.
1189 * @deprecated since 1.30, no longer needed
1190 * @param string $seqName
1191 * @return null|NextSequenceValue
1193 public function nextSequenceValue( $seqName );
1196 * REPLACE query wrapper.
1198 * REPLACE is a very handy MySQL extension, which functions like an INSERT
1199 * except that when there is a duplicate key error, the old row is deleted
1200 * and the new row is inserted in its place.
1202 * We simulate this with standard SQL with a DELETE followed by INSERT. To
1203 * perform the delete, we need to know what the unique indexes are so that
1204 * we know how to find the conflicting rows.
1206 * It may be more efficient to leave off unique indexes which are unlikely
1207 * to collide. However if you do this, you run the risk of encountering
1208 * errors which wouldn't have occurred in MySQL.
1210 * @param string $table The table to replace the row(s) in.
1211 * @param array $uniqueIndexes Either a list of fields that define a unique index or
1212 * an array of such lists if there are multiple unique indexes defined in the schema
1213 * @param array $rows Can be either a single row to insert, or multiple rows,
1214 * in the same format as for IDatabase::insert()
1215 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1218 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
);
1221 * INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
1223 * This updates any conflicting rows (according to the unique indexes) using
1224 * the provided SET clause and inserts any remaining (non-conflicted) rows.
1226 * $rows may be either:
1227 * - A single associative array. The array keys are the field names, and
1228 * the values are the values to insert. The values are treated as data
1229 * and will be quoted appropriately. If NULL is inserted, this will be
1230 * converted to a database NULL.
1231 * - An array with numeric keys, holding a list of associative arrays.
1232 * This causes a multi-row INSERT on DBMSs that support it. The keys in
1233 * each subarray must be identical to each other, and in the same order.
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 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
1244 * @param string $table Table name. This will be passed through Database::tableName().
1245 * @param array $rows A single row or list of rows to insert
1246 * @param array $uniqueIndexes Either a list of fields that define a unique index or
1247 * an array of such lists if there are multiple unique indexes defined in the schema
1248 * @param array $set An array of values to SET. For each array element, the
1249 * key gives the field name, and the value gives the data to set that
1250 * field to. The data will be quoted by IDatabase::addQuotes().
1251 * Values with integer keys form unquoted SET statements, which can be used for
1252 * things like "field = field + 1" or similar computed values.
1253 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1257 public function upsert(
1258 $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
1262 * DELETE where the condition is a join.
1264 * MySQL overrides this to use a multi-table DELETE syntax, in other databases
1265 * we use sub-selects
1267 * For safety, an empty $conds will not delete everything. If you want to
1268 * delete all rows where the join condition matches, set $conds='*'.
1270 * DO NOT put the join condition in $conds.
1272 * @param string $delTable The table to delete from.
1273 * @param string $joinTable The other table.
1274 * @param string $delVar The variable to join on, in the first table.
1275 * @param string $joinVar The variable to join on, in the second table.
1276 * @param array $conds Condition array of field names mapped to variables,
1277 * ANDed together in the WHERE clause
1278 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1281 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
1286 * DELETE query wrapper.
1288 * @param string $table Table name
1289 * @param string|array $conds Array of conditions. See $conds in IDatabase::select()
1290 * for the format. Use $conds == "*" to delete all rows
1291 * @param string $fname Name of the calling function
1292 * @throws DBUnexpectedError
1293 * @return bool|IResultWrapper
1296 public function delete( $table, $conds, $fname = __METHOD__
);
1299 * INSERT SELECT wrapper. Takes data from a SELECT query and inserts it
1300 * into another table.
1302 * @warning If the insert will use an auto-increment or sequence to
1303 * determine the value of a column, this may break replication on
1304 * databases using statement-based replication if the SELECT is not
1305 * deterministically ordered.
1307 * @param string $destTable The table name to insert into
1308 * @param string|array $srcTable May be either a table name, or an array of table names
1309 * to include in a join.
1311 * @param array $varMap Must be an associative array of the form
1312 * [ 'dest1' => 'source1', ... ]. Source items may be literals
1313 * rather than field names, but strings should be quoted with
1314 * IDatabase::addQuotes()
1316 * @param array $conds Condition array. See $conds in IDatabase::select() for
1317 * the details of the format of condition arrays. May be "*" to copy the
1320 * @param string $fname The function name of the caller, from __METHOD__
1322 * @param array $insertOptions Options for the INSERT part of the query, see
1323 * IDatabase::insert() for details. Also, one additional option is
1324 * available: pass 'NO_AUTO_COLUMNS' to hint that the query does not use
1325 * an auto-increment or sequence to determine any column values.
1326 * @param array $selectOptions Options for the SELECT part of the query, see
1327 * IDatabase::select() for details.
1328 * @param array $selectJoinConds Join conditions for the SELECT part of the query, see
1329 * IDatabase::select() for details.
1334 public function insertSelect( $destTable, $srcTable, $varMap, $conds,
1335 $fname = __METHOD__
,
1336 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
1340 * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
1341 * within the UNION construct.
1344 public function unionSupportsOrderAndLimit();
1347 * Construct a UNION query
1348 * This is used for providing overload point for other DB abstractions
1349 * not compatible with the MySQL syntax.
1350 * @param array $sqls SQL statements to combine
1351 * @param bool $all Use UNION ALL
1352 * @return string SQL fragment
1354 public function unionQueries( $sqls, $all );
1357 * Construct a UNION query for permutations of conditions
1359 * Databases sometimes have trouble with queries that have multiple values
1360 * for multiple condition parameters combined with limits and ordering.
1361 * This method constructs queries for the Cartesian product of the
1362 * conditions and unions them all together.
1364 * @see IDatabase::select()
1366 * @param string|array $table Table name
1367 * @param string|array $vars Field names
1368 * @param array $permute_conds Conditions for the Cartesian product. Keys
1369 * are field names, values are arrays of the possible values for that
1371 * @param string|array $extra_conds Additional conditions to include in the
1373 * @param string $fname Caller function name
1374 * @param string|array $options Query options. In addition to the options
1375 * recognized by IDatabase::select(), the following may be used:
1376 * - NOTALL: Set to use UNION instead of UNION ALL.
1377 * - INNER ORDER BY: If specified and supported, subqueries will use this
1378 * instead of ORDER BY.
1379 * @param string|array $join_conds Join conditions
1380 * @return string SQL query string.
1382 public function unionConditionPermutations(
1383 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__
,
1384 $options = [], $join_conds = []
1388 * Returns an SQL expression for a simple conditional. This doesn't need
1389 * to be overridden unless CASE isn't supported in your DBMS.
1391 * @param string|array $cond SQL expression which will result in a boolean value
1392 * @param string $trueVal SQL expression to return if true
1393 * @param string $falseVal SQL expression to return if false
1394 * @return string SQL fragment
1396 public function conditional( $cond, $trueVal, $falseVal );
1399 * Returns a command for str_replace function in SQL query.
1400 * Uses REPLACE() in MySQL
1402 * @param string $orig Column to modify
1403 * @param string $old Column to seek
1404 * @param string $new Column to replace with
1408 public function strreplace( $orig, $old, $new );
1411 * Determines how long the server has been up
1416 public function getServerUptime();
1419 * Determines if the last failure was due to a deadlock
1421 * Note that during a deadlock, the prior transaction will have been lost
1425 public function wasDeadlock();
1428 * Determines if the last failure was due to a lock timeout
1430 * Note that during a lock wait timeout, the prior transaction will have been lost
1434 public function wasLockTimeout();
1437 * Determines if the last query error was due to a dropped connection
1439 * Note that during a connection loss, the prior transaction will have been lost
1444 public function wasConnectionLoss();
1447 * Determines if the last failure was due to the database being read-only.
1451 public function wasReadOnlyError();
1454 * Determines if the last query error was due to something outside of the query itself
1456 * Note that the transaction may have been lost, discarding prior writes and results
1460 public function wasErrorReissuable();
1463 * Wait for the replica DB to catch up to a given master position
1465 * @param DBMasterPos $pos
1466 * @param int $timeout The maximum number of seconds to wait for synchronisation
1467 * @return int|null Zero if the replica DB was past that position already,
1468 * greater than zero if we waited for some period of time, less than
1469 * zero if it timed out, and null on error
1472 public function masterPosWait( DBMasterPos
$pos, $timeout );
1475 * Get the replication position of this replica DB
1477 * @return DBMasterPos|bool False if this is not a replica DB
1480 public function getReplicaPos();
1483 * Get the position of this master
1485 * @return DBMasterPos|bool False if this is not a master
1488 public function getMasterPos();
1491 * @return bool Whether the DB is marked as read-only server-side
1494 public function serverIsReadOnly();
1497 * Run a callback as soon as the current transaction commits or rolls back.
1498 * An error is thrown if no transaction is pending. Queries in the function will run in
1499 * AUTOCOMMIT mode unless there are begin() calls. Callbacks must commit any transactions
1502 * This is useful for combining cooperative locks and DB transactions.
1504 * @note do not assume that *other* IDatabase instances will be AUTOCOMMIT mode
1506 * The callback takes the following arguments:
1507 * - How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK)
1508 * - This IDatabase instance (since 1.32)
1510 * @param callable $callback
1511 * @param string $fname Caller name
1515 public function onTransactionResolution( callable
$callback, $fname = __METHOD__
);
1518 * Run a callback as soon as there is no transaction pending.
1519 * If there is a transaction and it is rolled back, then the callback is cancelled.
1521 * When transaction round mode (DBO_TRX) is set, the callback will run at the end
1522 * of the round, just after all peer transactions COMMIT. If the transaction round
1523 * is rolled back, then the callback is cancelled.
1525 * Queries in the function will run in AUTOCOMMIT mode unless there are begin() calls.
1526 * Callbacks must commit any transactions that they begin.
1528 * This is useful for updates to different systems or when separate transactions are needed.
1529 * For example, one might want to enqueue jobs into a system outside the database, but only
1530 * after the database is updated so that the jobs will see the data when they actually run.
1531 * It can also be used for updates that easily suffer from lock timeouts and deadlocks,
1532 * but where atomicity is not essential.
1534 * Avoid using IDatabase instances aside from this one in the callback, unless such instances
1535 * never have IDatabase::DBO_TRX set. This keeps callbacks from interfering with one another.
1537 * Updates will execute in the order they were enqueued.
1539 * @note do not assume that *other* IDatabase instances will be AUTOCOMMIT mode
1541 * The callback takes the following arguments:
1542 * - How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_IDLE)
1543 * - This IDatabase instance (since 1.32)
1545 * @param callable $callback
1546 * @param string $fname Caller name
1549 public function onTransactionCommitOrIdle( callable
$callback, $fname = __METHOD__
);
1552 * Alias for onTransactionCommitOrIdle() for backwards-compatibility
1554 * @param callable $callback
1555 * @param string $fname
1558 * @deprecated Since 1.32
1560 public function onTransactionIdle( callable
$callback, $fname = __METHOD__
);
1563 * Run a callback before the current transaction commits or now if there is none.
1564 * If there is a transaction and it is rolled back, then the callback is cancelled.
1566 * When transaction round mode (DBO_TRX) is set, the callback will run at the end
1567 * of the round, just before all peer transactions COMMIT. If the transaction round
1568 * is rolled back, then the callback is cancelled.
1570 * Callbacks must not start nor commit any transactions. If no transaction is active,
1571 * then a transaction will wrap the callback.
1573 * This is useful for updates that easily suffer from lock timeouts and deadlocks,
1574 * but where atomicity is strongly desired for these updates and some related updates.
1576 * Updates will execute in the order they were enqueued.
1578 * The callback takes the one argument:
1579 * - This IDatabase instance (since 1.32)
1581 * @param callable $callback
1582 * @param string $fname Caller name
1585 public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
);
1588 * Run a callback each time any transaction commits or rolls back
1590 * The callback takes two arguments:
1591 * - IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK
1592 * - This IDatabase object
1593 * Callbacks must commit any transactions that they begin.
1595 * Registering a callback here will not affect writesOrCallbacks() pending.
1597 * Since callbacks from this or onTransactionCommitOrIdle() can start and end transactions,
1598 * a single call to IDatabase::commit might trigger multiple runs of the listener callbacks.
1600 * @param string $name Callback name
1601 * @param callable|null $callback Use null to unset a listener
1605 public function setTransactionListener( $name, callable
$callback = null );
1608 * Begin an atomic section of SQL statements
1610 * Start an implicit transaction if no transaction is already active, set a savepoint
1611 * (if $cancelable is ATOMIC_CANCELABLE), and track the given section name to enforce
1612 * that the transaction is not committed prematurely. The end of the section must be
1613 * signified exactly once, either by endAtomic() or cancelAtomic(). Sections can have
1614 * have layers of inner sections (sub-sections), but all sections must be ended in order
1615 * of innermost to outermost. Transactions cannot be started or committed until all
1616 * atomic sections are closed.
1618 * ATOMIC_CANCELABLE is useful when the caller needs to handle specific failure cases
1619 * by discarding the section's writes. This should not be used for failures when:
1620 * - upsert() could easily be used instead
1621 * - insert() with IGNORE could easily be used instead
1622 * - select() with FOR UPDATE could be checked before issuing writes instead
1623 * - The failure is from code that runs after the first write but doesn't need to
1624 * - The failures are from contention solvable via onTransactionPreCommitOrIdle()
1625 * - The failures are deadlocks; the RDBMs usually discard the whole transaction
1627 * @note callers must use additional measures for situations involving two or more
1628 * (peer) transactions (e.g. updating two database servers at once). The transaction
1629 * and savepoint logic of this method only applies to this specific IDatabase instance.
1633 * // Start a transaction if there isn't one already
1634 * $dbw->startAtomic( __METHOD__ );
1635 * // Serialize these thread table updates
1636 * $dbw->select( 'thread', '1', [ 'td_id' => $tid ], __METHOD__, 'FOR UPDATE' );
1637 * // Add a new comment for the thread
1638 * $dbw->insert( 'comment', $row, __METHOD__ );
1639 * $cid = $db->insertId();
1640 * // Update thread reference to last comment
1641 * $dbw->update( 'thread', [ 'td_latest' => $cid ], [ 'td_id' => $tid ], __METHOD__ );
1642 * // Demark the end of this conceptual unit of updates
1643 * $dbw->endAtomic( __METHOD__ );
1646 * Example usage (atomic changes that might have to be discarded):
1648 * // Start a transaction if there isn't one already
1649 * $sectionId = $dbw->startAtomic( __METHOD__, $dbw::ATOMIC_CANCELABLE );
1650 * // Create new record metadata row
1651 * $dbw->insert( 'records', $row, __METHOD__ );
1652 * // Figure out where to store the data based on the new row's ID
1653 * $path = $recordDirectory . '/' . $dbw->insertId();
1654 * // Write the record data to the storage system
1655 * $status = $fileBackend->create( [ 'dst' => $path, 'content' => $data ] );
1656 * if ( $status->isOK() ) {
1657 * // Try to cleanup files orphaned by transaction rollback
1658 * $dbw->onTransactionResolution(
1659 * function ( $type ) use ( $fileBackend, $path ) {
1660 * if ( $type === IDatabase::TRIGGER_ROLLBACK ) {
1661 * $fileBackend->delete( [ 'src' => $path ] );
1666 * // Demark the end of this conceptual unit of updates
1667 * $dbw->endAtomic( __METHOD__ );
1669 * // Discard these writes from the transaction (preserving prior writes)
1670 * $dbw->cancelAtomic( __METHOD__, $sectionId );
1675 * @param string $fname
1676 * @param string $cancelable Pass self::ATOMIC_CANCELABLE to use a
1677 * savepoint and enable self::cancelAtomic() for this section.
1678 * @return AtomicSectionIdentifier section ID token
1681 public function startAtomic( $fname = __METHOD__
, $cancelable = self
::ATOMIC_NOT_CANCELABLE
);
1684 * Ends an atomic section of SQL statements
1686 * Ends the next section of atomic SQL statements and commits the transaction
1690 * @see IDatabase::startAtomic
1691 * @param string $fname
1694 public function endAtomic( $fname = __METHOD__
);
1697 * Cancel an atomic section of SQL statements
1699 * This will roll back only the statements executed since the start of the
1700 * most recent atomic section, and close that section. If a transaction was
1701 * open before the corresponding startAtomic() call, any statements before
1702 * that call are *not* rolled back and the transaction remains open. If the
1703 * corresponding startAtomic() implicitly started a transaction, that
1704 * transaction is rolled back.
1706 * @note callers must use additional measures for situations involving two or more
1707 * (peer) transactions (e.g. updating two database servers at once). The transaction
1708 * and savepoint logic of startAtomic() are bound to specific IDatabase instances.
1710 * Note that a call to IDatabase::rollback() will also roll back any open atomic sections.
1712 * @note As a micro-optimization to save a few DB calls, this method may only
1713 * be called when startAtomic() was called with the ATOMIC_CANCELABLE flag.
1715 * @see IDatabase::startAtomic
1716 * @param string $fname
1717 * @param AtomicSectionIdentifier|null $sectionId Section ID from startAtomic();
1718 * passing this enables cancellation of unclosed nested sections [optional]
1721 public function cancelAtomic( $fname = __METHOD__
, AtomicSectionIdentifier
$sectionId = null );
1724 * Perform an atomic section of reversable SQL statements from a callback
1726 * The $callback takes the following arguments:
1727 * - This database object
1728 * - The value of $fname
1730 * This will execute the callback inside a pair of startAtomic()/endAtomic() calls.
1731 * If any exception occurs during execution of the callback, it will be handled as follows:
1732 * - If $cancelable is ATOMIC_CANCELABLE, cancelAtomic() will be called to back out any
1733 * (and only) statements executed during the atomic section. If that succeeds, then the
1734 * exception will be re-thrown; if it fails, then a different exception will be thrown
1735 * and any further query attempts will fail until rollback() is called.
1736 * - If $cancelable is ATOMIC_NOT_CANCELABLE, cancelAtomic() will be called to mark the
1737 * end of the section and the error will be re-thrown. Any further query attempts will
1738 * fail until rollback() is called.
1740 * This method is convenient for letting calls to the caller of this method be wrapped
1741 * in a try/catch blocks for exception types that imply that the caller failed but was
1742 * able to properly discard the changes it made in the transaction. This method can be
1743 * an alternative to explicit calls to startAtomic()/endAtomic()/cancelAtomic().
1745 * Example usage, "RecordStore::save" method:
1747 * $dbw->doAtomicSection( __METHOD__, function ( $dbw ) use ( $record ) {
1748 * // Create new record metadata row
1749 * $dbw->insert( 'records', $record->toArray(), __METHOD__ );
1750 * // Figure out where to store the data based on the new row's ID
1751 * $path = $this->recordDirectory . '/' . $dbw->insertId();
1752 * // Write the record data to the storage system;
1753 * // blob store throughs StoreFailureException on failure
1754 * $this->blobStore->create( $path, $record->getJSON() );
1755 * // Try to cleanup files orphaned by transaction rollback
1756 * $dbw->onTransactionResolution(
1757 * function ( $type ) use ( $path ) {
1758 * if ( $type === IDatabase::TRIGGER_ROLLBACK ) {
1759 * $this->blobStore->delete( $path );
1764 * }, $dbw::ATOMIC_CANCELABLE );
1767 * Example usage, caller of the "RecordStore::save" method:
1769 * $dbw->startAtomic( __METHOD__ );
1770 * // ...various SQL writes happen...
1772 * $recordStore->save( $record );
1773 * } catch ( StoreFailureException $e ) {
1774 * // ...various SQL writes happen...
1776 * // ...various SQL writes happen...
1777 * $dbw->endAtomic( __METHOD__ );
1780 * @see Database::startAtomic
1781 * @see Database::endAtomic
1782 * @see Database::cancelAtomic
1784 * @param string $fname Caller name (usually __METHOD__)
1785 * @param callable $callback Callback that issues DB updates
1786 * @param string $cancelable Pass self::ATOMIC_CANCELABLE to use a
1787 * savepoint and enable self::cancelAtomic() for this section.
1788 * @return mixed $res Result of the callback (since 1.28)
1790 * @throws RuntimeException
1791 * @since 1.27; prior to 1.31 this did a rollback() instead of
1792 * cancelAtomic(), and assumed no callers up the stack would ever try to
1793 * catch the exception.
1795 public function doAtomicSection(
1796 $fname, callable
$callback, $cancelable = self
::ATOMIC_NOT_CANCELABLE
1800 * Begin a transaction. If a transaction is already in progress,
1801 * that transaction will be committed before the new transaction is started.
1803 * Only call this from code with outer transcation scope.
1804 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1805 * Nesting of transactions is not supported.
1807 * Note that when the DBO_TRX flag is set (which is usually the case for web
1808 * requests, but not for maintenance scripts), any previous database query
1809 * will have started a transaction automatically.
1811 * Nesting of transactions is not supported. Attempts to nest transactions
1812 * will cause a warning, unless the current transaction was started
1813 * automatically because of the DBO_TRX flag.
1815 * @param string $fname Calling function name
1816 * @param string $mode A situationally valid IDatabase::TRANSACTION_* constant [optional]
1819 public function begin( $fname = __METHOD__
, $mode = self
::TRANSACTION_EXPLICIT
);
1822 * Commits a transaction previously started using begin().
1823 * If no transaction is in progress, a warning is issued.
1825 * Only call this from code with outer transcation scope.
1826 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1827 * Nesting of transactions is not supported.
1829 * @param string $fname
1830 * @param string $flush Flush flag, set to situationally valid IDatabase::FLUSHING_*
1831 * constant to disable warnings about explicitly committing implicit transactions,
1832 * or calling commit when no transaction is in progress.
1834 * This will trigger an exception if there is an ongoing explicit transaction.
1836 * Only set the flush flag if you are sure that these warnings are not applicable,
1837 * and no explicit transactions are open.
1841 public function commit( $fname = __METHOD__
, $flush = '' );
1844 * Rollback a transaction previously started using begin().
1845 * If no transaction is in progress, a warning is issued.
1847 * Only call this from code with outer transcation scope.
1848 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1849 * Nesting of transactions is not supported. If a serious unexpected error occurs,
1850 * throwing an Exception is preferrable, using a pre-installed error handler to trigger
1851 * rollback (in any case, failure to issue COMMIT will cause rollback server-side).
1853 * Query, connection, and onTransaction* callback errors will be suppressed and logged.
1855 * @param string $fname Calling function name
1856 * @param string $flush Flush flag, set to a situationally valid IDatabase::FLUSHING_*
1857 * constant to disable warnings about calling rollback when no transaction is in
1858 * progress. This will silently break any ongoing explicit transaction. Only set the
1859 * flush flag if you are sure that it is safe to ignore these warnings in your context.
1861 * @since 1.23 Added $flush parameter
1863 public function rollback( $fname = __METHOD__
, $flush = '' );
1866 * Commit any transaction but error out if writes or callbacks are pending
1868 * This is intended for clearing out REPEATABLE-READ snapshots so that callers can
1869 * see a new point-in-time of the database. This is useful when one of many transaction
1870 * rounds finished and significant time will pass in the script's lifetime. It is also
1871 * useful to call on a replica DB after waiting on replication to catch up to the master.
1873 * @param string $fname Calling function name
1877 public function flushSnapshot( $fname = __METHOD__
);
1880 * Convert a timestamp in one of the formats accepted by wfTimestamp()
1881 * to the format used for inserting into timestamp fields in this DBMS.
1883 * The result is unquoted, and needs to be passed through addQuotes()
1884 * before it can be included in raw SQL.
1886 * @param string|int $ts
1890 public function timestamp( $ts = 0 );
1893 * Convert a timestamp in one of the formats accepted by wfTimestamp()
1894 * to the format used for inserting into timestamp fields in this DBMS. If
1895 * NULL is input, it is passed through, allowing NULL values to be inserted
1896 * into timestamp fields.
1898 * The result is unquoted, and needs to be passed through addQuotes()
1899 * before it can be included in raw SQL.
1901 * @param string|int|null $ts
1905 public function timestampOrNull( $ts = null );
1908 * Ping the server and try to reconnect if it there is no connection
1910 * @param float|null &$rtt Value to store the estimated RTT [optional]
1911 * @return bool Success or failure
1913 public function ping( &$rtt = null );
1916 * Get the amount of replication lag for this database server
1918 * Callers should avoid using this method while a transaction is active
1920 * @return int|bool Database replication lag in seconds or false on error
1923 public function getLag();
1926 * Get the replica DB lag when the current transaction started
1927 * or a general lag estimate if not transaction is active
1929 * This is useful when transactions might use snapshot isolation
1930 * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
1931 * is this lag plus transaction duration. If they don't, it is still
1932 * safe to be pessimistic. In AUTOCOMMIT mode, this still gives an
1933 * indication of the staleness of subsequent reads.
1935 * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
1939 public function getSessionLagStatus();
1942 * Return the maximum number of items allowed in a list, or 0 for unlimited.
1946 public function maxListLen();
1949 * Some DBMSs have a special format for inserting into blob fields, they
1950 * don't allow simple quoted strings to be inserted. To insert into such
1951 * a field, pass the data through this function before passing it to
1952 * IDatabase::insert().
1955 * @return string|Blob
1957 public function encodeBlob( $b );
1960 * Some DBMSs return a special placeholder object representing blob fields
1961 * in result objects. Pass the object through this function to return the
1964 * @param string|Blob $b
1967 public function decodeBlob( $b );
1970 * Override database's default behavior. $options include:
1971 * 'connTimeout' : Set the connection timeout value in seconds.
1972 * May be useful for very long batch queries such as
1973 * full-wiki dumps, where a single query reads out over
1976 * @param array $options
1980 public function setSessionOptions( array $options );
1983 * Set variables to be used in sourceFile/sourceStream, in preference to the
1984 * ones in $GLOBALS. If an array is set here, $GLOBALS will not be used at
1985 * all. If it's set to false, $GLOBALS will be used.
1987 * @param bool|array $vars Mapping variable name to value.
1989 public function setSchemaVars( $vars );
1992 * Check to see if a named lock is not locked by any thread (non-blocking)
1994 * @param string $lockName Name of lock to poll
1995 * @param string $method Name of method calling us
2000 public function lockIsFree( $lockName, $method );
2003 * Acquire a named lock
2005 * Named locks are not related to transactions
2007 * @param string $lockName Name of lock to aquire
2008 * @param string $method Name of the calling method
2009 * @param int $timeout Acquisition timeout in seconds
2013 public function lock( $lockName, $method, $timeout = 5 );
2018 * Named locks are not related to transactions
2020 * @param string $lockName Name of lock to release
2021 * @param string $method Name of the calling method
2023 * @return int Returns 1 if the lock was released, 0 if the lock was not established
2024 * by this thread (in which case the lock is not released), and NULL if the named lock
2029 public function unlock( $lockName, $method );
2032 * Acquire a named lock, flush any transaction, and return an RAII style unlocker object
2034 * Only call this from outer transcation scope and when only one DB will be affected.
2035 * See https://www.mediawiki.org/wiki/Database_transactions for details.
2037 * This is suitiable for transactions that need to be serialized using cooperative locks,
2038 * where each transaction can see each others' changes. Any transaction is flushed to clear
2039 * out stale REPEATABLE-READ snapshot data. Once the returned object falls out of PHP scope,
2040 * the lock will be released unless a transaction is active. If one is active, then the lock
2041 * will be released when it either commits or rolls back.
2043 * If the lock acquisition failed, then no transaction flush happens, and null is returned.
2045 * @param string $lockKey Name of lock to release
2046 * @param string $fname Name of the calling method
2047 * @param int $timeout Acquisition timeout in seconds
2048 * @return ScopedCallback|null
2052 public function getScopedLockAndFlush( $lockKey, $fname, $timeout );
2055 * Check to see if a named lock used by lock() use blocking queues
2060 public function namedLocksEnqueue();
2063 * Find out when 'infinity' is. Most DBMSes support this. This is a special
2064 * keyword for timestamps in PostgreSQL, and works with CHAR(14) as well
2065 * because "i" sorts after all numbers.
2069 public function getInfinity();
2072 * Encode an expiry time into the DBMS dependent format
2074 * @param string $expiry Timestamp for expiry, or the 'infinity' string
2077 public function encodeExpiry( $expiry );
2080 * Decode an expiry time into a DBMS independent format
2082 * @param string $expiry DB timestamp field value for expiry
2083 * @param int $format TS_* constant, defaults to TS_MW
2086 public function decodeExpiry( $expiry, $format = TS_MW
);
2089 * Allow or deny "big selects" for this session only. This is done by setting
2090 * the sql_big_selects session variable.
2092 * This is a MySQL-specific feature.
2094 * @param bool|string $value True for allow, false for deny, or "default" to
2095 * restore the initial value
2097 public function setBigSelects( $value = true );
2100 * @return bool Whether this DB is read-only
2103 public function isReadOnly();
2106 * Make certain table names use their own database, schema, and table prefix
2107 * when passed into SQL queries pre-escaped and without a qualified database name
2109 * For example, "user" can be converted to "myschema.mydbname.user" for convenience.
2110 * Appearances like `user`, somedb.user, somedb.someschema.user will used literally.
2112 * Calling this twice will completely clear any old table aliases. Also, note that
2113 * callers are responsible for making sure the schemas and databases actually exist.
2115 * @param array[] $aliases Map of (table => (dbname, schema, prefix) map)
2118 public function setTableAliases( array $aliases );
2121 * Convert certain index names to alternative names before querying the DB
2123 * Note that this applies to indexes regardless of the table they belong to.
2125 * This can be employed when an index was renamed X => Y in code, but the new Y-named
2126 * indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA,
2127 * the aliases can be removed, and then the old X-named indexes dropped.
2129 * @param string[] $aliases
2133 public function setIndexAliases( array $aliases );
2137 * @deprecated since 1.29
2139 class_alias( IDatabase
::class, 'IDatabase' );