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
;
25 use UnexpectedValueException
;
29 * @defgroup Database Database
30 * This group deals with database interface functions
31 * and query specifics/optimisations.
34 * Basic database interface for live and lazy-loaded relation database handles
36 * @note: IDatabase and DBConnRef should be updated to reflect any changes
40 /** @var int Callback triggered immediately due to no active transaction */
41 const TRIGGER_IDLE
= 1;
42 /** @var int Callback triggered by COMMIT */
43 const TRIGGER_COMMIT
= 2;
44 /** @var int Callback triggered by ROLLBACK */
45 const TRIGGER_ROLLBACK
= 3;
47 /** @var string Transaction is requested by regular caller outside of the DB layer */
48 const TRANSACTION_EXPLICIT
= '';
49 /** @var string Transaction is requested internally via DBO_TRX/startAtomic() */
50 const TRANSACTION_INTERNAL
= 'implicit';
52 /** @var string Transaction operation comes from service managing all DBs */
53 const FLUSHING_ALL_PEERS
= 'flush';
54 /** @var string Transaction operation comes from the database class internally */
55 const FLUSHING_INTERNAL
= 'flush';
57 /** @var string Do not remember the prior flags */
58 const REMEMBER_NOTHING
= '';
59 /** @var string Remember the prior flags */
60 const REMEMBER_PRIOR
= 'remember';
61 /** @var string Restore to the prior flag state */
62 const RESTORE_PRIOR
= 'prior';
63 /** @var string Restore to the initial flag state */
64 const RESTORE_INITIAL
= 'initial';
66 /** @var string Estimate total time (RTT, scanning, waiting on locks, applying) */
67 const ESTIMATE_TOTAL
= 'total';
68 /** @var string Estimate time to apply (scanning, applying) */
69 const ESTIMATE_DB_APPLY
= 'apply';
71 /** @var int Combine list with comma delimeters */
73 /** @var int Combine list with AND clauses */
75 /** @var int Convert map into a SET clause */
77 /** @var int Treat as field name and do not apply value escaping */
79 /** @var int Combine list with OR clauses */
82 /** @var int Enable debug logging */
84 /** @var int Disable query buffering (only one result set can be iterated at a time) */
85 const DBO_NOBUFFER
= 2;
86 /** @var int Ignore query errors (internal use only!) */
88 /** @var int Autoatically start transaction on first query (work with ILoadBalancer rounds) */
90 /** @var int Use DBO_TRX in non-CLI mode */
91 const DBO_DEFAULT
= 16;
92 /** @var int Use DB persistent connections if possible */
93 const DBO_PERSISTENT
= 32;
94 /** @var int DBA session mode; mostly for Oracle */
95 const DBO_SYSDBA
= 64;
96 /** @var int Schema file mode; mostly for Oracle */
97 const DBO_DDLMODE
= 128;
98 /** @var int Enable SSL/TLS in connection protocol */
100 /** @var int Enable compression in connection protocol */
101 const DBO_COMPRESS
= 512;
104 * A string describing the current software version, and possibly
105 * other details in a user-friendly way. Will be listed on Special:Version, etc.
106 * Use getServerVersion() to get machine-friendly information.
108 * @return string Version information from the database server
110 public function getServerInfo();
113 * Turns buffering of SQL result sets on (true) or off (false). Default is "on".
115 * Unbuffered queries are very troublesome in MySQL:
117 * - If another query is executed while the first query is being read
118 * out, the first query is killed. This means you can't call normal
119 * Database functions while you are reading an unbuffered query result
120 * from a normal Database connection.
122 * - Unbuffered queries cause the MySQL server to use large amounts of
123 * memory and to hold broad locks which block other queries.
125 * If you want to limit client-side memory, it's almost always better to
126 * split up queries into batches using a LIMIT clause than to switch off
129 * @param null|bool $buffer
130 * @return null|bool The previous value of the flag
132 public function bufferResults( $buffer = null );
135 * Gets the current transaction level.
137 * Historically, transactions were allowed to be "nested". This is no
138 * longer supported, so this function really only returns a boolean.
140 * @return int The previous value
142 public function trxLevel();
145 * Get the UNIX timestamp of the time that the transaction was established
147 * This can be used to reason about the staleness of SELECT data
148 * in REPEATABLE-READ transaction isolation level.
150 * @return float|null Returns null if there is not active transaction
153 public function trxTimestamp();
156 * @return bool Whether an explicit transaction or atomic sections are still open
159 public function explicitTrxActive();
162 * Get/set the table prefix.
163 * @param string $prefix The table prefix to set, or omitted to leave it unchanged.
164 * @return string The previous table prefix.
166 public function tablePrefix( $prefix = null );
169 * Get/set the db schema.
170 * @param string $schema The database schema to set, or omitted to leave it unchanged.
171 * @return string The previous db schema.
173 public function dbSchema( $schema = null );
176 * Get properties passed down from the server info array of the load
179 * @param string $name The entry of the info array to get, or null to get the
182 * @return array|mixed|null
184 public function getLBInfo( $name = null );
187 * Set the LB info array, or a member of it. If called with one parameter,
188 * the LB info array is set to that parameter. If it is called with two
189 * parameters, the member with the given name is set to the given value.
191 * @param string $name
192 * @param array $value
194 public function setLBInfo( $name, $value = null );
197 * Set a lazy-connecting DB handle to the master DB (for replication status purposes)
199 * @param IDatabase $conn
202 public function setLazyMasterHandle( IDatabase
$conn );
205 * Returns true if this database does an implicit sort when doing GROUP BY
208 * @deprecated Since 1.30; only use grouped or aggregated fields in the SELECT
210 public function implicitGroupby();
213 * Returns true if this database does an implicit order by when the column has an index
214 * For example: SELECT page_title FROM page LIMIT 1
218 public function implicitOrderby();
221 * Return the last query that went through IDatabase::query()
224 public function lastQuery();
227 * Returns true if the connection may have been used for write queries.
228 * Should return true if unsure.
232 public function doneWrites();
235 * Returns the last time the connection may have been used for write queries.
236 * Should return a timestamp if unsure.
238 * @return int|float UNIX timestamp or false
241 public function lastDoneWrites();
244 * @return bool Whether there is a transaction open with possible write queries
247 public function writesPending();
250 * Returns true if there is a transaction open with possible write
251 * queries or transaction pre-commit/idle callbacks waiting on it to finish.
252 * This does *not* count recurring callbacks, e.g. from setTransactionListener().
256 public function writesOrCallbacksPending();
259 * Get the time spend running write queries for this transaction
261 * High times could be due to scanning, updates, locking, and such
263 * @param string $type IDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL]
264 * @return float|bool Returns false if not transaction is active
267 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
);
270 * Get the list of method names that did write queries for this transaction
275 public function pendingWriteCallers();
278 * Get the number of affected rows from pending write queries
283 public function pendingWriteRowsAffected();
286 * Is a connection to the database open?
289 public function isOpen();
292 * Set a flag for this connection
294 * @param int $flag DBO_* constants from Defines.php:
295 * - DBO_DEBUG: output some debug info (same as debug())
296 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
297 * - DBO_TRX: automatically start transactions
298 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
299 * and removes it in command line mode
300 * - DBO_PERSISTENT: use persistant database connection
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 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 clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
);
320 * Restore the flags to their prior state before the last setFlag/clearFlag call
322 * @param string $state IDatabase::RESTORE_* constant. [default: RESTORE_PRIOR]
325 public function restoreFlags( $state = self
::RESTORE_PRIOR
);
328 * Returns a boolean whether the flag $flag is set for this connection
330 * @param int $flag DBO_* constants from Defines.php:
331 * - DBO_DEBUG: output some debug info (same as debug())
332 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
333 * - DBO_TRX: automatically start transactions
334 * - DBO_PERSISTENT: use persistant database connection
337 public function getFlag( $flag );
342 public function getDomainID();
345 * Alias for getDomainID()
350 public function getWikiID();
353 * Get the type of the DBMS, as it appears in $wgDBtype.
357 public function getType();
360 * Open a new connection to the database (closing any existing one)
362 * @param string $server Database server host
363 * @param string $user Database user name
364 * @param string $password Database user password
365 * @param string $dbName Database name
367 * @throws DBConnectionError
369 public function open( $server, $user, $password, $dbName );
372 * Fetch the next row from the given result object, in object form.
373 * Fields can be retrieved with $row->fieldname, with fields acting like
375 * If no more rows are available, false is returned.
377 * @param IResultWrapper|stdClass $res Object as returned from IDatabase::query(), etc.
378 * @return stdClass|bool
379 * @throws DBUnexpectedError Thrown if the database returns an error
381 public function fetchObject( $res );
384 * Fetch the next row from the given result object, in associative array
385 * form. Fields are retrieved with $row['fieldname'].
386 * If no more rows are available, false is returned.
388 * @param IResultWrapper $res Result object as returned from IDatabase::query(), etc.
390 * @throws DBUnexpectedError Thrown if the database returns an error
392 public function fetchRow( $res );
395 * Get the number of rows in a result object
397 * @param mixed $res A SQL result
400 public function numRows( $res );
403 * Get the number of fields in a result object
404 * @see https://secure.php.net/mysql_num_fields
406 * @param mixed $res A SQL result
409 public function numFields( $res );
412 * Get a field name in a result object
413 * @see https://secure.php.net/mysql_field_name
415 * @param mixed $res A SQL result
419 public function fieldName( $res, $n );
422 * Get the inserted value of an auto-increment row
424 * This should only be called after an insert that used an auto-incremented
425 * value. If no such insert was previously done in the current database
426 * session, the return value is undefined.
430 public function insertId();
433 * Change the position of the cursor in a result object
434 * @see https://secure.php.net/mysql_data_seek
436 * @param mixed $res A SQL result
439 public function dataSeek( $res, $row );
442 * Get the last error number
443 * @see https://secure.php.net/mysql_errno
447 public function lastErrno();
450 * Get a description of the last error
451 * @see https://secure.php.net/mysql_error
455 public function lastError();
458 * mysql_fetch_field() wrapper
459 * Returns false if the field doesn't exist
461 * @param string $table Table name
462 * @param string $field Field name
466 public function fieldInfo( $table, $field );
469 * Get the number of rows affected by the last write query
470 * @see https://secure.php.net/mysql_affected_rows
474 public function affectedRows();
477 * Returns a wikitext link to the DB's website, e.g.,
478 * return "[https://www.mysql.com/ MySQL]";
479 * Should at least contain plain text, if for some reason
480 * your database has no website.
482 * @return string Wikitext of a link to the server software's web site
484 public function getSoftwareLink();
487 * A string describing the current software version, like from
488 * mysql_get_server_info().
490 * @return string Version information from the database server.
492 public function getServerVersion();
495 * Close the database connection
497 * This should only be called after any transactions have been resolved,
498 * aside from read-only transactions (assuming no callbacks are registered).
499 * If a transaction is still open anyway, it will be committed if possible.
502 * @return bool Operation success. true if already closed.
504 public function close();
507 * @param string $error Fallback error message, used if none is given by DB
508 * @throws DBConnectionError
510 public function reportConnectionError( $error = 'Unknown error' );
513 * Run an SQL query and return the result. Normally throws a DBQueryError
514 * on failure. If errors are ignored, returns false instead.
516 * If a connection loss is detected, then an attempt to reconnect will be made.
517 * For queries that involve no larger transactions or locks, they will be re-issued
518 * for convenience, provided the connection was re-established.
520 * In new code, the query wrappers select(), insert(), update(), delete(),
521 * etc. should be used where possible, since they give much better DBMS
522 * independence and automatically quote or validate user input in a variety
523 * of contexts. This function is generally only useful for queries which are
524 * explicitly DBMS-dependent and are unsupported by the query wrappers, such
527 * However, the query wrappers themselves should call this function.
529 * @param string $sql SQL query
530 * @param string $fname Name of the calling function, for profiling/SHOW PROCESSLIST
531 * comment (you can use __METHOD__ or add some extra info)
532 * @param bool $tempIgnore Whether to avoid throwing an exception on errors...
533 * maybe best to catch the exception instead?
534 * @return bool|IResultWrapper True for a successful write query, IResultWrapper object
535 * for a successful read query, or false on failure if $tempIgnore set
538 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false );
541 * Report a query error. Log the error, and if neither the object ignore
542 * flag nor the $tempIgnore flag is set, throw a DBQueryError.
544 * @param string $error
547 * @param string $fname
548 * @param bool $tempIgnore
549 * @throws DBQueryError
551 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false );
554 * Free a result object returned by query() or select(). It's usually not
555 * necessary to call this, just use unset() or let the variable holding
556 * the result object go out of scope.
558 * @param mixed $res A SQL result
560 public function freeResult( $res );
563 * A SELECT wrapper which returns a single field from a single result row.
565 * Usually throws a DBQueryError on failure. If errors are explicitly
566 * ignored, returns false on failure.
568 * If no result rows are returned from the query, false is returned.
570 * @param string|array $table Table name. See IDatabase::select() for details.
571 * @param string $var The field name to select. This must be a valid SQL
572 * fragment: do not use unvalidated user input.
573 * @param string|array $cond The condition array. See IDatabase::select() for details.
574 * @param string $fname The function name of the caller.
575 * @param string|array $options The query options. See IDatabase::select() for details.
576 * @param string|array $join_conds The query join conditions. See IDatabase::select() for details.
578 * @return mixed The value from the field
581 public function selectField(
582 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
586 * A SELECT wrapper which returns a list of single field values from result rows.
588 * Usually throws a DBQueryError on failure. If errors are explicitly
589 * ignored, returns false on failure.
591 * If no result rows are returned from the query, false is returned.
593 * @param string|array $table Table name. See IDatabase::select() for details.
594 * @param string $var The field name to select. This must be a valid SQL
595 * fragment: do not use unvalidated user input.
596 * @param string|array $cond The condition array. See IDatabase::select() for details.
597 * @param string $fname The function name of the caller.
598 * @param string|array $options The query options. See IDatabase::select() for details.
599 * @param string|array $join_conds The query join conditions. See IDatabase::select() for details.
601 * @return array The values from the field
605 public function selectFieldValues(
606 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
610 * Execute a SELECT query constructed using the various parameters provided.
611 * See below for full details of the parameters.
613 * @param string|array $table Table name
614 * @param string|array $vars Field names
615 * @param string|array $conds Conditions
616 * @param string $fname Caller function name
617 * @param array $options Query options
618 * @param array $join_conds Join conditions
621 * @param string|array $table
623 * May be either an array of table names, or a single string holding a table
624 * name. If an array is given, table aliases can be specified, for example:
628 * This includes the user table in the query, with the alias "a" available
629 * for use in field names (e.g. a.user_name).
631 * Joins using parentheses for grouping (since MediaWiki 1.31) may be
632 * constructed using nested arrays. For example,
634 * [ 'tableA', 'nestedB' => [ 'tableB', 'b2' => 'tableB2' ] ]
636 * along with `$join_conds` like
638 * [ 'b2' => [ 'JOIN', 'b_id = b2_id' ], 'nestedB' => [ 'LEFT JOIN', 'b_a = a_id' ] ]
640 * will produce SQL something like
642 * FROM tableA LEFT JOIN (tableB JOIN tableB2 AS b2 ON (b_id = b2_id)) ON (b_a = a_id)
644 * All of the table names given here are automatically run through
645 * Database::tableName(), which causes the table prefix (if any) to be
646 * added, and various other table name mappings to be performed.
648 * Do not use untrusted user input as a table name. Alias names should
649 * not have characters outside of the Basic multilingual plane.
651 * @param string|array $vars
653 * May be either a field name or an array of field names. The field names
654 * can be complete fragments of SQL, for direct inclusion into the SELECT
655 * query. If an array is given, field aliases can be specified, for example:
657 * [ 'maxrev' => 'MAX(rev_id)' ]
659 * This includes an expression with the alias "maxrev" in the query.
661 * If an expression is given, care must be taken to ensure that it is
664 * Untrusted user input must not be passed to this parameter.
666 * @param string|array $conds
668 * May be either a string containing a single condition, or an array of
669 * conditions. If an array is given, the conditions constructed from each
670 * element are combined with AND.
672 * Array elements may take one of two forms:
674 * - Elements with a numeric key are interpreted as raw SQL fragments.
675 * - Elements with a string key are interpreted as equality conditions,
676 * where the key is the field name.
677 * - If the value of such an array element is a scalar (such as a
678 * string), it will be treated as data and thus quoted appropriately.
679 * If it is null, an IS NULL clause will be added.
680 * - If the value is an array, an IN (...) clause will be constructed
681 * from its non-null elements, and an IS NULL clause will be added
682 * if null is present, such that the field may match any of the
683 * elements in the array. The non-null elements will be quoted.
685 * Note that expressions are often DBMS-dependent in their syntax.
686 * DBMS-independent wrappers are provided for constructing several types of
687 * expression commonly used in condition queries. See:
688 * - IDatabase::buildLike()
689 * - IDatabase::conditional()
691 * Untrusted user input is safe in the values of string keys, however untrusted
692 * input must not be used in the array key names or in the values of numeric keys.
693 * Escaping of untrusted input used in values of numeric keys should be done via
694 * IDatabase::addQuotes()
696 * @param string|array $options
698 * Optional: Array of query options. Boolean options are specified by
699 * including them in the array as a string value with a numeric key, for
704 * The supported options are:
706 * - OFFSET: Skip this many rows at the start of the result set. OFFSET
707 * with LIMIT can theoretically be used for paging through a result set,
708 * but this is discouraged for performance reasons.
710 * - LIMIT: Integer: return at most this many rows. The rows are sorted
711 * and then the first rows are taken until the limit is reached. LIMIT
712 * is applied to a result set after OFFSET.
714 * - FOR UPDATE: Boolean: lock the returned rows so that they can't be
715 * changed until the next COMMIT.
717 * - DISTINCT: Boolean: return only unique result rows.
719 * - GROUP BY: May be either an SQL fragment string naming a field or
720 * expression to group by, or an array of such SQL fragments.
722 * - HAVING: May be either an string containing a HAVING clause or an array of
723 * conditions building the HAVING clause. If an array is given, the conditions
724 * constructed from each element are combined with AND.
726 * - ORDER BY: May be either an SQL fragment giving a field name or
727 * expression to order by, or an array of such SQL fragments.
729 * - USE INDEX: This may be either a string giving the index name to use
730 * for the query, or an array. If it is an associative array, each key
731 * gives the table name (or alias), each value gives the index name to
732 * use for that table. All strings are SQL fragments and so should be
733 * validated by the caller.
735 * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run,
738 * And also the following boolean MySQL extensions, see the MySQL manual
741 * - LOCK IN SHARE MODE
745 * - SQL_BUFFER_RESULT
747 * - SQL_CALC_FOUND_ROWS
752 * @param string|array $join_conds
754 * Optional associative array of table-specific join conditions. In the
755 * most common case, this is unnecessary, since the join condition can be
756 * in $conds. However, it is useful for doing a LEFT JOIN.
758 * The key of the array contains the table name or alias. The value is an
759 * array with two elements, numbered 0 and 1. The first gives the type of
760 * join, the second is the same as the $conds parameter. Thus it can be
761 * an SQL fragment, or an array where the string keys are equality and the
762 * numeric keys are SQL fragments all AND'd together. For example:
764 * [ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]
766 * @return IResultWrapper Resulting rows
769 public function select(
770 $table, $vars, $conds = '', $fname = __METHOD__
,
771 $options = [], $join_conds = []
775 * The equivalent of IDatabase::select() except that the constructed SQL
776 * is returned, instead of being immediately executed. This can be useful for
777 * doing UNION queries, where the SQL text of each query is needed. In general,
778 * however, callers outside of Database classes should just use select().
780 * @param string|array $table Table name
781 * @param string|array $vars Field names
782 * @param string|array $conds Conditions
783 * @param string $fname Caller function name
784 * @param string|array $options Query options
785 * @param string|array $join_conds Join conditions
787 * @return string SQL query string.
788 * @see IDatabase::select()
790 public function selectSQLText(
791 $table, $vars, $conds = '', $fname = __METHOD__
,
792 $options = [], $join_conds = []
796 * Single row SELECT wrapper. Equivalent to IDatabase::select(), except
797 * that a single row object is returned. If the query returns no rows,
800 * @param string|array $table Table name
801 * @param string|array $vars Field names
802 * @param array $conds Conditions
803 * @param string $fname Caller function name
804 * @param string|array $options Query options
805 * @param array|string $join_conds Join conditions
807 * @return stdClass|bool
810 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
811 $options = [], $join_conds = []
815 * Estimate the number of rows in dataset
817 * MySQL allows you to estimate the number of rows that would be returned
818 * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using
819 * index cardinality statistics, and is notoriously inaccurate, especially
820 * when large numbers of rows have recently been added or deleted.
822 * For DBMSs that don't support fast result size estimation, this function
823 * will actually perform the SELECT COUNT(*).
825 * Takes the same arguments as IDatabase::select().
827 * @param string $table Table name
828 * @param string $vars Unused
829 * @param array|string $conds Filters on the table
830 * @param string $fname Function name for profiling
831 * @param array $options Options for select
832 * @param array|string $join_conds Join conditions
833 * @return int Row count
836 public function estimateRowCount(
837 $table, $vars = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
841 * Get the number of rows in dataset
843 * This is useful when trying to do COUNT(*) but with a LIMIT for performance.
845 * Takes the same arguments as IDatabase::select().
847 * @since 1.27 Added $join_conds parameter
849 * @param array|string $tables Table names
850 * @param string $vars Unused
851 * @param array|string $conds Filters on the table
852 * @param string $fname Function name for profiling
853 * @param array $options Options for select
854 * @param array $join_conds Join conditions (since 1.27)
855 * @return int Row count
858 public function selectRowCount(
859 $tables, $vars = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
863 * Determines whether a field exists in a table
865 * @param string $table Table name
866 * @param string $field Filed to check on that table
867 * @param string $fname Calling function name (optional)
868 * @return bool Whether $table has filed $field
871 public function fieldExists( $table, $field, $fname = __METHOD__
);
874 * Determines whether an index exists
875 * Usually throws a DBQueryError on failure
876 * If errors are explicitly ignored, returns NULL on failure
878 * @param string $table
879 * @param string $index
880 * @param string $fname
884 public function indexExists( $table, $index, $fname = __METHOD__
);
887 * Query whether a given table exists
889 * @param string $table
890 * @param string $fname
894 public function tableExists( $table, $fname = __METHOD__
);
897 * Determines if a given index is unique
899 * @param string $table
900 * @param string $index
904 public function indexUnique( $table, $index );
907 * INSERT wrapper, inserts an array into a table.
911 * - A single associative array. The array keys are the field names, and
912 * the values are the values to insert. The values are treated as data
913 * and will be quoted appropriately. If NULL is inserted, this will be
914 * converted to a database NULL.
915 * - An array with numeric keys, holding a list of associative arrays.
916 * This causes a multi-row INSERT on DBMSs that support it. The keys in
917 * each subarray must be identical to each other, and in the same order.
919 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
922 * $options is an array of options, with boolean options encoded as values
923 * with numeric keys, in the same style as $options in
924 * IDatabase::select(). Supported options are:
926 * - IGNORE: Boolean: if present, duplicate key errors are ignored, and
927 * any rows which cause duplicate key errors are not inserted. It's
928 * possible to determine how many rows were successfully inserted using
929 * IDatabase::affectedRows().
931 * @param string $table Table name. This will be passed through
932 * Database::tableName().
933 * @param array $a Array of rows to insert
934 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
935 * @param array $options Array of options
940 public function insert( $table, $a, $fname = __METHOD__
, $options = [] );
943 * UPDATE wrapper. Takes a condition array and a SET array.
945 * @param string $table Name of the table to UPDATE. This will be passed through
946 * Database::tableName().
947 * @param array $values An array of values to SET. For each array element,
948 * the key gives the field name, and the value gives the data to set
949 * that field to. The data will be quoted by IDatabase::addQuotes().
950 * Values with integer keys form unquoted SET statements, which can be used for
951 * things like "field = field + 1" or similar computed values.
952 * @param array $conds An array of conditions (WHERE). See
953 * IDatabase::select() for the details of the format of condition
954 * arrays. Use '*' to update all rows.
955 * @param string $fname The function name of the caller (from __METHOD__),
956 * for logging and profiling.
957 * @param array $options An array of UPDATE options, can be:
958 * - IGNORE: Ignore unique key conflicts
959 * - LOW_PRIORITY: MySQL-specific, see MySQL manual.
963 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] );
966 * Makes an encoded list of strings from an array
968 * These can be used to make conjunctions or disjunctions on SQL condition strings
969 * derived from an array (see IDatabase::select() $conds documentation).
973 * $sql = $db->makeList( [
975 * $db->makeList( [ 'rev_minor' => 1, 'rev_len' < 500 ], $db::LIST_OR ] )
976 * ], $db::LIST_AND );
978 * This would set $sql to "rev_page = '$id' AND (rev_minor = '1' OR rev_len < '500')"
980 * @param array $a Containing the data
981 * @param int $mode IDatabase class constant:
982 * - IDatabase::LIST_COMMA: Comma separated, no field names
983 * - IDatabase::LIST_AND: ANDed WHERE clause (without the WHERE).
984 * - IDatabase::LIST_OR: ORed WHERE clause (without the WHERE)
985 * - IDatabase::LIST_SET: Comma separated with field names, like a SET clause
986 * - IDatabase::LIST_NAMES: Comma separated field names
990 public function makeList( $a, $mode = self
::LIST_COMMA
);
993 * Build a partial where clause from a 2-d array such as used for LinkBatch.
994 * The keys on each level may be either integers or strings.
996 * @param array $data Organized as 2-d
997 * [ baseKeyVal => [ subKeyVal => [ignored], ... ], ... ]
998 * @param string $baseKey Field name to match the base-level keys to (eg 'pl_namespace')
999 * @param string $subKey Field name to match the sub-level keys to (eg 'pl_title')
1000 * @return string|bool SQL fragment, or false if no items in array
1002 public function makeWhereFrom2d( $data, $baseKey, $subKey );
1005 * Return aggregated value alias
1007 * @param array $valuedata
1008 * @param string $valuename
1012 public function aggregateValue( $valuedata, $valuename = 'value' );
1015 * @param string $field
1018 public function bitNot( $field );
1021 * @param string $fieldLeft
1022 * @param string $fieldRight
1025 public function bitAnd( $fieldLeft, $fieldRight );
1028 * @param string $fieldLeft
1029 * @param string $fieldRight
1032 public function bitOr( $fieldLeft, $fieldRight );
1035 * Build a concatenation list to feed into a SQL query
1036 * @param array $stringList List of raw SQL expressions; caller is
1037 * responsible for any quoting
1040 public function buildConcat( $stringList );
1043 * Build a GROUP_CONCAT or equivalent statement for a query.
1045 * This is useful for combining a field for several rows into a single string.
1046 * NULL values will not appear in the output, duplicated values will appear,
1047 * and the resulting delimiter-separated values have no defined sort order.
1048 * Code using the results may need to use the PHP unique() or sort() methods.
1050 * @param string $delim Glue to bind the results together
1051 * @param string|array $table Table name
1052 * @param string $field Field name
1053 * @param string|array $conds Conditions
1054 * @param string|array $join_conds Join conditions
1055 * @return string SQL text
1058 public function buildGroupConcatField(
1059 $delim, $table, $field, $conds = '', $join_conds = []
1063 * Build a SUBSTRING function.
1065 * Behavior for non-ASCII values is undefined.
1067 * @param string $input Field name
1068 * @param int $startPosition Positive integer
1069 * @param int|null $length Non-negative integer length or null for no limit
1070 * @throws InvalidArgumentException
1071 * @return string SQL text
1074 public function buildSubString( $input, $startPosition, $length = null );
1077 * @param string $field Field or column to cast
1081 public function buildStringCast( $field );
1084 * @param string $field Field or column to cast
1088 public function buildIntegerCast( $field );
1091 * Returns true if DBs are assumed to be on potentially different servers
1093 * In systems like mysql/mariadb, different databases can easily be referenced on a single
1094 * connection merely by name, even in a single query via JOIN. On the other hand, Postgres
1095 * treats databases as fully separate, only allowing mechanisms like postgres_fdw to
1096 * effectively "mount" foreign DBs. This is true even among DBs on the same server.
1101 public function databasesAreIndependent();
1104 * Change the current database
1107 * @return bool Success or failure
1108 * @throws DBConnectionError If databasesAreIndependent() is true and an error occurs
1110 public function selectDB( $db );
1113 * Get the current DB name
1116 public function getDBname();
1119 * Get the server hostname or IP address
1122 public function getServer();
1125 * Adds quotes and backslashes.
1127 * @param string|int|null|bool|Blob $s
1128 * @return string|int
1130 public function addQuotes( $s );
1133 * LIKE statement wrapper, receives a variable-length argument list with
1134 * parts of pattern to match containing either string literals that will be
1135 * escaped or tokens returned by anyChar() or anyString(). Alternatively,
1136 * the function could be provided with an array of aforementioned
1139 * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns
1140 * a LIKE clause that searches for subpages of 'My page title'.
1142 * $pattern = [ 'My_page_title/', $dbr->anyString() ];
1143 * $query .= $dbr->buildLike( $pattern );
1146 * @return string Fully built LIKE statement
1148 public function buildLike();
1151 * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
1155 public function anyChar();
1158 * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
1162 public function anyString();
1165 * Deprecated method, calls should be removed.
1167 * This was formerly used for PostgreSQL and Oracle to handle
1168 * self::insertId() auto-incrementing fields. It is no longer necessary
1169 * since DatabasePostgres::insertId() has been reimplemented using
1170 * `lastval()` and Oracle has been reimplemented using triggers.
1172 * Implementations should return null if inserting `NULL` into an
1173 * auto-incrementing field works, otherwise it should return an instance of
1174 * NextSequenceValue and filter it on calls to relevant methods.
1176 * @deprecated since 1.30, no longer needed
1177 * @param string $seqName
1178 * @return null|NextSequenceValue
1180 public function nextSequenceValue( $seqName );
1183 * REPLACE query wrapper.
1185 * REPLACE is a very handy MySQL extension, which functions like an INSERT
1186 * except that when there is a duplicate key error, the old row is deleted
1187 * and the new row is inserted in its place.
1189 * We simulate this with standard SQL with a DELETE followed by INSERT. To
1190 * perform the delete, we need to know what the unique indexes are so that
1191 * we know how to find the conflicting rows.
1193 * It may be more efficient to leave off unique indexes which are unlikely
1194 * to collide. However if you do this, you run the risk of encountering
1195 * errors which wouldn't have occurred in MySQL.
1197 * @param string $table The table to replace the row(s) in.
1198 * @param array $uniqueIndexes Is an array of indexes. Each element may be either
1199 * a field name or an array of field names
1200 * @param array $rows Can be either a single row to insert, or multiple rows,
1201 * in the same format as for IDatabase::insert()
1202 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1205 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
);
1208 * INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
1210 * This updates any conflicting rows (according to the unique indexes) using
1211 * the provided SET clause and inserts any remaining (non-conflicted) rows.
1213 * $rows may be either:
1214 * - A single associative array. The array keys are the field names, and
1215 * the values are the values to insert. The values are treated as data
1216 * and will be quoted appropriately. If NULL is inserted, this will be
1217 * converted to a database NULL.
1218 * - An array with numeric keys, holding a list of associative arrays.
1219 * This causes a multi-row INSERT on DBMSs that support it. The keys in
1220 * each subarray must be identical to each other, and in the same order.
1222 * It may be more efficient to leave off unique indexes which are unlikely
1223 * to collide. However if you do this, you run the risk of encountering
1224 * errors which wouldn't have occurred in MySQL.
1226 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
1231 * @param string $table Table name. This will be passed through Database::tableName().
1232 * @param array $rows A single row or list of rows to insert
1233 * @param array $uniqueIndexes List of single field names or field name tuples
1234 * @param array $set An array of values to SET. For each array element, the
1235 * key gives the field name, and the value gives the data to set that
1236 * field to. The data will be quoted by IDatabase::addQuotes().
1237 * Values with integer keys form unquoted SET statements, which can be used for
1238 * things like "field = field + 1" or similar computed values.
1239 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1243 public function upsert(
1244 $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
1248 * DELETE where the condition is a join.
1250 * MySQL overrides this to use a multi-table DELETE syntax, in other databases
1251 * we use sub-selects
1253 * For safety, an empty $conds will not delete everything. If you want to
1254 * delete all rows where the join condition matches, set $conds='*'.
1256 * DO NOT put the join condition in $conds.
1258 * @param string $delTable The table to delete from.
1259 * @param string $joinTable The other table.
1260 * @param string $delVar The variable to join on, in the first table.
1261 * @param string $joinVar The variable to join on, in the second table.
1262 * @param array $conds Condition array of field names mapped to variables,
1263 * ANDed together in the WHERE clause
1264 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1267 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
1272 * DELETE query wrapper.
1274 * @param string $table Table name
1275 * @param string|array $conds Array of conditions. See $conds in IDatabase::select()
1276 * for the format. Use $conds == "*" to delete all rows
1277 * @param string $fname Name of the calling function
1278 * @throws DBUnexpectedError
1279 * @return bool|IResultWrapper
1282 public function delete( $table, $conds, $fname = __METHOD__
);
1285 * INSERT SELECT wrapper. Takes data from a SELECT query and inserts it
1286 * into another table.
1288 * @warning If the insert will use an auto-increment or sequence to
1289 * determine the value of a column, this may break replication on
1290 * databases using statement-based replication if the SELECT is not
1291 * deterministically ordered.
1293 * @param string $destTable The table name to insert into
1294 * @param string|array $srcTable May be either a table name, or an array of table names
1295 * to include in a join.
1297 * @param array $varMap Must be an associative array of the form
1298 * [ 'dest1' => 'source1', ... ]. Source items may be literals
1299 * rather than field names, but strings should be quoted with
1300 * IDatabase::addQuotes()
1302 * @param array $conds Condition array. See $conds in IDatabase::select() for
1303 * the details of the format of condition arrays. May be "*" to copy the
1306 * @param string $fname The function name of the caller, from __METHOD__
1308 * @param array $insertOptions Options for the INSERT part of the query, see
1309 * IDatabase::insert() for details. Also, one additional option is
1310 * available: pass 'NO_AUTO_COLUMNS' to hint that the query does not use
1311 * an auto-increment or sequence to determine any column values.
1312 * @param array $selectOptions Options for the SELECT part of the query, see
1313 * IDatabase::select() for details.
1314 * @param array $selectJoinConds Join conditions for the SELECT part of the query, see
1315 * IDatabase::select() for details.
1320 public function insertSelect( $destTable, $srcTable, $varMap, $conds,
1321 $fname = __METHOD__
,
1322 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
1326 * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
1327 * within the UNION construct.
1330 public function unionSupportsOrderAndLimit();
1333 * Construct a UNION query
1334 * This is used for providing overload point for other DB abstractions
1335 * not compatible with the MySQL syntax.
1336 * @param array $sqls SQL statements to combine
1337 * @param bool $all Use UNION ALL
1338 * @return string SQL fragment
1340 public function unionQueries( $sqls, $all );
1343 * Construct a UNION query for permutations of conditions
1345 * Databases sometimes have trouble with queries that have multiple values
1346 * for multiple condition parameters combined with limits and ordering.
1347 * This method constructs queries for the Cartesian product of the
1348 * conditions and unions them all together.
1350 * @see IDatabase::select()
1352 * @param string|array $table Table name
1353 * @param string|array $vars Field names
1354 * @param array $permute_conds Conditions for the Cartesian product. Keys
1355 * are field names, values are arrays of the possible values for that
1357 * @param string|array $extra_conds Additional conditions to include in the
1359 * @param string $fname Caller function name
1360 * @param string|array $options Query options. In addition to the options
1361 * recognized by IDatabase::select(), the following may be used:
1362 * - NOTALL: Set to use UNION instead of UNION ALL.
1363 * - INNER ORDER BY: If specified and supported, subqueries will use this
1364 * instead of ORDER BY.
1365 * @param string|array $join_conds Join conditions
1366 * @return string SQL query string.
1368 public function unionConditionPermutations(
1369 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__
,
1370 $options = [], $join_conds = []
1374 * Returns an SQL expression for a simple conditional. This doesn't need
1375 * to be overridden unless CASE isn't supported in your DBMS.
1377 * @param string|array $cond SQL expression which will result in a boolean value
1378 * @param string $trueVal SQL expression to return if true
1379 * @param string $falseVal SQL expression to return if false
1380 * @return string SQL fragment
1382 public function conditional( $cond, $trueVal, $falseVal );
1385 * Returns a command for str_replace function in SQL query.
1386 * Uses REPLACE() in MySQL
1388 * @param string $orig Column to modify
1389 * @param string $old Column to seek
1390 * @param string $new Column to replace with
1394 public function strreplace( $orig, $old, $new );
1397 * Determines how long the server has been up
1402 public function getServerUptime();
1405 * Determines if the last failure was due to a deadlock
1407 * Note that during a deadlock, the prior transaction will have been lost
1411 public function wasDeadlock();
1414 * Determines if the last failure was due to a lock timeout
1416 * Note that during a lock wait timeout, the prior transaction will have been lost
1420 public function wasLockTimeout();
1423 * Determines if the last query error was due to a dropped connection
1425 * Note that during a connection loss, the prior transaction will have been lost
1430 public function wasConnectionLoss();
1433 * Determines if the last failure was due to the database being read-only.
1437 public function wasReadOnlyError();
1440 * Determines if the last query error was due to something outside of the query itself
1442 * Note that the transaction may have been lost, discarding prior writes and results
1446 public function wasErrorReissuable();
1449 * Wait for the replica DB to catch up to a given master position
1451 * @param DBMasterPos $pos
1452 * @param int $timeout The maximum number of seconds to wait for synchronisation
1453 * @return int|null Zero if the replica DB was past that position already,
1454 * greater than zero if we waited for some period of time, less than
1455 * zero if it timed out, and null on error
1458 public function masterPosWait( DBMasterPos
$pos, $timeout );
1461 * Get the replication position of this replica DB
1463 * @return DBMasterPos|bool False if this is not a replica DB
1466 public function getReplicaPos();
1469 * Get the position of this master
1471 * @return DBMasterPos|bool False if this is not a master
1474 public function getMasterPos();
1477 * @return bool Whether the DB is marked as read-only server-side
1480 public function serverIsReadOnly();
1483 * Run a callback as soon as the current transaction commits or rolls back.
1484 * An error is thrown if no transaction is pending. Queries in the function will run in
1485 * AUTO-COMMIT mode unless there are begin() calls. Callbacks must commit any transactions
1488 * This is useful for combining cooperative locks and DB transactions.
1490 * The callback takes one argument:
1491 * - How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK)
1493 * @param callable $callback
1494 * @param string $fname Caller name
1498 public function onTransactionResolution( callable
$callback, $fname = __METHOD__
);
1501 * Run a callback as soon as there is no transaction pending.
1502 * If there is a transaction and it is rolled back, then the callback is cancelled.
1503 * Queries in the function will run in AUTO-COMMIT mode unless there are begin() calls.
1504 * Callbacks must commit any transactions that they begin.
1506 * This is useful for updates to different systems or when separate transactions are needed.
1507 * For example, one might want to enqueue jobs into a system outside the database, but only
1508 * after the database is updated so that the jobs will see the data when they actually run.
1509 * It can also be used for updates that easily cause deadlocks if locks are held too long.
1511 * Updates will execute in the order they were enqueued.
1513 * The callback takes one argument:
1514 * - How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_IDLE)
1516 * @param callable $callback
1517 * @param string $fname Caller name
1520 public function onTransactionIdle( callable
$callback, $fname = __METHOD__
);
1523 * Run a callback before the current transaction commits or now if there is none.
1524 * If there is a transaction and it is rolled back, then the callback is cancelled.
1525 * Callbacks must not start nor commit any transactions. If no transaction is active,
1526 * then a transaction will wrap the callback.
1528 * This is useful for updates that easily cause deadlocks if locks are held too long
1529 * but where atomicity is strongly desired for these updates and some related updates.
1531 * Updates will execute in the order they were enqueued.
1533 * @param callable $callback
1534 * @param string $fname Caller name
1537 public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
);
1540 * Run a callback each time any transaction commits or rolls back
1542 * The callback takes two arguments:
1543 * - IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK
1544 * - This IDatabase object
1545 * Callbacks must commit any transactions that they begin.
1547 * Registering a callback here will not affect writesOrCallbacks() pending
1549 * @param string $name Callback name
1550 * @param callable|null $callback Use null to unset a listener
1554 public function setTransactionListener( $name, callable
$callback = null );
1557 * Begin an atomic section of statements
1559 * If a transaction has been started already, just keep track of the given
1560 * section name to make sure the transaction is not committed pre-maturely.
1561 * This function can be used in layers (with sub-sections), so use a stack
1562 * to keep track of the different atomic sections. If there is no transaction,
1563 * start one implicitly.
1565 * The goal of this function is to create an atomic section of SQL queries
1566 * without having to start a new transaction if it already exists.
1568 * All atomic levels *must* be explicitly closed using IDatabase::endAtomic(),
1569 * and any database transactions cannot be began or committed until all atomic
1570 * levels are closed. There is no such thing as implicitly opening or closing
1571 * an atomic section.
1574 * @param string $fname
1577 public function startAtomic( $fname = __METHOD__
);
1580 * Ends an atomic section of SQL statements
1582 * Ends the next section of atomic SQL statements and commits the transaction
1586 * @see IDatabase::startAtomic
1587 * @param string $fname
1590 public function endAtomic( $fname = __METHOD__
);
1593 * Run a callback to do an atomic set of updates for this database
1595 * The $callback takes the following arguments:
1596 * - This database object
1597 * - The value of $fname
1599 * If any exception occurs in the callback, then rollback() will be called and the error will
1600 * be re-thrown. It may also be that the rollback itself fails with an exception before then.
1601 * In any case, such errors are expected to terminate the request, without any outside caller
1602 * attempting to catch errors and commit anyway. Note that any rollback undoes all prior
1603 * atomic section and uncommitted updates, which trashes the current request, requiring an
1604 * error to be displayed.
1606 * This can be an alternative to explicit startAtomic()/endAtomic() calls.
1608 * @see Database::startAtomic
1609 * @see Database::endAtomic
1611 * @param string $fname Caller name (usually __METHOD__)
1612 * @param callable $callback Callback that issues DB updates
1613 * @return mixed $res Result of the callback (since 1.28)
1615 * @throws RuntimeException
1616 * @throws UnexpectedValueException
1619 public function doAtomicSection( $fname, callable
$callback );
1622 * Begin a transaction. If a transaction is already in progress,
1623 * that transaction will be committed before the new transaction is started.
1625 * Only call this from code with outer transcation scope.
1626 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1627 * Nesting of transactions is not supported.
1629 * Note that when the DBO_TRX flag is set (which is usually the case for web
1630 * requests, but not for maintenance scripts), any previous database query
1631 * will have started a transaction automatically.
1633 * Nesting of transactions is not supported. Attempts to nest transactions
1634 * will cause a warning, unless the current transaction was started
1635 * automatically because of the DBO_TRX flag.
1637 * @param string $fname Calling function name
1638 * @param string $mode A situationally valid IDatabase::TRANSACTION_* constant [optional]
1641 public function begin( $fname = __METHOD__
, $mode = self
::TRANSACTION_EXPLICIT
);
1644 * Commits a transaction previously started using begin().
1645 * If no transaction is in progress, a warning is issued.
1647 * Only call this from code with outer transcation scope.
1648 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1649 * Nesting of transactions is not supported.
1651 * @param string $fname
1652 * @param string $flush Flush flag, set to situationally valid IDatabase::FLUSHING_*
1653 * constant to disable warnings about explicitly committing implicit transactions,
1654 * or calling commit when no transaction is in progress.
1656 * This will trigger an exception if there is an ongoing explicit transaction.
1658 * Only set the flush flag if you are sure that these warnings are not applicable,
1659 * and no explicit transactions are open.
1663 public function commit( $fname = __METHOD__
, $flush = '' );
1666 * Rollback a transaction previously started using begin().
1667 * If no transaction is in progress, a warning is issued.
1669 * Only call this from code with outer transcation scope.
1670 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1671 * Nesting of transactions is not supported. If a serious unexpected error occurs,
1672 * throwing an Exception is preferrable, using a pre-installed error handler to trigger
1673 * rollback (in any case, failure to issue COMMIT will cause rollback server-side).
1675 * Query, connection, and onTransaction* callback errors will be suppressed and logged.
1677 * @param string $fname Calling function name
1678 * @param string $flush Flush flag, set to a situationally valid IDatabase::FLUSHING_*
1679 * constant to disable warnings about calling rollback when no transaction is in
1680 * progress. This will silently break any ongoing explicit transaction. Only set the
1681 * flush flag if you are sure that it is safe to ignore these warnings in your context.
1683 * @since 1.23 Added $flush parameter
1685 public function rollback( $fname = __METHOD__
, $flush = '' );
1688 * Commit any transaction but error out if writes or callbacks are pending
1690 * This is intended for clearing out REPEATABLE-READ snapshots so that callers can
1691 * see a new point-in-time of the database. This is useful when one of many transaction
1692 * rounds finished and significant time will pass in the script's lifetime. It is also
1693 * useful to call on a replica DB after waiting on replication to catch up to the master.
1695 * @param string $fname Calling function name
1699 public function flushSnapshot( $fname = __METHOD__
);
1702 * List all tables on the database
1704 * @param string $prefix Only show tables with this prefix, e.g. mw_
1705 * @param string $fname Calling function name
1709 public function listTables( $prefix = null, $fname = __METHOD__
);
1712 * Convert a timestamp in one of the formats accepted by wfTimestamp()
1713 * to the format used for inserting into timestamp fields in this DBMS.
1715 * The result is unquoted, and needs to be passed through addQuotes()
1716 * before it can be included in raw SQL.
1718 * @param string|int $ts
1722 public function timestamp( $ts = 0 );
1725 * Convert a timestamp in one of the formats accepted by wfTimestamp()
1726 * to the format used for inserting into timestamp fields in this DBMS. If
1727 * NULL is input, it is passed through, allowing NULL values to be inserted
1728 * into timestamp fields.
1730 * The result is unquoted, and needs to be passed through addQuotes()
1731 * before it can be included in raw SQL.
1733 * @param string|int $ts
1737 public function timestampOrNull( $ts = null );
1740 * Ping the server and try to reconnect if it there is no connection
1742 * @param float|null &$rtt Value to store the estimated RTT [optional]
1743 * @return bool Success or failure
1745 public function ping( &$rtt = null );
1748 * Get replica DB lag. Currently supported only by MySQL.
1750 * Note that this function will generate a fatal error on many
1751 * installations. Most callers should use LoadBalancer::safeGetLag()
1754 * @return int|bool Database replication lag in seconds or false on error
1757 public function getLag();
1760 * Get the replica DB lag when the current transaction started
1761 * or a general lag estimate if not transaction is active
1763 * This is useful when transactions might use snapshot isolation
1764 * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
1765 * is this lag plus transaction duration. If they don't, it is still
1766 * safe to be pessimistic. In AUTO-COMMIT mode, this still gives an
1767 * indication of the staleness of subsequent reads.
1769 * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
1773 public function getSessionLagStatus();
1776 * Return the maximum number of items allowed in a list, or 0 for unlimited.
1780 public function maxListLen();
1783 * Some DBMSs have a special format for inserting into blob fields, they
1784 * don't allow simple quoted strings to be inserted. To insert into such
1785 * a field, pass the data through this function before passing it to
1786 * IDatabase::insert().
1789 * @return string|Blob
1791 public function encodeBlob( $b );
1794 * Some DBMSs return a special placeholder object representing blob fields
1795 * in result objects. Pass the object through this function to return the
1798 * @param string|Blob $b
1801 public function decodeBlob( $b );
1804 * Override database's default behavior. $options include:
1805 * 'connTimeout' : Set the connection timeout value in seconds.
1806 * May be useful for very long batch queries such as
1807 * full-wiki dumps, where a single query reads out over
1810 * @param array $options
1814 public function setSessionOptions( array $options );
1817 * Set variables to be used in sourceFile/sourceStream, in preference to the
1818 * ones in $GLOBALS. If an array is set here, $GLOBALS will not be used at
1819 * all. If it's set to false, $GLOBALS will be used.
1821 * @param bool|array $vars Mapping variable name to value.
1823 public function setSchemaVars( $vars );
1826 * Check to see if a named lock is not locked by any thread (non-blocking)
1828 * @param string $lockName Name of lock to poll
1829 * @param string $method Name of method calling us
1834 public function lockIsFree( $lockName, $method );
1837 * Acquire a named lock
1839 * Named locks are not related to transactions
1841 * @param string $lockName Name of lock to aquire
1842 * @param string $method Name of the calling method
1843 * @param int $timeout Acquisition timeout in seconds
1847 public function lock( $lockName, $method, $timeout = 5 );
1852 * Named locks are not related to transactions
1854 * @param string $lockName Name of lock to release
1855 * @param string $method Name of the calling method
1857 * @return int Returns 1 if the lock was released, 0 if the lock was not established
1858 * by this thread (in which case the lock is not released), and NULL if the named lock
1863 public function unlock( $lockName, $method );
1866 * Acquire a named lock, flush any transaction, and return an RAII style unlocker object
1868 * Only call this from outer transcation scope and when only one DB will be affected.
1869 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1871 * This is suitiable for transactions that need to be serialized using cooperative locks,
1872 * where each transaction can see each others' changes. Any transaction is flushed to clear
1873 * out stale REPEATABLE-READ snapshot data. Once the returned object falls out of PHP scope,
1874 * the lock will be released unless a transaction is active. If one is active, then the lock
1875 * will be released when it either commits or rolls back.
1877 * If the lock acquisition failed, then no transaction flush happens, and null is returned.
1879 * @param string $lockKey Name of lock to release
1880 * @param string $fname Name of the calling method
1881 * @param int $timeout Acquisition timeout in seconds
1882 * @return ScopedCallback|null
1886 public function getScopedLockAndFlush( $lockKey, $fname, $timeout );
1889 * Check to see if a named lock used by lock() use blocking queues
1894 public function namedLocksEnqueue();
1897 * Find out when 'infinity' is. Most DBMSes support this. This is a special
1898 * keyword for timestamps in PostgreSQL, and works with CHAR(14) as well
1899 * because "i" sorts after all numbers.
1903 public function getInfinity();
1906 * Encode an expiry time into the DBMS dependent format
1908 * @param string $expiry Timestamp for expiry, or the 'infinity' string
1911 public function encodeExpiry( $expiry );
1914 * Decode an expiry time into a DBMS independent format
1916 * @param string $expiry DB timestamp field value for expiry
1917 * @param int $format TS_* constant, defaults to TS_MW
1920 public function decodeExpiry( $expiry, $format = TS_MW
);
1923 * Allow or deny "big selects" for this session only. This is done by setting
1924 * the sql_big_selects session variable.
1926 * This is a MySQL-specific feature.
1928 * @param bool|string $value True for allow, false for deny, or "default" to
1929 * restore the initial value
1931 public function setBigSelects( $value = true );
1934 * @return bool Whether this DB is read-only
1937 public function isReadOnly();
1940 * Make certain table names use their own database, schema, and table prefix
1941 * when passed into SQL queries pre-escaped and without a qualified database name
1943 * For example, "user" can be converted to "myschema.mydbname.user" for convenience.
1944 * Appearances like `user`, somedb.user, somedb.someschema.user will used literally.
1946 * Calling this twice will completely clear any old table aliases. Also, note that
1947 * callers are responsible for making sure the schemas and databases actually exist.
1949 * @param array[] $aliases Map of (table => (dbname, schema, prefix) map)
1952 public function setTableAliases( array $aliases );
1955 * Convert certain index names to alternative names before querying the DB
1957 * Note that this applies to indexes regardless of the table they belong to.
1959 * This can be employed when an index was renamed X => Y in code, but the new Y-named
1960 * indexes were not yet built on all DBs. After all the Y-named ones are added by the DBA,
1961 * the aliases can be removed, and then the old X-named indexes dropped.
1963 * @param string[] $aliases
1967 public function setIndexAliases( array $aliases );
1970 class_alias( IDatabase
::class, 'IDatabase' );