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 Whether lock granularity is on the level of the entire database */
65 const ATTR_DB_LEVEL_LOCKING
= 'db-level-locking';
67 /** @var int New Database instance will not be connected yet when returned */
68 const NEW_UNCONNECTED
= 0;
69 /** @var int New Database instance will already be connected when returned */
70 const NEW_CONNECTED
= 1;
72 /** @var string SQL query */
73 protected $lastQuery = '';
74 /** @var float|bool UNIX timestamp of last write query */
75 protected $lastWriteTime = false;
76 /** @var string|bool */
77 protected $phpError = false;
78 /** @var string Server that this instance is currently connected to */
80 /** @var string User that this instance is currently connected under the name of */
82 /** @var string Password used to establish the current connection */
84 /** @var array[] Map of (table => (dbname, schema, prefix) map) */
85 protected $tableAliases = [];
86 /** @var string[] Map of (index alias => index) */
87 protected $indexAliases = [];
88 /** @var bool Whether this PHP instance is for a CLI script */
90 /** @var string Agent name for query profiling */
92 /** @var array Parameters used by initConnection() to establish a connection */
93 protected $connectionParams = [];
94 /** @var BagOStuff APC cache */
96 /** @var LoggerInterface */
97 protected $connLogger;
98 /** @var LoggerInterface */
99 protected $queryLogger;
100 /** @var callback Error logging callback */
101 protected $errorLogger;
102 /** @var callback Deprecation logging callback */
103 protected $deprecationLogger;
105 /** @var resource|null Database connection */
106 protected $conn = null;
108 protected $opened = false;
110 /** @var array[] List of (callable, method name, atomic section id) */
111 protected $trxIdleCallbacks = [];
112 /** @var array[] List of (callable, method name, atomic section id) */
113 protected $trxPreCommitCallbacks = [];
114 /** @var array[] List of (callable, method name, atomic section id) */
115 protected $trxEndCallbacks = [];
116 /** @var callable[] Map of (name => callable) */
117 protected $trxRecurringCallbacks = [];
118 /** @var bool Whether to suppress triggering of transaction end callbacks */
119 protected $trxEndCallbacksSuppressed = false;
124 protected $lbInfo = [];
125 /** @var array|bool */
126 protected $schemaVars = false;
128 protected $sessionVars = [];
129 /** @var array|null */
130 protected $preparedArgs;
131 /** @var string|bool|null Stashed value of html_errors INI setting */
132 protected $htmlErrors;
134 protected $delimiter = ';';
135 /** @var DatabaseDomain */
136 protected $currentDomain;
137 /** @var integer|null Rows affected by the last query to query() or its CRUD wrappers */
138 protected $affectedRowCount;
141 * @var int Transaction status
143 protected $trxStatus = self
::STATUS_TRX_NONE
;
145 * @var Exception|null The last error that caused the status to become STATUS_TRX_ERROR
147 protected $trxStatusCause;
149 * @var array|null If wasKnownStatementRollbackError() prevented trxStatus from being set,
150 * the relevant details are stored here.
152 protected $trxStatusIgnoredCause;
154 * Either 1 if a transaction is active or 0 otherwise.
155 * The other Trx fields may not be meaningfull if this is 0.
159 protected $trxLevel = 0;
161 * Either a short hexidecimal string if a transaction is active or ""
164 * @see Database::trxLevel
166 protected $trxShortId = '';
168 * The UNIX time that the transaction started. Callers can assume that if
169 * snapshot isolation is used, then the data is *at least* up to date to that
170 * point (possibly more up-to-date since the first SELECT defines the snapshot).
173 * @see Database::trxLevel
175 private $trxTimestamp = null;
176 /** @var float Lag estimate at the time of BEGIN */
177 private $trxReplicaLag = null;
179 * Remembers the function name given for starting the most recent transaction via begin().
180 * Used to provide additional context for error reporting.
183 * @see Database::trxLevel
185 private $trxFname = null;
187 * Record if possible write queries were done in the last transaction started
190 * @see Database::trxLevel
192 private $trxDoneWrites = false;
194 * Record if the current transaction was started implicitly due to DBO_TRX being set.
197 * @see Database::trxLevel
199 private $trxAutomatic = false;
201 * Counter for atomic savepoint identifiers. Reset when a new transaction begins.
205 private $trxAtomicCounter = 0;
207 * Array of levels of atomicity within transactions
209 * @var array List of (name, unique ID, savepoint ID)
211 private $trxAtomicLevels = [];
213 * Record if the current transaction was started implicitly by Database::startAtomic
217 private $trxAutomaticAtomic = false;
219 * Track the write query callers of the current transaction
223 private $trxWriteCallers = [];
225 * @var float Seconds spent in write queries for the current transaction
227 private $trxWriteDuration = 0.0;
229 * @var int Number of write queries for the current transaction
231 private $trxWriteQueryCount = 0;
233 * @var int Number of rows affected by write queries for the current transaction
235 private $trxWriteAffectedRows = 0;
237 * @var float Like trxWriteQueryCount but excludes lock-bound, easy to replicate, queries
239 private $trxWriteAdjDuration = 0.0;
241 * @var int Number of write queries counted in trxWriteAdjDuration
243 private $trxWriteAdjQueryCount = 0;
245 * @var float RTT time estimate
247 private $rttEstimate = 0.0;
249 /** @var array Map of (name => 1) for locks obtained via lock() */
250 private $namedLocksHeld = [];
251 /** @var array Map of (table name => 1) for TEMPORARY tables */
252 protected $sessionTempTables = [];
254 /** @var IDatabase|null Lazy handle to the master DB this server replicates from */
255 private $lazyMasterHandle;
257 /** @var float UNIX timestamp */
258 protected $lastPing = 0.0;
260 /** @var int[] Prior flags member variable values */
261 private $priorFlags = [];
263 /** @var mixed Class name or object With profileIn/profileOut methods */
265 /** @var TransactionProfiler */
266 protected $trxProfiler;
269 protected $nonNativeInsertSelectBatchSize = 10000;
271 /** @var string Idiom used when a cancelable atomic section started the transaction */
272 private static $NOT_APPLICABLE = 'n/a';
273 /** @var string Prefix to the atomic section counter used to make savepoint IDs */
274 private static $SAVEPOINT_PREFIX = 'wikimedia_rdbms_atomic';
276 /** @var int Transaction is in a error state requiring a full or savepoint rollback */
277 const STATUS_TRX_ERROR
= 1;
278 /** @var int Transaction is active and in a normal state */
279 const STATUS_TRX_OK
= 2;
280 /** @var int No transaction is active */
281 const STATUS_TRX_NONE
= 3;
284 * @note exceptions for missing libraries/drivers should be thrown in initConnection()
285 * @param array $params Parameters passed from Database::factory()
287 protected function __construct( array $params ) {
288 foreach ( [ 'host', 'user', 'password', 'dbname', 'schema', 'tablePrefix' ] as $name ) {
289 $this->connectionParams
[$name] = $params[$name];
292 $this->cliMode
= $params['cliMode'];
293 // Agent name is added to SQL queries in a comment, so make sure it can't break out
294 $this->agent
= str_replace( '/', '-', $params['agent'] );
296 $this->flags
= $params['flags'];
297 if ( $this->flags
& self
::DBO_DEFAULT
) {
298 if ( $this->cliMode
) {
299 $this->flags
&= ~self
::DBO_TRX
;
301 $this->flags |
= self
::DBO_TRX
;
304 // Disregard deprecated DBO_IGNORE flag (T189999)
305 $this->flags
&= ~self
::DBO_IGNORE
;
307 $this->sessionVars
= $params['variables'];
309 $this->srvCache
= $params['srvCache'] ??
new HashBagOStuff();
311 $this->profiler
= $params['profiler'];
312 $this->trxProfiler
= $params['trxProfiler'];
313 $this->connLogger
= $params['connLogger'];
314 $this->queryLogger
= $params['queryLogger'];
315 $this->errorLogger
= $params['errorLogger'];
316 $this->deprecationLogger
= $params['deprecationLogger'];
318 if ( isset( $params['nonNativeInsertSelectBatchSize'] ) ) {
319 $this->nonNativeInsertSelectBatchSize
= $params['nonNativeInsertSelectBatchSize'];
322 // Set initial dummy domain until open() sets the final DB/prefix
323 $this->currentDomain
= new DatabaseDomain(
324 $params['dbname'] != '' ?
$params['dbname'] : null,
325 $params['schema'] != '' ?
$params['schema'] : null,
326 $params['tablePrefix']
331 * Initialize the connection to the database over the wire (or to local files)
333 * @throws LogicException
334 * @throws InvalidArgumentException
335 * @throws DBConnectionError
338 final public function initConnection() {
339 if ( $this->isOpen() ) {
340 throw new LogicException( __METHOD__
. ': already connected.' );
342 // Establish the connection
343 $this->doInitConnection();
347 * Actually connect to the database over the wire (or to local files)
349 * @throws InvalidArgumentException
350 * @throws DBConnectionError
353 protected function doInitConnection() {
354 if ( strlen( $this->connectionParams
['user'] ) ) {
356 $this->connectionParams
['host'],
357 $this->connectionParams
['user'],
358 $this->connectionParams
['password'],
359 $this->connectionParams
['dbname'],
360 $this->connectionParams
['schema'],
361 $this->connectionParams
['tablePrefix']
364 throw new InvalidArgumentException( "No database user provided." );
369 * Open a new connection to the database (closing any existing one)
371 * @param string $server Database server host
372 * @param string $user Database user name
373 * @param string $password Database user password
374 * @param string $dbName Database name
375 * @param string|null $schema Database schema name
376 * @param string $tablePrefix Table prefix
378 * @throws DBConnectionError
380 abstract protected function open( $server, $user, $password, $dbName, $schema, $tablePrefix );
383 * Construct a Database subclass instance given a database type and parameters
385 * This also connects to the database immediately upon object construction
387 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
388 * @param array $p Parameter map with keys:
389 * - host : The hostname of the DB server
390 * - user : The name of the database user the client operates under
391 * - password : The password for the database user
392 * - dbname : The name of the database to use where queries do not specify one.
393 * The database must exist or an error might be thrown. Setting this to the empty string
394 * will avoid any such errors and make the handle have no implicit database scope. This is
395 * useful for queries like SHOW STATUS, CREATE DATABASE, or DROP DATABASE. Note that a
396 * "database" in Postgres is rougly equivalent to an entire MySQL server. This the domain
397 * in which user names and such are defined, e.g. users are database-specific in Postgres.
398 * - schema : The database schema to use (if supported). A "schema" in Postgres is roughly
399 * equivalent to a "database" in MySQL. Note that MySQL and SQLite do not use schemas.
400 * - tablePrefix : Optional table prefix that is implicitly added on to all table names
401 * recognized in queries. This can be used in place of schemas for handle site farms.
402 * - flags : Optional bitfield of DBO_* constants that define connection, protocol,
403 * buffering, and transaction behavior. It is STRONGLY adviced to leave the DBO_DEFAULT
404 * flag in place UNLESS this this database simply acts as a key/value store.
405 * - driver: Optional name of a specific DB client driver. For MySQL, there is only the
406 * 'mysqli' driver; the old one 'mysql' has been removed.
407 * - variables: Optional map of session variables to set after connecting. This can be
408 * used to adjust lock timeouts or encoding modes and the like.
409 * - connLogger: Optional PSR-3 logger interface instance.
410 * - queryLogger: Optional PSR-3 logger interface instance.
411 * - profiler: Optional class name or object with profileIn()/profileOut() methods.
412 * These will be called in query(), using a simplified version of the SQL that also
413 * includes the agent as a SQL comment.
414 * - trxProfiler: Optional TransactionProfiler instance.
415 * - errorLogger: Optional callback that takes an Exception and logs it.
416 * - deprecationLogger: Optional callback that takes a string and logs it.
417 * - cliMode: Whether to consider the execution context that of a CLI script.
418 * - agent: Optional name used to identify the end-user in query profiling/logging.
419 * - srvCache: Optional BagOStuff instance to an APC-style cache.
420 * - nonNativeInsertSelectBatchSize: Optional batch size for non-native INSERT SELECT emulation.
421 * @param int $connect One of the class constants (NEW_CONNECTED, NEW_UNCONNECTED) [optional]
422 * @return Database|null If the database driver or extension cannot be found
423 * @throws InvalidArgumentException If the database driver or extension cannot be found
426 final public static function factory( $dbType, $p = [], $connect = self
::NEW_CONNECTED
) {
427 $class = self
::getClass( $dbType, $p['driver'] ??
null );
429 if ( class_exists( $class ) && is_subclass_of( $class, IDatabase
::class ) ) {
430 // Resolve some defaults for b/c
431 $p['host'] = $p['host'] ??
false;
432 $p['user'] = $p['user'] ??
false;
433 $p['password'] = $p['password'] ??
false;
434 $p['dbname'] = $p['dbname'] ??
false;
435 $p['flags'] = $p['flags'] ??
0;
436 $p['variables'] = $p['variables'] ??
[];
437 $p['tablePrefix'] = $p['tablePrefix'] ??
'';
438 $p['schema'] = $p['schema'] ??
null;
439 $p['cliMode'] = $p['cliMode'] ??
( PHP_SAPI
=== 'cli' || PHP_SAPI
=== 'phpdbg' );
440 $p['agent'] = $p['agent'] ??
'';
441 if ( !isset( $p['connLogger'] ) ) {
442 $p['connLogger'] = new NullLogger();
444 if ( !isset( $p['queryLogger'] ) ) {
445 $p['queryLogger'] = new NullLogger();
447 $p['profiler'] = $p['profiler'] ??
null;
448 if ( !isset( $p['trxProfiler'] ) ) {
449 $p['trxProfiler'] = new TransactionProfiler();
451 if ( !isset( $p['errorLogger'] ) ) {
452 $p['errorLogger'] = function ( Exception
$e ) {
453 trigger_error( get_class( $e ) . ': ' . $e->getMessage(), E_USER_WARNING
);
456 if ( !isset( $p['deprecationLogger'] ) ) {
457 $p['deprecationLogger'] = function ( $msg ) {
458 trigger_error( $msg, E_USER_DEPRECATED
);
462 /** @var Database $conn */
463 $conn = new $class( $p );
464 if ( $connect == self
::NEW_CONNECTED
) {
465 $conn->initConnection();
475 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
476 * @param string|null $driver Optional name of a specific DB client driver
477 * @return array Map of (Database::ATTRIBUTE_* constant => value) for all such constants
478 * @throws InvalidArgumentException
481 final public static function attributesFromType( $dbType, $driver = null ) {
482 static $defaults = [ self
::ATTR_DB_LEVEL_LOCKING
=> false ];
484 $class = self
::getClass( $dbType, $driver );
486 return call_user_func( [ $class, 'getAttributes' ] ) +
$defaults;
490 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
491 * @param string|null $driver Optional name of a specific DB client driver
492 * @return string Database subclass name to use
493 * @throws InvalidArgumentException
495 private static function getClass( $dbType, $driver = null ) {
496 // For database types with built-in support, the below maps type to IDatabase
497 // implementations. For types with multipe driver implementations (PHP extensions),
498 // an array can be used, keyed by extension name. In case of an array, the
499 // optional 'driver' parameter can be used to force a specific driver. Otherwise,
500 // we auto-detect the first available driver. For types without built-in support,
501 // an class named "Database<Type>" us used, eg. DatabaseFoo for type 'foo'.
502 static $builtinTypes = [
503 'mssql' => DatabaseMssql
::class,
504 'mysql' => [ 'mysqli' => DatabaseMysqli
::class ],
505 'sqlite' => DatabaseSqlite
::class,
506 'postgres' => DatabasePostgres
::class,
509 $dbType = strtolower( $dbType );
512 if ( isset( $builtinTypes[$dbType] ) ) {
513 $possibleDrivers = $builtinTypes[$dbType];
514 if ( is_string( $possibleDrivers ) ) {
515 $class = $possibleDrivers;
517 if ( (string)$driver !== '' ) {
518 if ( !isset( $possibleDrivers[$driver] ) ) {
519 throw new InvalidArgumentException( __METHOD__
.
520 " type '$dbType' does not support driver '{$driver}'" );
522 $class = $possibleDrivers[$driver];
525 foreach ( $possibleDrivers as $posDriver => $possibleClass ) {
526 if ( extension_loaded( $posDriver ) ) {
527 $class = $possibleClass;
534 $class = 'Database' . ucfirst( $dbType );
537 if ( $class === false ) {
538 throw new InvalidArgumentException( __METHOD__
.
539 " no viable database extension found for type '$dbType'" );
546 * @return array Map of (Database::ATTRIBUTE_* constant => value
549 protected static function getAttributes() {
554 * Set the PSR-3 logger interface to use for query logging. (The logger
555 * interfaces for connection logging and error logging can be set with the
558 * @param LoggerInterface $logger
560 public function setLogger( LoggerInterface
$logger ) {
561 $this->queryLogger
= $logger;
564 public function getServerInfo() {
565 return $this->getServerVersion();
568 public function bufferResults( $buffer = null ) {
569 $res = !$this->getFlag( self
::DBO_NOBUFFER
);
570 if ( $buffer !== null ) {
572 ?
$this->clearFlag( self
::DBO_NOBUFFER
)
573 : $this->setFlag( self
::DBO_NOBUFFER
);
579 public function trxLevel() {
580 return $this->trxLevel
;
583 public function trxTimestamp() {
584 return $this->trxLevel ?
$this->trxTimestamp
: null;
588 * @return int One of the STATUS_TRX_* class constants
591 public function trxStatus() {
592 return $this->trxStatus
;
595 public function tablePrefix( $prefix = null ) {
596 $old = $this->currentDomain
->getTablePrefix();
597 if ( $prefix !== null ) {
598 $this->currentDomain
= new DatabaseDomain(
599 $this->currentDomain
->getDatabase(),
600 $this->currentDomain
->getSchema(),
608 public function dbSchema( $schema = null ) {
609 $old = $this->currentDomain
->getSchema();
610 if ( $schema !== null ) {
611 $this->currentDomain
= new DatabaseDomain(
612 $this->currentDomain
->getDatabase(),
613 // DatabaseDomain uses null for unspecified schemas
614 strlen( $schema ) ?
$schema : null,
615 $this->currentDomain
->getTablePrefix()
623 * @return string Schema to use to qualify relations in queries
625 protected function relationSchemaQualifier() {
626 return $this->dbSchema();
629 public function getLBInfo( $name = null ) {
630 if ( is_null( $name ) ) {
631 return $this->lbInfo
;
633 if ( array_key_exists( $name, $this->lbInfo
) ) {
634 return $this->lbInfo
[$name];
641 public function setLBInfo( $name, $value = null ) {
642 if ( is_null( $value ) ) {
643 $this->lbInfo
= $name;
645 $this->lbInfo
[$name] = $value;
649 public function setLazyMasterHandle( IDatabase
$conn ) {
650 $this->lazyMasterHandle
= $conn;
654 * @return IDatabase|null
655 * @see setLazyMasterHandle()
658 protected function getLazyMasterHandle() {
659 return $this->lazyMasterHandle
;
662 public function implicitGroupby() {
666 public function implicitOrderby() {
670 public function lastQuery() {
671 return $this->lastQuery
;
674 public function doneWrites() {
675 return (bool)$this->lastWriteTime
;
678 public function lastDoneWrites() {
679 return $this->lastWriteTime ?
: false;
682 public function writesPending() {
683 return $this->trxLevel
&& $this->trxDoneWrites
;
686 public function writesOrCallbacksPending() {
687 return $this->trxLevel
&& (
688 $this->trxDoneWrites ||
689 $this->trxIdleCallbacks ||
690 $this->trxPreCommitCallbacks ||
691 $this->trxEndCallbacks
695 public function preCommitCallbacksPending() {
696 return $this->trxLevel
&& $this->trxPreCommitCallbacks
;
700 * @return string|null
702 final protected function getTransactionRoundId() {
703 // If transaction round participation is enabled, see if one is active
704 if ( $this->getFlag( self
::DBO_TRX
) ) {
705 $id = $this->getLBInfo( 'trxRoundId' );
707 return is_string( $id ) ?
$id : null;
713 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
) {
714 if ( !$this->trxLevel
) {
716 } elseif ( !$this->trxDoneWrites
) {
721 case self
::ESTIMATE_DB_APPLY
:
722 return $this->pingAndCalculateLastTrxApplyTime();
723 default: // everything
724 return $this->trxWriteDuration
;
729 * @return float Time to apply writes to replicas based on trxWrite* fields
731 private function pingAndCalculateLastTrxApplyTime() {
734 $rttAdjTotal = $this->trxWriteAdjQueryCount
* $rtt;
735 $applyTime = max( $this->trxWriteAdjDuration
- $rttAdjTotal, 0 );
736 // For omitted queries, make them count as something at least
737 $omitted = $this->trxWriteQueryCount
- $this->trxWriteAdjQueryCount
;
738 $applyTime +
= self
::TINY_WRITE_SEC
* $omitted;
743 public function pendingWriteCallers() {
744 return $this->trxLevel ?
$this->trxWriteCallers
: [];
747 public function pendingWriteRowsAffected() {
748 return $this->trxWriteAffectedRows
;
752 * List the methods that have write queries or callbacks for the current transaction
754 * This method should not be used outside of Database/LoadBalancer
759 public function pendingWriteAndCallbackCallers() {
760 $fnames = $this->pendingWriteCallers();
762 $this->trxIdleCallbacks
,
763 $this->trxPreCommitCallbacks
,
764 $this->trxEndCallbacks
766 foreach ( $callbacks as $callback ) {
767 $fnames[] = $callback[1];
777 private function flatAtomicSectionList() {
778 return array_reduce( $this->trxAtomicLevels
, function ( $accum, $v ) {
779 return $accum === null ?
$v[0] : "$accum, " . $v[0];
783 public function isOpen() {
784 return $this->opened
;
787 public function setFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
788 if ( ( $flag & self
::DBO_IGNORE
) ) {
789 throw new UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
792 if ( $remember === self
::REMEMBER_PRIOR
) {
793 array_push( $this->priorFlags
, $this->flags
);
795 $this->flags |
= $flag;
798 public function clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
799 if ( ( $flag & self
::DBO_IGNORE
) ) {
800 throw new UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
803 if ( $remember === self
::REMEMBER_PRIOR
) {
804 array_push( $this->priorFlags
, $this->flags
);
806 $this->flags
&= ~
$flag;
809 public function restoreFlags( $state = self
::RESTORE_PRIOR
) {
810 if ( !$this->priorFlags
) {
814 if ( $state === self
::RESTORE_INITIAL
) {
815 $this->flags
= reset( $this->priorFlags
);
816 $this->priorFlags
= [];
818 $this->flags
= array_pop( $this->priorFlags
);
822 public function getFlag( $flag ) {
823 return !!( $this->flags
& $flag );
827 * @param string $name Class field name
829 * @deprecated Since 1.28
831 public function getProperty( $name ) {
835 public function getDomainID() {
836 return $this->currentDomain
->getId();
839 final public function getWikiID() {
840 return $this->getDomainID();
844 * Get information about an index into an object
845 * @param string $table Table name
846 * @param string $index Index name
847 * @param string $fname Calling function name
848 * @return mixed Database-specific index description class or false if the index does not exist
850 abstract function indexInfo( $table, $index, $fname = __METHOD__
);
853 * Wrapper for addslashes()
855 * @param string $s String to be slashed.
856 * @return string Slashed string.
858 abstract function strencode( $s );
861 * Set a custom error handler for logging errors during database connection
863 protected function installErrorHandler() {
864 $this->phpError
= false;
865 $this->htmlErrors
= ini_set( 'html_errors', '0' );
866 set_error_handler( [ $this, 'connectionErrorLogger' ] );
870 * Restore the previous error handler and return the last PHP error for this DB
872 * @return bool|string
874 protected function restoreErrorHandler() {
875 restore_error_handler();
876 if ( $this->htmlErrors
!== false ) {
877 ini_set( 'html_errors', $this->htmlErrors
);
880 return $this->getLastPHPError();
884 * @return string|bool Last PHP error for this DB (typically connection errors)
886 protected function getLastPHPError() {
887 if ( $this->phpError
) {
888 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->phpError
);
889 $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
898 * Error handler for logging errors during database connection
899 * This method should not be used outside of Database classes
902 * @param string $errstr
904 public function connectionErrorLogger( $errno, $errstr ) {
905 $this->phpError
= $errstr;
909 * Create a log context to pass to PSR-3 logger functions.
911 * @param array $extras Additional data to add to context
914 protected function getLogContext( array $extras = [] ) {
917 'db_server' => $this->server
,
918 'db_name' => $this->getDBname(),
919 'db_user' => $this->user
,
925 final public function close() {
926 $exception = null; // error to throw after disconnecting
929 // Roll back any dangling transaction first
930 if ( $this->trxLevel
) {
931 if ( $this->trxAtomicLevels
) {
932 // Cannot let incomplete atomic sections be committed
933 $levels = $this->flatAtomicSectionList();
934 $exception = new DBUnexpectedError(
936 __METHOD__
. ": atomic sections $levels are still open."
938 } elseif ( $this->trxAutomatic
) {
939 // Only the connection manager can commit non-empty DBO_TRX transactions
940 // (empty ones we can silently roll back)
941 if ( $this->writesOrCallbacksPending() ) {
942 $exception = new DBUnexpectedError(
945 ": mass commit/rollback of peer transaction required (DBO_TRX set)."
949 // Manual transactions should have been committed or rolled
950 // back, even if empty.
951 $exception = new DBUnexpectedError(
953 __METHOD__
. ": transaction is still open (from {$this->trxFname})."
957 if ( $this->trxEndCallbacksSuppressed
) {
958 $exception = $exception ?
: new DBUnexpectedError(
960 __METHOD__
. ': callbacks are suppressed; cannot properly commit.'
964 // Rollback the changes and run any callbacks as needed
965 $this->rollback( __METHOD__
, self
::FLUSHING_INTERNAL
);
968 // Close the actual connection in the binding handle
969 $closed = $this->closeConnection();
972 $closed = true; // already closed; nothing to do
975 $this->opened
= false;
977 // Throw any unexpected errors after having disconnected
978 if ( $exception instanceof Exception
) {
982 // Sanity check that no callbacks are dangling
983 $fnames = $this->pendingWriteAndCallbackCallers();
985 throw new RuntimeException(
986 "Transaction callbacks are still pending:\n" . implode( ', ', $fnames )
994 * Make sure isOpen() returns true as a sanity check
996 * @throws DBUnexpectedError
998 protected function assertOpen() {
999 if ( !$this->isOpen() ) {
1000 throw new DBUnexpectedError( $this, "DB connection was already closed." );
1005 * Closes underlying database connection
1007 * @return bool Whether connection was closed successfully
1009 abstract protected function closeConnection();
1012 * @deprecated since 1.32
1013 * @param string $error Fallback message, if none is given by DB
1014 * @throws DBConnectionError
1016 public function reportConnectionError( $error = 'Unknown error' ) {
1017 call_user_func( $this->deprecationLogger
, 'Use of ' . __METHOD__
. ' is deprecated.' );
1018 throw new DBConnectionError( $this, $this->lastError() ?
: $error );
1022 * Run a query and return a DBMS-dependent wrapper (that has all IResultWrapper methods)
1024 * This might return things, such as mysqli_result, that do not formally implement
1025 * IResultWrapper, but nonetheless implement all of its methods correctly
1027 * @param string $sql SQL query.
1028 * @return IResultWrapper|bool Iterator to feed to fetchObject/fetchRow; false on failure
1030 abstract protected function doQuery( $sql );
1033 * Determine whether a query writes to the DB. When in doubt, this returns true.
1037 * - Subsequent web requests should not need to wait for replication from
1038 * the master position seen by this web request, unless this request made
1039 * changes to the master. This is handled by ChronologyProtector by checking
1040 * doneWrites() at the end of the request. doneWrites() returns true if any
1041 * query set lastWriteTime; which query() does based on isWriteQuery().
1043 * - Reject write queries to replica DBs, in query().
1045 * @param string $sql
1048 protected function isWriteQuery( $sql ) {
1049 // BEGIN and COMMIT queries are considered read queries here.
1050 // Database backends and drivers (MySQL, MariaDB, php-mysqli) generally
1051 // treat these as write queries, in that their results have "affected rows"
1052 // as meta data as from writes, instead of "num rows" as from reads.
1053 // But, we treat them as read queries because when reading data (from
1054 // either replica or master) we use transactions to enable repeatable-read
1055 // snapshots, which ensures we get consistent results from the same snapshot
1056 // for all queries within a request. Use cases:
1057 // - Treating these as writes would trigger ChronologyProtector (see method doc).
1058 // - We use this method to reject writes to replicas, but we need to allow
1059 // use of transactions on replicas for read snapshots. This fine given
1060 // that transactions by themselves don't make changes, only actual writes
1061 // within the transaction matter, which we still detect.
1063 '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SAVEPOINT|RELEASE|SET|SHOW|EXPLAIN|\(SELECT)\b/i',
1069 * @param string $sql
1070 * @return string|null
1072 protected function getQueryVerb( $sql ) {
1073 return preg_match( '/^\s*([a-z]+)/i', $sql, $m ) ?
strtoupper( $m[1] ) : null;
1077 * Determine whether a SQL statement is sensitive to isolation level.
1079 * A SQL statement is considered transactable if its result could vary
1080 * depending on the transaction isolation level. Operational commands
1081 * such as 'SET' and 'SHOW' are not considered to be transactable.
1083 * Main purpose: Used by query() to decide whether to begin a transaction
1084 * before the current query (in DBO_TRX mode, on by default).
1086 * @param string $sql
1089 protected function isTransactableQuery( $sql ) {
1091 $this->getQueryVerb( $sql ),
1092 [ 'BEGIN', 'ROLLBACK', 'COMMIT', 'SET', 'SHOW', 'CREATE', 'ALTER' ],
1098 * @param string $sql A SQL query
1099 * @return bool Whether $sql is SQL for TEMPORARY table operation
1101 protected function registerTempTableOperation( $sql ) {
1103 '/^CREATE\s+TEMPORARY\s+TABLE\s+(?:IF\s+NOT\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
1107 $this->sessionTempTables
[$matches[1]] = 1;
1110 } elseif ( preg_match(
1111 '/^DROP\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
1115 $isTemp = isset( $this->sessionTempTables
[$matches[1]] );
1116 unset( $this->sessionTempTables
[$matches[1]] );
1119 } elseif ( preg_match(
1120 '/^TRUNCATE\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
1124 return isset( $this->sessionTempTables
[$matches[1]] );
1125 } elseif ( preg_match(
1126 '/^(?:INSERT\s+(?:\w+\s+)?INTO|UPDATE|DELETE\s+FROM)\s+[`"\']?(\w+)[`"\']?/i',
1130 return isset( $this->sessionTempTables
[$matches[1]] );
1136 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false ) {
1137 $this->assertTransactionStatus( $sql, $fname );
1139 # Avoid fatals if close() was called
1140 $this->assertOpen();
1142 $priorWritesPending = $this->writesOrCallbacksPending();
1143 $this->lastQuery
= $sql;
1145 $isWrite = $this->isWriteQuery( $sql );
1147 $isNonTempWrite = !$this->registerTempTableOperation( $sql );
1149 $isNonTempWrite = false;
1153 if ( $this->getLBInfo( 'replica' ) === true ) {
1156 'Write operations are not allowed on replica database connections.'
1159 # In theory, non-persistent writes are allowed in read-only mode, but due to things
1160 # like https://bugs.mysql.com/bug.php?id=33669 that might not work anyway...
1161 $reason = $this->getReadOnlyReason();
1162 if ( $reason !== false ) {
1163 throw new DBReadOnlyError( $this, "Database is read-only: $reason" );
1165 # Set a flag indicating that writes have been done
1166 $this->lastWriteTime
= microtime( true );
1169 # Add trace comment to the begin of the sql string, right after the operator.
1170 # Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (T44598)
1171 $commentedSql = preg_replace( '/\s|$/', " /* $fname {$this->agent} */ ", $sql, 1 );
1173 # Start implicit transactions that wrap the request if DBO_TRX is enabled
1174 if ( !$this->trxLevel
&& $this->getFlag( self
::DBO_TRX
)
1175 && $this->isTransactableQuery( $sql )
1177 $this->begin( __METHOD__
. " ($fname)", self
::TRANSACTION_INTERNAL
);
1178 $this->trxAutomatic
= true;
1181 # Keep track of whether the transaction has write queries pending
1182 if ( $this->trxLevel
&& !$this->trxDoneWrites
&& $isWrite ) {
1183 $this->trxDoneWrites
= true;
1184 $this->trxProfiler
->transactionWritingIn(
1185 $this->server
, $this->getDomainID(), $this->trxShortId
);
1188 if ( $this->getFlag( self
::DBO_DEBUG
) ) {
1189 $this->queryLogger
->debug( "{$this->getDomainID()} {$commentedSql}" );
1192 # Send the query to the server and fetch any corresponding errors
1193 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isNonTempWrite, $fname );
1194 $lastError = $this->lastError();
1195 $lastErrno = $this->lastErrno();
1197 # Try reconnecting if the connection was lost
1198 if ( $ret === false && $this->wasConnectionLoss() ) {
1199 # Check if any meaningful session state was lost
1200 $recoverable = $this->canRecoverFromDisconnect( $sql, $priorWritesPending );
1201 # Update session state tracking and try to restore the connection
1202 $reconnected = $this->replaceLostConnection( __METHOD__
);
1203 # Silently resend the query to the server if it is safe and possible
1204 if ( $reconnected && $recoverable ) {
1205 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isNonTempWrite, $fname );
1206 $lastError = $this->lastError();
1207 $lastErrno = $this->lastErrno();
1209 if ( $ret === false && $this->wasConnectionLoss() ) {
1210 # Query probably causes disconnects; reconnect and do not re-run it
1211 $this->replaceLostConnection( __METHOD__
);
1216 if ( $ret === false ) {
1217 if ( $this->trxLevel
) {
1218 if ( $this->wasKnownStatementRollbackError() ) {
1219 # We're ignoring an error that caused just the current query to be aborted.
1220 # But log the cause so we can log a deprecation notice if a caller actually
1222 $this->trxStatusIgnoredCause
= [ $lastError, $lastErrno, $fname ];
1224 # Either the query was aborted or all queries after BEGIN where aborted.
1225 # In the first case, the only options going forward are (a) ROLLBACK, or
1226 # (b) ROLLBACK TO SAVEPOINT (if one was set). If the later case, the only
1227 # option is ROLLBACK, since the snapshots would have been released.
1228 $this->trxStatus
= self
::STATUS_TRX_ERROR
;
1229 $this->trxStatusCause
=
1230 $this->makeQueryException( $lastError, $lastErrno, $sql, $fname );
1231 $tempIgnore = false; // cannot recover
1232 $this->trxStatusIgnoredCause
= null;
1236 $this->reportQueryError( $lastError, $lastErrno, $sql, $fname, $tempIgnore );
1239 return $this->resultObject( $ret );
1243 * Wrapper for query() that also handles profiling, logging, and affected row count updates
1245 * @param string $sql Original SQL query
1246 * @param string $commentedSql SQL query with debugging/trace comment
1247 * @param bool $isWrite Whether the query is a (non-temporary) write operation
1248 * @param string $fname Name of the calling function
1249 * @return bool|ResultWrapper True for a successful write query, ResultWrapper
1250 * object for a successful read query, or false on failure
1252 private function doProfiledQuery( $sql, $commentedSql, $isWrite, $fname ) {
1253 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
1254 # generalizeSQL() will probably cut down the query to reasonable
1255 # logging size most of the time. The substr is really just a sanity check.
1257 $queryProf = 'query-m: ' . substr( self
::generalizeSQL( $sql ), 0, 255 );
1259 $queryProf = 'query: ' . substr( self
::generalizeSQL( $sql ), 0, 255 );
1262 # Include query transaction state
1263 $queryProf .= $this->trxShortId ?
" [TRX#{$this->trxShortId}]" : "";
1265 $startTime = microtime( true );
1266 if ( $this->profiler
) {
1267 $this->profiler
->profileIn( $queryProf );
1269 $this->affectedRowCount
= null;
1270 $ret = $this->doQuery( $commentedSql );
1271 $this->affectedRowCount
= $this->affectedRows();
1272 if ( $this->profiler
) {
1273 $this->profiler
->profileOut( $queryProf );
1275 $queryRuntime = max( microtime( true ) - $startTime, 0.0 );
1277 unset( $queryProfSection ); // profile out (if set)
1279 if ( $ret !== false ) {
1280 $this->lastPing
= $startTime;
1281 if ( $isWrite && $this->trxLevel
) {
1282 $this->updateTrxWriteQueryTime( $sql, $queryRuntime, $this->affectedRows() );
1283 $this->trxWriteCallers
[] = $fname;
1287 if ( $sql === self
::PING_QUERY
) {
1288 $this->rttEstimate
= $queryRuntime;
1291 $this->trxProfiler
->recordQueryCompletion(
1295 $isWrite ?
$this->affectedRows() : $this->numRows( $ret )
1297 $this->queryLogger
->debug( $sql, [
1299 'master' => $isMaster,
1300 'runtime' => $queryRuntime,
1307 * Update the estimated run-time of a query, not counting large row lock times
1309 * LoadBalancer can be set to rollback transactions that will create huge replication
1310 * lag. It bases this estimate off of pendingWriteQueryDuration(). Certain simple
1311 * queries, like inserting a row can take a long time due to row locking. This method
1312 * uses some simple heuristics to discount those cases.
1314 * @param string $sql A SQL write query
1315 * @param float $runtime Total runtime, including RTT
1316 * @param int $affected Affected row count
1318 private function updateTrxWriteQueryTime( $sql, $runtime, $affected ) {
1319 // Whether this is indicative of replica DB runtime (except for RBR or ws_repl)
1320 $indicativeOfReplicaRuntime = true;
1321 if ( $runtime > self
::SLOW_WRITE_SEC
) {
1322 $verb = $this->getQueryVerb( $sql );
1323 // insert(), upsert(), replace() are fast unless bulky in size or blocked on locks
1324 if ( $verb === 'INSERT' ) {
1325 $indicativeOfReplicaRuntime = $this->affectedRows() > self
::SMALL_WRITE_ROWS
;
1326 } elseif ( $verb === 'REPLACE' ) {
1327 $indicativeOfReplicaRuntime = $this->affectedRows() > self
::SMALL_WRITE_ROWS
/ 2;
1331 $this->trxWriteDuration +
= $runtime;
1332 $this->trxWriteQueryCount +
= 1;
1333 $this->trxWriteAffectedRows +
= $affected;
1334 if ( $indicativeOfReplicaRuntime ) {
1335 $this->trxWriteAdjDuration +
= $runtime;
1336 $this->trxWriteAdjQueryCount +
= 1;
1341 * @param string $sql
1342 * @param string $fname
1343 * @throws DBTransactionStateError
1345 private function assertTransactionStatus( $sql, $fname ) {
1346 if ( $this->getQueryVerb( $sql ) === 'ROLLBACK' ) { // transaction/savepoint
1350 if ( $this->trxStatus
< self
::STATUS_TRX_OK
) {
1351 throw new DBTransactionStateError(
1353 "Cannot execute query from $fname while transaction status is ERROR.",
1355 $this->trxStatusCause
1357 } elseif ( $this->trxStatus
=== self
::STATUS_TRX_OK
&& $this->trxStatusIgnoredCause
) {
1358 list( $iLastError, $iLastErrno, $iFname ) = $this->trxStatusIgnoredCause
;
1359 call_user_func( $this->deprecationLogger
,
1360 "Caller from $fname ignored an error originally raised from $iFname: " .
1361 "[$iLastErrno] $iLastError"
1363 $this->trxStatusIgnoredCause
= null;
1367 public function assertNoOpenTransactions() {
1368 if ( $this->explicitTrxActive() ) {
1369 throw new DBTransactionError(
1371 "Explicit transaction still active. A caller may have caught an error. "
1372 . "Open transactions: " . $this->flatAtomicSectionList()
1378 * Determine whether or not it is safe to retry queries after a database
1379 * connection is lost
1381 * @param string $sql SQL query
1382 * @param bool $priorWritesPending Whether there is a transaction open with
1383 * possible write queries or transaction pre-commit/idle callbacks
1384 * waiting on it to finish.
1385 * @return bool True if it is safe to retry the query, false otherwise
1387 private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
1388 # Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
1389 # Dropped connections also mean that named locks are automatically released.
1390 # Only allow error suppression in autocommit mode or when the lost transaction
1391 # didn't matter anyway (aside from DBO_TRX snapshot loss).
1392 if ( $this->namedLocksHeld
) {
1393 return false; // possible critical section violation
1394 } elseif ( $this->sessionTempTables
) {
1395 return false; // tables might be queried latter
1396 } elseif ( $sql === 'COMMIT' ) {
1397 return !$priorWritesPending; // nothing written anyway? (T127428)
1398 } elseif ( $sql === 'ROLLBACK' ) {
1399 return true; // transaction lost...which is also what was requested :)
1400 } elseif ( $this->explicitTrxActive() ) {
1401 return false; // don't drop atomocity and explicit snapshots
1402 } elseif ( $priorWritesPending ) {
1403 return false; // prior writes lost from implicit transaction
1410 * Clean things up after session (and thus transaction) loss
1412 private function handleSessionLoss() {
1413 // Clean up tracking of session-level things...
1414 // https://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html
1415 // https://www.postgresql.org/docs/9.2/static/sql-createtable.html (ignoring ON COMMIT)
1416 $this->sessionTempTables
= [];
1417 // https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
1418 // https://www.postgresql.org/docs/9.4/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1419 $this->namedLocksHeld
= [];
1420 // Session loss implies transaction loss
1421 $this->handleTransactionLoss();
1425 * Clean things up after transaction loss
1427 private function handleTransactionLoss() {
1428 $this->trxLevel
= 0;
1429 $this->trxAtomicCounter
= 0;
1430 $this->trxIdleCallbacks
= []; // T67263; transaction already lost
1431 $this->trxPreCommitCallbacks
= []; // T67263; transaction already lost
1433 // Handle callbacks in trxEndCallbacks, e.g. onTransactionResolution().
1434 // If callback suppression is set then the array will remain unhandled.
1435 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_ROLLBACK
);
1436 } catch ( Exception
$ex ) {
1437 // Already logged; move on...
1440 // Handle callbacks in trxRecurringCallbacks, e.g. setTransactionListener()
1441 $this->runTransactionListenerCallbacks( self
::TRIGGER_ROLLBACK
);
1442 } catch ( Exception
$ex ) {
1443 // Already logged; move on...
1448 * Checks whether the cause of the error is detected to be a timeout.
1450 * It returns false by default, and not all engines support detecting this yet.
1451 * If this returns false, it will be treated as a generic query error.
1453 * @param string $error Error text
1454 * @param int $errno Error number
1457 protected function wasQueryTimeout( $error, $errno ) {
1462 * Report a query error. Log the error, and if neither the object ignore
1463 * flag nor the $tempIgnore flag is set, throw a DBQueryError.
1465 * @param string $error
1467 * @param string $sql
1468 * @param string $fname
1469 * @param bool $tempIgnore
1470 * @throws DBQueryError
1472 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1473 if ( $tempIgnore ) {
1474 $this->queryLogger
->debug( "SQL ERROR (ignored): $error\n" );
1476 $exception = $this->makeQueryException( $error, $errno, $sql, $fname );
1483 * @param string $error
1484 * @param string|int $errno
1485 * @param string $sql
1486 * @param string $fname
1489 private function makeQueryException( $error, $errno, $sql, $fname ) {
1490 $sql1line = mb_substr( str_replace( "\n", "\\n", $sql ), 0, 5 * 1024 );
1491 $this->queryLogger
->error(
1492 "{fname}\t{db_server}\t{errno}\t{error}\t{sql1line}",
1493 $this->getLogContext( [
1494 'method' => __METHOD__
,
1497 'sql1line' => $sql1line,
1501 $this->queryLogger
->debug( "SQL ERROR: " . $error . "\n" );
1502 $wasQueryTimeout = $this->wasQueryTimeout( $error, $errno );
1503 if ( $wasQueryTimeout ) {
1504 $e = new DBQueryTimeoutError( $this, $error, $errno, $sql, $fname );
1506 $e = new DBQueryError( $this, $error, $errno, $sql, $fname );
1512 public function freeResult( $res ) {
1515 public function selectField(
1516 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
1518 if ( $var === '*' ) { // sanity
1519 throw new DBUnexpectedError( $this, "Cannot use a * field: got '$var'" );
1522 if ( !is_array( $options ) ) {
1523 $options = [ $options ];
1526 $options['LIMIT'] = 1;
1528 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1529 if ( $res === false ||
!$this->numRows( $res ) ) {
1533 $row = $this->fetchRow( $res );
1535 if ( $row !== false ) {
1536 return reset( $row );
1542 public function selectFieldValues(
1543 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
1545 if ( $var === '*' ) { // sanity
1546 throw new DBUnexpectedError( $this, "Cannot use a * field" );
1547 } elseif ( !is_string( $var ) ) { // sanity
1548 throw new DBUnexpectedError( $this, "Cannot use an array of fields" );
1551 if ( !is_array( $options ) ) {
1552 $options = [ $options ];
1555 $res = $this->select( $table, [ 'value' => $var ], $cond, $fname, $options, $join_conds );
1556 if ( $res === false ) {
1561 foreach ( $res as $row ) {
1562 $values[] = $row->value
;
1569 * Returns an optional USE INDEX clause to go after the table, and a
1570 * string to go at the end of the query.
1572 * @param array $options Associative array of options to be turned into
1573 * an SQL query, valid keys are listed in the function.
1575 * @see Database::select()
1577 protected function makeSelectOptions( $options ) {
1578 $preLimitTail = $postLimitTail = '';
1583 foreach ( $options as $key => $option ) {
1584 if ( is_numeric( $key ) ) {
1585 $noKeyOptions[$option] = true;
1589 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1591 $preLimitTail .= $this->makeOrderBy( $options );
1593 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1594 $postLimitTail .= ' FOR UPDATE';
1597 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1598 $postLimitTail .= ' LOCK IN SHARE MODE';
1601 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) {
1602 $startOpts .= 'DISTINCT';
1605 # Various MySQL extensions
1606 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1607 $startOpts .= ' /*! STRAIGHT_JOIN */';
1610 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1611 $startOpts .= ' HIGH_PRIORITY';
1614 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1615 $startOpts .= ' SQL_BIG_RESULT';
1618 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1619 $startOpts .= ' SQL_BUFFER_RESULT';
1622 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1623 $startOpts .= ' SQL_SMALL_RESULT';
1626 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1627 $startOpts .= ' SQL_CALC_FOUND_ROWS';
1630 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1631 $startOpts .= ' SQL_CACHE';
1634 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1635 $startOpts .= ' SQL_NO_CACHE';
1638 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1639 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1643 if ( isset( $options['IGNORE INDEX'] ) && is_string( $options['IGNORE INDEX'] ) ) {
1644 $ignoreIndex = $this->ignoreIndexClause( $options['IGNORE INDEX'] );
1649 return [ $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ];
1653 * Returns an optional GROUP BY with an optional HAVING
1655 * @param array $options Associative array of options
1657 * @see Database::select()
1660 protected function makeGroupByWithHaving( $options ) {
1662 if ( isset( $options['GROUP BY'] ) ) {
1663 $gb = is_array( $options['GROUP BY'] )
1664 ?
implode( ',', $options['GROUP BY'] )
1665 : $options['GROUP BY'];
1666 $sql .= ' GROUP BY ' . $gb;
1668 if ( isset( $options['HAVING'] ) ) {
1669 $having = is_array( $options['HAVING'] )
1670 ?
$this->makeList( $options['HAVING'], self
::LIST_AND
)
1671 : $options['HAVING'];
1672 $sql .= ' HAVING ' . $having;
1679 * Returns an optional ORDER BY
1681 * @param array $options Associative array of options
1683 * @see Database::select()
1686 protected function makeOrderBy( $options ) {
1687 if ( isset( $options['ORDER BY'] ) ) {
1688 $ob = is_array( $options['ORDER BY'] )
1689 ?
implode( ',', $options['ORDER BY'] )
1690 : $options['ORDER BY'];
1692 return ' ORDER BY ' . $ob;
1698 public function select(
1699 $table, $vars, $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1701 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1703 return $this->query( $sql, $fname );
1706 public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__
,
1707 $options = [], $join_conds = []
1709 if ( is_array( $vars ) ) {
1710 $fields = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1715 $options = (array)$options;
1716 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1717 ?
$options['USE INDEX']
1720 isset( $options['IGNORE INDEX'] ) &&
1721 is_array( $options['IGNORE INDEX'] )
1723 ?
$options['IGNORE INDEX']
1727 $this->selectOptionsIncludeLocking( $options ) &&
1728 $this->selectFieldsOrOptionsAggregate( $vars, $options )
1730 // Some DB types (postgres/oracle) disallow FOR UPDATE with aggregate
1731 // functions. Discourage use of such queries to encourage compatibility.
1733 $this->deprecationLogger
,
1734 __METHOD__
. ": aggregation used with a locking SELECT ($fname)."
1738 if ( is_array( $table ) ) {
1740 $this->tableNamesWithIndexClauseOrJOIN(
1741 $table, $useIndexes, $ignoreIndexes, $join_conds );
1742 } elseif ( $table != '' ) {
1744 $this->tableNamesWithIndexClauseOrJOIN(
1745 [ $table ], $useIndexes, $ignoreIndexes, [] );
1750 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ) =
1751 $this->makeSelectOptions( $options );
1753 if ( is_array( $conds ) ) {
1754 $conds = $this->makeList( $conds, self
::LIST_AND
);
1757 if ( $conds === null ||
$conds === false ) {
1758 $this->queryLogger
->warning(
1762 . ' with incorrect parameters: $conds must be a string or an array'
1767 if ( $conds === '' ||
$conds === '*' ) {
1768 $sql = "SELECT $startOpts $fields $from $useIndex $ignoreIndex $preLimitTail";
1769 } elseif ( is_string( $conds ) ) {
1770 $sql = "SELECT $startOpts $fields $from $useIndex $ignoreIndex " .
1771 "WHERE $conds $preLimitTail";
1773 throw new DBUnexpectedError( $this, __METHOD__
. ' called with incorrect parameters' );
1776 if ( isset( $options['LIMIT'] ) ) {
1777 $sql = $this->limitResult( $sql, $options['LIMIT'],
1778 $options['OFFSET'] ??
false );
1780 $sql = "$sql $postLimitTail";
1782 if ( isset( $options['EXPLAIN'] ) ) {
1783 $sql = 'EXPLAIN ' . $sql;
1789 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
1790 $options = [], $join_conds = []
1792 $options = (array)$options;
1793 $options['LIMIT'] = 1;
1794 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1796 if ( $res === false ) {
1800 if ( !$this->numRows( $res ) ) {
1804 $obj = $this->fetchObject( $res );
1809 public function estimateRowCount(
1810 $table, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1812 $conds = $this->normalizeConditions( $conds, $fname );
1813 $column = $this->extractSingleFieldFromList( $var );
1814 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
1815 $conds[] = "$column IS NOT NULL";
1818 $res = $this->select(
1819 $table, [ 'rowcount' => 'COUNT(*)' ], $conds, $fname, $options, $join_conds
1821 $row = $res ?
$this->fetchRow( $res ) : [];
1823 return isset( $row['rowcount'] ) ?
(int)$row['rowcount'] : 0;
1826 public function selectRowCount(
1827 $tables, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1829 $conds = $this->normalizeConditions( $conds, $fname );
1830 $column = $this->extractSingleFieldFromList( $var );
1831 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
1832 $conds[] = "$column IS NOT NULL";
1835 $res = $this->select(
1837 'tmp_count' => $this->buildSelectSubquery(
1846 [ 'rowcount' => 'COUNT(*)' ],
1850 $row = $res ?
$this->fetchRow( $res ) : [];
1852 return isset( $row['rowcount'] ) ?
(int)$row['rowcount'] : 0;
1856 * @param string|array $options
1859 private function selectOptionsIncludeLocking( $options ) {
1860 $options = (array)$options;
1861 foreach ( [ 'FOR UPDATE', 'LOCK IN SHARE MODE' ] as $lock ) {
1862 if ( in_array( $lock, $options, true ) ) {
1871 * @param array|string $fields
1872 * @param array|string $options
1875 private function selectFieldsOrOptionsAggregate( $fields, $options ) {
1876 foreach ( (array)$options as $key => $value ) {
1877 if ( is_string( $key ) ) {
1878 if ( preg_match( '/^(?:GROUP BY|HAVING)$/i', $key ) ) {
1881 } elseif ( is_string( $value ) ) {
1882 if ( preg_match( '/^(?:DISTINCT|DISTINCTROW)$/i', $value ) ) {
1888 $regex = '/^(?:COUNT|MIN|MAX|SUM|GROUP_CONCAT|LISTAGG|ARRAY_AGG)\s*\\(/i';
1889 foreach ( (array)$fields as $field ) {
1890 if ( is_string( $field ) && preg_match( $regex, $field ) ) {
1899 * @param array|string $conds
1900 * @param string $fname
1903 final protected function normalizeConditions( $conds, $fname ) {
1904 if ( $conds === null ||
$conds === false ) {
1905 $this->queryLogger
->warning(
1909 . ' with incorrect parameters: $conds must be a string or an array'
1914 if ( !is_array( $conds ) ) {
1915 $conds = ( $conds === '' ) ?
[] : [ $conds ];
1922 * @param array|string $var Field parameter in the style of select()
1923 * @return string|null Column name or null; ignores aliases
1924 * @throws DBUnexpectedError Errors out if multiple columns are given
1926 final protected function extractSingleFieldFromList( $var ) {
1927 if ( is_array( $var ) ) {
1930 } elseif ( count( $var ) == 1 ) {
1931 $column = $var[0] ??
reset( $var );
1933 throw new DBUnexpectedError( $this, __METHOD__
. ': got multiple columns.' );
1942 public function lockForUpdate(
1943 $table, $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1945 if ( !$this->trxLevel
&& !$this->getFlag( self
::DBO_TRX
) ) {
1946 throw new DBUnexpectedError(
1948 __METHOD__
. ': no transaction is active nor is DBO_TRX set'
1952 $options = (array)$options;
1953 $options[] = 'FOR UPDATE';
1955 return $this->selectRowCount( $table, '*', $conds, $fname, $options, $join_conds );
1959 * Removes most variables from an SQL query and replaces them with X or N for numbers.
1960 * It's only slightly flawed. Don't use for anything important.
1962 * @param string $sql A SQL Query
1966 protected static function generalizeSQL( $sql ) {
1967 # This does the same as the regexp below would do, but in such a way
1968 # as to avoid crashing php on some large strings.
1969 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
1971 $sql = str_replace( "\\\\", '', $sql );
1972 $sql = str_replace( "\\'", '', $sql );
1973 $sql = str_replace( "\\\"", '', $sql );
1974 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
1975 $sql = preg_replace( '/".*"/s', "'X'", $sql );
1977 # All newlines, tabs, etc replaced by single space
1978 $sql = preg_replace( '/\s+/', ' ', $sql );
1981 # except the ones surrounded by characters, e.g. l10n
1982 $sql = preg_replace( '/-?\d+(,-?\d+)+/s', 'N,...,N', $sql );
1983 $sql = preg_replace( '/(?<![a-zA-Z])-?\d+(?![a-zA-Z])/s', 'N', $sql );
1988 public function fieldExists( $table, $field, $fname = __METHOD__
) {
1989 $info = $this->fieldInfo( $table, $field );
1994 public function indexExists( $table, $index, $fname = __METHOD__
) {
1995 if ( !$this->tableExists( $table ) ) {
1999 $info = $this->indexInfo( $table, $index, $fname );
2000 if ( is_null( $info ) ) {
2003 return $info !== false;
2007 abstract public function tableExists( $table, $fname = __METHOD__
);
2009 public function indexUnique( $table, $index ) {
2010 $indexInfo = $this->indexInfo( $table, $index );
2012 if ( !$indexInfo ) {
2016 return !$indexInfo[0]->Non_unique
;
2020 * Helper for Database::insert().
2022 * @param array $options
2025 protected function makeInsertOptions( $options ) {
2026 return implode( ' ', $options );
2029 public function insert( $table, $a, $fname = __METHOD__
, $options = [] ) {
2030 # No rows to insert, easy just return now
2031 if ( !count( $a ) ) {
2035 $table = $this->tableName( $table );
2037 if ( !is_array( $options ) ) {
2038 $options = [ $options ];
2041 $fh = $options['fileHandle'] ??
null;
2042 $options = $this->makeInsertOptions( $options );
2044 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
2046 $keys = array_keys( $a[0] );
2049 $keys = array_keys( $a );
2052 $sql = 'INSERT ' . $options .
2053 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
2057 foreach ( $a as $row ) {
2063 $sql .= '(' . $this->makeList( $row ) . ')';
2066 $sql .= '(' . $this->makeList( $a ) . ')';
2069 if ( $fh !== null && false === fwrite( $fh, $sql ) ) {
2071 } elseif ( $fh !== null ) {
2075 return (bool)$this->query( $sql, $fname );
2079 * Make UPDATE options array for Database::makeUpdateOptions
2081 * @param array $options
2084 protected function makeUpdateOptionsArray( $options ) {
2085 if ( !is_array( $options ) ) {
2086 $options = [ $options ];
2091 if ( in_array( 'IGNORE', $options ) ) {
2099 * Make UPDATE options for the Database::update function
2101 * @param array $options The options passed to Database::update
2104 protected function makeUpdateOptions( $options ) {
2105 $opts = $this->makeUpdateOptionsArray( $options );
2107 return implode( ' ', $opts );
2110 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] ) {
2111 $table = $this->tableName( $table );
2112 $opts = $this->makeUpdateOptions( $options );
2113 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, self
::LIST_SET
);
2115 if ( $conds !== [] && $conds !== '*' ) {
2116 $sql .= " WHERE " . $this->makeList( $conds, self
::LIST_AND
);
2119 return (bool)$this->query( $sql, $fname );
2122 public function makeList( $a, $mode = self
::LIST_COMMA
) {
2123 if ( !is_array( $a ) ) {
2124 throw new DBUnexpectedError( $this, __METHOD__
. ' called with incorrect parameters' );
2130 foreach ( $a as $field => $value ) {
2132 if ( $mode == self
::LIST_AND
) {
2134 } elseif ( $mode == self
::LIST_OR
) {
2143 if ( ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) && is_numeric( $field ) ) {
2144 $list .= "($value)";
2145 } elseif ( $mode == self
::LIST_SET
&& is_numeric( $field ) ) {
2148 ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) && is_array( $value )
2150 // Remove null from array to be handled separately if found
2151 $includeNull = false;
2152 foreach ( array_keys( $value, null, true ) as $nullKey ) {
2153 $includeNull = true;
2154 unset( $value[$nullKey] );
2156 if ( count( $value ) == 0 && !$includeNull ) {
2157 throw new InvalidArgumentException(
2158 __METHOD__
. ": empty input for field $field" );
2159 } elseif ( count( $value ) == 0 ) {
2160 // only check if $field is null
2161 $list .= "$field IS NULL";
2163 // IN clause contains at least one valid element
2164 if ( $includeNull ) {
2165 // Group subconditions to ensure correct precedence
2168 if ( count( $value ) == 1 ) {
2169 // Special-case single values, as IN isn't terribly efficient
2170 // Don't necessarily assume the single key is 0; we don't
2171 // enforce linear numeric ordering on other arrays here.
2172 $value = array_values( $value )[0];
2173 $list .= $field . " = " . $this->addQuotes( $value );
2175 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
2177 // if null present in array, append IS NULL
2178 if ( $includeNull ) {
2179 $list .= " OR $field IS NULL)";
2182 } elseif ( $value === null ) {
2183 if ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) {
2184 $list .= "$field IS ";
2185 } elseif ( $mode == self
::LIST_SET
) {
2186 $list .= "$field = ";
2191 $mode == self
::LIST_AND ||
$mode == self
::LIST_OR ||
$mode == self
::LIST_SET
2193 $list .= "$field = ";
2195 $list .= $mode == self
::LIST_NAMES ?
$value : $this->addQuotes( $value );
2202 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
2205 foreach ( $data as $base => $sub ) {
2206 if ( count( $sub ) ) {
2207 $conds[] = $this->makeList(
2208 [ $baseKey => $base, $subKey => array_keys( $sub ) ],
2214 return $this->makeList( $conds, self
::LIST_OR
);
2216 // Nothing to search for...
2221 public function aggregateValue( $valuedata, $valuename = 'value' ) {
2225 public function bitNot( $field ) {
2229 public function bitAnd( $fieldLeft, $fieldRight ) {
2230 return "($fieldLeft & $fieldRight)";
2233 public function bitOr( $fieldLeft, $fieldRight ) {
2234 return "($fieldLeft | $fieldRight)";
2237 public function buildConcat( $stringList ) {
2238 return 'CONCAT(' . implode( ',', $stringList ) . ')';
2241 public function buildGroupConcatField(
2242 $delim, $table, $field, $conds = '', $join_conds = []
2244 $fld = "GROUP_CONCAT($field SEPARATOR " . $this->addQuotes( $delim ) . ')';
2246 return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
2249 public function buildSubstring( $input, $startPosition, $length = null ) {
2250 $this->assertBuildSubstringParams( $startPosition, $length );
2251 $functionBody = "$input FROM $startPosition";
2252 if ( $length !== null ) {
2253 $functionBody .= " FOR $length";
2255 return 'SUBSTRING(' . $functionBody . ')';
2259 * Check type and bounds for parameters to self::buildSubstring()
2261 * All supported databases have substring functions that behave the same for
2262 * positive $startPosition and non-negative $length, but behaviors differ when
2263 * given 0 or negative $startPosition or negative $length. The simplest
2264 * solution to that is to just forbid those values.
2266 * @param int $startPosition
2267 * @param int|null $length
2270 protected function assertBuildSubstringParams( $startPosition, $length ) {
2271 if ( !is_int( $startPosition ) ||
$startPosition <= 0 ) {
2272 throw new InvalidArgumentException(
2273 '$startPosition must be a positive integer'
2276 if ( !( is_int( $length ) && $length >= 0 ||
$length === null ) ) {
2277 throw new InvalidArgumentException(
2278 '$length must be null or an integer greater than or equal to 0'
2283 public function buildStringCast( $field ) {
2287 public function buildIntegerCast( $field ) {
2288 return 'CAST( ' . $field . ' AS INTEGER )';
2291 public function buildSelectSubquery(
2292 $table, $vars, $conds = '', $fname = __METHOD__
,
2293 $options = [], $join_conds = []
2295 return new Subquery(
2296 $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds )
2300 public function databasesAreIndependent() {
2304 final public function selectDB( $db ) {
2305 $this->selectDomain( new DatabaseDomain(
2307 $this->currentDomain
->getSchema(),
2308 $this->currentDomain
->getTablePrefix()
2314 final public function selectDomain( $domain ) {
2315 $this->doSelectDomain( DatabaseDomain
::newFromId( $domain ) );
2318 protected function doSelectDomain( DatabaseDomain
$domain ) {
2319 $this->currentDomain
= $domain;
2322 public function getDBname() {
2323 return $this->currentDomain
->getDatabase();
2326 public function getServer() {
2327 return $this->server
;
2330 public function tableName( $name, $format = 'quoted' ) {
2331 if ( $name instanceof Subquery
) {
2332 throw new DBUnexpectedError(
2334 __METHOD__
. ': got Subquery instance when expecting a string.'
2338 # Skip the entire process when we have a string quoted on both ends.
2339 # Note that we check the end so that we will still quote any use of
2340 # use of `database`.table. But won't break things if someone wants
2341 # to query a database table with a dot in the name.
2342 if ( $this->isQuotedIdentifier( $name ) ) {
2346 # Lets test for any bits of text that should never show up in a table
2347 # name. Basically anything like JOIN or ON which are actually part of
2348 # SQL queries, but may end up inside of the table value to combine
2349 # sql. Such as how the API is doing.
2350 # Note that we use a whitespace test rather than a \b test to avoid
2351 # any remote case where a word like on may be inside of a table name
2352 # surrounded by symbols which may be considered word breaks.
2353 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
2354 $this->queryLogger
->warning(
2355 __METHOD__
. ": use of subqueries is not supported this way.",
2356 [ 'trace' => ( new RuntimeException() )->getTraceAsString() ]
2362 # Split database and table into proper variables.
2363 list( $database, $schema, $prefix, $table ) = $this->qualifiedTableComponents( $name );
2365 # Quote $table and apply the prefix if not quoted.
2366 # $tableName might be empty if this is called from Database::replaceVars()
2367 $tableName = "{$prefix}{$table}";
2368 if ( $format === 'quoted'
2369 && !$this->isQuotedIdentifier( $tableName )
2370 && $tableName !== ''
2372 $tableName = $this->addIdentifierQuotes( $tableName );
2375 # Quote $schema and $database and merge them with the table name if needed
2376 $tableName = $this->prependDatabaseOrSchema( $schema, $tableName, $format );
2377 $tableName = $this->prependDatabaseOrSchema( $database, $tableName, $format );
2383 * Get the table components needed for a query given the currently selected database
2385 * @param string $name Table name in the form of db.schema.table, db.table, or table
2386 * @return array (DB name or "" for default, schema name, table prefix, table name)
2388 protected function qualifiedTableComponents( $name ) {
2389 # We reverse the explode so that database.table and table both output the correct table.
2390 $dbDetails = explode( '.', $name, 3 );
2391 if ( count( $dbDetails ) == 3 ) {
2392 list( $database, $schema, $table ) = $dbDetails;
2393 # We don't want any prefix added in this case
2395 } elseif ( count( $dbDetails ) == 2 ) {
2396 list( $database, $table ) = $dbDetails;
2397 # We don't want any prefix added in this case
2399 # In dbs that support it, $database may actually be the schema
2400 # but that doesn't affect any of the functionality here
2403 list( $table ) = $dbDetails;
2404 if ( isset( $this->tableAliases
[$table] ) ) {
2405 $database = $this->tableAliases
[$table]['dbname'];
2406 $schema = is_string( $this->tableAliases
[$table]['schema'] )
2407 ?
$this->tableAliases
[$table]['schema']
2408 : $this->relationSchemaQualifier();
2409 $prefix = is_string( $this->tableAliases
[$table]['prefix'] )
2410 ?
$this->tableAliases
[$table]['prefix']
2411 : $this->tablePrefix();
2414 $schema = $this->relationSchemaQualifier(); # Default schema
2415 $prefix = $this->tablePrefix(); # Default prefix
2419 return [ $database, $schema, $prefix, $table ];
2423 * @param string|null $namespace Database or schema
2424 * @param string $relation Name of table, view, sequence, etc...
2425 * @param string $format One of (raw, quoted)
2426 * @return string Relation name with quoted and merged $namespace as needed
2428 private function prependDatabaseOrSchema( $namespace, $relation, $format ) {
2429 if ( strlen( $namespace ) ) {
2430 if ( $format === 'quoted' && !$this->isQuotedIdentifier( $namespace ) ) {
2431 $namespace = $this->addIdentifierQuotes( $namespace );
2433 $relation = $namespace . '.' . $relation;
2439 public function tableNames() {
2440 $inArray = func_get_args();
2443 foreach ( $inArray as $name ) {
2444 $retVal[$name] = $this->tableName( $name );
2450 public function tableNamesN() {
2451 $inArray = func_get_args();
2454 foreach ( $inArray as $name ) {
2455 $retVal[] = $this->tableName( $name );
2462 * Get an aliased table name
2464 * This returns strings like "tableName AS newTableName" for aliased tables
2465 * and "(SELECT * from tableA) newTablename" for subqueries (e.g. derived tables)
2467 * @see Database::tableName()
2468 * @param string|Subquery $table Table name or object with a 'sql' field
2469 * @param string|bool $alias Table alias (optional)
2470 * @return string SQL name for aliased table. Will not alias a table to its own name
2472 protected function tableNameWithAlias( $table, $alias = false ) {
2473 if ( is_string( $table ) ) {
2474 $quotedTable = $this->tableName( $table );
2475 } elseif ( $table instanceof Subquery
) {
2476 $quotedTable = (string)$table;
2478 throw new InvalidArgumentException( "Table must be a string or Subquery." );
2481 if ( !strlen( $alias ) ||
$alias === $table ) {
2482 if ( $table instanceof Subquery
) {
2483 throw new InvalidArgumentException( "Subquery table missing alias." );
2486 return $quotedTable;
2488 return $quotedTable . ' ' . $this->addIdentifierQuotes( $alias );
2493 * Gets an array of aliased table names
2495 * @param array $tables [ [alias] => table ]
2496 * @return string[] See tableNameWithAlias()
2498 protected function tableNamesWithAlias( $tables ) {
2500 foreach ( $tables as $alias => $table ) {
2501 if ( is_numeric( $alias ) ) {
2504 $retval[] = $this->tableNameWithAlias( $table, $alias );
2511 * Get an aliased field name
2512 * e.g. fieldName AS newFieldName
2514 * @param string $name Field name
2515 * @param string|bool $alias Alias (optional)
2516 * @return string SQL name for aliased field. Will not alias a field to its own name
2518 protected function fieldNameWithAlias( $name, $alias = false ) {
2519 if ( !$alias ||
(string)$alias === (string)$name ) {
2522 return $name . ' AS ' . $this->addIdentifierQuotes( $alias ); // PostgreSQL needs AS
2527 * Gets an array of aliased field names
2529 * @param array $fields [ [alias] => field ]
2530 * @return string[] See fieldNameWithAlias()
2532 protected function fieldNamesWithAlias( $fields ) {
2534 foreach ( $fields as $alias => $field ) {
2535 if ( is_numeric( $alias ) ) {
2538 $retval[] = $this->fieldNameWithAlias( $field, $alias );
2545 * Get the aliased table name clause for a FROM clause
2546 * which might have a JOIN and/or USE INDEX or IGNORE INDEX clause
2548 * @param array $tables ( [alias] => table )
2549 * @param array $use_index Same as for select()
2550 * @param array $ignore_index Same as for select()
2551 * @param array $join_conds Same as for select()
2554 protected function tableNamesWithIndexClauseOrJOIN(
2555 $tables, $use_index = [], $ignore_index = [], $join_conds = []
2559 $use_index = (array)$use_index;
2560 $ignore_index = (array)$ignore_index;
2561 $join_conds = (array)$join_conds;
2563 foreach ( $tables as $alias => $table ) {
2564 if ( !is_string( $alias ) ) {
2565 // No alias? Set it equal to the table name
2569 if ( is_array( $table ) ) {
2570 // A parenthesized group
2571 if ( count( $table ) > 1 ) {
2572 $joinedTable = '(' .
2573 $this->tableNamesWithIndexClauseOrJOIN(
2574 $table, $use_index, $ignore_index, $join_conds ) . ')';
2577 $innerTable = reset( $table );
2578 $innerAlias = key( $table );
2579 $joinedTable = $this->tableNameWithAlias(
2581 is_string( $innerAlias ) ?
$innerAlias : $innerTable
2585 $joinedTable = $this->tableNameWithAlias( $table, $alias );
2588 // Is there a JOIN clause for this table?
2589 if ( isset( $join_conds[$alias] ) ) {
2590 list( $joinType, $conds ) = $join_conds[$alias];
2591 $tableClause = $joinType;
2592 $tableClause .= ' ' . $joinedTable;
2593 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2594 $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2596 $tableClause .= ' ' . $use;
2599 if ( isset( $ignore_index[$alias] ) ) { // has IGNORE INDEX?
2600 $ignore = $this->ignoreIndexClause(
2601 implode( ',', (array)$ignore_index[$alias] ) );
2602 if ( $ignore != '' ) {
2603 $tableClause .= ' ' . $ignore;
2606 $on = $this->makeList( (array)$conds, self
::LIST_AND
);
2608 $tableClause .= ' ON (' . $on . ')';
2611 $retJOIN[] = $tableClause;
2612 } elseif ( isset( $use_index[$alias] ) ) {
2613 // Is there an INDEX clause for this table?
2614 $tableClause = $joinedTable;
2615 $tableClause .= ' ' . $this->useIndexClause(
2616 implode( ',', (array)$use_index[$alias] )
2619 $ret[] = $tableClause;
2620 } elseif ( isset( $ignore_index[$alias] ) ) {
2621 // Is there an INDEX clause for this table?
2622 $tableClause = $joinedTable;
2623 $tableClause .= ' ' . $this->ignoreIndexClause(
2624 implode( ',', (array)$ignore_index[$alias] )
2627 $ret[] = $tableClause;
2629 $tableClause = $joinedTable;
2631 $ret[] = $tableClause;
2635 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2636 $implicitJoins = $ret ?
implode( ',', $ret ) : "";
2637 $explicitJoins = $retJOIN ?
implode( ' ', $retJOIN ) : "";
2639 // Compile our final table clause
2640 return implode( ' ', [ $implicitJoins, $explicitJoins ] );
2644 * Allows for index remapping in queries where this is not consistent across DBMS
2646 * @param string $index
2649 protected function indexName( $index ) {
2650 return $this->indexAliases
[$index] ??
$index;
2653 public function addQuotes( $s ) {
2654 if ( $s instanceof Blob
) {
2657 if ( $s === null ) {
2659 } elseif ( is_bool( $s ) ) {
2662 # This will also quote numeric values. This should be harmless,
2663 # and protects against weird problems that occur when they really
2664 # _are_ strings such as article titles and string->number->string
2665 # conversion is not 1:1.
2666 return "'" . $this->strencode( $s ) . "'";
2671 * Quotes an identifier using `backticks` or "double quotes" depending on the database type.
2672 * MySQL uses `backticks` while basically everything else uses double quotes.
2673 * Since MySQL is the odd one out here the double quotes are our generic
2674 * and we implement backticks in DatabaseMysqlBase.
2679 public function addIdentifierQuotes( $s ) {
2680 return '"' . str_replace( '"', '""', $s ) . '"';
2684 * Returns if the given identifier looks quoted or not according to
2685 * the database convention for quoting identifiers .
2687 * @note Do not use this to determine if untrusted input is safe.
2688 * A malicious user can trick this function.
2689 * @param string $name
2692 public function isQuotedIdentifier( $name ) {
2693 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2698 * @param string $escapeChar
2701 protected function escapeLikeInternal( $s, $escapeChar = '`' ) {
2702 return str_replace( [ $escapeChar, '%', '_' ],
2703 [ "{$escapeChar}{$escapeChar}", "{$escapeChar}%", "{$escapeChar}_" ],
2707 public function buildLike() {
2708 $params = func_get_args();
2710 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2711 $params = $params[0];
2716 // We use ` instead of \ as the default LIKE escape character, since addQuotes()
2717 // may escape backslashes, creating problems of double escaping. The `
2718 // character has good cross-DBMS compatibility, avoiding special operators
2719 // in MS SQL like ^ and %
2722 foreach ( $params as $value ) {
2723 if ( $value instanceof LikeMatch
) {
2724 $s .= $value->toString();
2726 $s .= $this->escapeLikeInternal( $value, $escapeChar );
2731 $this->addQuotes( $s ) . ' ESCAPE ' . $this->addQuotes( $escapeChar ) . ' ';
2734 public function anyChar() {
2735 return new LikeMatch( '_' );
2738 public function anyString() {
2739 return new LikeMatch( '%' );
2742 public function nextSequenceValue( $seqName ) {
2747 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2748 * is only needed because a) MySQL must be as efficient as possible due to
2749 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2750 * which index to pick. Anyway, other databases might have different
2751 * indexes on a given table. So don't bother overriding this unless you're
2753 * @param string $index
2756 public function useIndexClause( $index ) {
2761 * IGNORE INDEX clause. Unlikely to be useful for anything but MySQL. This
2762 * is only needed because a) MySQL must be as efficient as possible due to
2763 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2764 * which index to pick. Anyway, other databases might have different
2765 * indexes on a given table. So don't bother overriding this unless you're
2767 * @param string $index
2770 public function ignoreIndexClause( $index ) {
2774 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
2775 if ( count( $rows ) == 0 ) {
2780 if ( !is_array( reset( $rows ) ) ) {
2785 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
2786 $affectedRowCount = 0;
2787 foreach ( $rows as $row ) {
2788 // Delete rows which collide with this one
2789 $indexWhereClauses = [];
2790 foreach ( $uniqueIndexes as $index ) {
2791 $indexColumns = (array)$index;
2792 $indexRowValues = array_intersect_key( $row, array_flip( $indexColumns ) );
2793 if ( count( $indexRowValues ) != count( $indexColumns ) ) {
2794 throw new DBUnexpectedError(
2796 'New record does not provide all values for unique key (' .
2797 implode( ', ', $indexColumns ) . ')'
2799 } elseif ( in_array( null, $indexRowValues, true ) ) {
2800 throw new DBUnexpectedError(
2802 'New record has a null value for unique key (' .
2803 implode( ', ', $indexColumns ) . ')'
2806 $indexWhereClauses[] = $this->makeList( $indexRowValues, LIST_AND
);
2809 if ( $indexWhereClauses ) {
2810 $this->delete( $table, $this->makeList( $indexWhereClauses, LIST_OR
), $fname );
2811 $affectedRowCount +
= $this->affectedRows();
2814 // Now insert the row
2815 $this->insert( $table, $row, $fname );
2816 $affectedRowCount +
= $this->affectedRows();
2818 $this->endAtomic( $fname );
2819 $this->affectedRowCount
= $affectedRowCount;
2820 } catch ( Exception
$e ) {
2821 $this->cancelAtomic( $fname );
2827 * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2830 * @param string $table Table name
2831 * @param array|string $rows Row(s) to insert
2832 * @param string $fname Caller function name
2834 * @return ResultWrapper
2836 protected function nativeReplace( $table, $rows, $fname ) {
2837 $table = $this->tableName( $table );
2840 if ( !is_array( reset( $rows ) ) ) {
2844 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2847 foreach ( $rows as $row ) {
2854 $sql .= '(' . $this->makeList( $row ) . ')';
2857 return $this->query( $sql, $fname );
2860 public function upsert( $table, array $rows, array $uniqueIndexes, array $set,
2863 if ( !count( $rows ) ) {
2864 return true; // nothing to do
2867 if ( !is_array( reset( $rows ) ) ) {
2871 if ( count( $uniqueIndexes ) ) {
2872 $clauses = []; // list WHERE clauses that each identify a single row
2873 foreach ( $rows as $row ) {
2874 foreach ( $uniqueIndexes as $index ) {
2875 $index = is_array( $index ) ?
$index : [ $index ]; // columns
2876 $rowKey = []; // unique key to this row
2877 foreach ( $index as $column ) {
2878 $rowKey[$column] = $row[$column];
2880 $clauses[] = $this->makeList( $rowKey, self
::LIST_AND
);
2883 $where = [ $this->makeList( $clauses, self
::LIST_OR
) ];
2888 $affectedRowCount = 0;
2890 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
2891 # Update any existing conflicting row(s)
2892 if ( $where !== false ) {
2893 $ok = $this->update( $table, $set, $where, $fname );
2894 $affectedRowCount +
= $this->affectedRows();
2898 # Now insert any non-conflicting row(s)
2899 $ok = $this->insert( $table, $rows, $fname, [ 'IGNORE' ] ) && $ok;
2900 $affectedRowCount +
= $this->affectedRows();
2901 $this->endAtomic( $fname );
2902 $this->affectedRowCount
= $affectedRowCount;
2903 } catch ( Exception
$e ) {
2904 $this->cancelAtomic( $fname );
2911 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2915 throw new DBUnexpectedError( $this, __METHOD__
. ' called with empty $conds' );
2918 $delTable = $this->tableName( $delTable );
2919 $joinTable = $this->tableName( $joinTable );
2920 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2921 if ( $conds != '*' ) {
2922 $sql .= 'WHERE ' . $this->makeList( $conds, self
::LIST_AND
);
2926 $this->query( $sql, $fname );
2929 public function textFieldSize( $table, $field ) {
2930 $table = $this->tableName( $table );
2931 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2932 $res = $this->query( $sql, __METHOD__
);
2933 $row = $this->fetchObject( $res );
2937 if ( preg_match( '/\((.*)\)/', $row->Type
, $m ) ) {
2946 public function delete( $table, $conds, $fname = __METHOD__
) {
2948 throw new DBUnexpectedError( $this, __METHOD__
. ' called with no conditions' );
2951 $table = $this->tableName( $table );
2952 $sql = "DELETE FROM $table";
2954 if ( $conds != '*' ) {
2955 if ( is_array( $conds ) ) {
2956 $conds = $this->makeList( $conds, self
::LIST_AND
);
2958 $sql .= ' WHERE ' . $conds;
2961 return $this->query( $sql, $fname );
2964 final public function insertSelect(
2965 $destTable, $srcTable, $varMap, $conds,
2966 $fname = __METHOD__
, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
2968 static $hints = [ 'NO_AUTO_COLUMNS' ];
2970 $insertOptions = (array)$insertOptions;
2971 $selectOptions = (array)$selectOptions;
2973 if ( $this->cliMode
&& $this->isInsertSelectSafe( $insertOptions, $selectOptions ) ) {
2974 // For massive migrations with downtime, we don't want to select everything
2975 // into memory and OOM, so do all this native on the server side if possible.
2976 return $this->nativeInsertSelect(
2982 array_diff( $insertOptions, $hints ),
2988 return $this->nonNativeInsertSelect(
2994 array_diff( $insertOptions, $hints ),
3001 * @param array $insertOptions INSERT options
3002 * @param array $selectOptions SELECT options
3003 * @return bool Whether an INSERT SELECT with these options will be replication safe
3006 protected function isInsertSelectSafe( array $insertOptions, array $selectOptions ) {
3011 * Implementation of insertSelect() based on select() and insert()
3013 * @see IDatabase::insertSelect()
3015 * @param string $destTable
3016 * @param string|array $srcTable
3017 * @param array $varMap
3018 * @param array $conds
3019 * @param string $fname
3020 * @param array $insertOptions
3021 * @param array $selectOptions
3022 * @param array $selectJoinConds
3025 protected function nonNativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
3026 $fname = __METHOD__
,
3027 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3029 // For web requests, do a locking SELECT and then INSERT. This puts the SELECT burden
3030 // on only the master (without needing row-based-replication). It also makes it easy to
3031 // know how big the INSERT is going to be.
3033 foreach ( $varMap as $dstColumn => $sourceColumnOrSql ) {
3034 $fields[] = $this->fieldNameWithAlias( $sourceColumnOrSql, $dstColumn );
3036 $selectOptions[] = 'FOR UPDATE';
3037 $res = $this->select(
3038 $srcTable, implode( ',', $fields ), $conds, $fname, $selectOptions, $selectJoinConds
3045 $affectedRowCount = 0;
3046 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
3049 foreach ( $res as $row ) {
3050 $rows[] = (array)$row;
3052 // Avoid inserts that are too huge
3053 if ( count( $rows ) >= $this->nonNativeInsertSelectBatchSize
) {
3054 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
3058 $affectedRowCount +
= $this->affectedRows();
3062 if ( $rows && $ok ) {
3063 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
3065 $affectedRowCount +
= $this->affectedRows();
3069 $this->endAtomic( $fname );
3070 $this->affectedRowCount
= $affectedRowCount;
3072 $this->cancelAtomic( $fname );
3075 } catch ( Exception
$e ) {
3076 $this->cancelAtomic( $fname );
3082 * Native server-side implementation of insertSelect() for situations where
3083 * we don't want to select everything into memory
3085 * @see IDatabase::insertSelect()
3086 * @param string $destTable
3087 * @param string|array $srcTable
3088 * @param array $varMap
3089 * @param array $conds
3090 * @param string $fname
3091 * @param array $insertOptions
3092 * @param array $selectOptions
3093 * @param array $selectJoinConds
3096 protected function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
3097 $fname = __METHOD__
,
3098 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3100 $destTable = $this->tableName( $destTable );
3102 if ( !is_array( $insertOptions ) ) {
3103 $insertOptions = [ $insertOptions ];
3106 $insertOptions = $this->makeInsertOptions( $insertOptions );
3108 $selectSql = $this->selectSQLText(
3110 array_values( $varMap ),
3117 $sql = "INSERT $insertOptions" .
3118 " INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ') ' .
3121 return $this->query( $sql, $fname );
3125 * Construct a LIMIT query with optional offset. This is used for query
3126 * pages. The SQL should be adjusted so that only the first $limit rows
3127 * are returned. If $offset is provided as well, then the first $offset
3128 * rows should be discarded, and the next $limit rows should be returned.
3129 * If the result of the query is not ordered, then the rows to be returned
3130 * are theoretically arbitrary.
3132 * $sql is expected to be a SELECT, if that makes a difference.
3134 * The version provided by default works in MySQL and SQLite. It will very
3135 * likely need to be overridden for most other DBMSes.
3137 * @param string $sql SQL query we will append the limit too
3138 * @param int $limit The SQL limit
3139 * @param int|bool $offset The SQL offset (default false)
3140 * @throws DBUnexpectedError
3143 public function limitResult( $sql, $limit, $offset = false ) {
3144 if ( !is_numeric( $limit ) ) {
3145 throw new DBUnexpectedError( $this,
3146 "Invalid non-numeric limit passed to limitResult()\n" );
3149 return "$sql LIMIT "
3150 . ( ( is_numeric( $offset ) && $offset != 0 ) ?
"{$offset}," : "" )
3154 public function unionSupportsOrderAndLimit() {
3155 return true; // True for almost every DB supported
3158 public function unionQueries( $sqls, $all ) {
3159 $glue = $all ?
') UNION ALL (' : ') UNION (';
3161 return '(' . implode( $glue, $sqls ) . ')';
3164 public function unionConditionPermutations(
3165 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__
,
3166 $options = [], $join_conds = []
3168 // First, build the Cartesian product of $permute_conds
3170 foreach ( $permute_conds as $field => $values ) {
3172 // Skip empty $values
3175 $values = array_unique( $values ); // For sanity
3177 foreach ( $conds as $cond ) {
3178 foreach ( $values as $value ) {
3179 $cond[$field] = $value;
3180 $newConds[] = $cond; // Arrays are by-value, not by-reference, so this works
3186 $extra_conds = $extra_conds === '' ?
[] : (array)$extra_conds;
3188 // If there's just one condition and no subordering, hand off to
3189 // selectSQLText directly.
3190 if ( count( $conds ) === 1 &&
3191 ( !isset( $options['INNER ORDER BY'] ) ||
!$this->unionSupportsOrderAndLimit() )
3193 return $this->selectSQLText(
3194 $table, $vars, $conds[0] +
$extra_conds, $fname, $options, $join_conds
3198 // Otherwise, we need to pull out the order and limit to apply after
3199 // the union. Then build the SQL queries for each set of conditions in
3200 // $conds. Then union them together (using UNION ALL, because the
3201 // product *should* already be distinct).
3202 $orderBy = $this->makeOrderBy( $options );
3203 $limit = $options['LIMIT'] ??
null;
3204 $offset = $options['OFFSET'] ??
false;
3205 $all = empty( $options['NOTALL'] ) && !in_array( 'NOTALL', $options );
3206 if ( !$this->unionSupportsOrderAndLimit() ) {
3207 unset( $options['ORDER BY'], $options['LIMIT'], $options['OFFSET'] );
3209 if ( array_key_exists( 'INNER ORDER BY', $options ) ) {
3210 $options['ORDER BY'] = $options['INNER ORDER BY'];
3212 if ( $limit !== null && is_numeric( $offset ) && $offset != 0 ) {
3213 // We need to increase the limit by the offset rather than
3214 // using the offset directly, otherwise it'll skip incorrectly
3215 // in the subqueries.
3216 $options['LIMIT'] = $limit +
$offset;
3217 unset( $options['OFFSET'] );
3222 foreach ( $conds as $cond ) {
3223 $sqls[] = $this->selectSQLText(
3224 $table, $vars, $cond +
$extra_conds, $fname, $options, $join_conds
3227 $sql = $this->unionQueries( $sqls, $all ) . $orderBy;
3228 if ( $limit !== null ) {
3229 $sql = $this->limitResult( $sql, $limit, $offset );
3235 public function conditional( $cond, $trueVal, $falseVal ) {
3236 if ( is_array( $cond ) ) {
3237 $cond = $this->makeList( $cond, self
::LIST_AND
);
3240 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
3243 public function strreplace( $orig, $old, $new ) {
3244 return "REPLACE({$orig}, {$old}, {$new})";
3247 public function getServerUptime() {
3251 public function wasDeadlock() {
3255 public function wasLockTimeout() {
3259 public function wasConnectionLoss() {
3260 return $this->wasConnectionError( $this->lastErrno() );
3263 public function wasReadOnlyError() {
3267 public function wasErrorReissuable() {
3269 $this->wasDeadlock() ||
3270 $this->wasLockTimeout() ||
3271 $this->wasConnectionLoss()
3276 * Do not use this method outside of Database/DBError classes
3278 * @param int|string $errno
3279 * @return bool Whether the given query error was a connection drop
3281 public function wasConnectionError( $errno ) {
3286 * @return bool Whether it is safe to assume the given error only caused statement rollback
3287 * @note This is for backwards compatibility for callers catching DBError exceptions in
3288 * order to ignore problems like duplicate key errors or foriegn key violations
3291 protected function wasKnownStatementRollbackError() {
3292 return false; // don't know; it could have caused a transaction rollback
3295 public function deadlockLoop() {
3296 $args = func_get_args();
3297 $function = array_shift( $args );
3298 $tries = self
::DEADLOCK_TRIES
;
3300 $this->begin( __METHOD__
);
3303 /** @var Exception $e */
3307 $retVal = $function( ...$args );
3309 } catch ( DBQueryError
$e ) {
3310 if ( $this->wasDeadlock() ) {
3311 // Retry after a randomized delay
3312 usleep( mt_rand( self
::DEADLOCK_DELAY_MIN
, self
::DEADLOCK_DELAY_MAX
) );
3314 // Throw the error back up
3318 } while ( --$tries > 0 );
3320 if ( $tries <= 0 ) {
3321 // Too many deadlocks; give up
3322 $this->rollback( __METHOD__
);
3325 $this->commit( __METHOD__
);
3331 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
3332 # Real waits are implemented in the subclass.
3336 public function getReplicaPos() {
3341 public function getMasterPos() {
3346 public function serverIsReadOnly() {
3350 final public function onTransactionResolution( callable
$callback, $fname = __METHOD__
) {
3351 if ( !$this->trxLevel
) {
3352 throw new DBUnexpectedError( $this, "No transaction is active." );
3354 $this->trxEndCallbacks
[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3357 final public function onTransactionCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
3358 if ( !$this->trxLevel
&& $this->getTransactionRoundId() ) {
3359 // Start an implicit transaction similar to how query() does
3360 $this->begin( __METHOD__
, self
::TRANSACTION_INTERNAL
);
3361 $this->trxAutomatic
= true;
3364 $this->trxIdleCallbacks
[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3365 if ( !$this->trxLevel
) {
3366 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_IDLE
);
3370 final public function onTransactionIdle( callable
$callback, $fname = __METHOD__
) {
3371 $this->onTransactionCommitOrIdle( $callback, $fname );
3374 final public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
3375 if ( !$this->trxLevel
&& $this->getTransactionRoundId() ) {
3376 // Start an implicit transaction similar to how query() does
3377 $this->begin( __METHOD__
, self
::TRANSACTION_INTERNAL
);
3378 $this->trxAutomatic
= true;
3381 if ( $this->trxLevel
) {
3382 $this->trxPreCommitCallbacks
[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3384 // No transaction is active nor will start implicitly, so make one for this callback
3385 $this->startAtomic( __METHOD__
, self
::ATOMIC_CANCELABLE
);
3388 $this->endAtomic( __METHOD__
);
3389 } catch ( Exception
$e ) {
3390 $this->cancelAtomic( __METHOD__
);
3397 * @return AtomicSectionIdentifier|null ID of the topmost atomic section level
3399 private function currentAtomicSectionId() {
3400 if ( $this->trxLevel
&& $this->trxAtomicLevels
) {
3401 $levelInfo = end( $this->trxAtomicLevels
);
3403 return $levelInfo[1];
3410 * @param AtomicSectionIdentifier $old
3411 * @param AtomicSectionIdentifier $new
3413 private function reassignCallbacksForSection(
3414 AtomicSectionIdentifier
$old, AtomicSectionIdentifier
$new
3416 foreach ( $this->trxPreCommitCallbacks
as $key => $info ) {
3417 if ( $info[2] === $old ) {
3418 $this->trxPreCommitCallbacks
[$key][2] = $new;
3421 foreach ( $this->trxIdleCallbacks
as $key => $info ) {
3422 if ( $info[2] === $old ) {
3423 $this->trxIdleCallbacks
[$key][2] = $new;
3426 foreach ( $this->trxEndCallbacks
as $key => $info ) {
3427 if ( $info[2] === $old ) {
3428 $this->trxEndCallbacks
[$key][2] = $new;
3434 * @param AtomicSectionIdentifier[] $sectionIds ID of an actual savepoint
3435 * @throws UnexpectedValueException
3437 private function modifyCallbacksForCancel( array $sectionIds ) {
3438 // Cancel the "on commit" callbacks owned by this savepoint
3439 $this->trxIdleCallbacks
= array_filter(
3440 $this->trxIdleCallbacks
,
3441 function ( $entry ) use ( $sectionIds ) {
3442 return !in_array( $entry[2], $sectionIds, true );
3445 $this->trxPreCommitCallbacks
= array_filter(
3446 $this->trxPreCommitCallbacks
,
3447 function ( $entry ) use ( $sectionIds ) {
3448 return !in_array( $entry[2], $sectionIds, true );
3451 // Make "on resolution" callbacks owned by this savepoint to perceive a rollback
3452 foreach ( $this->trxEndCallbacks
as $key => $entry ) {
3453 if ( in_array( $entry[2], $sectionIds, true ) ) {
3454 $callback = $entry[0];
3455 $this->trxEndCallbacks
[$key][0] = function () use ( $callback ) {
3456 return $callback( self
::TRIGGER_ROLLBACK
, $this );
3462 final public function setTransactionListener( $name, callable
$callback = null ) {
3464 $this->trxRecurringCallbacks
[$name] = $callback;
3466 unset( $this->trxRecurringCallbacks
[$name] );
3471 * Whether to disable running of post-COMMIT/ROLLBACK callbacks
3473 * This method should not be used outside of Database/LoadBalancer
3475 * @param bool $suppress
3478 final public function setTrxEndCallbackSuppression( $suppress ) {
3479 $this->trxEndCallbacksSuppressed
= $suppress;
3483 * Actually consume and run any "on transaction idle/resolution" callbacks.
3485 * This method should not be used outside of Database/LoadBalancer
3487 * @param int $trigger IDatabase::TRIGGER_* constant
3488 * @return int Number of callbacks attempted
3492 public function runOnTransactionIdleCallbacks( $trigger ) {
3493 if ( $this->trxLevel
) { // sanity
3494 throw new DBUnexpectedError( $this, __METHOD__
. ': a transaction is still open.' );
3497 if ( $this->trxEndCallbacksSuppressed
) {
3502 $autoTrx = $this->getFlag( self
::DBO_TRX
); // automatic begin() enabled?
3503 /** @var Exception $e */
3504 $e = null; // first exception
3505 do { // callbacks may add callbacks :)
3506 $callbacks = array_merge(
3507 $this->trxIdleCallbacks
,
3508 $this->trxEndCallbacks
// include "transaction resolution" callbacks
3510 $this->trxIdleCallbacks
= []; // consumed (and recursion guard)
3511 $this->trxEndCallbacks
= []; // consumed (recursion guard)
3512 foreach ( $callbacks as $callback ) {
3514 list( $phpCallback ) = $callback;
3515 $this->clearFlag( self
::DBO_TRX
); // make each query its own transaction
3517 call_user_func( $phpCallback, $trigger, $this );
3518 } catch ( Exception
$ex ) {
3519 call_user_func( $this->errorLogger
, $ex );
3521 // Some callbacks may use startAtomic/endAtomic, so make sure
3522 // their transactions are ended so other callbacks don't fail
3523 if ( $this->trxLevel() ) {
3524 $this->rollback( __METHOD__
, self
::FLUSHING_INTERNAL
);
3528 $this->setFlag( self
::DBO_TRX
); // restore automatic begin()
3530 $this->clearFlag( self
::DBO_TRX
); // restore auto-commit
3534 } while ( count( $this->trxIdleCallbacks
) );
3536 if ( $e instanceof Exception
) {
3537 throw $e; // re-throw any first exception
3544 * Actually consume and run any "on transaction pre-commit" callbacks.
3546 * This method should not be used outside of Database/LoadBalancer
3549 * @return int Number of callbacks attempted
3552 public function runOnTransactionPreCommitCallbacks() {
3555 $e = null; // first exception
3556 do { // callbacks may add callbacks :)
3557 $callbacks = $this->trxPreCommitCallbacks
;
3558 $this->trxPreCommitCallbacks
= []; // consumed (and recursion guard)
3559 foreach ( $callbacks as $callback ) {
3562 list( $phpCallback ) = $callback;
3563 $phpCallback( $this );
3564 } catch ( Exception
$ex ) {
3565 ( $this->errorLogger
)( $ex );
3569 } while ( count( $this->trxPreCommitCallbacks
) );
3571 if ( $e instanceof Exception
) {
3572 throw $e; // re-throw any first exception
3579 * Actually run any "transaction listener" callbacks.
3581 * This method should not be used outside of Database/LoadBalancer
3583 * @param int $trigger IDatabase::TRIGGER_* constant
3587 public function runTransactionListenerCallbacks( $trigger ) {
3588 if ( $this->trxEndCallbacksSuppressed
) {
3592 /** @var Exception $e */
3593 $e = null; // first exception
3595 foreach ( $this->trxRecurringCallbacks
as $phpCallback ) {
3597 $phpCallback( $trigger, $this );
3598 } catch ( Exception
$ex ) {
3599 ( $this->errorLogger
)( $ex );
3604 if ( $e instanceof Exception
) {
3605 throw $e; // re-throw any first exception
3610 * Create a savepoint
3612 * This is used internally to implement atomic sections. It should not be
3616 * @param string $identifier Identifier for the savepoint
3617 * @param string $fname Calling function name
3619 protected function doSavepoint( $identifier, $fname ) {
3620 $this->query( 'SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3624 * Release a savepoint
3626 * This is used internally to implement atomic sections. It should not be
3630 * @param string $identifier Identifier for the savepoint
3631 * @param string $fname Calling function name
3633 protected function doReleaseSavepoint( $identifier, $fname ) {
3634 $this->query( 'RELEASE SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3638 * Rollback to a savepoint
3640 * This is used internally to implement atomic sections. It should not be
3644 * @param string $identifier Identifier for the savepoint
3645 * @param string $fname Calling function name
3647 protected function doRollbackToSavepoint( $identifier, $fname ) {
3648 $this->query( 'ROLLBACK TO SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3652 * @param string $fname
3655 private function nextSavepointId( $fname ) {
3656 $savepointId = self
::$SAVEPOINT_PREFIX . ++
$this->trxAtomicCounter
;
3657 if ( strlen( $savepointId ) > 30 ) {
3658 // 30 == Oracle's identifier length limit (pre 12c)
3659 // With a 22 character prefix, that puts the highest number at 99999999.
3660 throw new DBUnexpectedError(
3662 'There have been an excessively large number of atomic sections in a transaction'
3663 . " started by $this->trxFname (at $fname)"
3667 return $savepointId;
3670 final public function startAtomic(
3671 $fname = __METHOD__
, $cancelable = self
::ATOMIC_NOT_CANCELABLE
3673 $savepointId = $cancelable === self
::ATOMIC_CANCELABLE ? self
::$NOT_APPLICABLE : null;
3675 if ( !$this->trxLevel
) {
3676 $this->begin( $fname, self
::TRANSACTION_INTERNAL
); // sets trxAutomatic
3677 // If DBO_TRX is set, a series of startAtomic/endAtomic pairs will result
3678 // in all changes being in one transaction to keep requests transactional.
3679 if ( $this->getFlag( self
::DBO_TRX
) ) {
3680 // Since writes could happen in between the topmost atomic sections as part
3681 // of the transaction, those sections will need savepoints.
3682 $savepointId = $this->nextSavepointId( $fname );
3683 $this->doSavepoint( $savepointId, $fname );
3685 $this->trxAutomaticAtomic
= true;
3687 } elseif ( $cancelable === self
::ATOMIC_CANCELABLE
) {
3688 $savepointId = $this->nextSavepointId( $fname );
3689 $this->doSavepoint( $savepointId, $fname );
3692 $sectionId = new AtomicSectionIdentifier
;
3693 $this->trxAtomicLevels
[] = [ $fname, $sectionId, $savepointId ];
3694 $this->queryLogger
->debug( 'startAtomic: entering level ' .
3695 ( count( $this->trxAtomicLevels
) - 1 ) . " ($fname)" );
3700 final public function endAtomic( $fname = __METHOD__
) {
3701 if ( !$this->trxLevel ||
!$this->trxAtomicLevels
) {
3702 throw new DBUnexpectedError( $this, "No atomic section is open (got $fname)." );
3705 // Check if the current section matches $fname
3706 $pos = count( $this->trxAtomicLevels
) - 1;
3707 list( $savedFname, $sectionId, $savepointId ) = $this->trxAtomicLevels
[$pos];
3708 $this->queryLogger
->debug( "endAtomic: leaving level $pos ($fname)" );
3710 if ( $savedFname !== $fname ) {
3711 throw new DBUnexpectedError(
3713 "Invalid atomic section ended (got $fname but expected $savedFname)."
3717 // Remove the last section (no need to re-index the array)
3718 array_pop( $this->trxAtomicLevels
);
3720 if ( !$this->trxAtomicLevels
&& $this->trxAutomaticAtomic
) {
3721 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
3722 } elseif ( $savepointId !== null && $savepointId !== self
::$NOT_APPLICABLE ) {
3723 $this->doReleaseSavepoint( $savepointId, $fname );
3726 // Hoist callback ownership for callbacks in the section that just ended;
3727 // all callbacks should have an owner that is present in trxAtomicLevels.
3728 $currentSectionId = $this->currentAtomicSectionId();
3729 if ( $currentSectionId ) {
3730 $this->reassignCallbacksForSection( $sectionId, $currentSectionId );
3734 final public function cancelAtomic(
3735 $fname = __METHOD__
, AtomicSectionIdentifier
$sectionId = null
3737 if ( !$this->trxLevel ||
!$this->trxAtomicLevels
) {
3738 throw new DBUnexpectedError( $this, "No atomic section is open (got $fname)." );
3741 $excisedFnames = [];
3742 if ( $sectionId !== null ) {
3743 // Find the (last) section with the given $sectionId
3745 foreach ( $this->trxAtomicLevels
as $i => list( $asFname, $asId, $spId ) ) {
3746 if ( $asId === $sectionId ) {
3751 throw new DBUnexpectedError( "Atomic section not found (for $fname)" );
3753 // Remove all descendant sections and re-index the array
3755 $len = count( $this->trxAtomicLevels
);
3756 for ( $i = $pos +
1; $i < $len; ++
$i ) {
3757 $excisedFnames[] = $this->trxAtomicLevels
[$i][0];
3758 $excisedIds[] = $this->trxAtomicLevels
[$i][1];
3760 $this->trxAtomicLevels
= array_slice( $this->trxAtomicLevels
, 0, $pos +
1 );
3761 $this->modifyCallbacksForCancel( $excisedIds );
3764 // Check if the current section matches $fname
3765 $pos = count( $this->trxAtomicLevels
) - 1;
3766 list( $savedFname, $savedSectionId, $savepointId ) = $this->trxAtomicLevels
[$pos];
3768 if ( $excisedFnames ) {
3769 $this->queryLogger
->debug( "cancelAtomic: canceling level $pos ($savedFname) " .
3770 "and descendants " . implode( ', ', $excisedFnames ) );
3772 $this->queryLogger
->debug( "cancelAtomic: canceling level $pos ($savedFname)" );
3775 if ( $savedFname !== $fname ) {
3776 throw new DBUnexpectedError(
3778 "Invalid atomic section ended (got $fname but expected $savedFname)."
3782 // Remove the last section (no need to re-index the array)
3783 array_pop( $this->trxAtomicLevels
);
3784 $this->modifyCallbacksForCancel( [ $savedSectionId ] );
3786 if ( $savepointId !== null ) {
3787 // Rollback the transaction to the state just before this atomic section
3788 if ( $savepointId === self
::$NOT_APPLICABLE ) {
3789 $this->rollback( $fname, self
::FLUSHING_INTERNAL
);
3791 $this->doRollbackToSavepoint( $savepointId, $fname );
3792 $this->trxStatus
= self
::STATUS_TRX_OK
; // no exception; recovered
3793 $this->trxStatusIgnoredCause
= null;
3795 } elseif ( $this->trxStatus
> self
::STATUS_TRX_ERROR
) {
3796 // Put the transaction into an error state if it's not already in one
3797 $this->trxStatus
= self
::STATUS_TRX_ERROR
;
3798 $this->trxStatusCause
= new DBUnexpectedError(
3800 "Uncancelable atomic section canceled (got $fname)."
3804 $this->affectedRowCount
= 0; // for the sake of consistency
3807 final public function doAtomicSection(
3808 $fname, callable
$callback, $cancelable = self
::ATOMIC_NOT_CANCELABLE
3810 $sectionId = $this->startAtomic( $fname, $cancelable );
3812 $res = $callback( $this, $fname );
3813 } catch ( Exception
$e ) {
3814 $this->cancelAtomic( $fname, $sectionId );
3818 $this->endAtomic( $fname );
3823 final public function begin( $fname = __METHOD__
, $mode = self
::TRANSACTION_EXPLICIT
) {
3824 static $modes = [ self
::TRANSACTION_EXPLICIT
, self
::TRANSACTION_INTERNAL
];
3825 if ( !in_array( $mode, $modes, true ) ) {
3826 throw new DBUnexpectedError( $this, "$fname: invalid mode parameter '$mode'." );
3829 // Protect against mismatched atomic section, transaction nesting, and snapshot loss
3830 if ( $this->trxLevel
) {
3831 if ( $this->trxAtomicLevels
) {
3832 $levels = $this->flatAtomicSectionList();
3833 $msg = "$fname: Got explicit BEGIN while atomic section(s) $levels are open.";
3834 throw new DBUnexpectedError( $this, $msg );
3835 } elseif ( !$this->trxAutomatic
) {
3836 $msg = "$fname: Explicit transaction already active (from {$this->trxFname}).";
3837 throw new DBUnexpectedError( $this, $msg );
3839 $msg = "$fname: Implicit transaction already active (from {$this->trxFname}).";
3840 throw new DBUnexpectedError( $this, $msg );
3842 } elseif ( $this->getFlag( self
::DBO_TRX
) && $mode !== self
::TRANSACTION_INTERNAL
) {
3843 $msg = "$fname: Implicit transaction expected (DBO_TRX set).";
3844 throw new DBUnexpectedError( $this, $msg );
3847 // Avoid fatals if close() was called
3848 $this->assertOpen();
3850 $this->doBegin( $fname );
3851 $this->trxStatus
= self
::STATUS_TRX_OK
;
3852 $this->trxStatusIgnoredCause
= null;
3853 $this->trxAtomicCounter
= 0;
3854 $this->trxTimestamp
= microtime( true );
3855 $this->trxFname
= $fname;
3856 $this->trxDoneWrites
= false;
3857 $this->trxAutomaticAtomic
= false;
3858 $this->trxAtomicLevels
= [];
3859 $this->trxShortId
= sprintf( '%06x', mt_rand( 0, 0xffffff ) );
3860 $this->trxWriteDuration
= 0.0;
3861 $this->trxWriteQueryCount
= 0;
3862 $this->trxWriteAffectedRows
= 0;
3863 $this->trxWriteAdjDuration
= 0.0;
3864 $this->trxWriteAdjQueryCount
= 0;
3865 $this->trxWriteCallers
= [];
3866 // First SELECT after BEGIN will establish the snapshot in REPEATABLE-READ.
3867 // Get an estimate of the replication lag before any such queries.
3868 $this->trxReplicaLag
= null; // clear cached value first
3869 $this->trxReplicaLag
= $this->getApproximateLagStatus()['lag'];
3870 // T147697: make explicitTrxActive() return true until begin() finishes. This way, no
3871 // caller will think its OK to muck around with the transaction just because startAtomic()
3872 // has not yet completed (e.g. setting trxAtomicLevels).
3873 $this->trxAutomatic
= ( $mode === self
::TRANSACTION_INTERNAL
);
3877 * Issues the BEGIN command to the database server.
3879 * @see Database::begin()
3880 * @param string $fname
3882 protected function doBegin( $fname ) {
3883 $this->query( 'BEGIN', $fname );
3884 $this->trxLevel
= 1;
3887 final public function commit( $fname = __METHOD__
, $flush = self
::FLUSHING_ONE
) {
3888 static $modes = [ self
::FLUSHING_ONE
, self
::FLUSHING_ALL_PEERS
, self
::FLUSHING_INTERNAL
];
3889 if ( !in_array( $flush, $modes, true ) ) {
3890 throw new DBUnexpectedError( $this, "$fname: invalid flush parameter '$flush'." );
3893 if ( $this->trxLevel
&& $this->trxAtomicLevels
) {
3894 // There are still atomic sections open; this cannot be ignored
3895 $levels = $this->flatAtomicSectionList();
3896 throw new DBUnexpectedError(
3898 "$fname: Got COMMIT while atomic sections $levels are still open."
3902 if ( $flush === self
::FLUSHING_INTERNAL ||
$flush === self
::FLUSHING_ALL_PEERS
) {
3903 if ( !$this->trxLevel
) {
3904 return; // nothing to do
3905 } elseif ( !$this->trxAutomatic
) {
3906 throw new DBUnexpectedError(
3908 "$fname: Flushing an explicit transaction, getting out of sync."
3912 if ( !$this->trxLevel
) {
3913 $this->queryLogger
->error(
3914 "$fname: No transaction to commit, something got out of sync." );
3915 return; // nothing to do
3916 } elseif ( $this->trxAutomatic
) {
3917 throw new DBUnexpectedError(
3919 "$fname: Expected mass commit of all peer transactions (DBO_TRX set)."
3924 // Avoid fatals if close() was called
3925 $this->assertOpen();
3927 $this->runOnTransactionPreCommitCallbacks();
3929 $writeTime = $this->pendingWriteQueryDuration( self
::ESTIMATE_DB_APPLY
);
3930 $this->doCommit( $fname );
3931 $this->trxStatus
= self
::STATUS_TRX_NONE
;
3933 if ( $this->trxDoneWrites
) {
3934 $this->lastWriteTime
= microtime( true );
3935 $this->trxProfiler
->transactionWritingOut(
3937 $this->getDomainID(),
3940 $this->trxWriteAffectedRows
3944 // With FLUSHING_ALL_PEERS, callbacks will be explicitly run later
3945 if ( $flush !== self
::FLUSHING_ALL_PEERS
) {
3946 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_COMMIT
);
3947 $this->runTransactionListenerCallbacks( self
::TRIGGER_COMMIT
);
3952 * Issues the COMMIT command to the database server.
3954 * @see Database::commit()
3955 * @param string $fname
3957 protected function doCommit( $fname ) {
3958 if ( $this->trxLevel
) {
3959 $this->query( 'COMMIT', $fname );
3960 $this->trxLevel
= 0;
3964 final public function rollback( $fname = __METHOD__
, $flush = '' ) {
3965 $trxActive = $this->trxLevel
;
3967 if ( $flush !== self
::FLUSHING_INTERNAL
&& $flush !== self
::FLUSHING_ALL_PEERS
) {
3968 if ( $this->getFlag( self
::DBO_TRX
) ) {
3969 throw new DBUnexpectedError(
3971 "$fname: Expected mass rollback of all peer transactions (DBO_TRX set)."
3977 // Avoid fatals if close() was called
3978 $this->assertOpen();
3980 $this->doRollback( $fname );
3981 $this->trxStatus
= self
::STATUS_TRX_NONE
;
3982 $this->trxAtomicLevels
= [];
3983 // Estimate the RTT via a query now that trxStatus is OK
3984 $writeTime = $this->pingAndCalculateLastTrxApplyTime();
3986 if ( $this->trxDoneWrites
) {
3987 $this->trxProfiler
->transactionWritingOut(
3989 $this->getDomainID(),
3992 $this->trxWriteAffectedRows
3997 // Clear any commit-dependant callbacks. They might even be present
3998 // only due to transaction rounds, with no SQL transaction being active
3999 $this->trxIdleCallbacks
= [];
4000 $this->trxPreCommitCallbacks
= [];
4002 // With FLUSHING_ALL_PEERS, callbacks will be explicitly run later
4003 if ( $trxActive && $flush !== self
::FLUSHING_ALL_PEERS
) {
4005 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_ROLLBACK
);
4006 } catch ( Exception
$e ) {
4007 // already logged; finish and let LoadBalancer move on during mass-rollback
4010 $this->runTransactionListenerCallbacks( self
::TRIGGER_ROLLBACK
);
4011 } catch ( Exception
$e ) {
4012 // already logged; let LoadBalancer move on during mass-rollback
4015 $this->affectedRowCount
= 0; // for the sake of consistency
4020 * Issues the ROLLBACK command to the database server.
4022 * @see Database::rollback()
4023 * @param string $fname
4025 protected function doRollback( $fname ) {
4026 if ( $this->trxLevel
) {
4027 # Disconnects cause rollback anyway, so ignore those errors
4028 $ignoreErrors = true;
4029 $this->query( 'ROLLBACK', $fname, $ignoreErrors );
4030 $this->trxLevel
= 0;
4034 public function flushSnapshot( $fname = __METHOD__
) {
4035 if ( $this->writesOrCallbacksPending() ||
$this->explicitTrxActive() ) {
4036 // This only flushes transactions to clear snapshots, not to write data
4037 $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
4038 throw new DBUnexpectedError(
4040 "$fname: Cannot flush snapshot because writes are pending ($fnames)."
4044 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
4047 public function explicitTrxActive() {
4048 return $this->trxLevel
&& ( $this->trxAtomicLevels ||
!$this->trxAutomatic
);
4051 public function duplicateTableStructure(
4052 $oldName, $newName, $temporary = false, $fname = __METHOD__
4054 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
4057 public function listTables( $prefix = null, $fname = __METHOD__
) {
4058 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
4061 public function listViews( $prefix = null, $fname = __METHOD__
) {
4062 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
4065 public function timestamp( $ts = 0 ) {
4066 $t = new ConvertibleTimestamp( $ts );
4067 // Let errors bubble up to avoid putting garbage in the DB
4068 return $t->getTimestamp( TS_MW
);
4071 public function timestampOrNull( $ts = null ) {
4072 if ( is_null( $ts ) ) {
4075 return $this->timestamp( $ts );
4079 public function affectedRows() {
4080 return ( $this->affectedRowCount
=== null )
4081 ?
$this->fetchAffectedRowCount() // default to driver value
4082 : $this->affectedRowCount
;
4086 * @return int Number of retrieved rows according to the driver
4088 abstract protected function fetchAffectedRowCount();
4091 * Take the result from a query, and wrap it in a ResultWrapper if
4092 * necessary. Boolean values are passed through as is, to indicate success
4093 * of write queries or failure.
4095 * Once upon a time, Database::query() returned a bare MySQL result
4096 * resource, and it was necessary to call this function to convert it to
4097 * a wrapper. Nowadays, raw database objects are never exposed to external
4098 * callers, so this is unnecessary in external code.
4100 * @param bool|ResultWrapper|resource $result
4101 * @return bool|ResultWrapper
4103 protected function resultObject( $result ) {
4106 } elseif ( $result instanceof ResultWrapper
) {
4108 } elseif ( $result === true ) {
4109 // Successful write query
4112 return new ResultWrapper( $this, $result );
4116 public function ping( &$rtt = null ) {
4117 // Avoid hitting the server if it was hit recently
4118 if ( $this->isOpen() && ( microtime( true ) - $this->lastPing
) < self
::PING_TTL
) {
4119 if ( !func_num_args() ||
$this->rttEstimate
> 0 ) {
4120 $rtt = $this->rttEstimate
;
4121 return true; // don't care about $rtt
4125 // This will reconnect if possible or return false if not
4126 $this->clearFlag( self
::DBO_TRX
, self
::REMEMBER_PRIOR
);
4127 $ok = ( $this->query( self
::PING_QUERY
, __METHOD__
, true ) !== false );
4128 $this->restoreFlags( self
::RESTORE_PRIOR
);
4131 $rtt = $this->rttEstimate
;
4138 * Close any existing (dead) database connection and open a new connection
4140 * @param string $fname
4141 * @return bool True if new connection is opened successfully, false if error
4143 protected function replaceLostConnection( $fname ) {
4144 $this->closeConnection();
4145 $this->opened
= false;
4146 $this->conn
= false;
4154 $this->tablePrefix()
4156 $this->lastPing
= microtime( true );
4159 $this->connLogger
->warning(
4160 $fname . ': lost connection to {dbserver}; reconnected',
4162 'dbserver' => $this->getServer(),
4163 'trace' => ( new RuntimeException() )->getTraceAsString()
4166 } catch ( DBConnectionError
$e ) {
4169 $this->connLogger
->error(
4170 $fname . ': lost connection to {dbserver} permanently',
4171 [ 'dbserver' => $this->getServer() ]
4175 $this->handleSessionLoss();
4180 public function getSessionLagStatus() {
4181 return $this->getRecordedTransactionLagStatus() ?
: $this->getApproximateLagStatus();
4185 * Get the replica DB lag when the current transaction started
4187 * This is useful when transactions might use snapshot isolation
4188 * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
4189 * is this lag plus transaction duration. If they don't, it is still
4190 * safe to be pessimistic. This returns null if there is no transaction.
4192 * This returns null if the lag status for this transaction was not yet recorded.
4194 * @return array|null ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
4197 final protected function getRecordedTransactionLagStatus() {
4198 return ( $this->trxLevel
&& $this->trxReplicaLag
!== null )
4199 ?
[ 'lag' => $this->trxReplicaLag
, 'since' => $this->trxTimestamp() ]
4204 * Get a replica DB lag estimate for this server
4206 * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)
4209 protected function getApproximateLagStatus() {
4211 'lag' => $this->getLBInfo( 'replica' ) ?
$this->getLag() : 0,
4212 'since' => microtime( true )
4217 * Merge the result of getSessionLagStatus() for several DBs
4218 * using the most pessimistic values to estimate the lag of
4219 * any data derived from them in combination
4221 * This is information is useful for caching modules
4223 * @see WANObjectCache::set()
4224 * @see WANObjectCache::getWithSetCallback()
4226 * @param IDatabase $db1
4227 * @param IDatabase|null $db2 [optional]
4228 * @return array Map of values:
4229 * - lag: highest lag of any of the DBs or false on error (e.g. replication stopped)
4230 * - since: oldest UNIX timestamp of any of the DB lag estimates
4231 * - pending: whether any of the DBs have uncommitted changes
4235 public static function getCacheSetOptions( IDatabase
$db1, IDatabase
$db2 = null ) {
4236 $res = [ 'lag' => 0, 'since' => INF
, 'pending' => false ];
4237 foreach ( func_get_args() as $db ) {
4238 /** @var IDatabase $db */
4239 $status = $db->getSessionLagStatus();
4240 if ( $status['lag'] === false ) {
4241 $res['lag'] = false;
4242 } elseif ( $res['lag'] !== false ) {
4243 $res['lag'] = max( $res['lag'], $status['lag'] );
4245 $res['since'] = min( $res['since'], $status['since'] );
4246 $res['pending'] = $res['pending'] ?
: $db->writesPending();
4252 public function getLag() {
4256 public function maxListLen() {
4260 public function encodeBlob( $b ) {
4264 public function decodeBlob( $b ) {
4265 if ( $b instanceof Blob
) {
4271 public function setSessionOptions( array $options ) {
4274 public function sourceFile(
4276 callable
$lineCallback = null,
4277 callable
$resultCallback = null,
4279 callable
$inputCallback = null
4281 Wikimedia\
suppressWarnings();
4282 $fp = fopen( $filename, 'r' );
4283 Wikimedia\restoreWarnings
();
4285 if ( false === $fp ) {
4286 throw new RuntimeException( "Could not open \"{$filename}\".\n" );
4290 $fname = __METHOD__
. "( $filename )";
4294 $error = $this->sourceStream(
4295 $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
4296 } catch ( Exception
$e ) {
4306 public function setSchemaVars( $vars ) {
4307 $this->schemaVars
= $vars;
4310 public function sourceStream(
4312 callable
$lineCallback = null,
4313 callable
$resultCallback = null,
4314 $fname = __METHOD__
,
4315 callable
$inputCallback = null
4317 $delimiterReset = new ScopedCallback(
4318 function ( $delimiter ) {
4319 $this->delimiter
= $delimiter;
4321 [ $this->delimiter
]
4325 while ( !feof( $fp ) ) {
4326 if ( $lineCallback ) {
4327 call_user_func( $lineCallback );
4330 $line = trim( fgets( $fp ) );
4332 if ( $line == '' ) {
4336 if ( '-' == $line[0] && '-' == $line[1] ) {
4344 $done = $this->streamStatementEnd( $cmd, $line );
4348 if ( $done ||
feof( $fp ) ) {
4349 $cmd = $this->replaceVars( $cmd );
4351 if ( $inputCallback ) {
4352 $callbackResult = $inputCallback( $cmd );
4354 if ( is_string( $callbackResult ) ||
!$callbackResult ) {
4355 $cmd = $callbackResult;
4360 $res = $this->query( $cmd, $fname );
4362 if ( $resultCallback ) {
4363 $resultCallback( $res, $this );
4366 if ( false === $res ) {
4367 $err = $this->lastError();
4369 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
4376 ScopedCallback
::consume( $delimiterReset );
4381 * Called by sourceStream() to check if we've reached a statement end
4383 * @param string &$sql SQL assembled so far
4384 * @param string &$newLine New line about to be added to $sql
4385 * @return bool Whether $newLine contains end of the statement
4387 public function streamStatementEnd( &$sql, &$newLine ) {
4388 if ( $this->delimiter
) {
4390 $newLine = preg_replace(
4391 '/' . preg_quote( $this->delimiter
, '/' ) . '$/', '', $newLine );
4392 if ( $newLine != $prev ) {
4401 * Database independent variable replacement. Replaces a set of variables
4402 * in an SQL statement with their contents as given by $this->getSchemaVars().
4404 * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
4406 * - '{$var}' should be used for text and is passed through the database's
4408 * - `{$var}` should be used for identifiers (e.g. table and database names).
4409 * It is passed through the database's addIdentifierQuotes method which
4410 * can be overridden if the database uses something other than backticks.
4411 * - / *_* / or / *$wgDBprefix* / passes the name that follows through the
4412 * database's tableName method.
4413 * - / *i* / passes the name that follows through the database's indexName method.
4414 * - In all other cases, / *$var* / is left unencoded. Except for table options,
4415 * its use should be avoided. In 1.24 and older, string encoding was applied.
4417 * @param string $ins SQL statement to replace variables in
4418 * @return string The new SQL statement with variables replaced
4420 protected function replaceVars( $ins ) {
4421 $vars = $this->getSchemaVars();
4422 return preg_replace_callback(
4424 /\* (\$wgDBprefix|[_i]) \*/ (\w*) | # 1-2. tableName, indexName
4425 \'\{\$ (\w+) }\' | # 3. addQuotes
4426 `\{\$ (\w+) }` | # 4. addIdentifierQuotes
4427 /\*\$ (\w+) \*/ # 5. leave unencoded
4429 function ( $m ) use ( $vars ) {
4430 // Note: Because of <https://bugs.php.net/bug.php?id=51881>,
4431 // check for both nonexistent keys *and* the empty string.
4432 if ( isset( $m[1] ) && $m[1] !== '' ) {
4433 if ( $m[1] === 'i' ) {
4434 return $this->indexName( $m[2] );
4436 return $this->tableName( $m[2] );
4438 } elseif ( isset( $m[3] ) && $m[3] !== '' && array_key_exists( $m[3], $vars ) ) {
4439 return $this->addQuotes( $vars[$m[3]] );
4440 } elseif ( isset( $m[4] ) && $m[4] !== '' && array_key_exists( $m[4], $vars ) ) {
4441 return $this->addIdentifierQuotes( $vars[$m[4]] );
4442 } elseif ( isset( $m[5] ) && $m[5] !== '' && array_key_exists( $m[5], $vars ) ) {
4443 return $vars[$m[5]];
4453 * Get schema variables. If none have been set via setSchemaVars(), then
4454 * use some defaults from the current object.
4458 protected function getSchemaVars() {
4459 if ( $this->schemaVars
) {
4460 return $this->schemaVars
;
4462 return $this->getDefaultSchemaVars();
4467 * Get schema variables to use if none have been set via setSchemaVars().
4469 * Override this in derived classes to provide variables for tables.sql
4470 * and SQL patch files.
4474 protected function getDefaultSchemaVars() {
4478 public function lockIsFree( $lockName, $method ) {
4479 // RDBMs methods for checking named locks may or may not count this thread itself.
4480 // In MySQL, IS_FREE_LOCK() returns 0 if the thread already has the lock. This is
4481 // the behavior choosen by the interface for this method.
4482 return !isset( $this->namedLocksHeld
[$lockName] );
4485 public function lock( $lockName, $method, $timeout = 5 ) {
4486 $this->namedLocksHeld
[$lockName] = 1;
4491 public function unlock( $lockName, $method ) {
4492 unset( $this->namedLocksHeld
[$lockName] );
4497 public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
4498 if ( $this->writesOrCallbacksPending() ) {
4499 // This only flushes transactions to clear snapshots, not to write data
4500 $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
4501 throw new DBUnexpectedError(
4503 "$fname: Cannot flush pre-lock snapshot because writes are pending ($fnames)."
4507 if ( !$this->lock( $lockKey, $fname, $timeout ) ) {
4511 $unlocker = new ScopedCallback( function () use ( $lockKey, $fname ) {
4512 if ( $this->trxLevel() ) {
4513 // There is a good chance an exception was thrown, causing any early return
4514 // from the caller. Let any error handler get a chance to issue rollback().
4515 // If there isn't one, let the error bubble up and trigger server-side rollback.
4516 $this->onTransactionResolution(
4517 function () use ( $lockKey, $fname ) {
4518 $this->unlock( $lockKey, $fname );
4523 $this->unlock( $lockKey, $fname );
4527 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
4532 public function namedLocksEnqueue() {
4536 public function tableLocksHaveTransactionScope() {
4540 final public function lockTables( array $read, array $write, $method ) {
4541 if ( $this->writesOrCallbacksPending() ) {
4542 throw new DBUnexpectedError( $this, "Transaction writes or callbacks still pending." );
4545 if ( $this->tableLocksHaveTransactionScope() ) {
4546 $this->startAtomic( $method );
4549 return $this->doLockTables( $read, $write, $method );
4553 * Helper function for lockTables() that handles the actual table locking
4555 * @param array $read Array of tables to lock for read access
4556 * @param array $write Array of tables to lock for write access
4557 * @param string $method Name of caller
4560 protected function doLockTables( array $read, array $write, $method ) {
4564 final public function unlockTables( $method ) {
4565 if ( $this->tableLocksHaveTransactionScope() ) {
4566 $this->endAtomic( $method );
4568 return true; // locks released on COMMIT/ROLLBACK
4571 return $this->doUnlockTables( $method );
4575 * Helper function for unlockTables() that handles the actual table unlocking
4577 * @param string $method Name of caller
4580 protected function doUnlockTables( $method ) {
4586 * @param string $tableName
4587 * @param string $fName
4588 * @return bool|ResultWrapper
4591 public function dropTable( $tableName, $fName = __METHOD__
) {
4592 if ( !$this->tableExists( $tableName, $fName ) ) {
4595 $sql = "DROP TABLE " . $this->tableName( $tableName ) . " CASCADE";
4597 return $this->query( $sql, $fName );
4600 public function getInfinity() {
4604 public function encodeExpiry( $expiry ) {
4605 return ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() )
4606 ?
$this->getInfinity()
4607 : $this->timestamp( $expiry );
4610 public function decodeExpiry( $expiry, $format = TS_MW
) {
4611 if ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() ) {
4615 return ConvertibleTimestamp
::convert( $format, $expiry );
4618 public function setBigSelects( $value = true ) {
4622 public function isReadOnly() {
4623 return ( $this->getReadOnlyReason() !== false );
4627 * @return string|bool Reason this DB is read-only or false if it is not
4629 protected function getReadOnlyReason() {
4630 $reason = $this->getLBInfo( 'readOnlyReason' );
4632 return is_string( $reason ) ?
$reason : false;
4635 public function setTableAliases( array $aliases ) {
4636 $this->tableAliases
= $aliases;
4639 public function setIndexAliases( array $aliases ) {
4640 $this->indexAliases
= $aliases;
4644 * Get the underlying binding connection handle
4646 * Makes sure the connection resource is set (disconnects and ping() failure can unset it).
4647 * This catches broken callers than catch and ignore disconnection exceptions.
4648 * Unlike checking isOpen(), this is safe to call inside of open().
4651 * @throws DBUnexpectedError
4654 protected function getBindingHandle() {
4655 if ( !$this->conn
) {
4656 throw new DBUnexpectedError(
4658 'DB connection was already closed or the connection dropped.'
4669 public function __toString() {
4670 return (string)$this->conn
;
4674 * Make sure that copies do not share the same client binding handle
4675 * @throws DBConnectionError
4677 public function __clone() {
4678 $this->connLogger
->warning(
4679 "Cloning " . static::class . " is not recommended; forking connection:\n" .
4680 ( new RuntimeException() )->getTraceAsString()
4683 if ( $this->isOpen() ) {
4684 // Open a new connection resource without messing with the old one
4685 $this->opened
= false;
4686 $this->conn
= false;
4687 $this->trxEndCallbacks
= []; // don't copy
4688 $this->handleSessionLoss(); // no trx or locks anymore
4695 $this->tablePrefix()
4697 $this->lastPing
= microtime( true );
4702 * Called by serialize. Throw an exception when DB connection is serialized.
4703 * This causes problems on some database engines because the connection is
4704 * not restored on unserialize.
4706 public function __sleep() {
4707 throw new RuntimeException( 'Database serialization may cause problems, since ' .
4708 'the connection is not restored on wakeup.' );
4712 * Run a few simple sanity checks and close dangling connections
4714 public function __destruct() {
4715 if ( $this->trxLevel
&& $this->trxDoneWrites
) {
4716 trigger_error( "Uncommitted DB writes (transaction from {$this->trxFname})." );
4719 $danglingWriters = $this->pendingWriteAndCallbackCallers();
4720 if ( $danglingWriters ) {
4721 $fnames = implode( ', ', $danglingWriters );
4722 trigger_error( "DB transaction writes or callbacks still pending ($fnames)." );
4725 if ( $this->conn
) {
4726 // Avoid connection leaks for sanity. Normally, resources close at script completion.
4727 // The connection might already be closed in zend/hhvm by now, so suppress warnings.
4728 Wikimedia\
suppressWarnings();
4729 $this->closeConnection();
4730 Wikimedia\restoreWarnings
();
4731 $this->conn
= false;
4732 $this->opened
= false;
4738 * @deprecated since 1.28
4740 class_alias( Database
::class, 'DatabaseBase' );
4743 * @deprecated since 1.29
4745 class_alias( Database
::class, 'Database' );