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 $table = $this->tableName( $table, 'raw' );
531 if ( isset( $this->mSessionTempTables
[$table] ) ) {
532 return true; // already known to exist and won't show in SHOW TABLES anyway
535 $encLike = $this->buildLike( $table );
537 return $this->query( "SHOW TABLES $encLike", $fname )->numRows() > 0;
541 * @param string $table
542 * @param string $field
543 * @return bool|MySQLField
545 public function fieldInfo( $table, $field ) {
546 $table = $this->tableName( $table );
547 $res = $this->query( "SELECT * FROM $table LIMIT 1", __METHOD__
, true );
551 $n = $this->mysqlNumFields( $res->result
);
552 for ( $i = 0; $i < $n; $i++
) {
553 $meta = $this->mysqlFetchField( $res->result
, $i );
554 if ( $field == $meta->name
) {
555 return new MySQLField( $meta );
563 * Get column information from a result
565 * @param resource $res Raw result
569 abstract protected function mysqlFetchField( $res, $n );
572 * Get information about an index into an object
573 * Returns false if the index does not exist
575 * @param string $table
576 * @param string $index
577 * @param string $fname
578 * @return bool|array|null False or null on failure
580 public function indexInfo( $table, $index, $fname = __METHOD__
) {
581 # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
582 # SHOW INDEX should work for 3.x and up:
583 # https://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
584 $table = $this->tableName( $table );
585 $index = $this->indexName( $index );
587 $sql = 'SHOW INDEX FROM ' . $table;
588 $res = $this->query( $sql, $fname );
596 foreach ( $res as $row ) {
597 if ( $row->Key_name
== $index ) {
602 return empty( $result ) ?
false : $result;
609 public function strencode( $s ) {
610 return $this->mysqlRealEscapeString( $s );
617 abstract protected function mysqlRealEscapeString( $s );
619 public function addQuotes( $s ) {
620 if ( is_bool( $s ) ) {
621 // Parent would transform to int, which does not play nice with MySQL type juggling.
622 // When searching for an int in a string column, the strings are cast to int, which
623 // means false would match any string not starting with a number.
624 $s = (string)(int)$s;
626 return parent
::addQuotes( $s );
630 * MySQL uses `backticks` for identifier quoting instead of the sql standard "double quotes".
635 public function addIdentifierQuotes( $s ) {
636 // Characters in the range \u0001-\uFFFF are valid in a quoted identifier
637 // Remove NUL bytes and escape backticks by doubling
638 return '`' . str_replace( [ "\0", '`' ], [ '', '``' ], $s ) . '`';
642 * @param string $name
645 public function isQuotedIdentifier( $name ) {
646 return strlen( $name ) && $name[0] == '`' && substr( $name, -1, 1 ) == '`';
649 public function getLag() {
650 if ( $this->getLagDetectionMethod() === 'pt-heartbeat' ) {
651 return $this->getLagFromPtHeartbeat();
653 return $this->getLagFromSlaveStatus();
660 protected function getLagDetectionMethod() {
661 return $this->lagDetectionMethod
;
667 protected function getLagFromSlaveStatus() {
668 $res = $this->query( 'SHOW SLAVE STATUS', __METHOD__
);
669 $row = $res ?
$res->fetchObject() : false;
670 if ( $row && strval( $row->Seconds_Behind_Master
) !== '' ) {
671 return intval( $row->Seconds_Behind_Master
);
680 protected function getLagFromPtHeartbeat() {
681 $options = $this->lagDetectionOptions
;
683 if ( isset( $options['conds'] ) ) {
684 // Best method for multi-DC setups: use logical channel names
685 $data = $this->getHeartbeatData( $options['conds'] );
687 // Standard method: use master server ID (works with stock pt-heartbeat)
688 $masterInfo = $this->getMasterServerInfo();
689 if ( !$masterInfo ) {
690 $this->queryLogger
->error(
691 "Unable to query master of {db_server} for server ID",
692 $this->getLogContext( [
693 'method' => __METHOD__
697 return false; // could not get master server ID
700 $conds = [ 'server_id' => intval( $masterInfo['serverId'] ) ];
701 $data = $this->getHeartbeatData( $conds );
704 list( $time, $nowUnix ) = $data;
705 if ( $time !== null ) {
706 // @time is in ISO format like "2015-09-25T16:48:10.000510"
707 $dateTime = new DateTime( $time, new DateTimeZone( 'UTC' ) );
708 $timeUnix = (int)$dateTime->format( 'U' ) +
$dateTime->format( 'u' ) / 1e6
;
710 return max( $nowUnix - $timeUnix, 0.0 );
713 $this->queryLogger
->error(
714 "Unable to find pt-heartbeat row for {db_server}",
715 $this->getLogContext( [
716 'method' => __METHOD__
723 protected function getMasterServerInfo() {
724 $cache = $this->srvCache
;
725 $key = $cache->makeGlobalKey(
728 // Using one key for all cluster replica DBs is preferable
729 $this->getLBInfo( 'clusterMasterHost' ) ?
: $this->getServer()
732 return $cache->getWithSetCallback(
734 $cache::TTL_INDEFINITE
,
735 function () use ( $cache, $key ) {
736 // Get and leave a lock key in place for a short period
737 if ( !$cache->lock( $key, 0, 10 ) ) {
738 return false; // avoid master connection spike slams
741 $conn = $this->getLazyMasterHandle();
743 return false; // something is misconfigured
746 // Connect to and query the master; catch errors to avoid outages
748 $res = $conn->query( 'SELECT @@server_id AS id', __METHOD__
);
749 $row = $res ?
$res->fetchObject() : false;
750 $id = $row ?
(int)$row->id
: 0;
751 } catch ( DBError
$e ) {
755 // Cache the ID if it was retrieved
756 return $id ?
[ 'serverId' => $id, 'asOf' => time() ] : false;
762 * @param array $conds WHERE clause conditions to find a row
763 * @return array (heartbeat `ts` column value or null, UNIX timestamp) for the newest beat
764 * @see https://www.percona.com/doc/percona-toolkit/2.1/pt-heartbeat.html
766 protected function getHeartbeatData( array $conds ) {
767 // Do not bother starting implicit transactions here
768 $this->clearFlag( self
::DBO_TRX
, self
::REMEMBER_PRIOR
);
770 $whereSQL = $this->makeList( $conds, self
::LIST_AND
);
771 // Use ORDER BY for channel based queries since that field might not be UNIQUE.
772 // Note: this would use "TIMESTAMPDIFF(MICROSECOND,ts,UTC_TIMESTAMP(6))" but the
773 // percision field is not supported in MySQL <= 5.5.
775 "SELECT ts FROM heartbeat.heartbeat WHERE $whereSQL ORDER BY ts DESC LIMIT 1"
777 $row = $res ?
$res->fetchObject() : false;
779 $this->restoreFlags();
782 return [ $row ?
$row->ts
: null, microtime( true ) ];
785 protected function getApproximateLagStatus() {
786 if ( $this->getLagDetectionMethod() === 'pt-heartbeat' ) {
787 // Disable caching since this is fast enough and we don't wan't
788 // to be *too* pessimistic by having both the cache TTL and the
789 // pt-heartbeat interval count as lag in getSessionLagStatus()
790 return parent
::getApproximateLagStatus();
793 $key = $this->srvCache
->makeGlobalKey( 'mysql-lag', $this->getServer() );
794 $approxLag = $this->srvCache
->get( $key );
796 $approxLag = parent
::getApproximateLagStatus();
797 $this->srvCache
->set( $key, $approxLag, 1 );
803 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
804 if ( !( $pos instanceof MySQLMasterPos
) ) {
805 throw new InvalidArgumentException( "Position not an instance of MySQLMasterPos" );
808 if ( $this->getLBInfo( 'is static' ) === true ) {
809 return 0; // this is a copy of a read-only dataset with no master DB
810 } elseif ( $this->lastKnownReplicaPos
&& $this->lastKnownReplicaPos
->hasReached( $pos ) ) {
811 return 0; // already reached this point for sure
814 // Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
815 if ( $this->useGTIDs
&& $pos->gtids
) {
816 // Wait on the GTID set (MariaDB only)
817 $gtidArg = $this->addQuotes( implode( ',', $pos->gtids
) );
818 $res = $this->doQuery( "SELECT MASTER_GTID_WAIT($gtidArg, $timeout)" );
820 // Wait on the binlog coordinates
821 $encFile = $this->addQuotes( $pos->file
);
822 $encPos = intval( $pos->pos
);
823 $res = $this->doQuery( "SELECT MASTER_POS_WAIT($encFile, $encPos, $timeout)" );
826 $row = $res ?
$this->fetchRow( $res ) : false;
828 throw new DBExpectedError( $this,
829 "MASTER_POS_WAIT() or MASTER_GTID_WAIT() failed: {$this->lastError()}" );
832 // Result can be NULL (error), -1 (timeout), or 0+ per the MySQL manual
833 $status = ( $row[0] !== null ) ?
intval( $row[0] ) : null;
834 if ( $status === null ) {
835 // T126436: jobs programmed to wait on master positions might be referencing binlogs
836 // with an old master hostname. Such calls make MASTER_POS_WAIT() return null. Try
837 // to detect this and treat the replica DB as having reached the position; a proper master
838 // switchover already requires that the new master be caught up before the switch.
839 $replicationPos = $this->getReplicaPos();
840 if ( $replicationPos && !$replicationPos->channelsMatch( $pos ) ) {
841 $this->lastKnownReplicaPos
= $replicationPos;
844 } elseif ( $status >= 0 ) {
845 // Remember that this position was reached to save queries next time
846 $this->lastKnownReplicaPos
= $pos;
853 * Get the position of the master from SHOW SLAVE STATUS
855 * @return MySQLMasterPos|bool
857 public function getReplicaPos() {
858 $res = $this->query( 'SHOW SLAVE STATUS', __METHOD__
);
859 $row = $this->fetchObject( $res );
862 $pos = isset( $row->Exec_master_log_pos
)
863 ?
$row->Exec_master_log_pos
864 : $row->Exec_Master_Log_Pos
;
865 // Also fetch the last-applied GTID set (MariaDB)
866 if ( $this->useGTIDs
) {
867 $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'gtid_slave_pos'", __METHOD__
);
868 $gtidRow = $this->fetchObject( $res );
869 $gtidSet = $gtidRow ?
$gtidRow->Value
: '';
874 return new MySQLMasterPos( $row->Relay_Master_Log_File
, $pos, $gtidSet );
881 * Get the position of the master from SHOW MASTER STATUS
883 * @return MySQLMasterPos|bool
885 public function getMasterPos() {
886 $res = $this->query( 'SHOW MASTER STATUS', __METHOD__
);
887 $row = $this->fetchObject( $res );
890 // Also fetch the last-written GTID set (MariaDB)
891 if ( $this->useGTIDs
) {
892 $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'gtid_binlog_pos'", __METHOD__
);
893 $gtidRow = $this->fetchObject( $res );
894 $gtidSet = $gtidRow ?
$gtidRow->Value
: '';
899 return new MySQLMasterPos( $row->File
, $row->Position
, $gtidSet );
905 public function serverIsReadOnly() {
906 $res = $this->query( "SHOW GLOBAL VARIABLES LIKE 'read_only'", __METHOD__
);
907 $row = $this->fetchObject( $res );
909 return $row ?
( strtolower( $row->Value
) === 'on' ) : false;
913 * @param string $index
916 function useIndexClause( $index ) {
917 return "FORCE INDEX (" . $this->indexName( $index ) . ")";
921 * @param string $index
924 function ignoreIndexClause( $index ) {
925 return "IGNORE INDEX (" . $this->indexName( $index ) . ")";
931 function lowPriorityOption() {
932 return 'LOW_PRIORITY';
938 public function getSoftwareLink() {
939 // MariaDB includes its name in its version string; this is how MariaDB's version of
940 // the mysql command-line client identifies MariaDB servers (see mariadb_connection()
941 // in libmysql/libmysql.c).
942 $version = $this->getServerVersion();
943 if ( strpos( $version, 'MariaDB' ) !== false ||
strpos( $version, '-maria-' ) !== false ) {
944 return '[{{int:version-db-mariadb-url}} MariaDB]';
947 // Percona Server's version suffix is not very distinctive, and @@version_comment
948 // doesn't give the necessary info for source builds, so assume the server is MySQL.
949 // (Even Percona's version of mysql doesn't try to make the distinction.)
950 return '[{{int:version-db-mysql-url}} MySQL]';
956 public function getServerVersion() {
957 // Not using mysql_get_server_info() or similar for consistency: in the handshake,
958 // MariaDB 10 adds the prefix "5.5.5-", and only some newer client libraries strip
959 // it off (see RPL_VERSION_HACK in include/mysql_com.h).
960 if ( $this->serverVersion
=== null ) {
961 $this->serverVersion
= $this->selectField( '', 'VERSION()', '', __METHOD__
);
963 return $this->serverVersion
;
967 * @param array $options
969 public function setSessionOptions( array $options ) {
970 if ( isset( $options['connTimeout'] ) ) {
971 $timeout = (int)$options['connTimeout'];
972 $this->query( "SET net_read_timeout=$timeout" );
973 $this->query( "SET net_write_timeout=$timeout" );
979 * @param string $newLine
982 public function streamStatementEnd( &$sql, &$newLine ) {
983 if ( strtoupper( substr( $newLine, 0, 9 ) ) == 'DELIMITER' ) {
984 preg_match( '/^DELIMITER\s+(\S+)/', $newLine, $m );
985 $this->delimiter
= $m[1];
989 return parent
::streamStatementEnd( $sql, $newLine );
993 * Check to see if a named lock is available. This is non-blocking.
995 * @param string $lockName Name of lock to poll
996 * @param string $method Name of method calling us
1000 public function lockIsFree( $lockName, $method ) {
1001 $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1002 $result = $this->query( "SELECT IS_FREE_LOCK($encName) AS lockstatus", $method );
1003 $row = $this->fetchObject( $result );
1005 return ( $row->lockstatus
== 1 );
1009 * @param string $lockName
1010 * @param string $method
1011 * @param int $timeout
1014 public function lock( $lockName, $method, $timeout = 5 ) {
1015 $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1016 $result = $this->query( "SELECT GET_LOCK($encName, $timeout) AS lockstatus", $method );
1017 $row = $this->fetchObject( $result );
1019 if ( $row->lockstatus
== 1 ) {
1020 parent
::lock( $lockName, $method, $timeout ); // record
1024 $this->queryLogger
->warning( __METHOD__
. " failed to acquire lock '$lockName'\n" );
1031 * https://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock
1032 * @param string $lockName
1033 * @param string $method
1036 public function unlock( $lockName, $method ) {
1037 $encName = $this->addQuotes( $this->makeLockName( $lockName ) );
1038 $result = $this->query( "SELECT RELEASE_LOCK($encName) as lockstatus", $method );
1039 $row = $this->fetchObject( $result );
1041 if ( $row->lockstatus
== 1 ) {
1042 parent
::unlock( $lockName, $method ); // record
1046 $this->queryLogger
->warning( __METHOD__
. " failed to release lock '$lockName'\n" );
1051 private function makeLockName( $lockName ) {
1052 // https://dev.mysql.com/doc/refman/5.7/en/miscellaneous-functions.html#function_get-lock
1053 // Newer version enforce a 64 char length limit.
1054 return ( strlen( $lockName ) > 64 ) ?
sha1( $lockName ) : $lockName;
1057 public function namedLocksEnqueue() {
1061 public function tableLocksHaveTransactionScope() {
1062 return false; // tied to TCP connection
1065 protected function doLockTables( array $read, array $write, $method ) {
1067 foreach ( $write as $table ) {
1068 $items[] = $this->tableName( $table ) . ' WRITE';
1070 foreach ( $read as $table ) {
1071 $items[] = $this->tableName( $table ) . ' READ';
1074 $sql = "LOCK TABLES " . implode( ',', $items );
1075 $this->query( $sql, $method );
1080 protected function doUnlockTables( $method ) {
1081 $this->query( "UNLOCK TABLES", $method );
1087 * @param bool $value
1089 public function setBigSelects( $value = true ) {
1090 if ( $value === 'default' ) {
1091 if ( $this->mDefaultBigSelects
=== null ) {
1092 # Function hasn't been called before so it must already be set to the default
1095 $value = $this->mDefaultBigSelects
;
1097 } elseif ( $this->mDefaultBigSelects
=== null ) {
1098 $this->mDefaultBigSelects
=
1099 (bool)$this->selectField( false, '@@sql_big_selects', '', __METHOD__
);
1101 $encValue = $value ?
'1' : '0';
1102 $this->query( "SET sql_big_selects=$encValue", __METHOD__
);
1106 * DELETE where the condition is a join. MySql uses multi-table deletes.
1107 * @param string $delTable
1108 * @param string $joinTable
1109 * @param string $delVar
1110 * @param string $joinVar
1111 * @param array|string $conds
1112 * @param bool|string $fname
1113 * @throws DBUnexpectedError
1114 * @return bool|ResultWrapper
1116 public function deleteJoin(
1117 $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
1120 throw new DBUnexpectedError( $this, __METHOD__
. ' called with empty $conds' );
1123 $delTable = $this->tableName( $delTable );
1124 $joinTable = $this->tableName( $joinTable );
1125 $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
1127 if ( $conds != '*' ) {
1128 $sql .= ' AND ' . $this->makeList( $conds, self
::LIST_AND
);
1131 return $this->query( $sql, $fname );
1135 * @param string $table
1136 * @param array $rows
1137 * @param array $uniqueIndexes
1139 * @param string $fname
1142 public function upsert( $table, array $rows, array $uniqueIndexes,
1143 array $set, $fname = __METHOD__
1145 if ( !count( $rows ) ) {
1146 return true; // nothing to do
1149 if ( !is_array( reset( $rows ) ) ) {
1153 $table = $this->tableName( $table );
1154 $columns = array_keys( $rows[0] );
1156 $sql = "INSERT INTO $table (" . implode( ',', $columns ) . ') VALUES ';
1158 foreach ( $rows as $row ) {
1159 $rowTuples[] = '(' . $this->makeList( $row ) . ')';
1161 $sql .= implode( ',', $rowTuples );
1162 $sql .= " ON DUPLICATE KEY UPDATE " . $this->makeList( $set, self
::LIST_SET
);
1164 return (bool)$this->query( $sql, $fname );
1168 * Determines how long the server has been up
1172 public function getServerUptime() {
1173 $vars = $this->getMysqlStatus( 'Uptime' );
1175 return (int)$vars['Uptime'];
1179 * Determines if the last failure was due to a deadlock
1183 public function wasDeadlock() {
1184 return $this->lastErrno() == 1213;
1188 * Determines if the last failure was due to a lock timeout
1192 public function wasLockTimeout() {
1193 return $this->lastErrno() == 1205;
1196 public function wasErrorReissuable() {
1197 return $this->lastErrno() == 2013 ||
$this->lastErrno() == 2006;
1201 * Determines if the last failure was due to the database being read-only.
1205 public function wasReadOnlyError() {
1206 return $this->lastErrno() == 1223 ||
1207 ( $this->lastErrno() == 1290 && strpos( $this->lastError(), '--read-only' ) !== false );
1210 public function wasConnectionError( $errno ) {
1211 return $errno == 2013 ||
$errno == 2006;
1215 * @param string $oldName
1216 * @param string $newName
1217 * @param bool $temporary
1218 * @param string $fname
1221 public function duplicateTableStructure(
1222 $oldName, $newName, $temporary = false, $fname = __METHOD__
1224 $tmp = $temporary ?
'TEMPORARY ' : '';
1225 $newName = $this->addIdentifierQuotes( $newName );
1226 $oldName = $this->addIdentifierQuotes( $oldName );
1227 $query = "CREATE $tmp TABLE $newName (LIKE $oldName)";
1229 return $this->query( $query, $fname );
1233 * List all tables on the database
1235 * @param string $prefix Only show tables with this prefix, e.g. mw_
1236 * @param string $fname Calling function name
1239 public function listTables( $prefix = null, $fname = __METHOD__
) {
1240 $result = $this->query( "SHOW TABLES", $fname );
1244 foreach ( $result as $table ) {
1245 $vars = get_object_vars( $table );
1246 $table = array_pop( $vars );
1248 if ( !$prefix ||
strpos( $table, $prefix ) === 0 ) {
1249 $endArray[] = $table;
1257 * @param string $tableName
1258 * @param string $fName
1259 * @return bool|ResultWrapper
1261 public function dropTable( $tableName, $fName = __METHOD__
) {
1262 if ( !$this->tableExists( $tableName, $fName ) ) {
1266 return $this->query( "DROP TABLE IF EXISTS " . $this->tableName( $tableName ), $fName );
1270 * Get status information from SHOW STATUS in an associative array
1272 * @param string $which
1275 private function getMysqlStatus( $which = "%" ) {
1276 $res = $this->query( "SHOW STATUS LIKE '{$which}'" );
1279 foreach ( $res as $row ) {
1280 $status[$row->Variable_name
] = $row->Value
;
1287 * Lists VIEWs in the database
1289 * @param string $prefix Only show VIEWs with this prefix, eg.
1290 * unit_test_, or $wgDBprefix. Default: null, would return all views.
1291 * @param string $fname Name of calling function
1295 public function listViews( $prefix = null, $fname = __METHOD__
) {
1296 // The name of the column containing the name of the VIEW
1297 $propertyName = 'Tables_in_' . $this->mDBname
;
1299 // Query for the VIEWS
1300 $res = $this->query( 'SHOW FULL TABLES WHERE TABLE_TYPE = "VIEW"' );
1302 foreach ( $res as $row ) {
1303 array_push( $allViews, $row->$propertyName );
1306 if ( is_null( $prefix ) ||
$prefix === '' ) {
1310 $filteredViews = [];
1311 foreach ( $allViews as $viewName ) {
1312 // Does the name of this VIEW start with the table-prefix?
1313 if ( strpos( $viewName, $prefix ) === 0 ) {
1314 array_push( $filteredViews, $viewName );
1318 return $filteredViews;
1322 * Differentiates between a TABLE and a VIEW.
1324 * @param string $name Name of the TABLE/VIEW to test
1325 * @param string $prefix
1329 public function isView( $name, $prefix = null ) {
1330 return in_array( $name, $this->listViews( $prefix ) );
1334 * Allows for index remapping in queries where this is not consistent across DBMS
1336 * @param string $index
1339 protected function indexName( $index ) {
1341 * When SQLite indexes were introduced in r45764, it was noted that
1342 * SQLite requires index names to be unique within the whole database,
1343 * not just within a schema. As discussed in CR r45819, to avoid the
1344 * need for a schema change on existing installations, the indexes
1345 * were implicitly mapped from the new names to the old names.
1347 * This mapping can be removed if DB patches are introduced to alter
1348 * the relevant tables in existing installations. Note that because
1349 * this index mapping applies to table creation, even new installations
1350 * of MySQL have the old names (except for installations created during
1351 * a period where this mapping was inappropriately removed, see
1355 'ar_usertext_timestamp' => 'usertext_timestamp',
1356 'un_user_id' => 'user_id',
1357 'un_user_ip' => 'user_ip',
1360 if ( isset( $renamed[$index] ) ) {
1361 return $renamed[$index];
1368 class_alias( DatabaseMysqlBase
::class, 'DatabaseMysqlBase' );