3 * This is the MySQL database abstraction layer.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 namespace Wikimedia\Rdbms
;
28 use InvalidArgumentException
;
33 * Database abstraction object for MySQL.
34 * Defines methods independent on used MySQL extension.
40 abstract class DatabaseMysqlBase
extends Database
{
41 /** @var MysqlMasterPos */
42 protected $lastKnownReplicaPos;
43 /** @var string Method to detect replica DB lag */
44 protected $lagDetectionMethod;
45 /** @var array Method to detect replica DB lag */
46 protected $lagDetectionOptions = [];
47 /** @var bool bool Whether to use GTID methods */
48 protected $useGTIDs = false;
49 /** @var string|null */
50 protected $sslKeyPath;
51 /** @var string|null */
52 protected $sslCertPath;
53 /** @var string|null */
55 /** @var string|null */
57 /** @var string[]|null */
58 protected $sslCiphers;
59 /** @var string sql_mode value to send on connection */
61 /** @var bool Use experimental UTF-8 transmission encoding */
64 protected $defaultBigSelects = null;
66 /** @var string|null */
67 private $serverVersion = null;
69 private $insertSelectIsSafe = null;
70 /** @var stdClass|null */
71 private $replicationInfoRow = null;
74 * Additional $params include:
75 * - lagDetectionMethod : set to one of (Seconds_Behind_Master,pt-heartbeat).
76 * pt-heartbeat assumes the table is at heartbeat.heartbeat
77 * and uses UTC timestamps in the heartbeat.ts column.
78 * (https://www.percona.com/doc/percona-toolkit/2.2/pt-heartbeat.html)
79 * - lagDetectionOptions : if using pt-heartbeat, this can be set to an array map to change
80 * the default behavior. Normally, the heartbeat row with the server
81 * ID of this server's master will be used. Set the "conds" field to
82 * override the query conditions, e.g. ['shard' => 's1'].
83 * - useGTIDs : use GTID methods like MASTER_GTID_WAIT() when possible.
84 * - insertSelectIsSafe : force that native INSERT SELECT is or is not safe [default: null]
85 * - sslKeyPath : path to key file [default: null]
86 * - sslCertPath : path to certificate file [default: null]
87 * - sslCAFile: path to a single certificate authority PEM file [default: null]
88 * - sslCAPath : parth to certificate authority PEM directory [default: null]
89 * - sslCiphers : array list of allowable ciphers [default: null]
90 * @param array $params
92 function __construct( array $params ) {
93 $this->lagDetectionMethod
= isset( $params['lagDetectionMethod'] )
94 ?
$params['lagDetectionMethod']
95 : 'Seconds_Behind_Master';
96 $this->lagDetectionOptions
= isset( $params['lagDetectionOptions'] )
97 ?
$params['lagDetectionOptions']
99 $this->useGTIDs
= !empty( $params['useGTIDs' ] );
100 foreach ( [ 'KeyPath', 'CertPath', 'CAFile', 'CAPath', 'Ciphers' ] as $name ) {
102 if ( isset( $params[$var] ) ) {
103 $this->$var = $params[$var];
106 $this->sqlMode
= isset( $params['sqlMode'] ) ?
$params['sqlMode'] : '';
107 $this->utf8Mode
= !empty( $params['utf8Mode'] );
108 $this->insertSelectIsSafe
= isset( $params['insertSelectIsSafe'] )
109 ?
(bool)$params['insertSelectIsSafe'] : null;
111 parent
::__construct( $params );
117 public function getType() {
122 * @param string $server
123 * @param string $user
124 * @param string $password
125 * @param string $dbName
126 * @throws Exception|DBConnectionError
129 public function open( $server, $user, $password, $dbName ) {
130 # Close/unset connection handle
133 $this->server
= $server;
135 $this->password
= $password;
136 $this->dbName
= $dbName;
138 $this->installErrorHandler();
140 $this->conn
= $this->mysqlConnect( $this->server
);
141 } catch ( Exception
$ex ) {
142 $this->restoreErrorHandler();
145 $error = $this->restoreErrorHandler();
147 # Always log connection errors
148 if ( !$this->conn
) {
150 $error = $this->lastError();
152 $this->connLogger
->error(
153 "Error connecting to {db_server}: {error}",
154 $this->getLogContext( [
155 'method' => __METHOD__
,
159 $this->connLogger
->debug( "DB connection error\n" .
160 "Server: $server, User: $user, Password: " .
161 substr( $password, 0, 3 ) . "..., error: " . $error . "\n" );
163 $this->reportConnectionError( $error );
166 if ( strlen( $dbName ) ) {
167 Wikimedia\
suppressWarnings();
168 $success = $this->selectDB( $dbName );
169 Wikimedia\restoreWarnings
();
171 $this->queryLogger
->error(
172 "Error selecting database {db_name} on server {db_server}",
173 $this->getLogContext( [
174 'method' => __METHOD__
,
177 $this->queryLogger
->debug(
178 "Error selecting database $dbName on server {$this->server}" );
180 $this->reportConnectionError( "Error selecting database $dbName" );
184 // Tell the server what we're communicating with
185 if ( !$this->connectInitCharset() ) {
186 $this->reportConnectionError( "Error setting character set" );
189 // Abstract over any insane MySQL defaults
190 $set = [ 'group_concat_max_len = 262144' ];
191 // Set SQL mode, default is turning them all off, can be overridden or skipped with null
192 if ( is_string( $this->sqlMode
) ) {
193 $set[] = 'sql_mode = ' . $this->addQuotes( $this->sqlMode
);
195 // Set any custom settings defined by site config
196 // (e.g. https://dev.mysql.com/doc/refman/4.1/en/innodb-parameters.html)
197 foreach ( $this->sessionVars
as $var => $val ) {
198 // Escape strings but not numbers to avoid MySQL complaining
199 if ( !is_int( $val ) && !is_float( $val ) ) {
200 $val = $this->addQuotes( $val );
202 $set[] = $this->addIdentifierQuotes( $var ) . ' = ' . $val;
206 // Use doQuery() to avoid opening implicit transactions (DBO_TRX)
207 $success = $this->doQuery( 'SET ' . implode( ', ', $set ) );
209 $this->queryLogger
->error(
210 'Error setting MySQL variables on server {db_server} (check $wgSQLMode)',
211 $this->getLogContext( [
212 'method' => __METHOD__
,
215 $this->reportConnectionError(
216 'Error setting MySQL variables on server {db_server} (check $wgSQLMode)' );
220 $this->opened
= true;
226 * Set the character set information right after connection
229 protected function connectInitCharset() {
230 if ( $this->utf8Mode
) {
231 // Tell the server we're communicating with it in UTF-8.
232 // This may engage various charset conversions.
233 return $this->mysqlSetCharset( 'utf8' );
235 return $this->mysqlSetCharset( 'binary' );
240 * Open a connection to a MySQL server
242 * @param string $realServer
243 * @return mixed Raw connection
244 * @throws DBConnectionError
246 abstract protected function mysqlConnect( $realServer );
249 * Set the character set of the MySQL link
251 * @param string $charset
254 abstract protected function mysqlSetCharset( $charset );
257 * @param ResultWrapper|resource $res
258 * @throws DBUnexpectedError
260 public function freeResult( $res ) {
261 if ( $res instanceof ResultWrapper
) {
264 Wikimedia\
suppressWarnings();
265 $ok = $this->mysqlFreeResult( $res );
266 Wikimedia\restoreWarnings
();
268 throw new DBUnexpectedError( $this, "Unable to free MySQL result" );
275 * @param resource $res Raw result
278 abstract protected function mysqlFreeResult( $res );
281 * @param ResultWrapper|resource $res
282 * @return stdClass|bool
283 * @throws DBUnexpectedError
285 public function fetchObject( $res ) {
286 if ( $res instanceof ResultWrapper
) {
289 Wikimedia\
suppressWarnings();
290 $row = $this->mysqlFetchObject( $res );
291 Wikimedia\restoreWarnings
();
293 $errno = $this->lastErrno();
294 // Unfortunately, mysql_fetch_object does not reset the last errno.
295 // Only check for CR_SERVER_LOST and CR_UNKNOWN_ERROR, as
296 // these are the only errors mysql_fetch_object can cause.
297 // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
298 if ( $errno == 2000 ||
$errno == 2013 ) {
299 throw new DBUnexpectedError(
301 'Error in fetchObject(): ' . htmlspecialchars( $this->lastError() )
309 * Fetch a result row as an object
311 * @param resource $res Raw result
314 abstract protected function mysqlFetchObject( $res );
317 * @param ResultWrapper|resource $res
319 * @throws DBUnexpectedError
321 public function fetchRow( $res ) {
322 if ( $res instanceof ResultWrapper
) {
325 Wikimedia\
suppressWarnings();
326 $row = $this->mysqlFetchArray( $res );
327 Wikimedia\restoreWarnings
();
329 $errno = $this->lastErrno();
330 // Unfortunately, mysql_fetch_array does not reset the last errno.
331 // Only check for CR_SERVER_LOST and CR_UNKNOWN_ERROR, as
332 // these are the only errors mysql_fetch_array can cause.
333 // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
334 if ( $errno == 2000 ||
$errno == 2013 ) {
335 throw new DBUnexpectedError(
337 'Error in fetchRow(): ' . htmlspecialchars( $this->lastError() )
345 * Fetch a result row as an associative and numeric array
347 * @param resource $res Raw result
350 abstract protected function mysqlFetchArray( $res );
353 * @throws DBUnexpectedError
354 * @param ResultWrapper|resource $res
357 function numRows( $res ) {
358 if ( $res instanceof ResultWrapper
) {
361 Wikimedia\
suppressWarnings();
362 $n = $this->mysqlNumRows( $res );
363 Wikimedia\restoreWarnings
();
365 // Unfortunately, mysql_num_rows does not reset the last errno.
366 // We are not checking for any errors here, since
367 // these are no errors mysql_num_rows can cause.
368 // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
369 // See https://phabricator.wikimedia.org/T44430
374 * Get number of rows in result
376 * @param resource $res Raw result
379 abstract protected function mysqlNumRows( $res );
382 * @param ResultWrapper|resource $res
385 public function numFields( $res ) {
386 if ( $res instanceof ResultWrapper
) {
390 return $this->mysqlNumFields( $res );
394 * Get number of fields in result
396 * @param resource $res Raw result
399 abstract protected function mysqlNumFields( $res );
402 * @param ResultWrapper|resource $res
406 public function fieldName( $res, $n ) {
407 if ( $res instanceof ResultWrapper
) {
411 return $this->mysqlFieldName( $res, $n );
415 * Get the name of the specified field in a result
417 * @param ResultWrapper|resource $res
421 abstract protected function mysqlFieldName( $res, $n );
424 * mysql_field_type() wrapper
425 * @param ResultWrapper|resource $res
429 public function fieldType( $res, $n ) {
430 if ( $res instanceof ResultWrapper
) {
434 return $this->mysqlFieldType( $res, $n );
438 * Get the type of the specified field in a result
440 * @param ResultWrapper|resource $res
444 abstract protected function mysqlFieldType( $res, $n );
447 * @param ResultWrapper|resource $res
451 public function dataSeek( $res, $row ) {
452 if ( $res instanceof ResultWrapper
) {
456 return $this->mysqlDataSeek( $res, $row );
460 * Move internal result pointer
462 * @param ResultWrapper|resource $res
466 abstract protected function mysqlDataSeek( $res, $row );
471 public function lastError() {
473 # Even if it's non-zero, it can still be invalid
474 Wikimedia\
suppressWarnings();
475 $error = $this->mysqlError( $this->conn
);
477 $error = $this->mysqlError();
479 Wikimedia\restoreWarnings
();
481 $error = $this->mysqlError();
484 $error .= ' (' . $this->server
. ')';
491 * Returns the text of the error message from previous MySQL operation
493 * @param resource $conn Raw connection
496 abstract protected function mysqlError( $conn = null );
498 protected function wasQueryTimeout( $error, $errno ) {
499 return $errno == 2062;
503 * @param string $table
504 * @param array $uniqueIndexes
506 * @param string $fname
507 * @return ResultWrapper
509 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
510 return $this->nativeReplace( $table, $rows, $fname );
513 protected function isInsertSelectSafe( array $insertOptions, array $selectOptions ) {
514 $row = $this->getReplicationSafetyInfo();
515 // For row-based-replication, the resulting changes will be relayed, not the query
516 if ( $row->binlog_format
=== 'ROW' ) {
519 // LIMIT requires ORDER BY on a unique key or it is non-deterministic
520 if ( isset( $selectOptions['LIMIT'] ) ) {
523 // In MySQL, an INSERT SELECT is only replication safe with row-based
524 // replication or if innodb_autoinc_lock_mode is 0. When those
525 // conditions aren't met, use non-native mode.
526 // While we could try to determine if the insert is safe anyway by
527 // checking if the target table has an auto-increment column that
528 // isn't set in $varMap, that seems unlikely to be worth the extra
531 in_array( 'NO_AUTO_COLUMNS', $insertOptions ) ||
532 (int)$row->innodb_autoinc_lock_mode
=== 0
537 * @return stdClass Process cached row
539 protected function getReplicationSafetyInfo() {
540 if ( $this->replicationInfoRow
=== null ) {
541 $this->replicationInfoRow
= $this->selectRow(
544 'innodb_autoinc_lock_mode' => '@@innodb_autoinc_lock_mode',
545 'binlog_format' => '@@binlog_format',
552 return $this->replicationInfoRow
;
556 * Estimate rows in dataset
557 * Returns estimated count, based on EXPLAIN output
558 * Takes same arguments as Database::select()
560 * @param string|array $table
561 * @param string|array $vars
562 * @param string|array $conds
563 * @param string $fname
564 * @param string|array $options
567 public function estimateRowCount( $table, $vars = '*', $conds = '',
568 $fname = __METHOD__
, $options = []
570 $options['EXPLAIN'] = true;
571 $res = $this->select( $table, $vars, $conds, $fname, $options );
572 if ( $res === false ) {
575 if ( !$this->numRows( $res ) ) {
580 foreach ( $res as $plan ) {
581 $rows *= $plan->rows
> 0 ?
$plan->rows
: 1; // avoid resetting to zero
587 public function tableExists( $table, $fname = __METHOD__
) {
588 // Split database and table into proper variables as Database::tableName() returns
589 // shared tables prefixed with their database, which do not work in SHOW TABLES statements
590 list( $database, , $prefix, $table ) = $this->qualifiedTableComponents( $table );
591 $tableName = "{$prefix}{$table}";
593 if ( isset( $this->sessionTempTables
[$tableName] ) ) {
594 return true; // already known to exist and won't show in SHOW TABLES anyway
597 // We can't use buildLike() here, because it specifies an escape character
598 // other than the backslash, which is the only one supported by SHOW TABLES
599 $encLike = $this->escapeLikeInternal( $tableName, '\\' );
601 // If the database has been specified (such as for shared tables), use "FROM"
602 if ( $database !== '' ) {
603 $encDatabase = $this->addIdentifierQuotes( $database );
604 $query = "SHOW TABLES FROM $encDatabase LIKE '$encLike'";
606 $query = "SHOW TABLES LIKE '$encLike'";
609 return $this->query( $query, $fname )->numRows() > 0;
613 * @param string $table
614 * @param string $field
615 * @return bool|MySQLField
617 public function fieldInfo( $table, $field ) {
618 $table = $this->tableName( $table );
619 $res = $this->query( "SELECT * FROM $table LIMIT 1", __METHOD__
, true );
623 $n = $this->mysqlNumFields( $res->result
);
624 for ( $i = 0; $i < $n; $i++
) {
625 $meta = $this->mysqlFetchField( $res->result
, $i );
626 if ( $field == $meta->name
) {
627 return new MySQLField( $meta );
635 * Get column information from a result
637 * @param resource $res Raw result
641 abstract protected function mysqlFetchField( $res, $n );
644 * Get information about an index into an object
645 * Returns false if the index does not exist
647 * @param string $table
648 * @param string $index
649 * @param string $fname
650 * @return bool|array|null False or null on failure
652 public function indexInfo( $table, $index, $fname = __METHOD__
) {
653 # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
654 # SHOW INDEX should work for 3.x and up:
655 # https://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
656 $table = $this->tableName( $table );
657 $index = $this->indexName( $index );
659 $sql = 'SHOW INDEX FROM ' . $table;
660 $res = $this->query( $sql, $fname );
668 foreach ( $res as $row ) {
669 if ( $row->Key_name
== $index ) {
674 return $result ?
: false;
681 public function strencode( $s ) {
682 return $this->mysqlRealEscapeString( $s );
689 abstract protected function mysqlRealEscapeString( $s );
691 public function addQuotes( $s ) {
692 if ( is_bool( $s ) ) {
693 // Parent would transform to int, which does not play nice with MySQL type juggling.
694 // When searching for an int in a string column, the strings are cast to int, which
695 // means false would match any string not starting with a number.
696 $s = (string)(int)$s;
698 return parent
::addQuotes( $s );
702 * MySQL uses `backticks` for identifier quoting instead of the sql standard "double quotes".
707 public function addIdentifierQuotes( $s ) {
708 // Characters in the range \u0001-\uFFFF are valid in a quoted identifier
709 // Remove NUL bytes and escape backticks by doubling
710 return '`' . str_replace( [ "\0", '`' ], [ '', '``' ], $s ) . '`';
714 * @param string $name
717 public function isQuotedIdentifier( $name ) {
718 return strlen( $name ) && $name[0] == '`' && substr( $name, -1, 1 ) == '`';
721 public function getLag() {
722 if ( $this->getLagDetectionMethod() === 'pt-heartbeat' ) {
723 return $this->getLagFromPtHeartbeat();
725 return $this->getLagFromSlaveStatus();
732 protected function getLagDetectionMethod() {
733 return $this->lagDetectionMethod
;
739 protected function getLagFromSlaveStatus() {
740 $res = $this->query( 'SHOW SLAVE STATUS', __METHOD__
);
741 $row = $res ?
$res->fetchObject() : false;
742 if ( $row && strval( $row->Seconds_Behind_Master
) !== '' ) {
743 return intval( $row->Seconds_Behind_Master
);
752 protected function getLagFromPtHeartbeat() {
753 $options = $this->lagDetectionOptions
;
755 if ( isset( $options['conds'] ) ) {
756 // Best method for multi-DC setups: use logical channel names
757 $data = $this->getHeartbeatData( $options['conds'] );
759 // Standard method: use master server ID (works with stock pt-heartbeat)
760 $masterInfo = $this->getMasterServerInfo();
761 if ( !$masterInfo ) {
762 $this->queryLogger
->error(
763 "Unable to query master of {db_server} for server ID",
764 $this->getLogContext( [
765 'method' => __METHOD__
769 return false; // could not get master server ID
772 $conds = [ 'server_id' => intval( $masterInfo['serverId'] ) ];
773 $data = $this->getHeartbeatData( $conds );
776 list( $time, $nowUnix ) = $data;
777 if ( $time !== null ) {
778 // @time is in ISO format like "2015-09-25T16:48:10.000510"
779 $dateTime = new DateTime( $time, new DateTimeZone( 'UTC' ) );
780 $timeUnix = (int)$dateTime->format( 'U' ) +
$dateTime->format( 'u' ) / 1e6
;
782 return max( $nowUnix - $timeUnix, 0.0 );
785 $this->queryLogger
->error(
786 "Unable to find pt-heartbeat row for {db_server}",
787 $this->getLogContext( [
788 'method' => __METHOD__
795 protected function getMasterServerInfo() {
796 $cache = $this->srvCache
;
797 $key = $cache->makeGlobalKey(
800 // Using one key for all cluster replica DBs is preferable
801 $this->getLBInfo( 'clusterMasterHost' ) ?
: $this->getServer()
804 return $cache->getWithSetCallback(
806 $cache::TTL_INDEFINITE
,
807 function () use ( $cache, $key ) {
808 // Get and leave a lock key in place for a short period
809 if ( !$cache->lock( $key, 0, 10 ) ) {
810 return false; // avoid master connection spike slams
813 $conn = $this->getLazyMasterHandle();
815 return false; // something is misconfigured
818 // Connect to and query the master; catch errors to avoid outages
820 $res = $conn->query( 'SELECT @@server_id AS id', __METHOD__
);
821 $row = $res ?
$res->fetchObject() : false;
822 $id = $row ?
(int)$row->id
: 0;
823 } catch ( DBError
$e ) {
827 // Cache the ID if it was retrieved
828 return $id ?
[ 'serverId' => $id, 'asOf' => time() ] : false;
834 * @param array $conds WHERE clause conditions to find a row
835 * @return array (heartbeat `ts` column value or null, UNIX timestamp) for the newest beat
836 * @see https://www.percona.com/doc/percona-toolkit/2.1/pt-heartbeat.html
838 protected function getHeartbeatData( array $conds ) {
839 // Query time and trip time are not counted
840 $nowUnix = microtime( true );
841 // Do not bother starting implicit transactions here
842 $this->clearFlag( self
::DBO_TRX
, self
::REMEMBER_PRIOR
);
844 $whereSQL = $this->makeList( $conds, self
::LIST_AND
);
845 // Use ORDER BY for channel based queries since that field might not be UNIQUE.
846 // Note: this would use "TIMESTAMPDIFF(MICROSECOND,ts,UTC_TIMESTAMP(6))" but the
847 // percision field is not supported in MySQL <= 5.5.
849 "SELECT ts FROM heartbeat.heartbeat WHERE $whereSQL ORDER BY ts DESC LIMIT 1"
851 $row = $res ?
$res->fetchObject() : false;
853 $this->restoreFlags();
856 return [ $row ?
$row->ts
: null, $nowUnix ];
859 protected function getApproximateLagStatus() {
860 if ( $this->getLagDetectionMethod() === 'pt-heartbeat' ) {
861 // Disable caching since this is fast enough and we don't wan't
862 // to be *too* pessimistic by having both the cache TTL and the
863 // pt-heartbeat interval count as lag in getSessionLagStatus()
864 return parent
::getApproximateLagStatus();
867 $key = $this->srvCache
->makeGlobalKey( 'mysql-lag', $this->getServer() );
868 $approxLag = $this->srvCache
->get( $key );
870 $approxLag = parent
::getApproximateLagStatus();
871 $this->srvCache
->set( $key, $approxLag, 1 );
877 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
878 if ( !( $pos instanceof MySQLMasterPos
) ) {
879 throw new InvalidArgumentException( "Position not an instance of MySQLMasterPos" );
882 if ( $this->getLBInfo( 'is static' ) === true ) {
883 return 0; // this is a copy of a read-only dataset with no master DB
884 } elseif ( $this->lastKnownReplicaPos
&& $this->lastKnownReplicaPos
->hasReached( $pos ) ) {
885 return 0; // already reached this point for sure
888 // Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
889 if ( $pos->getGTIDs() ) {
890 // Ignore GTIDs from domains exclusive to the master DB (presumably inactive)
891 $rpos = $this->getReplicaPos();
892 $gtidsWait = $rpos ? MySQLMasterPos
::getCommonDomainGTIDs( $pos, $rpos ) : [];
894 return -1; // $pos is from the wrong cluster?
896 // Wait on the GTID set (MariaDB only)
897 $gtidArg = $this->addQuotes( implode( ',', $gtidsWait ) );
898 $res = $this->doQuery( "SELECT MASTER_GTID_WAIT($gtidArg, $timeout)" );
900 // Wait on the binlog coordinates
901 $encFile = $this->addQuotes( $pos->getLogFile() );
902 $encPos = intval( $pos->pos
[1] );
903 $res = $this->doQuery( "SELECT MASTER_POS_WAIT($encFile, $encPos, $timeout)" );
906 $row = $res ?
$this->fetchRow( $res ) : false;
908 throw new DBExpectedError( $this,
909 "MASTER_POS_WAIT() or MASTER_GTID_WAIT() failed: {$this->lastError()}" );
912 // Result can be NULL (error), -1 (timeout), or 0+ per the MySQL manual
913 $status = ( $row[0] !== null ) ?
intval( $row[0] ) : null;
914 if ( $status === null ) {
915 if ( !$pos->getGTIDs() ) {
916 // T126436: jobs programmed to wait on master positions might be referencing
917 // binlogs with an old master hostname; this makes MASTER_POS_WAIT() return null.
918 // Try to detect this case and treat the replica DB as having reached the given
919 // position (any master switchover already requires that the new master be caught
920 // up before the switch).
921 $replicationPos = $this->getReplicaPos();
922 if ( $replicationPos && !$replicationPos->channelsMatch( $pos ) ) {
923 $this->lastKnownReplicaPos
= $replicationPos;
927 } elseif ( $status >= 0 ) {
928 // Remember that this position was reached to save queries next time
929 $this->lastKnownReplicaPos
= $pos;
936 * Get the position of the master from SHOW SLAVE STATUS
938 * @return MySQLMasterPos|bool
940 public function getReplicaPos() {
941 $now = microtime( true );
943 if ( $this->useGTIDs
) {
944 $res = $this->query( "SELECT @@global.gtid_slave_pos AS Value", __METHOD__
);
945 $gtidRow = $this->fetchObject( $res );
946 if ( $gtidRow && strlen( $gtidRow->Value
) ) {
947 return new MySQLMasterPos( $gtidRow->Value
, $now );
951 $res = $this->query( 'SHOW SLAVE STATUS', __METHOD__
);
952 $row = $this->fetchObject( $res );
953 if ( $row && strlen( $row->Relay_Master_Log_File
) ) {
954 return new MySQLMasterPos(
955 "{$row->Relay_Master_Log_File}/{$row->Exec_Master_Log_Pos}",
964 * Get the position of the master from SHOW MASTER STATUS
966 * @return MySQLMasterPos|bool
968 public function getMasterPos() {
969 $now = microtime( true );
971 if ( $this->useGTIDs
) {
972 $res = $this->query( "SELECT @@global.gtid_binlog_pos AS Value", __METHOD__
);
973 $gtidRow = $this->fetchObject( $res );
974 if ( $gtidRow && strlen( $gtidRow->Value
) ) {
975 return new MySQLMasterPos( $gtidRow->Value
, $now );
979 $res = $this->query( 'SHOW MASTER STATUS', __METHOD__
);
980 $row = $this->fetchObject( $res );
981 if ( $row && strlen( $row->File
) ) {
982 return new MySQLMasterPos( "{$row->File}/{$row->Position}", $now );
988 public function serverIsReadOnly() {
989 $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'read_only'", __METHOD__
);
990 $row = $this->fetchObject( $res );
992 return $row ?
( strtolower( $row->Value
) === 'on' ) : false;
996 * @param string $index
999 function useIndexClause( $index ) {
1000 return "FORCE INDEX (" . $this->indexName( $index ) . ")";
1004 * @param string $index
1007 function ignoreIndexClause( $index ) {
1008 return "IGNORE INDEX (" . $this->indexName( $index ) . ")";
1014 function lowPriorityOption() {
1015 return 'LOW_PRIORITY';
1021 public function getSoftwareLink() {
1022 // MariaDB includes its name in its version string; this is how MariaDB's version of
1023 // the mysql command-line client identifies MariaDB servers (see mariadb_connection()
1024 // in libmysql/libmysql.c).
1025 $version = $this->getServerVersion();
1026 if ( strpos( $version, 'MariaDB' ) !== false ||
strpos( $version, '-maria-' ) !== false ) {
1027 return '[{{int:version-db-mariadb-url}} MariaDB]';
1030 // Percona Server's version suffix is not very distinctive, and @@version_comment
1031 // doesn't give the necessary info for source builds, so assume the server is MySQL.
1032 // (Even Percona's version of mysql doesn't try to make the distinction.)
1033 return '[{{int:version-db-mysql-url}} MySQL]';
1039 public function getServerVersion() {
1040 // Not using mysql_get_server_info() or similar for consistency: in the handshake,
1041 // MariaDB 10 adds the prefix "5.5.5-", and only some newer client libraries strip
1042 // it off (see RPL_VERSION_HACK in include/mysql_com.h).
1043 if ( $this->serverVersion
=== null ) {
1044 $this->serverVersion
= $this->selectField( '', 'VERSION()', '', __METHOD__
);
1046 return $this->serverVersion
;
1050 * @param array $options
1052 public function setSessionOptions( array $options ) {
1053 if ( isset( $options['connTimeout'] ) ) {
1054 $timeout = (int)$options['connTimeout'];
1055 $this->query( "SET net_read_timeout=$timeout" );
1056 $this->query( "SET net_write_timeout=$timeout" );
1061 * @param string &$sql
1062 * @param string &$newLine
1065 public function streamStatementEnd( &$sql, &$newLine ) {
1066 if ( strtoupper( substr( $newLine, 0, 9 ) ) == 'DELIMITER' ) {
1067 preg_match( '/^DELIMITER\s+(\S+)/', $newLine, $m );
1068 $this->delimiter
= $m[1];
1072 return parent
::streamStatementEnd( $sql, $newLine );
1076 * Check to see if a named lock is available. This is non-blocking.
1078 * @param string $lockName Name of lock to poll
1079 * @param string $method Name of method calling us
1083 public function lockIsFree( $lockName, $method ) {
1084 if ( !parent
::lockIsFree( $lockName, $method ) ) {
1085 return false; // already held
1088 $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1089 $result = $this->query( "SELECT IS_FREE_LOCK($encName) AS lockstatus", $method );
1090 $row = $this->fetchObject( $result );
1092 return ( $row->lockstatus
== 1 );
1096 * @param string $lockName
1097 * @param string $method
1098 * @param int $timeout
1101 public function lock( $lockName, $method, $timeout = 5 ) {
1102 $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1103 $result = $this->query( "SELECT GET_LOCK($encName, $timeout) AS lockstatus", $method );
1104 $row = $this->fetchObject( $result );
1106 if ( $row->lockstatus
== 1 ) {
1107 parent
::lock( $lockName, $method, $timeout ); // record
1111 $this->queryLogger
->info( __METHOD__
. " failed to acquire lock '{lockname}'",
1112 [ 'lockname' => $lockName ] );
1119 * https://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock
1120 * @param string $lockName
1121 * @param string $method
1124 public function unlock( $lockName, $method ) {
1125 $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1126 $result = $this->query( "SELECT RELEASE_LOCK($encName) as lockstatus", $method );
1127 $row = $this->fetchObject( $result );
1129 if ( $row->lockstatus
== 1 ) {
1130 parent
::unlock( $lockName, $method ); // record
1134 $this->queryLogger
->warning( __METHOD__
. " failed to release lock '$lockName'\n" );
1139 private function makeLockName( $lockName ) {
1140 // https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
1141 // Newer version enforce a 64 char length limit.
1142 return ( strlen( $lockName ) > 64 ) ?
sha1( $lockName ) : $lockName;
1145 public function namedLocksEnqueue() {
1149 public function tableLocksHaveTransactionScope() {
1150 return false; // tied to TCP connection
1153 protected function doLockTables( array $read, array $write, $method ) {
1155 foreach ( $write as $table ) {
1156 $items[] = $this->tableName( $table ) . ' WRITE';
1158 foreach ( $read as $table ) {
1159 $items[] = $this->tableName( $table ) . ' READ';
1162 $sql = "LOCK TABLES " . implode( ',', $items );
1163 $this->query( $sql, $method );
1168 protected function doUnlockTables( $method ) {
1169 $this->query( "UNLOCK TABLES", $method );
1175 * @param bool $value
1177 public function setBigSelects( $value = true ) {
1178 if ( $value === 'default' ) {
1179 if ( $this->defaultBigSelects
=== null ) {
1180 # Function hasn't been called before so it must already be set to the default
1183 $value = $this->defaultBigSelects
;
1185 } elseif ( $this->defaultBigSelects
=== null ) {
1186 $this->defaultBigSelects
=
1187 (bool)$this->selectField( false, '@@sql_big_selects', '', __METHOD__
);
1189 $encValue = $value ?
'1' : '0';
1190 $this->query( "SET sql_big_selects=$encValue", __METHOD__
);
1194 * DELETE where the condition is a join. MySql uses multi-table deletes.
1195 * @param string $delTable
1196 * @param string $joinTable
1197 * @param string $delVar
1198 * @param string $joinVar
1199 * @param array|string $conds
1200 * @param bool|string $fname
1201 * @throws DBUnexpectedError
1202 * @return bool|ResultWrapper
1204 public function deleteJoin(
1205 $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
1208 throw new DBUnexpectedError( $this, __METHOD__
. ' called with empty $conds' );
1211 $delTable = $this->tableName( $delTable );
1212 $joinTable = $this->tableName( $joinTable );
1213 $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
1215 if ( $conds != '*' ) {
1216 $sql .= ' AND ' . $this->makeList( $conds, self
::LIST_AND
);
1219 return $this->query( $sql, $fname );
1223 * @param string $table
1224 * @param array $rows
1225 * @param array $uniqueIndexes
1227 * @param string $fname
1230 public function upsert( $table, array $rows, array $uniqueIndexes,
1231 array $set, $fname = __METHOD__
1233 if ( !count( $rows ) ) {
1234 return true; // nothing to do
1237 if ( !is_array( reset( $rows ) ) ) {
1241 $table = $this->tableName( $table );
1242 $columns = array_keys( $rows[0] );
1244 $sql = "INSERT INTO $table (" . implode( ',', $columns ) . ') VALUES ';
1246 foreach ( $rows as $row ) {
1247 $rowTuples[] = '(' . $this->makeList( $row ) . ')';
1249 $sql .= implode( ',', $rowTuples );
1250 $sql .= " ON DUPLICATE KEY UPDATE " . $this->makeList( $set, self
::LIST_SET
);
1252 return (bool)$this->query( $sql, $fname );
1256 * Determines how long the server has been up
1260 public function getServerUptime() {
1261 $vars = $this->getMysqlStatus( 'Uptime' );
1263 return (int)$vars['Uptime'];
1267 * Determines if the last failure was due to a deadlock
1271 public function wasDeadlock() {
1272 return $this->lastErrno() == 1213;
1276 * Determines if the last failure was due to a lock timeout
1280 public function wasLockTimeout() {
1281 return $this->lastErrno() == 1205;
1284 public function wasErrorReissuable() {
1285 return $this->lastErrno() == 2013 ||
$this->lastErrno() == 2006;
1289 * Determines if the last failure was due to the database being read-only.
1293 public function wasReadOnlyError() {
1294 return $this->lastErrno() == 1223 ||
1295 ( $this->lastErrno() == 1290 && strpos( $this->lastError(), '--read-only' ) !== false );
1298 public function wasConnectionError( $errno ) {
1299 return $errno == 2013 ||
$errno == 2006;
1303 * @param string $oldName
1304 * @param string $newName
1305 * @param bool $temporary
1306 * @param string $fname
1309 public function duplicateTableStructure(
1310 $oldName, $newName, $temporary = false, $fname = __METHOD__
1312 $tmp = $temporary ?
'TEMPORARY ' : '';
1313 $newName = $this->addIdentifierQuotes( $newName );
1314 $oldName = $this->addIdentifierQuotes( $oldName );
1315 $query = "CREATE $tmp TABLE $newName (LIKE $oldName)";
1317 return $this->query( $query, $fname );
1321 * List all tables on the database
1323 * @param string $prefix Only show tables with this prefix, e.g. mw_
1324 * @param string $fname Calling function name
1327 public function listTables( $prefix = null, $fname = __METHOD__
) {
1328 $result = $this->query( "SHOW TABLES", $fname );
1332 foreach ( $result as $table ) {
1333 $vars = get_object_vars( $table );
1334 $table = array_pop( $vars );
1336 if ( !$prefix ||
strpos( $table, $prefix ) === 0 ) {
1337 $endArray[] = $table;
1345 * @param string $tableName
1346 * @param string $fName
1347 * @return bool|ResultWrapper
1349 public function dropTable( $tableName, $fName = __METHOD__
) {
1350 if ( !$this->tableExists( $tableName, $fName ) ) {
1354 return $this->query( "DROP TABLE IF EXISTS " . $this->tableName( $tableName ), $fName );
1358 * Get status information from SHOW STATUS in an associative array
1360 * @param string $which
1363 private function getMysqlStatus( $which = "%" ) {
1364 $res = $this->query( "SHOW STATUS LIKE '{$which}'" );
1367 foreach ( $res as $row ) {
1368 $status[$row->Variable_name
] = $row->Value
;
1375 * Lists VIEWs in the database
1377 * @param string $prefix Only show VIEWs with this prefix, eg.
1378 * unit_test_, or $wgDBprefix. Default: null, would return all views.
1379 * @param string $fname Name of calling function
1383 public function listViews( $prefix = null, $fname = __METHOD__
) {
1384 // The name of the column containing the name of the VIEW
1385 $propertyName = 'Tables_in_' . $this->dbName
;
1387 // Query for the VIEWS
1388 $res = $this->query( 'SHOW FULL TABLES WHERE TABLE_TYPE = "VIEW"' );
1390 foreach ( $res as $row ) {
1391 array_push( $allViews, $row->$propertyName );
1394 if ( is_null( $prefix ) ||
$prefix === '' ) {
1398 $filteredViews = [];
1399 foreach ( $allViews as $viewName ) {
1400 // Does the name of this VIEW start with the table-prefix?
1401 if ( strpos( $viewName, $prefix ) === 0 ) {
1402 array_push( $filteredViews, $viewName );
1406 return $filteredViews;
1410 * Differentiates between a TABLE and a VIEW.
1412 * @param string $name Name of the TABLE/VIEW to test
1413 * @param string $prefix
1417 public function isView( $name, $prefix = null ) {
1418 return in_array( $name, $this->listViews( $prefix ) );
1422 * Allows for index remapping in queries where this is not consistent across DBMS
1424 * @param string $index
1427 protected function indexName( $index ) {
1429 * When SQLite indexes were introduced in r45764, it was noted that
1430 * SQLite requires index names to be unique within the whole database,
1431 * not just within a schema. As discussed in CR r45819, to avoid the
1432 * need for a schema change on existing installations, the indexes
1433 * were implicitly mapped from the new names to the old names.
1435 * This mapping can be removed if DB patches are introduced to alter
1436 * the relevant tables in existing installations. Note that because
1437 * this index mapping applies to table creation, even new installations
1438 * of MySQL have the old names (except for installations created during
1439 * a period where this mapping was inappropriately removed, see
1443 'ar_usertext_timestamp' => 'usertext_timestamp',
1444 'un_user_id' => 'user_id',
1445 'un_user_ip' => 'user_ip',
1448 if ( isset( $renamed[$index] ) ) {
1449 return $renamed[$index];
1455 protected function isTransactableQuery( $sql ) {
1456 return parent
::isTransactableQuery( $sql ) &&
1457 !preg_match( '/^SELECT\s+(GET|RELEASE|IS_FREE)_LOCK\(/', $sql );
1461 * @param string $field Field or column to cast
1464 public function buildIntegerCast( $field ) {
1465 return 'CAST( ' . $field . ' AS SIGNED )';
1470 class_alias( DatabaseMysqlBase
::class, 'DatabaseMysqlBase' );