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 /*private*/ 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 # Test for missing mysql.so
35 # First try to load it
39 # Otherwise we get a suppressed fatal error, which is very hard to track down
40 if ( !function_exists( 'mysql_connect' ) ) {
41 throw new DBConnectionError( $this, "MySQL functions missing, have you compiled PHP with the --with-mysql option?\n" );
44 # Debugging hack -- fake cluster
45 if ( $wgAllDBsAreLocalhost ) {
46 $realServer = 'localhost';
48 $realServer = $server;
51 $this->mServer
= $server;
53 $this->mPassword
= $password;
54 $this->mDBname
= $dbName;
58 wfProfileIn("dbconnect-$server");
60 # The kernel's default SYN retransmission period is far too slow for us,
61 # so we use a short timeout plus a manual retry. Retrying means that a small
62 # but finite rate of SYN packet loss won't cause user-visible errors.
64 if ( ini_get( 'mysql.connect_timeout' ) <= 3 ) {
69 $this->installErrorHandler();
70 for ( $i = 0; $i < $numAttempts && !$this->mConn
; $i++
) {
74 if ( $this->mFlags
& DBO_PERSISTENT
) {
75 $this->mConn
= mysql_pconnect( $realServer, $user, $password );
77 # Create a new connection...
78 $this->mConn
= mysql_connect( $realServer, $user, $password, true );
80 if ($this->mConn
=== false) {
82 #wfLogDBError("Connect loop error $iplus of $max ($server): " . mysql_errno() . " - " . mysql_error()."\n");
85 $phpError = $this->restoreErrorHandler();
86 # Always log connection errors
87 if ( !$this->mConn
) {
88 $error = $this->lastError();
92 wfLogDBError( "Error connecting to {$this->mServer}: $error\n" );
93 wfDebug( "DB connection error\n" );
94 wfDebug( "Server: $server, User: $user, Password: " .
95 substr( $password, 0, 3 ) . "..., error: " . mysql_error() . "\n" );
99 wfProfileOut("dbconnect-$server");
101 if ( $dbName != '' && $this->mConn
!== false ) {
102 $success = @/**/mysql_select_db( $dbName, $this->mConn
);
104 $error = "Error selecting database $dbName on server {$this->mServer} " .
105 "from client host " . wfHostname() . "\n";
106 wfLogDBError(" Error selecting database $dbName on server {$this->mServer} \n");
111 $success = (bool)$this->mConn
;
115 $version = $this->getServerVersion();
116 if ( version_compare( $version, '4.1' ) >= 0 ) {
117 // Tell the server we're communicating with it in UTF-8.
118 // This may engage various charset conversions.
121 $this->query( 'SET NAMES utf8', __METHOD__
);
123 $this->query( 'SET NAMES binary', __METHOD__
);
125 // Set SQL mode, default is turning them all off, can be overridden or skipped with null
127 if ( is_string( $wgSQLMode ) ) {
128 $mode = $this->addQuotes( $wgSQLMode );
129 $this->query( "SET sql_mode = $mode", __METHOD__
);
133 // Turn off strict mode if it is on
135 $this->reportConnectionError( $phpError );
138 $this->mOpened
= $success;
139 wfProfileOut( __METHOD__
);
144 $this->mOpened
= false;
145 if ( $this->mConn
) {
146 if ( $this->trxLevel() ) {
149 return mysql_close( $this->mConn
);
155 function freeResult( $res ) {
156 if ( $res instanceof ResultWrapper
) {
159 if ( !@/**/mysql_free_result( $res ) ) {
160 throw new DBUnexpectedError( $this, "Unable to free MySQL result" );
164 function fetchObject( $res ) {
165 if ( $res instanceof ResultWrapper
) {
168 @/**/$row = mysql_fetch_object( $res );
169 if( $this->lastErrno() ) {
170 throw new DBUnexpectedError( $this, 'Error in fetchObject(): ' . htmlspecialchars( $this->lastError() ) );
175 function fetchRow( $res ) {
176 if ( $res instanceof ResultWrapper
) {
179 @/**/$row = mysql_fetch_array( $res );
180 if ( $this->lastErrno() ) {
181 throw new DBUnexpectedError( $this, 'Error in fetchRow(): ' . htmlspecialchars( $this->lastError() ) );
186 function numRows( $res ) {
187 if ( $res instanceof ResultWrapper
) {
190 @/**/$n = mysql_num_rows( $res );
191 if( $this->lastErrno() ) {
192 throw new DBUnexpectedError( $this, 'Error in numRows(): ' . htmlspecialchars( $this->lastError() ) );
197 function numFields( $res ) {
198 if ( $res instanceof ResultWrapper
) {
201 return mysql_num_fields( $res );
204 function fieldName( $res, $n ) {
205 if ( $res instanceof ResultWrapper
) {
208 return mysql_field_name( $res, $n );
211 function insertId() { return mysql_insert_id( $this->mConn
); }
213 function dataSeek( $res, $row ) {
214 if ( $res instanceof ResultWrapper
) {
217 return mysql_data_seek( $res, $row );
220 function lastErrno() {
221 if ( $this->mConn
) {
222 return mysql_errno( $this->mConn
);
224 return mysql_errno();
228 function lastError() {
229 if ( $this->mConn
) {
230 # Even if it's non-zero, it can still be invalid
231 wfSuppressWarnings();
232 $error = mysql_error( $this->mConn
);
234 $error = mysql_error();
238 $error = mysql_error();
241 $error .= ' (' . $this->mServer
. ')';
246 function affectedRows() { return mysql_affected_rows( $this->mConn
); }
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 = 'Database::estimateRowCount', $options = array() ) {
254 $options['EXPLAIN'] = true;
255 $res = $this->select( $table, $vars, $conds, $fname, $options );
256 if ( $res === false )
258 if ( !$this->numRows( $res ) ) {
263 while( $plan = $this->fetchObject( $res ) ) {
264 $rows *= $plan->rows
> 0 ?
$plan->rows
: 1; // avoid resetting to zero
269 function fieldInfo( $table, $field ) {
270 $table = $this->tableName( $table );
271 $res = $this->query( "SELECT * FROM $table LIMIT 1", __METHOD__
, true );
275 $n = mysql_num_fields( $res->result
);
276 for( $i = 0; $i < $n; $i++
) {
277 $meta = mysql_fetch_field( $res->result
, $i );
278 if( $field == $meta->name
) {
279 return new MySQLField($meta);
285 function selectDB( $db ) {
286 $this->mDBname
= $db;
287 return mysql_select_db( $db, $this->mConn
);
290 function strencode( $s ) {
291 $sQuoted = mysql_real_escape_string( $s, $this->mConn
);
293 if($sQuoted === false) {
295 $sQuoted = mysql_real_escape_string( $s, $this->mConn
);
301 $ping = mysql_ping( $this->mConn
);
306 mysql_close( $this->mConn
);
307 $this->mOpened
= false;
308 $this->mConn
= false;
309 $this->open( $this->mServer
, $this->mUser
, $this->mPassword
, $this->mDBname
);
315 * At the moment, this will only work if the DB user has the PROCESS privilege
319 if ( !is_null( $this->mFakeSlaveLag
) ) {
320 wfDebug( "getLag: fake slave lagged {$this->mFakeSlaveLag} seconds\n" );
321 return $this->mFakeSlaveLag
;
323 $res = $this->query( 'SHOW PROCESSLIST', __METHOD__
);
324 # Find slave SQL thread
325 while ( $row = $this->fetchObject( $res ) ) {
326 /* This should work for most situations - when default db
327 * for thread is not specified, it had no events executed,
328 * and therefore it doesn't know yet how lagged it is.
330 * Relay log I/O thread does not select databases.
332 if ( $row->User
== 'system user' &&
333 $row->State
!= 'Waiting for master to send event' &&
334 $row->State
!= 'Connecting to master' &&
335 $row->State
!= 'Queueing master event to the relay log' &&
336 $row->State
!= 'Waiting for master update' &&
337 $row->State
!= 'Requesting binlog dump' &&
338 $row->State
!= 'Waiting to reconnect after a failed master event read' &&
339 $row->State
!= 'Reconnecting after a failed master event read' &&
340 $row->State
!= 'Registering slave on master'
342 # This is it, return the time (except -ve)
343 if ( $row->Time
> 0x7fffffff ) {
353 function getServerVersion() {
354 return mysql_get_server_info( $this->mConn
);
357 function useIndexClause( $index ) {
358 return "FORCE INDEX (" . $this->indexName( $index ) . ")";
361 function lowPriorityOption() {
362 return 'LOW_PRIORITY';
365 function getSoftwareLink() {
366 return '[http://www.mysql.com/ MySQL]';
369 function standardSelectDistinct() {
373 public function setTimeout( $timeout ) {
374 $this->query( "SET net_read_timeout=$timeout" );
375 $this->query( "SET net_write_timeout=$timeout" );
378 public function lock( $lockName, $method, $timeout = 5 ) {
379 $lockName = $this->addQuotes( $lockName );
380 $result = $this->query( "SELECT GET_LOCK($lockName, $timeout) AS lockstatus", $method );
381 $row = $this->fetchObject( $result );
383 if( $row->lockstatus
== 1 ) {
386 wfDebug( __METHOD__
." failed to acquire lock\n" );
392 * FROM MYSQL DOCS: http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock
394 public function unlock( $lockName, $method ) {
395 $lockName = $this->addQuotes( $lockName );
396 $result = $this->query( "SELECT RELEASE_LOCK($lockName) as lockstatus", $method );
397 $row = $this->fetchObject( $result );
398 return $row->lockstatus
;
401 public function lockTables( $read, $write, $method, $lowPriority = true ) {
404 foreach( $write as $table ) {
405 $tbl = $this->tableName( $table ) .
406 ( $lowPriority ?
' LOW_PRIORITY' : '' ) .
410 foreach( $read as $table ) {
411 $items[] = $this->tableName( $table ) . ' READ';
413 $sql = "LOCK TABLES " . implode( ',', $items );
414 $this->query( $sql, $method );
417 public function unlockTables( $method ) {
418 $this->query( "UNLOCK TABLES", $method );
422 * Get search engine class. All subclasses of this
423 * need to implement this if they wish to use searching.
427 public function getSearchEngine() {
428 return 'SearchMySQL';
431 public function setBigSelects( $value = true ) {
432 if ( $value === 'default' ) {
433 if ( $this->mDefaultBigSelects
=== null ) {
434 # Function hasn't been called before so it must already be set to the default
437 $value = $this->mDefaultBigSelects
;
439 } elseif ( $this->mDefaultBigSelects
=== null ) {
440 $this->mDefaultBigSelects
= (bool)$this->selectField( false, '@@sql_big_selects' );
442 $encValue = $value ?
'1' : '0';
443 $this->query( "SET sql_big_selects=$encValue", __METHOD__
);
448 * Determines if the last failure was due to a deadlock
450 function wasDeadlock() {
451 return $this->lastErrno() == 1213;
455 * Determines if the last query error was something that should be dealt
456 * with by pinging the connection and reissuing the query
458 function wasErrorReissuable() {
459 return $this->lastErrno() == 2013 ||
$this->lastErrno() == 2006;
463 * Determines if the last failure was due to the database being read-only.
465 function wasReadOnlyError() {
466 return $this->lastErrno() == 1223 ||
467 ( $this->lastErrno() == 1290 && strpos( $this->lastError(), '--read-only' ) !== false );
470 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = 'DatabaseMysql::duplicateTableStructure' ) {
471 $tmp = $temporary ?
'TEMPORARY ' : '';
472 if ( strcmp( $this->getServerVersion(), '4.1' ) < 0 ) {
473 # Hack for MySQL versions < 4.1, which don't support
474 # "CREATE TABLE ... LIKE". Note that
475 # "CREATE TEMPORARY TABLE ... SELECT * FROM ... LIMIT 0"
476 # would not create the indexes we need....
478 # Note that we don't bother changing around the prefixes here be-
479 # cause we know we're using MySQL anyway.
481 $res = $this->query( "SHOW CREATE TABLE $oldName" );
482 $row = $this->fetchRow( $res );
484 $query = preg_replace( '/CREATE TABLE `(.*?)`/',
485 "CREATE $tmp TABLE `$newName`", $oldQuery );
486 if ($oldQuery === $query) {
487 # Couldn't do replacement
488 throw new MWException( "could not create temporary table $newName" );
491 $query = "CREATE $tmp TABLE $newName (LIKE $oldName)";
493 $this->query( $query, $fname );
499 * Legacy support: Database == DatabaseMysql
501 class Database
extends DatabaseMysql
{}
503 class MySQLMasterPos
{
506 function __construct( $file, $pos ) {
511 function __toString() {
512 return "{$this->file}/{$this->pos}";