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 */
56 protected $sslCiphers;
57 /** @var string sql_mode value to send on connection */
59 /** @var bool Use experimental UTF-8 transmission encoding */
62 /** @var string|null */
63 private $serverVersion = null;
66 * Additional $params include:
67 * - lagDetectionMethod : set to one of (Seconds_Behind_Master,pt-heartbeat).
68 * pt-heartbeat assumes the table is at heartbeat.heartbeat
69 * and uses UTC timestamps in the heartbeat.ts column.
70 * (https://www.percona.com/doc/percona-toolkit/2.2/pt-heartbeat.html)
71 * - lagDetectionOptions : if using pt-heartbeat, this can be set to an array map to change
72 * the default behavior. Normally, the heartbeat row with the server
73 * ID of this server's master will be used. Set the "conds" field to
74 * override the query conditions, e.g. ['shard' => 's1'].
75 * - useGTIDs : use GTID methods like MASTER_GTID_WAIT() when possible.
76 * - sslKeyPath : path to key file [default: null]
77 * - sslCertPath : path to certificate file [default: null]
78 * - sslCAPath : parth to certificate authority PEM files [default: null]
79 * - sslCiphers : array list of allowable ciphers [default: null]
80 * @param array $params
82 function __construct( array $params ) {
83 $this->lagDetectionMethod
= isset( $params['lagDetectionMethod'] )
84 ?
$params['lagDetectionMethod']
85 : 'Seconds_Behind_Master';
86 $this->lagDetectionOptions
= isset( $params['lagDetectionOptions'] )
87 ?
$params['lagDetectionOptions']
89 $this->useGTIDs
= !empty( $params['useGTIDs' ] );
90 foreach ( [ 'KeyPath', 'CertPath', 'CAPath', 'Ciphers' ] as $name ) {
92 if ( isset( $params[$var] ) ) {
93 $this->$var = $params[$var];
96 $this->sqlMode
= isset( $params['sqlMode'] ) ?
$params['sqlMode'] : '';
97 $this->utf8Mode
= !empty( $params['utf8Mode'] );
99 parent
::__construct( $params );
105 public function getType() {
110 * @param string $server
111 * @param string $user
112 * @param string $password
113 * @param string $dbName
114 * @throws Exception|DBConnectionError
117 public function open( $server, $user, $password, $dbName ) {
118 # Close/unset connection handle
121 $this->mServer
= $server;
122 $this->mUser
= $user;
123 $this->mPassword
= $password;
124 $this->mDBname
= $dbName;
126 $this->installErrorHandler();
128 $this->mConn
= $this->mysqlConnect( $this->mServer
);
129 } catch ( Exception
$ex ) {
130 $this->restoreErrorHandler();
133 $error = $this->restoreErrorHandler();
135 # Always log connection errors
136 if ( !$this->mConn
) {
138 $error = $this->lastError();
140 $this->connLogger
->error(
141 "Error connecting to {db_server}: {error}",
142 $this->getLogContext( [
143 'method' => __METHOD__
,
147 $this->connLogger
->debug( "DB connection error\n" .
148 "Server: $server, User: $user, Password: " .
149 substr( $password, 0, 3 ) . "..., error: " . $error . "\n" );
151 $this->reportConnectionError( $error );
154 if ( $dbName != '' ) {
155 MediaWiki\
suppressWarnings();
156 $success = $this->selectDB( $dbName );
157 MediaWiki\restoreWarnings
();
159 $this->queryLogger
->error(
160 "Error selecting database {db_name} on server {db_server}",
161 $this->getLogContext( [
162 'method' => __METHOD__
,
165 $this->queryLogger
->debug(
166 "Error selecting database $dbName on server {$this->mServer}" );
168 $this->reportConnectionError( "Error selecting database $dbName" );
172 // Tell the server what we're communicating with
173 if ( !$this->connectInitCharset() ) {
174 $this->reportConnectionError( "Error setting character set" );
177 // Abstract over any insane MySQL defaults
178 $set = [ 'group_concat_max_len = 262144' ];
179 // Set SQL mode, default is turning them all off, can be overridden or skipped with null
180 if ( is_string( $this->sqlMode
) ) {
181 $set[] = 'sql_mode = ' . $this->addQuotes( $this->sqlMode
);
183 // Set any custom settings defined by site config
184 // (e.g. https://dev.mysql.com/doc/refman/4.1/en/innodb-parameters.html)
185 foreach ( $this->mSessionVars
as $var => $val ) {
186 // Escape strings but not numbers to avoid MySQL complaining
187 if ( !is_int( $val ) && !is_float( $val ) ) {
188 $val = $this->addQuotes( $val );
190 $set[] = $this->addIdentifierQuotes( $var ) . ' = ' . $val;
194 // Use doQuery() to avoid opening implicit transactions (DBO_TRX)
195 $success = $this->doQuery( 'SET ' . implode( ', ', $set ) );
197 $this->queryLogger
->error(
198 'Error setting MySQL variables on server {db_server} (check $wgSQLMode)',
199 $this->getLogContext( [
200 'method' => __METHOD__
,
203 $this->reportConnectionError(
204 'Error setting MySQL variables on server {db_server} (check $wgSQLMode)' );
208 $this->mOpened
= true;
214 * Set the character set information right after connection
217 protected function connectInitCharset() {
218 if ( $this->utf8Mode
) {
219 // Tell the server we're communicating with it in UTF-8.
220 // This may engage various charset conversions.
221 return $this->mysqlSetCharset( 'utf8' );
223 return $this->mysqlSetCharset( 'binary' );
228 * Open a connection to a MySQL server
230 * @param string $realServer
231 * @return mixed Raw connection
232 * @throws DBConnectionError
234 abstract protected function mysqlConnect( $realServer );
237 * Set the character set of the MySQL link
239 * @param string $charset
242 abstract protected function mysqlSetCharset( $charset );
245 * @param ResultWrapper|resource $res
246 * @throws DBUnexpectedError
248 public function freeResult( $res ) {
249 if ( $res instanceof ResultWrapper
) {
252 MediaWiki\
suppressWarnings();
253 $ok = $this->mysqlFreeResult( $res );
254 MediaWiki\restoreWarnings
();
256 throw new DBUnexpectedError( $this, "Unable to free MySQL result" );
263 * @param resource $res Raw result
266 abstract protected function mysqlFreeResult( $res );
269 * @param ResultWrapper|resource $res
270 * @return stdClass|bool
271 * @throws DBUnexpectedError
273 public function fetchObject( $res ) {
274 if ( $res instanceof ResultWrapper
) {
277 MediaWiki\
suppressWarnings();
278 $row = $this->mysqlFetchObject( $res );
279 MediaWiki\restoreWarnings
();
281 $errno = $this->lastErrno();
282 // Unfortunately, mysql_fetch_object does not reset the last errno.
283 // Only check for CR_SERVER_LOST and CR_UNKNOWN_ERROR, as
284 // these are the only errors mysql_fetch_object can cause.
285 // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
286 if ( $errno == 2000 ||
$errno == 2013 ) {
287 throw new DBUnexpectedError(
289 'Error in fetchObject(): ' . htmlspecialchars( $this->lastError() )
297 * Fetch a result row as an object
299 * @param resource $res Raw result
302 abstract protected function mysqlFetchObject( $res );
305 * @param ResultWrapper|resource $res
307 * @throws DBUnexpectedError
309 public function fetchRow( $res ) {
310 if ( $res instanceof ResultWrapper
) {
313 MediaWiki\
suppressWarnings();
314 $row = $this->mysqlFetchArray( $res );
315 MediaWiki\restoreWarnings
();
317 $errno = $this->lastErrno();
318 // Unfortunately, mysql_fetch_array does not reset the last errno.
319 // Only check for CR_SERVER_LOST and CR_UNKNOWN_ERROR, as
320 // these are the only errors mysql_fetch_array can cause.
321 // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
322 if ( $errno == 2000 ||
$errno == 2013 ) {
323 throw new DBUnexpectedError(
325 'Error in fetchRow(): ' . htmlspecialchars( $this->lastError() )
333 * Fetch a result row as an associative and numeric array
335 * @param resource $res Raw result
338 abstract protected function mysqlFetchArray( $res );
341 * @throws DBUnexpectedError
342 * @param ResultWrapper|resource $res
345 function numRows( $res ) {
346 if ( $res instanceof ResultWrapper
) {
349 MediaWiki\
suppressWarnings();
350 $n = $this->mysqlNumRows( $res );
351 MediaWiki\restoreWarnings
();
353 // Unfortunately, mysql_num_rows does not reset the last errno.
354 // We are not checking for any errors here, since
355 // these are no errors mysql_num_rows can cause.
356 // See https://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
357 // See https://phabricator.wikimedia.org/T44430
362 * Get number of rows in result
364 * @param resource $res Raw result
367 abstract protected function mysqlNumRows( $res );
370 * @param ResultWrapper|resource $res
373 public function numFields( $res ) {
374 if ( $res instanceof ResultWrapper
) {
378 return $this->mysqlNumFields( $res );
382 * Get number of fields in result
384 * @param resource $res Raw result
387 abstract protected function mysqlNumFields( $res );
390 * @param ResultWrapper|resource $res
394 public function fieldName( $res, $n ) {
395 if ( $res instanceof ResultWrapper
) {
399 return $this->mysqlFieldName( $res, $n );
403 * Get the name of the specified field in a result
405 * @param ResultWrapper|resource $res
409 abstract protected function mysqlFieldName( $res, $n );
412 * mysql_field_type() wrapper
413 * @param ResultWrapper|resource $res
417 public function fieldType( $res, $n ) {
418 if ( $res instanceof ResultWrapper
) {
422 return $this->mysqlFieldType( $res, $n );
426 * Get the type of the specified field in a result
428 * @param ResultWrapper|resource $res
432 abstract protected function mysqlFieldType( $res, $n );
435 * @param ResultWrapper|resource $res
439 public function dataSeek( $res, $row ) {
440 if ( $res instanceof ResultWrapper
) {
444 return $this->mysqlDataSeek( $res, $row );
448 * Move internal result pointer
450 * @param ResultWrapper|resource $res
454 abstract protected function mysqlDataSeek( $res, $row );
459 public function lastError() {
460 if ( $this->mConn
) {
461 # Even if it's non-zero, it can still be invalid
462 MediaWiki\
suppressWarnings();
463 $error = $this->mysqlError( $this->mConn
);
465 $error = $this->mysqlError();
467 MediaWiki\restoreWarnings
();
469 $error = $this->mysqlError();
472 $error .= ' (' . $this->mServer
. ')';
479 * Returns the text of the error message from previous MySQL operation
481 * @param resource $conn Raw connection
484 abstract protected function mysqlError( $conn = null );
487 * @param string $table
488 * @param array $uniqueIndexes
490 * @param string $fname
491 * @return ResultWrapper
493 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
494 return $this->nativeReplace( $table, $rows, $fname );
498 * Estimate rows in dataset
499 * Returns estimated count, based on EXPLAIN output
500 * Takes same arguments as Database::select()
502 * @param string|array $table
503 * @param string|array $vars
504 * @param string|array $conds
505 * @param string $fname
506 * @param string|array $options
509 public function estimateRowCount( $table, $vars = '*', $conds = '',
510 $fname = __METHOD__
, $options = []
512 $options['EXPLAIN'] = true;
513 $res = $this->select( $table, $vars, $conds, $fname, $options );
514 if ( $res === false ) {
517 if ( !$this->numRows( $res ) ) {
522 foreach ( $res as $plan ) {
523 $rows *= $plan->rows
> 0 ?
$plan->rows
: 1; // avoid resetting to zero
529 public function tableExists( $table, $fname = __METHOD__
) {
530 // Split database and table into proper variables as Database::tableName() returns
531 // shared tables prefixed with their database, which do not work in SHOW TABLES statements
532 list( $database, , $prefix, $table ) = $this->qualifiedTableComponents( $table );
533 $tableName = "{$prefix}{$table}";
535 if ( isset( $this->mSessionTempTables
[$tableName] ) ) {
536 return true; // already known to exist and won't show in SHOW TABLES anyway
539 // We can't use buildLike() here, because it specifies an escape character
540 // other than the backslash, which is the only one supported by SHOW TABLES
541 $encLike = $this->escapeLikeInternal( $tableName, '\\' );
543 // If the database has been specified (such as for shared tables), use "FROM"
544 if ( $database !== '' ) {
545 $encDatabase = $this->addIdentifierQuotes( $database );
546 $query = "SHOW TABLES FROM $encDatabase LIKE '$encLike'";
548 $query = "SHOW TABLES LIKE '$encLike'";
551 return $this->query( $query, $fname )->numRows() > 0;
555 * @param string $table
556 * @param string $field
557 * @return bool|MySQLField
559 public function fieldInfo( $table, $field ) {
560 $table = $this->tableName( $table );
561 $res = $this->query( "SELECT * FROM $table LIMIT 1", __METHOD__
, true );
565 $n = $this->mysqlNumFields( $res->result
);
566 for ( $i = 0; $i < $n; $i++
) {
567 $meta = $this->mysqlFetchField( $res->result
, $i );
568 if ( $field == $meta->name
) {
569 return new MySQLField( $meta );
577 * Get column information from a result
579 * @param resource $res Raw result
583 abstract protected function mysqlFetchField( $res, $n );
586 * Get information about an index into an object
587 * Returns false if the index does not exist
589 * @param string $table
590 * @param string $index
591 * @param string $fname
592 * @return bool|array|null False or null on failure
594 public function indexInfo( $table, $index, $fname = __METHOD__
) {
595 # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
596 # SHOW INDEX should work for 3.x and up:
597 # https://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
598 $table = $this->tableName( $table );
599 $index = $this->indexName( $index );
601 $sql = 'SHOW INDEX FROM ' . $table;
602 $res = $this->query( $sql, $fname );
610 foreach ( $res as $row ) {
611 if ( $row->Key_name
== $index ) {
616 return empty( $result ) ?
false : $result;
623 public function strencode( $s ) {
624 return $this->mysqlRealEscapeString( $s );
631 abstract protected function mysqlRealEscapeString( $s );
633 public function addQuotes( $s ) {
634 if ( is_bool( $s ) ) {
635 // Parent would transform to int, which does not play nice with MySQL type juggling.
636 // When searching for an int in a string column, the strings are cast to int, which
637 // means false would match any string not starting with a number.
638 $s = (string)(int)$s;
640 return parent
::addQuotes( $s );
644 * MySQL uses `backticks` for identifier quoting instead of the sql standard "double quotes".
649 public function addIdentifierQuotes( $s ) {
650 // Characters in the range \u0001-\uFFFF are valid in a quoted identifier
651 // Remove NUL bytes and escape backticks by doubling
652 return '`' . str_replace( [ "\0", '`' ], [ '', '``' ], $s ) . '`';
656 * @param string $name
659 public function isQuotedIdentifier( $name ) {
660 return strlen( $name ) && $name[0] == '`' && substr( $name, -1, 1 ) == '`';
663 public function getLag() {
664 if ( $this->getLagDetectionMethod() === 'pt-heartbeat' ) {
665 return $this->getLagFromPtHeartbeat();
667 return $this->getLagFromSlaveStatus();
674 protected function getLagDetectionMethod() {
675 return $this->lagDetectionMethod
;
681 protected function getLagFromSlaveStatus() {
682 $res = $this->query( 'SHOW SLAVE STATUS', __METHOD__
);
683 $row = $res ?
$res->fetchObject() : false;
684 if ( $row && strval( $row->Seconds_Behind_Master
) !== '' ) {
685 return intval( $row->Seconds_Behind_Master
);
694 protected function getLagFromPtHeartbeat() {
695 $options = $this->lagDetectionOptions
;
697 if ( isset( $options['conds'] ) ) {
698 // Best method for multi-DC setups: use logical channel names
699 $data = $this->getHeartbeatData( $options['conds'] );
701 // Standard method: use master server ID (works with stock pt-heartbeat)
702 $masterInfo = $this->getMasterServerInfo();
703 if ( !$masterInfo ) {
704 $this->queryLogger
->error(
705 "Unable to query master of {db_server} for server ID",
706 $this->getLogContext( [
707 'method' => __METHOD__
711 return false; // could not get master server ID
714 $conds = [ 'server_id' => intval( $masterInfo['serverId'] ) ];
715 $data = $this->getHeartbeatData( $conds );
718 list( $time, $nowUnix ) = $data;
719 if ( $time !== null ) {
720 // @time is in ISO format like "2015-09-25T16:48:10.000510"
721 $dateTime = new DateTime( $time, new DateTimeZone( 'UTC' ) );
722 $timeUnix = (int)$dateTime->format( 'U' ) +
$dateTime->format( 'u' ) / 1e6
;
724 return max( $nowUnix - $timeUnix, 0.0 );
727 $this->queryLogger
->error(
728 "Unable to find pt-heartbeat row for {db_server}",
729 $this->getLogContext( [
730 'method' => __METHOD__
737 protected function getMasterServerInfo() {
738 $cache = $this->srvCache
;
739 $key = $cache->makeGlobalKey(
742 // Using one key for all cluster replica DBs is preferable
743 $this->getLBInfo( 'clusterMasterHost' ) ?
: $this->getServer()
746 return $cache->getWithSetCallback(
748 $cache::TTL_INDEFINITE
,
749 function () use ( $cache, $key ) {
750 // Get and leave a lock key in place for a short period
751 if ( !$cache->lock( $key, 0, 10 ) ) {
752 return false; // avoid master connection spike slams
755 $conn = $this->getLazyMasterHandle();
757 return false; // something is misconfigured
760 // Connect to and query the master; catch errors to avoid outages
762 $res = $conn->query( 'SELECT @@server_id AS id', __METHOD__
);
763 $row = $res ?
$res->fetchObject() : false;
764 $id = $row ?
(int)$row->id
: 0;
765 } catch ( DBError
$e ) {
769 // Cache the ID if it was retrieved
770 return $id ?
[ 'serverId' => $id, 'asOf' => time() ] : false;
776 * @param array $conds WHERE clause conditions to find a row
777 * @return array (heartbeat `ts` column value or null, UNIX timestamp) for the newest beat
778 * @see https://www.percona.com/doc/percona-toolkit/2.1/pt-heartbeat.html
780 protected function getHeartbeatData( array $conds ) {
781 // Query time and trip time are not counted
782 $nowUnix = microtime( true );
783 // Do not bother starting implicit transactions here
784 $this->clearFlag( self
::DBO_TRX
, self
::REMEMBER_PRIOR
);
786 $whereSQL = $this->makeList( $conds, self
::LIST_AND
);
787 // Use ORDER BY for channel based queries since that field might not be UNIQUE.
788 // Note: this would use "TIMESTAMPDIFF(MICROSECOND,ts,UTC_TIMESTAMP(6))" but the
789 // percision field is not supported in MySQL <= 5.5.
791 "SELECT ts FROM heartbeat.heartbeat WHERE $whereSQL ORDER BY ts DESC LIMIT 1"
793 $row = $res ?
$res->fetchObject() : false;
795 $this->restoreFlags();
798 return [ $row ?
$row->ts
: null, $nowUnix ];
801 protected function getApproximateLagStatus() {
802 if ( $this->getLagDetectionMethod() === 'pt-heartbeat' ) {
803 // Disable caching since this is fast enough and we don't wan't
804 // to be *too* pessimistic by having both the cache TTL and the
805 // pt-heartbeat interval count as lag in getSessionLagStatus()
806 return parent
::getApproximateLagStatus();
809 $key = $this->srvCache
->makeGlobalKey( 'mysql-lag', $this->getServer() );
810 $approxLag = $this->srvCache
->get( $key );
812 $approxLag = parent
::getApproximateLagStatus();
813 $this->srvCache
->set( $key, $approxLag, 1 );
819 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
820 if ( !( $pos instanceof MySQLMasterPos
) ) {
821 throw new InvalidArgumentException( "Position not an instance of MySQLMasterPos" );
824 if ( $this->getLBInfo( 'is static' ) === true ) {
825 return 0; // this is a copy of a read-only dataset with no master DB
826 } elseif ( $this->lastKnownReplicaPos
&& $this->lastKnownReplicaPos
->hasReached( $pos ) ) {
827 return 0; // already reached this point for sure
830 // Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
831 if ( $this->useGTIDs
&& $pos->gtids
) {
832 // Wait on the GTID set (MariaDB only)
833 $gtidArg = $this->addQuotes( implode( ',', $pos->gtids
) );
834 $res = $this->doQuery( "SELECT MASTER_GTID_WAIT($gtidArg, $timeout)" );
836 // Wait on the binlog coordinates
837 $encFile = $this->addQuotes( $pos->file
);
838 $encPos = intval( $pos->pos
);
839 $res = $this->doQuery( "SELECT MASTER_POS_WAIT($encFile, $encPos, $timeout)" );
842 $row = $res ?
$this->fetchRow( $res ) : false;
844 throw new DBExpectedError( $this,
845 "MASTER_POS_WAIT() or MASTER_GTID_WAIT() failed: {$this->lastError()}" );
848 // Result can be NULL (error), -1 (timeout), or 0+ per the MySQL manual
849 $status = ( $row[0] !== null ) ?
intval( $row[0] ) : null;
850 if ( $status === null ) {
851 // T126436: jobs programmed to wait on master positions might be referencing binlogs
852 // with an old master hostname. Such calls make MASTER_POS_WAIT() return null. Try
853 // to detect this and treat the replica DB as having reached the position; a proper master
854 // switchover already requires that the new master be caught up before the switch.
855 $replicationPos = $this->getReplicaPos();
856 if ( $replicationPos && !$replicationPos->channelsMatch( $pos ) ) {
857 $this->lastKnownReplicaPos
= $replicationPos;
860 } elseif ( $status >= 0 ) {
861 // Remember that this position was reached to save queries next time
862 $this->lastKnownReplicaPos
= $pos;
869 * Get the position of the master from SHOW SLAVE STATUS
871 * @return MySQLMasterPos|bool
873 public function getReplicaPos() {
874 $res = $this->query( 'SHOW SLAVE STATUS', __METHOD__
);
875 $row = $this->fetchObject( $res );
878 $pos = isset( $row->Exec_master_log_pos
)
879 ?
$row->Exec_master_log_pos
880 : $row->Exec_Master_Log_Pos
;
881 // Also fetch the last-applied GTID set (MariaDB)
882 if ( $this->useGTIDs
) {
883 $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'gtid_slave_pos'", __METHOD__
);
884 $gtidRow = $this->fetchObject( $res );
885 $gtidSet = $gtidRow ?
$gtidRow->Value
: '';
890 return new MySQLMasterPos( $row->Relay_Master_Log_File
, $pos, $gtidSet );
897 * Get the position of the master from SHOW MASTER STATUS
899 * @return MySQLMasterPos|bool
901 public function getMasterPos() {
902 $res = $this->query( 'SHOW MASTER STATUS', __METHOD__
);
903 $row = $this->fetchObject( $res );
906 // Also fetch the last-written GTID set (MariaDB)
907 if ( $this->useGTIDs
) {
908 $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'gtid_binlog_pos'", __METHOD__
);
909 $gtidRow = $this->fetchObject( $res );
910 $gtidSet = $gtidRow ?
$gtidRow->Value
: '';
915 return new MySQLMasterPos( $row->File
, $row->Position
, $gtidSet );
921 public function serverIsReadOnly() {
922 $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'read_only'", __METHOD__
);
923 $row = $this->fetchObject( $res );
925 return $row ?
( strtolower( $row->Value
) === 'on' ) : false;
929 * @param string $index
932 function useIndexClause( $index ) {
933 return "FORCE INDEX (" . $this->indexName( $index ) . ")";
937 * @param string $index
940 function ignoreIndexClause( $index ) {
941 return "IGNORE INDEX (" . $this->indexName( $index ) . ")";
947 function lowPriorityOption() {
948 return 'LOW_PRIORITY';
954 public function getSoftwareLink() {
955 // MariaDB includes its name in its version string; this is how MariaDB's version of
956 // the mysql command-line client identifies MariaDB servers (see mariadb_connection()
957 // in libmysql/libmysql.c).
958 $version = $this->getServerVersion();
959 if ( strpos( $version, 'MariaDB' ) !== false ||
strpos( $version, '-maria-' ) !== false ) {
960 return '[{{int:version-db-mariadb-url}} MariaDB]';
963 // Percona Server's version suffix is not very distinctive, and @@version_comment
964 // doesn't give the necessary info for source builds, so assume the server is MySQL.
965 // (Even Percona's version of mysql doesn't try to make the distinction.)
966 return '[{{int:version-db-mysql-url}} MySQL]';
972 public function getServerVersion() {
973 // Not using mysql_get_server_info() or similar for consistency: in the handshake,
974 // MariaDB 10 adds the prefix "5.5.5-", and only some newer client libraries strip
975 // it off (see RPL_VERSION_HACK in include/mysql_com.h).
976 if ( $this->serverVersion
=== null ) {
977 $this->serverVersion
= $this->selectField( '', 'VERSION()', '', __METHOD__
);
979 return $this->serverVersion
;
983 * @param array $options
985 public function setSessionOptions( array $options ) {
986 if ( isset( $options['connTimeout'] ) ) {
987 $timeout = (int)$options['connTimeout'];
988 $this->query( "SET net_read_timeout=$timeout" );
989 $this->query( "SET net_write_timeout=$timeout" );
994 * @param string &$sql
995 * @param string &$newLine
998 public function streamStatementEnd( &$sql, &$newLine ) {
999 if ( strtoupper( substr( $newLine, 0, 9 ) ) == 'DELIMITER' ) {
1000 preg_match( '/^DELIMITER\s+(\S+)/', $newLine, $m );
1001 $this->delimiter
= $m[1];
1005 return parent
::streamStatementEnd( $sql, $newLine );
1009 * Check to see if a named lock is available. This is non-blocking.
1011 * @param string $lockName Name of lock to poll
1012 * @param string $method Name of method calling us
1016 public function lockIsFree( $lockName, $method ) {
1017 $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1018 $result = $this->query( "SELECT IS_FREE_LOCK($encName) AS lockstatus", $method );
1019 $row = $this->fetchObject( $result );
1021 return ( $row->lockstatus
== 1 );
1025 * @param string $lockName
1026 * @param string $method
1027 * @param int $timeout
1030 public function lock( $lockName, $method, $timeout = 5 ) {
1031 $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1032 $result = $this->query( "SELECT GET_LOCK($encName, $timeout) AS lockstatus", $method );
1033 $row = $this->fetchObject( $result );
1035 if ( $row->lockstatus
== 1 ) {
1036 parent
::lock( $lockName, $method, $timeout ); // record
1040 $this->queryLogger
->warning( __METHOD__
. " failed to acquire lock '$lockName'\n" );
1047 * https://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock
1048 * @param string $lockName
1049 * @param string $method
1052 public function unlock( $lockName, $method ) {
1053 $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1054 $result = $this->query( "SELECT RELEASE_LOCK($encName) as lockstatus", $method );
1055 $row = $this->fetchObject( $result );
1057 if ( $row->lockstatus
== 1 ) {
1058 parent
::unlock( $lockName, $method ); // record
1062 $this->queryLogger
->warning( __METHOD__
. " failed to release lock '$lockName'\n" );
1067 private function makeLockName( $lockName ) {
1068 // https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
1069 // Newer version enforce a 64 char length limit.
1070 return ( strlen( $lockName ) > 64 ) ?
sha1( $lockName ) : $lockName;
1073 public function namedLocksEnqueue() {
1077 public function tableLocksHaveTransactionScope() {
1078 return false; // tied to TCP connection
1081 protected function doLockTables( array $read, array $write, $method ) {
1083 foreach ( $write as $table ) {
1084 $items[] = $this->tableName( $table ) . ' WRITE';
1086 foreach ( $read as $table ) {
1087 $items[] = $this->tableName( $table ) . ' READ';
1090 $sql = "LOCK TABLES " . implode( ',', $items );
1091 $this->query( $sql, $method );
1096 protected function doUnlockTables( $method ) {
1097 $this->query( "UNLOCK TABLES", $method );
1103 * @param bool $value
1105 public function setBigSelects( $value = true ) {
1106 if ( $value === 'default' ) {
1107 if ( $this->mDefaultBigSelects
=== null ) {
1108 # Function hasn't been called before so it must already be set to the default
1111 $value = $this->mDefaultBigSelects
;
1113 } elseif ( $this->mDefaultBigSelects
=== null ) {
1114 $this->mDefaultBigSelects
=
1115 (bool)$this->selectField( false, '@@sql_big_selects', '', __METHOD__
);
1117 $encValue = $value ?
'1' : '0';
1118 $this->query( "SET sql_big_selects=$encValue", __METHOD__
);
1122 * DELETE where the condition is a join. MySql uses multi-table deletes.
1123 * @param string $delTable
1124 * @param string $joinTable
1125 * @param string $delVar
1126 * @param string $joinVar
1127 * @param array|string $conds
1128 * @param bool|string $fname
1129 * @throws DBUnexpectedError
1130 * @return bool|ResultWrapper
1132 public function deleteJoin(
1133 $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
1136 throw new DBUnexpectedError( $this, __METHOD__
. ' called with empty $conds' );
1139 $delTable = $this->tableName( $delTable );
1140 $joinTable = $this->tableName( $joinTable );
1141 $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
1143 if ( $conds != '*' ) {
1144 $sql .= ' AND ' . $this->makeList( $conds, self
::LIST_AND
);
1147 return $this->query( $sql, $fname );
1151 * @param string $table
1152 * @param array $rows
1153 * @param array $uniqueIndexes
1155 * @param string $fname
1158 public function upsert( $table, array $rows, array $uniqueIndexes,
1159 array $set, $fname = __METHOD__
1161 if ( !count( $rows ) ) {
1162 return true; // nothing to do
1165 if ( !is_array( reset( $rows ) ) ) {
1169 $table = $this->tableName( $table );
1170 $columns = array_keys( $rows[0] );
1172 $sql = "INSERT INTO $table (" . implode( ',', $columns ) . ') VALUES ';
1174 foreach ( $rows as $row ) {
1175 $rowTuples[] = '(' . $this->makeList( $row ) . ')';
1177 $sql .= implode( ',', $rowTuples );
1178 $sql .= " ON DUPLICATE KEY UPDATE " . $this->makeList( $set, self
::LIST_SET
);
1180 return (bool)$this->query( $sql, $fname );
1184 * Determines how long the server has been up
1188 public function getServerUptime() {
1189 $vars = $this->getMysqlStatus( 'Uptime' );
1191 return (int)$vars['Uptime'];
1195 * Determines if the last failure was due to a deadlock
1199 public function wasDeadlock() {
1200 return $this->lastErrno() == 1213;
1204 * Determines if the last failure was due to a lock timeout
1208 public function wasLockTimeout() {
1209 return $this->lastErrno() == 1205;
1212 public function wasErrorReissuable() {
1213 return $this->lastErrno() == 2013 ||
$this->lastErrno() == 2006;
1217 * Determines if the last failure was due to the database being read-only.
1221 public function wasReadOnlyError() {
1222 return $this->lastErrno() == 1223 ||
1223 ( $this->lastErrno() == 1290 && strpos( $this->lastError(), '--read-only' ) !== false );
1226 public function wasConnectionError( $errno ) {
1227 return $errno == 2013 ||
$errno == 2006;
1231 * @param string $oldName
1232 * @param string $newName
1233 * @param bool $temporary
1234 * @param string $fname
1237 public function duplicateTableStructure(
1238 $oldName, $newName, $temporary = false, $fname = __METHOD__
1240 $tmp = $temporary ?
'TEMPORARY ' : '';
1241 $newName = $this->addIdentifierQuotes( $newName );
1242 $oldName = $this->addIdentifierQuotes( $oldName );
1243 $query = "CREATE $tmp TABLE $newName (LIKE $oldName)";
1245 return $this->query( $query, $fname );
1249 * List all tables on the database
1251 * @param string $prefix Only show tables with this prefix, e.g. mw_
1252 * @param string $fname Calling function name
1255 public function listTables( $prefix = null, $fname = __METHOD__
) {
1256 $result = $this->query( "SHOW TABLES", $fname );
1260 foreach ( $result as $table ) {
1261 $vars = get_object_vars( $table );
1262 $table = array_pop( $vars );
1264 if ( !$prefix ||
strpos( $table, $prefix ) === 0 ) {
1265 $endArray[] = $table;
1273 * @param string $tableName
1274 * @param string $fName
1275 * @return bool|ResultWrapper
1277 public function dropTable( $tableName, $fName = __METHOD__
) {
1278 if ( !$this->tableExists( $tableName, $fName ) ) {
1282 return $this->query( "DROP TABLE IF EXISTS " . $this->tableName( $tableName ), $fName );
1286 * Get status information from SHOW STATUS in an associative array
1288 * @param string $which
1291 private function getMysqlStatus( $which = "%" ) {
1292 $res = $this->query( "SHOW STATUS LIKE '{$which}'" );
1295 foreach ( $res as $row ) {
1296 $status[$row->Variable_name
] = $row->Value
;
1303 * Lists VIEWs in the database
1305 * @param string $prefix Only show VIEWs with this prefix, eg.
1306 * unit_test_, or $wgDBprefix. Default: null, would return all views.
1307 * @param string $fname Name of calling function
1311 public function listViews( $prefix = null, $fname = __METHOD__
) {
1312 // The name of the column containing the name of the VIEW
1313 $propertyName = 'Tables_in_' . $this->mDBname
;
1315 // Query for the VIEWS
1316 $res = $this->query( 'SHOW FULL TABLES WHERE TABLE_TYPE = "VIEW"' );
1318 foreach ( $res as $row ) {
1319 array_push( $allViews, $row->$propertyName );
1322 if ( is_null( $prefix ) ||
$prefix === '' ) {
1326 $filteredViews = [];
1327 foreach ( $allViews as $viewName ) {
1328 // Does the name of this VIEW start with the table-prefix?
1329 if ( strpos( $viewName, $prefix ) === 0 ) {
1330 array_push( $filteredViews, $viewName );
1334 return $filteredViews;
1338 * Differentiates between a TABLE and a VIEW.
1340 * @param string $name Name of the TABLE/VIEW to test
1341 * @param string $prefix
1345 public function isView( $name, $prefix = null ) {
1346 return in_array( $name, $this->listViews( $prefix ) );
1350 * Allows for index remapping in queries where this is not consistent across DBMS
1352 * @param string $index
1355 protected function indexName( $index ) {
1357 * When SQLite indexes were introduced in r45764, it was noted that
1358 * SQLite requires index names to be unique within the whole database,
1359 * not just within a schema. As discussed in CR r45819, to avoid the
1360 * need for a schema change on existing installations, the indexes
1361 * were implicitly mapped from the new names to the old names.
1363 * This mapping can be removed if DB patches are introduced to alter
1364 * the relevant tables in existing installations. Note that because
1365 * this index mapping applies to table creation, even new installations
1366 * of MySQL have the old names (except for installations created during
1367 * a period where this mapping was inappropriately removed, see
1371 'ar_usertext_timestamp' => 'usertext_timestamp',
1372 'un_user_id' => 'user_id',
1373 'un_user_ip' => 'user_ip',
1376 if ( isset( $renamed[$index] ) ) {
1377 return $renamed[$index];
1384 class_alias( DatabaseMysqlBase
::class, 'DatabaseMysqlBase' );