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
25 * Database abstraction object for MySQL.
26 * Defines methods independent on used MySQL extension.
32 abstract class DatabaseMysqlBase
extends DatabaseBase
{
33 /** @var MysqlMasterPos */
34 protected $lastKnownSlavePos;
44 * @param $server string
46 * @param $password string
47 * @param $dbName string
49 * @throws DBConnectionError
51 function open( $server, $user, $password, $dbName ) {
52 global $wgAllDBsAreLocalhost, $wgSQLMode;
53 wfProfileIn( __METHOD__
);
55 # Debugging hack -- fake cluster
56 if ( $wgAllDBsAreLocalhost ) {
57 $realServer = 'localhost';
59 $realServer = $server;
62 $this->mServer
= $server;
64 $this->mPassword
= $password;
65 $this->mDBname
= $dbName;
67 wfProfileIn( "dbconnect-$server" );
69 # The kernel's default SYN retransmission period is far too slow for us,
70 # so we use a short timeout plus a manual retry. Retrying means that a small
71 # but finite rate of SYN packet loss won't cause user-visible errors.
73 $this->installErrorHandler();
75 $this->mConn
= $this->mysqlConnect( $realServer );
76 } catch ( Exception
$ex ) {
77 wfProfileOut( "dbconnect-$server" );
78 wfProfileOut( __METHOD__
);
79 $this->restoreErrorHandler();
82 $error = $this->restoreErrorHandler();
84 wfProfileOut( "dbconnect-$server" );
86 # Always log connection errors
87 if ( !$this->mConn
) {
89 $error = $this->lastError();
91 wfLogDBError( "Error connecting to {$this->mServer}: $error\n" );
92 wfDebug( "DB connection error\n" .
93 "Server: $server, User: $user, Password: " .
94 substr( $password, 0, 3 ) . "..., error: " . $error . "\n" );
96 wfProfileOut( __METHOD__
);
98 $this->reportConnectionError( $error );
101 if ( $dbName != '' ) {
102 wfSuppressWarnings();
103 $success = $this->selectDB( $dbName );
106 wfLogDBError( "Error selecting database $dbName on server {$this->mServer}\n" );
107 wfDebug( "Error selecting database $dbName on server {$this->mServer} " .
108 "from client host " . wfHostname() . "\n" );
110 wfProfileOut( __METHOD__
);
112 $this->reportConnectionError( "Error selecting database $dbName" );
116 // Tell the server what we're communicating with
117 if ( !$this->connectInitCharset() ) {
118 $this->reportConnectionError( "Error setting character set" );
121 // Set SQL mode, default is turning them all off, can be overridden or skipped with null
122 if ( is_string( $wgSQLMode ) ) {
123 $mode = $this->addQuotes( $wgSQLMode );
124 // Use doQuery() to avoid opening implicit transactions (DBO_TRX)
125 $success = $this->doQuery( "SET sql_mode = $mode", __METHOD__
);
127 wfLogDBError( "Error setting sql_mode to $mode on server {$this->mServer}" );
128 wfProfileOut( __METHOD__
);
129 $this->reportConnectionError( "Error setting sql_mode to $mode" );
133 $this->mOpened
= true;
134 wfProfileOut( __METHOD__
);
140 * Set the character set information right after connection
143 protected function connectInitCharset() {
147 // Tell the server we're communicating with it in UTF-8.
148 // This may engage various charset conversions.
149 return $this->mysqlSetCharset( 'utf8' );
151 return $this->mysqlSetCharset( 'binary' );
156 * Open a connection to a MySQL server
158 * @param $realServer string
159 * @return mixed Raw connection
160 * @throws DBConnectionError
162 abstract protected function mysqlConnect( $realServer );
165 * Set the character set of the MySQL link
167 * @param string $charset
170 abstract protected function mysqlSetCharset( $charset );
173 * @param $res ResultWrapper
174 * @throws DBUnexpectedError
176 function freeResult( $res ) {
177 if ( $res instanceof ResultWrapper
) {
180 wfSuppressWarnings();
181 $ok = $this->mysqlFreeResult( $res );
184 throw new DBUnexpectedError( $this, "Unable to free MySQL result" );
191 * @param $res Raw result
194 abstract protected function mysqlFreeResult( $res );
197 * @param $res ResultWrapper
198 * @return object|bool
199 * @throws DBUnexpectedError
201 function fetchObject( $res ) {
202 if ( $res instanceof ResultWrapper
) {
205 wfSuppressWarnings();
206 $row = $this->mysqlFetchObject( $res );
209 $errno = $this->lastErrno();
210 // Unfortunately, mysql_fetch_object does not reset the last errno.
211 // Only check for CR_SERVER_LOST and CR_UNKNOWN_ERROR, as
212 // these are the only errors mysql_fetch_object can cause.
213 // See http://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
214 if ( $errno == 2000 ||
$errno == 2013 ) {
215 throw new DBUnexpectedError(
217 'Error in fetchObject(): ' . htmlspecialchars( $this->lastError() )
225 * Fetch a result row as an object
227 * @param $res Raw result
230 abstract protected function mysqlFetchObject( $res );
233 * @param $res ResultWrapper
235 * @throws DBUnexpectedError
237 function fetchRow( $res ) {
238 if ( $res instanceof ResultWrapper
) {
241 wfSuppressWarnings();
242 $row = $this->mysqlFetchArray( $res );
245 $errno = $this->lastErrno();
246 // Unfortunately, mysql_fetch_array does not reset the last errno.
247 // Only check for CR_SERVER_LOST and CR_UNKNOWN_ERROR, as
248 // these are the only errors mysql_fetch_array can cause.
249 // See http://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
250 if ( $errno == 2000 ||
$errno == 2013 ) {
251 throw new DBUnexpectedError(
253 'Error in fetchRow(): ' . htmlspecialchars( $this->lastError() )
261 * Fetch a result row as an associative and numeric array
263 * @param $res Raw result
266 abstract protected function mysqlFetchArray( $res );
269 * @throws DBUnexpectedError
270 * @param $res ResultWrapper
273 function numRows( $res ) {
274 if ( $res instanceof ResultWrapper
) {
277 wfSuppressWarnings();
278 $n = $this->mysqlNumRows( $res );
281 // Unfortunately, mysql_num_rows does not reset the last errno.
282 // We are not checking for any errors here, since
283 // these are no errors mysql_num_rows can cause.
284 // See http://dev.mysql.com/doc/refman/5.0/en/mysql-fetch-row.html.
285 // See https://bugzilla.wikimedia.org/42430
290 * Get number of rows in result
292 * @param $res Raw result
295 abstract protected function mysqlNumRows( $res );
298 * @param $res ResultWrapper
301 function numFields( $res ) {
302 if ( $res instanceof ResultWrapper
) {
306 return $this->mysqlNumFields( $res );
310 * Get number of fields in result
312 * @param $res Raw result
315 abstract protected function mysqlNumFields( $res );
318 * @param $res ResultWrapper
322 function fieldName( $res, $n ) {
323 if ( $res instanceof ResultWrapper
) {
327 return $this->mysqlFieldName( $res, $n );
331 * Get the name of the specified field in a result
333 * @param $res Raw result
337 abstract protected function mysqlFieldName( $res, $n );
340 * mysql_field_type() wrapper
345 public function fieldType( $res, $n ) {
346 if ( $res instanceof ResultWrapper
) {
350 return $this->mysqlFieldType( $res, $n );
354 * Get the type of the specified field in a result
356 * @param $res Raw result
360 abstract protected function mysqlFieldType( $res, $n );
363 * @param $res ResultWrapper
367 function dataSeek( $res, $row ) {
368 if ( $res instanceof ResultWrapper
) {
372 return $this->mysqlDataSeek( $res, $row );
376 * Move internal result pointer
378 * @param $res Raw result
382 abstract protected function mysqlDataSeek( $res, $row );
387 function lastError() {
388 if ( $this->mConn
) {
389 # Even if it's non-zero, it can still be invalid
390 wfSuppressWarnings();
391 $error = $this->mysqlError( $this->mConn
);
393 $error = $this->mysqlError();
397 $error = $this->mysqlError();
400 $error .= ' (' . $this->mServer
. ')';
407 * Returns the text of the error message from previous MySQL operation
409 * @param $conn Raw connection
412 abstract protected function mysqlError( $conn = null );
415 * @param $table string
416 * @param $uniqueIndexes
418 * @param $fname string
419 * @return ResultWrapper
421 function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
422 return $this->nativeReplace( $table, $rows, $fname );
426 * Estimate rows in dataset
427 * Returns estimated count, based on EXPLAIN output
428 * Takes same arguments as Database::select()
430 * @param $table string|array
431 * @param $vars string|array
432 * @param $conds string|array
433 * @param $fname string
434 * @param $options string|array
437 public function estimateRowCount( $table, $vars = '*', $conds = '',
438 $fname = __METHOD__
, $options = array()
440 $options['EXPLAIN'] = true;
441 $res = $this->select( $table, $vars, $conds, $fname, $options );
442 if ( $res === false ) {
445 if ( !$this->numRows( $res ) ) {
450 foreach ( $res as $plan ) {
451 $rows *= $plan->rows
> 0 ?
$plan->rows
: 1; // avoid resetting to zero
458 * @param $table string
459 * @param $field string
460 * @return bool|MySQLField
462 function fieldInfo( $table, $field ) {
463 $table = $this->tableName( $table );
464 $res = $this->query( "SELECT * FROM $table LIMIT 1", __METHOD__
, true );
468 $n = $this->mysqlNumFields( $res->result
);
469 for ( $i = 0; $i < $n; $i++
) {
470 $meta = $this->mysqlFetchField( $res->result
, $i );
471 if ( $field == $meta->name
) {
472 return new MySQLField( $meta );
480 * Get column information from a result
482 * @param $res Raw result
486 abstract protected function mysqlFetchField( $res, $n );
489 * Get information about an index into an object
490 * Returns false if the index does not exist
492 * @param $table string
493 * @param $index string
494 * @param $fname string
495 * @return bool|array|null False or null on failure
497 function indexInfo( $table, $index, $fname = __METHOD__
) {
498 # SHOW INDEX works in MySQL 3.23.58, but SHOW INDEXES does not.
499 # SHOW INDEX should work for 3.x and up:
500 # http://dev.mysql.com/doc/mysql/en/SHOW_INDEX.html
501 $table = $this->tableName( $table );
502 $index = $this->indexName( $index );
504 $sql = 'SHOW INDEX FROM ' . $table;
505 $res = $this->query( $sql, $fname );
513 foreach ( $res as $row ) {
514 if ( $row->Key_name
== $index ) {
519 return empty( $result ) ?
false : $result;
527 function strencode( $s ) {
528 $sQuoted = $this->mysqlRealEscapeString( $s );
530 if ( $sQuoted === false ) {
532 $sQuoted = $this->mysqlRealEscapeString( $s );
539 * MySQL uses `backticks` for identifier quoting instead of the sql standard "double quotes".
545 public function addIdentifierQuotes( $s ) {
546 // Characters in the range \u0001-\uFFFF are valid in a quoted identifier
547 // Remove NUL bytes and escape backticks by doubling
548 return '`' . str_replace( array( "\0", '`' ), array( '', '``' ), $s ) . '`';
552 * @param $name string
555 public function isQuotedIdentifier( $name ) {
556 return strlen( $name ) && $name[0] == '`' && substr( $name, -1, 1 ) == '`';
563 $ping = $this->mysqlPing();
568 $this->closeConnection();
569 $this->mOpened
= false;
570 $this->mConn
= false;
571 $this->open( $this->mServer
, $this->mUser
, $this->mPassword
, $this->mDBname
);
577 * Ping a server connection or reconnect if there is no connection
581 abstract protected function mysqlPing();
586 * This will do a SHOW SLAVE STATUS
591 if ( !is_null( $this->mFakeSlaveLag
) ) {
592 wfDebug( "getLag: fake slave lagged {$this->mFakeSlaveLag} seconds\n" );
594 return $this->mFakeSlaveLag
;
597 return $this->getLagFromSlaveStatus();
603 function getLagFromSlaveStatus() {
604 $res = $this->query( 'SHOW SLAVE STATUS', __METHOD__
);
608 $row = $res->fetchObject();
612 if ( strval( $row->Seconds_Behind_Master
) === '' ) {
615 return intval( $row->Seconds_Behind_Master
);
620 * @deprecated in 1.19, use getLagFromSlaveStatus
624 function getLagFromProcesslist() {
625 wfDeprecated( __METHOD__
, '1.19' );
626 $res = $this->query( 'SHOW PROCESSLIST', __METHOD__
);
630 # Find slave SQL thread
631 foreach ( $res as $row ) {
632 /* This should work for most situations - when default db
633 * for thread is not specified, it had no events executed,
634 * and therefore it doesn't know yet how lagged it is.
636 * Relay log I/O thread does not select databases.
638 if ( $row->User
== 'system user' &&
639 $row->State
!= 'Waiting for master to send event' &&
640 $row->State
!= 'Connecting to master' &&
641 $row->State
!= 'Queueing master event to the relay log' &&
642 $row->State
!= 'Waiting for master update' &&
643 $row->State
!= 'Requesting binlog dump' &&
644 $row->State
!= 'Waiting to reconnect after a failed master event read' &&
645 $row->State
!= 'Reconnecting after a failed master event read' &&
646 $row->State
!= 'Registering slave on master'
648 # This is it, return the time (except -ve)
649 if ( $row->Time
> 0x7fffffff ) {
661 * Wait for the slave to catch up to a given master position.
662 * @TODO: return values for this and base class are rubbish
664 * @param $pos DBMasterPos object
665 * @param $timeout Integer: the maximum number of seconds to wait for synchronisation
666 * @return bool|string
668 function masterPosWait( DBMasterPos
$pos, $timeout ) {
669 if ( $this->lastKnownSlavePos
&& $this->lastKnownSlavePos
->hasReached( $pos ) ) {
670 return '0'; // http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html
673 wfProfileIn( __METHOD__
);
674 # Commit any open transactions
675 $this->commit( __METHOD__
, 'flush' );
677 if ( !is_null( $this->mFakeSlaveLag
) ) {
678 $status = parent
::masterPosWait( $pos, $timeout );
679 wfProfileOut( __METHOD__
);
684 # Call doQuery() directly, to avoid opening a transaction if DBO_TRX is set
685 $encFile = $this->addQuotes( $pos->file
);
686 $encPos = intval( $pos->pos
);
687 $sql = "SELECT MASTER_POS_WAIT($encFile, $encPos, $timeout)";
688 $res = $this->doQuery( $sql );
691 if ( $res && $row = $this->fetchRow( $res ) ) {
692 $status = $row[0]; // can be NULL, -1, or 0+ per the MySQL manual
693 if ( ctype_digit( $status ) ) { // success
694 $this->lastKnownSlavePos
= $pos;
698 wfProfileOut( __METHOD__
);
704 * Get the position of the master from SHOW SLAVE STATUS
706 * @return MySQLMasterPos|bool
708 function getSlavePos() {
709 if ( !is_null( $this->mFakeSlaveLag
) ) {
710 return parent
::getSlavePos();
713 $res = $this->query( 'SHOW SLAVE STATUS', 'DatabaseBase::getSlavePos' );
714 $row = $this->fetchObject( $res );
717 $pos = isset( $row->Exec_master_log_pos
)
718 ?
$row->Exec_master_log_pos
719 : $row->Exec_Master_Log_Pos
;
721 return new MySQLMasterPos( $row->Relay_Master_Log_File
, $pos );
728 * Get the position of the master from SHOW MASTER STATUS
730 * @return MySQLMasterPos|bool
732 function getMasterPos() {
733 if ( $this->mFakeMaster
) {
734 return parent
::getMasterPos();
737 $res = $this->query( 'SHOW MASTER STATUS', 'DatabaseBase::getMasterPos' );
738 $row = $this->fetchObject( $res );
741 return new MySQLMasterPos( $row->File
, $row->Position
);
751 function useIndexClause( $index ) {
752 return "FORCE INDEX (" . $this->indexName( $index ) . ")";
758 function lowPriorityOption() {
759 return 'LOW_PRIORITY';
765 public function getSoftwareLink() {
766 return '[http://www.mysql.com/ MySQL]';
770 * @param $options array
772 public function setSessionOptions( array $options ) {
773 if ( isset( $options['connTimeout'] ) ) {
774 $timeout = (int)$options['connTimeout'];
775 $this->query( "SET net_read_timeout=$timeout" );
776 $this->query( "SET net_write_timeout=$timeout" );
780 public function streamStatementEnd( &$sql, &$newLine ) {
781 if ( strtoupper( substr( $newLine, 0, 9 ) ) == 'DELIMITER' ) {
782 preg_match( '/^DELIMITER\s+(\S+)/', $newLine, $m );
783 $this->delimiter
= $m[1];
787 return parent
::streamStatementEnd( $sql, $newLine );
791 * Check to see if a named lock is available. This is non-blocking.
793 * @param string $lockName name of lock to poll
794 * @param string $method name of method calling us
798 public function lockIsFree( $lockName, $method ) {
799 $lockName = $this->addQuotes( $lockName );
800 $result = $this->query( "SELECT IS_FREE_LOCK($lockName) AS lockstatus", $method );
801 $row = $this->fetchObject( $result );
803 return ( $row->lockstatus
== 1 );
807 * @param $lockName string
808 * @param $method string
809 * @param $timeout int
812 public function lock( $lockName, $method, $timeout = 5 ) {
813 $lockName = $this->addQuotes( $lockName );
814 $result = $this->query( "SELECT GET_LOCK($lockName, $timeout) AS lockstatus", $method );
815 $row = $this->fetchObject( $result );
817 if ( $row->lockstatus
== 1 ) {
820 wfDebug( __METHOD__
. " failed to acquire lock\n" );
828 * http://dev.mysql.com/doc/refman/5.0/en/miscellaneous-functions.html#function_release-lock
829 * @param $lockName string
830 * @param $method string
833 public function unlock( $lockName, $method ) {
834 $lockName = $this->addQuotes( $lockName );
835 $result = $this->query( "SELECT RELEASE_LOCK($lockName) as lockstatus", $method );
836 $row = $this->fetchObject( $result );
838 return ( $row->lockstatus
== 1 );
843 * @param $write array
844 * @param $method string
845 * @param $lowPriority bool
848 public function lockTables( $read, $write, $method, $lowPriority = true ) {
851 foreach ( $write as $table ) {
852 $tbl = $this->tableName( $table ) .
853 ( $lowPriority ?
' LOW_PRIORITY' : '' ) .
857 foreach ( $read as $table ) {
858 $items[] = $this->tableName( $table ) . ' READ';
860 $sql = "LOCK TABLES " . implode( ',', $items );
861 $this->query( $sql, $method );
867 * @param $method string
870 public function unlockTables( $method ) {
871 $this->query( "UNLOCK TABLES", $method );
877 * Get search engine class. All subclasses of this
878 * need to implement this if they wish to use searching.
882 public function getSearchEngine() {
883 return 'SearchMySQL';
890 public function setBigSelects( $value = true ) {
891 if ( $value === 'default' ) {
892 if ( $this->mDefaultBigSelects
=== null ) {
893 # Function hasn't been called before so it must already be set to the default
896 $value = $this->mDefaultBigSelects
;
898 } elseif ( $this->mDefaultBigSelects
=== null ) {
899 $this->mDefaultBigSelects
= (bool)$this->selectField( false, '@@sql_big_selects' );
901 $encValue = $value ?
'1' : '0';
902 $this->query( "SET sql_big_selects=$encValue", __METHOD__
);
906 * DELETE where the condition is a join. MySql uses multi-table deletes.
907 * @param $delTable string
908 * @param $joinTable string
909 * @param $delVar string
910 * @param $joinVar string
911 * @param $conds array|string
912 * @param bool|string $fname bool
913 * @throws DBUnexpectedError
914 * @return bool|ResultWrapper
916 function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds, $fname = __METHOD__
) {
918 throw new DBUnexpectedError( $this, 'DatabaseBase::deleteJoin() called with empty $conds' );
921 $delTable = $this->tableName( $delTable );
922 $joinTable = $this->tableName( $joinTable );
923 $sql = "DELETE $delTable FROM $delTable, $joinTable WHERE $delVar=$joinVar ";
925 if ( $conds != '*' ) {
926 $sql .= ' AND ' . $this->makeList( $conds, LIST_AND
);
929 return $this->query( $sql, $fname );
933 * @param string $table
935 * @param array $uniqueIndexes
937 * @param string $fname
940 public function upsert(
941 $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
943 if ( !count( $rows ) ) {
944 return true; // nothing to do
946 $rows = is_array( reset( $rows ) ) ?
$rows : array( $rows );
948 $table = $this->tableName( $table );
949 $columns = array_keys( $rows[0] );
951 $sql = "INSERT INTO $table (" . implode( ',', $columns ) . ') VALUES ';
952 $rowTuples = array();
953 foreach ( $rows as $row ) {
954 $rowTuples[] = '(' . $this->makeList( $row ) . ')';
956 $sql .= implode( ',', $rowTuples );
957 $sql .= " ON DUPLICATE KEY UPDATE " . $this->makeList( $set, LIST_SET
);
959 return (bool)$this->query( $sql, $fname );
963 * Determines how long the server has been up
967 function getServerUptime() {
968 $vars = $this->getMysqlStatus( 'Uptime' );
970 return (int)$vars['Uptime'];
974 * Determines if the last failure was due to a deadlock
978 function wasDeadlock() {
979 return $this->lastErrno() == 1213;
983 * Determines if the last failure was due to a lock timeout
987 function wasLockTimeout() {
988 return $this->lastErrno() == 1205;
992 * Determines if the last query error was something that should be dealt
993 * with by pinging the connection and reissuing the query
997 function wasErrorReissuable() {
998 return $this->lastErrno() == 2013 ||
$this->lastErrno() == 2006;
1002 * Determines if the last failure was due to the database being read-only.
1006 function wasReadOnlyError() {
1007 return $this->lastErrno() == 1223 ||
1008 ( $this->lastErrno() == 1290 && strpos( $this->lastError(), '--read-only' ) !== false );
1014 * @param $temporary bool
1015 * @param $fname string
1017 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = __METHOD__
) {
1018 $tmp = $temporary ?
'TEMPORARY ' : '';
1019 $newName = $this->addIdentifierQuotes( $newName );
1020 $oldName = $this->addIdentifierQuotes( $oldName );
1021 $query = "CREATE $tmp TABLE $newName (LIKE $oldName)";
1022 $this->query( $query, $fname );
1026 * List all tables on the database
1028 * @param string $prefix Only show tables with this prefix, e.g. mw_
1029 * @param string $fname calling function name
1032 function listTables( $prefix = null, $fname = __METHOD__
) {
1033 $result = $this->query( "SHOW TABLES", $fname );
1035 $endArray = array();
1037 foreach ( $result as $table ) {
1038 $vars = get_object_vars( $table );
1039 $table = array_pop( $vars );
1041 if ( !$prefix ||
strpos( $table, $prefix ) === 0 ) {
1042 $endArray[] = $table;
1051 * @param $fName string
1052 * @return bool|ResultWrapper
1054 public function dropTable( $tableName, $fName = __METHOD__
) {
1055 if ( !$this->tableExists( $tableName, $fName ) ) {
1059 return $this->query( "DROP TABLE IF EXISTS " . $this->tableName( $tableName ), $fName );
1065 protected function getDefaultSchemaVars() {
1066 $vars = parent
::getDefaultSchemaVars();
1067 $vars['wgDBTableOptions'] = str_replace( 'TYPE', 'ENGINE', $GLOBALS['wgDBTableOptions'] );
1068 $vars['wgDBTableOptions'] = str_replace(
1071 $vars['wgDBTableOptions']
1078 * Get status information from SHOW STATUS in an associative array
1080 * @param $which string
1083 function getMysqlStatus( $which = "%" ) {
1084 $res = $this->query( "SHOW STATUS LIKE '{$which}'" );
1087 foreach ( $res as $row ) {
1088 $status[$row->Variable_name
] = $row->Value
;
1095 * Lists VIEWs in the database
1097 * @param string $prefix Only show VIEWs with this prefix, eg.
1098 * unit_test_, or $wgDBprefix. Default: null, would return all views.
1099 * @param string $fname Name of calling function
1103 public function listViews( $prefix = null, $fname = __METHOD__
) {
1105 if ( !isset( $this->allViews
) ) {
1107 // The name of the column containing the name of the VIEW
1108 $propertyName = 'Tables_in_' . $this->mDBname
;
1110 // Query for the VIEWS
1111 $result = $this->query( 'SHOW FULL TABLES WHERE TABLE_TYPE = "VIEW"' );
1112 $this->allViews
= array();
1113 while ( ( $row = $this->fetchRow( $result ) ) !== false ) {
1114 array_push( $this->allViews
, $row[$propertyName] );
1118 if ( is_null( $prefix ) ||
$prefix === '' ) {
1119 return $this->allViews
;
1122 $filteredViews = array();
1123 foreach ( $this->allViews
as $viewName ) {
1124 // Does the name of this VIEW start with the table-prefix?
1125 if ( strpos( $viewName, $prefix ) === 0 ) {
1126 array_push( $filteredViews, $viewName );
1130 return $filteredViews;
1134 * Differentiates between a TABLE and a VIEW.
1136 * @param $name string: Name of the TABLE/VIEW to test
1140 public function isView( $name, $prefix = null ) {
1141 return in_array( $name, $this->listViews( $prefix ) );
1149 class MySQLField
implements Field
{
1150 private $name, $tablename, $default, $max_length, $nullable,
1151 $is_pk, $is_unique, $is_multiple, $is_key, $type, $binary;
1153 function __construct( $info ) {
1154 $this->name
= $info->name
;
1155 $this->tablename
= $info->table
;
1156 $this->default = $info->def
;
1157 $this->max_length
= $info->max_length
;
1158 $this->nullable
= !$info->not_null
;
1159 $this->is_pk
= $info->primary_key
;
1160 $this->is_unique
= $info->unique_key
;
1161 $this->is_multiple
= $info->multiple_key
;
1162 $this->is_key
= ( $this->is_pk ||
$this->is_unique ||
$this->is_multiple
);
1163 $this->type
= $info->type
;
1164 $this->binary
= isset( $info->binary
) ?
$info->binary
: false;
1177 function tableName() {
1178 return $this->tableName
;
1191 function isNullable() {
1192 return $this->nullable
;
1195 function defaultValue() {
1196 return $this->default;
1203 return $this->is_key
;
1209 function isMultipleKey() {
1210 return $this->is_multiple
;
1213 function isBinary() {
1214 return $this->binary
;
1218 class MySQLMasterPos
implements DBMasterPos
{
1221 function __construct( $file, $pos ) {
1222 $this->file
= $file;
1226 function __toString() {
1227 // e.g db1034-bin.000976/843431247
1228 return "{$this->file}/{$this->pos}";
1232 * @return array|false (int, int)
1234 protected function getCoordinates() {
1236 if ( preg_match( '!\.(\d+)/(\d+)$!', (string)$this, $m ) ) {
1237 return array( (int)$m[1], (int)$m[2] );
1243 function hasReached( MySQLMasterPos
$pos ) {
1244 $thisPos = $this->getCoordinates();
1245 $thatPos = $pos->getCoordinates();
1247 return ( $thisPos && $thatPos && $thisPos >= $thatPos );