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 ) {
98 $success = @/**/mysql_select_db( $dbName, $this->mConn
);
100 $error = "Error selecting database $dbName on server {$this->mServer} " .
101 "from client host " . wfHostname() . "\n";
102 wfLogDBError(" Error selecting database $dbName on server {$this->mServer} \n");
107 $success = (bool)$this->mConn
;
111 $version = $this->getServerVersion();
112 if ( version_compare( $version, '4.1' ) >= 0 ) {
113 // Tell the server we're communicating with it in UTF-8.
114 // This may engage various charset conversions.
117 $this->query( 'SET NAMES utf8', __METHOD__
);
119 $this->query( 'SET NAMES binary', __METHOD__
);
121 // Set SQL mode, default is turning them all off, can be overridden or skipped with null
123 if ( is_string( $wgSQLMode ) ) {
124 $mode = $this->addQuotes( $wgSQLMode );
125 $this->query( "SET sql_mode = $mode", __METHOD__
);
129 // Turn off strict mode if it is on
131 $this->reportConnectionError( $phpError );
134 $this->mOpened
= $success;
135 wfProfileOut( __METHOD__
);
140 $this->mOpened
= false;
141 if ( $this->mConn
) {
142 if ( $this->trxLevel() ) {
145 return mysql_close( $this->mConn
);
151 function freeResult( $res ) {
152 if ( $res instanceof ResultWrapper
) {
155 if ( !@/**/mysql_free_result( $res ) ) {
156 throw new DBUnexpectedError( $this, "Unable to free MySQL result" );
160 function fetchObject( $res ) {
161 if ( $res instanceof ResultWrapper
) {
164 @/**/$row = mysql_fetch_object( $res );
165 if( $this->lastErrno() ) {
166 throw new DBUnexpectedError( $this, 'Error in fetchObject(): ' . htmlspecialchars( $this->lastError() ) );
171 function fetchRow( $res ) {
172 if ( $res instanceof ResultWrapper
) {
175 @/**/$row = mysql_fetch_array( $res );
176 if ( $this->lastErrno() ) {
177 throw new DBUnexpectedError( $this, 'Error in fetchRow(): ' . htmlspecialchars( $this->lastError() ) );
182 function numRows( $res ) {
183 if ( $res instanceof ResultWrapper
) {
186 @/**/$n = mysql_num_rows( $res );
187 if( $this->lastErrno() ) {
188 throw new DBUnexpectedError( $this, 'Error in numRows(): ' . htmlspecialchars( $this->lastError() ) );
193 function numFields( $res ) {
194 if ( $res instanceof ResultWrapper
) {
197 return mysql_num_fields( $res );
200 function fieldName( $res, $n ) {
201 if ( $res instanceof ResultWrapper
) {
204 return mysql_field_name( $res, $n );
207 function insertId() { return mysql_insert_id( $this->mConn
); }
209 function dataSeek( $res, $row ) {
210 if ( $res instanceof ResultWrapper
) {
213 return mysql_data_seek( $res, $row );
216 function lastErrno() {
217 if ( $this->mConn
) {
218 return mysql_errno( $this->mConn
);
220 return mysql_errno();
224 function lastError() {
225 if ( $this->mConn
) {
226 # Even if it's non-zero, it can still be invalid
227 wfSuppressWarnings();
228 $error = mysql_error( $this->mConn
);
230 $error = mysql_error();
234 $error = mysql_error();
237 $error .= ' (' . $this->mServer
. ')';
242 function affectedRows() { return mysql_affected_rows( $this->mConn
); }
244 function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabaseMysql::replace' ) {
245 return $this->nativeReplace( $table, $rows, $fname );
249 * Estimate rows in dataset
250 * Returns estimated count, based on EXPLAIN output
251 * Takes same arguments as Database::select()
253 public function estimateRowCount( $table, $vars='*', $conds='', $fname = 'DatabaseMysql::estimateRowCount', $options = array() ) {
254 $options['EXPLAIN'] = true;
255 $res = $this->select( $table, $vars, $conds, $fname, $options );
256 if ( $res === false ) {
259 if ( !$this->numRows( $res ) ) {
264 foreach ( $res as $plan ) {
265 $rows *= $plan->rows
> 0 ?
$plan->rows
: 1; // avoid resetting to zero
270 function fieldInfo( $table, $field ) {
271 $table = $this->tableName( $table );
272 $res = $this->query( "SELECT * FROM $table LIMIT 1", __METHOD__
, true );
276 $n = mysql_num_fields( $res->result
);
277 for( $i = 0; $i < $n; $i++
) {
278 $meta = mysql_fetch_field( $res->result
, $i );
279 if( $field == $meta->name
) {
280 return new MySQLField($meta);
287 * Get information about an index into an object
288 * Returns false if the index does not exist
290 function indexInfo( $table, $index, $fname = 'DatabaseMysql::indexInfo' ) {
291 # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
292 # SHOW INDEX should work for 3.x and up:
293 # http://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
294 $table = $this->tableName( $table );
295 $index = $this->indexName( $index );
296 $sql = 'SHOW INDEX FROM ' . $table;
297 $res = $this->query( $sql, $fname );
305 foreach ( $res as $row ) {
306 if ( $row->Key_name
== $index ) {
311 return empty( $result ) ?
false : $result;
314 function selectDB( $db ) {
315 $this->mDBname
= $db;
316 return mysql_select_db( $db, $this->mConn
);
319 function strencode( $s ) {
320 $sQuoted = mysql_real_escape_string( $s, $this->mConn
);
322 if($sQuoted === false) {
324 $sQuoted = mysql_real_escape_string( $s, $this->mConn
);
330 * MySQL uses `backticks` for identifier quoting instead of the sql standard "double quotes".
332 public function addIdentifierQuotes( $s ) {
333 return "`" . $this->strencode( $s ) . "`";
336 public function isQuotedIdentifier( $name ) {
337 return strlen($name) && $name[0] == '`' && substr( $name, -1, 1 ) == '`';
341 $ping = mysql_ping( $this->mConn
);
346 mysql_close( $this->mConn
);
347 $this->mOpened
= false;
348 $this->mConn
= false;
349 $this->open( $this->mServer
, $this->mUser
, $this->mPassword
, $this->mDBname
);
356 * On MySQL 4.1.9 and later, this will do a SHOW SLAVE STATUS. On earlier
357 * versions of MySQL, it uses SHOW PROCESSLIST, which requires the PROCESS
363 if ( !is_null( $this->mFakeSlaveLag
) ) {
364 wfDebug( "getLag: fake slave lagged {$this->mFakeSlaveLag} seconds\n" );
365 return $this->mFakeSlaveLag
;
368 /*if ( version_compare( $this->getServerVersion(), '4.1.9', '>=' ) ) {
369 return $this->getLagFromSlaveStatus();
371 return $this->getLagFromProcesslist();
375 function getLagFromSlaveStatus() {
376 $res = $this->query( 'SHOW SLAVE STATUS', __METHOD__
);
380 $row = $res->fetchObject();
384 if ( strval( $row->Seconds_Behind_Master
) === '' ) {
387 return intval( $row->Seconds_Behind_Master
);
391 function getLagFromProcesslist() {
392 $res = $this->query( 'SHOW PROCESSLIST', __METHOD__
);
396 # Find slave SQL thread
397 foreach( $res as $row ) {
398 /* This should work for most situations - when default db
399 * for thread is not specified, it had no events executed,
400 * and therefore it doesn't know yet how lagged it is.
402 * Relay log I/O thread does not select databases.
404 if ( $row->User
== 'system user' &&
405 $row->State
!= 'Waiting for master to send event' &&
406 $row->State
!= 'Connecting to master' &&
407 $row->State
!= 'Queueing master event to the relay log' &&
408 $row->State
!= 'Waiting for master update' &&
409 $row->State
!= 'Requesting binlog dump' &&
410 $row->State
!= 'Waiting to reconnect after a failed master event read' &&
411 $row->State
!= 'Reconnecting after a failed master event read' &&
412 $row->State
!= 'Registering slave on master'
414 # This is it, return the time (except -ve)
415 if ( $row->Time
> 0x7fffffff ) {
426 * Wait for the slave to catch up to a given master position.
428 * @param $pos DBMasterPos object
429 * @param $timeout Integer: the maximum number of seconds to wait for synchronisation
431 function masterPosWait( DBMasterPos
$pos, $timeout ) {
432 $fname = 'DatabaseBase::masterPosWait';
433 wfProfileIn( $fname );
435 # Commit any open transactions
436 if ( $this->mTrxLevel
) {
440 if ( !is_null( $this->mFakeSlaveLag
) ) {
441 $status = parent
::masterPosWait( $pos, $timeout );
442 wfProfileOut( $fname );
446 # Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
447 $encFile = $this->addQuotes( $pos->file
);
448 $encPos = intval( $pos->pos
);
449 $sql = "SELECT MASTER_POS_WAIT($encFile, $encPos, $timeout)";
450 $res = $this->doQuery( $sql );
452 if ( $res && $row = $this->fetchRow( $res ) ) {
453 wfProfileOut( $fname );
456 wfProfileOut( $fname );
462 * Get the position of the master from SHOW SLAVE STATUS
464 * @return MySQLMasterPos|false
466 function getSlavePos() {
467 if ( !is_null( $this->mFakeSlaveLag
) ) {
468 return parent
::getSlavePos();
471 $res = $this->query( 'SHOW SLAVE STATUS', 'DatabaseBase::getSlavePos' );
472 $row = $this->fetchObject( $res );
475 $pos = isset( $row->Exec_master_log_pos
) ?
$row->Exec_master_log_pos
: $row->Exec_Master_Log_Pos
;
476 return new MySQLMasterPos( $row->Relay_Master_Log_File
, $pos );
483 * Get the position of the master from SHOW MASTER STATUS
485 * @return MySQLMasterPos|false
487 function getMasterPos() {
488 if ( $this->mFakeMaster
) {
489 return parent
::getMasterPos();
492 $res = $this->query( 'SHOW MASTER STATUS', 'DatabaseBase::getMasterPos' );
493 $row = $this->fetchObject( $res );
496 return new MySQLMasterPos( $row->File
, $row->Position
);
502 function getServerVersion() {
503 return mysql_get_server_info( $this->mConn
);
506 function useIndexClause( $index ) {
507 return "FORCE INDEX (" . $this->indexName( $index ) . ")";
510 function lowPriorityOption() {
511 return 'LOW_PRIORITY';
514 public static function getSoftwareLink() {
515 return '[http://www.mysql.com/ MySQL]';
518 function standardSelectDistinct() {
522 public function setTimeout( $timeout ) {
523 $this->query( "SET net_read_timeout=$timeout" );
524 $this->query( "SET net_write_timeout=$timeout" );
527 public function lock( $lockName, $method, $timeout = 5 ) {
528 $lockName = $this->addQuotes( $lockName );
529 $result = $this->query( "SELECT GET_LOCK($lockName, $timeout) AS lockstatus", $method );
530 $row = $this->fetchObject( $result );
532 if( $row->lockstatus
== 1 ) {
535 wfDebug( __METHOD__
." failed to acquire lock\n" );
541 * FROM MYSQL DOCS: http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock
543 public function unlock( $lockName, $method ) {
544 $lockName = $this->addQuotes( $lockName );
545 $result = $this->query( "SELECT RELEASE_LOCK($lockName) as lockstatus", $method );
546 $row = $this->fetchObject( $result );
547 return $row->lockstatus
;
550 public function lockTables( $read, $write, $method, $lowPriority = true ) {
553 foreach( $write as $table ) {
554 $tbl = $this->tableName( $table ) .
555 ( $lowPriority ?
' LOW_PRIORITY' : '' ) .
559 foreach( $read as $table ) {
560 $items[] = $this->tableName( $table ) . ' READ';
562 $sql = "LOCK TABLES " . implode( ',', $items );
563 $this->query( $sql, $method );
566 public function unlockTables( $method ) {
567 $this->query( "UNLOCK TABLES", $method );
571 * Get search engine class. All subclasses of this
572 * need to implement this if they wish to use searching.
576 public function getSearchEngine() {
577 return 'SearchMySQL';
580 public function setBigSelects( $value = true ) {
581 if ( $value === 'default' ) {
582 if ( $this->mDefaultBigSelects
=== null ) {
583 # Function hasn't been called before so it must already be set to the default
586 $value = $this->mDefaultBigSelects
;
588 } elseif ( $this->mDefaultBigSelects
=== null ) {
589 $this->mDefaultBigSelects
= (bool)$this->selectField( false, '@@sql_big_selects' );
591 $encValue = $value ?
'1' : '0';
592 $this->query( "SET sql_big_selects=$encValue", __METHOD__
);
596 * DELETE where the condition is a join. MySql uses multi-table deletes.
598 function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = 'DatabaseBase::deleteJoin' ) {
600 throw new DBUnexpectedError( $this, 'DatabaseBase::deleteJoin() called with empty $conds' );
603 $delTable = $this->tableName( $delTable );
604 $joinTable = $this->tableName( $joinTable );
605 $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
607 if ( $conds != '*' ) {
608 $sql .= ' AND ' . $this->makeList( $conds, LIST_AND
);
611 return $this->query( $sql, $fname );
615 * Determines if the last failure was due to a deadlock
617 function wasDeadlock() {
618 return $this->lastErrno() == 1213;
622 * Determines if the last query error was something that should be dealt
623 * with by pinging the connection and reissuing the query
625 function wasErrorReissuable() {
626 return $this->lastErrno() == 2013 ||
$this->lastErrno() == 2006;
630 * Determines if the last failure was due to the database being read-only.
632 function wasReadOnlyError() {
633 return $this->lastErrno() == 1223 ||
634 ( $this->lastErrno() == 1290 && strpos( $this->lastError(), '--read-only' ) !== false );
637 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'DatabaseMysql::duplicateTableStructure' ) {
638 $tmp = $temporary ?
'TEMPORARY ' : '';
639 if ( strcmp( $this->getServerVersion(), '4.1' ) < 0 ) {
640 # Hack for MySQL versions < 4.1, which don't support
641 # "CREATE TABLE ... LIKE". Note that
642 # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
643 # would not create the indexes we need....
645 # Note that we don't bother changing around the prefixes here be-
646 # cause we know we're using MySQL anyway.
648 $res = $this->query( 'SHOW CREATE TABLE ' . $this->addIdentifierQuotes( $oldName ) );
649 $row = $this->fetchRow( $res );
651 $query = preg_replace( '/CREATE TABLE `(.*?)`/',
652 "CREATE $tmp TABLE " . $this->addIdentifierQuotes( $newName ), $oldQuery );
653 if ($oldQuery === $query) {
654 # Couldn't do replacement
655 throw new MWException( "could not create temporary table $newName" );
658 $newName = $this->addIdentifierQuotes( $newName );
659 $oldName = $this->addIdentifierQuotes( $oldName );
660 $query = "CREATE $tmp TABLE $newName (LIKE $oldName)";
662 $this->query( $query, $fname );
666 * List all tables on the database
668 * @param $prefix Only show tables with this prefix, e.g. mw_
669 * @param $fname String: calling function name
671 function listTables( $prefix = null, $fname = 'DatabaseMysql::listTables' ) {
672 $result = $this->query( "SHOW TABLES", $fname);
676 foreach( $result as $table ) {
677 $vars = get_object_vars($table);
678 $table = array_pop( $vars );
680 if( !$prefix ||
strpos( $table, $prefix ) === 0 ) {
681 $endArray[] = $table;
688 public function dropTable( $tableName, $fName = 'DatabaseMysql::dropTable' ) {
689 if( !$this->tableExists( $tableName ) ) {
692 return $this->query( "DROP TABLE IF EXISTS " . $this->tableName( $tableName ), $fName );
695 protected function getDefaultSchemaVars() {
696 $vars = parent
::getDefaultSchemaVars();
697 $vars['wgDBTableOptions'] = $GLOBALS['wgDBTableOptions'];
702 * Get status information from SHOW STATUS in an associative array
706 function getMysqlStatus( $which = "%" ) {
707 $res = $this->query( "SHOW STATUS LIKE '{$which}'" );
710 foreach ( $res as $row ) {
711 $status[$row->Variable_name
] = $row->Value
;
720 * Legacy support: Database == DatabaseMysql
722 class Database
extends DatabaseMysql
{}
728 class MySQLField
implements Field
{
729 private $name, $tablename, $default, $max_length, $nullable,
730 $is_pk, $is_unique, $is_multiple, $is_key, $type;
732 function __construct ( $info ) {
733 $this->name
= $info->name
;
734 $this->tablename
= $info->table
;
735 $this->default = $info->def
;
736 $this->max_length
= $info->max_length
;
737 $this->nullable
= !$info->not_null
;
738 $this->is_pk
= $info->primary_key
;
739 $this->is_unique
= $info->unique_key
;
740 $this->is_multiple
= $info->multiple_key
;
741 $this->is_key
= ( $this->is_pk ||
$this->is_unique ||
$this->is_multiple
);
742 $this->type
= $info->type
;
749 function tableName() {
750 return $this->tableName
;
757 function isNullable() {
758 return $this->nullable
;
761 function defaultValue() {
762 return $this->default;
766 return $this->is_key
;
769 function isMultipleKey() {
770 return $this->is_multiple
;
774 class MySQLMasterPos
implements DBMasterPos
{
777 function __construct( $file, $pos ) {
782 function __toString() {
783 return "{$this->file}/{$this->pos}";