314b6edd8b9da1fe005d7c03ec32c9800ebad2a3
3 * This is the MySQL database abstraction layer.
10 * Database abstraction object for mySQL
11 * Inherit all methods and properties of Database::Database()
16 class DatabaseMysql
extends DatabaseBase
{
21 protected function doQuery( $sql ) {
22 if( $this->bufferResults() ) {
23 $ret = mysql_query( $sql, $this->mConn
);
25 $ret = mysql_unbuffered_query( $sql, $this->mConn
);
30 function open( $server, $user, $password, $dbName ) {
31 global $wgAllDBsAreLocalhost;
32 wfProfileIn( __METHOD__
);
34 # Load mysql.so if we don't have it
38 # Otherwise we get a suppressed fatal error, which is very hard to track down
39 if ( !function_exists( 'mysql_connect' ) ) {
40 throw new DBConnectionError( $this, "MySQL functions missing, have you compiled PHP with the --with-mysql option?\n" );
43 # Debugging hack -- fake cluster
44 if ( $wgAllDBsAreLocalhost ) {
45 $realServer = 'localhost';
47 $realServer = $server;
50 $this->mServer
= $server;
52 $this->mPassword
= $password;
53 $this->mDBname
= $dbName;
55 wfProfileIn("dbconnect-$server");
57 # The kernel's default SYN retransmission period is far too slow for us,
58 # so we use a short timeout plus a manual retry. Retrying means that a small
59 # but finite rate of SYN packet loss won't cause user-visible errors.
61 if ( ini_get( 'mysql.connect_timeout' ) <= 3 ) {
66 $this->installErrorHandler();
67 for ( $i = 0; $i < $numAttempts && !$this->mConn
; $i++
) {
71 if ( $this->mFlags
& DBO_PERSISTENT
) {
72 $this->mConn
= mysql_pconnect( $realServer, $user, $password );
74 # Create a new connection...
75 $this->mConn
= mysql_connect( $realServer, $user, $password, true );
77 #if ( $this->mConn === false ) {
79 #wfLogDBError("Connect loop error $iplus of $max ($server): " . mysql_errno() . " - " . mysql_error()."\n");
82 $phpError = $this->restoreErrorHandler();
83 # Always log connection errors
84 if ( !$this->mConn
) {
85 $error = $this->lastError();
89 wfLogDBError( "Error connecting to {$this->mServer}: $error\n" );
90 wfDebug( "DB connection error\n" );
91 wfDebug( "Server: $server, User: $user, Password: " .
92 substr( $password, 0, 3 ) . "..., error: " . mysql_error() . "\n" );
95 wfProfileOut("dbconnect-$server");
97 if ( $dbName != '' && $this->mConn
!== false ) {
99 $success = mysql_select_db( $dbName, $this->mConn
);
102 $error = "Error selecting database $dbName on server {$this->mServer} " .
103 "from client host " . wfHostname() . "\n";
104 wfLogDBError(" Error selecting database $dbName on server {$this->mServer} \n");
109 $success = (bool)$this->mConn
;
113 $version = $this->getServerVersion();
114 if ( version_compare( $version, '4.1' ) >= 0 ) {
115 // Tell the server we're communicating with it in UTF-8.
116 // This may engage various charset conversions.
119 $this->query( 'SET NAMES utf8', __METHOD__
);
121 $this->query( 'SET NAMES binary', __METHOD__
);
123 // Set SQL mode, default is turning them all off, can be overridden or skipped with null
125 if ( is_string( $wgSQLMode ) ) {
126 $mode = $this->addQuotes( $wgSQLMode );
127 $this->query( "SET sql_mode = $mode", __METHOD__
);
131 // Turn off strict mode if it is on
133 $this->reportConnectionError( $phpError );
136 $this->mOpened
= $success;
137 wfProfileOut( __METHOD__
);
142 $this->mOpened
= false;
143 if ( $this->mConn
) {
144 if ( $this->trxLevel() ) {
147 return mysql_close( $this->mConn
);
153 function freeResult( $res ) {
154 if ( $res instanceof ResultWrapper
) {
157 wfSuppressWarnings();
158 $ok = mysql_free_result( $res );
161 throw new DBUnexpectedError( $this, "Unable to free MySQL result" );
165 function fetchObject( $res ) {
166 if ( $res instanceof ResultWrapper
) {
169 wfSuppressWarnings();
170 $row = mysql_fetch_object( $res );
172 if( $this->lastErrno() ) {
173 throw new DBUnexpectedError( $this, 'Error in fetchObject(): ' . htmlspecialchars( $this->lastError() ) );
178 function fetchRow( $res ) {
179 if ( $res instanceof ResultWrapper
) {
182 wfSuppressWarnings();
183 $row = mysql_fetch_array( $res );
185 if ( $this->lastErrno() ) {
186 throw new DBUnexpectedError( $this, 'Error in fetchRow(): ' . htmlspecialchars( $this->lastError() ) );
191 function numRows( $res ) {
192 if ( $res instanceof ResultWrapper
) {
195 wfSuppressWarnings();
196 $n = mysql_num_rows( $res );
198 if( $this->lastErrno() ) {
199 throw new DBUnexpectedError( $this, 'Error in numRows(): ' . htmlspecialchars( $this->lastError() ) );
204 function numFields( $res ) {
205 if ( $res instanceof ResultWrapper
) {
208 return mysql_num_fields( $res );
211 function fieldName( $res, $n ) {
212 if ( $res instanceof ResultWrapper
) {
215 return mysql_field_name( $res, $n );
218 function insertId() { return mysql_insert_id( $this->mConn
); }
220 function dataSeek( $res, $row ) {
221 if ( $res instanceof ResultWrapper
) {
224 return mysql_data_seek( $res, $row );
227 function lastErrno() {
228 if ( $this->mConn
) {
229 return mysql_errno( $this->mConn
);
231 return mysql_errno();
235 function lastError() {
236 if ( $this->mConn
) {
237 # Even if it's non-zero, it can still be invalid
238 wfSuppressWarnings();
239 $error = mysql_error( $this->mConn
);
241 $error = mysql_error();
245 $error = mysql_error();
248 $error .= ' (' . $this->mServer
. ')';
253 function affectedRows() { return mysql_affected_rows( $this->mConn
); }
255 function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabaseMysql::replace' ) {
256 return $this->nativeReplace( $table, $rows, $fname );
260 * Estimate rows in dataset
261 * Returns estimated count, based on EXPLAIN output
262 * Takes same arguments as Database::select()
264 public function estimateRowCount( $table, $vars='*', $conds='', $fname = 'DatabaseMysql::estimateRowCount', $options = array() ) {
265 $options['EXPLAIN'] = true;
266 $res = $this->select( $table, $vars, $conds, $fname, $options );
267 if ( $res === false ) {
270 if ( !$this->numRows( $res ) ) {
275 foreach ( $res as $plan ) {
276 $rows *= $plan->rows
> 0 ?
$plan->rows
: 1; // avoid resetting to zero
281 function fieldInfo( $table, $field ) {
282 $table = $this->tableName( $table );
283 $res = $this->query( "SELECT * FROM $table LIMIT 1", __METHOD__
, true );
287 $n = mysql_num_fields( $res->result
);
288 for( $i = 0; $i < $n; $i++
) {
289 $meta = mysql_fetch_field( $res->result
, $i );
290 if( $field == $meta->name
) {
291 return new MySQLField($meta);
298 * Get information about an index into an object
299 * Returns false if the index does not exist
301 function indexInfo( $table, $index, $fname = 'DatabaseMysql::indexInfo' ) {
302 # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
303 # SHOW INDEX should work for 3.x and up:
304 # http://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
305 $table = $this->tableName( $table );
306 $index = $this->indexName( $index );
307 $sql = 'SHOW INDEX FROM ' . $table;
308 $res = $this->query( $sql, $fname );
316 foreach ( $res as $row ) {
317 if ( $row->Key_name
== $index ) {
322 return empty( $result ) ?
false : $result;
325 function selectDB( $db ) {
326 $this->mDBname
= $db;
327 return mysql_select_db( $db, $this->mConn
);
330 function strencode( $s ) {
331 $sQuoted = mysql_real_escape_string( $s, $this->mConn
);
333 if($sQuoted === false) {
335 $sQuoted = mysql_real_escape_string( $s, $this->mConn
);
341 * MySQL uses `backticks` for identifier quoting instead of the sql standard "double quotes".
343 public function addIdentifierQuotes( $s ) {
344 return "`" . $this->strencode( $s ) . "`";
347 public function isQuotedIdentifier( $name ) {
348 return strlen($name) && $name[0] == '`' && substr( $name, -1, 1 ) == '`';
352 $ping = mysql_ping( $this->mConn
);
357 mysql_close( $this->mConn
);
358 $this->mOpened
= false;
359 $this->mConn
= false;
360 $this->open( $this->mServer
, $this->mUser
, $this->mPassword
, $this->mDBname
);
367 * On MySQL 4.1.9 and later, this will do a SHOW SLAVE STATUS. On earlier
368 * versions of MySQL, it uses SHOW PROCESSLIST, which requires the PROCESS
374 if ( !is_null( $this->mFakeSlaveLag
) ) {
375 wfDebug( "getLag: fake slave lagged {$this->mFakeSlaveLag} seconds\n" );
376 return $this->mFakeSlaveLag
;
379 if ( version_compare( $this->getServerVersion(), '4.1.9', '>=' ) ) {
380 return $this->getLagFromSlaveStatus();
382 return $this->getLagFromProcesslist();
389 function getLagFromSlaveStatus() {
390 $res = $this->query( 'SHOW SLAVE STATUS', __METHOD__
);
394 $row = $res->fetchObject();
398 if ( strval( $row->Seconds_Behind_Master
) === '' ) {
401 return intval( $row->Seconds_Behind_Master
);
408 function getLagFromProcesslist() {
409 $res = $this->query( 'SHOW PROCESSLIST', __METHOD__
);
413 # Find slave SQL thread
414 foreach( $res as $row ) {
415 /* This should work for most situations - when default db
416 * for thread is not specified, it had no events executed,
417 * and therefore it doesn't know yet how lagged it is.
419 * Relay log I/O thread does not select databases.
421 if ( $row->User
== 'system user' &&
422 $row->State
!= 'Waiting for master to send event' &&
423 $row->State
!= 'Connecting to master' &&
424 $row->State
!= 'Queueing master event to the relay log' &&
425 $row->State
!= 'Waiting for master update' &&
426 $row->State
!= 'Requesting binlog dump' &&
427 $row->State
!= 'Waiting to reconnect after a failed master event read' &&
428 $row->State
!= 'Reconnecting after a failed master event read' &&
429 $row->State
!= 'Registering slave on master'
431 # This is it, return the time (except -ve)
432 if ( $row->Time
> 0x7fffffff ) {
443 * Wait for the slave to catch up to a given master position.
445 * @param $pos DBMasterPos object
446 * @param $timeout Integer: the maximum number of seconds to wait for synchronisation
448 function masterPosWait( DBMasterPos
$pos, $timeout ) {
449 $fname = 'DatabaseBase::masterPosWait';
450 wfProfileIn( $fname );
452 # Commit any open transactions
453 if ( $this->mTrxLevel
) {
457 if ( !is_null( $this->mFakeSlaveLag
) ) {
458 $status = parent
::masterPosWait( $pos, $timeout );
459 wfProfileOut( $fname );
463 # Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
464 $encFile = $this->addQuotes( $pos->file
);
465 $encPos = intval( $pos->pos
);
466 $sql = "SELECT MASTER_POS_WAIT($encFile, $encPos, $timeout)";
467 $res = $this->doQuery( $sql );
469 if ( $res && $row = $this->fetchRow( $res ) ) {
470 wfProfileOut( $fname );
473 wfProfileOut( $fname );
479 * Get the position of the master from SHOW SLAVE STATUS
481 * @return MySQLMasterPos|false
483 function getSlavePos() {
484 if ( !is_null( $this->mFakeSlaveLag
) ) {
485 return parent
::getSlavePos();
488 $res = $this->query( 'SHOW SLAVE STATUS', 'DatabaseBase::getSlavePos' );
489 $row = $this->fetchObject( $res );
492 $pos = isset( $row->Exec_master_log_pos
) ?
$row->Exec_master_log_pos
: $row->Exec_Master_Log_Pos
;
493 return new MySQLMasterPos( $row->Relay_Master_Log_File
, $pos );
500 * Get the position of the master from SHOW MASTER STATUS
502 * @return MySQLMasterPos|false
504 function getMasterPos() {
505 if ( $this->mFakeMaster
) {
506 return parent
::getMasterPos();
509 $res = $this->query( 'SHOW MASTER STATUS', 'DatabaseBase::getMasterPos' );
510 $row = $this->fetchObject( $res );
513 return new MySQLMasterPos( $row->File
, $row->Position
);
519 function getServerVersion() {
520 return mysql_get_server_info( $this->mConn
);
523 function useIndexClause( $index ) {
524 return "FORCE INDEX (" . $this->indexName( $index ) . ")";
527 function lowPriorityOption() {
528 return 'LOW_PRIORITY';
531 public static function getSoftwareLink() {
532 return '[http://www.mysql.com/ MySQL]';
535 function standardSelectDistinct() {
539 public function setTimeout( $timeout ) {
540 $this->query( "SET net_read_timeout=$timeout" );
541 $this->query( "SET net_write_timeout=$timeout" );
544 public function lock( $lockName, $method, $timeout = 5 ) {
545 $lockName = $this->addQuotes( $lockName );
546 $result = $this->query( "SELECT GET_LOCK($lockName, $timeout) AS lockstatus", $method );
547 $row = $this->fetchObject( $result );
549 if( $row->lockstatus
== 1 ) {
552 wfDebug( __METHOD__
." failed to acquire lock\n" );
558 * FROM MYSQL DOCS: http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock
560 public function unlock( $lockName, $method ) {
561 $lockName = $this->addQuotes( $lockName );
562 $result = $this->query( "SELECT RELEASE_LOCK($lockName) as lockstatus", $method );
563 $row = $this->fetchObject( $result );
564 return $row->lockstatus
;
567 public function lockTables( $read, $write, $method, $lowPriority = true ) {
570 foreach( $write as $table ) {
571 $tbl = $this->tableName( $table ) .
572 ( $lowPriority ?
' LOW_PRIORITY' : '' ) .
576 foreach( $read as $table ) {
577 $items[] = $this->tableName( $table ) . ' READ';
579 $sql = "LOCK TABLES " . implode( ',', $items );
580 $this->query( $sql, $method );
583 public function unlockTables( $method ) {
584 $this->query( "UNLOCK TABLES", $method );
588 * Get search engine class. All subclasses of this
589 * need to implement this if they wish to use searching.
593 public function getSearchEngine() {
594 return 'SearchMySQL';
597 public function setBigSelects( $value = true ) {
598 if ( $value === 'default' ) {
599 if ( $this->mDefaultBigSelects
=== null ) {
600 # Function hasn't been called before so it must already be set to the default
603 $value = $this->mDefaultBigSelects
;
605 } elseif ( $this->mDefaultBigSelects
=== null ) {
606 $this->mDefaultBigSelects
= (bool)$this->selectField( false, '@@sql_big_selects' );
608 $encValue = $value ?
'1' : '0';
609 $this->query( "SET sql_big_selects=$encValue", __METHOD__
);
613 * DELETE where the condition is a join. MySql uses multi-table deletes.
615 function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'DatabaseBase::deleteJoin' ) {
617 throw new DBUnexpectedError( $this, 'DatabaseBase::deleteJoin() called with empty $conds' );
620 $delTable = $this->tableName( $delTable );
621 $joinTable = $this->tableName( $joinTable );
622 $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
624 if ( $conds != '*' ) {
625 $sql .= ' AND ' . $this->makeList( $conds, LIST_AND
);
628 return $this->query( $sql, $fname );
632 * Determines if the last failure was due to a deadlock
634 function wasDeadlock() {
635 return $this->lastErrno() == 1213;
639 * Determines if the last query error was something that should be dealt
640 * with by pinging the connection and reissuing the query
642 function wasErrorReissuable() {
643 return $this->lastErrno() == 2013 ||
$this->lastErrno() == 2006;
647 * Determines if the last failure was due to the database being read-only.
649 function wasReadOnlyError() {
650 return $this->lastErrno() == 1223 ||
651 ( $this->lastErrno() == 1290 && strpos( $this->lastError(), '--read-only' ) !== false );
654 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'DatabaseMysql::duplicateTableStructure' ) {
655 $tmp = $temporary ?
'TEMPORARY ' : '';
656 if ( strcmp( $this->getServerVersion(), '4.1' ) < 0 ) {
657 # Hack for MySQL versions < 4.1, which don't support
658 # "CREATE TABLE ... LIKE". Note that
659 # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
660 # would not create the indexes we need....
662 # Note that we don't bother changing around the prefixes here be-
663 # cause we know we're using MySQL anyway.
665 $res = $this->query( 'SHOW CREATE TABLE ' . $this->addIdentifierQuotes( $oldName ) );
666 $row = $this->fetchRow( $res );
668 $query = preg_replace( '/CREATE TABLE `(.*?)`/',
669 "CREATE $tmp TABLE " . $this->addIdentifierQuotes( $newName ), $oldQuery );
670 if ($oldQuery === $query) {
671 # Couldn't do replacement
672 throw new MWException( "could not create temporary table $newName" );
675 $newName = $this->addIdentifierQuotes( $newName );
676 $oldName = $this->addIdentifierQuotes( $oldName );
677 $query = "CREATE $tmp TABLE $newName (LIKE $oldName)";
679 $this->query( $query, $fname );
683 * List all tables on the database
685 * @param $prefix Only show tables with this prefix, e.g. mw_
686 * @param $fname String: calling function name
688 function listTables( $prefix = null, $fname = 'DatabaseMysql::listTables' ) {
689 $result = $this->query( "SHOW TABLES", $fname);
693 foreach( $result as $table ) {
694 $vars = get_object_vars($table);
695 $table = array_pop( $vars );
697 if( !$prefix ||
strpos( $table, $prefix ) === 0 ) {
698 $endArray[] = $table;
705 public function dropTable( $tableName, $fName = 'DatabaseMysql::dropTable' ) {
706 if( !$this->tableExists( $tableName ) ) {
709 return $this->query( "DROP TABLE IF EXISTS " . $this->tableName( $tableName ), $fName );
712 protected function getDefaultSchemaVars() {
713 $vars = parent
::getDefaultSchemaVars();
714 $vars['wgDBTableOptions'] = $GLOBALS['wgDBTableOptions'];
719 * Get status information from SHOW STATUS in an associative array
723 function getMysqlStatus( $which = "%" ) {
724 $res = $this->query( "SHOW STATUS LIKE '{$which}'" );
727 foreach ( $res as $row ) {
728 $status[$row->Variable_name
] = $row->Value
;
737 * Legacy support: Database == DatabaseMysql
739 class Database
extends DatabaseMysql
{}
745 class MySQLField
implements Field
{
746 private $name, $tablename, $default, $max_length, $nullable,
747 $is_pk, $is_unique, $is_multiple, $is_key, $type;
749 function __construct ( $info ) {
750 $this->name
= $info->name
;
751 $this->tablename
= $info->table
;
752 $this->default = $info->def
;
753 $this->max_length
= $info->max_length
;
754 $this->nullable
= !$info->not_null
;
755 $this->is_pk
= $info->primary_key
;
756 $this->is_unique
= $info->unique_key
;
757 $this->is_multiple
= $info->multiple_key
;
758 $this->is_key
= ( $this->is_pk ||
$this->is_unique ||
$this->is_multiple
);
759 $this->type
= $info->type
;
766 function tableName() {
767 return $this->tableName
;
774 function isNullable() {
775 return $this->nullable
;
778 function defaultValue() {
779 return $this->default;
783 return $this->is_key
;
786 function isMultipleKey() {
787 return $this->is_multiple
;
791 class MySQLMasterPos
implements DBMasterPos
{
794 function __construct( $file, $pos ) {
799 function __toString() {
800 return "{$this->file}/{$this->pos}";