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 namespace Wikimedia\Rdbms
;
28 use Psr\Log\LoggerAwareInterface
;
29 use Psr\Log\LoggerInterface
;
30 use Psr\Log\NullLogger
;
31 use Wikimedia\ScopedCallback
;
32 use Wikimedia\Timestamp\ConvertibleTimestamp
;
37 use InvalidArgumentException
;
38 use UnexpectedValueException
;
43 * Relational database abstraction object
48 abstract class Database
implements IDatabase
, IMaintainableDatabase
, LoggerAwareInterface
{
49 /** Number of times to re-try an operation in case of deadlock */
50 const DEADLOCK_TRIES
= 4;
51 /** Minimum time to wait before retry, in microseconds */
52 const DEADLOCK_DELAY_MIN
= 500000;
53 /** Maximum time to wait before retry */
54 const DEADLOCK_DELAY_MAX
= 1500000;
56 /** How long before it is worth doing a dummy query to test the connection */
58 const PING_QUERY
= 'SELECT 1 AS ping';
60 const TINY_WRITE_SEC
= 0.010;
61 const SLOW_WRITE_SEC
= 0.500;
62 const SMALL_WRITE_ROWS
= 100;
64 /** @var string Lock granularity is on the level of the entire database */
65 const ATTR_DB_LEVEL_LOCKING
= 'db-level-locking';
66 /** @var string The SCHEMA keyword refers to a grouping of tables in a database */
67 const ATTR_SCHEMAS_AS_TABLE_GROUPS
= 'supports-schemas';
69 /** @var int New Database instance will not be connected yet when returned */
70 const NEW_UNCONNECTED
= 0;
71 /** @var int New Database instance will already be connected when returned */
72 const NEW_CONNECTED
= 1;
74 /** @var string SQL query */
75 protected $lastQuery = '';
76 /** @var float|bool UNIX timestamp of last write query */
77 protected $lastWriteTime = false;
78 /** @var string|bool */
79 protected $phpError = false;
80 /** @var string Server that this instance is currently connected to */
82 /** @var string User that this instance is currently connected under the name of */
84 /** @var string Password used to establish the current connection */
86 /** @var array[] Map of (table => (dbname, schema, prefix) map) */
87 protected $tableAliases = [];
88 /** @var string[] Map of (index alias => index) */
89 protected $indexAliases = [];
90 /** @var bool Whether this PHP instance is for a CLI script */
92 /** @var string Agent name for query profiling */
94 /** @var array Parameters used by initConnection() to establish a connection */
95 protected $connectionParams = [];
96 /** @var BagOStuff APC cache */
98 /** @var LoggerInterface */
99 protected $connLogger;
100 /** @var LoggerInterface */
101 protected $queryLogger;
102 /** @var callable Error logging callback */
103 protected $errorLogger;
104 /** @var callable Deprecation logging callback */
105 protected $deprecationLogger;
107 /** @var resource|null Database connection */
108 protected $conn = null;
110 protected $opened = false;
112 /** @var array[] List of (callable, method name, atomic section id) */
113 protected $trxIdleCallbacks = [];
114 /** @var array[] List of (callable, method name, atomic section id) */
115 protected $trxPreCommitCallbacks = [];
116 /** @var array[] List of (callable, method name, atomic section id) */
117 protected $trxEndCallbacks = [];
118 /** @var callable[] Map of (name => callable) */
119 protected $trxRecurringCallbacks = [];
120 /** @var bool Whether to suppress triggering of transaction end callbacks */
121 protected $trxEndCallbacksSuppressed = false;
126 protected $lbInfo = [];
127 /** @var array|bool */
128 protected $schemaVars = false;
130 protected $sessionVars = [];
131 /** @var array|null */
132 protected $preparedArgs;
133 /** @var string|bool|null Stashed value of html_errors INI setting */
134 protected $htmlErrors;
136 protected $delimiter = ';';
137 /** @var DatabaseDomain */
138 protected $currentDomain;
139 /** @var integer|null Rows affected by the last query to query() or its CRUD wrappers */
140 protected $affectedRowCount;
143 * @var int Transaction status
145 protected $trxStatus = self
::STATUS_TRX_NONE
;
147 * @var Exception|null The last error that caused the status to become STATUS_TRX_ERROR
149 protected $trxStatusCause;
151 * @var array|null If wasKnownStatementRollbackError() prevented trxStatus from being set,
152 * the relevant details are stored here.
154 protected $trxStatusIgnoredCause;
156 * Either 1 if a transaction is active or 0 otherwise.
157 * The other Trx fields may not be meaningfull if this is 0.
161 protected $trxLevel = 0;
163 * Either a short hexidecimal string if a transaction is active or ""
166 * @see Database::trxLevel
168 protected $trxShortId = '';
170 * The UNIX time that the transaction started. Callers can assume that if
171 * snapshot isolation is used, then the data is *at least* up to date to that
172 * point (possibly more up-to-date since the first SELECT defines the snapshot).
175 * @see Database::trxLevel
177 private $trxTimestamp = null;
178 /** @var float Lag estimate at the time of BEGIN */
179 private $trxReplicaLag = null;
181 * Remembers the function name given for starting the most recent transaction via begin().
182 * Used to provide additional context for error reporting.
185 * @see Database::trxLevel
187 private $trxFname = null;
189 * Record if possible write queries were done in the last transaction started
192 * @see Database::trxLevel
194 private $trxDoneWrites = false;
196 * Record if the current transaction was started implicitly due to DBO_TRX being set.
199 * @see Database::trxLevel
201 private $trxAutomatic = false;
203 * Counter for atomic savepoint identifiers. Reset when a new transaction begins.
207 private $trxAtomicCounter = 0;
209 * Array of levels of atomicity within transactions
211 * @var array List of (name, unique ID, savepoint ID)
213 private $trxAtomicLevels = [];
215 * Record if the current transaction was started implicitly by Database::startAtomic
219 private $trxAutomaticAtomic = false;
221 * Track the write query callers of the current transaction
225 private $trxWriteCallers = [];
227 * @var float Seconds spent in write queries for the current transaction
229 private $trxWriteDuration = 0.0;
231 * @var int Number of write queries for the current transaction
233 private $trxWriteQueryCount = 0;
235 * @var int Number of rows affected by write queries for the current transaction
237 private $trxWriteAffectedRows = 0;
239 * @var float Like trxWriteQueryCount but excludes lock-bound, easy to replicate, queries
241 private $trxWriteAdjDuration = 0.0;
243 * @var int Number of write queries counted in trxWriteAdjDuration
245 private $trxWriteAdjQueryCount = 0;
247 * @var float RTT time estimate
249 private $rttEstimate = 0.0;
251 /** @var array Map of (name => 1) for locks obtained via lock() */
252 private $namedLocksHeld = [];
253 /** @var array Map of (table name => 1) for TEMPORARY tables */
254 protected $sessionTempTables = [];
256 /** @var IDatabase|null Lazy handle to the master DB this server replicates from */
257 private $lazyMasterHandle;
259 /** @var float UNIX timestamp */
260 protected $lastPing = 0.0;
262 /** @var int[] Prior flags member variable values */
263 private $priorFlags = [];
265 /** @var callable|null */
267 /** @var TransactionProfiler */
268 protected $trxProfiler;
271 protected $nonNativeInsertSelectBatchSize = 10000;
273 /** @var string Idiom used when a cancelable atomic section started the transaction */
274 private static $NOT_APPLICABLE = 'n/a';
275 /** @var string Prefix to the atomic section counter used to make savepoint IDs */
276 private static $SAVEPOINT_PREFIX = 'wikimedia_rdbms_atomic';
278 /** @var int Transaction is in a error state requiring a full or savepoint rollback */
279 const STATUS_TRX_ERROR
= 1;
280 /** @var int Transaction is active and in a normal state */
281 const STATUS_TRX_OK
= 2;
282 /** @var int No transaction is active */
283 const STATUS_TRX_NONE
= 3;
285 /** @var int Writes to this temporary table do not affect lastDoneWrites() */
286 const TEMP_NORMAL
= 1;
287 /** @var int Writes to this temporary table effect lastDoneWrites() */
288 const TEMP_PSEUDO_PERMANENT
= 2;
291 * @note exceptions for missing libraries/drivers should be thrown in initConnection()
292 * @param array $params Parameters passed from Database::factory()
294 protected function __construct( array $params ) {
295 foreach ( [ 'host', 'user', 'password', 'dbname', 'schema', 'tablePrefix' ] as $name ) {
296 $this->connectionParams
[$name] = $params[$name];
299 $this->cliMode
= $params['cliMode'];
300 // Agent name is added to SQL queries in a comment, so make sure it can't break out
301 $this->agent
= str_replace( '/', '-', $params['agent'] );
303 $this->flags
= $params['flags'];
304 if ( $this->flags
& self
::DBO_DEFAULT
) {
305 if ( $this->cliMode
) {
306 $this->flags
&= ~self
::DBO_TRX
;
308 $this->flags |
= self
::DBO_TRX
;
311 // Disregard deprecated DBO_IGNORE flag (T189999)
312 $this->flags
&= ~self
::DBO_IGNORE
;
314 $this->sessionVars
= $params['variables'];
316 $this->srvCache
= $params['srvCache'] ??
new HashBagOStuff();
318 $this->profiler
= is_callable( $params['profiler'] ) ?
$params['profiler'] : null;
319 $this->trxProfiler
= $params['trxProfiler'];
320 $this->connLogger
= $params['connLogger'];
321 $this->queryLogger
= $params['queryLogger'];
322 $this->errorLogger
= $params['errorLogger'];
323 $this->deprecationLogger
= $params['deprecationLogger'];
325 if ( isset( $params['nonNativeInsertSelectBatchSize'] ) ) {
326 $this->nonNativeInsertSelectBatchSize
= $params['nonNativeInsertSelectBatchSize'];
329 // Set initial dummy domain until open() sets the final DB/prefix
330 $this->currentDomain
= new DatabaseDomain(
331 $params['dbname'] != '' ?
$params['dbname'] : null,
332 $params['schema'] != '' ?
$params['schema'] : null,
333 $params['tablePrefix']
338 * Initialize the connection to the database over the wire (or to local files)
340 * @throws LogicException
341 * @throws InvalidArgumentException
342 * @throws DBConnectionError
345 final public function initConnection() {
346 if ( $this->isOpen() ) {
347 throw new LogicException( __METHOD__
. ': already connected.' );
349 // Establish the connection
350 $this->doInitConnection();
354 * Actually connect to the database over the wire (or to local files)
356 * @throws InvalidArgumentException
357 * @throws DBConnectionError
360 protected function doInitConnection() {
361 if ( strlen( $this->connectionParams
['user'] ) ) {
363 $this->connectionParams
['host'],
364 $this->connectionParams
['user'],
365 $this->connectionParams
['password'],
366 $this->connectionParams
['dbname'],
367 $this->connectionParams
['schema'],
368 $this->connectionParams
['tablePrefix']
371 throw new InvalidArgumentException( "No database user provided." );
376 * Open a new connection to the database (closing any existing one)
378 * @param string $server Database server host
379 * @param string $user Database user name
380 * @param string $password Database user password
381 * @param string $dbName Database name
382 * @param string|null $schema Database schema name
383 * @param string $tablePrefix Table prefix
385 * @throws DBConnectionError
387 abstract protected function open( $server, $user, $password, $dbName, $schema, $tablePrefix );
390 * Construct a Database subclass instance given a database type and parameters
392 * This also connects to the database immediately upon object construction
394 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
395 * @param array $p Parameter map with keys:
396 * - host : The hostname of the DB server
397 * - user : The name of the database user the client operates under
398 * - password : The password for the database user
399 * - dbname : The name of the database to use where queries do not specify one.
400 * The database must exist or an error might be thrown. Setting this to the empty string
401 * will avoid any such errors and make the handle have no implicit database scope. This is
402 * useful for queries like SHOW STATUS, CREATE DATABASE, or DROP DATABASE. Note that a
403 * "database" in Postgres is rougly equivalent to an entire MySQL server. This the domain
404 * in which user names and such are defined, e.g. users are database-specific in Postgres.
405 * - schema : The database schema to use (if supported). A "schema" in Postgres is roughly
406 * equivalent to a "database" in MySQL. Note that MySQL and SQLite do not use schemas.
407 * - tablePrefix : Optional table prefix that is implicitly added on to all table names
408 * recognized in queries. This can be used in place of schemas for handle site farms.
409 * - flags : Optional bitfield of DBO_* constants that define connection, protocol,
410 * buffering, and transaction behavior. It is STRONGLY adviced to leave the DBO_DEFAULT
411 * flag in place UNLESS this this database simply acts as a key/value store.
412 * - driver: Optional name of a specific DB client driver. For MySQL, there is only the
413 * 'mysqli' driver; the old one 'mysql' has been removed.
414 * - variables: Optional map of session variables to set after connecting. This can be
415 * used to adjust lock timeouts or encoding modes and the like.
416 * - connLogger: Optional PSR-3 logger interface instance.
417 * - queryLogger: Optional PSR-3 logger interface instance.
418 * - profiler : Optional callback that takes a section name argument and returns
419 * a ScopedCallback instance that ends the profile section in its destructor.
420 * These will be called in query(), using a simplified version of the SQL that
421 * also includes the agent as a SQL comment.
422 * - trxProfiler: Optional TransactionProfiler instance.
423 * - errorLogger: Optional callback that takes an Exception and logs it.
424 * - deprecationLogger: Optional callback that takes a string and logs it.
425 * - cliMode: Whether to consider the execution context that of a CLI script.
426 * - agent: Optional name used to identify the end-user in query profiling/logging.
427 * - srvCache: Optional BagOStuff instance to an APC-style cache.
428 * - nonNativeInsertSelectBatchSize: Optional batch size for non-native INSERT SELECT emulation.
429 * @param int $connect One of the class constants (NEW_CONNECTED, NEW_UNCONNECTED) [optional]
430 * @return Database|null If the database driver or extension cannot be found
431 * @throws InvalidArgumentException If the database driver or extension cannot be found
434 final public static function factory( $dbType, $p = [], $connect = self
::NEW_CONNECTED
) {
435 $class = self
::getClass( $dbType, $p['driver'] ??
null );
437 if ( class_exists( $class ) && is_subclass_of( $class, IDatabase
::class ) ) {
438 // Resolve some defaults for b/c
439 $p['host'] = $p['host'] ??
false;
440 $p['user'] = $p['user'] ??
false;
441 $p['password'] = $p['password'] ??
false;
442 $p['dbname'] = $p['dbname'] ??
false;
443 $p['flags'] = $p['flags'] ??
0;
444 $p['variables'] = $p['variables'] ??
[];
445 $p['tablePrefix'] = $p['tablePrefix'] ??
'';
446 $p['schema'] = $p['schema'] ??
null;
447 $p['cliMode'] = $p['cliMode'] ??
( PHP_SAPI
=== 'cli' || PHP_SAPI
=== 'phpdbg' );
448 $p['agent'] = $p['agent'] ??
'';
449 if ( !isset( $p['connLogger'] ) ) {
450 $p['connLogger'] = new NullLogger();
452 if ( !isset( $p['queryLogger'] ) ) {
453 $p['queryLogger'] = new NullLogger();
455 $p['profiler'] = $p['profiler'] ??
null;
456 if ( !isset( $p['trxProfiler'] ) ) {
457 $p['trxProfiler'] = new TransactionProfiler();
459 if ( !isset( $p['errorLogger'] ) ) {
460 $p['errorLogger'] = function ( Exception
$e ) {
461 trigger_error( get_class( $e ) . ': ' . $e->getMessage(), E_USER_WARNING
);
464 if ( !isset( $p['deprecationLogger'] ) ) {
465 $p['deprecationLogger'] = function ( $msg ) {
466 trigger_error( $msg, E_USER_DEPRECATED
);
470 /** @var Database $conn */
471 $conn = new $class( $p );
472 if ( $connect == self
::NEW_CONNECTED
) {
473 $conn->initConnection();
483 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
484 * @param string|null $driver Optional name of a specific DB client driver
485 * @return array Map of (Database::ATTR_* constant => value) for all such constants
486 * @throws InvalidArgumentException
489 final public static function attributesFromType( $dbType, $driver = null ) {
491 self
::ATTR_DB_LEVEL_LOCKING
=> false,
492 self
::ATTR_SCHEMAS_AS_TABLE_GROUPS
=> false
495 $class = self
::getClass( $dbType, $driver );
497 return call_user_func( [ $class, 'getAttributes' ] ) +
$defaults;
501 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
502 * @param string|null $driver Optional name of a specific DB client driver
503 * @return string Database subclass name to use
504 * @throws InvalidArgumentException
506 private static function getClass( $dbType, $driver = null ) {
507 // For database types with built-in support, the below maps type to IDatabase
508 // implementations. For types with multipe driver implementations (PHP extensions),
509 // an array can be used, keyed by extension name. In case of an array, the
510 // optional 'driver' parameter can be used to force a specific driver. Otherwise,
511 // we auto-detect the first available driver. For types without built-in support,
512 // an class named "Database<Type>" us used, eg. DatabaseFoo for type 'foo'.
513 static $builtinTypes = [
514 'mssql' => DatabaseMssql
::class,
515 'mysql' => [ 'mysqli' => DatabaseMysqli
::class ],
516 'sqlite' => DatabaseSqlite
::class,
517 'postgres' => DatabasePostgres
::class,
520 $dbType = strtolower( $dbType );
523 if ( isset( $builtinTypes[$dbType] ) ) {
524 $possibleDrivers = $builtinTypes[$dbType];
525 if ( is_string( $possibleDrivers ) ) {
526 $class = $possibleDrivers;
527 } elseif ( (string)$driver !== '' ) {
528 if ( !isset( $possibleDrivers[$driver] ) ) {
529 throw new InvalidArgumentException( __METHOD__
.
530 " type '$dbType' does not support driver '{$driver}'" );
533 $class = $possibleDrivers[$driver];
535 foreach ( $possibleDrivers as $posDriver => $possibleClass ) {
536 if ( extension_loaded( $posDriver ) ) {
537 $class = $possibleClass;
543 $class = 'Database' . ucfirst( $dbType );
546 if ( $class === false ) {
547 throw new InvalidArgumentException( __METHOD__
.
548 " no viable database extension found for type '$dbType'" );
555 * @return array Map of (Database::ATTR_* constant => value
558 protected static function getAttributes() {
563 * Set the PSR-3 logger interface to use for query logging. (The logger
564 * interfaces for connection logging and error logging can be set with the
567 * @param LoggerInterface $logger
569 public function setLogger( LoggerInterface
$logger ) {
570 $this->queryLogger
= $logger;
573 public function getServerInfo() {
574 return $this->getServerVersion();
577 public function bufferResults( $buffer = null ) {
578 $res = !$this->getFlag( self
::DBO_NOBUFFER
);
579 if ( $buffer !== null ) {
581 ?
$this->clearFlag( self
::DBO_NOBUFFER
)
582 : $this->setFlag( self
::DBO_NOBUFFER
);
588 public function trxLevel() {
589 return $this->trxLevel
;
592 public function trxTimestamp() {
593 return $this->trxLevel ?
$this->trxTimestamp
: null;
597 * @return int One of the STATUS_TRX_* class constants
600 public function trxStatus() {
601 return $this->trxStatus
;
604 public function tablePrefix( $prefix = null ) {
605 $old = $this->currentDomain
->getTablePrefix();
606 if ( $prefix !== null ) {
607 $this->currentDomain
= new DatabaseDomain(
608 $this->currentDomain
->getDatabase(),
609 $this->currentDomain
->getSchema(),
617 public function dbSchema( $schema = null ) {
618 if ( strlen( $schema ) && $this->getDBname() === null ) {
619 throw new DBUnexpectedError( $this, "Cannot set schema to '$schema'; no database set." );
622 $old = $this->currentDomain
->getSchema();
623 if ( $schema !== null ) {
624 $this->currentDomain
= new DatabaseDomain(
625 $this->currentDomain
->getDatabase(),
626 // DatabaseDomain uses null for unspecified schemas
627 strlen( $schema ) ?
$schema : null,
628 $this->currentDomain
->getTablePrefix()
636 * @return string Schema to use to qualify relations in queries
638 protected function relationSchemaQualifier() {
639 return $this->dbSchema();
642 public function getLBInfo( $name = null ) {
643 if ( is_null( $name ) ) {
644 return $this->lbInfo
;
647 if ( array_key_exists( $name, $this->lbInfo
) ) {
648 return $this->lbInfo
[$name];
654 public function setLBInfo( $name, $value = null ) {
655 if ( is_null( $value ) ) {
656 $this->lbInfo
= $name;
658 $this->lbInfo
[$name] = $value;
662 public function setLazyMasterHandle( IDatabase
$conn ) {
663 $this->lazyMasterHandle
= $conn;
667 * @return IDatabase|null
668 * @see setLazyMasterHandle()
671 protected function getLazyMasterHandle() {
672 return $this->lazyMasterHandle
;
675 public function implicitGroupby() {
679 public function implicitOrderby() {
683 public function lastQuery() {
684 return $this->lastQuery
;
687 public function doneWrites() {
688 return (bool)$this->lastWriteTime
;
691 public function lastDoneWrites() {
692 return $this->lastWriteTime ?
: false;
695 public function writesPending() {
696 return $this->trxLevel
&& $this->trxDoneWrites
;
699 public function writesOrCallbacksPending() {
700 return $this->trxLevel
&& (
701 $this->trxDoneWrites ||
702 $this->trxIdleCallbacks ||
703 $this->trxPreCommitCallbacks ||
704 $this->trxEndCallbacks
708 public function preCommitCallbacksPending() {
709 return $this->trxLevel
&& $this->trxPreCommitCallbacks
;
713 * @return string|null
715 final protected function getTransactionRoundId() {
716 // If transaction round participation is enabled, see if one is active
717 if ( $this->getFlag( self
::DBO_TRX
) ) {
718 $id = $this->getLBInfo( 'trxRoundId' );
720 return is_string( $id ) ?
$id : null;
726 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
) {
727 if ( !$this->trxLevel
) {
729 } elseif ( !$this->trxDoneWrites
) {
734 case self
::ESTIMATE_DB_APPLY
:
735 return $this->pingAndCalculateLastTrxApplyTime();
736 default: // everything
737 return $this->trxWriteDuration
;
742 * @return float Time to apply writes to replicas based on trxWrite* fields
744 private function pingAndCalculateLastTrxApplyTime() {
747 $rttAdjTotal = $this->trxWriteAdjQueryCount
* $rtt;
748 $applyTime = max( $this->trxWriteAdjDuration
- $rttAdjTotal, 0 );
749 // For omitted queries, make them count as something at least
750 $omitted = $this->trxWriteQueryCount
- $this->trxWriteAdjQueryCount
;
751 $applyTime +
= self
::TINY_WRITE_SEC
* $omitted;
756 public function pendingWriteCallers() {
757 return $this->trxLevel ?
$this->trxWriteCallers
: [];
760 public function pendingWriteRowsAffected() {
761 return $this->trxWriteAffectedRows
;
765 * List the methods that have write queries or callbacks for the current transaction
767 * This method should not be used outside of Database/LoadBalancer
772 public function pendingWriteAndCallbackCallers() {
773 $fnames = $this->pendingWriteCallers();
775 $this->trxIdleCallbacks
,
776 $this->trxPreCommitCallbacks
,
777 $this->trxEndCallbacks
779 foreach ( $callbacks as $callback ) {
780 $fnames[] = $callback[1];
790 private function flatAtomicSectionList() {
791 return array_reduce( $this->trxAtomicLevels
, function ( $accum, $v ) {
792 return $accum === null ?
$v[0] : "$accum, " . $v[0];
796 public function isOpen() {
797 return $this->opened
;
800 public function setFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
801 if ( ( $flag & self
::DBO_IGNORE
) ) {
802 throw new UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
805 if ( $remember === self
::REMEMBER_PRIOR
) {
806 array_push( $this->priorFlags
, $this->flags
);
808 $this->flags |
= $flag;
811 public function clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
812 if ( ( $flag & self
::DBO_IGNORE
) ) {
813 throw new UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
816 if ( $remember === self
::REMEMBER_PRIOR
) {
817 array_push( $this->priorFlags
, $this->flags
);
819 $this->flags
&= ~
$flag;
822 public function restoreFlags( $state = self
::RESTORE_PRIOR
) {
823 if ( !$this->priorFlags
) {
827 if ( $state === self
::RESTORE_INITIAL
) {
828 $this->flags
= reset( $this->priorFlags
);
829 $this->priorFlags
= [];
831 $this->flags
= array_pop( $this->priorFlags
);
835 public function getFlag( $flag ) {
836 return (bool)( $this->flags
& $flag );
840 * @param string $name Class field name
842 * @deprecated Since 1.28
844 public function getProperty( $name ) {
848 public function getDomainID() {
849 return $this->currentDomain
->getId();
852 final public function getWikiID() {
853 return $this->getDomainID();
857 * Get information about an index into an object
858 * @param string $table Table name
859 * @param string $index Index name
860 * @param string $fname Calling function name
861 * @return mixed Database-specific index description class or false if the index does not exist
863 abstract function indexInfo( $table, $index, $fname = __METHOD__
);
866 * Wrapper for addslashes()
868 * @param string $s String to be slashed.
869 * @return string Slashed string.
871 abstract function strencode( $s );
874 * Set a custom error handler for logging errors during database connection
876 protected function installErrorHandler() {
877 $this->phpError
= false;
878 $this->htmlErrors
= ini_set( 'html_errors', '0' );
879 set_error_handler( [ $this, 'connectionErrorLogger' ] );
883 * Restore the previous error handler and return the last PHP error for this DB
885 * @return bool|string
887 protected function restoreErrorHandler() {
888 restore_error_handler();
889 if ( $this->htmlErrors
!== false ) {
890 ini_set( 'html_errors', $this->htmlErrors
);
893 return $this->getLastPHPError();
897 * @return string|bool Last PHP error for this DB (typically connection errors)
899 protected function getLastPHPError() {
900 if ( $this->phpError
) {
901 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->phpError
);
902 $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
911 * Error handler for logging errors during database connection
912 * This method should not be used outside of Database classes
915 * @param string $errstr
917 public function connectionErrorLogger( $errno, $errstr ) {
918 $this->phpError
= $errstr;
922 * Create a log context to pass to PSR-3 logger functions.
924 * @param array $extras Additional data to add to context
927 protected function getLogContext( array $extras = [] ) {
930 'db_server' => $this->server
,
931 'db_name' => $this->getDBname(),
932 'db_user' => $this->user
,
938 final public function close() {
939 $exception = null; // error to throw after disconnecting
941 $wasOpen = $this->opened
;
942 // This should mostly do nothing if the connection is already closed
944 // Roll back any dangling transaction first
945 if ( $this->trxLevel
) {
946 if ( $this->trxAtomicLevels
) {
947 // Cannot let incomplete atomic sections be committed
948 $levels = $this->flatAtomicSectionList();
949 $exception = new DBUnexpectedError(
951 __METHOD__
. ": atomic sections $levels are still open."
953 } elseif ( $this->trxAutomatic
) {
954 // Only the connection manager can commit non-empty DBO_TRX transactions
955 // (empty ones we can silently roll back)
956 if ( $this->writesOrCallbacksPending() ) {
957 $exception = new DBUnexpectedError(
960 ": mass commit/rollback of peer transaction required (DBO_TRX set)."
964 // Manual transactions should have been committed or rolled
965 // back, even if empty.
966 $exception = new DBUnexpectedError(
968 __METHOD__
. ": transaction is still open (from {$this->trxFname})."
972 if ( $this->trxEndCallbacksSuppressed
) {
973 $exception = $exception ?
: new DBUnexpectedError(
975 __METHOD__
. ': callbacks are suppressed; cannot properly commit.'
979 // Rollback the changes and run any callbacks as needed
980 $this->rollback( __METHOD__
, self
::FLUSHING_INTERNAL
);
983 // Close the actual connection in the binding handle
984 $closed = $this->closeConnection();
986 $closed = true; // already closed; nothing to do
990 $this->opened
= false;
992 // Throw any unexpected errors after having disconnected
993 if ( $exception instanceof Exception
) {
997 // Note that various subclasses call close() at the start of open(), which itself is
998 // called by replaceLostConnection(). In that case, just because onTransactionResolution()
999 // callbacks are pending does not mean that an exception should be thrown. Rather, they
1000 // will be executed after the reconnection step.
1002 // Sanity check that no callbacks are dangling
1003 $fnames = $this->pendingWriteAndCallbackCallers();
1005 throw new RuntimeException(
1006 "Transaction callbacks are still pending:\n" . implode( ', ', $fnames )
1015 * Make sure there is an open connection handle (alive or not) as a sanity check
1017 * This guards against fatal errors to the binding handle not being defined
1018 * in cases where open() was never called or close() was already called
1020 * @throws DBUnexpectedError
1022 protected function assertHasConnectionHandle() {
1023 if ( !$this->isOpen() ) {
1024 throw new DBUnexpectedError( $this, "DB connection was already closed." );
1029 * Make sure that this server is not marked as a replica nor read-only as a sanity check
1031 * @throws DBUnexpectedError
1033 protected function assertIsWritableMaster() {
1034 if ( $this->getLBInfo( 'replica' ) === true ) {
1035 throw new DBUnexpectedError(
1037 'Write operations are not allowed on replica database connections.'
1040 $reason = $this->getReadOnlyReason();
1041 if ( $reason !== false ) {
1042 throw new DBReadOnlyError( $this, "Database is read-only: $reason" );
1047 * Closes underlying database connection
1049 * @return bool Whether connection was closed successfully
1051 abstract protected function closeConnection();
1054 * @deprecated since 1.32
1055 * @param string $error Fallback message, if none is given by DB
1056 * @throws DBConnectionError
1058 public function reportConnectionError( $error = 'Unknown error' ) {
1059 call_user_func( $this->deprecationLogger
, 'Use of ' . __METHOD__
. ' is deprecated.' );
1060 throw new DBConnectionError( $this, $this->lastError() ?
: $error );
1064 * Run a query and return a DBMS-dependent wrapper or boolean
1066 * For SELECT queries, this returns either:
1067 * - a) A driver-specific value/resource, only on success. This can be iterated
1068 * over by calling fetchObject()/fetchRow() until there are no more rows.
1069 * Alternatively, the result can be passed to resultObject() to obtain a
1070 * ResultWrapper instance which can then be iterated over via "foreach".
1071 * - b) False, on any query failure
1073 * For non-SELECT queries, this returns either:
1074 * - a) A driver-specific value/resource, only on success
1075 * - b) True, only on success (e.g. no meaningful result other than "OK")
1076 * - c) False, on any query failure
1078 * @param string $sql SQL query
1079 * @return mixed|bool An object, resource, or true on success; false on failure
1081 abstract protected function doQuery( $sql );
1084 * Determine whether a query writes to the DB. When in doubt, this returns true.
1088 * - Subsequent web requests should not need to wait for replication from
1089 * the master position seen by this web request, unless this request made
1090 * changes to the master. This is handled by ChronologyProtector by checking
1091 * doneWrites() at the end of the request. doneWrites() returns true if any
1092 * query set lastWriteTime; which query() does based on isWriteQuery().
1094 * - Reject write queries to replica DBs, in query().
1096 * @param string $sql
1099 protected function isWriteQuery( $sql ) {
1100 // BEGIN and COMMIT queries are considered read queries here.
1101 // Database backends and drivers (MySQL, MariaDB, php-mysqli) generally
1102 // treat these as write queries, in that their results have "affected rows"
1103 // as meta data as from writes, instead of "num rows" as from reads.
1104 // But, we treat them as read queries because when reading data (from
1105 // either replica or master) we use transactions to enable repeatable-read
1106 // snapshots, which ensures we get consistent results from the same snapshot
1107 // for all queries within a request. Use cases:
1108 // - Treating these as writes would trigger ChronologyProtector (see method doc).
1109 // - We use this method to reject writes to replicas, but we need to allow
1110 // use of transactions on replicas for read snapshots. This fine given
1111 // that transactions by themselves don't make changes, only actual writes
1112 // within the transaction matter, which we still detect.
1114 '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SAVEPOINT|RELEASE|SET|SHOW|EXPLAIN|\(SELECT)\b/i',
1120 * @param string $sql
1121 * @return string|null
1123 protected function getQueryVerb( $sql ) {
1124 return preg_match( '/^\s*([a-z]+)/i', $sql, $m ) ?
strtoupper( $m[1] ) : null;
1128 * Determine whether a SQL statement is sensitive to isolation level.
1130 * A SQL statement is considered transactable if its result could vary
1131 * depending on the transaction isolation level. Operational commands
1132 * such as 'SET' and 'SHOW' are not considered to be transactable.
1134 * Main purpose: Used by query() to decide whether to begin a transaction
1135 * before the current query (in DBO_TRX mode, on by default).
1137 * @param string $sql
1140 protected function isTransactableQuery( $sql ) {
1142 $this->getQueryVerb( $sql ),
1143 [ 'BEGIN', 'ROLLBACK', 'COMMIT', 'SET', 'SHOW', 'CREATE', 'ALTER' ],
1149 * @param string $sql A SQL query
1150 * @param bool $pseudoPermanent Treat any table from CREATE TEMPORARY as pseudo-permanent
1151 * @return int|null A self::TEMP_* constant for temp table operations or null otherwise
1153 protected function registerTempTableWrite( $sql, $pseudoPermanent ) {
1154 static $qt = '[`"\']?(\w+)[`"\']?'; // quoted table
1157 '/^CREATE\s+TEMPORARY\s+TABLE\s+(?:IF\s+NOT\s+EXISTS\s+)?' . $qt . '/i',
1161 $type = $pseudoPermanent ? self
::TEMP_PSEUDO_PERMANENT
: self
::TEMP_NORMAL
;
1162 $this->sessionTempTables
[$matches[1]] = $type;
1165 } elseif ( preg_match(
1166 '/^DROP\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?' . $qt . '/i',
1170 $type = $this->sessionTempTables
[$matches[1]] ??
null;
1171 unset( $this->sessionTempTables
[$matches[1]] );
1174 } elseif ( preg_match(
1175 '/^TRUNCATE\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?' . $qt . '/i',
1179 return $this->sessionTempTables
[$matches[1]] ??
null;
1180 } elseif ( preg_match(
1181 '/^(?:(?:INSERT|REPLACE)\s+(?:\w+\s+)?INTO|UPDATE|DELETE\s+FROM)\s+' . $qt . '/i',
1185 return $this->sessionTempTables
[$matches[1]] ??
null;
1191 public function query( $sql, $fname = __METHOD__
, $flags = 0 ) {
1192 $this->assertTransactionStatus( $sql, $fname );
1193 $this->assertHasConnectionHandle();
1195 $flags = (int)$flags; // b/c; this field used to be a bool
1196 $ignoreErrors = $this->hasFlags( $flags, self
::QUERY_SILENCE_ERRORS
);
1197 $pseudoPermanent = $this->hasFlags( $flags, self
::QUERY_PSEUDO_PERMANENT
);
1199 $priorTransaction = $this->trxLevel
;
1200 $priorWritesPending = $this->writesOrCallbacksPending();
1201 $this->lastQuery
= $sql;
1203 if ( $this->isWriteQuery( $sql ) ) {
1204 # In theory, non-persistent writes are allowed in read-only mode, but due to things
1205 # like https://bugs.mysql.com/bug.php?id=33669 that might not work anyway...
1206 $this->assertIsWritableMaster();
1207 # Do not treat temporary table writes as "meaningful writes" that need committing.
1208 # Profile them as reads. Integration tests can override this behavior via $flags.
1209 $tableType = $this->registerTempTableWrite( $sql, $pseudoPermanent );
1210 $isEffectiveWrite = ( $tableType !== self
::TEMP_NORMAL
);
1212 $isEffectiveWrite = false;
1215 # Add trace comment to the begin of the sql string, right after the operator.
1216 # Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (T44598)
1217 $commentedSql = preg_replace( '/\s|$/', " /* $fname {$this->agent} */ ", $sql, 1 );
1219 # Send the query to the server and fetch any corresponding errors
1220 $ret = $this->attemptQuery( $sql, $commentedSql, $isEffectiveWrite, $fname );
1221 $lastError = $this->lastError();
1222 $lastErrno = $this->lastErrno();
1224 $recoverableSR = false; // recoverable statement rollback?
1225 $recoverableCL = false; // recoverable connection loss?
1227 if ( $ret === false && $this->wasConnectionLoss() ) {
1228 # Check if no meaningful session state was lost
1229 $recoverableCL = $this->canRecoverFromDisconnect( $sql, $priorWritesPending );
1230 # Update session state tracking and try to restore the connection
1231 $reconnected = $this->replaceLostConnection( __METHOD__
);
1232 # Silently resend the query to the server if it is safe and possible
1233 if ( $recoverableCL && $reconnected ) {
1234 $ret = $this->attemptQuery( $sql, $commentedSql, $isEffectiveWrite, $fname );
1235 $lastError = $this->lastError();
1236 $lastErrno = $this->lastErrno();
1238 if ( $ret === false && $this->wasConnectionLoss() ) {
1239 # Query probably causes disconnects; reconnect and do not re-run it
1240 $this->replaceLostConnection( __METHOD__
);
1242 $recoverableCL = false; // connection does not need recovering
1243 $recoverableSR = $this->wasKnownStatementRollbackError();
1247 $recoverableSR = $this->wasKnownStatementRollbackError();
1250 if ( $ret === false ) {
1251 if ( $priorTransaction ) {
1252 if ( $recoverableSR ) {
1253 # We're ignoring an error that caused just the current query to be aborted.
1254 # But log the cause so we can log a deprecation notice if a caller actually
1256 $this->trxStatusIgnoredCause
= [ $lastError, $lastErrno, $fname ];
1257 } elseif ( !$recoverableCL ) {
1258 # Either the query was aborted or all queries after BEGIN where aborted.
1259 # In the first case, the only options going forward are (a) ROLLBACK, or
1260 # (b) ROLLBACK TO SAVEPOINT (if one was set). If the later case, the only
1261 # option is ROLLBACK, since the snapshots would have been released.
1262 $this->trxStatus
= self
::STATUS_TRX_ERROR
;
1263 $this->trxStatusCause
=
1264 $this->getQueryExceptionAndLog( $lastError, $lastErrno, $sql, $fname );
1265 $ignoreErrors = false; // cannot recover
1266 $this->trxStatusIgnoredCause
= null;
1270 $this->reportQueryError( $lastError, $lastErrno, $sql, $fname, $ignoreErrors );
1273 return $this->resultObject( $ret );
1277 * Wrapper for query() that also handles profiling, logging, and affected row count updates
1279 * @param string $sql Original SQL query
1280 * @param string $commentedSql SQL query with debugging/trace comment
1281 * @param bool $isEffectiveWrite Whether the query is a (non-temporary table) write
1282 * @param string $fname Name of the calling function
1283 * @return bool|ResultWrapper True for a successful write query, ResultWrapper
1284 * object for a successful read query, or false on failure
1286 private function attemptQuery( $sql, $commentedSql, $isEffectiveWrite, $fname ) {
1287 $this->beginIfImplied( $sql, $fname );
1289 # Keep track of whether the transaction has write queries pending
1290 if ( $isEffectiveWrite ) {
1291 $this->lastWriteTime
= microtime( true );
1292 if ( $this->trxLevel
&& !$this->trxDoneWrites
) {
1293 $this->trxDoneWrites
= true;
1294 $this->trxProfiler
->transactionWritingIn(
1295 $this->server
, $this->getDomainID(), $this->trxShortId
);
1299 if ( $this->getFlag( self
::DBO_DEBUG
) ) {
1300 $this->queryLogger
->debug( "{$this->getDomainID()} {$commentedSql}" );
1303 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
1304 # generalizeSQL() will probably cut down the query to reasonable
1305 # logging size most of the time. The substr is really just a sanity check.
1307 $queryProf = 'query-m: ' . substr( self
::generalizeSQL( $sql ), 0, 255 );
1309 $queryProf = 'query: ' . substr( self
::generalizeSQL( $sql ), 0, 255 );
1312 # Include query transaction state
1313 $queryProf .= $this->trxShortId ?
" [TRX#{$this->trxShortId}]" : "";
1315 $startTime = microtime( true );
1316 $ps = $this->profiler ?
( $this->profiler
)( $queryProf ) : null;
1317 $this->affectedRowCount
= null;
1318 $ret = $this->doQuery( $commentedSql );
1319 $this->affectedRowCount
= $this->affectedRows();
1320 unset( $ps ); // profile out (if set)
1321 $queryRuntime = max( microtime( true ) - $startTime, 0.0 );
1323 if ( $ret !== false ) {
1324 $this->lastPing
= $startTime;
1325 if ( $isEffectiveWrite && $this->trxLevel
) {
1326 $this->updateTrxWriteQueryTime( $sql, $queryRuntime, $this->affectedRows() );
1327 $this->trxWriteCallers
[] = $fname;
1331 if ( $sql === self
::PING_QUERY
) {
1332 $this->rttEstimate
= $queryRuntime;
1335 $this->trxProfiler
->recordQueryCompletion(
1339 $isEffectiveWrite ?
$this->affectedRows() : $this->numRows( $ret )
1341 $this->queryLogger
->debug( $sql, [
1343 'master' => $isMaster,
1344 'runtime' => $queryRuntime,
1351 * Start an implicit transaction if DBO_TRX is enabled and no transaction is active
1353 * @param string $sql
1354 * @param string $fname
1356 private function beginIfImplied( $sql, $fname ) {
1359 $this->getFlag( self
::DBO_TRX
) &&
1360 $this->isTransactableQuery( $sql )
1362 $this->begin( __METHOD__
. " ($fname)", self
::TRANSACTION_INTERNAL
);
1363 $this->trxAutomatic
= true;
1368 * Update the estimated run-time of a query, not counting large row lock times
1370 * LoadBalancer can be set to rollback transactions that will create huge replication
1371 * lag. It bases this estimate off of pendingWriteQueryDuration(). Certain simple
1372 * queries, like inserting a row can take a long time due to row locking. This method
1373 * uses some simple heuristics to discount those cases.
1375 * @param string $sql A SQL write query
1376 * @param float $runtime Total runtime, including RTT
1377 * @param int $affected Affected row count
1379 private function updateTrxWriteQueryTime( $sql, $runtime, $affected ) {
1380 // Whether this is indicative of replica DB runtime (except for RBR or ws_repl)
1381 $indicativeOfReplicaRuntime = true;
1382 if ( $runtime > self
::SLOW_WRITE_SEC
) {
1383 $verb = $this->getQueryVerb( $sql );
1384 // insert(), upsert(), replace() are fast unless bulky in size or blocked on locks
1385 if ( $verb === 'INSERT' ) {
1386 $indicativeOfReplicaRuntime = $this->affectedRows() > self
::SMALL_WRITE_ROWS
;
1387 } elseif ( $verb === 'REPLACE' ) {
1388 $indicativeOfReplicaRuntime = $this->affectedRows() > self
::SMALL_WRITE_ROWS
/ 2;
1392 $this->trxWriteDuration +
= $runtime;
1393 $this->trxWriteQueryCount +
= 1;
1394 $this->trxWriteAffectedRows +
= $affected;
1395 if ( $indicativeOfReplicaRuntime ) {
1396 $this->trxWriteAdjDuration +
= $runtime;
1397 $this->trxWriteAdjQueryCount +
= 1;
1402 * Error out if the DB is not in a valid state for a query via query()
1404 * @param string $sql
1405 * @param string $fname
1406 * @throws DBTransactionStateError
1408 private function assertTransactionStatus( $sql, $fname ) {
1409 $verb = $this->getQueryVerb( $sql );
1410 if ( $verb === 'USE' ) {
1411 throw new DBUnexpectedError( $this, "Got USE query; use selectDomain() instead." );
1414 if ( $verb === 'ROLLBACK' ) { // transaction/savepoint
1418 if ( $this->trxStatus
< self
::STATUS_TRX_OK
) {
1419 throw new DBTransactionStateError(
1421 "Cannot execute query from $fname while transaction status is ERROR.",
1423 $this->trxStatusCause
1425 } elseif ( $this->trxStatus
=== self
::STATUS_TRX_OK
&& $this->trxStatusIgnoredCause
) {
1426 list( $iLastError, $iLastErrno, $iFname ) = $this->trxStatusIgnoredCause
;
1427 call_user_func( $this->deprecationLogger
,
1428 "Caller from $fname ignored an error originally raised from $iFname: " .
1429 "[$iLastErrno] $iLastError"
1431 $this->trxStatusIgnoredCause
= null;
1435 public function assertNoOpenTransactions() {
1436 if ( $this->explicitTrxActive() ) {
1437 throw new DBTransactionError(
1439 "Explicit transaction still active. A caller may have caught an error. "
1440 . "Open transactions: " . $this->flatAtomicSectionList()
1446 * Determine whether it is safe to retry queries after a database connection is lost
1448 * @param string $sql SQL query
1449 * @param bool $priorWritesPending Whether there is a transaction open with
1450 * possible write queries or transaction pre-commit/idle callbacks
1451 * waiting on it to finish.
1452 * @return bool True if it is safe to retry the query, false otherwise
1454 private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
1455 # Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
1456 # Dropped connections also mean that named locks are automatically released.
1457 # Only allow error suppression in autocommit mode or when the lost transaction
1458 # didn't matter anyway (aside from DBO_TRX snapshot loss).
1459 if ( $this->namedLocksHeld
) {
1460 return false; // possible critical section violation
1461 } elseif ( $this->sessionTempTables
) {
1462 return false; // tables might be queried latter
1463 } elseif ( $sql === 'COMMIT' ) {
1464 return !$priorWritesPending; // nothing written anyway? (T127428)
1465 } elseif ( $sql === 'ROLLBACK' ) {
1466 return true; // transaction lost...which is also what was requested :)
1467 } elseif ( $this->explicitTrxActive() ) {
1468 return false; // don't drop atomocity and explicit snapshots
1469 } elseif ( $priorWritesPending ) {
1470 return false; // prior writes lost from implicit transaction
1477 * Clean things up after session (and thus transaction) loss before reconnect
1479 private function handleSessionLossPreconnect() {
1480 // Clean up tracking of session-level things...
1481 // https://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html
1482 // https://www.postgresql.org/docs/9.2/static/sql-createtable.html (ignoring ON COMMIT)
1483 $this->sessionTempTables
= [];
1484 // https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
1485 // https://www.postgresql.org/docs/9.4/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1486 $this->namedLocksHeld
= [];
1487 // Session loss implies transaction loss
1488 $this->trxLevel
= 0;
1489 $this->trxAtomicCounter
= 0;
1490 $this->trxIdleCallbacks
= []; // T67263; transaction already lost
1491 $this->trxPreCommitCallbacks
= []; // T67263; transaction already lost
1492 // @note: leave trxRecurringCallbacks in place
1493 if ( $this->trxDoneWrites
) {
1494 $this->trxProfiler
->transactionWritingOut(
1496 $this->getDomainID(),
1498 $this->pendingWriteQueryDuration( self
::ESTIMATE_TOTAL
),
1499 $this->trxWriteAffectedRows
1505 * Clean things up after session (and thus transaction) loss after reconnect
1507 private function handleSessionLossPostconnect() {
1509 // Handle callbacks in trxEndCallbacks, e.g. onTransactionResolution().
1510 // If callback suppression is set then the array will remain unhandled.
1511 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_ROLLBACK
);
1512 } catch ( Exception
$ex ) {
1513 // Already logged; move on...
1516 // Handle callbacks in trxRecurringCallbacks, e.g. setTransactionListener()
1517 $this->runTransactionListenerCallbacks( self
::TRIGGER_ROLLBACK
);
1518 } catch ( Exception
$ex ) {
1519 // Already logged; move on...
1524 * Checks whether the cause of the error is detected to be a timeout.
1526 * It returns false by default, and not all engines support detecting this yet.
1527 * If this returns false, it will be treated as a generic query error.
1529 * @param string $error Error text
1530 * @param int $errno Error number
1533 protected function wasQueryTimeout( $error, $errno ) {
1538 * Report a query error. Log the error, and if neither the object ignore
1539 * flag nor the $ignoreErrors flag is set, throw a DBQueryError.
1541 * @param string $error
1543 * @param string $sql
1544 * @param string $fname
1545 * @param bool $ignoreErrors
1546 * @throws DBQueryError
1548 public function reportQueryError( $error, $errno, $sql, $fname, $ignoreErrors = false ) {
1549 if ( $ignoreErrors ) {
1550 $this->queryLogger
->debug( "SQL ERROR (ignored): $error\n" );
1552 $exception = $this->getQueryExceptionAndLog( $error, $errno, $sql, $fname );
1559 * @param string $error
1560 * @param string|int $errno
1561 * @param string $sql
1562 * @param string $fname
1565 private function getQueryExceptionAndLog( $error, $errno, $sql, $fname ) {
1566 $sql1line = mb_substr( str_replace( "\n", "\\n", $sql ), 0, 5 * 1024 );
1567 $this->queryLogger
->error(
1568 "{fname}\t{db_server}\t{errno}\t{error}\t{sql1line}",
1569 $this->getLogContext( [
1570 'method' => __METHOD__
,
1573 'sql1line' => $sql1line,
1575 'trace' => ( new RuntimeException() )->getTraceAsString()
1578 $this->queryLogger
->debug( "SQL ERROR: " . $error . "\n" );
1579 $wasQueryTimeout = $this->wasQueryTimeout( $error, $errno );
1580 if ( $wasQueryTimeout ) {
1581 $e = new DBQueryTimeoutError( $this, $error, $errno, $sql, $fname );
1583 $e = new DBQueryError( $this, $error, $errno, $sql, $fname );
1589 public function freeResult( $res ) {
1592 public function selectField(
1593 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
1595 if ( $var === '*' ) { // sanity
1596 throw new DBUnexpectedError( $this, "Cannot use a * field: got '$var'" );
1599 if ( !is_array( $options ) ) {
1600 $options = [ $options ];
1603 $options['LIMIT'] = 1;
1605 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1606 if ( $res === false ||
!$this->numRows( $res ) ) {
1610 $row = $this->fetchRow( $res );
1612 if ( $row !== false ) {
1613 return reset( $row );
1619 public function selectFieldValues(
1620 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
1622 if ( $var === '*' ) { // sanity
1623 throw new DBUnexpectedError( $this, "Cannot use a * field" );
1624 } elseif ( !is_string( $var ) ) { // sanity
1625 throw new DBUnexpectedError( $this, "Cannot use an array of fields" );
1628 if ( !is_array( $options ) ) {
1629 $options = [ $options ];
1632 $res = $this->select( $table, [ 'value' => $var ], $cond, $fname, $options, $join_conds );
1633 if ( $res === false ) {
1638 foreach ( $res as $row ) {
1639 $values[] = $row->value
;
1646 * Returns an optional USE INDEX clause to go after the table, and a
1647 * string to go at the end of the query.
1649 * @param array $options Associative array of options to be turned into
1650 * an SQL query, valid keys are listed in the function.
1652 * @see Database::select()
1654 protected function makeSelectOptions( $options ) {
1655 $preLimitTail = $postLimitTail = '';
1660 foreach ( $options as $key => $option ) {
1661 if ( is_numeric( $key ) ) {
1662 $noKeyOptions[$option] = true;
1666 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1668 $preLimitTail .= $this->makeOrderBy( $options );
1670 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1671 $postLimitTail .= ' FOR UPDATE';
1674 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1675 $postLimitTail .= ' LOCK IN SHARE MODE';
1678 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) {
1679 $startOpts .= 'DISTINCT';
1682 # Various MySQL extensions
1683 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1684 $startOpts .= ' /*! STRAIGHT_JOIN */';
1687 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1688 $startOpts .= ' HIGH_PRIORITY';
1691 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1692 $startOpts .= ' SQL_BIG_RESULT';
1695 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1696 $startOpts .= ' SQL_BUFFER_RESULT';
1699 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1700 $startOpts .= ' SQL_SMALL_RESULT';
1703 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1704 $startOpts .= ' SQL_CALC_FOUND_ROWS';
1707 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1708 $startOpts .= ' SQL_CACHE';
1711 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1712 $startOpts .= ' SQL_NO_CACHE';
1715 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1716 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1720 if ( isset( $options['IGNORE INDEX'] ) && is_string( $options['IGNORE INDEX'] ) ) {
1721 $ignoreIndex = $this->ignoreIndexClause( $options['IGNORE INDEX'] );
1726 return [ $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ];
1730 * Returns an optional GROUP BY with an optional HAVING
1732 * @param array $options Associative array of options
1734 * @see Database::select()
1737 protected function makeGroupByWithHaving( $options ) {
1739 if ( isset( $options['GROUP BY'] ) ) {
1740 $gb = is_array( $options['GROUP BY'] )
1741 ?
implode( ',', $options['GROUP BY'] )
1742 : $options['GROUP BY'];
1743 $sql .= ' GROUP BY ' . $gb;
1745 if ( isset( $options['HAVING'] ) ) {
1746 $having = is_array( $options['HAVING'] )
1747 ?
$this->makeList( $options['HAVING'], self
::LIST_AND
)
1748 : $options['HAVING'];
1749 $sql .= ' HAVING ' . $having;
1756 * Returns an optional ORDER BY
1758 * @param array $options Associative array of options
1760 * @see Database::select()
1763 protected function makeOrderBy( $options ) {
1764 if ( isset( $options['ORDER BY'] ) ) {
1765 $ob = is_array( $options['ORDER BY'] )
1766 ?
implode( ',', $options['ORDER BY'] )
1767 : $options['ORDER BY'];
1769 return ' ORDER BY ' . $ob;
1775 public function select(
1776 $table, $vars, $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1778 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1780 return $this->query( $sql, $fname );
1783 public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__
,
1784 $options = [], $join_conds = []
1786 if ( is_array( $vars ) ) {
1787 $fields = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1792 $options = (array)$options;
1793 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1794 ?
$options['USE INDEX']
1797 isset( $options['IGNORE INDEX'] ) &&
1798 is_array( $options['IGNORE INDEX'] )
1800 ?
$options['IGNORE INDEX']
1804 $this->selectOptionsIncludeLocking( $options ) &&
1805 $this->selectFieldsOrOptionsAggregate( $vars, $options )
1807 // Some DB types (postgres/oracle) disallow FOR UPDATE with aggregate
1808 // functions. Discourage use of such queries to encourage compatibility.
1810 $this->deprecationLogger
,
1811 __METHOD__
. ": aggregation used with a locking SELECT ($fname)."
1815 if ( is_array( $table ) ) {
1817 $this->tableNamesWithIndexClauseOrJOIN(
1818 $table, $useIndexes, $ignoreIndexes, $join_conds );
1819 } elseif ( $table != '' ) {
1821 $this->tableNamesWithIndexClauseOrJOIN(
1822 [ $table ], $useIndexes, $ignoreIndexes, [] );
1827 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ) =
1828 $this->makeSelectOptions( $options );
1830 if ( is_array( $conds ) ) {
1831 $conds = $this->makeList( $conds, self
::LIST_AND
);
1834 if ( $conds === null ||
$conds === false ) {
1835 $this->queryLogger
->warning(
1839 . ' with incorrect parameters: $conds must be a string or an array'
1844 if ( $conds === '' ||
$conds === '*' ) {
1845 $sql = "SELECT $startOpts $fields $from $useIndex $ignoreIndex $preLimitTail";
1846 } elseif ( is_string( $conds ) ) {
1847 $sql = "SELECT $startOpts $fields $from $useIndex $ignoreIndex " .
1848 "WHERE $conds $preLimitTail";
1850 throw new DBUnexpectedError( $this, __METHOD__
. ' called with incorrect parameters' );
1853 if ( isset( $options['LIMIT'] ) ) {
1854 $sql = $this->limitResult( $sql, $options['LIMIT'],
1855 $options['OFFSET'] ??
false );
1857 $sql = "$sql $postLimitTail";
1859 if ( isset( $options['EXPLAIN'] ) ) {
1860 $sql = 'EXPLAIN ' . $sql;
1866 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
1867 $options = [], $join_conds = []
1869 $options = (array)$options;
1870 $options['LIMIT'] = 1;
1871 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1873 if ( $res === false ) {
1877 if ( !$this->numRows( $res ) ) {
1881 $obj = $this->fetchObject( $res );
1886 public function estimateRowCount(
1887 $table, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1889 $conds = $this->normalizeConditions( $conds, $fname );
1890 $column = $this->extractSingleFieldFromList( $var );
1891 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
1892 $conds[] = "$column IS NOT NULL";
1895 $res = $this->select(
1896 $table, [ 'rowcount' => 'COUNT(*)' ], $conds, $fname, $options, $join_conds
1898 $row = $res ?
$this->fetchRow( $res ) : [];
1900 return isset( $row['rowcount'] ) ?
(int)$row['rowcount'] : 0;
1903 public function selectRowCount(
1904 $tables, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1906 $conds = $this->normalizeConditions( $conds, $fname );
1907 $column = $this->extractSingleFieldFromList( $var );
1908 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
1909 $conds[] = "$column IS NOT NULL";
1912 $res = $this->select(
1914 'tmp_count' => $this->buildSelectSubquery(
1923 [ 'rowcount' => 'COUNT(*)' ],
1927 $row = $res ?
$this->fetchRow( $res ) : [];
1929 return isset( $row['rowcount'] ) ?
(int)$row['rowcount'] : 0;
1933 * @param string|array $options
1936 private function selectOptionsIncludeLocking( $options ) {
1937 $options = (array)$options;
1938 foreach ( [ 'FOR UPDATE', 'LOCK IN SHARE MODE' ] as $lock ) {
1939 if ( in_array( $lock, $options, true ) ) {
1948 * @param array|string $fields
1949 * @param array|string $options
1952 private function selectFieldsOrOptionsAggregate( $fields, $options ) {
1953 foreach ( (array)$options as $key => $value ) {
1954 if ( is_string( $key ) ) {
1955 if ( preg_match( '/^(?:GROUP BY|HAVING)$/i', $key ) ) {
1958 } elseif ( is_string( $value ) ) {
1959 if ( preg_match( '/^(?:DISTINCT|DISTINCTROW)$/i', $value ) ) {
1965 $regex = '/^(?:COUNT|MIN|MAX|SUM|GROUP_CONCAT|LISTAGG|ARRAY_AGG)\s*\\(/i';
1966 foreach ( (array)$fields as $field ) {
1967 if ( is_string( $field ) && preg_match( $regex, $field ) ) {
1976 * @param array|string $conds
1977 * @param string $fname
1980 final protected function normalizeConditions( $conds, $fname ) {
1981 if ( $conds === null ||
$conds === false ) {
1982 $this->queryLogger
->warning(
1986 . ' with incorrect parameters: $conds must be a string or an array'
1991 if ( !is_array( $conds ) ) {
1992 $conds = ( $conds === '' ) ?
[] : [ $conds ];
1999 * @param array|string $var Field parameter in the style of select()
2000 * @return string|null Column name or null; ignores aliases
2001 * @throws DBUnexpectedError Errors out if multiple columns are given
2003 final protected function extractSingleFieldFromList( $var ) {
2004 if ( is_array( $var ) ) {
2007 } elseif ( count( $var ) == 1 ) {
2008 $column = $var[0] ??
reset( $var );
2010 throw new DBUnexpectedError( $this, __METHOD__
. ': got multiple columns.' );
2019 public function lockForUpdate(
2020 $table, $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
2022 if ( !$this->trxLevel
&& !$this->getFlag( self
::DBO_TRX
) ) {
2023 throw new DBUnexpectedError(
2025 __METHOD__
. ': no transaction is active nor is DBO_TRX set'
2029 $options = (array)$options;
2030 $options[] = 'FOR UPDATE';
2032 return $this->selectRowCount( $table, '*', $conds, $fname, $options, $join_conds );
2036 * Removes most variables from an SQL query and replaces them with X or N for numbers.
2037 * It's only slightly flawed. Don't use for anything important.
2039 * @param string $sql A SQL Query
2043 protected static function generalizeSQL( $sql ) {
2044 # This does the same as the regexp below would do, but in such a way
2045 # as to avoid crashing php on some large strings.
2046 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
2048 $sql = str_replace( "\\\\", '', $sql );
2049 $sql = str_replace( "\\'", '', $sql );
2050 $sql = str_replace( "\\\"", '', $sql );
2051 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
2052 $sql = preg_replace( '/".*"/s', "'X'", $sql );
2054 # All newlines, tabs, etc replaced by single space
2055 $sql = preg_replace( '/\s+/', ' ', $sql );
2058 # except the ones surrounded by characters, e.g. l10n
2059 $sql = preg_replace( '/-?\d+(,-?\d+)+/s', 'N,...,N', $sql );
2060 $sql = preg_replace( '/(?<![a-zA-Z])-?\d+(?![a-zA-Z])/s', 'N', $sql );
2065 public function fieldExists( $table, $field, $fname = __METHOD__
) {
2066 $info = $this->fieldInfo( $table, $field );
2071 public function indexExists( $table, $index, $fname = __METHOD__
) {
2072 if ( !$this->tableExists( $table ) ) {
2076 $info = $this->indexInfo( $table, $index, $fname );
2077 if ( is_null( $info ) ) {
2080 return $info !== false;
2084 abstract public function tableExists( $table, $fname = __METHOD__
);
2086 public function indexUnique( $table, $index ) {
2087 $indexInfo = $this->indexInfo( $table, $index );
2089 if ( !$indexInfo ) {
2093 return !$indexInfo[0]->Non_unique
;
2097 * Helper for Database::insert().
2099 * @param array $options
2102 protected function makeInsertOptions( $options ) {
2103 return implode( ' ', $options );
2106 public function insert( $table, $a, $fname = __METHOD__
, $options = [] ) {
2107 # No rows to insert, easy just return now
2108 if ( !count( $a ) ) {
2112 $table = $this->tableName( $table );
2114 if ( !is_array( $options ) ) {
2115 $options = [ $options ];
2118 $options = $this->makeInsertOptions( $options );
2120 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
2122 $keys = array_keys( $a[0] );
2125 $keys = array_keys( $a );
2128 $sql = 'INSERT ' . $options .
2129 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
2133 foreach ( $a as $row ) {
2139 $sql .= '(' . $this->makeList( $row ) . ')';
2142 $sql .= '(' . $this->makeList( $a ) . ')';
2145 $this->query( $sql, $fname );
2151 * Make UPDATE options array for Database::makeUpdateOptions
2153 * @param array $options
2156 protected function makeUpdateOptionsArray( $options ) {
2157 if ( !is_array( $options ) ) {
2158 $options = [ $options ];
2163 if ( in_array( 'IGNORE', $options ) ) {
2171 * Make UPDATE options for the Database::update function
2173 * @param array $options The options passed to Database::update
2176 protected function makeUpdateOptions( $options ) {
2177 $opts = $this->makeUpdateOptionsArray( $options );
2179 return implode( ' ', $opts );
2182 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] ) {
2183 $table = $this->tableName( $table );
2184 $opts = $this->makeUpdateOptions( $options );
2185 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, self
::LIST_SET
);
2187 if ( $conds !== [] && $conds !== '*' ) {
2188 $sql .= " WHERE " . $this->makeList( $conds, self
::LIST_AND
);
2191 $this->query( $sql, $fname );
2196 public function makeList( $a, $mode = self
::LIST_COMMA
) {
2197 if ( !is_array( $a ) ) {
2198 throw new DBUnexpectedError( $this, __METHOD__
. ' called with incorrect parameters' );
2204 foreach ( $a as $field => $value ) {
2206 if ( $mode == self
::LIST_AND
) {
2208 } elseif ( $mode == self
::LIST_OR
) {
2217 if ( ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) && is_numeric( $field ) ) {
2218 $list .= "($value)";
2219 } elseif ( $mode == self
::LIST_SET
&& is_numeric( $field ) ) {
2222 ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) && is_array( $value )
2224 // Remove null from array to be handled separately if found
2225 $includeNull = false;
2226 foreach ( array_keys( $value, null, true ) as $nullKey ) {
2227 $includeNull = true;
2228 unset( $value[$nullKey] );
2230 if ( count( $value ) == 0 && !$includeNull ) {
2231 throw new InvalidArgumentException(
2232 __METHOD__
. ": empty input for field $field" );
2233 } elseif ( count( $value ) == 0 ) {
2234 // only check if $field is null
2235 $list .= "$field IS NULL";
2237 // IN clause contains at least one valid element
2238 if ( $includeNull ) {
2239 // Group subconditions to ensure correct precedence
2242 if ( count( $value ) == 1 ) {
2243 // Special-case single values, as IN isn't terribly efficient
2244 // Don't necessarily assume the single key is 0; we don't
2245 // enforce linear numeric ordering on other arrays here.
2246 $value = array_values( $value )[0];
2247 $list .= $field . " = " . $this->addQuotes( $value );
2249 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
2251 // if null present in array, append IS NULL
2252 if ( $includeNull ) {
2253 $list .= " OR $field IS NULL)";
2256 } elseif ( $value === null ) {
2257 if ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) {
2258 $list .= "$field IS ";
2259 } elseif ( $mode == self
::LIST_SET
) {
2260 $list .= "$field = ";
2265 $mode == self
::LIST_AND ||
$mode == self
::LIST_OR ||
$mode == self
::LIST_SET
2267 $list .= "$field = ";
2269 $list .= $mode == self
::LIST_NAMES ?
$value : $this->addQuotes( $value );
2276 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
2279 foreach ( $data as $base => $sub ) {
2280 if ( count( $sub ) ) {
2281 $conds[] = $this->makeList(
2282 [ $baseKey => $base, $subKey => array_keys( $sub ) ],
2288 return $this->makeList( $conds, self
::LIST_OR
);
2290 // Nothing to search for...
2295 public function aggregateValue( $valuedata, $valuename = 'value' ) {
2299 public function bitNot( $field ) {
2303 public function bitAnd( $fieldLeft, $fieldRight ) {
2304 return "($fieldLeft & $fieldRight)";
2307 public function bitOr( $fieldLeft, $fieldRight ) {
2308 return "($fieldLeft | $fieldRight)";
2311 public function buildConcat( $stringList ) {
2312 return 'CONCAT(' . implode( ',', $stringList ) . ')';
2315 public function buildGroupConcatField(
2316 $delim, $table, $field, $conds = '', $join_conds = []
2318 $fld = "GROUP_CONCAT($field SEPARATOR " . $this->addQuotes( $delim ) . ')';
2320 return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
2323 public function buildSubstring( $input, $startPosition, $length = null ) {
2324 $this->assertBuildSubstringParams( $startPosition, $length );
2325 $functionBody = "$input FROM $startPosition";
2326 if ( $length !== null ) {
2327 $functionBody .= " FOR $length";
2329 return 'SUBSTRING(' . $functionBody . ')';
2333 * Check type and bounds for parameters to self::buildSubstring()
2335 * All supported databases have substring functions that behave the same for
2336 * positive $startPosition and non-negative $length, but behaviors differ when
2337 * given 0 or negative $startPosition or negative $length. The simplest
2338 * solution to that is to just forbid those values.
2340 * @param int $startPosition
2341 * @param int|null $length
2344 protected function assertBuildSubstringParams( $startPosition, $length ) {
2345 if ( !is_int( $startPosition ) ||
$startPosition <= 0 ) {
2346 throw new InvalidArgumentException(
2347 '$startPosition must be a positive integer'
2350 if ( !( is_int( $length ) && $length >= 0 ||
$length === null ) ) {
2351 throw new InvalidArgumentException(
2352 '$length must be null or an integer greater than or equal to 0'
2357 public function buildStringCast( $field ) {
2358 // In theory this should work for any standards-compliant
2359 // SQL implementation, although it may not be the best way to do it.
2360 return "CAST( $field AS CHARACTER )";
2363 public function buildIntegerCast( $field ) {
2364 return 'CAST( ' . $field . ' AS INTEGER )';
2367 public function buildSelectSubquery(
2368 $table, $vars, $conds = '', $fname = __METHOD__
,
2369 $options = [], $join_conds = []
2371 return new Subquery(
2372 $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds )
2376 public function databasesAreIndependent() {
2380 final public function selectDB( $db ) {
2381 $this->selectDomain( new DatabaseDomain(
2383 $this->currentDomain
->getSchema(),
2384 $this->currentDomain
->getTablePrefix()
2390 final public function selectDomain( $domain ) {
2391 $this->doSelectDomain( DatabaseDomain
::newFromId( $domain ) );
2394 protected function doSelectDomain( DatabaseDomain
$domain ) {
2395 $this->currentDomain
= $domain;
2398 public function getDBname() {
2399 return $this->currentDomain
->getDatabase();
2402 public function getServer() {
2403 return $this->server
;
2406 public function tableName( $name, $format = 'quoted' ) {
2407 if ( $name instanceof Subquery
) {
2408 throw new DBUnexpectedError(
2410 __METHOD__
. ': got Subquery instance when expecting a string.'
2414 # Skip the entire process when we have a string quoted on both ends.
2415 # Note that we check the end so that we will still quote any use of
2416 # use of `database`.table. But won't break things if someone wants
2417 # to query a database table with a dot in the name.
2418 if ( $this->isQuotedIdentifier( $name ) ) {
2422 # Lets test for any bits of text that should never show up in a table
2423 # name. Basically anything like JOIN or ON which are actually part of
2424 # SQL queries, but may end up inside of the table value to combine
2425 # sql. Such as how the API is doing.
2426 # Note that we use a whitespace test rather than a \b test to avoid
2427 # any remote case where a word like on may be inside of a table name
2428 # surrounded by symbols which may be considered word breaks.
2429 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
2430 $this->queryLogger
->warning(
2431 __METHOD__
. ": use of subqueries is not supported this way.",
2432 [ 'trace' => ( new RuntimeException() )->getTraceAsString() ]
2438 # Split database and table into proper variables.
2439 list( $database, $schema, $prefix, $table ) = $this->qualifiedTableComponents( $name );
2441 # Quote $table and apply the prefix if not quoted.
2442 # $tableName might be empty if this is called from Database::replaceVars()
2443 $tableName = "{$prefix}{$table}";
2444 if ( $format === 'quoted'
2445 && !$this->isQuotedIdentifier( $tableName )
2446 && $tableName !== ''
2448 $tableName = $this->addIdentifierQuotes( $tableName );
2451 # Quote $schema and $database and merge them with the table name if needed
2452 $tableName = $this->prependDatabaseOrSchema( $schema, $tableName, $format );
2453 $tableName = $this->prependDatabaseOrSchema( $database, $tableName, $format );
2459 * Get the table components needed for a query given the currently selected database
2461 * @param string $name Table name in the form of db.schema.table, db.table, or table
2462 * @return array (DB name or "" for default, schema name, table prefix, table name)
2464 protected function qualifiedTableComponents( $name ) {
2465 # We reverse the explode so that database.table and table both output the correct table.
2466 $dbDetails = explode( '.', $name, 3 );
2467 if ( count( $dbDetails ) == 3 ) {
2468 list( $database, $schema, $table ) = $dbDetails;
2469 # We don't want any prefix added in this case
2471 } elseif ( count( $dbDetails ) == 2 ) {
2472 list( $database, $table ) = $dbDetails;
2473 # We don't want any prefix added in this case
2475 # In dbs that support it, $database may actually be the schema
2476 # but that doesn't affect any of the functionality here
2479 list( $table ) = $dbDetails;
2480 if ( isset( $this->tableAliases
[$table] ) ) {
2481 $database = $this->tableAliases
[$table]['dbname'];
2482 $schema = is_string( $this->tableAliases
[$table]['schema'] )
2483 ?
$this->tableAliases
[$table]['schema']
2484 : $this->relationSchemaQualifier();
2485 $prefix = is_string( $this->tableAliases
[$table]['prefix'] )
2486 ?
$this->tableAliases
[$table]['prefix']
2487 : $this->tablePrefix();
2490 $schema = $this->relationSchemaQualifier(); # Default schema
2491 $prefix = $this->tablePrefix(); # Default prefix
2495 return [ $database, $schema, $prefix, $table ];
2499 * @param string|null $namespace Database or schema
2500 * @param string $relation Name of table, view, sequence, etc...
2501 * @param string $format One of (raw, quoted)
2502 * @return string Relation name with quoted and merged $namespace as needed
2504 private function prependDatabaseOrSchema( $namespace, $relation, $format ) {
2505 if ( strlen( $namespace ) ) {
2506 if ( $format === 'quoted' && !$this->isQuotedIdentifier( $namespace ) ) {
2507 $namespace = $this->addIdentifierQuotes( $namespace );
2509 $relation = $namespace . '.' . $relation;
2515 public function tableNames() {
2516 $inArray = func_get_args();
2519 foreach ( $inArray as $name ) {
2520 $retVal[$name] = $this->tableName( $name );
2526 public function tableNamesN() {
2527 $inArray = func_get_args();
2530 foreach ( $inArray as $name ) {
2531 $retVal[] = $this->tableName( $name );
2538 * Get an aliased table name
2540 * This returns strings like "tableName AS newTableName" for aliased tables
2541 * and "(SELECT * from tableA) newTablename" for subqueries (e.g. derived tables)
2543 * @see Database::tableName()
2544 * @param string|Subquery $table Table name or object with a 'sql' field
2545 * @param string|bool $alias Table alias (optional)
2546 * @return string SQL name for aliased table. Will not alias a table to its own name
2548 protected function tableNameWithAlias( $table, $alias = false ) {
2549 if ( is_string( $table ) ) {
2550 $quotedTable = $this->tableName( $table );
2551 } elseif ( $table instanceof Subquery
) {
2552 $quotedTable = (string)$table;
2554 throw new InvalidArgumentException( "Table must be a string or Subquery." );
2557 if ( $alias === false ||
$alias === $table ) {
2558 if ( $table instanceof Subquery
) {
2559 throw new InvalidArgumentException( "Subquery table missing alias." );
2562 return $quotedTable;
2564 return $quotedTable . ' ' . $this->addIdentifierQuotes( $alias );
2569 * Gets an array of aliased table names
2571 * @param array $tables [ [alias] => table ]
2572 * @return string[] See tableNameWithAlias()
2574 protected function tableNamesWithAlias( $tables ) {
2576 foreach ( $tables as $alias => $table ) {
2577 if ( is_numeric( $alias ) ) {
2580 $retval[] = $this->tableNameWithAlias( $table, $alias );
2587 * Get an aliased field name
2588 * e.g. fieldName AS newFieldName
2590 * @param string $name Field name
2591 * @param string|bool $alias Alias (optional)
2592 * @return string SQL name for aliased field. Will not alias a field to its own name
2594 protected function fieldNameWithAlias( $name, $alias = false ) {
2595 if ( !$alias ||
(string)$alias === (string)$name ) {
2598 return $name . ' AS ' . $this->addIdentifierQuotes( $alias ); // PostgreSQL needs AS
2603 * Gets an array of aliased field names
2605 * @param array $fields [ [alias] => field ]
2606 * @return string[] See fieldNameWithAlias()
2608 protected function fieldNamesWithAlias( $fields ) {
2610 foreach ( $fields as $alias => $field ) {
2611 if ( is_numeric( $alias ) ) {
2614 $retval[] = $this->fieldNameWithAlias( $field, $alias );
2621 * Get the aliased table name clause for a FROM clause
2622 * which might have a JOIN and/or USE INDEX or IGNORE INDEX clause
2624 * @param array $tables ( [alias] => table )
2625 * @param array $use_index Same as for select()
2626 * @param array $ignore_index Same as for select()
2627 * @param array $join_conds Same as for select()
2630 protected function tableNamesWithIndexClauseOrJOIN(
2631 $tables, $use_index = [], $ignore_index = [], $join_conds = []
2635 $use_index = (array)$use_index;
2636 $ignore_index = (array)$ignore_index;
2637 $join_conds = (array)$join_conds;
2639 foreach ( $tables as $alias => $table ) {
2640 if ( !is_string( $alias ) ) {
2641 // No alias? Set it equal to the table name
2645 if ( is_array( $table ) ) {
2646 // A parenthesized group
2647 if ( count( $table ) > 1 ) {
2648 $joinedTable = '(' .
2649 $this->tableNamesWithIndexClauseOrJOIN(
2650 $table, $use_index, $ignore_index, $join_conds ) . ')';
2653 $innerTable = reset( $table );
2654 $innerAlias = key( $table );
2655 $joinedTable = $this->tableNameWithAlias(
2657 is_string( $innerAlias ) ?
$innerAlias : $innerTable
2661 $joinedTable = $this->tableNameWithAlias( $table, $alias );
2664 // Is there a JOIN clause for this table?
2665 if ( isset( $join_conds[$alias] ) ) {
2666 list( $joinType, $conds ) = $join_conds[$alias];
2667 $tableClause = $joinType;
2668 $tableClause .= ' ' . $joinedTable;
2669 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2670 $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2672 $tableClause .= ' ' . $use;
2675 if ( isset( $ignore_index[$alias] ) ) { // has IGNORE INDEX?
2676 $ignore = $this->ignoreIndexClause(
2677 implode( ',', (array)$ignore_index[$alias] ) );
2678 if ( $ignore != '' ) {
2679 $tableClause .= ' ' . $ignore;
2682 $on = $this->makeList( (array)$conds, self
::LIST_AND
);
2684 $tableClause .= ' ON (' . $on . ')';
2687 $retJOIN[] = $tableClause;
2688 } elseif ( isset( $use_index[$alias] ) ) {
2689 // Is there an INDEX clause for this table?
2690 $tableClause = $joinedTable;
2691 $tableClause .= ' ' . $this->useIndexClause(
2692 implode( ',', (array)$use_index[$alias] )
2695 $ret[] = $tableClause;
2696 } elseif ( isset( $ignore_index[$alias] ) ) {
2697 // Is there an INDEX clause for this table?
2698 $tableClause = $joinedTable;
2699 $tableClause .= ' ' . $this->ignoreIndexClause(
2700 implode( ',', (array)$ignore_index[$alias] )
2703 $ret[] = $tableClause;
2705 $tableClause = $joinedTable;
2707 $ret[] = $tableClause;
2711 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2712 $implicitJoins = $ret ?
implode( ',', $ret ) : "";
2713 $explicitJoins = $retJOIN ?
implode( ' ', $retJOIN ) : "";
2715 // Compile our final table clause
2716 return implode( ' ', [ $implicitJoins, $explicitJoins ] );
2720 * Allows for index remapping in queries where this is not consistent across DBMS
2722 * @param string $index
2725 protected function indexName( $index ) {
2726 return $this->indexAliases
[$index] ??
$index;
2729 public function addQuotes( $s ) {
2730 if ( $s instanceof Blob
) {
2733 if ( $s === null ) {
2735 } elseif ( is_bool( $s ) ) {
2738 # This will also quote numeric values. This should be harmless,
2739 # and protects against weird problems that occur when they really
2740 # _are_ strings such as article titles and string->number->string
2741 # conversion is not 1:1.
2742 return "'" . $this->strencode( $s ) . "'";
2746 public function addIdentifierQuotes( $s ) {
2747 return '"' . str_replace( '"', '""', $s ) . '"';
2751 * Returns if the given identifier looks quoted or not according to
2752 * the database convention for quoting identifiers .
2754 * @note Do not use this to determine if untrusted input is safe.
2755 * A malicious user can trick this function.
2756 * @param string $name
2759 public function isQuotedIdentifier( $name ) {
2760 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2765 * @param string $escapeChar
2768 protected function escapeLikeInternal( $s, $escapeChar = '`' ) {
2769 return str_replace( [ $escapeChar, '%', '_' ],
2770 [ "{$escapeChar}{$escapeChar}", "{$escapeChar}%", "{$escapeChar}_" ],
2774 public function buildLike() {
2775 $params = func_get_args();
2777 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2778 $params = $params[0];
2783 // We use ` instead of \ as the default LIKE escape character, since addQuotes()
2784 // may escape backslashes, creating problems of double escaping. The `
2785 // character has good cross-DBMS compatibility, avoiding special operators
2786 // in MS SQL like ^ and %
2789 foreach ( $params as $value ) {
2790 if ( $value instanceof LikeMatch
) {
2791 $s .= $value->toString();
2793 $s .= $this->escapeLikeInternal( $value, $escapeChar );
2798 $this->addQuotes( $s ) . ' ESCAPE ' . $this->addQuotes( $escapeChar ) . ' ';
2801 public function anyChar() {
2802 return new LikeMatch( '_' );
2805 public function anyString() {
2806 return new LikeMatch( '%' );
2809 public function nextSequenceValue( $seqName ) {
2814 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2815 * is only needed because a) MySQL must be as efficient as possible due to
2816 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2817 * which index to pick. Anyway, other databases might have different
2818 * indexes on a given table. So don't bother overriding this unless you're
2820 * @param string $index
2823 public function useIndexClause( $index ) {
2828 * IGNORE INDEX clause. Unlikely to be useful for anything but MySQL. This
2829 * is only needed because a) MySQL must be as efficient as possible due to
2830 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2831 * which index to pick. Anyway, other databases might have different
2832 * indexes on a given table. So don't bother overriding this unless you're
2834 * @param string $index
2837 public function ignoreIndexClause( $index ) {
2841 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
2842 if ( count( $rows ) == 0 ) {
2846 $uniqueIndexes = (array)$uniqueIndexes;
2848 if ( !is_array( reset( $rows ) ) ) {
2853 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
2854 $affectedRowCount = 0;
2855 foreach ( $rows as $row ) {
2856 // Delete rows which collide with this one
2857 $indexWhereClauses = [];
2858 foreach ( $uniqueIndexes as $index ) {
2859 $indexColumns = (array)$index;
2860 $indexRowValues = array_intersect_key( $row, array_flip( $indexColumns ) );
2861 if ( count( $indexRowValues ) != count( $indexColumns ) ) {
2862 throw new DBUnexpectedError(
2864 'New record does not provide all values for unique key (' .
2865 implode( ', ', $indexColumns ) . ')'
2867 } elseif ( in_array( null, $indexRowValues, true ) ) {
2868 throw new DBUnexpectedError(
2870 'New record has a null value for unique key (' .
2871 implode( ', ', $indexColumns ) . ')'
2874 $indexWhereClauses[] = $this->makeList( $indexRowValues, LIST_AND
);
2877 if ( $indexWhereClauses ) {
2878 $this->delete( $table, $this->makeList( $indexWhereClauses, LIST_OR
), $fname );
2879 $affectedRowCount +
= $this->affectedRows();
2882 // Now insert the row
2883 $this->insert( $table, $row, $fname );
2884 $affectedRowCount +
= $this->affectedRows();
2886 $this->endAtomic( $fname );
2887 $this->affectedRowCount
= $affectedRowCount;
2888 } catch ( Exception
$e ) {
2889 $this->cancelAtomic( $fname );
2895 * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2898 * @param string $table Table name
2899 * @param array|string $rows Row(s) to insert
2900 * @param string $fname Caller function name
2902 protected function nativeReplace( $table, $rows, $fname ) {
2903 $table = $this->tableName( $table );
2906 if ( !is_array( reset( $rows ) ) ) {
2910 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2913 foreach ( $rows as $row ) {
2920 $sql .= '(' . $this->makeList( $row ) . ')';
2923 $this->query( $sql, $fname );
2926 public function upsert( $table, array $rows, $uniqueIndexes, array $set,
2929 if ( $rows === [] ) {
2930 return true; // nothing to do
2933 $uniqueIndexes = (array)$uniqueIndexes;
2934 if ( !is_array( reset( $rows ) ) ) {
2938 if ( count( $uniqueIndexes ) ) {
2939 $clauses = []; // list WHERE clauses that each identify a single row
2940 foreach ( $rows as $row ) {
2941 foreach ( $uniqueIndexes as $index ) {
2942 $index = is_array( $index ) ?
$index : [ $index ]; // columns
2943 $rowKey = []; // unique key to this row
2944 foreach ( $index as $column ) {
2945 $rowKey[$column] = $row[$column];
2947 $clauses[] = $this->makeList( $rowKey, self
::LIST_AND
);
2950 $where = [ $this->makeList( $clauses, self
::LIST_OR
) ];
2955 $affectedRowCount = 0;
2957 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
2958 # Update any existing conflicting row(s)
2959 if ( $where !== false ) {
2960 $this->update( $table, $set, $where, $fname );
2961 $affectedRowCount +
= $this->affectedRows();
2963 # Now insert any non-conflicting row(s)
2964 $this->insert( $table, $rows, $fname, [ 'IGNORE' ] );
2965 $affectedRowCount +
= $this->affectedRows();
2966 $this->endAtomic( $fname );
2967 $this->affectedRowCount
= $affectedRowCount;
2968 } catch ( Exception
$e ) {
2969 $this->cancelAtomic( $fname );
2976 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2980 throw new DBUnexpectedError( $this, __METHOD__
. ' called with empty $conds' );
2983 $delTable = $this->tableName( $delTable );
2984 $joinTable = $this->tableName( $joinTable );
2985 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2986 if ( $conds != '*' ) {
2987 $sql .= 'WHERE ' . $this->makeList( $conds, self
::LIST_AND
);
2991 $this->query( $sql, $fname );
2994 public function textFieldSize( $table, $field ) {
2995 $table = $this->tableName( $table );
2996 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2997 $res = $this->query( $sql, __METHOD__
);
2998 $row = $this->fetchObject( $res );
3002 if ( preg_match( '/\((.*)\)/', $row->Type
, $m ) ) {
3011 public function delete( $table, $conds, $fname = __METHOD__
) {
3013 throw new DBUnexpectedError( $this, __METHOD__
. ' called with no conditions' );
3016 $table = $this->tableName( $table );
3017 $sql = "DELETE FROM $table";
3019 if ( $conds != '*' ) {
3020 if ( is_array( $conds ) ) {
3021 $conds = $this->makeList( $conds, self
::LIST_AND
);
3023 $sql .= ' WHERE ' . $conds;
3026 $this->query( $sql, $fname );
3031 final public function insertSelect(
3032 $destTable, $srcTable, $varMap, $conds,
3033 $fname = __METHOD__
, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3035 static $hints = [ 'NO_AUTO_COLUMNS' ];
3037 $insertOptions = (array)$insertOptions;
3038 $selectOptions = (array)$selectOptions;
3040 if ( $this->cliMode
&& $this->isInsertSelectSafe( $insertOptions, $selectOptions ) ) {
3041 // For massive migrations with downtime, we don't want to select everything
3042 // into memory and OOM, so do all this native on the server side if possible.
3043 $this->nativeInsertSelect(
3049 array_diff( $insertOptions, $hints ),
3054 $this->nonNativeInsertSelect(
3060 array_diff( $insertOptions, $hints ),
3070 * @param array $insertOptions INSERT options
3071 * @param array $selectOptions SELECT options
3072 * @return bool Whether an INSERT SELECT with these options will be replication safe
3075 protected function isInsertSelectSafe( array $insertOptions, array $selectOptions ) {
3080 * Implementation of insertSelect() based on select() and insert()
3082 * @see IDatabase::insertSelect()
3084 * @param string $destTable
3085 * @param string|array $srcTable
3086 * @param array $varMap
3087 * @param array $conds
3088 * @param string $fname
3089 * @param array $insertOptions
3090 * @param array $selectOptions
3091 * @param array $selectJoinConds
3093 protected function nonNativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
3094 $fname = __METHOD__
,
3095 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3097 // For web requests, do a locking SELECT and then INSERT. This puts the SELECT burden
3098 // on only the master (without needing row-based-replication). It also makes it easy to
3099 // know how big the INSERT is going to be.
3101 foreach ( $varMap as $dstColumn => $sourceColumnOrSql ) {
3102 $fields[] = $this->fieldNameWithAlias( $sourceColumnOrSql, $dstColumn );
3104 $selectOptions[] = 'FOR UPDATE';
3105 $res = $this->select(
3106 $srcTable, implode( ',', $fields ), $conds, $fname, $selectOptions, $selectJoinConds
3113 $affectedRowCount = 0;
3114 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
3117 foreach ( $res as $row ) {
3118 $rows[] = (array)$row;
3120 // Avoid inserts that are too huge
3121 if ( count( $rows ) >= $this->nonNativeInsertSelectBatchSize
) {
3122 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
3126 $affectedRowCount +
= $this->affectedRows();
3130 if ( $rows && $ok ) {
3131 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
3133 $affectedRowCount +
= $this->affectedRows();
3137 $this->endAtomic( $fname );
3138 $this->affectedRowCount
= $affectedRowCount;
3140 $this->cancelAtomic( $fname );
3142 } catch ( Exception
$e ) {
3143 $this->cancelAtomic( $fname );
3149 * Native server-side implementation of insertSelect() for situations where
3150 * we don't want to select everything into memory
3152 * @see IDatabase::insertSelect()
3153 * @param string $destTable
3154 * @param string|array $srcTable
3155 * @param array $varMap
3156 * @param array $conds
3157 * @param string $fname
3158 * @param array $insertOptions
3159 * @param array $selectOptions
3160 * @param array $selectJoinConds
3162 protected function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
3163 $fname = __METHOD__
,
3164 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3166 $destTable = $this->tableName( $destTable );
3168 if ( !is_array( $insertOptions ) ) {
3169 $insertOptions = [ $insertOptions ];
3172 $insertOptions = $this->makeInsertOptions( $insertOptions );
3174 $selectSql = $this->selectSQLText(
3176 array_values( $varMap ),
3183 $sql = "INSERT $insertOptions" .
3184 " INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ') ' .
3187 $this->query( $sql, $fname );
3191 * Construct a LIMIT query with optional offset. This is used for query
3192 * pages. The SQL should be adjusted so that only the first $limit rows
3193 * are returned. If $offset is provided as well, then the first $offset
3194 * rows should be discarded, and the next $limit rows should be returned.
3195 * If the result of the query is not ordered, then the rows to be returned
3196 * are theoretically arbitrary.
3198 * $sql is expected to be a SELECT, if that makes a difference.
3200 * The version provided by default works in MySQL and SQLite. It will very
3201 * likely need to be overridden for most other DBMSes.
3203 * @param string $sql SQL query we will append the limit too
3204 * @param int $limit The SQL limit
3205 * @param int|bool $offset The SQL offset (default false)
3206 * @throws DBUnexpectedError
3209 public function limitResult( $sql, $limit, $offset = false ) {
3210 if ( !is_numeric( $limit ) ) {
3211 throw new DBUnexpectedError( $this,
3212 "Invalid non-numeric limit passed to limitResult()\n" );
3215 return "$sql LIMIT "
3216 . ( ( is_numeric( $offset ) && $offset != 0 ) ?
"{$offset}," : "" )
3220 public function unionSupportsOrderAndLimit() {
3221 return true; // True for almost every DB supported
3224 public function unionQueries( $sqls, $all ) {
3225 $glue = $all ?
') UNION ALL (' : ') UNION (';
3227 return '(' . implode( $glue, $sqls ) . ')';
3230 public function unionConditionPermutations(
3231 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__
,
3232 $options = [], $join_conds = []
3234 // First, build the Cartesian product of $permute_conds
3236 foreach ( $permute_conds as $field => $values ) {
3238 // Skip empty $values
3241 $values = array_unique( $values ); // For sanity
3243 foreach ( $conds as $cond ) {
3244 foreach ( $values as $value ) {
3245 $cond[$field] = $value;
3246 $newConds[] = $cond; // Arrays are by-value, not by-reference, so this works
3252 $extra_conds = $extra_conds === '' ?
[] : (array)$extra_conds;
3254 // If there's just one condition and no subordering, hand off to
3255 // selectSQLText directly.
3256 if ( count( $conds ) === 1 &&
3257 ( !isset( $options['INNER ORDER BY'] ) ||
!$this->unionSupportsOrderAndLimit() )
3259 return $this->selectSQLText(
3260 $table, $vars, $conds[0] +
$extra_conds, $fname, $options, $join_conds
3264 // Otherwise, we need to pull out the order and limit to apply after
3265 // the union. Then build the SQL queries for each set of conditions in
3266 // $conds. Then union them together (using UNION ALL, because the
3267 // product *should* already be distinct).
3268 $orderBy = $this->makeOrderBy( $options );
3269 $limit = $options['LIMIT'] ??
null;
3270 $offset = $options['OFFSET'] ??
false;
3271 $all = empty( $options['NOTALL'] ) && !in_array( 'NOTALL', $options );
3272 if ( !$this->unionSupportsOrderAndLimit() ) {
3273 unset( $options['ORDER BY'], $options['LIMIT'], $options['OFFSET'] );
3275 if ( array_key_exists( 'INNER ORDER BY', $options ) ) {
3276 $options['ORDER BY'] = $options['INNER ORDER BY'];
3278 if ( $limit !== null && is_numeric( $offset ) && $offset != 0 ) {
3279 // We need to increase the limit by the offset rather than
3280 // using the offset directly, otherwise it'll skip incorrectly
3281 // in the subqueries.
3282 $options['LIMIT'] = $limit +
$offset;
3283 unset( $options['OFFSET'] );
3288 foreach ( $conds as $cond ) {
3289 $sqls[] = $this->selectSQLText(
3290 $table, $vars, $cond +
$extra_conds, $fname, $options, $join_conds
3293 $sql = $this->unionQueries( $sqls, $all ) . $orderBy;
3294 if ( $limit !== null ) {
3295 $sql = $this->limitResult( $sql, $limit, $offset );
3301 public function conditional( $cond, $trueVal, $falseVal ) {
3302 if ( is_array( $cond ) ) {
3303 $cond = $this->makeList( $cond, self
::LIST_AND
);
3306 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
3309 public function strreplace( $orig, $old, $new ) {
3310 return "REPLACE({$orig}, {$old}, {$new})";
3313 public function getServerUptime() {
3317 public function wasDeadlock() {
3321 public function wasLockTimeout() {
3325 public function wasConnectionLoss() {
3326 return $this->wasConnectionError( $this->lastErrno() );
3329 public function wasReadOnlyError() {
3333 public function wasErrorReissuable() {
3335 $this->wasDeadlock() ||
3336 $this->wasLockTimeout() ||
3337 $this->wasConnectionLoss()
3342 * Do not use this method outside of Database/DBError classes
3344 * @param int|string $errno
3345 * @return bool Whether the given query error was a connection drop
3347 public function wasConnectionError( $errno ) {
3352 * @return bool Whether it is known that the last query error only caused statement rollback
3353 * @note This is for backwards compatibility for callers catching DBError exceptions in
3354 * order to ignore problems like duplicate key errors or foriegn key violations
3357 protected function wasKnownStatementRollbackError() {
3358 return false; // don't know; it could have caused a transaction rollback
3361 public function deadlockLoop() {
3362 $args = func_get_args();
3363 $function = array_shift( $args );
3364 $tries = self
::DEADLOCK_TRIES
;
3366 $this->begin( __METHOD__
);
3369 /** @var Exception $e */
3373 $retVal = $function( ...$args );
3375 } catch ( DBQueryError
$e ) {
3376 if ( $this->wasDeadlock() ) {
3377 // Retry after a randomized delay
3378 usleep( mt_rand( self
::DEADLOCK_DELAY_MIN
, self
::DEADLOCK_DELAY_MAX
) );
3380 // Throw the error back up
3384 } while ( --$tries > 0 );
3386 if ( $tries <= 0 ) {
3387 // Too many deadlocks; give up
3388 $this->rollback( __METHOD__
);
3391 $this->commit( __METHOD__
);
3397 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
3398 # Real waits are implemented in the subclass.
3402 public function getReplicaPos() {
3407 public function getMasterPos() {
3412 public function serverIsReadOnly() {
3416 final public function onTransactionResolution( callable
$callback, $fname = __METHOD__
) {
3417 if ( !$this->trxLevel
) {
3418 throw new DBUnexpectedError( $this, "No transaction is active." );
3420 $this->trxEndCallbacks
[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3423 final public function onTransactionCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
3424 if ( !$this->trxLevel
&& $this->getTransactionRoundId() ) {
3425 // Start an implicit transaction similar to how query() does
3426 $this->begin( __METHOD__
, self
::TRANSACTION_INTERNAL
);
3427 $this->trxAutomatic
= true;
3430 $this->trxIdleCallbacks
[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3431 if ( !$this->trxLevel
) {
3432 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_IDLE
);
3436 final public function onTransactionIdle( callable
$callback, $fname = __METHOD__
) {
3437 $this->onTransactionCommitOrIdle( $callback, $fname );
3440 final public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
3441 if ( !$this->trxLevel
&& $this->getTransactionRoundId() ) {
3442 // Start an implicit transaction similar to how query() does
3443 $this->begin( __METHOD__
, self
::TRANSACTION_INTERNAL
);
3444 $this->trxAutomatic
= true;
3447 if ( $this->trxLevel
) {
3448 $this->trxPreCommitCallbacks
[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3450 // No transaction is active nor will start implicitly, so make one for this callback
3451 $this->startAtomic( __METHOD__
, self
::ATOMIC_CANCELABLE
);
3454 $this->endAtomic( __METHOD__
);
3455 } catch ( Exception
$e ) {
3456 $this->cancelAtomic( __METHOD__
);
3463 * @return AtomicSectionIdentifier|null ID of the topmost atomic section level
3465 private function currentAtomicSectionId() {
3466 if ( $this->trxLevel
&& $this->trxAtomicLevels
) {
3467 $levelInfo = end( $this->trxAtomicLevels
);
3469 return $levelInfo[1];
3476 * @param AtomicSectionIdentifier $old
3477 * @param AtomicSectionIdentifier $new
3479 private function reassignCallbacksForSection(
3480 AtomicSectionIdentifier
$old, AtomicSectionIdentifier
$new
3482 foreach ( $this->trxPreCommitCallbacks
as $key => $info ) {
3483 if ( $info[2] === $old ) {
3484 $this->trxPreCommitCallbacks
[$key][2] = $new;
3487 foreach ( $this->trxIdleCallbacks
as $key => $info ) {
3488 if ( $info[2] === $old ) {
3489 $this->trxIdleCallbacks
[$key][2] = $new;
3492 foreach ( $this->trxEndCallbacks
as $key => $info ) {
3493 if ( $info[2] === $old ) {
3494 $this->trxEndCallbacks
[$key][2] = $new;
3500 * @param AtomicSectionIdentifier[] $sectionIds ID of an actual savepoint
3501 * @throws UnexpectedValueException
3503 private function modifyCallbacksForCancel( array $sectionIds ) {
3504 // Cancel the "on commit" callbacks owned by this savepoint
3505 $this->trxIdleCallbacks
= array_filter(
3506 $this->trxIdleCallbacks
,
3507 function ( $entry ) use ( $sectionIds ) {
3508 return !in_array( $entry[2], $sectionIds, true );
3511 $this->trxPreCommitCallbacks
= array_filter(
3512 $this->trxPreCommitCallbacks
,
3513 function ( $entry ) use ( $sectionIds ) {
3514 return !in_array( $entry[2], $sectionIds, true );
3517 // Make "on resolution" callbacks owned by this savepoint to perceive a rollback
3518 foreach ( $this->trxEndCallbacks
as $key => $entry ) {
3519 if ( in_array( $entry[2], $sectionIds, true ) ) {
3520 $callback = $entry[0];
3521 $this->trxEndCallbacks
[$key][0] = function () use ( $callback ) {
3522 return $callback( self
::TRIGGER_ROLLBACK
, $this );
3528 final public function setTransactionListener( $name, callable
$callback = null ) {
3530 $this->trxRecurringCallbacks
[$name] = $callback;
3532 unset( $this->trxRecurringCallbacks
[$name] );
3537 * Whether to disable running of post-COMMIT/ROLLBACK callbacks
3539 * This method should not be used outside of Database/LoadBalancer
3541 * @param bool $suppress
3544 final public function setTrxEndCallbackSuppression( $suppress ) {
3545 $this->trxEndCallbacksSuppressed
= $suppress;
3549 * Actually consume and run any "on transaction idle/resolution" callbacks.
3551 * This method should not be used outside of Database/LoadBalancer
3553 * @param int $trigger IDatabase::TRIGGER_* constant
3554 * @return int Number of callbacks attempted
3558 public function runOnTransactionIdleCallbacks( $trigger ) {
3559 if ( $this->trxLevel
) { // sanity
3560 throw new DBUnexpectedError( $this, __METHOD__
. ': a transaction is still open.' );
3563 if ( $this->trxEndCallbacksSuppressed
) {
3568 $autoTrx = $this->getFlag( self
::DBO_TRX
); // automatic begin() enabled?
3569 /** @var Exception $e */
3570 $e = null; // first exception
3571 do { // callbacks may add callbacks :)
3572 $callbacks = array_merge(
3573 $this->trxIdleCallbacks
,
3574 $this->trxEndCallbacks
// include "transaction resolution" callbacks
3576 $this->trxIdleCallbacks
= []; // consumed (and recursion guard)
3577 $this->trxEndCallbacks
= []; // consumed (recursion guard)
3578 foreach ( $callbacks as $callback ) {
3580 list( $phpCallback ) = $callback;
3581 $this->clearFlag( self
::DBO_TRX
); // make each query its own transaction
3583 call_user_func( $phpCallback, $trigger, $this );
3584 } catch ( Exception
$ex ) {
3585 call_user_func( $this->errorLogger
, $ex );
3587 // Some callbacks may use startAtomic/endAtomic, so make sure
3588 // their transactions are ended so other callbacks don't fail
3589 if ( $this->trxLevel() ) {
3590 $this->rollback( __METHOD__
, self
::FLUSHING_INTERNAL
);
3594 $this->setFlag( self
::DBO_TRX
); // restore automatic begin()
3596 $this->clearFlag( self
::DBO_TRX
); // restore auto-commit
3600 } while ( count( $this->trxIdleCallbacks
) );
3602 if ( $e instanceof Exception
) {
3603 throw $e; // re-throw any first exception
3610 * Actually consume and run any "on transaction pre-commit" callbacks.
3612 * This method should not be used outside of Database/LoadBalancer
3615 * @return int Number of callbacks attempted
3618 public function runOnTransactionPreCommitCallbacks() {
3621 $e = null; // first exception
3622 do { // callbacks may add callbacks :)
3623 $callbacks = $this->trxPreCommitCallbacks
;
3624 $this->trxPreCommitCallbacks
= []; // consumed (and recursion guard)
3625 foreach ( $callbacks as $callback ) {
3628 list( $phpCallback ) = $callback;
3629 $phpCallback( $this );
3630 } catch ( Exception
$ex ) {
3631 ( $this->errorLogger
)( $ex );
3635 } while ( count( $this->trxPreCommitCallbacks
) );
3637 if ( $e instanceof Exception
) {
3638 throw $e; // re-throw any first exception
3645 * Actually run any "transaction listener" callbacks.
3647 * This method should not be used outside of Database/LoadBalancer
3649 * @param int $trigger IDatabase::TRIGGER_* constant
3653 public function runTransactionListenerCallbacks( $trigger ) {
3654 if ( $this->trxEndCallbacksSuppressed
) {
3658 /** @var Exception $e */
3659 $e = null; // first exception
3661 foreach ( $this->trxRecurringCallbacks
as $phpCallback ) {
3663 $phpCallback( $trigger, $this );
3664 } catch ( Exception
$ex ) {
3665 ( $this->errorLogger
)( $ex );
3670 if ( $e instanceof Exception
) {
3671 throw $e; // re-throw any first exception
3676 * Create a savepoint
3678 * This is used internally to implement atomic sections. It should not be
3682 * @param string $identifier Identifier for the savepoint
3683 * @param string $fname Calling function name
3685 protected function doSavepoint( $identifier, $fname ) {
3686 $this->query( 'SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3690 * Release a savepoint
3692 * This is used internally to implement atomic sections. It should not be
3696 * @param string $identifier Identifier for the savepoint
3697 * @param string $fname Calling function name
3699 protected function doReleaseSavepoint( $identifier, $fname ) {
3700 $this->query( 'RELEASE SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3704 * Rollback to a savepoint
3706 * This is used internally to implement atomic sections. It should not be
3710 * @param string $identifier Identifier for the savepoint
3711 * @param string $fname Calling function name
3713 protected function doRollbackToSavepoint( $identifier, $fname ) {
3714 $this->query( 'ROLLBACK TO SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3718 * @param string $fname
3721 private function nextSavepointId( $fname ) {
3722 $savepointId = self
::$SAVEPOINT_PREFIX . ++
$this->trxAtomicCounter
;
3723 if ( strlen( $savepointId ) > 30 ) {
3724 // 30 == Oracle's identifier length limit (pre 12c)
3725 // With a 22 character prefix, that puts the highest number at 99999999.
3726 throw new DBUnexpectedError(
3728 'There have been an excessively large number of atomic sections in a transaction'
3729 . " started by $this->trxFname (at $fname)"
3733 return $savepointId;
3736 final public function startAtomic(
3737 $fname = __METHOD__
, $cancelable = self
::ATOMIC_NOT_CANCELABLE
3739 $savepointId = $cancelable === self
::ATOMIC_CANCELABLE ? self
::$NOT_APPLICABLE : null;
3741 if ( !$this->trxLevel
) {
3742 $this->begin( $fname, self
::TRANSACTION_INTERNAL
); // sets trxAutomatic
3743 // If DBO_TRX is set, a series of startAtomic/endAtomic pairs will result
3744 // in all changes being in one transaction to keep requests transactional.
3745 if ( $this->getFlag( self
::DBO_TRX
) ) {
3746 // Since writes could happen in between the topmost atomic sections as part
3747 // of the transaction, those sections will need savepoints.
3748 $savepointId = $this->nextSavepointId( $fname );
3749 $this->doSavepoint( $savepointId, $fname );
3751 $this->trxAutomaticAtomic
= true;
3753 } elseif ( $cancelable === self
::ATOMIC_CANCELABLE
) {
3754 $savepointId = $this->nextSavepointId( $fname );
3755 $this->doSavepoint( $savepointId, $fname );
3758 $sectionId = new AtomicSectionIdentifier
;
3759 $this->trxAtomicLevels
[] = [ $fname, $sectionId, $savepointId ];
3760 $this->queryLogger
->debug( 'startAtomic: entering level ' .
3761 ( count( $this->trxAtomicLevels
) - 1 ) . " ($fname)" );
3766 final public function endAtomic( $fname = __METHOD__
) {
3767 if ( !$this->trxLevel ||
!$this->trxAtomicLevels
) {
3768 throw new DBUnexpectedError( $this, "No atomic section is open (got $fname)." );
3771 // Check if the current section matches $fname
3772 $pos = count( $this->trxAtomicLevels
) - 1;
3773 list( $savedFname, $sectionId, $savepointId ) = $this->trxAtomicLevels
[$pos];
3774 $this->queryLogger
->debug( "endAtomic: leaving level $pos ($fname)" );
3776 if ( $savedFname !== $fname ) {
3777 throw new DBUnexpectedError(
3779 "Invalid atomic section ended (got $fname but expected $savedFname)."
3783 // Remove the last section (no need to re-index the array)
3784 array_pop( $this->trxAtomicLevels
);
3786 if ( !$this->trxAtomicLevels
&& $this->trxAutomaticAtomic
) {
3787 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
3788 } elseif ( $savepointId !== null && $savepointId !== self
::$NOT_APPLICABLE ) {
3789 $this->doReleaseSavepoint( $savepointId, $fname );
3792 // Hoist callback ownership for callbacks in the section that just ended;
3793 // all callbacks should have an owner that is present in trxAtomicLevels.
3794 $currentSectionId = $this->currentAtomicSectionId();
3795 if ( $currentSectionId ) {
3796 $this->reassignCallbacksForSection( $sectionId, $currentSectionId );
3800 final public function cancelAtomic(
3801 $fname = __METHOD__
, AtomicSectionIdentifier
$sectionId = null
3803 if ( !$this->trxLevel ||
!$this->trxAtomicLevels
) {
3804 throw new DBUnexpectedError( $this, "No atomic section is open (got $fname)." );
3807 $excisedFnames = [];
3808 if ( $sectionId !== null ) {
3809 // Find the (last) section with the given $sectionId
3811 foreach ( $this->trxAtomicLevels
as $i => list( $asFname, $asId, $spId ) ) {
3812 if ( $asId === $sectionId ) {
3817 throw new DBUnexpectedError( $this, "Atomic section not found (for $fname)" );
3819 // Remove all descendant sections and re-index the array
3821 $len = count( $this->trxAtomicLevels
);
3822 for ( $i = $pos +
1; $i < $len; ++
$i ) {
3823 $excisedFnames[] = $this->trxAtomicLevels
[$i][0];
3824 $excisedIds[] = $this->trxAtomicLevels
[$i][1];
3826 $this->trxAtomicLevels
= array_slice( $this->trxAtomicLevels
, 0, $pos +
1 );
3827 $this->modifyCallbacksForCancel( $excisedIds );
3830 // Check if the current section matches $fname
3831 $pos = count( $this->trxAtomicLevels
) - 1;
3832 list( $savedFname, $savedSectionId, $savepointId ) = $this->trxAtomicLevels
[$pos];
3834 if ( $excisedFnames ) {
3835 $this->queryLogger
->debug( "cancelAtomic: canceling level $pos ($savedFname) " .
3836 "and descendants " . implode( ', ', $excisedFnames ) );
3838 $this->queryLogger
->debug( "cancelAtomic: canceling level $pos ($savedFname)" );
3841 if ( $savedFname !== $fname ) {
3842 throw new DBUnexpectedError(
3844 "Invalid atomic section ended (got $fname but expected $savedFname)."
3848 // Remove the last section (no need to re-index the array)
3849 array_pop( $this->trxAtomicLevels
);
3850 $this->modifyCallbacksForCancel( [ $savedSectionId ] );
3852 if ( $savepointId !== null ) {
3853 // Rollback the transaction to the state just before this atomic section
3854 if ( $savepointId === self
::$NOT_APPLICABLE ) {
3855 $this->rollback( $fname, self
::FLUSHING_INTERNAL
);
3857 $this->doRollbackToSavepoint( $savepointId, $fname );
3858 $this->trxStatus
= self
::STATUS_TRX_OK
; // no exception; recovered
3859 $this->trxStatusIgnoredCause
= null;
3861 } elseif ( $this->trxStatus
> self
::STATUS_TRX_ERROR
) {
3862 // Put the transaction into an error state if it's not already in one
3863 $this->trxStatus
= self
::STATUS_TRX_ERROR
;
3864 $this->trxStatusCause
= new DBUnexpectedError(
3866 "Uncancelable atomic section canceled (got $fname)."
3870 $this->affectedRowCount
= 0; // for the sake of consistency
3873 final public function doAtomicSection(
3874 $fname, callable
$callback, $cancelable = self
::ATOMIC_NOT_CANCELABLE
3876 $sectionId = $this->startAtomic( $fname, $cancelable );
3878 $res = $callback( $this, $fname );
3879 } catch ( Exception
$e ) {
3880 $this->cancelAtomic( $fname, $sectionId );
3884 $this->endAtomic( $fname );
3889 final public function begin( $fname = __METHOD__
, $mode = self
::TRANSACTION_EXPLICIT
) {
3890 static $modes = [ self
::TRANSACTION_EXPLICIT
, self
::TRANSACTION_INTERNAL
];
3891 if ( !in_array( $mode, $modes, true ) ) {
3892 throw new DBUnexpectedError( $this, "$fname: invalid mode parameter '$mode'." );
3895 // Protect against mismatched atomic section, transaction nesting, and snapshot loss
3896 if ( $this->trxLevel
) {
3897 if ( $this->trxAtomicLevels
) {
3898 $levels = $this->flatAtomicSectionList();
3899 $msg = "$fname: Got explicit BEGIN while atomic section(s) $levels are open.";
3900 throw new DBUnexpectedError( $this, $msg );
3901 } elseif ( !$this->trxAutomatic
) {
3902 $msg = "$fname: Explicit transaction already active (from {$this->trxFname}).";
3903 throw new DBUnexpectedError( $this, $msg );
3905 $msg = "$fname: Implicit transaction already active (from {$this->trxFname}).";
3906 throw new DBUnexpectedError( $this, $msg );
3908 } elseif ( $this->getFlag( self
::DBO_TRX
) && $mode !== self
::TRANSACTION_INTERNAL
) {
3909 $msg = "$fname: Implicit transaction expected (DBO_TRX set).";
3910 throw new DBUnexpectedError( $this, $msg );
3913 $this->assertHasConnectionHandle();
3915 $this->doBegin( $fname );
3916 $this->trxStatus
= self
::STATUS_TRX_OK
;
3917 $this->trxStatusIgnoredCause
= null;
3918 $this->trxAtomicCounter
= 0;
3919 $this->trxTimestamp
= microtime( true );
3920 $this->trxFname
= $fname;
3921 $this->trxDoneWrites
= false;
3922 $this->trxAutomaticAtomic
= false;
3923 $this->trxAtomicLevels
= [];
3924 $this->trxShortId
= sprintf( '%06x', mt_rand( 0, 0xffffff ) );
3925 $this->trxWriteDuration
= 0.0;
3926 $this->trxWriteQueryCount
= 0;
3927 $this->trxWriteAffectedRows
= 0;
3928 $this->trxWriteAdjDuration
= 0.0;
3929 $this->trxWriteAdjQueryCount
= 0;
3930 $this->trxWriteCallers
= [];
3931 // First SELECT after BEGIN will establish the snapshot in REPEATABLE-READ.
3932 // Get an estimate of the replication lag before any such queries.
3933 $this->trxReplicaLag
= null; // clear cached value first
3934 $this->trxReplicaLag
= $this->getApproximateLagStatus()['lag'];
3935 // T147697: make explicitTrxActive() return true until begin() finishes. This way, no
3936 // caller will think its OK to muck around with the transaction just because startAtomic()
3937 // has not yet completed (e.g. setting trxAtomicLevels).
3938 $this->trxAutomatic
= ( $mode === self
::TRANSACTION_INTERNAL
);
3942 * Issues the BEGIN command to the database server.
3944 * @see Database::begin()
3945 * @param string $fname
3947 protected function doBegin( $fname ) {
3948 $this->query( 'BEGIN', $fname );
3949 $this->trxLevel
= 1;
3952 final public function commit( $fname = __METHOD__
, $flush = self
::FLUSHING_ONE
) {
3953 static $modes = [ self
::FLUSHING_ONE
, self
::FLUSHING_ALL_PEERS
, self
::FLUSHING_INTERNAL
];
3954 if ( !in_array( $flush, $modes, true ) ) {
3955 throw new DBUnexpectedError( $this, "$fname: invalid flush parameter '$flush'." );
3958 if ( $this->trxLevel
&& $this->trxAtomicLevels
) {
3959 // There are still atomic sections open; this cannot be ignored
3960 $levels = $this->flatAtomicSectionList();
3961 throw new DBUnexpectedError(
3963 "$fname: Got COMMIT while atomic sections $levels are still open."
3967 if ( $flush === self
::FLUSHING_INTERNAL ||
$flush === self
::FLUSHING_ALL_PEERS
) {
3968 if ( !$this->trxLevel
) {
3969 return; // nothing to do
3970 } elseif ( !$this->trxAutomatic
) {
3971 throw new DBUnexpectedError(
3973 "$fname: Flushing an explicit transaction, getting out of sync."
3976 } elseif ( !$this->trxLevel
) {
3977 $this->queryLogger
->error(
3978 "$fname: No transaction to commit, something got out of sync." );
3979 return; // nothing to do
3980 } elseif ( $this->trxAutomatic
) {
3981 throw new DBUnexpectedError(
3983 "$fname: Expected mass commit of all peer transactions (DBO_TRX set)."
3987 $this->assertHasConnectionHandle();
3989 $this->runOnTransactionPreCommitCallbacks();
3991 $writeTime = $this->pendingWriteQueryDuration( self
::ESTIMATE_DB_APPLY
);
3992 $this->doCommit( $fname );
3993 $this->trxStatus
= self
::STATUS_TRX_NONE
;
3995 if ( $this->trxDoneWrites
) {
3996 $this->lastWriteTime
= microtime( true );
3997 $this->trxProfiler
->transactionWritingOut(
3999 $this->getDomainID(),
4002 $this->trxWriteAffectedRows
4006 // With FLUSHING_ALL_PEERS, callbacks will be explicitly run later
4007 if ( $flush !== self
::FLUSHING_ALL_PEERS
) {
4008 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_COMMIT
);
4009 $this->runTransactionListenerCallbacks( self
::TRIGGER_COMMIT
);
4014 * Issues the COMMIT command to the database server.
4016 * @see Database::commit()
4017 * @param string $fname
4019 protected function doCommit( $fname ) {
4020 if ( $this->trxLevel
) {
4021 $this->query( 'COMMIT', $fname );
4022 $this->trxLevel
= 0;
4026 final public function rollback( $fname = __METHOD__
, $flush = '' ) {
4027 $trxActive = $this->trxLevel
;
4029 if ( $flush !== self
::FLUSHING_INTERNAL
4030 && $flush !== self
::FLUSHING_ALL_PEERS
4031 && $this->getFlag( self
::DBO_TRX
)
4033 throw new DBUnexpectedError(
4035 "$fname: Expected mass rollback of all peer transactions (DBO_TRX set)."
4040 $this->assertHasConnectionHandle();
4042 $this->doRollback( $fname );
4043 $this->trxStatus
= self
::STATUS_TRX_NONE
;
4044 $this->trxAtomicLevels
= [];
4045 // Estimate the RTT via a query now that trxStatus is OK
4046 $writeTime = $this->pingAndCalculateLastTrxApplyTime();
4048 if ( $this->trxDoneWrites
) {
4049 $this->trxProfiler
->transactionWritingOut(
4051 $this->getDomainID(),
4054 $this->trxWriteAffectedRows
4059 // Clear any commit-dependant callbacks. They might even be present
4060 // only due to transaction rounds, with no SQL transaction being active
4061 $this->trxIdleCallbacks
= [];
4062 $this->trxPreCommitCallbacks
= [];
4064 // With FLUSHING_ALL_PEERS, callbacks will be explicitly run later
4065 if ( $trxActive && $flush !== self
::FLUSHING_ALL_PEERS
) {
4067 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_ROLLBACK
);
4068 } catch ( Exception
$e ) {
4069 // already logged; finish and let LoadBalancer move on during mass-rollback
4072 $this->runTransactionListenerCallbacks( self
::TRIGGER_ROLLBACK
);
4073 } catch ( Exception
$e ) {
4074 // already logged; let LoadBalancer move on during mass-rollback
4077 $this->affectedRowCount
= 0; // for the sake of consistency
4082 * Issues the ROLLBACK command to the database server.
4084 * @see Database::rollback()
4085 * @param string $fname
4087 protected function doRollback( $fname ) {
4088 if ( $this->trxLevel
) {
4089 # Disconnects cause rollback anyway, so ignore those errors
4090 $ignoreErrors = true;
4091 $this->query( 'ROLLBACK', $fname, $ignoreErrors );
4092 $this->trxLevel
= 0;
4096 public function flushSnapshot( $fname = __METHOD__
) {
4097 if ( $this->writesOrCallbacksPending() ||
$this->explicitTrxActive() ) {
4098 // This only flushes transactions to clear snapshots, not to write data
4099 $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
4100 throw new DBUnexpectedError(
4102 "$fname: Cannot flush snapshot because writes are pending ($fnames)."
4106 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
4109 public function explicitTrxActive() {
4110 return $this->trxLevel
&& ( $this->trxAtomicLevels ||
!$this->trxAutomatic
);
4113 public function duplicateTableStructure(
4114 $oldName, $newName, $temporary = false, $fname = __METHOD__
4116 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
4119 public function listTables( $prefix = null, $fname = __METHOD__
) {
4120 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
4123 public function listViews( $prefix = null, $fname = __METHOD__
) {
4124 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
4127 public function timestamp( $ts = 0 ) {
4128 $t = new ConvertibleTimestamp( $ts );
4129 // Let errors bubble up to avoid putting garbage in the DB
4130 return $t->getTimestamp( TS_MW
);
4133 public function timestampOrNull( $ts = null ) {
4134 if ( is_null( $ts ) ) {
4137 return $this->timestamp( $ts );
4141 public function affectedRows() {
4142 return ( $this->affectedRowCount
=== null )
4143 ?
$this->fetchAffectedRowCount() // default to driver value
4144 : $this->affectedRowCount
;
4148 * @return int Number of retrieved rows according to the driver
4150 abstract protected function fetchAffectedRowCount();
4153 * Take the result from a query, and wrap it in a ResultWrapper if
4154 * necessary. Boolean values are passed through as is, to indicate success
4155 * of write queries or failure.
4157 * Once upon a time, Database::query() returned a bare MySQL result
4158 * resource, and it was necessary to call this function to convert it to
4159 * a wrapper. Nowadays, raw database objects are never exposed to external
4160 * callers, so this is unnecessary in external code.
4162 * @param bool|ResultWrapper|resource $result
4163 * @return bool|ResultWrapper
4165 protected function resultObject( $result ) {
4168 } elseif ( $result instanceof ResultWrapper
) {
4170 } elseif ( $result === true ) {
4171 // Successful write query
4174 return new ResultWrapper( $this, $result );
4178 public function ping( &$rtt = null ) {
4179 // Avoid hitting the server if it was hit recently
4180 if ( $this->isOpen() && ( microtime( true ) - $this->lastPing
) < self
::PING_TTL
) {
4181 if ( !func_num_args() ||
$this->rttEstimate
> 0 ) {
4182 $rtt = $this->rttEstimate
;
4183 return true; // don't care about $rtt
4187 // This will reconnect if possible or return false if not
4188 $this->clearFlag( self
::DBO_TRX
, self
::REMEMBER_PRIOR
);
4189 $ok = ( $this->query( self
::PING_QUERY
, __METHOD__
, true ) !== false );
4190 $this->restoreFlags( self
::RESTORE_PRIOR
);
4193 $rtt = $this->rttEstimate
;
4200 * Close any existing (dead) database connection and open a new connection
4202 * @param string $fname
4203 * @return bool True if new connection is opened successfully, false if error
4205 protected function replaceLostConnection( $fname ) {
4206 $this->closeConnection();
4207 $this->opened
= false;
4208 $this->conn
= false;
4210 $this->handleSessionLossPreconnect();
4219 $this->tablePrefix()
4221 $this->lastPing
= microtime( true );
4224 $this->connLogger
->warning(
4225 $fname . ': lost connection to {dbserver}; reconnected',
4227 'dbserver' => $this->getServer(),
4228 'trace' => ( new RuntimeException() )->getTraceAsString()
4231 } catch ( DBConnectionError
$e ) {
4234 $this->connLogger
->error(
4235 $fname . ': lost connection to {dbserver} permanently',
4236 [ 'dbserver' => $this->getServer() ]
4240 $this->handleSessionLossPostconnect();
4245 public function getSessionLagStatus() {
4246 return $this->getRecordedTransactionLagStatus() ?
: $this->getApproximateLagStatus();
4250 * Get the replica DB lag when the current transaction started
4252 * This is useful when transactions might use snapshot isolation
4253 * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
4254 * is this lag plus transaction duration. If they don't, it is still
4255 * safe to be pessimistic. This returns null if there is no transaction.
4257 * This returns null if the lag status for this transaction was not yet recorded.
4259 * @return array|null ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
4262 final protected function getRecordedTransactionLagStatus() {
4263 return ( $this->trxLevel
&& $this->trxReplicaLag
!== null )
4264 ?
[ 'lag' => $this->trxReplicaLag
, 'since' => $this->trxTimestamp() ]
4269 * Get a replica DB lag estimate for this server
4271 * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)
4274 protected function getApproximateLagStatus() {
4276 'lag' => $this->getLBInfo( 'replica' ) ?
$this->getLag() : 0,
4277 'since' => microtime( true )
4282 * Merge the result of getSessionLagStatus() for several DBs
4283 * using the most pessimistic values to estimate the lag of
4284 * any data derived from them in combination
4286 * This is information is useful for caching modules
4288 * @see WANObjectCache::set()
4289 * @see WANObjectCache::getWithSetCallback()
4291 * @param IDatabase $db1
4292 * @param IDatabase|null $db2 [optional]
4293 * @return array Map of values:
4294 * - lag: highest lag of any of the DBs or false on error (e.g. replication stopped)
4295 * - since: oldest UNIX timestamp of any of the DB lag estimates
4296 * - pending: whether any of the DBs have uncommitted changes
4300 public static function getCacheSetOptions( IDatabase
$db1, IDatabase
$db2 = null ) {
4301 $res = [ 'lag' => 0, 'since' => INF
, 'pending' => false ];
4302 foreach ( func_get_args() as $db ) {
4303 /** @var IDatabase $db */
4304 $status = $db->getSessionLagStatus();
4305 if ( $status['lag'] === false ) {
4306 $res['lag'] = false;
4307 } elseif ( $res['lag'] !== false ) {
4308 $res['lag'] = max( $res['lag'], $status['lag'] );
4310 $res['since'] = min( $res['since'], $status['since'] );
4311 $res['pending'] = $res['pending'] ?
: $db->writesPending();
4317 public function getLag() {
4321 public function maxListLen() {
4325 public function encodeBlob( $b ) {
4329 public function decodeBlob( $b ) {
4330 if ( $b instanceof Blob
) {
4336 public function setSessionOptions( array $options ) {
4339 public function sourceFile(
4341 callable
$lineCallback = null,
4342 callable
$resultCallback = null,
4344 callable
$inputCallback = null
4346 Wikimedia\
suppressWarnings();
4347 $fp = fopen( $filename, 'r' );
4348 Wikimedia\restoreWarnings
();
4350 if ( $fp === false ) {
4351 throw new RuntimeException( "Could not open \"{$filename}\".\n" );
4355 $fname = __METHOD__
. "( $filename )";
4359 $error = $this->sourceStream(
4360 $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
4361 } catch ( Exception
$e ) {
4371 public function setSchemaVars( $vars ) {
4372 $this->schemaVars
= $vars;
4375 public function sourceStream(
4377 callable
$lineCallback = null,
4378 callable
$resultCallback = null,
4379 $fname = __METHOD__
,
4380 callable
$inputCallback = null
4382 $delimiterReset = new ScopedCallback(
4383 function ( $delimiter ) {
4384 $this->delimiter
= $delimiter;
4386 [ $this->delimiter
]
4390 while ( !feof( $fp ) ) {
4391 if ( $lineCallback ) {
4392 call_user_func( $lineCallback );
4395 $line = trim( fgets( $fp ) );
4397 if ( $line == '' ) {
4401 if ( $line[0] == '-' && $line[1] == '-' ) {
4409 $done = $this->streamStatementEnd( $cmd, $line );
4413 if ( $done ||
feof( $fp ) ) {
4414 $cmd = $this->replaceVars( $cmd );
4416 if ( $inputCallback ) {
4417 $callbackResult = $inputCallback( $cmd );
4419 if ( is_string( $callbackResult ) ||
!$callbackResult ) {
4420 $cmd = $callbackResult;
4425 $res = $this->query( $cmd, $fname );
4427 if ( $resultCallback ) {
4428 $resultCallback( $res, $this );
4431 if ( $res === false ) {
4432 $err = $this->lastError();
4434 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
4441 ScopedCallback
::consume( $delimiterReset );
4446 * Called by sourceStream() to check if we've reached a statement end
4448 * @param string &$sql SQL assembled so far
4449 * @param string &$newLine New line about to be added to $sql
4450 * @return bool Whether $newLine contains end of the statement
4452 public function streamStatementEnd( &$sql, &$newLine ) {
4453 if ( $this->delimiter
) {
4455 $newLine = preg_replace(
4456 '/' . preg_quote( $this->delimiter
, '/' ) . '$/', '', $newLine );
4457 if ( $newLine != $prev ) {
4466 * Database independent variable replacement. Replaces a set of variables
4467 * in an SQL statement with their contents as given by $this->getSchemaVars().
4469 * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
4471 * - '{$var}' should be used for text and is passed through the database's
4473 * - `{$var}` should be used for identifiers (e.g. table and database names).
4474 * It is passed through the database's addIdentifierQuotes method which
4475 * can be overridden if the database uses something other than backticks.
4476 * - / *_* / or / *$wgDBprefix* / passes the name that follows through the
4477 * database's tableName method.
4478 * - / *i* / passes the name that follows through the database's indexName method.
4479 * - In all other cases, / *$var* / is left unencoded. Except for table options,
4480 * its use should be avoided. In 1.24 and older, string encoding was applied.
4482 * @param string $ins SQL statement to replace variables in
4483 * @return string The new SQL statement with variables replaced
4485 protected function replaceVars( $ins ) {
4486 $vars = $this->getSchemaVars();
4487 return preg_replace_callback(
4489 /\* (\$wgDBprefix|[_i]) \*/ (\w*) | # 1-2. tableName, indexName
4490 \'\{\$ (\w+) }\' | # 3. addQuotes
4491 `\{\$ (\w+) }` | # 4. addIdentifierQuotes
4492 /\*\$ (\w+) \*/ # 5. leave unencoded
4494 function ( $m ) use ( $vars ) {
4495 // Note: Because of <https://bugs.php.net/bug.php?id=51881>,
4496 // check for both nonexistent keys *and* the empty string.
4497 if ( isset( $m[1] ) && $m[1] !== '' ) {
4498 if ( $m[1] === 'i' ) {
4499 return $this->indexName( $m[2] );
4501 return $this->tableName( $m[2] );
4503 } elseif ( isset( $m[3] ) && $m[3] !== '' && array_key_exists( $m[3], $vars ) ) {
4504 return $this->addQuotes( $vars[$m[3]] );
4505 } elseif ( isset( $m[4] ) && $m[4] !== '' && array_key_exists( $m[4], $vars ) ) {
4506 return $this->addIdentifierQuotes( $vars[$m[4]] );
4507 } elseif ( isset( $m[5] ) && $m[5] !== '' && array_key_exists( $m[5], $vars ) ) {
4508 return $vars[$m[5]];
4518 * Get schema variables. If none have been set via setSchemaVars(), then
4519 * use some defaults from the current object.
4523 protected function getSchemaVars() {
4524 if ( $this->schemaVars
) {
4525 return $this->schemaVars
;
4527 return $this->getDefaultSchemaVars();
4532 * Get schema variables to use if none have been set via setSchemaVars().
4534 * Override this in derived classes to provide variables for tables.sql
4535 * and SQL patch files.
4539 protected function getDefaultSchemaVars() {
4543 public function lockIsFree( $lockName, $method ) {
4544 // RDBMs methods for checking named locks may or may not count this thread itself.
4545 // In MySQL, IS_FREE_LOCK() returns 0 if the thread already has the lock. This is
4546 // the behavior choosen by the interface for this method.
4547 return !isset( $this->namedLocksHeld
[$lockName] );
4550 public function lock( $lockName, $method, $timeout = 5 ) {
4551 $this->namedLocksHeld
[$lockName] = 1;
4556 public function unlock( $lockName, $method ) {
4557 unset( $this->namedLocksHeld
[$lockName] );
4562 public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
4563 if ( $this->writesOrCallbacksPending() ) {
4564 // This only flushes transactions to clear snapshots, not to write data
4565 $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
4566 throw new DBUnexpectedError(
4568 "$fname: Cannot flush pre-lock snapshot because writes are pending ($fnames)."
4572 if ( !$this->lock( $lockKey, $fname, $timeout ) ) {
4576 $unlocker = new ScopedCallback( function () use ( $lockKey, $fname ) {
4577 if ( $this->trxLevel() ) {
4578 // There is a good chance an exception was thrown, causing any early return
4579 // from the caller. Let any error handler get a chance to issue rollback().
4580 // If there isn't one, let the error bubble up and trigger server-side rollback.
4581 $this->onTransactionResolution(
4582 function () use ( $lockKey, $fname ) {
4583 $this->unlock( $lockKey, $fname );
4588 $this->unlock( $lockKey, $fname );
4592 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
4597 public function namedLocksEnqueue() {
4601 public function tableLocksHaveTransactionScope() {
4605 final public function lockTables( array $read, array $write, $method ) {
4606 if ( $this->writesOrCallbacksPending() ) {
4607 throw new DBUnexpectedError( $this, "Transaction writes or callbacks still pending." );
4610 if ( $this->tableLocksHaveTransactionScope() ) {
4611 $this->startAtomic( $method );
4614 return $this->doLockTables( $read, $write, $method );
4618 * Helper function for lockTables() that handles the actual table locking
4620 * @param array $read Array of tables to lock for read access
4621 * @param array $write Array of tables to lock for write access
4622 * @param string $method Name of caller
4625 protected function doLockTables( array $read, array $write, $method ) {
4629 final public function unlockTables( $method ) {
4630 if ( $this->tableLocksHaveTransactionScope() ) {
4631 $this->endAtomic( $method );
4633 return true; // locks released on COMMIT/ROLLBACK
4636 return $this->doUnlockTables( $method );
4640 * Helper function for unlockTables() that handles the actual table unlocking
4642 * @param string $method Name of caller
4645 protected function doUnlockTables( $method ) {
4651 * @param string $tableName
4652 * @param string $fName
4653 * @return bool|ResultWrapper
4656 public function dropTable( $tableName, $fName = __METHOD__
) {
4657 if ( !$this->tableExists( $tableName, $fName ) ) {
4660 $sql = "DROP TABLE " . $this->tableName( $tableName ) . " CASCADE";
4662 return $this->query( $sql, $fName );
4665 public function getInfinity() {
4669 public function encodeExpiry( $expiry ) {
4670 return ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() )
4671 ?
$this->getInfinity()
4672 : $this->timestamp( $expiry );
4675 public function decodeExpiry( $expiry, $format = TS_MW
) {
4676 if ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() ) {
4680 return ConvertibleTimestamp
::convert( $format, $expiry );
4683 public function setBigSelects( $value = true ) {
4687 public function isReadOnly() {
4688 return ( $this->getReadOnlyReason() !== false );
4692 * @return string|bool Reason this DB is read-only or false if it is not
4694 protected function getReadOnlyReason() {
4695 $reason = $this->getLBInfo( 'readOnlyReason' );
4697 return is_string( $reason ) ?
$reason : false;
4700 public function setTableAliases( array $aliases ) {
4701 $this->tableAliases
= $aliases;
4704 public function setIndexAliases( array $aliases ) {
4705 $this->indexAliases
= $aliases;
4713 protected function hasFlags( $field, $flags ) {
4714 return ( ( $field & $flags ) === $flags );
4718 * Get the underlying binding connection handle
4720 * Makes sure the connection resource is set (disconnects and ping() failure can unset it).
4721 * This catches broken callers than catch and ignore disconnection exceptions.
4722 * Unlike checking isOpen(), this is safe to call inside of open().
4725 * @throws DBUnexpectedError
4728 protected function getBindingHandle() {
4729 if ( !$this->conn
) {
4730 throw new DBUnexpectedError(
4732 'DB connection was already closed or the connection dropped.'
4743 public function __toString() {
4744 return (string)$this->conn
;
4748 * Make sure that copies do not share the same client binding handle
4749 * @throws DBConnectionError
4751 public function __clone() {
4752 $this->connLogger
->warning(
4753 "Cloning " . static::class . " is not recommended; forking connection:\n" .
4754 ( new RuntimeException() )->getTraceAsString()
4757 if ( $this->isOpen() ) {
4758 // Open a new connection resource without messing with the old one
4759 $this->opened
= false;
4760 $this->conn
= false;
4761 $this->trxEndCallbacks
= []; // don't copy
4762 $this->handleSessionLossPreconnect(); // no trx or locks anymore
4769 $this->tablePrefix()
4771 $this->lastPing
= microtime( true );
4776 * Called by serialize. Throw an exception when DB connection is serialized.
4777 * This causes problems on some database engines because the connection is
4778 * not restored on unserialize.
4780 public function __sleep() {
4781 throw new RuntimeException( 'Database serialization may cause problems, since ' .
4782 'the connection is not restored on wakeup.' );
4786 * Run a few simple sanity checks and close dangling connections
4788 public function __destruct() {
4789 if ( $this->trxLevel
&& $this->trxDoneWrites
) {
4790 trigger_error( "Uncommitted DB writes (transaction from {$this->trxFname})." );
4793 $danglingWriters = $this->pendingWriteAndCallbackCallers();
4794 if ( $danglingWriters ) {
4795 $fnames = implode( ', ', $danglingWriters );
4796 trigger_error( "DB transaction writes or callbacks still pending ($fnames)." );
4799 if ( $this->conn
) {
4800 // Avoid connection leaks for sanity. Normally, resources close at script completion.
4801 // The connection might already be closed in zend/hhvm by now, so suppress warnings.
4802 Wikimedia\
suppressWarnings();
4803 $this->closeConnection();
4804 Wikimedia\restoreWarnings
();
4805 $this->conn
= false;
4806 $this->opened
= false;
4812 * @deprecated since 1.28
4814 class_alias( Database
::class, 'DatabaseBase' );
4817 * @deprecated since 1.29
4819 class_alias( Database
::class, 'Database' );