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 Wikimedia\ScopedCallback
;
31 use Wikimedia\Timestamp\ConvertibleTimestamp
;
35 use InvalidArgumentException
;
40 * Relational database abstraction object
45 abstract class Database
implements IDatabase
, IMaintainableDatabase
, LoggerAwareInterface
{
46 /** Number of times to re-try an operation in case of deadlock */
47 const DEADLOCK_TRIES
= 4;
48 /** Minimum time to wait before retry, in microseconds */
49 const DEADLOCK_DELAY_MIN
= 500000;
50 /** Maximum time to wait before retry */
51 const DEADLOCK_DELAY_MAX
= 1500000;
53 /** How long before it is worth doing a dummy query to test the connection */
55 const PING_QUERY
= 'SELECT 1 AS ping';
57 const TINY_WRITE_SEC
= .010;
58 const SLOW_WRITE_SEC
= .500;
59 const SMALL_WRITE_ROWS
= 100;
61 /** @var string SQL query */
62 protected $mLastQuery = '';
63 /** @var float|bool UNIX timestamp of last write query */
64 protected $mLastWriteTime = false;
65 /** @var string|bool */
66 protected $mPHPError = false;
75 /** @var array[] $aliases Map of (table => (dbname, schema, prefix) map) */
76 protected $tableAliases = [];
77 /** @var bool Whether this PHP instance is for a CLI script */
79 /** @var string Agent name for query profiling */
82 /** @var BagOStuff APC cache */
84 /** @var LoggerInterface */
85 protected $connLogger;
86 /** @var LoggerInterface */
87 protected $queryLogger;
88 /** @var callback Error logging callback */
89 protected $errorLogger;
91 /** @var resource|null Database connection */
92 protected $mConn = null;
94 protected $mOpened = false;
96 /** @var array[] List of (callable, method name) */
97 protected $mTrxIdleCallbacks = [];
98 /** @var array[] List of (callable, method name) */
99 protected $mTrxPreCommitCallbacks = [];
100 /** @var array[] List of (callable, method name) */
101 protected $mTrxEndCallbacks = [];
102 /** @var callable[] Map of (name => callable) */
103 protected $mTrxRecurringCallbacks = [];
104 /** @var bool Whether to suppress triggering of transaction end callbacks */
105 protected $mTrxEndCallbacksSuppressed = false;
108 protected $mTablePrefix = '';
110 protected $mSchema = '';
114 protected $mLBInfo = [];
115 /** @var bool|null */
116 protected $mDefaultBigSelects = null;
117 /** @var array|bool */
118 protected $mSchemaVars = false;
120 protected $mSessionVars = [];
121 /** @var array|null */
122 protected $preparedArgs;
123 /** @var string|bool|null Stashed value of html_errors INI setting */
124 protected $htmlErrors;
126 protected $delimiter = ';';
127 /** @var DatabaseDomain */
128 protected $currentDomain;
131 * Either 1 if a transaction is active or 0 otherwise.
132 * The other Trx fields may not be meaningfull if this is 0.
136 protected $mTrxLevel = 0;
138 * Either a short hexidecimal string if a transaction is active or ""
141 * @see Database::mTrxLevel
143 protected $mTrxShortId = '';
145 * The UNIX time that the transaction started. Callers can assume that if
146 * snapshot isolation is used, then the data is *at least* up to date to that
147 * point (possibly more up-to-date since the first SELECT defines the snapshot).
150 * @see Database::mTrxLevel
152 private $mTrxTimestamp = null;
153 /** @var float Lag estimate at the time of BEGIN */
154 private $mTrxReplicaLag = null;
156 * Remembers the function name given for starting the most recent transaction via begin().
157 * Used to provide additional context for error reporting.
160 * @see Database::mTrxLevel
162 private $mTrxFname = null;
164 * Record if possible write queries were done in the last transaction started
167 * @see Database::mTrxLevel
169 private $mTrxDoneWrites = false;
171 * Record if the current transaction was started implicitly due to DBO_TRX being set.
174 * @see Database::mTrxLevel
176 private $mTrxAutomatic = false;
178 * Array of levels of atomicity within transactions
182 private $mTrxAtomicLevels = [];
184 * Record if the current transaction was started implicitly by Database::startAtomic
188 private $mTrxAutomaticAtomic = false;
190 * Track the write query callers of the current transaction
194 private $mTrxWriteCallers = [];
196 * @var float Seconds spent in write queries for the current transaction
198 private $mTrxWriteDuration = 0.0;
200 * @var integer Number of write queries for the current transaction
202 private $mTrxWriteQueryCount = 0;
204 * @var float Like mTrxWriteQueryCount but excludes lock-bound, easy to replicate, queries
206 private $mTrxWriteAdjDuration = 0.0;
208 * @var integer Number of write queries counted in mTrxWriteAdjDuration
210 private $mTrxWriteAdjQueryCount = 0;
212 * @var float RTT time estimate
214 private $mRTTEstimate = 0.0;
216 /** @var array Map of (name => 1) for locks obtained via lock() */
217 private $mNamedLocksHeld = [];
218 /** @var array Map of (table name => 1) for TEMPORARY tables */
219 protected $mSessionTempTables = [];
221 /** @var IDatabase|null Lazy handle to the master DB this server replicates from */
222 private $lazyMasterHandle;
224 /** @var float UNIX timestamp */
225 protected $lastPing = 0.0;
227 /** @var int[] Prior mFlags values */
228 private $priorFlags = [];
230 /** @var object|string Class name or object With profileIn/profileOut methods */
232 /** @var TransactionProfiler */
233 protected $trxProfiler;
236 * Constructor and database handle and attempt to connect to the DB server
238 * IDatabase classes should not be constructed directly in external
239 * code. Database::factory() should be used instead.
241 * @param array $params Parameters passed from Database::factory()
243 function __construct( array $params ) {
244 $server = $params['host'];
245 $user = $params['user'];
246 $password = $params['password'];
247 $dbName = $params['dbname'];
249 $this->mSchema
= $params['schema'];
250 $this->mTablePrefix
= $params['tablePrefix'];
252 $this->cliMode
= $params['cliMode'];
253 // Agent name is added to SQL queries in a comment, so make sure it can't break out
254 $this->agent
= str_replace( '/', '-', $params['agent'] );
256 $this->mFlags
= $params['flags'];
257 if ( $this->mFlags
& self
::DBO_DEFAULT
) {
258 if ( $this->cliMode
) {
259 $this->mFlags
&= ~self
::DBO_TRX
;
261 $this->mFlags |
= self
::DBO_TRX
;
265 $this->mSessionVars
= $params['variables'];
267 $this->srvCache
= isset( $params['srvCache'] )
268 ?
$params['srvCache']
269 : new HashBagOStuff();
271 $this->profiler
= $params['profiler'];
272 $this->trxProfiler
= $params['trxProfiler'];
273 $this->connLogger
= $params['connLogger'];
274 $this->queryLogger
= $params['queryLogger'];
275 $this->errorLogger
= $params['errorLogger'];
277 // Set initial dummy domain until open() sets the final DB/prefix
278 $this->currentDomain
= DatabaseDomain
::newUnspecified();
281 $this->open( $server, $user, $password, $dbName );
282 } elseif ( $this->requiresDatabaseUser() ) {
283 throw new InvalidArgumentException( "No database user provided." );
286 // Set the domain object after open() sets the relevant fields
287 if ( $this->mDBname
!= '' ) {
288 // Domains with server scope but a table prefix are not used by IDatabase classes
289 $this->currentDomain
= new DatabaseDomain( $this->mDBname
, null, $this->mTablePrefix
);
294 * Construct a Database subclass instance given a database type and parameters
296 * This also connects to the database immediately upon object construction
298 * @param string $dbType A possible DB type (sqlite, mysql, postgres)
299 * @param array $p Parameter map with keys:
300 * - host : The hostname of the DB server
301 * - user : The name of the database user the client operates under
302 * - password : The password for the database user
303 * - dbname : The name of the database to use where queries do not specify one.
304 * The database must exist or an error might be thrown. Setting this to the empty string
305 * will avoid any such errors and make the handle have no implicit database scope. This is
306 * useful for queries like SHOW STATUS, CREATE DATABASE, or DROP DATABASE. Note that a
307 * "database" in Postgres is rougly equivalent to an entire MySQL server. This the domain
308 * in which user names and such are defined, e.g. users are database-specific in Postgres.
309 * - schema : The database schema to use (if supported). A "schema" in Postgres is roughly
310 * equivalent to a "database" in MySQL. Note that MySQL and SQLite do not use schemas.
311 * - tablePrefix : Optional table prefix that is implicitly added on to all table names
312 * recognized in queries. This can be used in place of schemas for handle site farms.
313 * - flags : Optional bitfield of DBO_* constants that define connection, protocol,
314 * buffering, and transaction behavior. It is STRONGLY adviced to leave the DBO_DEFAULT
315 * flag in place UNLESS this this database simply acts as a key/value store.
316 * - driver: Optional name of a specific DB client driver. For MySQL, there is the old
317 * 'mysql' driver and the newer 'mysqli' driver.
318 * - variables: Optional map of session variables to set after connecting. This can be
319 * used to adjust lock timeouts or encoding modes and the like.
320 * - connLogger: Optional PSR-3 logger interface instance.
321 * - queryLogger: Optional PSR-3 logger interface instance.
322 * - profiler: Optional class name or object with profileIn()/profileOut() methods.
323 * These will be called in query(), using a simplified version of the SQL that also
324 * includes the agent as a SQL comment.
325 * - trxProfiler: Optional TransactionProfiler instance.
326 * - errorLogger: Optional callback that takes an Exception and logs it.
327 * - cliMode: Whether to consider the execution context that of a CLI script.
328 * - agent: Optional name used to identify the end-user in query profiling/logging.
329 * - srvCache: Optional BagOStuff instance to an APC-style cache.
330 * @return Database|null If the database driver or extension cannot be found
331 * @throws InvalidArgumentException If the database driver or extension cannot be found
334 final public static function factory( $dbType, $p = [] ) {
335 static $canonicalDBTypes = [
336 'mysql' => [ 'mysqli', 'mysql' ],
342 static $classAliases = [
343 'DatabaseMssql' => DatabaseMssql
::class,
344 'DatabaseMysql' => DatabaseMysql
::class,
345 'DatabaseMysqli' => DatabaseMysqli
::class,
346 'DatabaseSqlite' => DatabaseSqlite
::class,
347 'DatabasePostgres' => DatabasePostgres
::class
351 $dbType = strtolower( $dbType );
352 if ( isset( $canonicalDBTypes[$dbType] ) && $canonicalDBTypes[$dbType] ) {
353 $possibleDrivers = $canonicalDBTypes[$dbType];
354 if ( !empty( $p['driver'] ) ) {
355 if ( in_array( $p['driver'], $possibleDrivers ) ) {
356 $driver = $p['driver'];
358 throw new InvalidArgumentException( __METHOD__
.
359 " type '$dbType' does not support driver '{$p['driver']}'" );
362 foreach ( $possibleDrivers as $posDriver ) {
363 if ( extension_loaded( $posDriver ) ) {
364 $driver = $posDriver;
373 if ( $driver === false ||
$driver === '' ) {
374 throw new InvalidArgumentException( __METHOD__
.
375 " no viable database extension found for type '$dbType'" );
378 $class = 'Database' . ucfirst( $driver );
379 if ( isset( $classAliases[$class] ) ) {
380 $class = $classAliases[$class];
383 if ( class_exists( $class ) && is_subclass_of( $class, IDatabase
::class ) ) {
384 // Resolve some defaults for b/c
385 $p['host'] = isset( $p['host'] ) ?
$p['host'] : false;
386 $p['user'] = isset( $p['user'] ) ?
$p['user'] : false;
387 $p['password'] = isset( $p['password'] ) ?
$p['password'] : false;
388 $p['dbname'] = isset( $p['dbname'] ) ?
$p['dbname'] : false;
389 $p['flags'] = isset( $p['flags'] ) ?
$p['flags'] : 0;
390 $p['variables'] = isset( $p['variables'] ) ?
$p['variables'] : [];
391 $p['tablePrefix'] = isset( $p['tablePrefix'] ) ?
$p['tablePrefix'] : '';
392 $p['schema'] = isset( $p['schema'] ) ?
$p['schema'] : '';
393 $p['cliMode'] = isset( $p['cliMode'] ) ?
$p['cliMode'] : ( PHP_SAPI
=== 'cli' );
394 $p['agent'] = isset( $p['agent'] ) ?
$p['agent'] : '';
395 if ( !isset( $p['connLogger'] ) ) {
396 $p['connLogger'] = new \Psr\Log\
NullLogger();
398 if ( !isset( $p['queryLogger'] ) ) {
399 $p['queryLogger'] = new \Psr\Log\
NullLogger();
401 $p['profiler'] = isset( $p['profiler'] ) ?
$p['profiler'] : null;
402 if ( !isset( $p['trxProfiler'] ) ) {
403 $p['trxProfiler'] = new TransactionProfiler();
405 if ( !isset( $p['errorLogger'] ) ) {
406 $p['errorLogger'] = function ( Exception
$e ) {
407 trigger_error( get_class( $e ) . ': ' . $e->getMessage(), E_USER_WARNING
);
411 $conn = new $class( $p );
419 public function setLogger( LoggerInterface
$logger ) {
420 $this->queryLogger
= $logger;
423 public function getServerInfo() {
424 return $this->getServerVersion();
427 public function bufferResults( $buffer = null ) {
428 $res = !$this->getFlag( self
::DBO_NOBUFFER
);
429 if ( $buffer !== null ) {
431 ?
$this->clearFlag( self
::DBO_NOBUFFER
)
432 : $this->setFlag( self
::DBO_NOBUFFER
);
439 * Turns on (false) or off (true) the automatic generation and sending
440 * of a "we're sorry, but there has been a database error" page on
441 * database errors. Default is on (false). When turned off, the
442 * code should use lastErrno() and lastError() to handle the
443 * situation as appropriate.
445 * Do not use this function outside of the Database classes.
447 * @param null|bool $ignoreErrors
448 * @return bool The previous value of the flag.
450 protected function ignoreErrors( $ignoreErrors = null ) {
451 $res = $this->getFlag( self
::DBO_IGNORE
);
452 if ( $ignoreErrors !== null ) {
454 ?
$this->setFlag( self
::DBO_IGNORE
)
455 : $this->clearFlag( self
::DBO_IGNORE
);
461 public function trxLevel() {
462 return $this->mTrxLevel
;
465 public function trxTimestamp() {
466 return $this->mTrxLevel ?
$this->mTrxTimestamp
: null;
469 public function tablePrefix( $prefix = null ) {
470 $old = $this->mTablePrefix
;
471 if ( $prefix !== null ) {
472 $this->mTablePrefix
= $prefix;
473 $this->currentDomain
= ( $this->mDBname
!= '' )
474 ?
new DatabaseDomain( $this->mDBname
, null, $this->mTablePrefix
)
475 : DatabaseDomain
::newUnspecified();
481 public function dbSchema( $schema = null ) {
482 $old = $this->mSchema
;
483 if ( $schema !== null ) {
484 $this->mSchema
= $schema;
490 public function getLBInfo( $name = null ) {
491 if ( is_null( $name ) ) {
492 return $this->mLBInfo
;
494 if ( array_key_exists( $name, $this->mLBInfo
) ) {
495 return $this->mLBInfo
[$name];
502 public function setLBInfo( $name, $value = null ) {
503 if ( is_null( $value ) ) {
504 $this->mLBInfo
= $name;
506 $this->mLBInfo
[$name] = $value;
510 public function setLazyMasterHandle( IDatabase
$conn ) {
511 $this->lazyMasterHandle
= $conn;
515 * @return IDatabase|null
516 * @see setLazyMasterHandle()
519 protected function getLazyMasterHandle() {
520 return $this->lazyMasterHandle
;
523 public function implicitGroupby() {
527 public function implicitOrderby() {
531 public function lastQuery() {
532 return $this->mLastQuery
;
535 public function doneWrites() {
536 return (bool)$this->mLastWriteTime
;
539 public function lastDoneWrites() {
540 return $this->mLastWriteTime ?
: false;
543 public function writesPending() {
544 return $this->mTrxLevel
&& $this->mTrxDoneWrites
;
547 public function writesOrCallbacksPending() {
548 return $this->mTrxLevel
&& (
549 $this->mTrxDoneWrites ||
$this->mTrxIdleCallbacks ||
$this->mTrxPreCommitCallbacks
553 public function pendingWriteQueryDuration( $type = self
::ESTIMATE_TOTAL
) {
554 if ( !$this->mTrxLevel
) {
556 } elseif ( !$this->mTrxDoneWrites
) {
561 case self
::ESTIMATE_DB_APPLY
:
563 $rttAdjTotal = $this->mTrxWriteAdjQueryCount
* $rtt;
564 $applyTime = max( $this->mTrxWriteAdjDuration
- $rttAdjTotal, 0 );
565 // For omitted queries, make them count as something at least
566 $omitted = $this->mTrxWriteQueryCount
- $this->mTrxWriteAdjQueryCount
;
567 $applyTime +
= self
::TINY_WRITE_SEC
* $omitted;
570 default: // everything
571 return $this->mTrxWriteDuration
;
575 public function pendingWriteCallers() {
576 return $this->mTrxLevel ?
$this->mTrxWriteCallers
: [];
579 protected function pendingWriteAndCallbackCallers() {
580 if ( !$this->mTrxLevel
) {
584 $fnames = $this->mTrxWriteCallers
;
586 $this->mTrxIdleCallbacks
,
587 $this->mTrxPreCommitCallbacks
,
588 $this->mTrxEndCallbacks
590 foreach ( $callbacks as $callback ) {
591 $fnames[] = $callback[1];
598 public function isOpen() {
599 return $this->mOpened
;
602 public function setFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
603 if ( $remember === self
::REMEMBER_PRIOR
) {
604 array_push( $this->priorFlags
, $this->mFlags
);
606 $this->mFlags |
= $flag;
609 public function clearFlag( $flag, $remember = self
::REMEMBER_NOTHING
) {
610 if ( $remember === self
::REMEMBER_PRIOR
) {
611 array_push( $this->priorFlags
, $this->mFlags
);
613 $this->mFlags
&= ~
$flag;
616 public function restoreFlags( $state = self
::RESTORE_PRIOR
) {
617 if ( !$this->priorFlags
) {
621 if ( $state === self
::RESTORE_INITIAL
) {
622 $this->mFlags
= reset( $this->priorFlags
);
623 $this->priorFlags
= [];
625 $this->mFlags
= array_pop( $this->priorFlags
);
629 public function getFlag( $flag ) {
630 return !!( $this->mFlags
& $flag );
634 * @param string $name Class field name
636 * @deprecated Since 1.28
638 public function getProperty( $name ) {
642 public function getDomainID() {
643 return $this->currentDomain
->getId();
646 final public function getWikiID() {
647 return $this->getDomainID();
651 * Get information about an index into an object
652 * @param string $table Table name
653 * @param string $index Index name
654 * @param string $fname Calling function name
655 * @return mixed Database-specific index description class or false if the index does not exist
657 abstract function indexInfo( $table, $index, $fname = __METHOD__
);
660 * Wrapper for addslashes()
662 * @param string $s String to be slashed.
663 * @return string Slashed string.
665 abstract function strencode( $s );
667 protected function installErrorHandler() {
668 $this->mPHPError
= false;
669 $this->htmlErrors
= ini_set( 'html_errors', '0' );
670 set_error_handler( [ $this, 'connectionErrorLogger' ] );
674 * @return bool|string
676 protected function restoreErrorHandler() {
677 restore_error_handler();
678 if ( $this->htmlErrors
!== false ) {
679 ini_set( 'html_errors', $this->htmlErrors
);
682 return $this->getLastPHPError();
686 * @return string|bool Last PHP error for this DB (typically connection errors)
688 protected function getLastPHPError() {
689 if ( $this->mPHPError
) {
690 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->mPHPError
);
691 $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
700 * This method should not be used outside of Database classes
703 * @param string $errstr
705 public function connectionErrorLogger( $errno, $errstr ) {
706 $this->mPHPError
= $errstr;
710 * Create a log context to pass to PSR-3 logger functions.
712 * @param array $extras Additional data to add to context
715 protected function getLogContext( array $extras = [] ) {
718 'db_server' => $this->mServer
,
719 'db_name' => $this->mDBname
,
720 'db_user' => $this->mUser
,
726 public function close() {
727 if ( $this->mConn
) {
728 if ( $this->trxLevel() ) {
729 $this->commit( __METHOD__
, self
::FLUSHING_INTERNAL
);
732 $closed = $this->closeConnection();
733 $this->mConn
= false;
734 } elseif ( $this->mTrxIdleCallbacks ||
$this->mTrxEndCallbacks
) { // sanity
735 throw new RuntimeException( "Transaction callbacks still pending." );
739 $this->mOpened
= false;
745 * Make sure isOpen() returns true as a sanity check
747 * @throws DBUnexpectedError
749 protected function assertOpen() {
750 if ( !$this->isOpen() ) {
751 throw new DBUnexpectedError( $this, "DB connection was already closed." );
756 * Closes underlying database connection
758 * @return bool Whether connection was closed successfully
760 abstract protected function closeConnection();
762 public function reportConnectionError( $error = 'Unknown error' ) {
763 $myError = $this->lastError();
769 throw new DBConnectionError( $this, $error );
773 * The DBMS-dependent part of query()
775 * @param string $sql SQL query.
776 * @return ResultWrapper|bool Result object to feed to fetchObject,
777 * fetchRow, ...; or false on failure
779 abstract protected function doQuery( $sql );
782 * Determine whether a query writes to the DB.
783 * Should return true if unsure.
788 protected function isWriteQuery( $sql ) {
790 '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SET|SHOW|EXPLAIN|\(SELECT)\b/i', $sql );
795 * @return string|null
797 protected function getQueryVerb( $sql ) {
798 return preg_match( '/^\s*([a-z]+)/i', $sql, $m ) ?
strtoupper( $m[1] ) : null;
802 * Determine whether a SQL statement is sensitive to isolation level.
803 * A SQL statement is considered transactable if its result could vary
804 * depending on the transaction isolation level. Operational commands
805 * such as 'SET' and 'SHOW' are not considered to be transactable.
810 protected function isTransactableQuery( $sql ) {
812 $this->getQueryVerb( $sql ),
813 [ 'BEGIN', 'COMMIT', 'ROLLBACK', 'SHOW', 'SET', 'CREATE', 'ALTER' ],
819 * @param string $sql A SQL query
820 * @return bool Whether $sql is SQL for creating/dropping a new TEMPORARY table
822 protected function registerTempTableOperation( $sql ) {
824 '/^CREATE\s+TEMPORARY\s+TABLE\s+(?:IF\s+NOT\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
828 $this->mSessionTempTables
[$matches[1]] = 1;
831 } elseif ( preg_match(
832 '/^DROP\s+(?:TEMPORARY\s+)?TABLE\s+(?:IF\s+EXISTS\s+)?[`"\']?(\w+)[`"\']?/i',
836 unset( $this->mSessionTempTables
[$matches[1]] );
839 } elseif ( preg_match(
840 '/^(?:INSERT\s+(?:\w+\s+)?INTO|UPDATE|DELETE\s+FROM)\s+[`"\']?(\w+)[`"\']?/i',
844 return isset( $this->mSessionTempTables
[$matches[1]] );
850 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false ) {
851 $priorWritesPending = $this->writesOrCallbacksPending();
852 $this->mLastQuery
= $sql;
854 $isWrite = $this->isWriteQuery( $sql ) && !$this->registerTempTableOperation( $sql );
856 $reason = $this->getReadOnlyReason();
857 if ( $reason !== false ) {
858 throw new DBReadOnlyError( $this, "Database is read-only: $reason" );
860 # Set a flag indicating that writes have been done
861 $this->mLastWriteTime
= microtime( true );
864 // Add trace comment to the begin of the sql string, right after the operator.
865 // Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (T44598)
866 $commentedSql = preg_replace( '/\s|$/', " /* $fname {$this->agent} */ ", $sql, 1 );
868 # Start implicit transactions that wrap the request if DBO_TRX is enabled
869 if ( !$this->mTrxLevel
&& $this->getFlag( self
::DBO_TRX
)
870 && $this->isTransactableQuery( $sql )
872 $this->begin( __METHOD__
. " ($fname)", self
::TRANSACTION_INTERNAL
);
873 $this->mTrxAutomatic
= true;
876 # Keep track of whether the transaction has write queries pending
877 if ( $this->mTrxLevel
&& !$this->mTrxDoneWrites
&& $isWrite ) {
878 $this->mTrxDoneWrites
= true;
879 $this->trxProfiler
->transactionWritingIn(
880 $this->mServer
, $this->mDBname
, $this->mTrxShortId
);
883 if ( $this->getFlag( self
::DBO_DEBUG
) ) {
884 $this->queryLogger
->debug( "{$this->mDBname} {$commentedSql}" );
887 # Avoid fatals if close() was called
890 # Send the query to the server
891 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isWrite, $fname );
893 # Try reconnecting if the connection was lost
894 if ( false === $ret && $this->wasErrorReissuable() ) {
895 $recoverable = $this->canRecoverFromDisconnect( $sql, $priorWritesPending );
896 # Stash the last error values before anything might clear them
897 $lastError = $this->lastError();
898 $lastErrno = $this->lastErrno();
899 # Update state tracking to reflect transaction loss due to disconnection
900 $this->handleSessionLoss();
901 if ( $this->reconnect() ) {
902 $msg = __METHOD__
. ": lost connection to {$this->getServer()}; reconnected";
903 $this->connLogger
->warning( $msg );
904 $this->queryLogger
->warning(
905 "$msg:\n" . ( new RuntimeException() )->getTraceAsString() );
907 if ( !$recoverable ) {
908 # Callers may catch the exception and continue to use the DB
909 $this->reportQueryError( $lastError, $lastErrno, $sql, $fname );
911 # Should be safe to silently retry the query
912 $ret = $this->doProfiledQuery( $sql, $commentedSql, $isWrite, $fname );
915 $msg = __METHOD__
. ": lost connection to {$this->getServer()} permanently";
916 $this->connLogger
->error( $msg );
920 if ( false === $ret ) {
921 # Deadlocks cause the entire transaction to abort, not just the statement.
922 # https://dev.mysql.com/doc/refman/5.7/en/innodb-error-handling.html
923 # https://www.postgresql.org/docs/9.1/static/explicit-locking.html
924 if ( $this->wasDeadlock() ) {
925 if ( $this->explicitTrxActive() ||
$priorWritesPending ) {
926 $tempIgnore = false; // not recoverable
928 # Update state tracking to reflect transaction loss
929 $this->handleSessionLoss();
932 $this->reportQueryError(
933 $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
936 $res = $this->resultObject( $ret );
941 private function doProfiledQuery( $sql, $commentedSql, $isWrite, $fname ) {
942 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
943 # generalizeSQL() will probably cut down the query to reasonable
944 # logging size most of the time. The substr is really just a sanity check.
946 $queryProf = 'query-m: ' . substr( self
::generalizeSQL( $sql ), 0, 255 );
948 $queryProf = 'query: ' . substr( self
::generalizeSQL( $sql ), 0, 255 );
951 # Include query transaction state
952 $queryProf .= $this->mTrxShortId ?
" [TRX#{$this->mTrxShortId}]" : "";
954 $startTime = microtime( true );
955 if ( $this->profiler
) {
956 call_user_func( [ $this->profiler
, 'profileIn' ], $queryProf );
958 $ret = $this->doQuery( $commentedSql );
959 if ( $this->profiler
) {
960 call_user_func( [ $this->profiler
, 'profileOut' ], $queryProf );
962 $queryRuntime = max( microtime( true ) - $startTime, 0.0 );
964 unset( $queryProfSection ); // profile out (if set)
966 if ( $ret !== false ) {
967 $this->lastPing
= $startTime;
968 if ( $isWrite && $this->mTrxLevel
) {
969 $this->updateTrxWriteQueryTime( $sql, $queryRuntime );
970 $this->mTrxWriteCallers
[] = $fname;
974 if ( $sql === self
::PING_QUERY
) {
975 $this->mRTTEstimate
= $queryRuntime;
978 $this->trxProfiler
->recordQueryCompletion(
979 $queryProf, $startTime, $isWrite, $this->affectedRows()
981 $this->queryLogger
->debug( $sql, [
983 'master' => $isMaster,
984 'runtime' => $queryRuntime,
991 * Update the estimated run-time of a query, not counting large row lock times
993 * LoadBalancer can be set to rollback transactions that will create huge replication
994 * lag. It bases this estimate off of pendingWriteQueryDuration(). Certain simple
995 * queries, like inserting a row can take a long time due to row locking. This method
996 * uses some simple heuristics to discount those cases.
998 * @param string $sql A SQL write query
999 * @param float $runtime Total runtime, including RTT
1001 private function updateTrxWriteQueryTime( $sql, $runtime ) {
1002 // Whether this is indicative of replica DB runtime (except for RBR or ws_repl)
1003 $indicativeOfReplicaRuntime = true;
1004 if ( $runtime > self
::SLOW_WRITE_SEC
) {
1005 $verb = $this->getQueryVerb( $sql );
1006 // insert(), upsert(), replace() are fast unless bulky in size or blocked on locks
1007 if ( $verb === 'INSERT' ) {
1008 $indicativeOfReplicaRuntime = $this->affectedRows() > self
::SMALL_WRITE_ROWS
;
1009 } elseif ( $verb === 'REPLACE' ) {
1010 $indicativeOfReplicaRuntime = $this->affectedRows() > self
::SMALL_WRITE_ROWS
/ 2;
1014 $this->mTrxWriteDuration +
= $runtime;
1015 $this->mTrxWriteQueryCount +
= 1;
1016 if ( $indicativeOfReplicaRuntime ) {
1017 $this->mTrxWriteAdjDuration +
= $runtime;
1018 $this->mTrxWriteAdjQueryCount +
= 1;
1022 private function canRecoverFromDisconnect( $sql, $priorWritesPending ) {
1023 # Transaction dropped; this can mean lost writes, or REPEATABLE-READ snapshots.
1024 # Dropped connections also mean that named locks are automatically released.
1025 # Only allow error suppression in autocommit mode or when the lost transaction
1026 # didn't matter anyway (aside from DBO_TRX snapshot loss).
1027 if ( $this->mNamedLocksHeld
) {
1028 return false; // possible critical section violation
1029 } elseif ( $sql === 'COMMIT' ) {
1030 return !$priorWritesPending; // nothing written anyway? (T127428)
1031 } elseif ( $sql === 'ROLLBACK' ) {
1032 return true; // transaction lost...which is also what was requested :)
1033 } elseif ( $this->explicitTrxActive() ) {
1034 return false; // don't drop atomocity
1035 } elseif ( $priorWritesPending ) {
1036 return false; // prior writes lost from implicit transaction
1042 private function handleSessionLoss() {
1043 $this->mTrxLevel
= 0;
1044 $this->mTrxIdleCallbacks
= []; // T67263
1045 $this->mTrxPreCommitCallbacks
= []; // T67263
1046 $this->mSessionTempTables
= [];
1047 $this->mNamedLocksHeld
= [];
1049 // Handle callbacks in mTrxEndCallbacks
1050 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_ROLLBACK
);
1051 $this->runTransactionListenerCallbacks( self
::TRIGGER_ROLLBACK
);
1053 } catch ( Exception
$e ) {
1054 // Already logged; move on...
1059 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1060 if ( $this->ignoreErrors() ||
$tempIgnore ) {
1061 $this->queryLogger
->debug( "SQL ERROR (ignored): $error\n" );
1063 $sql1line = mb_substr( str_replace( "\n", "\\n", $sql ), 0, 5 * 1024 );
1064 $this->queryLogger
->error(
1065 "{fname}\t{db_server}\t{errno}\t{error}\t{sql1line}",
1066 $this->getLogContext( [
1067 'method' => __METHOD__
,
1070 'sql1line' => $sql1line,
1074 $this->queryLogger
->debug( "SQL ERROR: " . $error . "\n" );
1075 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
1079 public function freeResult( $res ) {
1082 public function selectField(
1083 $table, $var, $cond = '', $fname = __METHOD__
, $options = []
1085 if ( $var === '*' ) { // sanity
1086 throw new DBUnexpectedError( $this, "Cannot use a * field: got '$var'" );
1089 if ( !is_array( $options ) ) {
1090 $options = [ $options ];
1093 $options['LIMIT'] = 1;
1095 $res = $this->select( $table, $var, $cond, $fname, $options );
1096 if ( $res === false ||
!$this->numRows( $res ) ) {
1100 $row = $this->fetchRow( $res );
1102 if ( $row !== false ) {
1103 return reset( $row );
1109 public function selectFieldValues(
1110 $table, $var, $cond = '', $fname = __METHOD__
, $options = [], $join_conds = []
1112 if ( $var === '*' ) { // sanity
1113 throw new DBUnexpectedError( $this, "Cannot use a * field" );
1114 } elseif ( !is_string( $var ) ) { // sanity
1115 throw new DBUnexpectedError( $this, "Cannot use an array of fields" );
1118 if ( !is_array( $options ) ) {
1119 $options = [ $options ];
1122 $res = $this->select( $table, $var, $cond, $fname, $options, $join_conds );
1123 if ( $res === false ) {
1128 foreach ( $res as $row ) {
1129 $values[] = $row->$var;
1136 * Returns an optional USE INDEX clause to go after the table, and a
1137 * string to go at the end of the query.
1139 * @param array $options Associative array of options to be turned into
1140 * an SQL query, valid keys are listed in the function.
1142 * @see Database::select()
1144 protected function makeSelectOptions( $options ) {
1145 $preLimitTail = $postLimitTail = '';
1150 foreach ( $options as $key => $option ) {
1151 if ( is_numeric( $key ) ) {
1152 $noKeyOptions[$option] = true;
1156 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1158 $preLimitTail .= $this->makeOrderBy( $options );
1160 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1161 $postLimitTail .= ' FOR UPDATE';
1164 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1165 $postLimitTail .= ' LOCK IN SHARE MODE';
1168 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) {
1169 $startOpts .= 'DISTINCT';
1172 # Various MySQL extensions
1173 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1174 $startOpts .= ' /*! STRAIGHT_JOIN */';
1177 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1178 $startOpts .= ' HIGH_PRIORITY';
1181 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1182 $startOpts .= ' SQL_BIG_RESULT';
1185 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1186 $startOpts .= ' SQL_BUFFER_RESULT';
1189 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1190 $startOpts .= ' SQL_SMALL_RESULT';
1193 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1194 $startOpts .= ' SQL_CALC_FOUND_ROWS';
1197 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1198 $startOpts .= ' SQL_CACHE';
1201 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1202 $startOpts .= ' SQL_NO_CACHE';
1205 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1206 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1210 if ( isset( $options['IGNORE INDEX'] ) && is_string( $options['IGNORE INDEX'] ) ) {
1211 $ignoreIndex = $this->ignoreIndexClause( $options['IGNORE INDEX'] );
1216 return [ $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ];
1220 * Returns an optional GROUP BY with an optional HAVING
1222 * @param array $options Associative array of options
1224 * @see Database::select()
1227 protected function makeGroupByWithHaving( $options ) {
1229 if ( isset( $options['GROUP BY'] ) ) {
1230 $gb = is_array( $options['GROUP BY'] )
1231 ?
implode( ',', $options['GROUP BY'] )
1232 : $options['GROUP BY'];
1233 $sql .= ' GROUP BY ' . $gb;
1235 if ( isset( $options['HAVING'] ) ) {
1236 $having = is_array( $options['HAVING'] )
1237 ?
$this->makeList( $options['HAVING'], self
::LIST_AND
)
1238 : $options['HAVING'];
1239 $sql .= ' HAVING ' . $having;
1246 * Returns an optional ORDER BY
1248 * @param array $options Associative array of options
1250 * @see Database::select()
1253 protected function makeOrderBy( $options ) {
1254 if ( isset( $options['ORDER BY'] ) ) {
1255 $ob = is_array( $options['ORDER BY'] )
1256 ?
implode( ',', $options['ORDER BY'] )
1257 : $options['ORDER BY'];
1259 return ' ORDER BY ' . $ob;
1265 public function select( $table, $vars, $conds = '', $fname = __METHOD__
,
1266 $options = [], $join_conds = [] ) {
1267 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1269 return $this->query( $sql, $fname );
1272 public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__
,
1273 $options = [], $join_conds = []
1275 if ( is_array( $vars ) ) {
1276 $vars = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1279 $options = (array)$options;
1280 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1281 ?
$options['USE INDEX']
1284 isset( $options['IGNORE INDEX'] ) &&
1285 is_array( $options['IGNORE INDEX'] )
1287 ?
$options['IGNORE INDEX']
1290 if ( is_array( $table ) ) {
1292 $this->tableNamesWithIndexClauseOrJOIN(
1293 $table, $useIndexes, $ignoreIndexes, $join_conds );
1294 } elseif ( $table != '' ) {
1295 if ( $table[0] == ' ' ) {
1296 $from = ' FROM ' . $table;
1299 $this->tableNamesWithIndexClauseOrJOIN(
1300 [ $table ], $useIndexes, $ignoreIndexes, [] );
1306 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail, $ignoreIndex ) =
1307 $this->makeSelectOptions( $options );
1309 if ( !empty( $conds ) ) {
1310 if ( is_array( $conds ) ) {
1311 $conds = $this->makeList( $conds, self
::LIST_AND
);
1313 $sql = "SELECT $startOpts $vars $from $useIndex $ignoreIndex " .
1314 "WHERE $conds $preLimitTail";
1316 $sql = "SELECT $startOpts $vars $from $useIndex $ignoreIndex $preLimitTail";
1319 if ( isset( $options['LIMIT'] ) ) {
1320 $sql = $this->limitResult( $sql, $options['LIMIT'],
1321 isset( $options['OFFSET'] ) ?
$options['OFFSET'] : false );
1323 $sql = "$sql $postLimitTail";
1325 if ( isset( $options['EXPLAIN'] ) ) {
1326 $sql = 'EXPLAIN ' . $sql;
1332 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
1333 $options = [], $join_conds = []
1335 $options = (array)$options;
1336 $options['LIMIT'] = 1;
1337 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1339 if ( $res === false ) {
1343 if ( !$this->numRows( $res ) ) {
1347 $obj = $this->fetchObject( $res );
1352 public function estimateRowCount(
1353 $table, $vars = '*', $conds = '', $fname = __METHOD__
, $options = []
1356 $res = $this->select( $table, [ 'rowcount' => 'COUNT(*)' ], $conds, $fname, $options );
1359 $row = $this->fetchRow( $res );
1360 $rows = ( isset( $row['rowcount'] ) ) ?
(int)$row['rowcount'] : 0;
1366 public function selectRowCount(
1367 $tables, $vars = '*', $conds = '', $fname = __METHOD__
, $options = [], $join_conds = []
1370 $sql = $this->selectSQLText( $tables, '1', $conds, $fname, $options, $join_conds );
1371 // The identifier quotes is primarily for MSSQL.
1372 $rowCountCol = $this->addIdentifierQuotes( "rowcount" );
1373 $tableName = $this->addIdentifierQuotes( "tmp_count" );
1374 $res = $this->query( "SELECT COUNT(*) AS $rowCountCol FROM ($sql) $tableName", $fname );
1377 $row = $this->fetchRow( $res );
1378 $rows = ( isset( $row['rowcount'] ) ) ?
(int)$row['rowcount'] : 0;
1385 * Removes most variables from an SQL query and replaces them with X or N for numbers.
1386 * It's only slightly flawed. Don't use for anything important.
1388 * @param string $sql A SQL Query
1392 protected static function generalizeSQL( $sql ) {
1393 # This does the same as the regexp below would do, but in such a way
1394 # as to avoid crashing php on some large strings.
1395 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
1397 $sql = str_replace( "\\\\", '', $sql );
1398 $sql = str_replace( "\\'", '', $sql );
1399 $sql = str_replace( "\\\"", '', $sql );
1400 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
1401 $sql = preg_replace( '/".*"/s', "'X'", $sql );
1403 # All newlines, tabs, etc replaced by single space
1404 $sql = preg_replace( '/\s+/', ' ', $sql );
1407 # except the ones surrounded by characters, e.g. l10n
1408 $sql = preg_replace( '/-?\d+(,-?\d+)+/s', 'N,...,N', $sql );
1409 $sql = preg_replace( '/(?<![a-zA-Z])-?\d+(?![a-zA-Z])/s', 'N', $sql );
1414 public function fieldExists( $table, $field, $fname = __METHOD__
) {
1415 $info = $this->fieldInfo( $table, $field );
1420 public function indexExists( $table, $index, $fname = __METHOD__
) {
1421 if ( !$this->tableExists( $table ) ) {
1425 $info = $this->indexInfo( $table, $index, $fname );
1426 if ( is_null( $info ) ) {
1429 return $info !== false;
1433 public function tableExists( $table, $fname = __METHOD__
) {
1434 $tableRaw = $this->tableName( $table, 'raw' );
1435 if ( isset( $this->mSessionTempTables
[$tableRaw] ) ) {
1436 return true; // already known to exist
1439 $table = $this->tableName( $table );
1440 $ignoreErrors = true;
1441 $res = $this->query( "SELECT 1 FROM $table LIMIT 1", $fname, $ignoreErrors );
1446 public function indexUnique( $table, $index ) {
1447 $indexInfo = $this->indexInfo( $table, $index );
1449 if ( !$indexInfo ) {
1453 return !$indexInfo[0]->Non_unique
;
1457 * Helper for Database::insert().
1459 * @param array $options
1462 protected function makeInsertOptions( $options ) {
1463 return implode( ' ', $options );
1466 public function insert( $table, $a, $fname = __METHOD__
, $options = [] ) {
1467 # No rows to insert, easy just return now
1468 if ( !count( $a ) ) {
1472 $table = $this->tableName( $table );
1474 if ( !is_array( $options ) ) {
1475 $options = [ $options ];
1479 if ( isset( $options['fileHandle'] ) ) {
1480 $fh = $options['fileHandle'];
1482 $options = $this->makeInsertOptions( $options );
1484 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
1486 $keys = array_keys( $a[0] );
1489 $keys = array_keys( $a );
1492 $sql = 'INSERT ' . $options .
1493 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
1497 foreach ( $a as $row ) {
1503 $sql .= '(' . $this->makeList( $row ) . ')';
1506 $sql .= '(' . $this->makeList( $a ) . ')';
1509 if ( $fh !== null && false === fwrite( $fh, $sql ) ) {
1511 } elseif ( $fh !== null ) {
1515 return (bool)$this->query( $sql, $fname );
1519 * Make UPDATE options array for Database::makeUpdateOptions
1521 * @param array $options
1524 protected function makeUpdateOptionsArray( $options ) {
1525 if ( !is_array( $options ) ) {
1526 $options = [ $options ];
1531 if ( in_array( 'IGNORE', $options ) ) {
1539 * Make UPDATE options for the Database::update function
1541 * @param array $options The options passed to Database::update
1544 protected function makeUpdateOptions( $options ) {
1545 $opts = $this->makeUpdateOptionsArray( $options );
1547 return implode( ' ', $opts );
1550 public function update( $table, $values, $conds, $fname = __METHOD__
, $options = [] ) {
1551 $table = $this->tableName( $table );
1552 $opts = $this->makeUpdateOptions( $options );
1553 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, self
::LIST_SET
);
1555 if ( $conds !== [] && $conds !== '*' ) {
1556 $sql .= " WHERE " . $this->makeList( $conds, self
::LIST_AND
);
1559 return (bool)$this->query( $sql, $fname );
1562 public function makeList( $a, $mode = self
::LIST_COMMA
) {
1563 if ( !is_array( $a ) ) {
1564 throw new DBUnexpectedError( $this, __METHOD__
. ' called with incorrect parameters' );
1570 foreach ( $a as $field => $value ) {
1572 if ( $mode == self
::LIST_AND
) {
1574 } elseif ( $mode == self
::LIST_OR
) {
1583 if ( ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) && is_numeric( $field ) ) {
1584 $list .= "($value)";
1585 } elseif ( $mode == self
::LIST_SET
&& is_numeric( $field ) ) {
1588 ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) && is_array( $value )
1590 // Remove null from array to be handled separately if found
1591 $includeNull = false;
1592 foreach ( array_keys( $value, null, true ) as $nullKey ) {
1593 $includeNull = true;
1594 unset( $value[$nullKey] );
1596 if ( count( $value ) == 0 && !$includeNull ) {
1597 throw new InvalidArgumentException(
1598 __METHOD__
. ": empty input for field $field" );
1599 } elseif ( count( $value ) == 0 ) {
1600 // only check if $field is null
1601 $list .= "$field IS NULL";
1603 // IN clause contains at least one valid element
1604 if ( $includeNull ) {
1605 // Group subconditions to ensure correct precedence
1608 if ( count( $value ) == 1 ) {
1609 // Special-case single values, as IN isn't terribly efficient
1610 // Don't necessarily assume the single key is 0; we don't
1611 // enforce linear numeric ordering on other arrays here.
1612 $value = array_values( $value )[0];
1613 $list .= $field . " = " . $this->addQuotes( $value );
1615 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
1617 // if null present in array, append IS NULL
1618 if ( $includeNull ) {
1619 $list .= " OR $field IS NULL)";
1622 } elseif ( $value === null ) {
1623 if ( $mode == self
::LIST_AND ||
$mode == self
::LIST_OR
) {
1624 $list .= "$field IS ";
1625 } elseif ( $mode == self
::LIST_SET
) {
1626 $list .= "$field = ";
1631 $mode == self
::LIST_AND ||
$mode == self
::LIST_OR ||
$mode == self
::LIST_SET
1633 $list .= "$field = ";
1635 $list .= $mode == self
::LIST_NAMES ?
$value : $this->addQuotes( $value );
1642 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
1645 foreach ( $data as $base => $sub ) {
1646 if ( count( $sub ) ) {
1647 $conds[] = $this->makeList(
1648 [ $baseKey => $base, $subKey => array_keys( $sub ) ],
1654 return $this->makeList( $conds, self
::LIST_OR
);
1656 // Nothing to search for...
1661 public function aggregateValue( $valuedata, $valuename = 'value' ) {
1665 public function bitNot( $field ) {
1669 public function bitAnd( $fieldLeft, $fieldRight ) {
1670 return "($fieldLeft & $fieldRight)";
1673 public function bitOr( $fieldLeft, $fieldRight ) {
1674 return "($fieldLeft | $fieldRight)";
1677 public function buildConcat( $stringList ) {
1678 return 'CONCAT(' . implode( ',', $stringList ) . ')';
1681 public function buildGroupConcatField(
1682 $delim, $table, $field, $conds = '', $join_conds = []
1684 $fld = "GROUP_CONCAT($field SEPARATOR " . $this->addQuotes( $delim ) . ')';
1686 return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
1689 public function buildStringCast( $field ) {
1693 public function selectDB( $db ) {
1694 # Stub. Shouldn't cause serious problems if it's not overridden, but
1695 # if your database engine supports a concept similar to MySQL's
1696 # databases you may as well.
1697 $this->mDBname
= $db;
1702 public function getDBname() {
1703 return $this->mDBname
;
1706 public function getServer() {
1707 return $this->mServer
;
1710 public function tableName( $name, $format = 'quoted' ) {
1711 # Skip the entire process when we have a string quoted on both ends.
1712 # Note that we check the end so that we will still quote any use of
1713 # use of `database`.table. But won't break things if someone wants
1714 # to query a database table with a dot in the name.
1715 if ( $this->isQuotedIdentifier( $name ) ) {
1719 # Lets test for any bits of text that should never show up in a table
1720 # name. Basically anything like JOIN or ON which are actually part of
1721 # SQL queries, but may end up inside of the table value to combine
1722 # sql. Such as how the API is doing.
1723 # Note that we use a whitespace test rather than a \b test to avoid
1724 # any remote case where a word like on may be inside of a table name
1725 # surrounded by symbols which may be considered word breaks.
1726 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
1730 # Split database and table into proper variables.
1731 # We reverse the explode so that database.table and table both output
1732 # the correct table.
1733 $dbDetails = explode( '.', $name, 3 );
1734 if ( count( $dbDetails ) == 3 ) {
1735 list( $database, $schema, $table ) = $dbDetails;
1736 # We don't want any prefix added in this case
1738 } elseif ( count( $dbDetails ) == 2 ) {
1739 list( $database, $table ) = $dbDetails;
1740 # We don't want any prefix added in this case
1742 # In dbs that support it, $database may actually be the schema
1743 # but that doesn't affect any of the functionality here
1746 list( $table ) = $dbDetails;
1747 if ( isset( $this->tableAliases
[$table] ) ) {
1748 $database = $this->tableAliases
[$table]['dbname'];
1749 $schema = is_string( $this->tableAliases
[$table]['schema'] )
1750 ?
$this->tableAliases
[$table]['schema']
1752 $prefix = is_string( $this->tableAliases
[$table]['prefix'] )
1753 ?
$this->tableAliases
[$table]['prefix']
1754 : $this->mTablePrefix
;
1757 $schema = $this->mSchema
; # Default schema
1758 $prefix = $this->mTablePrefix
; # Default prefix
1762 # Quote $table and apply the prefix if not quoted.
1763 # $tableName might be empty if this is called from Database::replaceVars()
1764 $tableName = "{$prefix}{$table}";
1765 if ( $format === 'quoted'
1766 && !$this->isQuotedIdentifier( $tableName )
1767 && $tableName !== ''
1769 $tableName = $this->addIdentifierQuotes( $tableName );
1772 # Quote $schema and $database and merge them with the table name if needed
1773 $tableName = $this->prependDatabaseOrSchema( $schema, $tableName, $format );
1774 $tableName = $this->prependDatabaseOrSchema( $database, $tableName, $format );
1780 * @param string|null $namespace Database or schema
1781 * @param string $relation Name of table, view, sequence, etc...
1782 * @param string $format One of (raw, quoted)
1783 * @return string Relation name with quoted and merged $namespace as needed
1785 private function prependDatabaseOrSchema( $namespace, $relation, $format ) {
1786 if ( strlen( $namespace ) ) {
1787 if ( $format === 'quoted' && !$this->isQuotedIdentifier( $namespace ) ) {
1788 $namespace = $this->addIdentifierQuotes( $namespace );
1790 $relation = $namespace . '.' . $relation;
1796 public function tableNames() {
1797 $inArray = func_get_args();
1800 foreach ( $inArray as $name ) {
1801 $retVal[$name] = $this->tableName( $name );
1807 public function tableNamesN() {
1808 $inArray = func_get_args();
1811 foreach ( $inArray as $name ) {
1812 $retVal[] = $this->tableName( $name );
1819 * Get an aliased table name
1820 * e.g. tableName AS newTableName
1822 * @param string $name Table name, see tableName()
1823 * @param string|bool $alias Alias (optional)
1824 * @return string SQL name for aliased table. Will not alias a table to its own name
1826 protected function tableNameWithAlias( $name, $alias = false ) {
1827 if ( !$alias ||
$alias == $name ) {
1828 return $this->tableName( $name );
1830 return $this->tableName( $name ) . ' ' . $this->addIdentifierQuotes( $alias );
1835 * Gets an array of aliased table names
1837 * @param array $tables [ [alias] => table ]
1838 * @return string[] See tableNameWithAlias()
1840 protected function tableNamesWithAlias( $tables ) {
1842 foreach ( $tables as $alias => $table ) {
1843 if ( is_numeric( $alias ) ) {
1846 $retval[] = $this->tableNameWithAlias( $table, $alias );
1853 * Get an aliased field name
1854 * e.g. fieldName AS newFieldName
1856 * @param string $name Field name
1857 * @param string|bool $alias Alias (optional)
1858 * @return string SQL name for aliased field. Will not alias a field to its own name
1860 protected function fieldNameWithAlias( $name, $alias = false ) {
1861 if ( !$alias ||
(string)$alias === (string)$name ) {
1864 return $name . ' AS ' . $this->addIdentifierQuotes( $alias ); // PostgreSQL needs AS
1869 * Gets an array of aliased field names
1871 * @param array $fields [ [alias] => field ]
1872 * @return string[] See fieldNameWithAlias()
1874 protected function fieldNamesWithAlias( $fields ) {
1876 foreach ( $fields as $alias => $field ) {
1877 if ( is_numeric( $alias ) ) {
1880 $retval[] = $this->fieldNameWithAlias( $field, $alias );
1887 * Get the aliased table name clause for a FROM clause
1888 * which might have a JOIN and/or USE INDEX or IGNORE INDEX clause
1890 * @param array $tables ( [alias] => table )
1891 * @param array $use_index Same as for select()
1892 * @param array $ignore_index Same as for select()
1893 * @param array $join_conds Same as for select()
1896 protected function tableNamesWithIndexClauseOrJOIN(
1897 $tables, $use_index = [], $ignore_index = [], $join_conds = []
1901 $use_index = (array)$use_index;
1902 $ignore_index = (array)$ignore_index;
1903 $join_conds = (array)$join_conds;
1905 foreach ( $tables as $alias => $table ) {
1906 if ( !is_string( $alias ) ) {
1907 // No alias? Set it equal to the table name
1910 // Is there a JOIN clause for this table?
1911 if ( isset( $join_conds[$alias] ) ) {
1912 list( $joinType, $conds ) = $join_conds[$alias];
1913 $tableClause = $joinType;
1914 $tableClause .= ' ' . $this->tableNameWithAlias( $table, $alias );
1915 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
1916 $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
1918 $tableClause .= ' ' . $use;
1921 if ( isset( $ignore_index[$alias] ) ) { // has IGNORE INDEX?
1922 $ignore = $this->ignoreIndexClause(
1923 implode( ',', (array)$ignore_index[$alias] ) );
1924 if ( $ignore != '' ) {
1925 $tableClause .= ' ' . $ignore;
1928 $on = $this->makeList( (array)$conds, self
::LIST_AND
);
1930 $tableClause .= ' ON (' . $on . ')';
1933 $retJOIN[] = $tableClause;
1934 } elseif ( isset( $use_index[$alias] ) ) {
1935 // Is there an INDEX clause for this table?
1936 $tableClause = $this->tableNameWithAlias( $table, $alias );
1937 $tableClause .= ' ' . $this->useIndexClause(
1938 implode( ',', (array)$use_index[$alias] )
1941 $ret[] = $tableClause;
1942 } elseif ( isset( $ignore_index[$alias] ) ) {
1943 // Is there an INDEX clause for this table?
1944 $tableClause = $this->tableNameWithAlias( $table, $alias );
1945 $tableClause .= ' ' . $this->ignoreIndexClause(
1946 implode( ',', (array)$ignore_index[$alias] )
1949 $ret[] = $tableClause;
1951 $tableClause = $this->tableNameWithAlias( $table, $alias );
1953 $ret[] = $tableClause;
1957 // We can't separate explicit JOIN clauses with ',', use ' ' for those
1958 $implicitJoins = !empty( $ret ) ?
implode( ',', $ret ) : "";
1959 $explicitJoins = !empty( $retJOIN ) ?
implode( ' ', $retJOIN ) : "";
1961 // Compile our final table clause
1962 return implode( ' ', [ $implicitJoins, $explicitJoins ] );
1966 * Allows for index remapping in queries where this is not consistent across DBMS
1968 * @param string $index
1971 protected function indexName( $index ) {
1975 public function addQuotes( $s ) {
1976 if ( $s instanceof Blob
) {
1979 if ( $s === null ) {
1981 } elseif ( is_bool( $s ) ) {
1984 # This will also quote numeric values. This should be harmless,
1985 # and protects against weird problems that occur when they really
1986 # _are_ strings such as article titles and string->number->string
1987 # conversion is not 1:1.
1988 return "'" . $this->strencode( $s ) . "'";
1993 * Quotes an identifier using `backticks` or "double quotes" depending on the database type.
1994 * MySQL uses `backticks` while basically everything else uses double quotes.
1995 * Since MySQL is the odd one out here the double quotes are our generic
1996 * and we implement backticks in DatabaseMysql.
2001 public function addIdentifierQuotes( $s ) {
2002 return '"' . str_replace( '"', '""', $s ) . '"';
2006 * Returns if the given identifier looks quoted or not according to
2007 * the database convention for quoting identifiers .
2009 * @note Do not use this to determine if untrusted input is safe.
2010 * A malicious user can trick this function.
2011 * @param string $name
2014 public function isQuotedIdentifier( $name ) {
2015 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2022 protected function escapeLikeInternal( $s, $escapeChar = '`' ) {
2023 return str_replace( [ $escapeChar, '%', '_' ],
2024 [ "{$escapeChar}{$escapeChar}", "{$escapeChar}%", "{$escapeChar}_" ],
2028 public function buildLike() {
2029 $params = func_get_args();
2031 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2032 $params = $params[0];
2037 // We use ` instead of \ as the default LIKE escape character, since addQuotes()
2038 // may escape backslashes, creating problems of double escaping. The `
2039 // character has good cross-DBMS compatibility, avoiding special operators
2040 // in MS SQL like ^ and %
2043 foreach ( $params as $value ) {
2044 if ( $value instanceof LikeMatch
) {
2045 $s .= $value->toString();
2047 $s .= $this->escapeLikeInternal( $value, $escapeChar );
2051 return ' LIKE ' . $this->addQuotes( $s ) . ' ESCAPE ' . $this->addQuotes( $escapeChar ) . ' ';
2054 public function anyChar() {
2055 return new LikeMatch( '_' );
2058 public function anyString() {
2059 return new LikeMatch( '%' );
2062 public function nextSequenceValue( $seqName ) {
2067 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2068 * is only needed because a) MySQL must be as efficient as possible due to
2069 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2070 * which index to pick. Anyway, other databases might have different
2071 * indexes on a given table. So don't bother overriding this unless you're
2073 * @param string $index
2076 public function useIndexClause( $index ) {
2081 * IGNORE INDEX clause. Unlikely to be useful for anything but MySQL. This
2082 * is only needed because a) MySQL must be as efficient as possible due to
2083 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2084 * which index to pick. Anyway, other databases might have different
2085 * indexes on a given table. So don't bother overriding this unless you're
2087 * @param string $index
2090 public function ignoreIndexClause( $index ) {
2094 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
2095 $quotedTable = $this->tableName( $table );
2097 if ( count( $rows ) == 0 ) {
2102 if ( !is_array( reset( $rows ) ) ) {
2106 // @FXIME: this is not atomic, but a trx would break affectedRows()
2107 foreach ( $rows as $row ) {
2108 # Delete rows which collide
2109 if ( $uniqueIndexes ) {
2110 $sql = "DELETE FROM $quotedTable WHERE ";
2112 foreach ( $uniqueIndexes as $index ) {
2119 if ( is_array( $index ) ) {
2121 foreach ( $index as $col ) {
2127 $sql .= $col . '=' . $this->addQuotes( $row[$col] );
2130 $sql .= $index . '=' . $this->addQuotes( $row[$index] );
2134 $this->query( $sql, $fname );
2137 # Now insert the row
2138 $this->insert( $table, $row, $fname );
2143 * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2146 * @param string $table Table name
2147 * @param array|string $rows Row(s) to insert
2148 * @param string $fname Caller function name
2150 * @return ResultWrapper
2152 protected function nativeReplace( $table, $rows, $fname ) {
2153 $table = $this->tableName( $table );
2156 if ( !is_array( reset( $rows ) ) ) {
2160 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2163 foreach ( $rows as $row ) {
2170 $sql .= '(' . $this->makeList( $row ) . ')';
2173 return $this->query( $sql, $fname );
2176 public function upsert( $table, array $rows, array $uniqueIndexes, array $set,
2179 if ( !count( $rows ) ) {
2180 return true; // nothing to do
2183 if ( !is_array( reset( $rows ) ) ) {
2187 if ( count( $uniqueIndexes ) ) {
2188 $clauses = []; // list WHERE clauses that each identify a single row
2189 foreach ( $rows as $row ) {
2190 foreach ( $uniqueIndexes as $index ) {
2191 $index = is_array( $index ) ?
$index : [ $index ]; // columns
2192 $rowKey = []; // unique key to this row
2193 foreach ( $index as $column ) {
2194 $rowKey[$column] = $row[$column];
2196 $clauses[] = $this->makeList( $rowKey, self
::LIST_AND
);
2199 $where = [ $this->makeList( $clauses, self
::LIST_OR
) ];
2204 $useTrx = !$this->mTrxLevel
;
2206 $this->begin( $fname, self
::TRANSACTION_INTERNAL
);
2209 # Update any existing conflicting row(s)
2210 if ( $where !== false ) {
2211 $ok = $this->update( $table, $set, $where, $fname );
2215 # Now insert any non-conflicting row(s)
2216 $ok = $this->insert( $table, $rows, $fname, [ 'IGNORE' ] ) && $ok;
2217 } catch ( Exception
$e ) {
2219 $this->rollback( $fname, self
::FLUSHING_INTERNAL
);
2224 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
2230 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2234 throw new DBUnexpectedError( $this, __METHOD__
. ' called with empty $conds' );
2237 $delTable = $this->tableName( $delTable );
2238 $joinTable = $this->tableName( $joinTable );
2239 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2240 if ( $conds != '*' ) {
2241 $sql .= 'WHERE ' . $this->makeList( $conds, self
::LIST_AND
);
2245 $this->query( $sql, $fname );
2248 public function textFieldSize( $table, $field ) {
2249 $table = $this->tableName( $table );
2250 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2251 $res = $this->query( $sql, __METHOD__
);
2252 $row = $this->fetchObject( $res );
2256 if ( preg_match( '/\((.*)\)/', $row->Type
, $m ) ) {
2265 public function delete( $table, $conds, $fname = __METHOD__
) {
2267 throw new DBUnexpectedError( $this, __METHOD__
. ' called with no conditions' );
2270 $table = $this->tableName( $table );
2271 $sql = "DELETE FROM $table";
2273 if ( $conds != '*' ) {
2274 if ( is_array( $conds ) ) {
2275 $conds = $this->makeList( $conds, self
::LIST_AND
);
2277 $sql .= ' WHERE ' . $conds;
2280 return $this->query( $sql, $fname );
2283 public function insertSelect(
2284 $destTable, $srcTable, $varMap, $conds,
2285 $fname = __METHOD__
, $insertOptions = [], $selectOptions = []
2287 if ( $this->cliMode
) {
2288 // For massive migrations with downtime, we don't want to select everything
2289 // into memory and OOM, so do all this native on the server side if possible.
2290 return $this->nativeInsertSelect(
2301 // For web requests, do a locking SELECT and then INSERT. This puts the SELECT burden
2302 // on only the master (without needing row-based-replication). It also makes it easy to
2303 // know how big the INSERT is going to be.
2305 foreach ( $varMap as $dstColumn => $sourceColumnOrSql ) {
2306 $fields[] = $this->fieldNameWithAlias( $sourceColumnOrSql, $dstColumn );
2308 $selectOptions[] = 'FOR UPDATE';
2309 $res = $this->select( $srcTable, implode( ',', $fields ), $conds, $fname, $selectOptions );
2315 foreach ( $res as $row ) {
2316 $rows[] = (array)$row;
2319 return $this->insert( $destTable, $rows, $fname, $insertOptions );
2322 protected function nativeInsertSelect( $destTable, $srcTable, $varMap, $conds,
2323 $fname = __METHOD__
,
2324 $insertOptions = [], $selectOptions = []
2326 $destTable = $this->tableName( $destTable );
2328 if ( !is_array( $insertOptions ) ) {
2329 $insertOptions = [ $insertOptions ];
2332 $insertOptions = $this->makeInsertOptions( $insertOptions );
2334 if ( !is_array( $selectOptions ) ) {
2335 $selectOptions = [ $selectOptions ];
2338 list( $startOpts, $useIndex, $tailOpts, $ignoreIndex ) = $this->makeSelectOptions(
2341 if ( is_array( $srcTable ) ) {
2342 $srcTable = implode( ',', array_map( [ $this, 'tableName' ], $srcTable ) );
2344 $srcTable = $this->tableName( $srcTable );
2347 $sql = "INSERT $insertOptions" .
2348 " INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
2349 " SELECT $startOpts " . implode( ',', $varMap ) .
2350 " FROM $srcTable $useIndex $ignoreIndex ";
2352 if ( $conds != '*' ) {
2353 if ( is_array( $conds ) ) {
2354 $conds = $this->makeList( $conds, self
::LIST_AND
);
2356 $sql .= " WHERE $conds";
2359 $sql .= " $tailOpts";
2361 return $this->query( $sql, $fname );
2365 * Construct a LIMIT query with optional offset. This is used for query
2366 * pages. The SQL should be adjusted so that only the first $limit rows
2367 * are returned. If $offset is provided as well, then the first $offset
2368 * rows should be discarded, and the next $limit rows should be returned.
2369 * If the result of the query is not ordered, then the rows to be returned
2370 * are theoretically arbitrary.
2372 * $sql is expected to be a SELECT, if that makes a difference.
2374 * The version provided by default works in MySQL and SQLite. It will very
2375 * likely need to be overridden for most other DBMSes.
2377 * @param string $sql SQL query we will append the limit too
2378 * @param int $limit The SQL limit
2379 * @param int|bool $offset The SQL offset (default false)
2380 * @throws DBUnexpectedError
2383 public function limitResult( $sql, $limit, $offset = false ) {
2384 if ( !is_numeric( $limit ) ) {
2385 throw new DBUnexpectedError( $this,
2386 "Invalid non-numeric limit passed to limitResult()\n" );
2389 return "$sql LIMIT "
2390 . ( ( is_numeric( $offset ) && $offset != 0 ) ?
"{$offset}," : "" )
2394 public function unionSupportsOrderAndLimit() {
2395 return true; // True for almost every DB supported
2398 public function unionQueries( $sqls, $all ) {
2399 $glue = $all ?
') UNION ALL (' : ') UNION (';
2401 return '(' . implode( $glue, $sqls ) . ')';
2404 public function conditional( $cond, $trueVal, $falseVal ) {
2405 if ( is_array( $cond ) ) {
2406 $cond = $this->makeList( $cond, self
::LIST_AND
);
2409 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
2412 public function strreplace( $orig, $old, $new ) {
2413 return "REPLACE({$orig}, {$old}, {$new})";
2416 public function getServerUptime() {
2420 public function wasDeadlock() {
2424 public function wasLockTimeout() {
2428 public function wasErrorReissuable() {
2432 public function wasReadOnlyError() {
2437 * Do not use this method outside of Database/DBError classes
2439 * @param integer|string $errno
2440 * @return bool Whether the given query error was a connection drop
2442 public function wasConnectionError( $errno ) {
2446 public function deadlockLoop() {
2447 $args = func_get_args();
2448 $function = array_shift( $args );
2449 $tries = self
::DEADLOCK_TRIES
;
2451 $this->begin( __METHOD__
);
2454 /** @var Exception $e */
2458 $retVal = call_user_func_array( $function, $args );
2460 } catch ( DBQueryError
$e ) {
2461 if ( $this->wasDeadlock() ) {
2462 // Retry after a randomized delay
2463 usleep( mt_rand( self
::DEADLOCK_DELAY_MIN
, self
::DEADLOCK_DELAY_MAX
) );
2465 // Throw the error back up
2469 } while ( --$tries > 0 );
2471 if ( $tries <= 0 ) {
2472 // Too many deadlocks; give up
2473 $this->rollback( __METHOD__
);
2476 $this->commit( __METHOD__
);
2482 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
2483 # Real waits are implemented in the subclass.
2487 public function getReplicaPos() {
2492 public function getMasterPos() {
2497 public function serverIsReadOnly() {
2501 final public function onTransactionResolution( callable
$callback, $fname = __METHOD__
) {
2502 if ( !$this->mTrxLevel
) {
2503 throw new DBUnexpectedError( $this, "No transaction is active." );
2505 $this->mTrxEndCallbacks
[] = [ $callback, $fname ];
2508 final public function onTransactionIdle( callable
$callback, $fname = __METHOD__
) {
2509 $this->mTrxIdleCallbacks
[] = [ $callback, $fname ];
2510 if ( !$this->mTrxLevel
) {
2511 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_IDLE
);
2515 final public function onTransactionPreCommitOrIdle( callable
$callback, $fname = __METHOD__
) {
2516 if ( $this->mTrxLevel
) {
2517 $this->mTrxPreCommitCallbacks
[] = [ $callback, $fname ];
2519 // If no transaction is active, then make one for this callback
2520 $this->startAtomic( __METHOD__
);
2522 call_user_func( $callback );
2523 $this->endAtomic( __METHOD__
);
2524 } catch ( Exception
$e ) {
2525 $this->rollback( __METHOD__
, self
::FLUSHING_INTERNAL
);
2531 final public function setTransactionListener( $name, callable
$callback = null ) {
2533 $this->mTrxRecurringCallbacks
[$name] = $callback;
2535 unset( $this->mTrxRecurringCallbacks
[$name] );
2540 * Whether to disable running of post-COMMIT/ROLLBACK callbacks
2542 * This method should not be used outside of Database/LoadBalancer
2544 * @param bool $suppress
2547 final public function setTrxEndCallbackSuppression( $suppress ) {
2548 $this->mTrxEndCallbacksSuppressed
= $suppress;
2552 * Actually run and consume any "on transaction idle/resolution" callbacks.
2554 * This method should not be used outside of Database/LoadBalancer
2556 * @param integer $trigger IDatabase::TRIGGER_* constant
2560 public function runOnTransactionIdleCallbacks( $trigger ) {
2561 if ( $this->mTrxEndCallbacksSuppressed
) {
2565 $autoTrx = $this->getFlag( self
::DBO_TRX
); // automatic begin() enabled?
2566 /** @var Exception $e */
2567 $e = null; // first exception
2568 do { // callbacks may add callbacks :)
2569 $callbacks = array_merge(
2570 $this->mTrxIdleCallbacks
,
2571 $this->mTrxEndCallbacks
// include "transaction resolution" callbacks
2573 $this->mTrxIdleCallbacks
= []; // consumed (and recursion guard)
2574 $this->mTrxEndCallbacks
= []; // consumed (recursion guard)
2575 foreach ( $callbacks as $callback ) {
2577 list( $phpCallback ) = $callback;
2578 $this->clearFlag( self
::DBO_TRX
); // make each query its own transaction
2579 call_user_func_array( $phpCallback, [ $trigger ] );
2581 $this->setFlag( self
::DBO_TRX
); // restore automatic begin()
2583 $this->clearFlag( self
::DBO_TRX
); // restore auto-commit
2585 } catch ( Exception
$ex ) {
2586 call_user_func( $this->errorLogger
, $ex );
2588 // Some callbacks may use startAtomic/endAtomic, so make sure
2589 // their transactions are ended so other callbacks don't fail
2590 if ( $this->trxLevel() ) {
2591 $this->rollback( __METHOD__
, self
::FLUSHING_INTERNAL
);
2595 } while ( count( $this->mTrxIdleCallbacks
) );
2597 if ( $e instanceof Exception
) {
2598 throw $e; // re-throw any first exception
2603 * Actually run and consume any "on transaction pre-commit" callbacks.
2605 * This method should not be used outside of Database/LoadBalancer
2610 public function runOnTransactionPreCommitCallbacks() {
2611 $e = null; // first exception
2612 do { // callbacks may add callbacks :)
2613 $callbacks = $this->mTrxPreCommitCallbacks
;
2614 $this->mTrxPreCommitCallbacks
= []; // consumed (and recursion guard)
2615 foreach ( $callbacks as $callback ) {
2617 list( $phpCallback ) = $callback;
2618 call_user_func( $phpCallback );
2619 } catch ( Exception
$ex ) {
2620 call_user_func( $this->errorLogger
, $ex );
2624 } while ( count( $this->mTrxPreCommitCallbacks
) );
2626 if ( $e instanceof Exception
) {
2627 throw $e; // re-throw any first exception
2632 * Actually run any "transaction listener" callbacks.
2634 * This method should not be used outside of Database/LoadBalancer
2636 * @param integer $trigger IDatabase::TRIGGER_* constant
2640 public function runTransactionListenerCallbacks( $trigger ) {
2641 if ( $this->mTrxEndCallbacksSuppressed
) {
2645 /** @var Exception $e */
2646 $e = null; // first exception
2648 foreach ( $this->mTrxRecurringCallbacks
as $phpCallback ) {
2650 $phpCallback( $trigger, $this );
2651 } catch ( Exception
$ex ) {
2652 call_user_func( $this->errorLogger
, $ex );
2657 if ( $e instanceof Exception
) {
2658 throw $e; // re-throw any first exception
2662 final public function startAtomic( $fname = __METHOD__
) {
2663 if ( !$this->mTrxLevel
) {
2664 $this->begin( $fname, self
::TRANSACTION_INTERNAL
);
2665 // If DBO_TRX is set, a series of startAtomic/endAtomic pairs will result
2666 // in all changes being in one transaction to keep requests transactional.
2667 if ( !$this->getFlag( self
::DBO_TRX
) ) {
2668 $this->mTrxAutomaticAtomic
= true;
2672 $this->mTrxAtomicLevels
[] = $fname;
2675 final public function endAtomic( $fname = __METHOD__
) {
2676 if ( !$this->mTrxLevel
) {
2677 throw new DBUnexpectedError( $this, "No atomic transaction is open (got $fname)." );
2679 if ( !$this->mTrxAtomicLevels ||
2680 array_pop( $this->mTrxAtomicLevels
) !== $fname
2682 throw new DBUnexpectedError( $this, "Invalid atomic section ended (got $fname)." );
2685 if ( !$this->mTrxAtomicLevels
&& $this->mTrxAutomaticAtomic
) {
2686 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
2690 final public function doAtomicSection( $fname, callable
$callback ) {
2691 $this->startAtomic( $fname );
2693 $res = call_user_func_array( $callback, [ $this, $fname ] );
2694 } catch ( Exception
$e ) {
2695 $this->rollback( $fname, self
::FLUSHING_INTERNAL
);
2698 $this->endAtomic( $fname );
2703 final public function begin( $fname = __METHOD__
, $mode = self
::TRANSACTION_EXPLICIT
) {
2704 // Protect against mismatched atomic section, transaction nesting, and snapshot loss
2705 if ( $this->mTrxLevel
) {
2706 if ( $this->mTrxAtomicLevels
) {
2707 $levels = implode( ', ', $this->mTrxAtomicLevels
);
2708 $msg = "$fname: Got explicit BEGIN while atomic section(s) $levels are open.";
2709 throw new DBUnexpectedError( $this, $msg );
2710 } elseif ( !$this->mTrxAutomatic
) {
2711 $msg = "$fname: Explicit transaction already active (from {$this->mTrxFname}).";
2712 throw new DBUnexpectedError( $this, $msg );
2714 // @TODO: make this an exception at some point
2715 $msg = "$fname: Implicit transaction already active (from {$this->mTrxFname}).";
2716 $this->queryLogger
->error( $msg );
2717 return; // join the main transaction set
2719 } elseif ( $this->getFlag( self
::DBO_TRX
) && $mode !== self
::TRANSACTION_INTERNAL
) {
2720 // @TODO: make this an exception at some point
2721 $msg = "$fname: Implicit transaction expected (DBO_TRX set).";
2722 $this->queryLogger
->error( $msg );
2723 return; // let any writes be in the main transaction
2726 // Avoid fatals if close() was called
2727 $this->assertOpen();
2729 $this->doBegin( $fname );
2730 $this->mTrxTimestamp
= microtime( true );
2731 $this->mTrxFname
= $fname;
2732 $this->mTrxDoneWrites
= false;
2733 $this->mTrxAutomaticAtomic
= false;
2734 $this->mTrxAtomicLevels
= [];
2735 $this->mTrxShortId
= sprintf( '%06x', mt_rand( 0, 0xffffff ) );
2736 $this->mTrxWriteDuration
= 0.0;
2737 $this->mTrxWriteQueryCount
= 0;
2738 $this->mTrxWriteAdjDuration
= 0.0;
2739 $this->mTrxWriteAdjQueryCount
= 0;
2740 $this->mTrxWriteCallers
= [];
2741 // First SELECT after BEGIN will establish the snapshot in REPEATABLE-READ.
2742 // Get an estimate of the replica DB lag before then, treating estimate staleness
2743 // as lag itself just to be safe
2744 $status = $this->getApproximateLagStatus();
2745 $this->mTrxReplicaLag
= $status['lag'] +
( microtime( true ) - $status['since'] );
2746 // T147697: make explicitTrxActive() return true until begin() finishes. This way, no
2747 // caller will think its OK to muck around with the transaction just because startAtomic()
2748 // has not yet completed (e.g. setting mTrxAtomicLevels).
2749 $this->mTrxAutomatic
= ( $mode === self
::TRANSACTION_INTERNAL
);
2753 * Issues the BEGIN command to the database server.
2755 * @see Database::begin()
2756 * @param string $fname
2758 protected function doBegin( $fname ) {
2759 $this->query( 'BEGIN', $fname );
2760 $this->mTrxLevel
= 1;
2763 final public function commit( $fname = __METHOD__
, $flush = '' ) {
2764 if ( $this->mTrxLevel
&& $this->mTrxAtomicLevels
) {
2765 // There are still atomic sections open. This cannot be ignored
2766 $levels = implode( ', ', $this->mTrxAtomicLevels
);
2767 throw new DBUnexpectedError(
2769 "$fname: Got COMMIT while atomic sections $levels are still open."
2773 if ( $flush === self
::FLUSHING_INTERNAL ||
$flush === self
::FLUSHING_ALL_PEERS
) {
2774 if ( !$this->mTrxLevel
) {
2775 return; // nothing to do
2776 } elseif ( !$this->mTrxAutomatic
) {
2777 throw new DBUnexpectedError(
2779 "$fname: Flushing an explicit transaction, getting out of sync."
2783 if ( !$this->mTrxLevel
) {
2784 $this->queryLogger
->error(
2785 "$fname: No transaction to commit, something got out of sync." );
2786 return; // nothing to do
2787 } elseif ( $this->mTrxAutomatic
) {
2788 // @TODO: make this an exception at some point
2789 $msg = "$fname: Explicit commit of implicit transaction.";
2790 $this->queryLogger
->error( $msg );
2791 return; // wait for the main transaction set commit round
2795 // Avoid fatals if close() was called
2796 $this->assertOpen();
2798 $this->runOnTransactionPreCommitCallbacks();
2799 $writeTime = $this->pendingWriteQueryDuration( self
::ESTIMATE_DB_APPLY
);
2800 $this->doCommit( $fname );
2801 if ( $this->mTrxDoneWrites
) {
2802 $this->mLastWriteTime
= microtime( true );
2803 $this->trxProfiler
->transactionWritingOut(
2804 $this->mServer
, $this->mDBname
, $this->mTrxShortId
, $writeTime );
2807 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_COMMIT
);
2808 $this->runTransactionListenerCallbacks( self
::TRIGGER_COMMIT
);
2812 * Issues the COMMIT command to the database server.
2814 * @see Database::commit()
2815 * @param string $fname
2817 protected function doCommit( $fname ) {
2818 if ( $this->mTrxLevel
) {
2819 $this->query( 'COMMIT', $fname );
2820 $this->mTrxLevel
= 0;
2824 final public function rollback( $fname = __METHOD__
, $flush = '' ) {
2825 if ( $flush === self
::FLUSHING_INTERNAL ||
$flush === self
::FLUSHING_ALL_PEERS
) {
2826 if ( !$this->mTrxLevel
) {
2827 return; // nothing to do
2830 if ( !$this->mTrxLevel
) {
2831 $this->queryLogger
->error(
2832 "$fname: No transaction to rollback, something got out of sync." );
2833 return; // nothing to do
2834 } elseif ( $this->getFlag( self
::DBO_TRX
) ) {
2835 throw new DBUnexpectedError(
2837 "$fname: Expected mass rollback of all peer databases (DBO_TRX set)."
2842 // Avoid fatals if close() was called
2843 $this->assertOpen();
2845 $this->doRollback( $fname );
2846 $this->mTrxAtomicLevels
= [];
2847 if ( $this->mTrxDoneWrites
) {
2848 $this->trxProfiler
->transactionWritingOut(
2849 $this->mServer
, $this->mDBname
, $this->mTrxShortId
);
2852 $this->mTrxIdleCallbacks
= []; // clear
2853 $this->mTrxPreCommitCallbacks
= []; // clear
2854 $this->runOnTransactionIdleCallbacks( self
::TRIGGER_ROLLBACK
);
2855 $this->runTransactionListenerCallbacks( self
::TRIGGER_ROLLBACK
);
2859 * Issues the ROLLBACK command to the database server.
2861 * @see Database::rollback()
2862 * @param string $fname
2864 protected function doRollback( $fname ) {
2865 if ( $this->mTrxLevel
) {
2866 # Disconnects cause rollback anyway, so ignore those errors
2867 $ignoreErrors = true;
2868 $this->query( 'ROLLBACK', $fname, $ignoreErrors );
2869 $this->mTrxLevel
= 0;
2873 public function flushSnapshot( $fname = __METHOD__
) {
2874 if ( $this->writesOrCallbacksPending() ||
$this->explicitTrxActive() ) {
2875 // This only flushes transactions to clear snapshots, not to write data
2876 $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
2877 throw new DBUnexpectedError(
2879 "$fname: Cannot flush snapshot because writes are pending ($fnames)."
2883 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
2886 public function explicitTrxActive() {
2887 return $this->mTrxLevel
&& ( $this->mTrxAtomicLevels ||
!$this->mTrxAutomatic
);
2890 public function duplicateTableStructure(
2891 $oldName, $newName, $temporary = false, $fname = __METHOD__
2893 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
2896 public function listTables( $prefix = null, $fname = __METHOD__
) {
2897 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
2900 public function listViews( $prefix = null, $fname = __METHOD__
) {
2901 throw new RuntimeException( __METHOD__
. ' is not implemented in descendant class' );
2904 public function timestamp( $ts = 0 ) {
2905 $t = new ConvertibleTimestamp( $ts );
2906 // Let errors bubble up to avoid putting garbage in the DB
2907 return $t->getTimestamp( TS_MW
);
2910 public function timestampOrNull( $ts = null ) {
2911 if ( is_null( $ts ) ) {
2914 return $this->timestamp( $ts );
2919 * Take the result from a query, and wrap it in a ResultWrapper if
2920 * necessary. Boolean values are passed through as is, to indicate success
2921 * of write queries or failure.
2923 * Once upon a time, Database::query() returned a bare MySQL result
2924 * resource, and it was necessary to call this function to convert it to
2925 * a wrapper. Nowadays, raw database objects are never exposed to external
2926 * callers, so this is unnecessary in external code.
2928 * @param bool|ResultWrapper|resource|object $result
2929 * @return bool|ResultWrapper
2931 protected function resultObject( $result ) {
2934 } elseif ( $result instanceof ResultWrapper
) {
2936 } elseif ( $result === true ) {
2937 // Successful write query
2940 return new ResultWrapper( $this, $result );
2944 public function ping( &$rtt = null ) {
2945 // Avoid hitting the server if it was hit recently
2946 if ( $this->isOpen() && ( microtime( true ) - $this->lastPing
) < self
::PING_TTL
) {
2947 if ( !func_num_args() ||
$this->mRTTEstimate
> 0 ) {
2948 $rtt = $this->mRTTEstimate
;
2949 return true; // don't care about $rtt
2953 // This will reconnect if possible or return false if not
2954 $this->clearFlag( self
::DBO_TRX
, self
::REMEMBER_PRIOR
);
2955 $ok = ( $this->query( self
::PING_QUERY
, __METHOD__
, true ) !== false );
2956 $this->restoreFlags( self
::RESTORE_PRIOR
);
2959 $rtt = $this->mRTTEstimate
;
2968 protected function reconnect() {
2969 $this->closeConnection();
2970 $this->mOpened
= false;
2971 $this->mConn
= false;
2973 $this->open( $this->mServer
, $this->mUser
, $this->mPassword
, $this->mDBname
);
2974 $this->lastPing
= microtime( true );
2976 } catch ( DBConnectionError
$e ) {
2983 public function getSessionLagStatus() {
2984 return $this->getTransactionLagStatus() ?
: $this->getApproximateLagStatus();
2988 * Get the replica DB lag when the current transaction started
2990 * This is useful when transactions might use snapshot isolation
2991 * (e.g. REPEATABLE-READ in innodb), so the "real" lag of that data
2992 * is this lag plus transaction duration. If they don't, it is still
2993 * safe to be pessimistic. This returns null if there is no transaction.
2995 * @return array|null ('lag': seconds or false on error, 'since': UNIX timestamp of BEGIN)
2998 protected function getTransactionLagStatus() {
2999 return $this->mTrxLevel
3000 ?
[ 'lag' => $this->mTrxReplicaLag
, 'since' => $this->trxTimestamp() ]
3005 * Get a replica DB lag estimate for this server
3007 * @return array ('lag': seconds or false on error, 'since': UNIX timestamp of estimate)
3010 protected function getApproximateLagStatus() {
3012 'lag' => $this->getLBInfo( 'replica' ) ?
$this->getLag() : 0,
3013 'since' => microtime( true )
3018 * Merge the result of getSessionLagStatus() for several DBs
3019 * using the most pessimistic values to estimate the lag of
3020 * any data derived from them in combination
3022 * This is information is useful for caching modules
3024 * @see WANObjectCache::set()
3025 * @see WANObjectCache::getWithSetCallback()
3027 * @param IDatabase $db1
3028 * @param IDatabase ...
3029 * @return array Map of values:
3030 * - lag: highest lag of any of the DBs or false on error (e.g. replication stopped)
3031 * - since: oldest UNIX timestamp of any of the DB lag estimates
3032 * - pending: whether any of the DBs have uncommitted changes
3035 public static function getCacheSetOptions( IDatabase
$db1 ) {
3036 $res = [ 'lag' => 0, 'since' => INF
, 'pending' => false ];
3037 foreach ( func_get_args() as $db ) {
3038 /** @var IDatabase $db */
3039 $status = $db->getSessionLagStatus();
3040 if ( $status['lag'] === false ) {
3041 $res['lag'] = false;
3042 } elseif ( $res['lag'] !== false ) {
3043 $res['lag'] = max( $res['lag'], $status['lag'] );
3045 $res['since'] = min( $res['since'], $status['since'] );
3046 $res['pending'] = $res['pending'] ?
: $db->writesPending();
3052 public function getLag() {
3056 public function maxListLen() {
3060 public function encodeBlob( $b ) {
3064 public function decodeBlob( $b ) {
3065 if ( $b instanceof Blob
) {
3071 public function setSessionOptions( array $options ) {
3074 public function sourceFile(
3076 callable
$lineCallback = null,
3077 callable
$resultCallback = null,
3079 callable
$inputCallback = null
3081 MediaWiki\
suppressWarnings();
3082 $fp = fopen( $filename, 'r' );
3083 MediaWiki\restoreWarnings
();
3085 if ( false === $fp ) {
3086 throw new RuntimeException( "Could not open \"{$filename}\".\n" );
3090 $fname = __METHOD__
. "( $filename )";
3094 $error = $this->sourceStream(
3095 $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
3096 } catch ( Exception
$e ) {
3106 public function setSchemaVars( $vars ) {
3107 $this->mSchemaVars
= $vars;
3110 public function sourceStream(
3112 callable
$lineCallback = null,
3113 callable
$resultCallback = null,
3114 $fname = __METHOD__
,
3115 callable
$inputCallback = null
3119 while ( !feof( $fp ) ) {
3120 if ( $lineCallback ) {
3121 call_user_func( $lineCallback );
3124 $line = trim( fgets( $fp ) );
3126 if ( $line == '' ) {
3130 if ( '-' == $line[0] && '-' == $line[1] ) {
3138 $done = $this->streamStatementEnd( $cmd, $line );
3142 if ( $done ||
feof( $fp ) ) {
3143 $cmd = $this->replaceVars( $cmd );
3145 if ( !$inputCallback ||
call_user_func( $inputCallback, $cmd ) ) {
3146 $res = $this->query( $cmd, $fname );
3148 if ( $resultCallback ) {
3149 call_user_func( $resultCallback, $res, $this );
3152 if ( false === $res ) {
3153 $err = $this->lastError();
3155 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
3166 * Called by sourceStream() to check if we've reached a statement end
3168 * @param string &$sql SQL assembled so far
3169 * @param string &$newLine New line about to be added to $sql
3170 * @return bool Whether $newLine contains end of the statement
3172 public function streamStatementEnd( &$sql, &$newLine ) {
3173 if ( $this->delimiter
) {
3175 $newLine = preg_replace(
3176 '/' . preg_quote( $this->delimiter
, '/' ) . '$/', '', $newLine );
3177 if ( $newLine != $prev ) {
3186 * Database independent variable replacement. Replaces a set of variables
3187 * in an SQL statement with their contents as given by $this->getSchemaVars().
3189 * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
3191 * - '{$var}' should be used for text and is passed through the database's
3193 * - `{$var}` should be used for identifiers (e.g. table and database names).
3194 * It is passed through the database's addIdentifierQuotes method which
3195 * can be overridden if the database uses something other than backticks.
3196 * - / *_* / or / *$wgDBprefix* / passes the name that follows through the
3197 * database's tableName method.
3198 * - / *i* / passes the name that follows through the database's indexName method.
3199 * - In all other cases, / *$var* / is left unencoded. Except for table options,
3200 * its use should be avoided. In 1.24 and older, string encoding was applied.
3202 * @param string $ins SQL statement to replace variables in
3203 * @return string The new SQL statement with variables replaced
3205 protected function replaceVars( $ins ) {
3206 $vars = $this->getSchemaVars();
3207 return preg_replace_callback(
3209 /\* (\$wgDBprefix|[_i]) \*/ (\w*) | # 1-2. tableName, indexName
3210 \'\{\$ (\w+) }\' | # 3. addQuotes
3211 `\{\$ (\w+) }` | # 4. addIdentifierQuotes
3212 /\*\$ (\w+) \*/ # 5. leave unencoded
3214 function ( $m ) use ( $vars ) {
3215 // Note: Because of <https://bugs.php.net/bug.php?id=51881>,
3216 // check for both nonexistent keys *and* the empty string.
3217 if ( isset( $m[1] ) && $m[1] !== '' ) {
3218 if ( $m[1] === 'i' ) {
3219 return $this->indexName( $m[2] );
3221 return $this->tableName( $m[2] );
3223 } elseif ( isset( $m[3] ) && $m[3] !== '' && array_key_exists( $m[3], $vars ) ) {
3224 return $this->addQuotes( $vars[$m[3]] );
3225 } elseif ( isset( $m[4] ) && $m[4] !== '' && array_key_exists( $m[4], $vars ) ) {
3226 return $this->addIdentifierQuotes( $vars[$m[4]] );
3227 } elseif ( isset( $m[5] ) && $m[5] !== '' && array_key_exists( $m[5], $vars ) ) {
3228 return $vars[$m[5]];
3238 * Get schema variables. If none have been set via setSchemaVars(), then
3239 * use some defaults from the current object.
3243 protected function getSchemaVars() {
3244 if ( $this->mSchemaVars
) {
3245 return $this->mSchemaVars
;
3247 return $this->getDefaultSchemaVars();
3252 * Get schema variables to use if none have been set via setSchemaVars().
3254 * Override this in derived classes to provide variables for tables.sql
3255 * and SQL patch files.
3259 protected function getDefaultSchemaVars() {
3263 public function lockIsFree( $lockName, $method ) {
3267 public function lock( $lockName, $method, $timeout = 5 ) {
3268 $this->mNamedLocksHeld
[$lockName] = 1;
3273 public function unlock( $lockName, $method ) {
3274 unset( $this->mNamedLocksHeld
[$lockName] );
3279 public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) {
3280 if ( $this->writesOrCallbacksPending() ) {
3281 // This only flushes transactions to clear snapshots, not to write data
3282 $fnames = implode( ', ', $this->pendingWriteAndCallbackCallers() );
3283 throw new DBUnexpectedError(
3285 "$fname: Cannot flush pre-lock snapshot because writes are pending ($fnames)."
3289 if ( !$this->lock( $lockKey, $fname, $timeout ) ) {
3293 $unlocker = new ScopedCallback( function () use ( $lockKey, $fname ) {
3294 if ( $this->trxLevel() ) {
3295 // There is a good chance an exception was thrown, causing any early return
3296 // from the caller. Let any error handler get a chance to issue rollback().
3297 // If there isn't one, let the error bubble up and trigger server-side rollback.
3298 $this->onTransactionResolution(
3299 function () use ( $lockKey, $fname ) {
3300 $this->unlock( $lockKey, $fname );
3305 $this->unlock( $lockKey, $fname );
3309 $this->commit( $fname, self
::FLUSHING_INTERNAL
);
3314 public function namedLocksEnqueue() {
3318 public function tableLocksHaveTransactionScope() {
3322 final public function lockTables( array $read, array $write, $method ) {
3323 if ( $this->writesOrCallbacksPending() ) {
3324 throw new DBUnexpectedError( $this, "Transaction writes or callbacks still pending." );
3327 if ( $this->tableLocksHaveTransactionScope() ) {
3328 $this->startAtomic( $method );
3331 return $this->doLockTables( $read, $write, $method );
3334 protected function doLockTables( array $read, array $write, $method ) {
3338 final public function unlockTables( $method ) {
3339 if ( $this->tableLocksHaveTransactionScope() ) {
3340 $this->endAtomic( $method );
3342 return true; // locks released on COMMIT/ROLLBACK
3345 return $this->doUnlockTables( $method );
3348 protected function doUnlockTables( $method ) {
3354 * @param string $tableName
3355 * @param string $fName
3356 * @return bool|ResultWrapper
3359 public function dropTable( $tableName, $fName = __METHOD__
) {
3360 if ( !$this->tableExists( $tableName, $fName ) ) {
3363 $sql = "DROP TABLE " . $this->tableName( $tableName ) . " CASCADE";
3365 return $this->query( $sql, $fName );
3368 public function getInfinity() {
3372 public function encodeExpiry( $expiry ) {
3373 return ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() )
3374 ?
$this->getInfinity()
3375 : $this->timestamp( $expiry );
3378 public function decodeExpiry( $expiry, $format = TS_MW
) {
3379 if ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() ) {
3383 return ConvertibleTimestamp
::convert( $format, $expiry );
3386 public function setBigSelects( $value = true ) {
3390 public function isReadOnly() {
3391 return ( $this->getReadOnlyReason() !== false );
3395 * @return string|bool Reason this DB is read-only or false if it is not
3397 protected function getReadOnlyReason() {
3398 $reason = $this->getLBInfo( 'readOnlyReason' );
3400 return is_string( $reason ) ?
$reason : false;
3403 public function setTableAliases( array $aliases ) {
3404 $this->tableAliases
= $aliases;
3408 * @return bool Whether a DB user is required to access the DB
3411 protected function requiresDatabaseUser() {
3416 * Get the underlying binding handle, mConn
3418 * Makes sure that mConn is set (disconnects and ping() failure can unset it).
3419 * This catches broken callers than catch and ignore disconnection exceptions.
3420 * Unlike checking isOpen(), this is safe to call inside of open().
3422 * @return resource|object
3423 * @throws DBUnexpectedError
3426 protected function getBindingHandle() {
3427 if ( !$this->mConn
) {
3428 throw new DBUnexpectedError(
3430 'DB connection was already closed or the connection dropped.'
3434 return $this->mConn
;
3441 public function __toString() {
3442 return (string)$this->mConn
;
3446 * Make sure that copies do not share the same client binding handle
3447 * @throws DBConnectionError
3449 public function __clone() {
3450 $this->connLogger
->warning(
3451 "Cloning " . static::class . " is not recomended; forking connection:\n" .
3452 ( new RuntimeException() )->getTraceAsString()
3455 if ( $this->isOpen() ) {
3456 // Open a new connection resource without messing with the old one
3457 $this->mOpened
= false;
3458 $this->mConn
= false;
3459 $this->mTrxEndCallbacks
= []; // don't copy
3460 $this->handleSessionLoss(); // no trx or locks anymore
3461 $this->open( $this->mServer
, $this->mUser
, $this->mPassword
, $this->mDBname
);
3462 $this->lastPing
= microtime( true );
3467 * Called by serialize. Throw an exception when DB connection is serialized.
3468 * This causes problems on some database engines because the connection is
3469 * not restored on unserialize.
3471 public function __sleep() {
3472 throw new RuntimeException( 'Database serialization may cause problems, since ' .
3473 'the connection is not restored on wakeup.' );
3477 * Run a few simple sanity checks and close dangling connections
3479 public function __destruct() {
3480 if ( $this->mTrxLevel
&& $this->mTrxDoneWrites
) {
3481 trigger_error( "Uncommitted DB writes (transaction from {$this->mTrxFname})." );
3484 $danglingWriters = $this->pendingWriteAndCallbackCallers();
3485 if ( $danglingWriters ) {
3486 $fnames = implode( ', ', $danglingWriters );
3487 trigger_error( "DB transaction writes or callbacks still pending ($fnames)." );
3490 if ( $this->mConn
) {
3491 // Avoid connection leaks for sanity. Normally, resources close at script completion.
3492 // The connection might already be closed in zend/hhvm by now, so suppress warnings.
3493 \MediaWiki\
suppressWarnings();
3494 $this->closeConnection();
3495 \MediaWiki\restoreWarnings
();
3496 $this->mConn
= false;
3497 $this->mOpened
= false;
3502 class_alias( Database
::class, 'DatabaseBase' ); // b/c for old name
3503 class_alias( Database
::class, 'Database' ); // b/c global alias