3 * @defgroup Database Database
5 * This file deals with database interface functions
6 * and query specifics/optimisations.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
26 use Wikimedia\ScopedCallback
;
27 use Wikimedia\Rdbms\Blob
;
28 use Wikimedia\Rdbms\LikeMatch
;
29 use Wikimedia\Rdbms\DBMasterPos
;
30 use Wikimedia\Rdbms\Field
;
31 use Wikimedia\Rdbms\IResultWrapper
;
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
209 public function implicitGroupby();
212 * Returns true if this database does an implicit order by when the column has an index
213 * For example: SELECT page_title FROM page LIMIT 1
217 public function implicitOrderby();
220 * Return the last query that went through IDatabase::query()
223 public function lastQuery();
226 * Returns true if the connection may have been used for write queries.
227 * Should return true if unsure.
231 public function doneWrites();
234 * Returns the last time the connection may have been used for write queries.
235 * Should return a timestamp if unsure.
237 * @return int|float UNIX timestamp or false
240 public function lastDoneWrites();
243 * @return bool Whether there is a transaction open with possible write queries
246 public function writesPending();
249 * Returns true if there is a transaction open with possible write
250 * queries or transaction pre-commit/idle callbacks waiting on it to finish.
251 * This does *not* count recurring callbacks, e.g. from setTransactionListener().
255 public function writesOrCallbacksPending();
258 * Get the time spend running write queries for this transaction
260 * High times could be due to scanning, updates, locking, and such
262 * @param string $type IDatabase::ESTIMATE_* constant [default: ESTIMATE_ALL]
263 * @return float|bool Returns false if not transaction is active
266 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
);
269 * Get the list of method names that did write queries for this transaction
274 public function pendingWriteCallers();
277 * Is a connection to the database open?
280 public function isOpen();
283 * Set a flag for this connection
285 * @param int $flag DBO_* constants from Defines.php:
286 * - DBO_DEBUG: output some debug info (same as debug())
287 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
288 * - DBO_TRX: automatically start transactions
289 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
290 * and removes it in command line mode
291 * - DBO_PERSISTENT: use persistant database connection
292 * @param string $remember IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]
294 public function setFlag( $flag, $remember = self
::REMEMBER_NOTHING
);
297 * Clear a flag for this connection
299 * @param int $flag DBO_* constants from Defines.php:
300 * - DBO_DEBUG: output some debug info (same as debug())
301 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
302 * - DBO_TRX: automatically start transactions
303 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
304 * and removes it in command line mode
305 * - DBO_PERSISTENT: use persistant database connection
306 * @param string $remember IDatabase::REMEMBER_* constant [default: REMEMBER_NOTHING]
308 public function clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
);
311 * Restore the flags to their prior state before the last setFlag/clearFlag call
313 * @param string $state IDatabase::RESTORE_* constant. [default: RESTORE_PRIOR]
316 public function restoreFlags( $state = self
::RESTORE_PRIOR
);
319 * Returns a boolean whether the flag $flag is set for this connection
321 * @param int $flag DBO_* constants from Defines.php:
322 * - DBO_DEBUG: output some debug info (same as debug())
323 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
324 * - DBO_TRX: automatically start transactions
325 * - DBO_PERSISTENT: use persistant database connection
328 public function getFlag( $flag );
333 public function getDomainID();
336 * Alias for getDomainID()
340 public function getWikiID();
343 * Get the type of the DBMS, as it appears in $wgDBtype.
347 public function getType();
350 * Open a connection to the database. Usually aborts on failure
352 * @param string $server Database server host
353 * @param string $user Database user name
354 * @param string $password Database user password
355 * @param string $dbName Database name
357 * @throws DBConnectionError
359 public function open( $server, $user, $password, $dbName );
362 * Fetch the next row from the given result object, in object form.
363 * Fields can be retrieved with $row->fieldname, with fields acting like
365 * If no more rows are available, false is returned.
367 * @param IResultWrapper|stdClass $res Object as returned from IDatabase::query(), etc.
368 * @return stdClass|bool
369 * @throws DBUnexpectedError Thrown if the database returns an error
371 public function fetchObject( $res );
374 * Fetch the next row from the given result object, in associative array
375 * form. Fields are retrieved with $row['fieldname'].
376 * If no more rows are available, false is returned.
378 * @param IResultWrapper $res Result object as returned from IDatabase::query(), etc.
380 * @throws DBUnexpectedError Thrown if the database returns an error
382 public function fetchRow( $res );
385 * Get the number of rows in a result object
387 * @param mixed $res A SQL result
390 public function numRows( $res );
393 * Get the number of fields in a result object
394 * @see https://secure.php.net/mysql_num_fields
396 * @param mixed $res A SQL result
399 public function numFields( $res );
402 * Get a field name in a result object
403 * @see https://secure.php.net/mysql_field_name
405 * @param mixed $res A SQL result
409 public function fieldName( $res, $n );
412 * Get the inserted value of an auto-increment row
414 * The value inserted should be fetched from nextSequenceValue()
417 * $id = $dbw->nextSequenceValue( 'page_page_id_seq' );
418 * $dbw->insert( 'page', [ 'page_id' => $id ] );
419 * $id = $dbw->insertId();
423 public function insertId();
426 * Change the position of the cursor in a result object
427 * @see https://secure.php.net/mysql_data_seek
429 * @param mixed $res A SQL result
432 public function dataSeek( $res, $row );
435 * Get the last error number
436 * @see https://secure.php.net/mysql_errno
440 public function lastErrno();
443 * Get a description of the last error
444 * @see https://secure.php.net/mysql_error
448 public function lastError();
451 * mysql_fetch_field() wrapper
452 * Returns false if the field doesn't exist
454 * @param string $table Table name
455 * @param string $field Field name
459 public function fieldInfo( $table, $field );
462 * Get the number of rows affected by the last write query
463 * @see https://secure.php.net/mysql_affected_rows
467 public function affectedRows();
470 * Returns a wikitext link to the DB's website, e.g.,
471 * return "[https://www.mysql.com/ MySQL]";
472 * Should at least contain plain text, if for some reason
473 * your database has no website.
475 * @return string Wikitext of a link to the server software's web site
477 public function getSoftwareLink();
480 * A string describing the current software version, like from
481 * mysql_get_server_info().
483 * @return string Version information from the database server.
485 public function getServerVersion();
488 * Closes a database connection.
489 * if it is open : commits any open transactions
492 * @return bool Operation success. true if already closed.
494 public function close();
497 * @param string $error Fallback error message, used if none is given by DB
498 * @throws DBConnectionError
500 public function reportConnectionError( $error = 'Unknown error' );
503 * Run an SQL query and return the result. Normally throws a DBQueryError
504 * on failure. If errors are ignored, returns false instead.
506 * In new code, the query wrappers select(), insert(), update(), delete(),
507 * etc. should be used where possible, since they give much better DBMS
508 * independence and automatically quote or validate user input in a variety
509 * of contexts. This function is generally only useful for queries which are
510 * explicitly DBMS-dependent and are unsupported by the query wrappers, such
513 * However, the query wrappers themselves should call this function.
515 * @param string $sql SQL query
516 * @param string $fname Name of the calling function, for profiling/SHOW PROCESSLIST
517 * comment (you can use __METHOD__ or add some extra info)
518 * @param bool $tempIgnore Whether to avoid throwing an exception on errors...
519 * maybe best to catch the exception instead?
521 * @return bool|IResultWrapper True for a successful write query, IResultWrapper object
522 * for a successful read query, or false on failure if $tempIgnore set
524 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false );
527 * Report a query error. Log the error, and if neither the object ignore
528 * flag nor the $tempIgnore flag is set, throw a DBQueryError.
530 * @param string $error
533 * @param string $fname
534 * @param bool $tempIgnore
535 * @throws DBQueryError
537 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false );
540 * Free a result object returned by query() or select(). It's usually not
541 * necessary to call this, just use unset() or let the variable holding
542 * the result object go out of scope.
544 * @param mixed $res A SQL result
546 public function freeResult( $res );
549 * A SELECT wrapper which returns a single field from a single result row.
551 * Usually throws a DBQueryError on failure. If errors are explicitly
552 * ignored, returns false on failure.
554 * If no result rows are returned from the query, false is returned.
556 * @param string|array $table Table name. See IDatabase::select() for details.
557 * @param string $var The field name to select. This must be a valid SQL
558 * fragment: do not use unvalidated user input.
559 * @param string|array $cond The condition array. See IDatabase::select() for details.
560 * @param string $fname The function name of the caller.
561 * @param string|array $options The query options. See IDatabase::select() for details.
563 * @return bool|mixed The value from the field, or false on failure.
565 public function selectField(
566 $table, $var, $cond = '', $fname = __METHOD__
, $options = []
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.
584 * @return bool|array The values from the field, or false on failure
587 public function selectFieldValues(
588 $table, $var, $cond = '', $fname = __METHOD__
, $options = []
592 * Execute a SELECT query constructed using the various parameters provided.
593 * See below for full details of the parameters.
595 * @param string|array $table Table name
596 * @param string|array $vars Field names
597 * @param string|array $conds Conditions
598 * @param string $fname Caller function name
599 * @param array $options Query options
600 * @param array $join_conds Join conditions
603 * @param string|array $table
605 * May be either an array of table names, or a single string holding a table
606 * name. If an array is given, table aliases can be specified, for example:
610 * This includes the user table in the query, with the alias "a" available
611 * for use in field names (e.g. a.user_name).
613 * All of the table names given here are automatically run through
614 * Database::tableName(), which causes the table prefix (if any) to be
615 * added, and various other table name mappings to be performed.
617 * Do not use untrusted user input as a table name. Alias names should
618 * not have characters outside of the Basic multilingual plane.
620 * @param string|array $vars
622 * May be either a field name or an array of field names. The field names
623 * can be complete fragments of SQL, for direct inclusion into the SELECT
624 * query. If an array is given, field aliases can be specified, for example:
626 * [ 'maxrev' => 'MAX(rev_id)' ]
628 * This includes an expression with the alias "maxrev" in the query.
630 * If an expression is given, care must be taken to ensure that it is
633 * Untrusted user input must not be passed to this parameter.
635 * @param string|array $conds
637 * May be either a string containing a single condition, or an array of
638 * conditions. If an array is given, the conditions constructed from each
639 * element are combined with AND.
641 * Array elements may take one of two forms:
643 * - Elements with a numeric key are interpreted as raw SQL fragments.
644 * - Elements with a string key are interpreted as equality conditions,
645 * where the key is the field name.
646 * - If the value of such an array element is a scalar (such as a
647 * string), it will be treated as data and thus quoted appropriately.
648 * If it is null, an IS NULL clause will be added.
649 * - If the value is an array, an IN (...) clause will be constructed
650 * from its non-null elements, and an IS NULL clause will be added
651 * if null is present, such that the field may match any of the
652 * elements in the array. The non-null elements will be quoted.
654 * Note that expressions are often DBMS-dependent in their syntax.
655 * DBMS-independent wrappers are provided for constructing several types of
656 * expression commonly used in condition queries. See:
657 * - IDatabase::buildLike()
658 * - IDatabase::conditional()
660 * Untrusted user input is safe in the values of string keys, however untrusted
661 * input must not be used in the array key names or in the values of numeric keys.
662 * Escaping of untrusted input used in values of numeric keys should be done via
663 * IDatabase::addQuotes()
665 * @param string|array $options
667 * Optional: Array of query options. Boolean options are specified by
668 * including them in the array as a string value with a numeric key, for
673 * The supported options are:
675 * - OFFSET: Skip this many rows at the start of the result set. OFFSET
676 * with LIMIT can theoretically be used for paging through a result set,
677 * but this is discouraged for performance reasons.
679 * - LIMIT: Integer: return at most this many rows. The rows are sorted
680 * and then the first rows are taken until the limit is reached. LIMIT
681 * is applied to a result set after OFFSET.
683 * - FOR UPDATE: Boolean: lock the returned rows so that they can't be
684 * changed until the next COMMIT.
686 * - DISTINCT: Boolean: return only unique result rows.
688 * - GROUP BY: May be either an SQL fragment string naming a field or
689 * expression to group by, or an array of such SQL fragments.
691 * - HAVING: May be either an string containing a HAVING clause or an array of
692 * conditions building the HAVING clause. If an array is given, the conditions
693 * constructed from each element are combined with AND.
695 * - ORDER BY: May be either an SQL fragment giving a field name or
696 * expression to order by, or an array of such SQL fragments.
698 * - USE INDEX: This may be either a string giving the index name to use
699 * for the query, or an array. If it is an associative array, each key
700 * gives the table name (or alias), each value gives the index name to
701 * use for that table. All strings are SQL fragments and so should be
702 * validated by the caller.
704 * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run,
707 * And also the following boolean MySQL extensions, see the MySQL manual
710 * - LOCK IN SHARE MODE
714 * - SQL_BUFFER_RESULT
716 * - SQL_CALC_FOUND_ROWS
721 * @param string|array $join_conds
723 * Optional associative array of table-specific join conditions. In the
724 * most common case, this is unnecessary, since the join condition can be
725 * in $conds. However, it is useful for doing a LEFT JOIN.
727 * The key of the array contains the table name or alias. The value is an
728 * array with two elements, numbered 0 and 1. The first gives the type of
729 * join, the second is the same as the $conds parameter. Thus it can be
730 * an SQL fragment, or an array where the string keys are equality and the
731 * numeric keys are SQL fragments all AND'd together. For example:
733 * [ 'page' => [ 'LEFT JOIN', 'page_latest=rev_id' ] ]
735 * @return IResultWrapper|bool If the query returned no rows, a IResultWrapper
736 * with no rows in it will be returned. If there was a query error, a
737 * DBQueryError exception will be thrown, except if the "ignore errors"
738 * option was set, in which case false will be returned.
740 public function select(
741 $table, $vars, $conds = '', $fname = __METHOD__
,
742 $options = [], $join_conds = []
746 * The equivalent of IDatabase::select() except that the constructed SQL
747 * is returned, instead of being immediately executed. This can be useful for
748 * doing UNION queries, where the SQL text of each query is needed. In general,
749 * however, callers outside of Database classes should just use select().
751 * @param string|array $table Table name
752 * @param string|array $vars Field names
753 * @param string|array $conds Conditions
754 * @param string $fname Caller function name
755 * @param string|array $options Query options
756 * @param string|array $join_conds Join conditions
758 * @return string SQL query string.
759 * @see IDatabase::select()
761 public function selectSQLText(
762 $table, $vars, $conds = '', $fname = __METHOD__
,
763 $options = [], $join_conds = []
767 * Single row SELECT wrapper. Equivalent to IDatabase::select(), except
768 * that a single row object is returned. If the query returns no rows,
771 * @param string|array $table Table name
772 * @param string|array $vars Field names
773 * @param array $conds Conditions
774 * @param string $fname Caller function name
775 * @param string|array $options Query options
776 * @param array|string $join_conds Join conditions
778 * @return stdClass|bool
780 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
781 $options = [], $join_conds = []
785 * Estimate the number of rows in dataset
787 * MySQL allows you to estimate the number of rows that would be returned
788 * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using
789 * index cardinality statistics, and is notoriously inaccurate, especially
790 * when large numbers of rows have recently been added or deleted.
792 * For DBMSs that don't support fast result size estimation, this function
793 * will actually perform the SELECT COUNT(*).
795 * Takes the same arguments as IDatabase::select().
797 * @param string $table Table name
798 * @param string $vars Unused
799 * @param array|string $conds Filters on the table
800 * @param string $fname Function name for profiling
801 * @param array $options Options for select
802 * @return int Row count
804 public function estimateRowCount(
805 $table, $vars = '*', $conds = '', $fname = __METHOD__
, $options = []
809 * Get the number of rows in dataset
811 * This is useful when trying to do COUNT(*) but with a LIMIT for performance.
813 * Takes the same arguments as IDatabase::select().
815 * @since 1.27 Added $join_conds parameter
817 * @param array|string $tables Table names
818 * @param string $vars Unused
819 * @param array|string $conds Filters on the table
820 * @param string $fname Function name for profiling
821 * @param array $options Options for select
822 * @param array $join_conds Join conditions (since 1.27)
823 * @return int Row count
825 public function selectRowCount(
826 $tables, $vars = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
830 * Determines whether a field exists in a table
832 * @param string $table Table name
833 * @param string $field Filed to check on that table
834 * @param string $fname Calling function name (optional)
835 * @return bool Whether $table has filed $field
837 public function fieldExists( $table, $field, $fname = __METHOD__
);
840 * Determines whether an index exists
841 * Usually throws a DBQueryError on failure
842 * If errors are explicitly ignored, returns NULL on failure
844 * @param string $table
845 * @param string $index
846 * @param string $fname
849 public function indexExists( $table, $index, $fname = __METHOD__
);
852 * Query whether a given table exists
854 * @param string $table
855 * @param string $fname
858 public function tableExists( $table, $fname = __METHOD__
);
861 * Determines if a given index is unique
863 * @param string $table
864 * @param string $index
868 public function indexUnique( $table, $index );
871 * INSERT wrapper, inserts an array into a table.
875 * - A single associative array. The array keys are the field names, and
876 * the values are the values to insert. The values are treated as data
877 * and will be quoted appropriately. If NULL is inserted, this will be
878 * converted to a database NULL.
879 * - An array with numeric keys, holding a list of associative arrays.
880 * This causes a multi-row INSERT on DBMSs that support it. The keys in
881 * each subarray must be identical to each other, and in the same order.
883 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
886 * $options is an array of options, with boolean options encoded as values
887 * with numeric keys, in the same style as $options in
888 * IDatabase::select(). Supported options are:
890 * - IGNORE: Boolean: if present, duplicate key errors are ignored, and
891 * any rows which cause duplicate key errors are not inserted. It's
892 * possible to determine how many rows were successfully inserted using
893 * IDatabase::affectedRows().
895 * @param string $table Table name. This will be passed through
896 * Database::tableName().
897 * @param array $a Array of rows to insert
898 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
899 * @param array $options Array of options
903 public function insert( $table, $a, $fname = __METHOD__
, $options = [] );
906 * UPDATE wrapper. Takes a condition array and a SET array.
908 * @param string $table Name of the table to UPDATE. This will be passed through
909 * Database::tableName().
910 * @param array $values An array of values to SET. For each array element,
911 * the key gives the field name, and the value gives the data to set
912 * that field to. The data will be quoted by IDatabase::addQuotes().
913 * Values with integer keys form unquoted SET statements, which can be used for
914 * things like "field = field + 1" or similar computed values.
915 * @param array $conds An array of conditions (WHERE). See
916 * IDatabase::select() for the details of the format of condition
917 * arrays. Use '*' to update all rows.
918 * @param string $fname The function name of the caller (from __METHOD__),
919 * for logging and profiling.
920 * @param array $options An array of UPDATE options, can be:
921 * - IGNORE: Ignore unique key conflicts
922 * - LOW_PRIORITY: MySQL-specific, see MySQL manual.
925 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] );
928 * Makes an encoded list of strings from an array
930 * These can be used to make conjunctions or disjunctions on SQL condition strings
931 * derived from an array (see IDatabase::select() $conds documentation).
935 * $sql = $db->makeList( [
937 * $db->makeList( [ 'rev_minor' => 1, 'rev_len' < 500 ], $db::LIST_OR ] )
938 * ], $db::LIST_AND );
940 * This would set $sql to "rev_user = '$id' AND (rev_minor = '1' OR rev_len < '500')"
942 * @param array $a Containing the data
943 * @param int $mode IDatabase class constant:
944 * - IDatabase::LIST_COMMA: Comma separated, no field names
945 * - IDatabase::LIST_AND: ANDed WHERE clause (without the WHERE).
946 * - IDatabase::LIST_OR: ORed WHERE clause (without the WHERE)
947 * - IDatabase::LIST_SET: Comma separated with field names, like a SET clause
948 * - IDatabase::LIST_NAMES: Comma separated field names
952 public function makeList( $a, $mode = self
::LIST_COMMA
);
955 * Build a partial where clause from a 2-d array such as used for LinkBatch.
956 * The keys on each level may be either integers or strings.
958 * @param array $data Organized as 2-d
959 * [ baseKeyVal => [ subKeyVal => [ignored], ... ], ... ]
960 * @param string $baseKey Field name to match the base-level keys to (eg 'pl_namespace')
961 * @param string $subKey Field name to match the sub-level keys to (eg 'pl_title')
962 * @return string|bool SQL fragment, or false if no items in array
964 public function makeWhereFrom2d( $data, $baseKey, $subKey );
967 * Return aggregated value alias
969 * @param array $valuedata
970 * @param string $valuename
974 public function aggregateValue( $valuedata, $valuename = 'value' );
977 * @param string $field
980 public function bitNot( $field );
983 * @param string $fieldLeft
984 * @param string $fieldRight
987 public function bitAnd( $fieldLeft, $fieldRight );
990 * @param string $fieldLeft
991 * @param string $fieldRight
994 public function bitOr( $fieldLeft, $fieldRight );
997 * Build a concatenation list to feed into a SQL query
998 * @param array $stringList List of raw SQL expressions; caller is
999 * responsible for any quoting
1002 public function buildConcat( $stringList );
1005 * Build a GROUP_CONCAT or equivalent statement for a query.
1007 * This is useful for combining a field for several rows into a single string.
1008 * NULL values will not appear in the output, duplicated values will appear,
1009 * and the resulting delimiter-separated values have no defined sort order.
1010 * Code using the results may need to use the PHP unique() or sort() methods.
1012 * @param string $delim Glue to bind the results together
1013 * @param string|array $table Table name
1014 * @param string $field Field name
1015 * @param string|array $conds Conditions
1016 * @param string|array $join_conds Join conditions
1017 * @return string SQL text
1020 public function buildGroupConcatField(
1021 $delim, $table, $field, $conds = '', $join_conds = []
1025 * @param string $field Field or column to cast
1029 public function buildStringCast( $field );
1032 * Change the current database
1035 * @return bool Success or failure
1037 public function selectDB( $db );
1040 * Get the current DB name
1043 public function getDBname();
1046 * Get the server hostname or IP address
1049 public function getServer();
1052 * Adds quotes and backslashes.
1054 * @param string|int|null|bool|Blob $s
1055 * @return string|int
1057 public function addQuotes( $s );
1060 * LIKE statement wrapper, receives a variable-length argument list with
1061 * parts of pattern to match containing either string literals that will be
1062 * escaped or tokens returned by anyChar() or anyString(). Alternatively,
1063 * the function could be provided with an array of aforementioned
1066 * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns
1067 * a LIKE clause that searches for subpages of 'My page title'.
1069 * $pattern = [ 'My_page_title/', $dbr->anyString() ];
1070 * $query .= $dbr->buildLike( $pattern );
1073 * @return string Fully built LIKE statement
1075 public function buildLike();
1078 * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
1082 public function anyChar();
1085 * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
1089 public function anyString();
1092 * Returns an appropriately quoted sequence value for inserting a new row.
1093 * MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
1094 * subclass will return an integer, and save the value for insertId()
1096 * Any implementation of this function should *not* involve reusing
1097 * sequence numbers created for rolled-back transactions.
1098 * See https://bugs.mysql.com/bug.php?id=30767 for details.
1099 * @param string $seqName
1102 public function nextSequenceValue( $seqName );
1105 * REPLACE query wrapper.
1107 * REPLACE is a very handy MySQL extension, which functions like an INSERT
1108 * except that when there is a duplicate key error, the old row is deleted
1109 * and the new row is inserted in its place.
1111 * We simulate this with standard SQL with a DELETE followed by INSERT. To
1112 * perform the delete, we need to know what the unique indexes are so that
1113 * we know how to find the conflicting rows.
1115 * It may be more efficient to leave off unique indexes which are unlikely
1116 * to collide. However if you do this, you run the risk of encountering
1117 * errors which wouldn't have occurred in MySQL.
1119 * @param string $table The table to replace the row(s) in.
1120 * @param array $uniqueIndexes Is an array of indexes. Each element may be either
1121 * a field name or an array of field names
1122 * @param array $rows Can be either a single row to insert, or multiple rows,
1123 * in the same format as for IDatabase::insert()
1124 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1126 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
);
1129 * INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
1131 * This updates any conflicting rows (according to the unique indexes) using
1132 * the provided SET clause and inserts any remaining (non-conflicted) rows.
1134 * $rows may be either:
1135 * - A single associative array. The array keys are the field names, and
1136 * the values are the values to insert. The values are treated as data
1137 * and will be quoted appropriately. If NULL is inserted, this will be
1138 * converted to a database NULL.
1139 * - An array with numeric keys, holding a list of associative arrays.
1140 * This causes a multi-row INSERT on DBMSs that support it. The keys in
1141 * each subarray must be identical to each other, and in the same order.
1143 * It may be more efficient to leave off unique indexes which are unlikely
1144 * to collide. However if you do this, you run the risk of encountering
1145 * errors which wouldn't have occurred in MySQL.
1147 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
1152 * @param string $table Table name. This will be passed through Database::tableName().
1153 * @param array $rows A single row or list of rows to insert
1154 * @param array $uniqueIndexes List of single field names or field name tuples
1155 * @param array $set An array of values to SET. For each array element, the
1156 * key gives the field name, and the value gives the data to set that
1157 * field to. The data will be quoted by IDatabase::addQuotes().
1158 * Values with integer keys form unquoted SET statements, which can be used for
1159 * things like "field = field + 1" or similar computed values.
1160 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1164 public function upsert(
1165 $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
1169 * DELETE where the condition is a join.
1171 * MySQL overrides this to use a multi-table DELETE syntax, in other databases
1172 * we use sub-selects
1174 * For safety, an empty $conds will not delete everything. If you want to
1175 * delete all rows where the join condition matches, set $conds='*'.
1177 * DO NOT put the join condition in $conds.
1179 * @param string $delTable The table to delete from.
1180 * @param string $joinTable The other table.
1181 * @param string $delVar The variable to join on, in the first table.
1182 * @param string $joinVar The variable to join on, in the second table.
1183 * @param array $conds Condition array of field names mapped to variables,
1184 * ANDed together in the WHERE clause
1185 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1186 * @throws DBUnexpectedError
1188 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
1193 * DELETE query wrapper.
1195 * @param string $table Table name
1196 * @param string|array $conds Array of conditions. See $conds in IDatabase::select()
1197 * for the format. Use $conds == "*" to delete all rows
1198 * @param string $fname Name of the calling function
1199 * @throws DBUnexpectedError
1200 * @return bool|IResultWrapper
1202 public function delete( $table, $conds, $fname = __METHOD__
);
1205 * INSERT SELECT wrapper. Takes data from a SELECT query and inserts it
1206 * into another table.
1208 * @param string $destTable The table name to insert into
1209 * @param string|array $srcTable May be either a table name, or an array of table names
1210 * to include in a join.
1212 * @param array $varMap Must be an associative array of the form
1213 * [ 'dest1' => 'source1', ... ]. Source items may be literals
1214 * rather than field names, but strings should be quoted with
1215 * IDatabase::addQuotes()
1217 * @param array $conds Condition array. See $conds in IDatabase::select() for
1218 * the details of the format of condition arrays. May be "*" to copy the
1221 * @param string $fname The function name of the caller, from __METHOD__
1223 * @param array $insertOptions Options for the INSERT part of the query, see
1224 * IDatabase::insert() for details.
1225 * @param array $selectOptions Options for the SELECT part of the query, see
1226 * IDatabase::select() for details.
1228 * @return IResultWrapper
1230 public function insertSelect( $destTable, $srcTable, $varMap, $conds,
1231 $fname = __METHOD__
,
1232 $insertOptions = [], $selectOptions = []
1236 * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
1237 * within the UNION construct.
1240 public function unionSupportsOrderAndLimit();
1243 * Construct a UNION query
1244 * This is used for providing overload point for other DB abstractions
1245 * not compatible with the MySQL syntax.
1246 * @param array $sqls SQL statements to combine
1247 * @param bool $all Use UNION ALL
1248 * @return string SQL fragment
1250 public function unionQueries( $sqls, $all );
1253 * Returns an SQL expression for a simple conditional. This doesn't need
1254 * to be overridden unless CASE isn't supported in your DBMS.
1256 * @param string|array $cond SQL expression which will result in a boolean value
1257 * @param string $trueVal SQL expression to return if true
1258 * @param string $falseVal SQL expression to return if false
1259 * @return string SQL fragment
1261 public function conditional( $cond, $trueVal, $falseVal );
1264 * Returns a comand for str_replace function in SQL query.
1265 * Uses REPLACE() in MySQL
1267 * @param string $orig Column to modify
1268 * @param string $old Column to seek
1269 * @param string $new Column to replace with
1273 public function strreplace( $orig, $old, $new );
1276 * Determines how long the server has been up
1280 public function getServerUptime();
1283 * Determines if the last failure was due to a deadlock
1287 public function wasDeadlock();
1290 * Determines if the last failure was due to a lock timeout
1294 public function wasLockTimeout();
1297 * Determines if the last query error was due to a dropped connection and should
1298 * be dealt with by pinging the connection and reissuing the query.
1302 public function wasErrorReissuable();
1305 * Determines if the last failure was due to the database being read-only.
1309 public function wasReadOnlyError();
1312 * Wait for the replica DB to catch up to a given master position
1314 * @param DBMasterPos $pos
1315 * @param int $timeout The maximum number of seconds to wait for synchronisation
1316 * @return int|null Zero if the replica DB was past that position already,
1317 * greater than zero if we waited for some period of time, less than
1318 * zero if it timed out, and null on error
1320 public function masterPosWait( DBMasterPos
$pos, $timeout );
1323 * Get the replication position of this replica DB
1325 * @return DBMasterPos|bool False if this is not a replica DB.
1327 public function getReplicaPos();
1330 * Get the position of this master
1332 * @return DBMasterPos|bool False if this is not a master
1334 public function getMasterPos();
1337 * @return bool Whether the DB is marked as read-only server-side
1340 public function serverIsReadOnly();
1343 * Run a callback as soon as the current transaction commits or rolls back.
1344 * An error is thrown if no transaction is pending. Queries in the function will run in
1345 * AUTO-COMMIT mode unless there are begin() calls. Callbacks must commit any transactions
1348 * This is useful for combining cooperative locks and DB transactions.
1350 * The callback takes one argument:
1351 * - How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK)
1353 * @param callable $callback
1354 * @param string $fname Caller name
1358 public function onTransactionResolution( callable
$callback, $fname = __METHOD__
);
1361 * Run a callback as soon as there is no transaction pending.
1362 * If there is a transaction and it is rolled back, then the callback is cancelled.
1363 * Queries in the function will run in AUTO-COMMIT mode unless there are begin() calls.
1364 * Callbacks must commit any transactions that they begin.
1366 * This is useful for updates to different systems or when separate transactions are needed.
1367 * For example, one might want to enqueue jobs into a system outside the database, but only
1368 * after the database is updated so that the jobs will see the data when they actually run.
1369 * It can also be used for updates that easily cause deadlocks if locks are held too long.
1371 * Updates will execute in the order they were enqueued.
1373 * The callback takes one argument:
1374 * - How the transaction ended (IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_IDLE)
1376 * @param callable $callback
1377 * @param string $fname Caller name
1380 public function onTransactionIdle( callable
$callback, $fname = __METHOD__
);
1383 * Run a callback before the current transaction commits or now if there is none.
1384 * If there is a transaction and it is rolled back, then the callback is cancelled.
1385 * Callbacks must not start nor commit any transactions. If no transaction is active,
1386 * then a transaction will wrap the callback.
1388 * This is useful for updates that easily cause deadlocks if locks are held too long
1389 * but where atomicity is strongly desired for these updates and some related updates.
1391 * Updates will execute in the order they were enqueued.
1393 * @param callable $callback
1394 * @param string $fname Caller name
1397 public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
);
1400 * Run a callback each time any transaction commits or rolls back
1402 * The callback takes two arguments:
1403 * - IDatabase::TRIGGER_COMMIT or IDatabase::TRIGGER_ROLLBACK
1404 * - This IDatabase object
1405 * Callbacks must commit any transactions that they begin.
1407 * Registering a callback here will not affect writesOrCallbacks() pending
1409 * @param string $name Callback name
1410 * @param callable|null $callback Use null to unset a listener
1414 public function setTransactionListener( $name, callable
$callback = null );
1417 * Begin an atomic section of statements
1419 * If a transaction has been started already, just keep track of the given
1420 * section name to make sure the transaction is not committed pre-maturely.
1421 * This function can be used in layers (with sub-sections), so use a stack
1422 * to keep track of the different atomic sections. If there is no transaction,
1423 * start one implicitly.
1425 * The goal of this function is to create an atomic section of SQL queries
1426 * without having to start a new transaction if it already exists.
1428 * All atomic levels *must* be explicitly closed using IDatabase::endAtomic(),
1429 * and any database transactions cannot be began or committed until all atomic
1430 * levels are closed. There is no such thing as implicitly opening or closing
1431 * an atomic section.
1434 * @param string $fname
1437 public function startAtomic( $fname = __METHOD__
);
1440 * Ends an atomic section of SQL statements
1442 * Ends the next section of atomic SQL statements and commits the transaction
1446 * @see IDatabase::startAtomic
1447 * @param string $fname
1450 public function endAtomic( $fname = __METHOD__
);
1453 * Run a callback to do an atomic set of updates for this database
1455 * The $callback takes the following arguments:
1456 * - This database object
1457 * - The value of $fname
1459 * If any exception occurs in the callback, then rollback() will be called and the error will
1460 * be re-thrown. It may also be that the rollback itself fails with an exception before then.
1461 * In any case, such errors are expected to terminate the request, without any outside caller
1462 * attempting to catch errors and commit anyway. Note that any rollback undoes all prior
1463 * atomic section and uncommitted updates, which trashes the current request, requiring an
1464 * error to be displayed.
1466 * This can be an alternative to explicit startAtomic()/endAtomic() calls.
1468 * @see Database::startAtomic
1469 * @see Database::endAtomic
1471 * @param string $fname Caller name (usually __METHOD__)
1472 * @param callable $callback Callback that issues DB updates
1473 * @return mixed $res Result of the callback (since 1.28)
1475 * @throws RuntimeException
1476 * @throws UnexpectedValueException
1479 public function doAtomicSection( $fname, callable
$callback );
1482 * Begin a transaction. If a transaction is already in progress,
1483 * that transaction will be committed before the new transaction is started.
1485 * Only call this from code with outer transcation scope.
1486 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1487 * Nesting of transactions is not supported.
1489 * Note that when the DBO_TRX flag is set (which is usually the case for web
1490 * requests, but not for maintenance scripts), any previous database query
1491 * will have started a transaction automatically.
1493 * Nesting of transactions is not supported. Attempts to nest transactions
1494 * will cause a warning, unless the current transaction was started
1495 * automatically because of the DBO_TRX flag.
1497 * @param string $fname Calling function name
1498 * @param string $mode A situationally valid IDatabase::TRANSACTION_* constant [optional]
1501 public function begin( $fname = __METHOD__
, $mode = self
::TRANSACTION_EXPLICIT
);
1504 * Commits a transaction previously started using begin().
1505 * If no transaction is in progress, a warning is issued.
1507 * Only call this from code with outer transcation scope.
1508 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1509 * Nesting of transactions is not supported.
1511 * @param string $fname
1512 * @param string $flush Flush flag, set to situationally valid IDatabase::FLUSHING_*
1513 * constant to disable warnings about explicitly committing implicit transactions,
1514 * or calling commit when no transaction is in progress.
1516 * This will trigger an exception if there is an ongoing explicit transaction.
1518 * Only set the flush flag if you are sure that these warnings are not applicable,
1519 * and no explicit transactions are open.
1521 * @throws DBUnexpectedError
1523 public function commit( $fname = __METHOD__
, $flush = '' );
1526 * Rollback a transaction previously started using begin().
1527 * If no transaction is in progress, a warning is issued.
1529 * Only call this from code with outer transcation scope.
1530 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1531 * Nesting of transactions is not supported. If a serious unexpected error occurs,
1532 * throwing an Exception is preferrable, using a pre-installed error handler to trigger
1533 * rollback (in any case, failure to issue COMMIT will cause rollback server-side).
1535 * @param string $fname Calling function name
1536 * @param string $flush Flush flag, set to a situationally valid IDatabase::FLUSHING_*
1537 * constant to disable warnings about calling rollback when no transaction is in
1538 * progress. This will silently break any ongoing explicit transaction. Only set the
1539 * flush flag if you are sure that it is safe to ignore these warnings in your context.
1540 * @throws DBUnexpectedError
1541 * @since 1.23 Added $flush parameter
1543 public function rollback( $fname = __METHOD__
, $flush = '' );
1546 * Commit any transaction but error out if writes or callbacks are pending
1548 * This is intended for clearing out REPEATABLE-READ snapshots so that callers can
1549 * see a new point-in-time of the database. This is useful when one of many transaction
1550 * rounds finished and significant time will pass in the script's lifetime. It is also
1551 * useful to call on a replica DB after waiting on replication to catch up to the master.
1553 * @param string $fname Calling function name
1554 * @throws DBUnexpectedError
1557 public function flushSnapshot( $fname = __METHOD__
);
1560 * List all tables on the database
1562 * @param string $prefix Only show tables with this prefix, e.g. mw_
1563 * @param string $fname Calling function name
1567 public function listTables( $prefix = null, $fname = __METHOD__
);
1570 * Convert a timestamp in one of the formats accepted by wfTimestamp()
1571 * to the format used for inserting into timestamp fields in this DBMS.
1573 * The result is unquoted, and needs to be passed through addQuotes()
1574 * before it can be included in raw SQL.
1576 * @param string|int $ts
1580 public function timestamp( $ts = 0 );
1583 * Convert a timestamp in one of the formats accepted by wfTimestamp()
1584 * to the format used for inserting into timestamp fields in this DBMS. If
1585 * NULL is input, it is passed through, allowing NULL values to be inserted
1586 * into timestamp fields.
1588 * The result is unquoted, and needs to be passed through addQuotes()
1589 * before it can be included in raw SQL.
1591 * @param string|int $ts
1595 public function timestampOrNull( $ts = null );
1598 * Ping the server and try to reconnect if it there is no connection
1600 * @param float|null &$rtt Value to store the estimated RTT [optional]
1601 * @return bool Success or failure
1603 public function ping( &$rtt = null );
1606 * Get replica DB lag. Currently supported only by MySQL.
1608 * Note that this function will generate a fatal error on many
1609 * installations. Most callers should use LoadBalancer::safeGetLag()
1612 * @return int|bool Database replication lag in seconds or false on error
1614 public function getLag();
1617 * Get the replica DB lag when the current transaction started
1618 * or a general lag estimate if not transaction is active
1620 * This is useful when transactions might use snapshot isolation
1621 * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
1622 * is this lag plus transaction duration. If they don't, it is still
1623 * safe to be pessimistic. In AUTO-COMMIT mode, this still gives an
1624 * indication of the staleness of subsequent reads.
1626 * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
1629 public function getSessionLagStatus();
1632 * Return the maximum number of items allowed in a list, or 0 for unlimited.
1636 public function maxListLen();
1639 * Some DBMSs have a special format for inserting into blob fields, they
1640 * don't allow simple quoted strings to be inserted. To insert into such
1641 * a field, pass the data through this function before passing it to
1642 * IDatabase::insert().
1645 * @return string|Blob
1647 public function encodeBlob( $b );
1650 * Some DBMSs return a special placeholder object representing blob fields
1651 * in result objects. Pass the object through this function to return the
1654 * @param string|Blob $b
1657 public function decodeBlob( $b );
1660 * Override database's default behavior. $options include:
1661 * 'connTimeout' : Set the connection timeout value in seconds.
1662 * May be useful for very long batch queries such as
1663 * full-wiki dumps, where a single query reads out over
1666 * @param array $options
1669 public function setSessionOptions( array $options );
1672 * Set variables to be used in sourceFile/sourceStream, in preference to the
1673 * ones in $GLOBALS. If an array is set here, $GLOBALS will not be used at
1674 * all. If it's set to false, $GLOBALS will be used.
1676 * @param bool|array $vars Mapping variable name to value.
1678 public function setSchemaVars( $vars );
1681 * Check to see if a named lock is available (non-blocking)
1683 * @param string $lockName Name of lock to poll
1684 * @param string $method Name of method calling us
1688 public function lockIsFree( $lockName, $method );
1691 * Acquire a named lock
1693 * Named locks are not related to transactions
1695 * @param string $lockName Name of lock to aquire
1696 * @param string $method Name of the calling method
1697 * @param int $timeout Acquisition timeout in seconds
1700 public function lock( $lockName, $method, $timeout = 5 );
1705 * Named locks are not related to transactions
1707 * @param string $lockName Name of lock to release
1708 * @param string $method Name of the calling method
1710 * @return int Returns 1 if the lock was released, 0 if the lock was not established
1711 * by this thread (in which case the lock is not released), and NULL if the named
1712 * lock did not exist
1714 public function unlock( $lockName, $method );
1717 * Acquire a named lock, flush any transaction, and return an RAII style unlocker object
1719 * Only call this from outer transcation scope and when only one DB will be affected.
1720 * See https://www.mediawiki.org/wiki/Database_transactions for details.
1722 * This is suitiable for transactions that need to be serialized using cooperative locks,
1723 * where each transaction can see each others' changes. Any transaction is flushed to clear
1724 * out stale REPEATABLE-READ snapshot data. Once the returned object falls out of PHP scope,
1725 * the lock will be released unless a transaction is active. If one is active, then the lock
1726 * will be released when it either commits or rolls back.
1728 * If the lock acquisition failed, then no transaction flush happens, and null is returned.
1730 * @param string $lockKey Name of lock to release
1731 * @param string $fname Name of the calling method
1732 * @param int $timeout Acquisition timeout in seconds
1733 * @return ScopedCallback|null
1734 * @throws DBUnexpectedError
1737 public function getScopedLockAndFlush( $lockKey, $fname, $timeout );
1740 * Check to see if a named lock used by lock() use blocking queues
1745 public function namedLocksEnqueue();
1748 * Find out when 'infinity' is. Most DBMSes support this. This is a special
1749 * keyword for timestamps in PostgreSQL, and works with CHAR(14) as well
1750 * because "i" sorts after all numbers.
1754 public function getInfinity();
1757 * Encode an expiry time into the DBMS dependent format
1759 * @param string $expiry Timestamp for expiry, or the 'infinity' string
1762 public function encodeExpiry( $expiry );
1765 * Decode an expiry time into a DBMS independent format
1767 * @param string $expiry DB timestamp field value for expiry
1768 * @param int $format TS_* constant, defaults to TS_MW
1771 public function decodeExpiry( $expiry, $format = TS_MW
);
1774 * Allow or deny "big selects" for this session only. This is done by setting
1775 * the sql_big_selects session variable.
1777 * This is a MySQL-specific feature.
1779 * @param bool|string $value True for allow, false for deny, or "default" to
1780 * restore the initial value
1782 public function setBigSelects( $value = true );
1785 * @return bool Whether this DB is read-only
1788 public function isReadOnly();
1791 * Make certain table names use their own database, schema, and table prefix
1792 * when passed into SQL queries pre-escaped and without a qualified database name
1794 * For example, "user" can be converted to "myschema.mydbname.user" for convenience.
1795 * Appearances like `user`, somedb.user, somedb.someschema.user will used literally.
1797 * Calling this twice will completely clear any old table aliases. Also, note that
1798 * callers are responsible for making sure the schemas and databases actually exist.
1800 * @param array[] $aliases Map of (table => (dbname, schema, prefix) map)
1803 public function setTableAliases( array $aliases );