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 string Database that this instance is currently connected to */
86 /** @var array[] Map of (table => (dbname, schema, prefix) map) */
87 protected $tableAliases = [];
88 /** @var string[] Map of (index alias => index) */
89 protected $indexAliases = [];
90 /** @var bool Whether this PHP instance is for a CLI script */
92 /** @var string Agent name for query profiling */
94 /** @var array Parameters used by initConnection() to establish a connection */
95 protected $connectionParams = [];
96 /** @var BagOStuff APC cache */
98 /** @var LoggerInterface */
99 protected $connLogger;
100 /** @var LoggerInterface */
101 protected $queryLogger;
102 /** @var callback Error logging callback */
103 protected $errorLogger;
104 /** @var callback Deprecation logging callback */
105 protected $deprecationLogger;
107 /** @var resource|null Database connection */
108 protected $conn = null;
110 protected $opened = false;
112 /** @var array[] List of (callable, method name, atomic section id) */
113 protected $trxIdleCallbacks = [];
114 /** @var array[] List of (callable, method name, atomic section id) */
115 protected $trxPreCommitCallbacks = [];
116 /** @var array[] List of (callable, method name, atomic section id) */
117 protected $trxEndCallbacks = [];
118 /** @var callable[] Map of (name => callable) */
119 protected $trxRecurringCallbacks = [];
120 /** @var bool Whether to suppress triggering of transaction end callbacks */
121 protected $trxEndCallbacksSuppressed = false;
124 protected $tablePrefix = '';
126 protected $schema = '';
130 protected $lbInfo = [];
131 /** @var array|bool */
132 protected $schemaVars = false;
134 protected $sessionVars = [];
135 /** @var array|null */
136 protected $preparedArgs;
137 /** @var string|bool|null Stashed value of html_errors INI setting */
138 protected $htmlErrors;
140 protected $delimiter = ';';
141 /** @var DatabaseDomain */
142 protected $currentDomain;
143 /** @var integer|null Rows affected by the last query to query() or its CRUD wrappers */
144 protected $affectedRowCount;
147 * @var int Transaction status
149 protected $trxStatus = self
::STATUS_TRX_NONE
;
151 * @var Exception|null The last error that caused the status to become STATUS_TRX_ERROR
153 protected $trxStatusCause;
155 * @var array|null If wasKnownStatementRollbackError() prevented trxStatus from being set,
156 * the relevant details are stored here.
158 protected $trxStatusIgnoredCause;
160 * Either 1 if a transaction is active or 0 otherwise.
161 * The other Trx fields may not be meaningfull if this is 0.
165 protected $trxLevel = 0;
167 * Either a short hexidecimal string if a transaction is active or ""
170 * @see Database::trxLevel
172 protected $trxShortId = '';
174 * The UNIX time that the transaction started. Callers can assume that if
175 * snapshot isolation is used, then the data is *at least* up to date to that
176 * point (possibly more up-to-date since the first SELECT defines the snapshot).
179 * @see Database::trxLevel
181 private $trxTimestamp = null;
182 /** @var float Lag estimate at the time of BEGIN */
183 private $trxReplicaLag = null;
185 * Remembers the function name given for starting the most recent transaction via begin().
186 * Used to provide additional context for error reporting.
189 * @see Database::trxLevel
191 private $trxFname = null;
193 * Record if possible write queries were done in the last transaction started
196 * @see Database::trxLevel
198 private $trxDoneWrites = false;
200 * Record if the current transaction was started implicitly due to DBO_TRX being set.
203 * @see Database::trxLevel
205 private $trxAutomatic = false;
207 * Counter for atomic savepoint identifiers. Reset when a new transaction begins.
211 private $trxAtomicCounter = 0;
213 * Array of levels of atomicity within transactions
215 * @var array List of (name, unique ID, savepoint ID)
217 private $trxAtomicLevels = [];
219 * Record if the current transaction was started implicitly by Database::startAtomic
223 private $trxAutomaticAtomic = false;
225 * Track the write query callers of the current transaction
229 private $trxWriteCallers = [];
231 * @var float Seconds spent in write queries for the current transaction
233 private $trxWriteDuration = 0.0;
235 * @var int Number of write queries for the current transaction
237 private $trxWriteQueryCount = 0;
239 * @var int Number of rows affected by write queries for the current transaction
241 private $trxWriteAffectedRows = 0;
243 * @var float Like trxWriteQueryCount but excludes lock-bound, easy to replicate, queries
245 private $trxWriteAdjDuration = 0.0;
247 * @var int Number of write queries counted in trxWriteAdjDuration
249 private $trxWriteAdjQueryCount = 0;
251 * @var float RTT time estimate
253 private $rttEstimate = 0.0;
255 /** @var array Map of (name => 1) for locks obtained via lock() */
256 private $namedLocksHeld = [];
257 /** @var array Map of (table name => 1) for TEMPORARY tables */
258 protected $sessionTempTables = [];
260 /** @var IDatabase|null Lazy handle to the master DB this server replicates from */
261 private $lazyMasterHandle;
263 /** @var float UNIX timestamp */
264 protected $lastPing = 0.0;
266 /** @var int[] Prior flags member variable values */
267 private $priorFlags = [];
269 /** @var object|string Class name or object With profileIn/profileOut methods */
271 /** @var TransactionProfiler */
272 protected $trxProfiler;
275 protected $nonNativeInsertSelectBatchSize = 10000;
277 /** @var string Idiom used when a cancelable atomic section started the transaction */
278 private static $NOT_APPLICABLE = 'n/a';
279 /** @var string Prefix to the atomic section counter used to make savepoint IDs */
280 private static $SAVEPOINT_PREFIX = 'wikimedia_rdbms_atomic';
282 /** @var int Transaction is in a error state requiring a full or savepoint rollback */
283 const STATUS_TRX_ERROR
= 1;
284 /** @var int Transaction is active and in a normal state */
285 const STATUS_TRX_OK
= 2;
286 /** @var int No transaction is active */
287 const STATUS_TRX_NONE
= 3;
290 * @note: exceptions for missing libraries/drivers should be thrown in initConnection()
291 * @param array $params Parameters passed from Database::factory()
293 protected function __construct( array $params ) {
294 foreach ( [ 'host', 'user', 'password', 'dbname' ] as $name ) {
295 $this->connectionParams
[$name] = $params[$name];
298 $this->schema
= $params['schema'];
299 $this->tablePrefix
= $params['tablePrefix'];
301 $this->cliMode
= $params['cliMode'];
302 // Agent name is added to SQL queries in a comment, so make sure it can't break out
303 $this->agent
= str_replace( '/', '-', $params['agent'] );
305 $this->flags
= $params['flags'];
306 if ( $this->flags
& self
::DBO_DEFAULT
) {
307 if ( $this->cliMode
) {
308 $this->flags
&= ~self
::DBO_TRX
;
310 $this->flags |
= self
::DBO_TRX
;
313 // Disregard deprecated DBO_IGNORE flag (T189999)
314 $this->flags
&= ~self
::DBO_IGNORE
;
316 $this->sessionVars
= $params['variables'];
318 $this->srvCache
= isset( $params['srvCache'] )
319 ?
$params['srvCache']
320 : new HashBagOStuff();
322 $this->profiler
= $params['profiler'];
323 $this->trxProfiler
= $params['trxProfiler'];
324 $this->connLogger
= $params['connLogger'];
325 $this->queryLogger
= $params['queryLogger'];
326 $this->errorLogger
= $params['errorLogger'];
327 $this->deprecationLogger
= $params['deprecationLogger'];
329 if ( isset( $params['nonNativeInsertSelectBatchSize'] ) ) {
330 $this->nonNativeInsertSelectBatchSize
= $params['nonNativeInsertSelectBatchSize'];
333 // Set initial dummy domain until open() sets the final DB/prefix
334 $this->currentDomain
= DatabaseDomain
::newUnspecified();
338 * Initialize the connection to the database over the wire (or to local files)
340 * @throws LogicException
341 * @throws InvalidArgumentException
342 * @throws DBConnectionError
345 final public function initConnection() {
346 if ( $this->isOpen() ) {
347 throw new LogicException( __METHOD__
. ': already connected.' );
349 // Establish the connection
350 $this->doInitConnection();
351 // Set the domain object after open() sets the relevant fields
352 if ( $this->dbName
!= '' ) {
353 // Domains with server scope but a table prefix are not used by IDatabase classes
354 $this->currentDomain
= new DatabaseDomain( $this->dbName
, null, $this->tablePrefix
);
359 * Actually connect to the database over the wire (or to local files)
361 * @throws InvalidArgumentException
362 * @throws DBConnectionError
365 protected function doInitConnection() {
366 if ( strlen( $this->connectionParams
['user'] ) ) {
368 $this->connectionParams
['host'],
369 $this->connectionParams
['user'],
370 $this->connectionParams
['password'],
371 $this->connectionParams
['dbname']
374 throw new InvalidArgumentException( "No database user provided." );
379 * Construct a Database subclass instance given a database type and parameters
381 * This also connects to the database immediately upon object construction
383 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
384 * @param array $p Parameter map with keys:
385 * - host : The hostname of the DB server
386 * - user : The name of the database user the client operates under
387 * - password : The password for the database user
388 * - dbname : The name of the database to use where queries do not specify one.
389 * The database must exist or an error might be thrown. Setting this to the empty string
390 * will avoid any such errors and make the handle have no implicit database scope. This is
391 * useful for queries like SHOW STATUS, CREATE DATABASE, or DROP DATABASE. Note that a
392 * "database" in Postgres is rougly equivalent to an entire MySQL server. This the domain
393 * in which user names and such are defined, e.g. users are database-specific in Postgres.
394 * - schema : The database schema to use (if supported). A "schema" in Postgres is roughly
395 * equivalent to a "database" in MySQL. Note that MySQL and SQLite do not use schemas.
396 * - tablePrefix : Optional table prefix that is implicitly added on to all table names
397 * recognized in queries. This can be used in place of schemas for handle site farms.
398 * - flags : Optional bitfield of DBO_* constants that define connection, protocol,
399 * buffering, and transaction behavior. It is STRONGLY adviced to leave the DBO_DEFAULT
400 * flag in place UNLESS this this database simply acts as a key/value store.
401 * - driver: Optional name of a specific DB client driver. For MySQL, there is only the
402 * 'mysqli' driver; the old one 'mysql' has been removed.
403 * - variables: Optional map of session variables to set after connecting. This can be
404 * used to adjust lock timeouts or encoding modes and the like.
405 * - connLogger: Optional PSR-3 logger interface instance.
406 * - queryLogger: Optional PSR-3 logger interface instance.
407 * - profiler: Optional class name or object with profileIn()/profileOut() methods.
408 * These will be called in query(), using a simplified version of the SQL that also
409 * includes the agent as a SQL comment.
410 * - trxProfiler: Optional TransactionProfiler instance.
411 * - errorLogger: Optional callback that takes an Exception and logs it.
412 * - deprecationLogger: Optional callback that takes a string and logs it.
413 * - cliMode: Whether to consider the execution context that of a CLI script.
414 * - agent: Optional name used to identify the end-user in query profiling/logging.
415 * - srvCache: Optional BagOStuff instance to an APC-style cache.
416 * - nonNativeInsertSelectBatchSize: Optional batch size for non-native INSERT SELECT emulation.
417 * @param int $connect One of the class constants (NEW_CONNECTED, NEW_UNCONNECTED) [optional]
418 * @return Database|null If the database driver or extension cannot be found
419 * @throws InvalidArgumentException If the database driver or extension cannot be found
422 final public static function factory( $dbType, $p = [], $connect = self
::NEW_CONNECTED
) {
423 $class = self
::getClass( $dbType, isset( $p['driver'] ) ?
$p['driver'] : null );
425 if ( class_exists( $class ) && is_subclass_of( $class, IDatabase
::class ) ) {
426 // Resolve some defaults for b/c
427 $p['host'] = isset( $p['host'] ) ?
$p['host'] : false;
428 $p['user'] = isset( $p['user'] ) ?
$p['user'] : false;
429 $p['password'] = isset( $p['password'] ) ?
$p['password'] : false;
430 $p['dbname'] = isset( $p['dbname'] ) ?
$p['dbname'] : false;
431 $p['flags'] = isset( $p['flags'] ) ?
$p['flags'] : 0;
432 $p['variables'] = isset( $p['variables'] ) ?
$p['variables'] : [];
433 $p['tablePrefix'] = isset( $p['tablePrefix'] ) ?
$p['tablePrefix'] : '';
434 $p['schema'] = isset( $p['schema'] ) ?
$p['schema'] : '';
435 $p['cliMode'] = isset( $p['cliMode'] )
437 : ( PHP_SAPI
=== 'cli' || PHP_SAPI
=== 'phpdbg' );
438 $p['agent'] = isset( $p['agent'] ) ?
$p['agent'] : '';
439 if ( !isset( $p['connLogger'] ) ) {
440 $p['connLogger'] = new NullLogger();
442 if ( !isset( $p['queryLogger'] ) ) {
443 $p['queryLogger'] = new NullLogger();
445 $p['profiler'] = isset( $p['profiler'] ) ?
$p['profiler'] : null;
446 if ( !isset( $p['trxProfiler'] ) ) {
447 $p['trxProfiler'] = new TransactionProfiler();
449 if ( !isset( $p['errorLogger'] ) ) {
450 $p['errorLogger'] = function ( Exception
$e ) {
451 trigger_error( get_class( $e ) . ': ' . $e->getMessage(), E_USER_WARNING
);
454 if ( !isset( $p['deprecationLogger'] ) ) {
455 $p['deprecationLogger'] = function ( $msg ) {
456 trigger_error( $msg, E_USER_DEPRECATED
);
460 /** @var Database $conn */
461 $conn = new $class( $p );
462 if ( $connect == self
::NEW_CONNECTED
) {
463 $conn->initConnection();
473 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
474 * @param string|null $driver Optional name of a specific DB client driver
475 * @return array Map of (Database::ATTRIBUTE_* constant => value) for all such constants
476 * @throws InvalidArgumentException
479 final public static function attributesFromType( $dbType, $driver = null ) {
480 static $defaults = [ self
::ATTR_DB_LEVEL_LOCKING
=> false ];
482 $class = self
::getClass( $dbType, $driver );
484 return call_user_func( [ $class, 'getAttributes' ] ) +
$defaults;
488 * @param string $dbType A possible DB type (sqlite, mysql, postgres,...)
489 * @param string|null $driver Optional name of a specific DB client driver
490 * @return string Database subclass name to use
491 * @throws InvalidArgumentException
493 private static function getClass( $dbType, $driver = null ) {
494 // For database types with built-in support, the below maps type to IDatabase
495 // implementations. For types with multipe driver implementations (PHP extensions),
496 // an array can be used, keyed by extension name. In case of an array, the
497 // optional 'driver' parameter can be used to force a specific driver. Otherwise,
498 // we auto-detect the first available driver. For types without built-in support,
499 // an class named "Database<Type>" us used, eg. DatabaseFoo for type 'foo'.
500 static $builtinTypes = [
501 'mssql' => DatabaseMssql
::class,
502 'mysql' => [ 'mysqli' => DatabaseMysqli
::class ],
503 'sqlite' => DatabaseSqlite
::class,
504 'postgres' => DatabasePostgres
::class,
507 $dbType = strtolower( $dbType );
510 if ( isset( $builtinTypes[$dbType] ) ) {
511 $possibleDrivers = $builtinTypes[$dbType];
512 if ( is_string( $possibleDrivers ) ) {
513 $class = $possibleDrivers;
515 if ( (string)$driver !== '' ) {
516 if ( !isset( $possibleDrivers[$driver] ) ) {
517 throw new InvalidArgumentException( __METHOD__
.
518 " type '$dbType' does not support driver '{$driver}'" );
520 $class = $possibleDrivers[$driver];
523 foreach ( $possibleDrivers as $posDriver => $possibleClass ) {
524 if ( extension_loaded( $posDriver ) ) {
525 $class = $possibleClass;
532 $class = 'Database' . ucfirst( $dbType );
535 if ( $class === false ) {
536 throw new InvalidArgumentException( __METHOD__
.
537 " no viable database extension found for type '$dbType'" );
544 * @return array Map of (Database::ATTRIBUTE_* constant => value
547 protected static function getAttributes() {
552 * Set the PSR-3 logger interface to use for query logging. (The logger
553 * interfaces for connection logging and error logging can be set with the
556 * @param LoggerInterface $logger
558 public function setLogger( LoggerInterface
$logger ) {
559 $this->queryLogger
= $logger;
562 public function getServerInfo() {
563 return $this->getServerVersion();
566 public function bufferResults( $buffer = null ) {
567 $res = !$this->getFlag( self
::DBO_NOBUFFER
);
568 if ( $buffer !== null ) {
570 ?
$this->clearFlag( self
::DBO_NOBUFFER
)
571 : $this->setFlag( self
::DBO_NOBUFFER
);
577 public function trxLevel() {
578 return $this->trxLevel
;
581 public function trxTimestamp() {
582 return $this->trxLevel ?
$this->trxTimestamp
: null;
586 * @return int One of the STATUS_TRX_* class constants
589 public function trxStatus() {
590 return $this->trxStatus
;
593 public function tablePrefix( $prefix = null ) {
594 $old = $this->tablePrefix
;
595 if ( $prefix !== null ) {
596 $this->tablePrefix
= $prefix;
597 $this->currentDomain
= ( $this->dbName
!= '' )
598 ?
new DatabaseDomain( $this->dbName
, null, $this->tablePrefix
)
599 : DatabaseDomain
::newUnspecified();
605 public function dbSchema( $schema = null ) {
606 $old = $this->schema
;
607 if ( $schema !== null ) {
608 $this->schema
= $schema;
614 public function getLBInfo( $name = null ) {
615 if ( is_null( $name ) ) {
616 return $this->lbInfo
;
618 if ( array_key_exists( $name, $this->lbInfo
) ) {
619 return $this->lbInfo
[$name];
626 public function setLBInfo( $name, $value = null ) {
627 if ( is_null( $value ) ) {
628 $this->lbInfo
= $name;
630 $this->lbInfo
[$name] = $value;
634 public function setLazyMasterHandle( IDatabase
$conn ) {
635 $this->lazyMasterHandle
= $conn;
639 * @return IDatabase|null
640 * @see setLazyMasterHandle()
643 protected function getLazyMasterHandle() {
644 return $this->lazyMasterHandle
;
647 public function implicitGroupby() {
651 public function implicitOrderby() {
655 public function lastQuery() {
656 return $this->lastQuery
;
659 public function doneWrites() {
660 return (bool)$this->lastWriteTime
;
663 public function lastDoneWrites() {
664 return $this->lastWriteTime ?
: false;
667 public function writesPending() {
668 return $this->trxLevel
&& $this->trxDoneWrites
;
671 public function writesOrCallbacksPending() {
672 return $this->trxLevel
&& (
673 $this->trxDoneWrites ||
674 $this->trxIdleCallbacks ||
675 $this->trxPreCommitCallbacks ||
676 $this->trxEndCallbacks
680 public function preCommitCallbacksPending() {
681 return $this->trxLevel
&& $this->trxPreCommitCallbacks
;
685 * @return string|null
687 final protected function getTransactionRoundId() {
688 // If transaction round participation is enabled, see if one is active
689 if ( $this->getFlag( self
::DBO_TRX
) ) {
690 $id = $this->getLBInfo( 'trxRoundId' );
692 return is_string( $id ) ?
$id : null;
698 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
) {
699 if ( !$this->trxLevel
) {
701 } elseif ( !$this->trxDoneWrites
) {
706 case self
::ESTIMATE_DB_APPLY
:
708 $rttAdjTotal = $this->trxWriteAdjQueryCount
* $rtt;
709 $applyTime = max( $this->trxWriteAdjDuration
- $rttAdjTotal, 0 );
710 // For omitted queries, make them count as something at least
711 $omitted = $this->trxWriteQueryCount
- $this->trxWriteAdjQueryCount
;
712 $applyTime +
= self
::TINY_WRITE_SEC
* $omitted;
715 default: // everything
716 return $this->trxWriteDuration
;
720 public function pendingWriteCallers() {
721 return $this->trxLevel ?
$this->trxWriteCallers
: [];
724 public function pendingWriteRowsAffected() {
725 return $this->trxWriteAffectedRows
;
729 * List the methods that have write queries or callbacks for the current transaction
731 * This method should not be used outside of Database/LoadBalancer
736 public function pendingWriteAndCallbackCallers() {
737 $fnames = $this->pendingWriteCallers();
739 $this->trxIdleCallbacks
,
740 $this->trxPreCommitCallbacks
,
741 $this->trxEndCallbacks
743 foreach ( $callbacks as $callback ) {
744 $fnames[] = $callback[1];
754 private function flatAtomicSectionList() {
755 return array_reduce( $this->trxAtomicLevels
, function ( $accum, $v ) {
756 return $accum === null ?
$v[0] : "$accum, " . $v[0];
760 public function isOpen() {
761 return $this->opened
;
764 public function setFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
765 if ( ( $flag & self
::DBO_IGNORE
) ) {
766 throw new UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
769 if ( $remember === self
::REMEMBER_PRIOR
) {
770 array_push( $this->priorFlags
, $this->flags
);
772 $this->flags |
= $flag;
775 public function clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
776 if ( ( $flag & self
::DBO_IGNORE
) ) {
777 throw new UnexpectedValueException( "Modifying DBO_IGNORE is not allowed." );
780 if ( $remember === self
::REMEMBER_PRIOR
) {
781 array_push( $this->priorFlags
, $this->flags
);
783 $this->flags
&= ~
$flag;
786 public function restoreFlags( $state = self
::RESTORE_PRIOR
) {
787 if ( !$this->priorFlags
) {
791 if ( $state === self
::RESTORE_INITIAL
) {
792 $this->flags
= reset( $this->priorFlags
);
793 $this->priorFlags
= [];
795 $this->flags
= array_pop( $this->priorFlags
);
799 public function getFlag( $flag ) {
800 return !!( $this->flags
& $flag );
804 * @param string $name Class field name
806 * @deprecated Since 1.28
808 public function getProperty( $name ) {
812 public function getDomainID() {
813 return $this->currentDomain
->getId();
816 final public function getWikiID() {
817 return $this->getDomainID();
821 * Get information about an index into an object
822 * @param string $table Table name
823 * @param string $index Index name
824 * @param string $fname Calling function name
825 * @return mixed Database-specific index description class or false if the index does not exist
827 abstract function indexInfo( $table, $index, $fname = __METHOD__
);
830 * Wrapper for addslashes()
832 * @param string $s String to be slashed.
833 * @return string Slashed string.
835 abstract function strencode( $s );
838 * Set a custom error handler for logging errors during database connection
840 protected function installErrorHandler() {
841 $this->phpError
= false;
842 $this->htmlErrors
= ini_set( 'html_errors', '0' );
843 set_error_handler( [ $this, 'connectionErrorLogger' ] );
847 * Restore the previous error handler and return the last PHP error for this DB
849 * @return bool|string
851 protected function restoreErrorHandler() {
852 restore_error_handler();
853 if ( $this->htmlErrors
!== false ) {
854 ini_set( 'html_errors', $this->htmlErrors
);
857 return $this->getLastPHPError();
861 * @return string|bool Last PHP error for this DB (typically connection errors)
863 protected function getLastPHPError() {
864 if ( $this->phpError
) {
865 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->phpError
);
866 $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
875 * Error handler for logging errors during database connection
876 * This method should not be used outside of Database classes
879 * @param string $errstr
881 public function connectionErrorLogger( $errno, $errstr ) {
882 $this->phpError
= $errstr;
886 * Create a log context to pass to PSR-3 logger functions.
888 * @param array $extras Additional data to add to context
891 protected function getLogContext( array $extras = [] ) {
894 'db_server' => $this->server
,
895 'db_name' => $this->dbName
,
896 'db_user' => $this->user
,
902 final public function close() {
903 $exception = null; // error to throw after disconnecting
906 // Resolve any dangling transaction first
907 if ( $this->trxLevel
) {
908 if ( $this->trxAtomicLevels
) {
909 // Cannot let incomplete atomic sections be committed
910 $levels = $this->flatAtomicSectionList();
911 $exception = new DBUnexpectedError(
913 __METHOD__
. ": atomic sections $levels are still open."
915 } elseif ( $this->trxAutomatic
) {
916 // Only the connection manager can commit non-empty DBO_TRX transactions
917 if ( $this->writesOrCallbacksPending() ) {
918 $exception = new DBUnexpectedError(
921 ": mass commit/rollback of peer transaction required (DBO_TRX set)."
924 } elseif ( $this->trxLevel
) {
925 // Commit explicit transactions as if this was commit()
926 $this->queryLogger
->warning(
927 __METHOD__
. ": writes or callbacks still pending.",
928 [ 'trace' => ( new RuntimeException() )->getTraceAsString() ]
932 if ( $this->trxEndCallbacksSuppressed
) {
933 $exception = $exception ?
: new DBUnexpectedError(
935 __METHOD__
. ': callbacks are suppressed; cannot properly commit.'
939 // Commit or rollback the changes and run any callbacks as needed
940 if ( $this->trxStatus
=== self
::STATUS_TRX_OK
&& !$exception ) {
943 $this->trxAutomatic ? self
::FLUSHING_INTERNAL
: self
::FLUSHING_ONE
946 $this->rollback( __METHOD__
, self
::FLUSHING_INTERNAL
);
950 // Close the actual connection in the binding handle
951 $closed = $this->closeConnection();
954 $closed = true; // already closed; nothing to do
957 $this->opened
= false;
959 // Throw any unexpected errors after having disconnected
960 if ( $exception instanceof Exception
) {
964 // Sanity check that no callbacks are dangling
965 $fnames = $this->pendingWriteAndCallbackCallers();
967 throw new RuntimeException(
968 "Transaction callbacks are still pending:\n" . implode( ', ', $fnames )
976 * Make sure isOpen() returns true as a sanity check
978 * @throws DBUnexpectedError
980 protected function assertOpen() {
981 if ( !$this->isOpen() ) {
982 throw new DBUnexpectedError( $this, "DB connection was already closed." );
987 * Closes underlying database connection
989 * @return bool Whether connection was closed successfully
991 abstract protected function closeConnection();
994 * @deprecated since 1.32
995 * @param string $error Fallback message, if none is given by DB
996 * @throws DBConnectionError
998 public function reportConnectionError( $error = 'Unknown error' ) {
999 call_user_func( $this->deprecationLogger
, 'Use of ' . __METHOD__
. ' is deprecated.' );
1000 throw new DBConnectionError( $this, $this->lastError() ?
: $error );
1004 * Run a query and return a DBMS-dependent wrapper (that has all IResultWrapper methods)
1006 * This might return things, such as mysqli_result, that do not formally implement
1007 * IResultWrapper, but nonetheless implement all of its methods correctly
1009 * @param string $sql SQL query.
1010 * @return IResultWrapper|bool Iterator to feed to fetchObject/fetchRow; false on failure
1012 abstract protected function doQuery( $sql );
1015 * Determine whether a query writes to the DB.
1016 * Should return true if unsure.
1018 * @param string $sql
1021 protected function isWriteQuery( $sql ) {
1023 '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SET|SHOW|EXPLAIN|\(SELECT)\b/i', $sql );
1027 * @param string $sql
1028 * @return string|null
1030 protected function getQueryVerb( $sql ) {
1031 return preg_match( '/^\s*([a-z]+)/i', $sql, $m ) ?
strtoupper( $m[1] ) : null;
1035 * Determine whether a SQL statement is sensitive to isolation level.
1036 * A SQL statement is considered transactable if its result could vary
1037 * depending on the transaction isolation level. Operational commands
1038 * such as 'SET' and 'SHOW' are not considered to be transactable.
1040 * @param string $sql
1043 protected function isTransactableQuery( $sql ) {
1045 $this->getQueryVerb( $sql ),
1046 [ 'BEGIN', 'COMMIT', 'ROLLBACK', 'SHOW', 'SET', 'CREATE', 'ALTER' ],
1052 * @param string $sql A SQL query
1053 * @return bool Whether $sql is SQL for TEMPORARY table operation
1055 protected function registerTempTableOperation( $sql ) {
1057 '/^CREATE\s+TEMPORARY\s+TABLE\s+(?:IF\s+NOT\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
1061 $this->sessionTempTables
[$matches[1]] = 1;
1064 } elseif ( preg_match(
1065 '/^DROP\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
1069 $isTemp = isset( $this->sessionTempTables
[$matches[1]] );
1070 unset( $this->sessionTempTables
[$matches[1]] );
1073 } elseif ( preg_match(
1074 '/^TRUNCATE\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
1078 return isset( $this->sessionTempTables
[$matches[1]] );
1079 } elseif ( preg_match(
1080 '/^(?:INSERT\s+(?:\w+\s+)?INTO|UPDATE|DELETE\s+FROM)\s+[`"\']?(\w+)[`"\']?/i',
1084 return isset( $this->sessionTempTables
[$matches[1]] );
1090 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false ) {
1091 $this->assertTransactionStatus( $sql, $fname );
1093 # Avoid fatals if close() was called
1094 $this->assertOpen();
1096 $priorWritesPending = $this->writesOrCallbacksPending();
1097 $this->lastQuery
= $sql;
1099 $isWrite = $this->isWriteQuery( $sql );
1101 $isNonTempWrite = !$this->registerTempTableOperation( $sql );
1103 $isNonTempWrite = false;
1107 if ( $this->getLBInfo( 'replica' ) === true ) {
1110 'Write operations are not allowed on replica database connections.'
1113 # In theory, non-persistent writes are allowed in read-only mode, but due to things
1114 # like https://bugs.mysql.com/bug.php?id=33669 that might not work anyway...
1115 $reason = $this->getReadOnlyReason();
1116 if ( $reason !== false ) {
1117 throw new DBReadOnlyError( $this, "Database is read-only: $reason" );
1119 # Set a flag indicating that writes have been done
1120 $this->lastWriteTime
= microtime( true );
1123 # Add trace comment to the begin of the sql string, right after the operator.
1124 # Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (T44598)
1125 $commentedSql = preg_replace( '/\s|$/', " /* $fname {$this->agent} */ ", $sql, 1 );
1127 # Start implicit transactions that wrap the request if DBO_TRX is enabled
1128 if ( !$this->trxLevel
&& $this->getFlag( self
::DBO_TRX
)
1129 && $this->isTransactableQuery( $sql )
1131 $this->begin( __METHOD__
. " ($fname)", self
::TRANSACTION_INTERNAL
);
1132 $this->trxAutomatic
= true;
1135 # Keep track of whether the transaction has write queries pending
1136 if ( $this->trxLevel
&& !$this->trxDoneWrites
&& $isWrite ) {
1137 $this->trxDoneWrites
= true;
1138 $this->trxProfiler
->transactionWritingIn(
1139 $this->server
, $this->dbName
, $this->trxShortId
);
1142 if ( $this->getFlag( self
::DBO_DEBUG
) ) {
1143 $this->queryLogger
->debug( "{$this->dbName} {$commentedSql}" );
1146 # Send the query to the server and fetch any corresponding errors
1147 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isNonTempWrite, $fname );
1148 $lastError = $this->lastError();
1149 $lastErrno = $this->lastErrno();
1151 # Try reconnecting if the connection was lost
1152 if ( $ret === false && $this->wasConnectionLoss() ) {
1153 # Check if any meaningful session state was lost
1154 $recoverable = $this->canRecoverFromDisconnect( $sql, $priorWritesPending );
1155 # Update session state tracking and try to restore the connection
1156 $reconnected = $this->replaceLostConnection( __METHOD__
);
1157 # Silently resend the query to the server if it is safe and possible
1158 if ( $reconnected && $recoverable ) {
1159 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isNonTempWrite, $fname );
1160 $lastError = $this->lastError();
1161 $lastErrno = $this->lastErrno();
1163 if ( $ret === false && $this->wasConnectionLoss() ) {
1164 # Query probably causes disconnects; reconnect and do not re-run it
1165 $this->replaceLostConnection( __METHOD__
);
1170 if ( $ret === false ) {
1171 if ( $this->trxLevel
) {
1172 if ( !$this->wasKnownStatementRollbackError() ) {
1173 # Either the query was aborted or all queries after BEGIN where aborted.
1174 if ( $this->explicitTrxActive() ||
$priorWritesPending ) {
1175 # In the first case, the only options going forward are (a) ROLLBACK, or
1176 # (b) ROLLBACK TO SAVEPOINT (if one was set). If the later case, the only
1177 # option is ROLLBACK, since the snapshots would have been released.
1178 $this->trxStatus
= self
::STATUS_TRX_ERROR
;
1179 $this->trxStatusCause
=
1180 $this->makeQueryException( $lastError, $lastErrno, $sql, $fname );
1181 $tempIgnore = false; // cannot recover
1183 # Nothing prior was there to lose from the transaction,
1184 # so just roll it back.
1185 $this->rollback( __METHOD__
. " ($fname)", self
::FLUSHING_INTERNAL
);
1187 $this->trxStatusIgnoredCause
= null;
1189 # We're ignoring an error that caused just the current query to be aborted.
1190 # But log the cause so we can log a deprecation notice if a
1191 # caller actually does ignore it.
1192 $this->trxStatusIgnoredCause
= [ $lastError, $lastErrno, $fname ];
1196 $this->reportQueryError( $lastError, $lastErrno, $sql, $fname, $tempIgnore );
1199 return $this->resultObject( $ret );
1203 * Wrapper for query() that also handles profiling, logging, and affected row count updates
1205 * @param string $sql Original SQL query
1206 * @param string $commentedSql SQL query with debugging/trace comment
1207 * @param bool $isWrite Whether the query is a (non-temporary) write operation
1208 * @param string $fname Name of the calling function
1209 * @return bool|ResultWrapper True for a successful write query, ResultWrapper
1210 * object for a successful read query, or false on failure
1212 private function doProfiledQuery( $sql, $commentedSql, $isWrite, $fname ) {
1213 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
1214 # generalizeSQL() will probably cut down the query to reasonable
1215 # logging size most of the time. The substr is really just a sanity check.
1217 $queryProf = 'query-m: ' . substr( self
::generalizeSQL( $sql ), 0, 255 );
1219 $queryProf = 'query: ' . substr( self
::generalizeSQL( $sql ), 0, 255 );
1222 # Include query transaction state
1223 $queryProf .= $this->trxShortId ?
" [TRX#{$this->trxShortId}]" : "";
1225 $startTime = microtime( true );
1226 if ( $this->profiler
) {
1227 call_user_func( [ $this->profiler
, 'profileIn' ], $queryProf );
1229 $this->affectedRowCount
= null;
1230 $ret = $this->doQuery( $commentedSql );
1231 $this->affectedRowCount
= $this->affectedRows();
1232 if ( $this->profiler
) {
1233 call_user_func( [ $this->profiler
, 'profileOut' ], $queryProf );
1235 $queryRuntime = max( microtime( true ) - $startTime, 0.0 );
1237 unset( $queryProfSection ); // profile out (if set)
1239 if ( $ret !== false ) {
1240 $this->lastPing
= $startTime;
1241 if ( $isWrite && $this->trxLevel
) {
1242 $this->updateTrxWriteQueryTime( $sql, $queryRuntime, $this->affectedRows() );
1243 $this->trxWriteCallers
[] = $fname;
1247 if ( $sql === self
::PING_QUERY
) {
1248 $this->rttEstimate
= $queryRuntime;
1251 $this->trxProfiler
->recordQueryCompletion(
1252 $queryProf, $startTime, $isWrite, $this->affectedRows()
1254 $this->queryLogger
->debug( $sql, [
1256 'master' => $isMaster,
1257 'runtime' => $queryRuntime,
1264 * Update the estimated run-time of a query, not counting large row lock times
1266 * LoadBalancer can be set to rollback transactions that will create huge replication
1267 * lag. It bases this estimate off of pendingWriteQueryDuration(). Certain simple
1268 * queries, like inserting a row can take a long time due to row locking. This method
1269 * uses some simple heuristics to discount those cases.
1271 * @param string $sql A SQL write query
1272 * @param float $runtime Total runtime, including RTT
1273 * @param int $affected Affected row count
1275 private function updateTrxWriteQueryTime( $sql, $runtime, $affected ) {
1276 // Whether this is indicative of replica DB runtime (except for RBR or ws_repl)
1277 $indicativeOfReplicaRuntime = true;
1278 if ( $runtime > self
::SLOW_WRITE_SEC
) {
1279 $verb = $this->getQueryVerb( $sql );
1280 // insert(), upsert(), replace() are fast unless bulky in size or blocked on locks
1281 if ( $verb === 'INSERT' ) {
1282 $indicativeOfReplicaRuntime = $this->affectedRows() > self
::SMALL_WRITE_ROWS
;
1283 } elseif ( $verb === 'REPLACE' ) {
1284 $indicativeOfReplicaRuntime = $this->affectedRows() > self
::SMALL_WRITE_ROWS
/ 2;
1288 $this->trxWriteDuration +
= $runtime;
1289 $this->trxWriteQueryCount +
= 1;
1290 $this->trxWriteAffectedRows +
= $affected;
1291 if ( $indicativeOfReplicaRuntime ) {
1292 $this->trxWriteAdjDuration +
= $runtime;
1293 $this->trxWriteAdjQueryCount +
= 1;
1298 * @param string $sql
1299 * @param string $fname
1300 * @throws DBTransactionStateError
1302 private function assertTransactionStatus( $sql, $fname ) {
1303 if ( $this->getQueryVerb( $sql ) === 'ROLLBACK' ) { // transaction/savepoint
1307 if ( $this->trxStatus
< self
::STATUS_TRX_OK
) {
1308 throw new DBTransactionStateError(
1310 "Cannot execute query from $fname while transaction status is ERROR.",
1312 $this->trxStatusCause
1314 } elseif ( $this->trxStatus
=== self
::STATUS_TRX_OK
&& $this->trxStatusIgnoredCause
) {
1315 list( $iLastError, $iLastErrno, $iFname ) = $this->trxStatusIgnoredCause
;
1316 call_user_func( $this->deprecationLogger
,
1317 "Caller from $fname ignored an error originally raised from $iFname: " .
1318 "[$iLastErrno] $iLastError"
1320 $this->trxStatusIgnoredCause
= null;
1325 * Determine whether or not it is safe to retry queries after a database
1326 * connection is lost
1328 * @param string $sql SQL query
1329 * @param bool $priorWritesPending Whether there is a transaction open with
1330 * possible write queries or transaction pre-commit/idle callbacks
1331 * waiting on it to finish.
1332 * @return bool True if it is safe to retry the query, false otherwise
1334 private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
1335 # Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
1336 # Dropped connections also mean that named locks are automatically released.
1337 # Only allow error suppression in autocommit mode or when the lost transaction
1338 # didn't matter anyway (aside from DBO_TRX snapshot loss).
1339 if ( $this->namedLocksHeld
) {
1340 return false; // possible critical section violation
1341 } elseif ( $this->sessionTempTables
) {
1342 return false; // tables might be queried latter
1343 } elseif ( $sql === 'COMMIT' ) {
1344 return !$priorWritesPending; // nothing written anyway? (T127428)
1345 } elseif ( $sql === 'ROLLBACK' ) {
1346 return true; // transaction lost...which is also what was requested :)
1347 } elseif ( $this->explicitTrxActive() ) {
1348 return false; // don't drop atomocity and explicit snapshots
1349 } elseif ( $priorWritesPending ) {
1350 return false; // prior writes lost from implicit transaction
1357 * Clean things up after session (and thus transaction) loss
1359 private function handleSessionLoss() {
1360 // Clean up tracking of session-level things...
1361 // https://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html
1362 // https://www.postgresql.org/docs/9.2/static/sql-createtable.html (ignoring ON COMMIT)
1363 $this->sessionTempTables
= [];
1364 // https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
1365 // https://www.postgresql.org/docs/9.4/static/functions-admin.html#FUNCTIONS-ADVISORY-LOCKS
1366 $this->namedLocksHeld
= [];
1367 // Session loss implies transaction loss
1368 $this->handleTransactionLoss();
1372 * Clean things up after transaction loss
1374 private function handleTransactionLoss() {
1375 $this->trxLevel
= 0;
1376 $this->trxAtomicCounter
= 0;
1377 $this->trxIdleCallbacks
= []; // T67263; transaction already lost
1378 $this->trxPreCommitCallbacks
= []; // T67263; transaction already lost
1380 // Handle callbacks in trxEndCallbacks, e.g. onTransactionResolution().
1381 // If callback suppression is set then the array will remain unhandled.
1382 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_ROLLBACK
);
1383 } catch ( Exception
$ex ) {
1384 // Already logged; move on...
1387 // Handle callbacks in trxRecurringCallbacks, e.g. setTransactionListener()
1388 $this->runTransactionListenerCallbacks( self
::TRIGGER_ROLLBACK
);
1389 } catch ( Exception
$ex ) {
1390 // Already logged; move on...
1395 * Checks whether the cause of the error is detected to be a timeout.
1397 * It returns false by default, and not all engines support detecting this yet.
1398 * If this returns false, it will be treated as a generic query error.
1400 * @param string $error Error text
1401 * @param int $errno Error number
1404 protected function wasQueryTimeout( $error, $errno ) {
1409 * Report a query error. Log the error, and if neither the object ignore
1410 * flag nor the $tempIgnore flag is set, throw a DBQueryError.
1412 * @param string $error
1414 * @param string $sql
1415 * @param string $fname
1416 * @param bool $tempIgnore
1417 * @throws DBQueryError
1419 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1420 if ( $tempIgnore ) {
1421 $this->queryLogger
->debug( "SQL ERROR (ignored): $error\n" );
1423 $exception = $this->makeQueryException( $error, $errno, $sql, $fname );
1430 * @param string $error
1431 * @param string|int $errno
1432 * @param string $sql
1433 * @param string $fname
1436 private function makeQueryException( $error, $errno, $sql, $fname ) {
1437 $sql1line = mb_substr( str_replace( "\n", "\\n", $sql ), 0, 5 * 1024 );
1438 $this->queryLogger
->error(
1439 "{fname}\t{db_server}\t{errno}\t{error}\t{sql1line}",
1440 $this->getLogContext( [
1441 'method' => __METHOD__
,
1444 'sql1line' => $sql1line,
1448 $this->queryLogger
->debug( "SQL ERROR: " . $error . "\n" );
1449 $wasQueryTimeout = $this->wasQueryTimeout( $error, $errno );
1450 if ( $wasQueryTimeout ) {
1451 $e = new DBQueryTimeoutError( $this, $error, $errno, $sql, $fname );
1453 $e = new DBQueryError( $this, $error, $errno, $sql, $fname );
1459 public function freeResult( $res ) {
1462 public function selectField(
1463 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
1465 if ( $var === '*' ) { // sanity
1466 throw new DBUnexpectedError( $this, "Cannot use a * field: got '$var'" );
1469 if ( !is_array( $options ) ) {
1470 $options = [ $options ];
1473 $options['LIMIT'] = 1;
1475 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1476 if ( $res === false ||
!$this->numRows( $res ) ) {
1480 $row = $this->fetchRow( $res );
1482 if ( $row !== false ) {
1483 return reset( $row );
1489 public function selectFieldValues(
1490 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
1492 if ( $var === '*' ) { // sanity
1493 throw new DBUnexpectedError( $this, "Cannot use a * field" );
1494 } elseif ( !is_string( $var ) ) { // sanity
1495 throw new DBUnexpectedError( $this, "Cannot use an array of fields" );
1498 if ( !is_array( $options ) ) {
1499 $options = [ $options ];
1502 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1503 if ( $res === false ) {
1508 foreach ( $res as $row ) {
1509 $values[] = $row->$var;
1516 * Returns an optional USE INDEX clause to go after the table, and a
1517 * string to go at the end of the query.
1519 * @param array $options Associative array of options to be turned into
1520 * an SQL query, valid keys are listed in the function.
1522 * @see Database::select()
1524 protected function makeSelectOptions( $options ) {
1525 $preLimitTail = $postLimitTail = '';
1530 foreach ( $options as $key => $option ) {
1531 if ( is_numeric( $key ) ) {
1532 $noKeyOptions[$option] = true;
1536 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1538 $preLimitTail .= $this->makeOrderBy( $options );
1540 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1541 $postLimitTail .= ' FOR UPDATE';
1544 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1545 $postLimitTail .= ' LOCK IN SHARE MODE';
1548 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) {
1549 $startOpts .= 'DISTINCT';
1552 # Various MySQL extensions
1553 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1554 $startOpts .= ' /*! STRAIGHT_JOIN */';
1557 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1558 $startOpts .= ' HIGH_PRIORITY';
1561 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1562 $startOpts .= ' SQL_BIG_RESULT';
1565 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1566 $startOpts .= ' SQL_BUFFER_RESULT';
1569 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1570 $startOpts .= ' SQL_SMALL_RESULT';
1573 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1574 $startOpts .= ' SQL_CALC_FOUND_ROWS';
1577 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1578 $startOpts .= ' SQL_CACHE';
1581 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1582 $startOpts .= ' SQL_NO_CACHE';
1585 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1586 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1590 if ( isset( $options['IGNORE INDEX'] ) && is_string( $options['IGNORE INDEX'] ) ) {
1591 $ignoreIndex = $this->ignoreIndexClause( $options['IGNORE INDEX'] );
1596 return [ $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ];
1600 * Returns an optional GROUP BY with an optional HAVING
1602 * @param array $options Associative array of options
1604 * @see Database::select()
1607 protected function makeGroupByWithHaving( $options ) {
1609 if ( isset( $options['GROUP BY'] ) ) {
1610 $gb = is_array( $options['GROUP BY'] )
1611 ?
implode( ',', $options['GROUP BY'] )
1612 : $options['GROUP BY'];
1613 $sql .= ' GROUP BY ' . $gb;
1615 if ( isset( $options['HAVING'] ) ) {
1616 $having = is_array( $options['HAVING'] )
1617 ?
$this->makeList( $options['HAVING'], self
::LIST_AND
)
1618 : $options['HAVING'];
1619 $sql .= ' HAVING ' . $having;
1626 * Returns an optional ORDER BY
1628 * @param array $options Associative array of options
1630 * @see Database::select()
1633 protected function makeOrderBy( $options ) {
1634 if ( isset( $options['ORDER BY'] ) ) {
1635 $ob = is_array( $options['ORDER BY'] )
1636 ?
implode( ',', $options['ORDER BY'] )
1637 : $options['ORDER BY'];
1639 return ' ORDER BY ' . $ob;
1645 public function select(
1646 $table, $vars, $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1648 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1650 return $this->query( $sql, $fname );
1653 public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__
,
1654 $options = [], $join_conds = []
1656 if ( is_array( $vars ) ) {
1657 $fields = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1662 $options = (array)$options;
1663 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1664 ?
$options['USE INDEX']
1667 isset( $options['IGNORE INDEX'] ) &&
1668 is_array( $options['IGNORE INDEX'] )
1670 ?
$options['IGNORE INDEX']
1674 $this->selectOptionsIncludeLocking( $options ) &&
1675 $this->selectFieldsOrOptionsAggregate( $vars, $options )
1677 // Some DB types (postgres/oracle) disallow FOR UPDATE with aggregate
1678 // functions. Discourage use of such queries to encourage compatibility.
1680 $this->deprecationLogger
,
1681 __METHOD__
. ": aggregation used with a locking SELECT ($fname)."
1685 if ( is_array( $table ) ) {
1687 $this->tableNamesWithIndexClauseOrJOIN(
1688 $table, $useIndexes, $ignoreIndexes, $join_conds );
1689 } elseif ( $table != '' ) {
1691 $this->tableNamesWithIndexClauseOrJOIN(
1692 [ $table ], $useIndexes, $ignoreIndexes, [] );
1697 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ) =
1698 $this->makeSelectOptions( $options );
1700 if ( is_array( $conds ) ) {
1701 $conds = $this->makeList( $conds, self
::LIST_AND
);
1704 if ( $conds === null ||
$conds === false ) {
1705 $this->queryLogger
->warning(
1709 . ' with incorrect parameters: $conds must be a string or an array'
1714 if ( $conds === '' ) {
1715 $sql = "SELECT $startOpts $fields $from $useIndex $ignoreIndex $preLimitTail";
1716 } elseif ( is_string( $conds ) ) {
1717 $sql = "SELECT $startOpts $fields $from $useIndex $ignoreIndex " .
1718 "WHERE $conds $preLimitTail";
1720 throw new DBUnexpectedError( $this, __METHOD__
. ' called with incorrect parameters' );
1723 if ( isset( $options['LIMIT'] ) ) {
1724 $sql = $this->limitResult( $sql, $options['LIMIT'],
1725 isset( $options['OFFSET'] ) ?
$options['OFFSET'] : false );
1727 $sql = "$sql $postLimitTail";
1729 if ( isset( $options['EXPLAIN'] ) ) {
1730 $sql = 'EXPLAIN ' . $sql;
1736 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
1737 $options = [], $join_conds = []
1739 $options = (array)$options;
1740 $options['LIMIT'] = 1;
1741 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1743 if ( $res === false ) {
1747 if ( !$this->numRows( $res ) ) {
1751 $obj = $this->fetchObject( $res );
1756 public function estimateRowCount(
1757 $table, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1759 $conds = $this->normalizeConditions( $conds, $fname );
1760 $column = $this->extractSingleFieldFromList( $var );
1761 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
1762 $conds[] = "$column IS NOT NULL";
1765 $res = $this->select(
1766 $table, [ 'rowcount' => 'COUNT(*)' ], $conds, $fname, $options, $join_conds
1768 $row = $res ?
$this->fetchRow( $res ) : [];
1770 return isset( $row['rowcount'] ) ?
(int)$row['rowcount'] : 0;
1773 public function selectRowCount(
1774 $tables, $var = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1776 $conds = $this->normalizeConditions( $conds, $fname );
1777 $column = $this->extractSingleFieldFromList( $var );
1778 if ( is_string( $column ) && !in_array( $column, [ '*', '1' ] ) ) {
1779 $conds[] = "$column IS NOT NULL";
1782 $res = $this->select(
1784 'tmp_count' => $this->buildSelectSubquery(
1793 [ 'rowcount' => 'COUNT(*)' ],
1797 $row = $res ?
$this->fetchRow( $res ) : [];
1799 return isset( $row['rowcount'] ) ?
(int)$row['rowcount'] : 0;
1803 * @param string|array $options
1806 private function selectOptionsIncludeLocking( $options ) {
1807 $options = (array)$options;
1808 foreach ( [ 'FOR UPDATE', 'LOCK IN SHARE MODE' ] as $lock ) {
1809 if ( in_array( $lock, $options, true ) ) {
1818 * @param array|string $fields
1819 * @param array|string $options
1822 private function selectFieldsOrOptionsAggregate( $fields, $options ) {
1823 foreach ( (array)$options as $key => $value ) {
1824 if ( is_string( $key ) ) {
1825 if ( preg_match( '/^(?:GROUP BY|HAVING)$/i', $key ) ) {
1828 } elseif ( is_string( $value ) ) {
1829 if ( preg_match( '/^(?:DISTINCT|DISTINCTROW)$/i', $value ) ) {
1835 $regex = '/^(?:COUNT|MIN|MAX|SUM|GROUP_CONCAT|LISTAGG|ARRAY_AGG)\s*\\(/i';
1836 foreach ( (array)$fields as $field ) {
1837 if ( is_string( $field ) && preg_match( $regex, $field ) ) {
1846 * @param array|string $conds
1847 * @param string $fname
1850 final protected function normalizeConditions( $conds, $fname ) {
1851 if ( $conds === null ||
$conds === false ) {
1852 $this->queryLogger
->warning(
1856 . ' with incorrect parameters: $conds must be a string or an array'
1861 if ( !is_array( $conds ) ) {
1862 $conds = ( $conds === '' ) ?
[] : [ $conds ];
1869 * @param array|string $var Field parameter in the style of select()
1870 * @return string|null Column name or null; ignores aliases
1871 * @throws DBUnexpectedError Errors out if multiple columns are given
1873 final protected function extractSingleFieldFromList( $var ) {
1874 if ( is_array( $var ) ) {
1877 } elseif ( count( $var ) == 1 ) {
1878 $column = isset( $var[0] ) ?
$var[0] : reset( $var );
1880 throw new DBUnexpectedError( $this, __METHOD__
. ': got multiple columns.' );
1890 * Removes most variables from an SQL query and replaces them with X or N for numbers.
1891 * It's only slightly flawed. Don't use for anything important.
1893 * @param string $sql A SQL Query
1897 protected static function generalizeSQL( $sql ) {
1898 # This does the same as the regexp below would do, but in such a way
1899 # as to avoid crashing php on some large strings.
1900 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
1902 $sql = str_replace( "\\\\", '', $sql );
1903 $sql = str_replace( "\\'", '', $sql );
1904 $sql = str_replace( "\\\"", '', $sql );
1905 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
1906 $sql = preg_replace( '/".*"/s', "'X'", $sql );
1908 # All newlines, tabs, etc replaced by single space
1909 $sql = preg_replace( '/\s+/', ' ', $sql );
1912 # except the ones surrounded by characters, e.g. l10n
1913 $sql = preg_replace( '/-?\d+(,-?\d+)+/s', 'N,...,N', $sql );
1914 $sql = preg_replace( '/(?<![a-zA-Z])-?\d+(?![a-zA-Z])/s', 'N', $sql );
1919 public function fieldExists( $table, $field, $fname = __METHOD__
) {
1920 $info = $this->fieldInfo( $table, $field );
1925 public function indexExists( $table, $index, $fname = __METHOD__
) {
1926 if ( !$this->tableExists( $table ) ) {
1930 $info = $this->indexInfo( $table, $index, $fname );
1931 if ( is_null( $info ) ) {
1934 return $info !== false;
1938 public function tableExists( $table, $fname = __METHOD__
) {
1939 $tableRaw = $this->tableName( $table, 'raw' );
1940 if ( isset( $this->sessionTempTables
[$tableRaw] ) ) {
1941 return true; // already known to exist
1944 $table = $this->tableName( $table );
1945 $ignoreErrors = true;
1946 $res = $this->query( "SELECT 1 FROM $table LIMIT 1", $fname, $ignoreErrors );
1951 public function indexUnique( $table, $index ) {
1952 $indexInfo = $this->indexInfo( $table, $index );
1954 if ( !$indexInfo ) {
1958 return !$indexInfo[0]->Non_unique
;
1962 * Helper for Database::insert().
1964 * @param array $options
1967 protected function makeInsertOptions( $options ) {
1968 return implode( ' ', $options );
1971 public function insert( $table, $a, $fname = __METHOD__
, $options = [] ) {
1972 # No rows to insert, easy just return now
1973 if ( !count( $a ) ) {
1977 $table = $this->tableName( $table );
1979 if ( !is_array( $options ) ) {
1980 $options = [ $options ];
1984 if ( isset( $options['fileHandle'] ) ) {
1985 $fh = $options['fileHandle'];
1987 $options = $this->makeInsertOptions( $options );
1989 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
1991 $keys = array_keys( $a[0] );
1994 $keys = array_keys( $a );
1997 $sql = 'INSERT ' . $options .
1998 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
2002 foreach ( $a as $row ) {
2008 $sql .= '(' . $this->makeList( $row ) . ')';
2011 $sql .= '(' . $this->makeList( $a ) . ')';
2014 if ( $fh !== null && false === fwrite( $fh, $sql ) ) {
2016 } elseif ( $fh !== null ) {
2020 return (bool)$this->query( $sql, $fname );
2024 * Make UPDATE options array for Database::makeUpdateOptions
2026 * @param array $options
2029 protected function makeUpdateOptionsArray( $options ) {
2030 if ( !is_array( $options ) ) {
2031 $options = [ $options ];
2036 if ( in_array( 'IGNORE', $options ) ) {
2044 * Make UPDATE options for the Database::update function
2046 * @param array $options The options passed to Database::update
2049 protected function makeUpdateOptions( $options ) {
2050 $opts = $this->makeUpdateOptionsArray( $options );
2052 return implode( ' ', $opts );
2055 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] ) {
2056 $table = $this->tableName( $table );
2057 $opts = $this->makeUpdateOptions( $options );
2058 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, self
::LIST_SET
);
2060 if ( $conds !== [] && $conds !== '*' ) {
2061 $sql .= " WHERE " . $this->makeList( $conds, self
::LIST_AND
);
2064 return (bool)$this->query( $sql, $fname );
2067 public function makeList( $a, $mode = self
::LIST_COMMA
) {
2068 if ( !is_array( $a ) ) {
2069 throw new DBUnexpectedError( $this, __METHOD__
. ' called with incorrect parameters' );
2075 foreach ( $a as $field => $value ) {
2077 if ( $mode == self
::LIST_AND
) {
2079 } elseif ( $mode == self
::LIST_OR
) {
2088 if ( ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) && is_numeric( $field ) ) {
2089 $list .= "($value)";
2090 } elseif ( $mode == self
::LIST_SET
&& is_numeric( $field ) ) {
2093 ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) && is_array( $value )
2095 // Remove null from array to be handled separately if found
2096 $includeNull = false;
2097 foreach ( array_keys( $value, null, true ) as $nullKey ) {
2098 $includeNull = true;
2099 unset( $value[$nullKey] );
2101 if ( count( $value ) == 0 && !$includeNull ) {
2102 throw new InvalidArgumentException(
2103 __METHOD__
. ": empty input for field $field" );
2104 } elseif ( count( $value ) == 0 ) {
2105 // only check if $field is null
2106 $list .= "$field IS NULL";
2108 // IN clause contains at least one valid element
2109 if ( $includeNull ) {
2110 // Group subconditions to ensure correct precedence
2113 if ( count( $value ) == 1 ) {
2114 // Special-case single values, as IN isn't terribly efficient
2115 // Don't necessarily assume the single key is 0; we don't
2116 // enforce linear numeric ordering on other arrays here.
2117 $value = array_values( $value )[0];
2118 $list .= $field . " = " . $this->addQuotes( $value );
2120 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
2122 // if null present in array, append IS NULL
2123 if ( $includeNull ) {
2124 $list .= " OR $field IS NULL)";
2127 } elseif ( $value === null ) {
2128 if ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) {
2129 $list .= "$field IS ";
2130 } elseif ( $mode == self
::LIST_SET
) {
2131 $list .= "$field = ";
2136 $mode == self
::LIST_AND ||
$mode == self
::LIST_OR ||
$mode == self
::LIST_SET
2138 $list .= "$field = ";
2140 $list .= $mode == self
::LIST_NAMES ?
$value : $this->addQuotes( $value );
2147 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
2150 foreach ( $data as $base => $sub ) {
2151 if ( count( $sub ) ) {
2152 $conds[] = $this->makeList(
2153 [ $baseKey => $base, $subKey => array_keys( $sub ) ],
2159 return $this->makeList( $conds, self
::LIST_OR
);
2161 // Nothing to search for...
2166 public function aggregateValue( $valuedata, $valuename = 'value' ) {
2170 public function bitNot( $field ) {
2174 public function bitAnd( $fieldLeft, $fieldRight ) {
2175 return "($fieldLeft & $fieldRight)";
2178 public function bitOr( $fieldLeft, $fieldRight ) {
2179 return "($fieldLeft | $fieldRight)";
2182 public function buildConcat( $stringList ) {
2183 return 'CONCAT(' . implode( ',', $stringList ) . ')';
2186 public function buildGroupConcatField(
2187 $delim, $table, $field, $conds = '', $join_conds = []
2189 $fld = "GROUP_CONCAT($field SEPARATOR " . $this->addQuotes( $delim ) . ')';
2191 return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
2194 public function buildSubstring( $input, $startPosition, $length = null ) {
2195 $this->assertBuildSubstringParams( $startPosition, $length );
2196 $functionBody = "$input FROM $startPosition";
2197 if ( $length !== null ) {
2198 $functionBody .= " FOR $length";
2200 return 'SUBSTRING(' . $functionBody . ')';
2204 * Check type and bounds for parameters to self::buildSubstring()
2206 * All supported databases have substring functions that behave the same for
2207 * positive $startPosition and non-negative $length, but behaviors differ when
2208 * given 0 or negative $startPosition or negative $length. The simplest
2209 * solution to that is to just forbid those values.
2211 * @param int $startPosition
2212 * @param int|null $length
2215 protected function assertBuildSubstringParams( $startPosition, $length ) {
2216 if ( !is_int( $startPosition ) ||
$startPosition <= 0 ) {
2217 throw new InvalidArgumentException(
2218 '$startPosition must be a positive integer'
2221 if ( !( is_int( $length ) && $length >= 0 ||
$length === null ) ) {
2222 throw new InvalidArgumentException(
2223 '$length must be null or an integer greater than or equal to 0'
2228 public function buildStringCast( $field ) {
2232 public function buildIntegerCast( $field ) {
2233 return 'CAST( ' . $field . ' AS INTEGER )';
2236 public function buildSelectSubquery(
2237 $table, $vars, $conds = '', $fname = __METHOD__
,
2238 $options = [], $join_conds = []
2240 return new Subquery(
2241 $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds )
2245 public function databasesAreIndependent() {
2249 public function selectDB( $db ) {
2250 # Stub. Shouldn't cause serious problems if it's not overridden, but
2251 # if your database engine supports a concept similar to MySQL's
2252 # databases you may as well.
2253 $this->dbName
= $db;
2258 public function getDBname() {
2259 return $this->dbName
;
2262 public function getServer() {
2263 return $this->server
;
2266 public function tableName( $name, $format = 'quoted' ) {
2267 if ( $name instanceof Subquery
) {
2268 throw new DBUnexpectedError(
2270 __METHOD__
. ': got Subquery instance when expecting a string.'
2274 # Skip the entire process when we have a string quoted on both ends.
2275 # Note that we check the end so that we will still quote any use of
2276 # use of `database`.table. But won't break things if someone wants
2277 # to query a database table with a dot in the name.
2278 if ( $this->isQuotedIdentifier( $name ) ) {
2282 # Lets test for any bits of text that should never show up in a table
2283 # name. Basically anything like JOIN or ON which are actually part of
2284 # SQL queries, but may end up inside of the table value to combine
2285 # sql. Such as how the API is doing.
2286 # Note that we use a whitespace test rather than a \b test to avoid
2287 # any remote case where a word like on may be inside of a table name
2288 # surrounded by symbols which may be considered word breaks.
2289 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
2290 $this->queryLogger
->warning(
2291 __METHOD__
. ": use of subqueries is not supported this way.",
2292 [ 'trace' => ( new RuntimeException() )->getTraceAsString() ]
2298 # Split database and table into proper variables.
2299 list( $database, $schema, $prefix, $table ) = $this->qualifiedTableComponents( $name );
2301 # Quote $table and apply the prefix if not quoted.
2302 # $tableName might be empty if this is called from Database::replaceVars()
2303 $tableName = "{$prefix}{$table}";
2304 if ( $format === 'quoted'
2305 && !$this->isQuotedIdentifier( $tableName )
2306 && $tableName !== ''
2308 $tableName = $this->addIdentifierQuotes( $tableName );
2311 # Quote $schema and $database and merge them with the table name if needed
2312 $tableName = $this->prependDatabaseOrSchema( $schema, $tableName, $format );
2313 $tableName = $this->prependDatabaseOrSchema( $database, $tableName, $format );
2319 * Get the table components needed for a query given the currently selected database
2321 * @param string $name Table name in the form of db.schema.table, db.table, or table
2322 * @return array (DB name or "" for default, schema name, table prefix, table name)
2324 protected function qualifiedTableComponents( $name ) {
2325 # We reverse the explode so that database.table and table both output the correct table.
2326 $dbDetails = explode( '.', $name, 3 );
2327 if ( count( $dbDetails ) == 3 ) {
2328 list( $database, $schema, $table ) = $dbDetails;
2329 # We don't want any prefix added in this case
2331 } elseif ( count( $dbDetails ) == 2 ) {
2332 list( $database, $table ) = $dbDetails;
2333 # We don't want any prefix added in this case
2335 # In dbs that support it, $database may actually be the schema
2336 # but that doesn't affect any of the functionality here
2339 list( $table ) = $dbDetails;
2340 if ( isset( $this->tableAliases
[$table] ) ) {
2341 $database = $this->tableAliases
[$table]['dbname'];
2342 $schema = is_string( $this->tableAliases
[$table]['schema'] )
2343 ?
$this->tableAliases
[$table]['schema']
2345 $prefix = is_string( $this->tableAliases
[$table]['prefix'] )
2346 ?
$this->tableAliases
[$table]['prefix']
2347 : $this->tablePrefix
;
2350 $schema = $this->schema
; # Default schema
2351 $prefix = $this->tablePrefix
; # Default prefix
2355 return [ $database, $schema, $prefix, $table ];
2359 * @param string|null $namespace Database or schema
2360 * @param string $relation Name of table, view, sequence, etc...
2361 * @param string $format One of (raw, quoted)
2362 * @return string Relation name with quoted and merged $namespace as needed
2364 private function prependDatabaseOrSchema( $namespace, $relation, $format ) {
2365 if ( strlen( $namespace ) ) {
2366 if ( $format === 'quoted' && !$this->isQuotedIdentifier( $namespace ) ) {
2367 $namespace = $this->addIdentifierQuotes( $namespace );
2369 $relation = $namespace . '.' . $relation;
2375 public function tableNames() {
2376 $inArray = func_get_args();
2379 foreach ( $inArray as $name ) {
2380 $retVal[$name] = $this->tableName( $name );
2386 public function tableNamesN() {
2387 $inArray = func_get_args();
2390 foreach ( $inArray as $name ) {
2391 $retVal[] = $this->tableName( $name );
2398 * Get an aliased table name
2400 * This returns strings like "tableName AS newTableName" for aliased tables
2401 * and "(SELECT * from tableA) newTablename" for subqueries (e.g. derived tables)
2403 * @see Database::tableName()
2404 * @param string|Subquery $table Table name or object with a 'sql' field
2405 * @param string|bool $alias Table alias (optional)
2406 * @return string SQL name for aliased table. Will not alias a table to its own name
2408 protected function tableNameWithAlias( $table, $alias = false ) {
2409 if ( is_string( $table ) ) {
2410 $quotedTable = $this->tableName( $table );
2411 } elseif ( $table instanceof Subquery
) {
2412 $quotedTable = (string)$table;
2414 throw new InvalidArgumentException( "Table must be a string or Subquery." );
2417 if ( !strlen( $alias ) ||
$alias === $table ) {
2418 if ( $table instanceof Subquery
) {
2419 throw new InvalidArgumentException( "Subquery table missing alias." );
2422 return $quotedTable;
2424 return $quotedTable . ' ' . $this->addIdentifierQuotes( $alias );
2429 * Gets an array of aliased table names
2431 * @param array $tables [ [alias] => table ]
2432 * @return string[] See tableNameWithAlias()
2434 protected function tableNamesWithAlias( $tables ) {
2436 foreach ( $tables as $alias => $table ) {
2437 if ( is_numeric( $alias ) ) {
2440 $retval[] = $this->tableNameWithAlias( $table, $alias );
2447 * Get an aliased field name
2448 * e.g. fieldName AS newFieldName
2450 * @param string $name Field name
2451 * @param string|bool $alias Alias (optional)
2452 * @return string SQL name for aliased field. Will not alias a field to its own name
2454 protected function fieldNameWithAlias( $name, $alias = false ) {
2455 if ( !$alias ||
(string)$alias === (string)$name ) {
2458 return $name . ' AS ' . $this->addIdentifierQuotes( $alias ); // PostgreSQL needs AS
2463 * Gets an array of aliased field names
2465 * @param array $fields [ [alias] => field ]
2466 * @return string[] See fieldNameWithAlias()
2468 protected function fieldNamesWithAlias( $fields ) {
2470 foreach ( $fields as $alias => $field ) {
2471 if ( is_numeric( $alias ) ) {
2474 $retval[] = $this->fieldNameWithAlias( $field, $alias );
2481 * Get the aliased table name clause for a FROM clause
2482 * which might have a JOIN and/or USE INDEX or IGNORE INDEX clause
2484 * @param array $tables ( [alias] => table )
2485 * @param array $use_index Same as for select()
2486 * @param array $ignore_index Same as for select()
2487 * @param array $join_conds Same as for select()
2490 protected function tableNamesWithIndexClauseOrJOIN(
2491 $tables, $use_index = [], $ignore_index = [], $join_conds = []
2495 $use_index = (array)$use_index;
2496 $ignore_index = (array)$ignore_index;
2497 $join_conds = (array)$join_conds;
2499 foreach ( $tables as $alias => $table ) {
2500 if ( !is_string( $alias ) ) {
2501 // No alias? Set it equal to the table name
2505 if ( is_array( $table ) ) {
2506 // A parenthesized group
2507 if ( count( $table ) > 1 ) {
2508 $joinedTable = '(' .
2509 $this->tableNamesWithIndexClauseOrJOIN(
2510 $table, $use_index, $ignore_index, $join_conds ) . ')';
2513 $innerTable = reset( $table );
2514 $innerAlias = key( $table );
2515 $joinedTable = $this->tableNameWithAlias(
2517 is_string( $innerAlias ) ?
$innerAlias : $innerTable
2521 $joinedTable = $this->tableNameWithAlias( $table, $alias );
2524 // Is there a JOIN clause for this table?
2525 if ( isset( $join_conds[$alias] ) ) {
2526 list( $joinType, $conds ) = $join_conds[$alias];
2527 $tableClause = $joinType;
2528 $tableClause .= ' ' . $joinedTable;
2529 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2530 $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2532 $tableClause .= ' ' . $use;
2535 if ( isset( $ignore_index[$alias] ) ) { // has IGNORE INDEX?
2536 $ignore = $this->ignoreIndexClause(
2537 implode( ',', (array)$ignore_index[$alias] ) );
2538 if ( $ignore != '' ) {
2539 $tableClause .= ' ' . $ignore;
2542 $on = $this->makeList( (array)$conds, self
::LIST_AND
);
2544 $tableClause .= ' ON (' . $on . ')';
2547 $retJOIN[] = $tableClause;
2548 } elseif ( isset( $use_index[$alias] ) ) {
2549 // Is there an INDEX clause for this table?
2550 $tableClause = $joinedTable;
2551 $tableClause .= ' ' . $this->useIndexClause(
2552 implode( ',', (array)$use_index[$alias] )
2555 $ret[] = $tableClause;
2556 } elseif ( isset( $ignore_index[$alias] ) ) {
2557 // Is there an INDEX clause for this table?
2558 $tableClause = $joinedTable;
2559 $tableClause .= ' ' . $this->ignoreIndexClause(
2560 implode( ',', (array)$ignore_index[$alias] )
2563 $ret[] = $tableClause;
2565 $tableClause = $joinedTable;
2567 $ret[] = $tableClause;
2571 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2572 $implicitJoins = $ret ?
implode( ',', $ret ) : "";
2573 $explicitJoins = $retJOIN ?
implode( ' ', $retJOIN ) : "";
2575 // Compile our final table clause
2576 return implode( ' ', [ $implicitJoins, $explicitJoins ] );
2580 * Allows for index remapping in queries where this is not consistent across DBMS
2582 * @param string $index
2585 protected function indexName( $index ) {
2586 return isset( $this->indexAliases
[$index] )
2587 ?
$this->indexAliases
[$index]
2591 public function addQuotes( $s ) {
2592 if ( $s instanceof Blob
) {
2595 if ( $s === null ) {
2597 } elseif ( is_bool( $s ) ) {
2600 # This will also quote numeric values. This should be harmless,
2601 # and protects against weird problems that occur when they really
2602 # _are_ strings such as article titles and string->number->string
2603 # conversion is not 1:1.
2604 return "'" . $this->strencode( $s ) . "'";
2609 * Quotes an identifier using `backticks` or "double quotes" depending on the database type.
2610 * MySQL uses `backticks` while basically everything else uses double quotes.
2611 * Since MySQL is the odd one out here the double quotes are our generic
2612 * and we implement backticks in DatabaseMysqlBase.
2617 public function addIdentifierQuotes( $s ) {
2618 return '"' . str_replace( '"', '""', $s ) . '"';
2622 * Returns if the given identifier looks quoted or not according to
2623 * the database convention for quoting identifiers .
2625 * @note Do not use this to determine if untrusted input is safe.
2626 * A malicious user can trick this function.
2627 * @param string $name
2630 public function isQuotedIdentifier( $name ) {
2631 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2636 * @param string $escapeChar
2639 protected function escapeLikeInternal( $s, $escapeChar = '`' ) {
2640 return str_replace( [ $escapeChar, '%', '_' ],
2641 [ "{$escapeChar}{$escapeChar}", "{$escapeChar}%", "{$escapeChar}_" ],
2645 public function buildLike() {
2646 $params = func_get_args();
2648 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2649 $params = $params[0];
2654 // We use ` instead of \ as the default LIKE escape character, since addQuotes()
2655 // may escape backslashes, creating problems of double escaping. The `
2656 // character has good cross-DBMS compatibility, avoiding special operators
2657 // in MS SQL like ^ and %
2660 foreach ( $params as $value ) {
2661 if ( $value instanceof LikeMatch
) {
2662 $s .= $value->toString();
2664 $s .= $this->escapeLikeInternal( $value, $escapeChar );
2669 $this->addQuotes( $s ) . ' ESCAPE ' . $this->addQuotes( $escapeChar ) . ' ';
2672 public function anyChar() {
2673 return new LikeMatch( '_' );
2676 public function anyString() {
2677 return new LikeMatch( '%' );
2680 public function nextSequenceValue( $seqName ) {
2685 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2686 * is only needed because a) MySQL must be as efficient as possible due to
2687 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2688 * which index to pick. Anyway, other databases might have different
2689 * indexes on a given table. So don't bother overriding this unless you're
2691 * @param string $index
2694 public function useIndexClause( $index ) {
2699 * IGNORE INDEX clause. Unlikely to be useful for anything but MySQL. This
2700 * is only needed because a) MySQL must be as efficient as possible due to
2701 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2702 * which index to pick. Anyway, other databases might have different
2703 * indexes on a given table. So don't bother overriding this unless you're
2705 * @param string $index
2708 public function ignoreIndexClause( $index ) {
2712 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
2713 if ( count( $rows ) == 0 ) {
2718 if ( !is_array( reset( $rows ) ) ) {
2723 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
2724 $affectedRowCount = 0;
2725 foreach ( $rows as $row ) {
2726 // Delete rows which collide with this one
2727 $indexWhereClauses = [];
2728 foreach ( $uniqueIndexes as $index ) {
2729 $indexColumns = (array)$index;
2730 $indexRowValues = array_intersect_key( $row, array_flip( $indexColumns ) );
2731 if ( count( $indexRowValues ) != count( $indexColumns ) ) {
2732 throw new DBUnexpectedError(
2734 'New record does not provide all values for unique key (' .
2735 implode( ', ', $indexColumns ) . ')'
2737 } elseif ( in_array( null, $indexRowValues, true ) ) {
2738 throw new DBUnexpectedError(
2740 'New record has a null value for unique key (' .
2741 implode( ', ', $indexColumns ) . ')'
2744 $indexWhereClauses[] = $this->makeList( $indexRowValues, LIST_AND
);
2747 if ( $indexWhereClauses ) {
2748 $this->delete( $table, $this->makeList( $indexWhereClauses, LIST_OR
), $fname );
2749 $affectedRowCount +
= $this->affectedRows();
2752 // Now insert the row
2753 $this->insert( $table, $row, $fname );
2754 $affectedRowCount +
= $this->affectedRows();
2756 $this->endAtomic( $fname );
2757 $this->affectedRowCount
= $affectedRowCount;
2758 } catch ( Exception
$e ) {
2759 $this->cancelAtomic( $fname );
2765 * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2768 * @param string $table Table name
2769 * @param array|string $rows Row(s) to insert
2770 * @param string $fname Caller function name
2772 * @return ResultWrapper
2774 protected function nativeReplace( $table, $rows, $fname ) {
2775 $table = $this->tableName( $table );
2778 if ( !is_array( reset( $rows ) ) ) {
2782 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2785 foreach ( $rows as $row ) {
2792 $sql .= '(' . $this->makeList( $row ) . ')';
2795 return $this->query( $sql, $fname );
2798 public function upsert( $table, array $rows, array $uniqueIndexes, array $set,
2801 if ( !count( $rows ) ) {
2802 return true; // nothing to do
2805 if ( !is_array( reset( $rows ) ) ) {
2809 if ( count( $uniqueIndexes ) ) {
2810 $clauses = []; // list WHERE clauses that each identify a single row
2811 foreach ( $rows as $row ) {
2812 foreach ( $uniqueIndexes as $index ) {
2813 $index = is_array( $index ) ?
$index : [ $index ]; // columns
2814 $rowKey = []; // unique key to this row
2815 foreach ( $index as $column ) {
2816 $rowKey[$column] = $row[$column];
2818 $clauses[] = $this->makeList( $rowKey, self
::LIST_AND
);
2821 $where = [ $this->makeList( $clauses, self
::LIST_OR
) ];
2826 $affectedRowCount = 0;
2828 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
2829 # Update any existing conflicting row(s)
2830 if ( $where !== false ) {
2831 $ok = $this->update( $table, $set, $where, $fname );
2832 $affectedRowCount +
= $this->affectedRows();
2836 # Now insert any non-conflicting row(s)
2837 $ok = $this->insert( $table, $rows, $fname, [ 'IGNORE' ] ) && $ok;
2838 $affectedRowCount +
= $this->affectedRows();
2839 $this->endAtomic( $fname );
2840 $this->affectedRowCount
= $affectedRowCount;
2841 } catch ( Exception
$e ) {
2842 $this->cancelAtomic( $fname );
2849 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2853 throw new DBUnexpectedError( $this, __METHOD__
. ' called with empty $conds' );
2856 $delTable = $this->tableName( $delTable );
2857 $joinTable = $this->tableName( $joinTable );
2858 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2859 if ( $conds != '*' ) {
2860 $sql .= 'WHERE ' . $this->makeList( $conds, self
::LIST_AND
);
2864 $this->query( $sql, $fname );
2867 public function textFieldSize( $table, $field ) {
2868 $table = $this->tableName( $table );
2869 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2870 $res = $this->query( $sql, __METHOD__
);
2871 $row = $this->fetchObject( $res );
2875 if ( preg_match( '/\((.*)\)/', $row->Type
, $m ) ) {
2884 public function delete( $table, $conds, $fname = __METHOD__
) {
2886 throw new DBUnexpectedError( $this, __METHOD__
. ' called with no conditions' );
2889 $table = $this->tableName( $table );
2890 $sql = "DELETE FROM $table";
2892 if ( $conds != '*' ) {
2893 if ( is_array( $conds ) ) {
2894 $conds = $this->makeList( $conds, self
::LIST_AND
);
2896 $sql .= ' WHERE ' . $conds;
2899 return $this->query( $sql, $fname );
2902 final public function insertSelect(
2903 $destTable, $srcTable, $varMap, $conds,
2904 $fname = __METHOD__
, $insertOptions = [], $selectOptions = [], $selectJoinConds = []
2906 static $hints = [ 'NO_AUTO_COLUMNS' ];
2908 $insertOptions = (array)$insertOptions;
2909 $selectOptions = (array)$selectOptions;
2911 if ( $this->cliMode
&& $this->isInsertSelectSafe( $insertOptions, $selectOptions ) ) {
2912 // For massive migrations with downtime, we don't want to select everything
2913 // into memory and OOM, so do all this native on the server side if possible.
2914 return $this->nativeInsertSelect(
2920 array_diff( $insertOptions, $hints ),
2926 return $this->nonNativeInsertSelect(
2932 array_diff( $insertOptions, $hints ),
2939 * @param array $insertOptions INSERT options
2940 * @param array $selectOptions SELECT options
2941 * @return bool Whether an INSERT SELECT with these options will be replication safe
2944 protected function isInsertSelectSafe( array $insertOptions, array $selectOptions ) {
2949 * Implementation of insertSelect() based on select() and insert()
2951 * @see IDatabase::insertSelect()
2953 * @param string $destTable
2954 * @param string|array $srcTable
2955 * @param array $varMap
2956 * @param array $conds
2957 * @param string $fname
2958 * @param array $insertOptions
2959 * @param array $selectOptions
2960 * @param array $selectJoinConds
2963 protected function nonNativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
2964 $fname = __METHOD__
,
2965 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
2967 // For web requests, do a locking SELECT and then INSERT. This puts the SELECT burden
2968 // on only the master (without needing row-based-replication). It also makes it easy to
2969 // know how big the INSERT is going to be.
2971 foreach ( $varMap as $dstColumn => $sourceColumnOrSql ) {
2972 $fields[] = $this->fieldNameWithAlias( $sourceColumnOrSql, $dstColumn );
2974 $selectOptions[] = 'FOR UPDATE';
2975 $res = $this->select(
2976 $srcTable, implode( ',', $fields ), $conds, $fname, $selectOptions, $selectJoinConds
2983 $affectedRowCount = 0;
2984 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
2987 foreach ( $res as $row ) {
2988 $rows[] = (array)$row;
2990 // Avoid inserts that are too huge
2991 if ( count( $rows ) >= $this->nonNativeInsertSelectBatchSize
) {
2992 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
2996 $affectedRowCount +
= $this->affectedRows();
3000 if ( $rows && $ok ) {
3001 $ok = $this->insert( $destTable, $rows, $fname, $insertOptions );
3003 $affectedRowCount +
= $this->affectedRows();
3007 $this->endAtomic( $fname );
3008 $this->affectedRowCount
= $affectedRowCount;
3010 $this->cancelAtomic( $fname );
3013 } catch ( Exception
$e ) {
3014 $this->cancelAtomic( $fname );
3020 * Native server-side implementation of insertSelect() for situations where
3021 * we don't want to select everything into memory
3023 * @see IDatabase::insertSelect()
3024 * @param string $destTable
3025 * @param string|array $srcTable
3026 * @param array $varMap
3027 * @param array $conds
3028 * @param string $fname
3029 * @param array $insertOptions
3030 * @param array $selectOptions
3031 * @param array $selectJoinConds
3034 protected function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
3035 $fname = __METHOD__
,
3036 $insertOptions = [], $selectOptions = [], $selectJoinConds = []
3038 $destTable = $this->tableName( $destTable );
3040 if ( !is_array( $insertOptions ) ) {
3041 $insertOptions = [ $insertOptions ];
3044 $insertOptions = $this->makeInsertOptions( $insertOptions );
3046 $selectSql = $this->selectSQLText(
3048 array_values( $varMap ),
3055 $sql = "INSERT $insertOptions" .
3056 " INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ') ' .
3059 return $this->query( $sql, $fname );
3063 * Construct a LIMIT query with optional offset. This is used for query
3064 * pages. The SQL should be adjusted so that only the first $limit rows
3065 * are returned. If $offset is provided as well, then the first $offset
3066 * rows should be discarded, and the next $limit rows should be returned.
3067 * If the result of the query is not ordered, then the rows to be returned
3068 * are theoretically arbitrary.
3070 * $sql is expected to be a SELECT, if that makes a difference.
3072 * The version provided by default works in MySQL and SQLite. It will very
3073 * likely need to be overridden for most other DBMSes.
3075 * @param string $sql SQL query we will append the limit too
3076 * @param int $limit The SQL limit
3077 * @param int|bool $offset The SQL offset (default false)
3078 * @throws DBUnexpectedError
3081 public function limitResult( $sql, $limit, $offset = false ) {
3082 if ( !is_numeric( $limit ) ) {
3083 throw new DBUnexpectedError( $this,
3084 "Invalid non-numeric limit passed to limitResult()\n" );
3087 return "$sql LIMIT "
3088 . ( ( is_numeric( $offset ) && $offset != 0 ) ?
"{$offset}," : "" )
3092 public function unionSupportsOrderAndLimit() {
3093 return true; // True for almost every DB supported
3096 public function unionQueries( $sqls, $all ) {
3097 $glue = $all ?
') UNION ALL (' : ') UNION (';
3099 return '(' . implode( $glue, $sqls ) . ')';
3102 public function unionConditionPermutations(
3103 $table, $vars, array $permute_conds, $extra_conds = '', $fname = __METHOD__
,
3104 $options = [], $join_conds = []
3106 // First, build the Cartesian product of $permute_conds
3108 foreach ( $permute_conds as $field => $values ) {
3110 // Skip empty $values
3113 $values = array_unique( $values ); // For sanity
3115 foreach ( $conds as $cond ) {
3116 foreach ( $values as $value ) {
3117 $cond[$field] = $value;
3118 $newConds[] = $cond; // Arrays are by-value, not by-reference, so this works
3124 $extra_conds = $extra_conds === '' ?
[] : (array)$extra_conds;
3126 // If there's just one condition and no subordering, hand off to
3127 // selectSQLText directly.
3128 if ( count( $conds ) === 1 &&
3129 ( !isset( $options['INNER ORDER BY'] ) ||
!$this->unionSupportsOrderAndLimit() )
3131 return $this->selectSQLText(
3132 $table, $vars, $conds[0] +
$extra_conds, $fname, $options, $join_conds
3136 // Otherwise, we need to pull out the order and limit to apply after
3137 // the union. Then build the SQL queries for each set of conditions in
3138 // $conds. Then union them together (using UNION ALL, because the
3139 // product *should* already be distinct).
3140 $orderBy = $this->makeOrderBy( $options );
3141 $limit = isset( $options['LIMIT'] ) ?
$options['LIMIT'] : null;
3142 $offset = isset( $options['OFFSET'] ) ?
$options['OFFSET'] : false;
3143 $all = empty( $options['NOTALL'] ) && !in_array( 'NOTALL', $options );
3144 if ( !$this->unionSupportsOrderAndLimit() ) {
3145 unset( $options['ORDER BY'], $options['LIMIT'], $options['OFFSET'] );
3147 if ( array_key_exists( 'INNER ORDER BY', $options ) ) {
3148 $options['ORDER BY'] = $options['INNER ORDER BY'];
3150 if ( $limit !== null && is_numeric( $offset ) && $offset != 0 ) {
3151 // We need to increase the limit by the offset rather than
3152 // using the offset directly, otherwise it'll skip incorrectly
3153 // in the subqueries.
3154 $options['LIMIT'] = $limit +
$offset;
3155 unset( $options['OFFSET'] );
3160 foreach ( $conds as $cond ) {
3161 $sqls[] = $this->selectSQLText(
3162 $table, $vars, $cond +
$extra_conds, $fname, $options, $join_conds
3165 $sql = $this->unionQueries( $sqls, $all ) . $orderBy;
3166 if ( $limit !== null ) {
3167 $sql = $this->limitResult( $sql, $limit, $offset );
3173 public function conditional( $cond, $trueVal, $falseVal ) {
3174 if ( is_array( $cond ) ) {
3175 $cond = $this->makeList( $cond, self
::LIST_AND
);
3178 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
3181 public function strreplace( $orig, $old, $new ) {
3182 return "REPLACE({$orig}, {$old}, {$new})";
3185 public function getServerUptime() {
3189 public function wasDeadlock() {
3193 public function wasLockTimeout() {
3197 public function wasConnectionLoss() {
3198 return $this->wasConnectionError( $this->lastErrno() );
3201 public function wasReadOnlyError() {
3205 public function wasErrorReissuable() {
3207 $this->wasDeadlock() ||
3208 $this->wasLockTimeout() ||
3209 $this->wasConnectionLoss()
3214 * Do not use this method outside of Database/DBError classes
3216 * @param int|string $errno
3217 * @return bool Whether the given query error was a connection drop
3219 public function wasConnectionError( $errno ) {
3224 * @return bool Whether it is safe to assume the given error only caused statement rollback
3225 * @note This is for backwards compatibility for callers catching DBError exceptions in
3226 * order to ignore problems like duplicate key errors or foriegn key violations
3229 protected function wasKnownStatementRollbackError() {
3230 return false; // don't know; it could have caused a transaction rollback
3233 public function deadlockLoop() {
3234 $args = func_get_args();
3235 $function = array_shift( $args );
3236 $tries = self
::DEADLOCK_TRIES
;
3238 $this->begin( __METHOD__
);
3241 /** @var Exception $e */
3245 $retVal = call_user_func_array( $function, $args );
3247 } catch ( DBQueryError
$e ) {
3248 if ( $this->wasDeadlock() ) {
3249 // Retry after a randomized delay
3250 usleep( mt_rand( self
::DEADLOCK_DELAY_MIN
, self
::DEADLOCK_DELAY_MAX
) );
3252 // Throw the error back up
3256 } while ( --$tries > 0 );
3258 if ( $tries <= 0 ) {
3259 // Too many deadlocks; give up
3260 $this->rollback( __METHOD__
);
3263 $this->commit( __METHOD__
);
3269 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
3270 # Real waits are implemented in the subclass.
3274 public function getReplicaPos() {
3279 public function getMasterPos() {
3284 public function serverIsReadOnly() {
3288 final public function onTransactionResolution( callable
$callback, $fname = __METHOD__
) {
3289 if ( !$this->trxLevel
) {
3290 throw new DBUnexpectedError( $this, "No transaction is active." );
3292 $this->trxEndCallbacks
[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3295 final public function onTransactionIdle( callable
$callback, $fname = __METHOD__
) {
3296 if ( !$this->trxLevel
&& $this->getTransactionRoundId() ) {
3297 // Start an implicit transaction similar to how query() does
3298 $this->begin( __METHOD__
, self
::TRANSACTION_INTERNAL
);
3299 $this->trxAutomatic
= true;
3302 $this->trxIdleCallbacks
[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3303 if ( !$this->trxLevel
) {
3304 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_IDLE
);
3308 final public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
3309 if ( !$this->trxLevel
&& $this->getTransactionRoundId() ) {
3310 // Start an implicit transaction similar to how query() does
3311 $this->begin( __METHOD__
, self
::TRANSACTION_INTERNAL
);
3312 $this->trxAutomatic
= true;
3315 if ( $this->trxLevel
) {
3316 $this->trxPreCommitCallbacks
[] = [ $callback, $fname, $this->currentAtomicSectionId() ];
3318 // No transaction is active nor will start implicitly, so make one for this callback
3319 $this->startAtomic( __METHOD__
, self
::ATOMIC_CANCELABLE
);
3321 call_user_func( $callback, $this );
3322 $this->endAtomic( __METHOD__
);
3323 } catch ( Exception
$e ) {
3324 $this->cancelAtomic( __METHOD__
);
3331 * @return AtomicSectionIdentifier|null ID of the topmost atomic section level
3333 private function currentAtomicSectionId() {
3334 if ( $this->trxLevel
&& $this->trxAtomicLevels
) {
3335 $levelInfo = end( $this->trxAtomicLevels
);
3337 return $levelInfo[1];
3344 * @param AtomicSectionIdentifier $old
3345 * @param AtomicSectionIdentifier $new
3347 private function reassignCallbacksForSection(
3348 AtomicSectionIdentifier
$old, AtomicSectionIdentifier
$new
3350 foreach ( $this->trxPreCommitCallbacks
as $key => $info ) {
3351 if ( $info[2] === $old ) {
3352 $this->trxPreCommitCallbacks
[$key][2] = $new;
3355 foreach ( $this->trxIdleCallbacks
as $key => $info ) {
3356 if ( $info[2] === $old ) {
3357 $this->trxIdleCallbacks
[$key][2] = $new;
3360 foreach ( $this->trxEndCallbacks
as $key => $info ) {
3361 if ( $info[2] === $old ) {
3362 $this->trxEndCallbacks
[$key][2] = $new;
3368 * @param AtomicSectionIdentifier[] $sectionIds ID of an actual savepoint
3369 * @throws UnexpectedValueException
3371 private function modifyCallbacksForCancel( array $sectionIds ) {
3372 // Cancel the "on commit" callbacks owned by this savepoint
3373 $this->trxIdleCallbacks
= array_filter(
3374 $this->trxIdleCallbacks
,
3375 function ( $entry ) use ( $sectionIds ) {
3376 return !in_array( $entry[2], $sectionIds, true );
3379 $this->trxPreCommitCallbacks
= array_filter(
3380 $this->trxPreCommitCallbacks
,
3381 function ( $entry ) use ( $sectionIds ) {
3382 return !in_array( $entry[2], $sectionIds, true );
3385 // Make "on resolution" callbacks owned by this savepoint to perceive a rollback
3386 foreach ( $this->trxEndCallbacks
as $key => $entry ) {
3387 if ( in_array( $entry[2], $sectionIds, true ) ) {
3388 $callback = $entry[0];
3389 $this->trxEndCallbacks
[$key][0] = function () use ( $callback ) {
3390 return $callback( self
::TRIGGER_ROLLBACK
, $this );
3396 final public function setTransactionListener( $name, callable
$callback = null ) {
3398 $this->trxRecurringCallbacks
[$name] = $callback;
3400 unset( $this->trxRecurringCallbacks
[$name] );
3405 * Whether to disable running of post-COMMIT/ROLLBACK callbacks
3407 * This method should not be used outside of Database/LoadBalancer
3409 * @param bool $suppress
3412 final public function setTrxEndCallbackSuppression( $suppress ) {
3413 $this->trxEndCallbacksSuppressed
= $suppress;
3417 * Actually consume and run any "on transaction idle/resolution" callbacks.
3419 * This method should not be used outside of Database/LoadBalancer
3421 * @param int $trigger IDatabase::TRIGGER_* constant
3422 * @return int Number of callbacks attempted
3426 public function runOnTransactionIdleCallbacks( $trigger ) {
3427 if ( $this->trxLevel
) { // sanity
3428 throw new DBUnexpectedError( $this, __METHOD__
. ': a transaction is still open.' );
3431 if ( $this->trxEndCallbacksSuppressed
) {
3436 $autoTrx = $this->getFlag( self
::DBO_TRX
); // automatic begin() enabled?
3437 /** @var Exception $e */
3438 $e = null; // first exception
3439 do { // callbacks may add callbacks :)
3440 $callbacks = array_merge(
3441 $this->trxIdleCallbacks
,
3442 $this->trxEndCallbacks
// include "transaction resolution" callbacks
3444 $this->trxIdleCallbacks
= []; // consumed (and recursion guard)
3445 $this->trxEndCallbacks
= []; // consumed (recursion guard)
3446 foreach ( $callbacks as $callback ) {
3449 list( $phpCallback ) = $callback;
3450 $this->clearFlag( self
::DBO_TRX
); // make each query its own transaction
3451 call_user_func( $phpCallback, $trigger, $this );
3453 $this->setFlag( self
::DBO_TRX
); // restore automatic begin()
3455 $this->clearFlag( self
::DBO_TRX
); // restore auto-commit
3457 } catch ( Exception
$ex ) {
3458 call_user_func( $this->errorLogger
, $ex );
3460 // Some callbacks may use startAtomic/endAtomic, so make sure
3461 // their transactions are ended so other callbacks don't fail
3462 if ( $this->trxLevel() ) {
3463 $this->rollback( __METHOD__
, self
::FLUSHING_INTERNAL
);
3467 } while ( count( $this->trxIdleCallbacks
) );
3469 if ( $e instanceof Exception
) {
3470 throw $e; // re-throw any first exception
3477 * Actually consume and run any "on transaction pre-commit" callbacks.
3479 * This method should not be used outside of Database/LoadBalancer
3482 * @return int Number of callbacks attempted
3485 public function runOnTransactionPreCommitCallbacks() {
3488 $e = null; // first exception
3489 do { // callbacks may add callbacks :)
3490 $callbacks = $this->trxPreCommitCallbacks
;
3491 $this->trxPreCommitCallbacks
= []; // consumed (and recursion guard)
3492 foreach ( $callbacks as $callback ) {
3495 list( $phpCallback ) = $callback;
3496 call_user_func( $phpCallback, $this );
3497 } catch ( Exception
$ex ) {
3498 call_user_func( $this->errorLogger
, $ex );
3502 } while ( count( $this->trxPreCommitCallbacks
) );
3504 if ( $e instanceof Exception
) {
3505 throw $e; // re-throw any first exception
3512 * Actually run any "transaction listener" callbacks.
3514 * This method should not be used outside of Database/LoadBalancer
3516 * @param int $trigger IDatabase::TRIGGER_* constant
3520 public function runTransactionListenerCallbacks( $trigger ) {
3521 if ( $this->trxEndCallbacksSuppressed
) {
3525 /** @var Exception $e */
3526 $e = null; // first exception
3528 foreach ( $this->trxRecurringCallbacks
as $phpCallback ) {
3530 $phpCallback( $trigger, $this );
3531 } catch ( Exception
$ex ) {
3532 call_user_func( $this->errorLogger
, $ex );
3537 if ( $e instanceof Exception
) {
3538 throw $e; // re-throw any first exception
3543 * Create a savepoint
3545 * This is used internally to implement atomic sections. It should not be
3549 * @param string $identifier Identifier for the savepoint
3550 * @param string $fname Calling function name
3552 protected function doSavepoint( $identifier, $fname ) {
3553 $this->query( 'SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3557 * Release a savepoint
3559 * This is used internally to implement atomic sections. It should not be
3563 * @param string $identifier Identifier for the savepoint
3564 * @param string $fname Calling function name
3566 protected function doReleaseSavepoint( $identifier, $fname ) {
3567 $this->query( 'RELEASE SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3571 * Rollback to a savepoint
3573 * This is used internally to implement atomic sections. It should not be
3577 * @param string $identifier Identifier for the savepoint
3578 * @param string $fname Calling function name
3580 protected function doRollbackToSavepoint( $identifier, $fname ) {
3581 $this->query( 'ROLLBACK TO SAVEPOINT ' . $this->addIdentifierQuotes( $identifier ), $fname );
3585 * @param string $fname
3588 private function nextSavepointId( $fname ) {
3589 $savepointId = self
::$SAVEPOINT_PREFIX . ++
$this->trxAtomicCounter
;
3590 if ( strlen( $savepointId ) > 30 ) {
3591 // 30 == Oracle's identifier length limit (pre 12c)
3592 // With a 22 character prefix, that puts the highest number at 99999999.
3593 throw new DBUnexpectedError(
3595 'There have been an excessively large number of atomic sections in a transaction'
3596 . " started by $this->trxFname (at $fname)"
3600 return $savepointId;
3603 final public function startAtomic(
3604 $fname = __METHOD__
, $cancelable = self
::ATOMIC_NOT_CANCELABLE
3606 $savepointId = $cancelable === self
::ATOMIC_CANCELABLE ? self
::$NOT_APPLICABLE : null;
3608 if ( !$this->trxLevel
) {
3609 $this->begin( $fname, self
::TRANSACTION_INTERNAL
); // sets trxAutomatic
3610 // If DBO_TRX is set, a series of startAtomic/endAtomic pairs will result
3611 // in all changes being in one transaction to keep requests transactional.
3612 if ( $this->getFlag( self
::DBO_TRX
) ) {
3613 // Since writes could happen in between the topmost atomic sections as part
3614 // of the transaction, those sections will need savepoints.
3615 $savepointId = $this->nextSavepointId( $fname );
3616 $this->doSavepoint( $savepointId, $fname );
3618 $this->trxAutomaticAtomic
= true;
3620 } elseif ( $cancelable === self
::ATOMIC_CANCELABLE
) {
3621 $savepointId = $this->nextSavepointId( $fname );
3622 $this->doSavepoint( $savepointId, $fname );
3625 $sectionId = new AtomicSectionIdentifier
;
3626 $this->trxAtomicLevels
[] = [ $fname, $sectionId, $savepointId ];
3631 final public function endAtomic( $fname = __METHOD__
) {
3632 if ( !$this->trxLevel ||
!$this->trxAtomicLevels
) {
3633 throw new DBUnexpectedError( $this, "No atomic section is open (got $fname)." );
3636 // Check if the current section matches $fname
3637 $pos = count( $this->trxAtomicLevels
) - 1;
3638 list( $savedFname, $sectionId, $savepointId ) = $this->trxAtomicLevels
[$pos];
3640 if ( $savedFname !== $fname ) {
3641 throw new DBUnexpectedError(
3643 "Invalid atomic section ended (got $fname but expected $savedFname)."
3647 // Remove the last section (no need to re-index the array)
3648 array_pop( $this->trxAtomicLevels
);
3650 if ( !$this->trxAtomicLevels
&& $this->trxAutomaticAtomic
) {
3651 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
3652 } elseif ( $savepointId !== null && $savepointId !== self
::$NOT_APPLICABLE ) {
3653 $this->doReleaseSavepoint( $savepointId, $fname );
3656 // Hoist callback ownership for callbacks in the section that just ended;
3657 // all callbacks should have an owner that is present in trxAtomicLevels.
3658 $currentSectionId = $this->currentAtomicSectionId();
3659 if ( $currentSectionId ) {
3660 $this->reassignCallbacksForSection( $sectionId, $currentSectionId );
3664 final public function cancelAtomic(
3665 $fname = __METHOD__
, AtomicSectionIdentifier
$sectionId = null
3667 if ( !$this->trxLevel ||
!$this->trxAtomicLevels
) {
3668 throw new DBUnexpectedError( $this, "No atomic section is open (got $fname)." );
3671 if ( $sectionId !== null ) {
3672 // Find the (last) section with the given $sectionId
3674 foreach ( $this->trxAtomicLevels
as $i => list( $asFname, $asId, $spId ) ) {
3675 if ( $asId === $sectionId ) {
3680 throw new DBUnexpectedError( "Atomic section not found (for $fname)" );
3682 // Remove all descendant sections and re-index the array
3684 $len = count( $this->trxAtomicLevels
);
3685 for ( $i = $pos +
1; $i < $len; ++
$i ) {
3686 $excisedIds[] = $this->trxAtomicLevels
[$i][1];
3688 $this->trxAtomicLevels
= array_slice( $this->trxAtomicLevels
, 0, $pos +
1 );
3689 $this->modifyCallbacksForCancel( $excisedIds );
3692 // Check if the current section matches $fname
3693 $pos = count( $this->trxAtomicLevels
) - 1;
3694 list( $savedFname, $savedSectionId, $savepointId ) = $this->trxAtomicLevels
[$pos];
3696 if ( $savedFname !== $fname ) {
3697 throw new DBUnexpectedError(
3699 "Invalid atomic section ended (got $fname but expected $savedFname)."
3703 // Remove the last section (no need to re-index the array)
3704 array_pop( $this->trxAtomicLevels
);
3705 $this->modifyCallbacksForCancel( [ $savedSectionId ] );
3707 if ( $savepointId !== null ) {
3708 // Rollback the transaction to the state just before this atomic section
3709 if ( $savepointId === self
::$NOT_APPLICABLE ) {
3710 $this->rollback( $fname, self
::FLUSHING_INTERNAL
);
3712 $this->doRollbackToSavepoint( $savepointId, $fname );
3713 $this->trxStatus
= self
::STATUS_TRX_OK
; // no exception; recovered
3714 $this->trxStatusIgnoredCause
= null;
3716 } elseif ( $this->trxStatus
> self
::STATUS_TRX_ERROR
) {
3717 // Put the transaction into an error state if it's not already in one
3718 $this->trxStatus
= self
::STATUS_TRX_ERROR
;
3719 $this->trxStatusCause
= new DBUnexpectedError(
3721 "Uncancelable atomic section canceled (got $fname)."
3725 $this->affectedRowCount
= 0; // for the sake of consistency
3728 final public function doAtomicSection(
3729 $fname, callable
$callback, $cancelable = self
::ATOMIC_NOT_CANCELABLE
3731 $sectionId = $this->startAtomic( $fname, $cancelable );
3733 $res = call_user_func_array( $callback, [ $this, $fname ] );
3734 } catch ( Exception
$e ) {
3735 $this->cancelAtomic( $fname, $sectionId );
3739 $this->endAtomic( $fname );
3744 final public function begin( $fname = __METHOD__
, $mode = self
::TRANSACTION_EXPLICIT
) {
3745 static $modes = [ self
::TRANSACTION_EXPLICIT
, self
::TRANSACTION_INTERNAL
];
3746 if ( !in_array( $mode, $modes, true ) ) {
3747 throw new DBUnexpectedError( $this, "$fname: invalid mode parameter '$mode'." );
3750 // Protect against mismatched atomic section, transaction nesting, and snapshot loss
3751 if ( $this->trxLevel
) {
3752 if ( $this->trxAtomicLevels
) {
3753 $levels = $this->flatAtomicSectionList();
3754 $msg = "$fname: Got explicit BEGIN while atomic section(s) $levels are open.";
3755 throw new DBUnexpectedError( $this, $msg );
3756 } elseif ( !$this->trxAutomatic
) {
3757 $msg = "$fname: Explicit transaction already active (from {$this->trxFname}).";
3758 throw new DBUnexpectedError( $this, $msg );
3760 $msg = "$fname: Implicit transaction already active (from {$this->trxFname}).";
3761 throw new DBUnexpectedError( $this, $msg );
3763 } elseif ( $this->getFlag( self
::DBO_TRX
) && $mode !== self
::TRANSACTION_INTERNAL
) {
3764 $msg = "$fname: Implicit transaction expected (DBO_TRX set).";
3765 throw new DBUnexpectedError( $this, $msg );
3768 // Avoid fatals if close() was called
3769 $this->assertOpen();
3771 $this->doBegin( $fname );
3772 $this->trxStatus
= self
::STATUS_TRX_OK
;
3773 $this->trxStatusIgnoredCause
= null;
3774 $this->trxAtomicCounter
= 0;
3775 $this->trxTimestamp
= microtime( true );
3776 $this->trxFname
= $fname;
3777 $this->trxDoneWrites
= false;
3778 $this->trxAutomaticAtomic
= false;
3779 $this->trxAtomicLevels
= [];
3780 $this->trxShortId
= sprintf( '%06x', mt_rand( 0, 0xffffff ) );
3781 $this->trxWriteDuration
= 0.0;
3782 $this->trxWriteQueryCount
= 0;
3783 $this->trxWriteAffectedRows
= 0;
3784 $this->trxWriteAdjDuration
= 0.0;
3785 $this->trxWriteAdjQueryCount
= 0;
3786 $this->trxWriteCallers
= [];
3787 // First SELECT after BEGIN will establish the snapshot in REPEATABLE-READ.
3788 // Get an estimate of the replication lag before any such queries.
3789 $this->trxReplicaLag
= null; // clear cached value first
3790 $this->trxReplicaLag
= $this->getApproximateLagStatus()['lag'];
3791 // T147697: make explicitTrxActive() return true until begin() finishes. This way, no
3792 // caller will think its OK to muck around with the transaction just because startAtomic()
3793 // has not yet completed (e.g. setting trxAtomicLevels).
3794 $this->trxAutomatic
= ( $mode === self
::TRANSACTION_INTERNAL
);
3798 * Issues the BEGIN command to the database server.
3800 * @see Database::begin()
3801 * @param string $fname
3803 protected function doBegin( $fname ) {
3804 $this->query( 'BEGIN', $fname );
3805 $this->trxLevel
= 1;
3808 final public function commit( $fname = __METHOD__
, $flush = self
::FLUSHING_ONE
) {
3809 static $modes = [ self
::FLUSHING_ONE
, self
::FLUSHING_ALL_PEERS
, self
::FLUSHING_INTERNAL
];
3810 if ( !in_array( $flush, $modes, true ) ) {
3811 throw new DBUnexpectedError( $this, "$fname: invalid flush parameter '$flush'." );
3814 if ( $this->trxLevel
&& $this->trxAtomicLevels
) {
3815 // There are still atomic sections open; this cannot be ignored
3816 $levels = $this->flatAtomicSectionList();
3817 throw new DBUnexpectedError(
3819 "$fname: Got COMMIT while atomic sections $levels are still open."
3823 if ( $flush === self
::FLUSHING_INTERNAL ||
$flush === self
::FLUSHING_ALL_PEERS
) {
3824 if ( !$this->trxLevel
) {
3825 return; // nothing to do
3826 } elseif ( !$this->trxAutomatic
) {
3827 throw new DBUnexpectedError(
3829 "$fname: Flushing an explicit transaction, getting out of sync."
3833 if ( !$this->trxLevel
) {
3834 $this->queryLogger
->error(
3835 "$fname: No transaction to commit, something got out of sync." );
3836 return; // nothing to do
3837 } elseif ( $this->trxAutomatic
) {
3838 throw new DBUnexpectedError(
3840 "$fname: Expected mass commit of all peer transactions (DBO_TRX set)."
3845 // Avoid fatals if close() was called
3846 $this->assertOpen();
3848 $this->runOnTransactionPreCommitCallbacks();
3849 $writeTime = $this->pendingWriteQueryDuration( self
::ESTIMATE_DB_APPLY
);
3850 $this->doCommit( $fname );
3851 $this->trxStatus
= self
::STATUS_TRX_NONE
;
3852 if ( $this->trxDoneWrites
) {
3853 $this->lastWriteTime
= microtime( true );
3854 $this->trxProfiler
->transactionWritingOut(
3859 $this->trxWriteAffectedRows
3863 // With FLUSHING_ALL_PEERS, callbacks will be explicitly run later
3864 if ( $flush !== self
::FLUSHING_ALL_PEERS
) {
3865 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_COMMIT
);
3866 $this->runTransactionListenerCallbacks( self
::TRIGGER_COMMIT
);
3871 * Issues the COMMIT command to the database server.
3873 * @see Database::commit()
3874 * @param string $fname
3876 protected function doCommit( $fname ) {
3877 if ( $this->trxLevel
) {
3878 $this->query( 'COMMIT', $fname );
3879 $this->trxLevel
= 0;
3883 final public function rollback( $fname = __METHOD__
, $flush = '' ) {
3884 $trxActive = $this->trxLevel
;
3886 if ( $flush !== self
::FLUSHING_INTERNAL
&& $flush !== self
::FLUSHING_ALL_PEERS
) {
3887 if ( $this->getFlag( self
::DBO_TRX
) ) {
3888 throw new DBUnexpectedError(
3890 "$fname: Expected mass rollback of all peer transactions (DBO_TRX set)."
3896 // Avoid fatals if close() was called
3897 $this->assertOpen();
3899 $this->doRollback( $fname );
3900 $this->trxStatus
= self
::STATUS_TRX_NONE
;
3901 $this->trxAtomicLevels
= [];
3902 if ( $this->trxDoneWrites
) {
3903 $this->trxProfiler
->transactionWritingOut(
3911 // Clear any commit-dependant callbacks. They might even be present
3912 // only due to transaction rounds, with no SQL transaction being active
3913 $this->trxIdleCallbacks
= [];
3914 $this->trxPreCommitCallbacks
= [];
3916 // With FLUSHING_ALL_PEERS, callbacks will be explicitly run later
3917 if ( $trxActive && $flush !== self
::FLUSHING_ALL_PEERS
) {
3919 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_ROLLBACK
);
3920 } catch ( Exception
$e ) {
3921 // already logged; finish and let LoadBalancer move on during mass-rollback
3924 $this->runTransactionListenerCallbacks( self
::TRIGGER_ROLLBACK
);
3925 } catch ( Exception
$e ) {
3926 // already logged; let LoadBalancer move on during mass-rollback
3929 $this->affectedRowCount
= 0; // for the sake of consistency
3934 * Issues the ROLLBACK command to the database server.
3936 * @see Database::rollback()
3937 * @param string $fname
3939 protected function doRollback( $fname ) {
3940 if ( $this->trxLevel
) {
3941 # Disconnects cause rollback anyway, so ignore those errors
3942 $ignoreErrors = true;
3943 $this->query( 'ROLLBACK', $fname, $ignoreErrors );
3944 $this->trxLevel
= 0;
3948 public function flushSnapshot( $fname = __METHOD__
) {
3949 if ( $this->writesOrCallbacksPending() ||
$this->explicitTrxActive() ) {
3950 // This only flushes transactions to clear snapshots, not to write data
3951 $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
3952 throw new DBUnexpectedError(
3954 "$fname: Cannot flush snapshot because writes are pending ($fnames)."
3958 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
3961 public function explicitTrxActive() {
3962 return $this->trxLevel
&& ( $this->trxAtomicLevels ||
!$this->trxAutomatic
);
3965 public function duplicateTableStructure(
3966 $oldName, $newName, $temporary = false, $fname = __METHOD__
3968 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
3971 public function listTables( $prefix = null, $fname = __METHOD__
) {
3972 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
3975 public function listViews( $prefix = null, $fname = __METHOD__
) {
3976 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
3979 public function timestamp( $ts = 0 ) {
3980 $t = new ConvertibleTimestamp( $ts );
3981 // Let errors bubble up to avoid putting garbage in the DB
3982 return $t->getTimestamp( TS_MW
);
3985 public function timestampOrNull( $ts = null ) {
3986 if ( is_null( $ts ) ) {
3989 return $this->timestamp( $ts );
3993 public function affectedRows() {
3994 return ( $this->affectedRowCount
=== null )
3995 ?
$this->fetchAffectedRowCount() // default to driver value
3996 : $this->affectedRowCount
;
4000 * @return int Number of retrieved rows according to the driver
4002 abstract protected function fetchAffectedRowCount();
4005 * Take the result from a query, and wrap it in a ResultWrapper if
4006 * necessary. Boolean values are passed through as is, to indicate success
4007 * of write queries or failure.
4009 * Once upon a time, Database::query() returned a bare MySQL result
4010 * resource, and it was necessary to call this function to convert it to
4011 * a wrapper. Nowadays, raw database objects are never exposed to external
4012 * callers, so this is unnecessary in external code.
4014 * @param bool|ResultWrapper|resource|object $result
4015 * @return bool|ResultWrapper
4017 protected function resultObject( $result ) {
4020 } elseif ( $result instanceof ResultWrapper
) {
4022 } elseif ( $result === true ) {
4023 // Successful write query
4026 return new ResultWrapper( $this, $result );
4030 public function ping( &$rtt = null ) {
4031 // Avoid hitting the server if it was hit recently
4032 if ( $this->isOpen() && ( microtime( true ) - $this->lastPing
) < self
::PING_TTL
) {
4033 if ( !func_num_args() ||
$this->rttEstimate
> 0 ) {
4034 $rtt = $this->rttEstimate
;
4035 return true; // don't care about $rtt
4039 // This will reconnect if possible or return false if not
4040 $this->clearFlag( self
::DBO_TRX
, self
::REMEMBER_PRIOR
);
4041 $ok = ( $this->query( self
::PING_QUERY
, __METHOD__
, true ) !== false );
4042 $this->restoreFlags( self
::RESTORE_PRIOR
);
4045 $rtt = $this->rttEstimate
;
4052 * Close any existing (dead) database connection and open a new connection
4054 * @param string $fname
4055 * @return bool True if new connection is opened successfully, false if error
4057 protected function replaceLostConnection( $fname ) {
4058 $this->closeConnection();
4059 $this->opened
= false;
4060 $this->conn
= false;
4062 $this->open( $this->server
, $this->user
, $this->password
, $this->dbName
);
4063 $this->lastPing
= microtime( true );
4066 $this->connLogger
->warning(
4067 $fname . ': lost connection to {dbserver}; reconnected',
4069 'dbserver' => $this->getServer(),
4070 'trace' => ( new RuntimeException() )->getTraceAsString()
4073 } catch ( DBConnectionError
$e ) {
4076 $this->connLogger
->error(
4077 $fname . ': lost connection to {dbserver} permanently',
4078 [ 'dbserver' => $this->getServer() ]
4082 $this->handleSessionLoss();
4087 public function getSessionLagStatus() {
4088 return $this->getRecordedTransactionLagStatus() ?
: $this->getApproximateLagStatus();
4092 * Get the replica DB lag when the current transaction started
4094 * This is useful when transactions might use snapshot isolation
4095 * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
4096 * is this lag plus transaction duration. If they don't, it is still
4097 * safe to be pessimistic. This returns null if there is no transaction.
4099 * This returns null if the lag status for this transaction was not yet recorded.
4101 * @return array|null ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
4104 final protected function getRecordedTransactionLagStatus() {
4105 return ( $this->trxLevel
&& $this->trxReplicaLag
!== null )
4106 ?
[ 'lag' => $this->trxReplicaLag
, 'since' => $this->trxTimestamp() ]
4111 * Get a replica DB lag estimate for this server
4113 * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)
4116 protected function getApproximateLagStatus() {
4118 'lag' => $this->getLBInfo( 'replica' ) ?
$this->getLag() : 0,
4119 'since' => microtime( true )
4124 * Merge the result of getSessionLagStatus() for several DBs
4125 * using the most pessimistic values to estimate the lag of
4126 * any data derived from them in combination
4128 * This is information is useful for caching modules
4130 * @see WANObjectCache::set()
4131 * @see WANObjectCache::getWithSetCallback()
4133 * @param IDatabase $db1
4134 * @param IDatabase $db2 [optional]
4135 * @return array Map of values:
4136 * - lag: highest lag of any of the DBs or false on error (e.g. replication stopped)
4137 * - since: oldest UNIX timestamp of any of the DB lag estimates
4138 * - pending: whether any of the DBs have uncommitted changes
4142 public static function getCacheSetOptions( IDatabase
$db1, IDatabase
$db2 = null ) {
4143 $res = [ 'lag' => 0, 'since' => INF
, 'pending' => false ];
4144 foreach ( func_get_args() as $db ) {
4145 /** @var IDatabase $db */
4146 $status = $db->getSessionLagStatus();
4147 if ( $status['lag'] === false ) {
4148 $res['lag'] = false;
4149 } elseif ( $res['lag'] !== false ) {
4150 $res['lag'] = max( $res['lag'], $status['lag'] );
4152 $res['since'] = min( $res['since'], $status['since'] );
4153 $res['pending'] = $res['pending'] ?
: $db->writesPending();
4159 public function getLag() {
4163 public function maxListLen() {
4167 public function encodeBlob( $b ) {
4171 public function decodeBlob( $b ) {
4172 if ( $b instanceof Blob
) {
4178 public function setSessionOptions( array $options ) {
4181 public function sourceFile(
4183 callable
$lineCallback = null,
4184 callable
$resultCallback = null,
4186 callable
$inputCallback = null
4188 Wikimedia\
suppressWarnings();
4189 $fp = fopen( $filename, 'r' );
4190 Wikimedia\restoreWarnings
();
4192 if ( false === $fp ) {
4193 throw new RuntimeException( "Could not open \"{$filename}\".\n" );
4197 $fname = __METHOD__
. "( $filename )";
4201 $error = $this->sourceStream(
4202 $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
4203 } catch ( Exception
$e ) {
4213 public function setSchemaVars( $vars ) {
4214 $this->schemaVars
= $vars;
4217 public function sourceStream(
4219 callable
$lineCallback = null,
4220 callable
$resultCallback = null,
4221 $fname = __METHOD__
,
4222 callable
$inputCallback = null
4224 $delimiterReset = new ScopedCallback(
4225 function ( $delimiter ) {
4226 $this->delimiter
= $delimiter;
4228 [ $this->delimiter
]
4232 while ( !feof( $fp ) ) {
4233 if ( $lineCallback ) {
4234 call_user_func( $lineCallback );
4237 $line = trim( fgets( $fp ) );
4239 if ( $line == '' ) {
4243 if ( '-' == $line[0] && '-' == $line[1] ) {
4251 $done = $this->streamStatementEnd( $cmd, $line );
4255 if ( $done ||
feof( $fp ) ) {
4256 $cmd = $this->replaceVars( $cmd );
4258 if ( $inputCallback ) {
4259 $callbackResult = call_user_func( $inputCallback, $cmd );
4261 if ( is_string( $callbackResult ) ||
!$callbackResult ) {
4262 $cmd = $callbackResult;
4267 $res = $this->query( $cmd, $fname );
4269 if ( $resultCallback ) {
4270 call_user_func( $resultCallback, $res, $this );
4273 if ( false === $res ) {
4274 $err = $this->lastError();
4276 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
4283 ScopedCallback
::consume( $delimiterReset );
4288 * Called by sourceStream() to check if we've reached a statement end
4290 * @param string &$sql SQL assembled so far
4291 * @param string &$newLine New line about to be added to $sql
4292 * @return bool Whether $newLine contains end of the statement
4294 public function streamStatementEnd( &$sql, &$newLine ) {
4295 if ( $this->delimiter
) {
4297 $newLine = preg_replace(
4298 '/' . preg_quote( $this->delimiter
, '/' ) . '$/', '', $newLine );
4299 if ( $newLine != $prev ) {
4308 * Database independent variable replacement. Replaces a set of variables
4309 * in an SQL statement with their contents as given by $this->getSchemaVars().
4311 * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
4313 * - '{$var}' should be used for text and is passed through the database's
4315 * - `{$var}` should be used for identifiers (e.g. table and database names).
4316 * It is passed through the database's addIdentifierQuotes method which
4317 * can be overridden if the database uses something other than backticks.
4318 * - / *_* / or / *$wgDBprefix* / passes the name that follows through the
4319 * database's tableName method.
4320 * - / *i* / passes the name that follows through the database's indexName method.
4321 * - In all other cases, / *$var* / is left unencoded. Except for table options,
4322 * its use should be avoided. In 1.24 and older, string encoding was applied.
4324 * @param string $ins SQL statement to replace variables in
4325 * @return string The new SQL statement with variables replaced
4327 protected function replaceVars( $ins ) {
4328 $vars = $this->getSchemaVars();
4329 return preg_replace_callback(
4331 /\* (\$wgDBprefix|[_i]) \*/ (\w*) | # 1-2. tableName, indexName
4332 \'\{\$ (\w+) }\' | # 3. addQuotes
4333 `\{\$ (\w+) }` | # 4. addIdentifierQuotes
4334 /\*\$ (\w+) \*/ # 5. leave unencoded
4336 function ( $m ) use ( $vars ) {
4337 // Note: Because of <https://bugs.php.net/bug.php?id=51881>,
4338 // check for both nonexistent keys *and* the empty string.
4339 if ( isset( $m[1] ) && $m[1] !== '' ) {
4340 if ( $m[1] === 'i' ) {
4341 return $this->indexName( $m[2] );
4343 return $this->tableName( $m[2] );
4345 } elseif ( isset( $m[3] ) && $m[3] !== '' && array_key_exists( $m[3], $vars ) ) {
4346 return $this->addQuotes( $vars[$m[3]] );
4347 } elseif ( isset( $m[4] ) && $m[4] !== '' && array_key_exists( $m[4], $vars ) ) {
4348 return $this->addIdentifierQuotes( $vars[$m[4]] );
4349 } elseif ( isset( $m[5] ) && $m[5] !== '' && array_key_exists( $m[5], $vars ) ) {
4350 return $vars[$m[5]];
4360 * Get schema variables. If none have been set via setSchemaVars(), then
4361 * use some defaults from the current object.
4365 protected function getSchemaVars() {
4366 if ( $this->schemaVars
) {
4367 return $this->schemaVars
;
4369 return $this->getDefaultSchemaVars();
4374 * Get schema variables to use if none have been set via setSchemaVars().
4376 * Override this in derived classes to provide variables for tables.sql
4377 * and SQL patch files.
4381 protected function getDefaultSchemaVars() {
4385 public function lockIsFree( $lockName, $method ) {
4386 // RDBMs methods for checking named locks may or may not count this thread itself.
4387 // In MySQL, IS_FREE_LOCK() returns 0 if the thread already has the lock. This is
4388 // the behavior choosen by the interface for this method.
4389 return !isset( $this->namedLocksHeld
[$lockName] );
4392 public function lock( $lockName, $method, $timeout = 5 ) {
4393 $this->namedLocksHeld
[$lockName] = 1;
4398 public function unlock( $lockName, $method ) {
4399 unset( $this->namedLocksHeld
[$lockName] );
4404 public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
4405 if ( $this->writesOrCallbacksPending() ) {
4406 // This only flushes transactions to clear snapshots, not to write data
4407 $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
4408 throw new DBUnexpectedError(
4410 "$fname: Cannot flush pre-lock snapshot because writes are pending ($fnames)."
4414 if ( !$this->lock( $lockKey, $fname, $timeout ) ) {
4418 $unlocker = new ScopedCallback( function () use ( $lockKey, $fname ) {
4419 if ( $this->trxLevel() ) {
4420 // There is a good chance an exception was thrown, causing any early return
4421 // from the caller. Let any error handler get a chance to issue rollback().
4422 // If there isn't one, let the error bubble up and trigger server-side rollback.
4423 $this->onTransactionResolution(
4424 function () use ( $lockKey, $fname ) {
4425 $this->unlock( $lockKey, $fname );
4430 $this->unlock( $lockKey, $fname );
4434 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
4439 public function namedLocksEnqueue() {
4443 public function tableLocksHaveTransactionScope() {
4447 final public function lockTables( array $read, array $write, $method ) {
4448 if ( $this->writesOrCallbacksPending() ) {
4449 throw new DBUnexpectedError( $this, "Transaction writes or callbacks still pending." );
4452 if ( $this->tableLocksHaveTransactionScope() ) {
4453 $this->startAtomic( $method );
4456 return $this->doLockTables( $read, $write, $method );
4460 * Helper function for lockTables() that handles the actual table locking
4462 * @param array $read Array of tables to lock for read access
4463 * @param array $write Array of tables to lock for write access
4464 * @param string $method Name of caller
4467 protected function doLockTables( array $read, array $write, $method ) {
4471 final public function unlockTables( $method ) {
4472 if ( $this->tableLocksHaveTransactionScope() ) {
4473 $this->endAtomic( $method );
4475 return true; // locks released on COMMIT/ROLLBACK
4478 return $this->doUnlockTables( $method );
4482 * Helper function for unlockTables() that handles the actual table unlocking
4484 * @param string $method Name of caller
4487 protected function doUnlockTables( $method ) {
4493 * @param string $tableName
4494 * @param string $fName
4495 * @return bool|ResultWrapper
4498 public function dropTable( $tableName, $fName = __METHOD__
) {
4499 if ( !$this->tableExists( $tableName, $fName ) ) {
4502 $sql = "DROP TABLE " . $this->tableName( $tableName ) . " CASCADE";
4504 return $this->query( $sql, $fName );
4507 public function getInfinity() {
4511 public function encodeExpiry( $expiry ) {
4512 return ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() )
4513 ?
$this->getInfinity()
4514 : $this->timestamp( $expiry );
4517 public function decodeExpiry( $expiry, $format = TS_MW
) {
4518 if ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() ) {
4522 return ConvertibleTimestamp
::convert( $format, $expiry );
4525 public function setBigSelects( $value = true ) {
4529 public function isReadOnly() {
4530 return ( $this->getReadOnlyReason() !== false );
4534 * @return string|bool Reason this DB is read-only or false if it is not
4536 protected function getReadOnlyReason() {
4537 $reason = $this->getLBInfo( 'readOnlyReason' );
4539 return is_string( $reason ) ?
$reason : false;
4542 public function setTableAliases( array $aliases ) {
4543 $this->tableAliases
= $aliases;
4546 public function setIndexAliases( array $aliases ) {
4547 $this->indexAliases
= $aliases;
4551 * Get the underlying binding connection handle
4553 * Makes sure the connection resource is set (disconnects and ping() failure can unset it).
4554 * This catches broken callers than catch and ignore disconnection exceptions.
4555 * Unlike checking isOpen(), this is safe to call inside of open().
4558 * @throws DBUnexpectedError
4561 protected function getBindingHandle() {
4562 if ( !$this->conn
) {
4563 throw new DBUnexpectedError(
4565 'DB connection was already closed or the connection dropped.'
4576 public function __toString() {
4577 return (string)$this->conn
;
4581 * Make sure that copies do not share the same client binding handle
4582 * @throws DBConnectionError
4584 public function __clone() {
4585 $this->connLogger
->warning(
4586 "Cloning " . static::class . " is not recomended; forking connection:\n" .
4587 ( new RuntimeException() )->getTraceAsString()
4590 if ( $this->isOpen() ) {
4591 // Open a new connection resource without messing with the old one
4592 $this->opened
= false;
4593 $this->conn
= false;
4594 $this->trxEndCallbacks
= []; // don't copy
4595 $this->handleSessionLoss(); // no trx or locks anymore
4596 $this->open( $this->server
, $this->user
, $this->password
, $this->dbName
);
4597 $this->lastPing
= microtime( true );
4602 * Called by serialize. Throw an exception when DB connection is serialized.
4603 * This causes problems on some database engines because the connection is
4604 * not restored on unserialize.
4606 public function __sleep() {
4607 throw new RuntimeException( 'Database serialization may cause problems, since ' .
4608 'the connection is not restored on wakeup.' );
4612 * Run a few simple sanity checks and close dangling connections
4614 public function __destruct() {
4615 if ( $this->trxLevel
&& $this->trxDoneWrites
) {
4616 trigger_error( "Uncommitted DB writes (transaction from {$this->trxFname})." );
4619 $danglingWriters = $this->pendingWriteAndCallbackCallers();
4620 if ( $danglingWriters ) {
4621 $fnames = implode( ', ', $danglingWriters );
4622 trigger_error( "DB transaction writes or callbacks still pending ($fnames)." );
4625 if ( $this->conn
) {
4626 // Avoid connection leaks for sanity. Normally, resources close at script completion.
4627 // The connection might already be closed in zend/hhvm by now, so suppress warnings.
4628 Wikimedia\
suppressWarnings();
4629 $this->closeConnection();
4630 Wikimedia\restoreWarnings
();
4631 $this->conn
= false;
4632 $this->opened
= false;
4637 class_alias( Database
::class, 'DatabaseBase' ); // b/c for old name
4638 class_alias( Database
::class, 'Database' ); // b/c global alias