3 * @defgroup Database Database
5 * This file deals with database interface functions
6 * and query specifics/optimisations.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
28 * Base interface for all DBMS-specific code. At a bare minimum, all of the
29 * following must be implemented to support MediaWiki
34 interface DatabaseType
{
36 * Get the type of the DBMS, as it appears in $wgDBtype.
43 * Open a connection to the database. Usually aborts on failure
45 * @param string $server database server host
46 * @param string $user database user name
47 * @param string $password database user password
48 * @param string $dbName database name
50 * @throws DBConnectionError
52 function open( $server, $user, $password, $dbName );
55 * Fetch the next row from the given result object, in object form.
56 * Fields can be retrieved with $row->fieldname, with fields acting like
58 * If no more rows are available, false is returned.
60 * @param $res ResultWrapper|object as returned from DatabaseBase::query(), etc.
62 * @throws DBUnexpectedError Thrown if the database returns an error
64 function fetchObject( $res );
67 * Fetch the next row from the given result object, in associative array
68 * form. Fields are retrieved with $row['fieldname'].
69 * If no more rows are available, false is returned.
71 * @param $res ResultWrapper result object as returned from DatabaseBase::query(), etc.
73 * @throws DBUnexpectedError Thrown if the database returns an error
75 function fetchRow( $res );
78 * Get the number of rows in a result object
80 * @param $res Mixed: A SQL result
83 function numRows( $res );
86 * Get the number of fields in a result object
87 * @see http://www.php.net/mysql_num_fields
89 * @param $res Mixed: A SQL result
92 function numFields( $res );
95 * Get a field name in a result object
96 * @see http://www.php.net/mysql_field_name
98 * @param $res Mixed: A SQL result
102 function fieldName( $res, $n );
105 * Get the inserted value of an auto-increment row
107 * The value inserted should be fetched from nextSequenceValue()
110 * $id = $dbw->nextSequenceValue( 'page_page_id_seq' );
111 * $dbw->insert( 'page', array( 'page_id' => $id ) );
112 * $id = $dbw->insertId();
119 * Change the position of the cursor in a result object
120 * @see http://www.php.net/mysql_data_seek
122 * @param $res Mixed: A SQL result
123 * @param $row Mixed: Either MySQL row or ResultWrapper
125 function dataSeek( $res, $row );
128 * Get the last error number
129 * @see http://www.php.net/mysql_errno
133 function lastErrno();
136 * Get a description of the last error
137 * @see http://www.php.net/mysql_error
141 function lastError();
144 * mysql_fetch_field() wrapper
145 * Returns false if the field doesn't exist
147 * @param string $table table name
148 * @param string $field field name
152 function fieldInfo( $table, $field );
155 * Get information about an index into an object
156 * @param string $table Table name
157 * @param string $index Index name
158 * @param string $fname Calling function name
159 * @return Mixed: Database-specific index description class or false if the index does not exist
161 function indexInfo( $table, $index, $fname = __METHOD__
);
164 * Get the number of rows affected by the last write query
165 * @see http://www.php.net/mysql_affected_rows
169 function affectedRows();
172 * Wrapper for addslashes()
174 * @param string $s to be slashed.
175 * @return string: slashed string.
177 function strencode( $s );
180 * Returns a wikitext link to the DB's website, e.g.,
181 * return "[http://www.mysql.com/ MySQL]";
182 * Should at least contain plain text, if for some reason
183 * your database has no website.
185 * @return string: wikitext of a link to the server software's web site
187 function getSoftwareLink();
190 * A string describing the current software version, like from
191 * mysql_get_server_info().
193 * @return string: Version information from the database server.
195 function getServerVersion();
198 * A string describing the current software version, and possibly
199 * other details in a user-friendly way. Will be listed on Special:Version, etc.
200 * Use getServerVersion() to get machine-friendly information.
202 * @return string: Version information from the database server
204 function getServerInfo();
208 * Interface for classes that implement or wrap DatabaseBase
211 interface IDatabase
{}
214 * Database abstraction object
217 abstract class DatabaseBase
implements IDatabase
, DatabaseType
{
218 /** Number of times to re-try an operation in case of deadlock */
219 const DEADLOCK_TRIES
= 4;
220 /** Minimum time to wait before retry, in microseconds */
221 const DEADLOCK_DELAY_MIN
= 500000;
222 /** Maximum time to wait before retry */
223 const DEADLOCK_DELAY_MAX
= 1500000;
225 # ------------------------------------------------------------------------------
227 # ------------------------------------------------------------------------------
229 protected $mLastQuery = '';
230 protected $mDoneWrites = false;
231 protected $mPHPError = false;
233 protected $mServer, $mUser, $mPassword, $mDBname;
235 protected $mConn = null;
236 protected $mOpened = false;
238 /** @var callable[] */
239 protected $mTrxIdleCallbacks = array();
240 /** @var callable[] */
241 protected $mTrxPreCommitCallbacks = array();
243 protected $mTablePrefix;
246 protected $mTrxLevel = 0;
247 protected $mErrorCount = 0;
248 protected $mLBInfo = array();
249 protected $mFakeSlaveLag = null, $mFakeMaster = false;
250 protected $mDefaultBigSelects = null;
251 protected $mSchemaVars = false;
253 protected $preparedArgs;
255 protected $htmlErrors;
257 protected $delimiter = ';';
260 * Remembers the function name given for starting the most recent transaction via begin().
261 * Used to provide additional context for error reporting.
264 * @see DatabaseBase::mTrxLevel
266 private $mTrxFname = null;
269 * Record if possible write queries were done in the last transaction started
272 * @see DatabaseBase::mTrxLevel
274 private $mTrxDoneWrites = false;
277 * Record if the current transaction was started implicitly due to DBO_TRX being set.
280 * @see DatabaseBase::mTrxLevel
282 private $mTrxAutomatic = false;
286 * @var file handle for upgrade
288 protected $fileHandle = null;
290 # ------------------------------------------------------------------------------
292 # ------------------------------------------------------------------------------
293 # These optionally set a variable and return the previous state
296 * A string describing the current software version, and possibly
297 * other details in a user-friendly way. Will be listed on Special:Version, etc.
298 * Use getServerVersion() to get machine-friendly information.
300 * @return string: Version information from the database server
302 public function getServerInfo() {
303 return $this->getServerVersion();
307 * @return string: command delimiter used by this database engine
309 public function getDelimiter() {
310 return $this->delimiter
;
314 * Boolean, controls output of large amounts of debug information.
315 * @param $debug bool|null
316 * - true to enable debugging
317 * - false to disable debugging
318 * - omitted or null to do nothing
320 * @return bool|null previous value of the flag
322 public function debug( $debug = null ) {
323 return wfSetBit( $this->mFlags
, DBO_DEBUG
, $debug );
327 * Turns buffering of SQL result sets on (true) or off (false). Default is
330 * Unbuffered queries are very troublesome in MySQL:
332 * - If another query is executed while the first query is being read
333 * out, the first query is killed. This means you can't call normal
334 * MediaWiki functions while you are reading an unbuffered query result
335 * from a normal wfGetDB() connection.
337 * - Unbuffered queries cause the MySQL server to use large amounts of
338 * memory and to hold broad locks which block other queries.
340 * If you want to limit client-side memory, it's almost always better to
341 * split up queries into batches using a LIMIT clause than to switch off
344 * @param $buffer null|bool
346 * @return null|bool The previous value of the flag
348 public function bufferResults( $buffer = null ) {
349 if ( is_null( $buffer ) ) {
350 return !(bool)( $this->mFlags
& DBO_NOBUFFER
);
352 return !wfSetBit( $this->mFlags
, DBO_NOBUFFER
, !$buffer );
357 * Turns on (false) or off (true) the automatic generation and sending
358 * of a "we're sorry, but there has been a database error" page on
359 * database errors. Default is on (false). When turned off, the
360 * code should use lastErrno() and lastError() to handle the
361 * situation as appropriate.
363 * @param $ignoreErrors bool|null
365 * @return bool The previous value of the flag.
367 public function ignoreErrors( $ignoreErrors = null ) {
368 return wfSetBit( $this->mFlags
, DBO_IGNORE
, $ignoreErrors );
372 * Gets or sets the current transaction level.
374 * Historically, transactions were allowed to be "nested". This is no
375 * longer supported, so this function really only returns a boolean.
377 * @param int $level An integer (0 or 1), or omitted to leave it unchanged.
378 * @return int The previous value
380 public function trxLevel( $level = null ) {
381 return wfSetVar( $this->mTrxLevel
, $level );
385 * Get/set the number of errors logged. Only useful when errors are ignored
386 * @param int $count The count to set, or omitted to leave it unchanged.
387 * @return int The error count
389 public function errorCount( $count = null ) {
390 return wfSetVar( $this->mErrorCount
, $count );
394 * Get/set the table prefix.
395 * @param string $prefix The table prefix to set, or omitted to leave it unchanged.
396 * @return string The previous table prefix.
398 public function tablePrefix( $prefix = null ) {
399 return wfSetVar( $this->mTablePrefix
, $prefix );
403 * Set the filehandle to copy write statements to.
405 * @param $fh filehandle
407 public function setFileHandle( $fh ) {
408 $this->fileHandle
= $fh;
412 * Get properties passed down from the server info array of the load
415 * @param string $name The entry of the info array to get, or null to get the
418 * @return LoadBalancer|null
420 public function getLBInfo( $name = null ) {
421 if ( is_null( $name ) ) {
422 return $this->mLBInfo
;
424 if ( array_key_exists( $name, $this->mLBInfo
) ) {
425 return $this->mLBInfo
[$name];
433 * Set the LB info array, or a member of it. If called with one parameter,
434 * the LB info array is set to that parameter. If it is called with two
435 * parameters, the member with the given name is set to the given value.
440 public function setLBInfo( $name, $value = null ) {
441 if ( is_null( $value ) ) {
442 $this->mLBInfo
= $name;
444 $this->mLBInfo
[$name] = $value;
449 * Set lag time in seconds for a fake slave
453 public function setFakeSlaveLag( $lag ) {
454 $this->mFakeSlaveLag
= $lag;
458 * Make this connection a fake master
460 * @param $enabled bool
462 public function setFakeMaster( $enabled = true ) {
463 $this->mFakeMaster
= $enabled;
467 * Returns true if this database supports (and uses) cascading deletes
471 public function cascadingDeletes() {
476 * Returns true if this database supports (and uses) triggers (e.g. on the page table)
480 public function cleanupTriggers() {
485 * Returns true if this database is strict about what can be put into an IP field.
486 * Specifically, it uses a NULL value instead of an empty string.
490 public function strictIPs() {
495 * Returns true if this database uses timestamps rather than integers
499 public function realTimestamps() {
504 * Returns true if this database does an implicit sort when doing GROUP BY
508 public function implicitGroupby() {
513 * Returns true if this database does an implicit order by when the column has an index
514 * For example: SELECT page_title FROM page LIMIT 1
518 public function implicitOrderby() {
523 * Returns true if this database can do a native search on IP columns
524 * e.g. this works as expected: .. WHERE rc_ip = '127.42.12.102/32';
528 public function searchableIPs() {
533 * Returns true if this database can use functional indexes
537 public function functionalIndexes() {
542 * Return the last query that went through DatabaseBase::query()
545 public function lastQuery() {
546 return $this->mLastQuery
;
550 * Returns true if the connection may have been used for write queries.
551 * Should return true if unsure.
555 public function doneWrites() {
556 return $this->mDoneWrites
;
560 * Returns true if there is a transaction open with possible write
561 * queries or transaction pre-commit/idle callbacks waiting on it to finish.
565 public function writesOrCallbacksPending() {
566 return $this->mTrxLevel
&& (
567 $this->mTrxDoneWrites ||
$this->mTrxIdleCallbacks ||
$this->mTrxPreCommitCallbacks
572 * Is a connection to the database open?
575 public function isOpen() {
576 return $this->mOpened
;
580 * Set a flag for this connection
582 * @param $flag Integer: DBO_* constants from Defines.php:
583 * - DBO_DEBUG: output some debug info (same as debug())
584 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
585 * - DBO_IGNORE: ignore errors (same as ignoreErrors())
586 * - DBO_TRX: automatically start transactions
587 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
588 * and removes it in command line mode
589 * - DBO_PERSISTENT: use persistant database connection
591 public function setFlag( $flag ) {
592 global $wgDebugDBTransactions;
593 $this->mFlags |
= $flag;
594 if ( ( $flag & DBO_TRX
) & $wgDebugDBTransactions ) {
595 wfDebug( "Implicit transactions are now disabled.\n" );
600 * Clear a flag for this connection
602 * @param $flag: same as setFlag()'s $flag param
604 public function clearFlag( $flag ) {
605 global $wgDebugDBTransactions;
606 $this->mFlags
&= ~
$flag;
607 if ( ( $flag & DBO_TRX
) && $wgDebugDBTransactions ) {
608 wfDebug( "Implicit transactions are now disabled.\n" );
613 * Returns a boolean whether the flag $flag is set for this connection
615 * @param $flag: same as setFlag()'s $flag param
618 public function getFlag( $flag ) {
619 return !!( $this->mFlags
& $flag );
623 * General read-only accessor
625 * @param $name string
629 public function getProperty( $name ) {
636 public function getWikiID() {
637 if ( $this->mTablePrefix
) {
638 return "{$this->mDBname}-{$this->mTablePrefix}";
640 return $this->mDBname
;
645 * Return a path to the DBMS-specific schema file, otherwise default to tables.sql
649 public function getSchemaPath() {
651 if ( file_exists( "$IP/maintenance/" . $this->getType() . "/tables.sql" ) ) {
652 return "$IP/maintenance/" . $this->getType() . "/tables.sql";
654 return "$IP/maintenance/tables.sql";
658 # ------------------------------------------------------------------------------
660 # ------------------------------------------------------------------------------
664 * @param string $server database server host
665 * @param string $user database user name
666 * @param string $password database user password
667 * @param string $dbName database name
669 * @param string $tablePrefix database table prefixes. By default use the prefix gave in LocalSettings.php
670 * @param bool $foreign disable some operations specific to local databases
672 function __construct( $server = false, $user = false, $password = false, $dbName = false,
673 $flags = 0, $tablePrefix = 'get from global', $foreign = false
675 global $wgDBprefix, $wgCommandLineMode, $wgDebugDBTransactions;
677 $this->mFlags
= $flags;
679 if ( $this->mFlags
& DBO_DEFAULT
) {
680 if ( $wgCommandLineMode ) {
681 $this->mFlags
&= ~DBO_TRX
;
682 if ( $wgDebugDBTransactions ) {
683 wfDebug( "Implicit transaction open disabled.\n" );
686 $this->mFlags |
= DBO_TRX
;
687 if ( $wgDebugDBTransactions ) {
688 wfDebug( "Implicit transaction open enabled.\n" );
693 /** Get the default table prefix*/
694 if ( $tablePrefix == 'get from global' ) {
695 $this->mTablePrefix
= $wgDBprefix;
697 $this->mTablePrefix
= $tablePrefix;
700 $this->mForeign
= $foreign;
703 $this->open( $server, $user, $password, $dbName );
708 * Called by serialize. Throw an exception when DB connection is serialized.
709 * This causes problems on some database engines because the connection is
710 * not restored on unserialize.
712 public function __sleep() {
713 throw new MWException( 'Database serialization may cause problems, since the connection is not restored on wakeup.' );
717 * Given a DB type, construct the name of the appropriate child class of
718 * DatabaseBase. This is designed to replace all of the manual stuff like:
719 * $class = 'Database' . ucfirst( strtolower( $type ) );
720 * as well as validate against the canonical list of DB types we have
722 * This factory function is mostly useful for when you need to connect to a
723 * database other than the MediaWiki default (such as for external auth,
724 * an extension, et cetera). Do not use this to connect to the MediaWiki
725 * database. Example uses in core:
726 * @see LoadBalancer::reallyOpenConnection()
727 * @see ForeignDBRepo::getMasterDB()
728 * @see WebInstaller_DBConnect::execute()
732 * @param string $dbType A possible DB type
733 * @param array $p An array of options to pass to the constructor.
734 * Valid options are: host, user, password, dbname, flags, tablePrefix
735 * @return DatabaseBase subclass or null
737 final public static function factory( $dbType, $p = array() ) {
738 $canonicalDBTypes = array(
739 'mysql', 'postgres', 'sqlite', 'oracle', 'mssql'
741 $dbType = strtolower( $dbType );
742 $class = 'Database' . ucfirst( $dbType );
744 if ( in_array( $dbType, $canonicalDBTypes ) ||
( class_exists( $class ) && is_subclass_of( $class, 'DatabaseBase' ) ) ) {
746 isset( $p['host'] ) ?
$p['host'] : false,
747 isset( $p['user'] ) ?
$p['user'] : false,
748 isset( $p['password'] ) ?
$p['password'] : false,
749 isset( $p['dbname'] ) ?
$p['dbname'] : false,
750 isset( $p['flags'] ) ?
$p['flags'] : 0,
751 isset( $p['tablePrefix'] ) ?
$p['tablePrefix'] : 'get from global',
752 isset( $p['foreign'] ) ?
$p['foreign'] : false
759 protected function installErrorHandler() {
760 $this->mPHPError
= false;
761 $this->htmlErrors
= ini_set( 'html_errors', '0' );
762 set_error_handler( array( $this, 'connectionErrorHandler' ) );
766 * @return bool|string
768 protected function restoreErrorHandler() {
769 restore_error_handler();
770 if ( $this->htmlErrors
!== false ) {
771 ini_set( 'html_errors', $this->htmlErrors
);
773 if ( $this->mPHPError
) {
774 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->mPHPError
);
775 $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
787 public function connectionErrorHandler( $errno, $errstr ) {
788 $this->mPHPError
= $errstr;
792 * Closes a database connection.
793 * if it is open : commits any open transactions
795 * @throws MWException
796 * @return Bool operation success. true if already closed.
798 public function close() {
799 if ( count( $this->mTrxIdleCallbacks
) ) { // sanity
800 throw new MWException( "Transaction idle callbacks still pending." );
802 $this->mOpened
= false;
803 if ( $this->mConn
) {
804 if ( $this->trxLevel() ) {
805 if ( !$this->mTrxAutomatic
) {
806 wfWarn( "Transaction still in progress (from {$this->mTrxFname}), " .
807 " performing implicit commit before closing connection!" );
810 $this->commit( __METHOD__
, 'flush' );
813 $ret = $this->closeConnection();
814 $this->mConn
= false;
822 * Closes underlying database connection
824 * @return bool: Whether connection was closed successfully
826 abstract protected function closeConnection();
829 * @param string $error fallback error message, used if none is given by DB
830 * @throws DBConnectionError
832 function reportConnectionError( $error = 'Unknown error' ) {
833 $myError = $this->lastError();
839 throw new DBConnectionError( $this, $error );
843 * The DBMS-dependent part of query()
845 * @param $sql String: SQL query.
846 * @return ResultWrapper Result object to feed to fetchObject, fetchRow, ...; or false on failure
848 abstract protected function doQuery( $sql );
851 * Determine whether a query writes to the DB.
852 * Should return true if unsure.
858 public function isWriteQuery( $sql ) {
859 return !preg_match( '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SET|SHOW|EXPLAIN|\(SELECT)\b/i', $sql );
863 * Run an SQL query and return the result. Normally throws a DBQueryError
864 * on failure. If errors are ignored, returns false instead.
866 * In new code, the query wrappers select(), insert(), update(), delete(),
867 * etc. should be used where possible, since they give much better DBMS
868 * independence and automatically quote or validate user input in a variety
869 * of contexts. This function is generally only useful for queries which are
870 * explicitly DBMS-dependent and are unsupported by the query wrappers, such
873 * However, the query wrappers themselves should call this function.
875 * @param $sql String: SQL query
876 * @param $fname String: Name of the calling function, for profiling/SHOW PROCESSLIST
877 * comment (you can use __METHOD__ or add some extra info)
878 * @param $tempIgnore Boolean: Whether to avoid throwing an exception on errors...
879 * maybe best to catch the exception instead?
880 * @throws MWException
881 * @return boolean|ResultWrapper. true for a successful write query, ResultWrapper object
882 * for a successful read query, or false on failure if $tempIgnore set
884 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false ) {
885 global $wgUser, $wgDebugDBTransactions;
887 $this->mLastQuery
= $sql;
888 if ( !$this->mDoneWrites
&& $this->isWriteQuery( $sql ) ) {
889 # Set a flag indicating that writes have been done
890 wfDebug( __METHOD__
. ": Writes done: $sql\n" );
891 $this->mDoneWrites
= true;
894 # Add a comment for easy SHOW PROCESSLIST interpretation
895 if ( is_object( $wgUser ) && $wgUser->isItemLoaded( 'name' ) ) {
896 $userName = $wgUser->getName();
897 if ( mb_strlen( $userName ) > 15 ) {
898 $userName = mb_substr( $userName, 0, 15 ) . '...';
900 $userName = str_replace( '/', '', $userName );
905 // Add trace comment to the begin of the sql string, right after the operator.
906 // Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (bug 42598)
907 $commentedSql = preg_replace( '/\s|$/', " /* $fname $userName */ ", $sql, 1 );
909 # If DBO_TRX is set, start a transaction
910 if ( ( $this->mFlags
& DBO_TRX
) && !$this->mTrxLevel
&&
911 $sql != 'BEGIN' && $sql != 'COMMIT' && $sql != 'ROLLBACK' )
913 # Avoid establishing transactions for SHOW and SET statements too -
914 # that would delay transaction initializations to once connection
915 # is really used by application
916 $sqlstart = substr( $sql, 0, 10 ); // very much worth it, benchmark certified(tm)
917 if ( strpos( $sqlstart, "SHOW " ) !== 0 && strpos( $sqlstart, "SET " ) !== 0 ) {
918 if ( $wgDebugDBTransactions ) {
919 wfDebug( "Implicit transaction start.\n" );
921 $this->begin( __METHOD__
. " ($fname)" );
922 $this->mTrxAutomatic
= true;
926 # Keep track of whether the transaction has write queries pending
927 if ( $this->mTrxLevel
&& !$this->mTrxDoneWrites
&& $this->isWriteQuery( $sql ) ) {
928 $this->mTrxDoneWrites
= true;
929 Profiler
::instance()->transactionWritingIn( $this->mServer
, $this->mDBname
);
932 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
933 if ( !Profiler
::instance()->isStub() ) {
934 # generalizeSQL will probably cut down the query to reasonable
935 # logging size most of the time. The substr is really just a sanity check.
937 $queryProf = 'query-m: ' . substr( DatabaseBase
::generalizeSQL( $sql ), 0, 255 );
938 $totalProf = 'DatabaseBase::query-master';
940 $queryProf = 'query: ' . substr( DatabaseBase
::generalizeSQL( $sql ), 0, 255 );
941 $totalProf = 'DatabaseBase::query';
943 wfProfileIn( $totalProf );
944 wfProfileIn( $queryProf );
947 if ( $this->debug() ) {
951 $sqlx = substr( $commentedSql, 0, 500 );
952 $sqlx = strtr( $sqlx, "\t\n", ' ' );
954 $master = $isMaster ?
'master' : 'slave';
955 wfDebug( "Query {$this->mDBname} ($cnt) ($master): $sqlx\n" );
958 $queryId = MWDebug
::query( $sql, $fname, $isMaster );
960 # Do the query and handle errors
961 $ret = $this->doQuery( $commentedSql );
963 MWDebug
::queryTime( $queryId );
965 # Try reconnecting if the connection was lost
966 if ( false === $ret && $this->wasErrorReissuable() ) {
967 # Transaction is gone, like it or not
968 $this->mTrxLevel
= 0;
969 $this->mTrxIdleCallbacks
= array(); // cancel
970 $this->mTrxPreCommitCallbacks
= array(); // cancel
971 wfDebug( "Connection lost, reconnecting...\n" );
973 if ( $this->ping() ) {
974 wfDebug( "Reconnected\n" );
975 $sqlx = substr( $commentedSql, 0, 500 );
976 $sqlx = strtr( $sqlx, "\t\n", ' ' );
977 global $wgRequestTime;
978 $elapsed = round( microtime( true ) - $wgRequestTime, 3 );
979 if ( $elapsed < 300 ) {
980 # Not a database error to lose a transaction after a minute or two
981 wfLogDBError( "Connection lost and reconnected after {$elapsed}s, query: $sqlx\n" );
983 $ret = $this->doQuery( $commentedSql );
985 wfDebug( "Failed\n" );
989 if ( false === $ret ) {
990 $this->reportQueryError( $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
993 if ( !Profiler
::instance()->isStub() ) {
994 wfProfileOut( $queryProf );
995 wfProfileOut( $totalProf );
998 return $this->resultObject( $ret );
1002 * Report a query error. Log the error, and if neither the object ignore
1003 * flag nor the $tempIgnore flag is set, throw a DBQueryError.
1005 * @param $error String
1006 * @param $errno Integer
1007 * @param $sql String
1008 * @param $fname String
1009 * @param $tempIgnore Boolean
1010 * @throws DBQueryError
1012 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1013 # Ignore errors during error handling to avoid infinite recursion
1014 $ignore = $this->ignoreErrors( true );
1015 ++
$this->mErrorCount
;
1017 if ( $ignore ||
$tempIgnore ) {
1018 wfDebug( "SQL ERROR (ignored): $error\n" );
1019 $this->ignoreErrors( $ignore );
1021 $sql1line = str_replace( "\n", "\\n", $sql );
1022 wfLogDBError( "$fname\t{$this->mServer}\t$errno\t$error\t$sql1line\n" );
1023 wfDebug( "SQL ERROR: " . $error . "\n" );
1024 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
1029 * Intended to be compatible with the PEAR::DB wrapper functions.
1030 * http://pear.php.net/manual/en/package.database.db.intro-execute.php
1032 * ? = scalar value, quoted as necessary
1033 * ! = raw SQL bit (a function for instance)
1034 * & = filename; reads the file and inserts as a blob
1035 * (we don't use this though...)
1037 * @param $sql string
1038 * @param $func string
1042 protected function prepare( $sql, $func = 'DatabaseBase::prepare' ) {
1043 /* MySQL doesn't support prepared statements (yet), so just
1044 pack up the query for reference. We'll manually replace
1046 return array( 'query' => $sql, 'func' => $func );
1050 * Free a prepared query, generated by prepare().
1053 protected function freePrepared( $prepared ) {
1054 /* No-op by default */
1058 * Execute a prepared query with the various arguments
1059 * @param string $prepared the prepared sql
1060 * @param $args Mixed: Either an array here, or put scalars as varargs
1062 * @return ResultWrapper
1064 public function execute( $prepared, $args = null ) {
1065 if ( !is_array( $args ) ) {
1067 $args = func_get_args();
1068 array_shift( $args );
1071 $sql = $this->fillPrepared( $prepared['query'], $args );
1073 return $this->query( $sql, $prepared['func'] );
1077 * For faking prepared SQL statements on DBs that don't support it directly.
1079 * @param string $preparedQuery a 'preparable' SQL statement
1080 * @param array $args of arguments to fill it with
1081 * @return string executable SQL
1083 public function fillPrepared( $preparedQuery, $args ) {
1085 $this->preparedArgs
=& $args;
1087 return preg_replace_callback( '/(\\\\[?!&]|[?!&])/',
1088 array( &$this, 'fillPreparedArg' ), $preparedQuery );
1092 * preg_callback func for fillPrepared()
1093 * The arguments should be in $this->preparedArgs and must not be touched
1094 * while we're doing this.
1096 * @param $matches Array
1097 * @throws DBUnexpectedError
1100 protected function fillPreparedArg( $matches ) {
1101 switch ( $matches[1] ) {
1110 list( /* $n */, $arg ) = each( $this->preparedArgs
);
1112 switch ( $matches[1] ) {
1114 return $this->addQuotes( $arg );
1118 # return $this->addQuotes( file_get_contents( $arg ) );
1119 throw new DBUnexpectedError( $this, '& mode is not implemented. If it\'s really needed, uncomment the line above.' );
1121 throw new DBUnexpectedError( $this, 'Received invalid match. This should never happen!' );
1126 * Free a result object returned by query() or select(). It's usually not
1127 * necessary to call this, just use unset() or let the variable holding
1128 * the result object go out of scope.
1130 * @param $res Mixed: A SQL result
1132 public function freeResult( $res ) {
1136 * A SELECT wrapper which returns a single field from a single result row.
1138 * Usually throws a DBQueryError on failure. If errors are explicitly
1139 * ignored, returns false on failure.
1141 * If no result rows are returned from the query, false is returned.
1143 * @param string|array $table Table name. See DatabaseBase::select() for details.
1144 * @param string $var The field name to select. This must be a valid SQL
1145 * fragment: do not use unvalidated user input.
1146 * @param string|array $cond The condition array. See DatabaseBase::select() for details.
1147 * @param string $fname The function name of the caller.
1148 * @param string|array $options The query options. See DatabaseBase::select() for details.
1150 * @return bool|mixed The value from the field, or false on failure.
1152 public function selectField( $table, $var, $cond = '', $fname = __METHOD__
,
1155 if ( !is_array( $options ) ) {
1156 $options = array( $options );
1159 $options['LIMIT'] = 1;
1161 $res = $this->select( $table, $var, $cond, $fname, $options );
1163 if ( $res === false ||
!$this->numRows( $res ) ) {
1167 $row = $this->fetchRow( $res );
1169 if ( $row !== false ) {
1170 return reset( $row );
1177 * Returns an optional USE INDEX clause to go after the table, and a
1178 * string to go at the end of the query.
1180 * @param array $options associative array of options to be turned into
1181 * an SQL query, valid keys are listed in the function.
1183 * @see DatabaseBase::select()
1185 public function makeSelectOptions( $options ) {
1186 $preLimitTail = $postLimitTail = '';
1189 $noKeyOptions = array();
1191 foreach ( $options as $key => $option ) {
1192 if ( is_numeric( $key ) ) {
1193 $noKeyOptions[$option] = true;
1197 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1199 $preLimitTail .= $this->makeOrderBy( $options );
1201 // if (isset($options['LIMIT'])) {
1202 // $tailOpts .= $this->limitResult('', $options['LIMIT'],
1203 // isset($options['OFFSET']) ? $options['OFFSET']
1207 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1208 $postLimitTail .= ' FOR UPDATE';
1211 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1212 $postLimitTail .= ' LOCK IN SHARE MODE';
1215 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) {
1216 $startOpts .= 'DISTINCT';
1219 # Various MySQL extensions
1220 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1221 $startOpts .= ' /*! STRAIGHT_JOIN */';
1224 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1225 $startOpts .= ' HIGH_PRIORITY';
1228 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1229 $startOpts .= ' SQL_BIG_RESULT';
1232 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1233 $startOpts .= ' SQL_BUFFER_RESULT';
1236 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1237 $startOpts .= ' SQL_SMALL_RESULT';
1240 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1241 $startOpts .= ' SQL_CALC_FOUND_ROWS';
1244 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1245 $startOpts .= ' SQL_CACHE';
1248 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1249 $startOpts .= ' SQL_NO_CACHE';
1252 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1253 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1258 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1262 * Returns an optional GROUP BY with an optional HAVING
1264 * @param array $options associative array of options
1266 * @see DatabaseBase::select()
1269 public function makeGroupByWithHaving( $options ) {
1271 if ( isset( $options['GROUP BY'] ) ) {
1272 $gb = is_array( $options['GROUP BY'] )
1273 ?
implode( ',', $options['GROUP BY'] )
1274 : $options['GROUP BY'];
1275 $sql .= ' GROUP BY ' . $gb;
1277 if ( isset( $options['HAVING'] ) ) {
1278 $having = is_array( $options['HAVING'] )
1279 ?
$this->makeList( $options['HAVING'], LIST_AND
)
1280 : $options['HAVING'];
1281 $sql .= ' HAVING ' . $having;
1287 * Returns an optional ORDER BY
1289 * @param array $options associative array of options
1291 * @see DatabaseBase::select()
1294 public function makeOrderBy( $options ) {
1295 if ( isset( $options['ORDER BY'] ) ) {
1296 $ob = is_array( $options['ORDER BY'] )
1297 ?
implode( ',', $options['ORDER BY'] )
1298 : $options['ORDER BY'];
1299 return ' ORDER BY ' . $ob;
1305 * Execute a SELECT query constructed using the various parameters provided.
1306 * See below for full details of the parameters.
1308 * @param string|array $table Table name
1309 * @param string|array $vars Field names
1310 * @param string|array $conds Conditions
1311 * @param string $fname Caller function name
1312 * @param array $options Query options
1313 * @param $join_conds Array Join conditions
1315 * @param $table string|array
1317 * May be either an array of table names, or a single string holding a table
1318 * name. If an array is given, table aliases can be specified, for example:
1320 * array( 'a' => 'user' )
1322 * This includes the user table in the query, with the alias "a" available
1323 * for use in field names (e.g. a.user_name).
1325 * All of the table names given here are automatically run through
1326 * DatabaseBase::tableName(), which causes the table prefix (if any) to be
1327 * added, and various other table name mappings to be performed.
1330 * @param $vars string|array
1332 * May be either a field name or an array of field names. The field names
1333 * can be complete fragments of SQL, for direct inclusion into the SELECT
1334 * query. If an array is given, field aliases can be specified, for example:
1336 * array( 'maxrev' => 'MAX(rev_id)' )
1338 * This includes an expression with the alias "maxrev" in the query.
1340 * If an expression is given, care must be taken to ensure that it is
1344 * @param $conds string|array
1346 * May be either a string containing a single condition, or an array of
1347 * conditions. If an array is given, the conditions constructed from each
1348 * element are combined with AND.
1350 * Array elements may take one of two forms:
1352 * - Elements with a numeric key are interpreted as raw SQL fragments.
1353 * - Elements with a string key are interpreted as equality conditions,
1354 * where the key is the field name.
1355 * - If the value of such an array element is a scalar (such as a
1356 * string), it will be treated as data and thus quoted appropriately.
1357 * If it is null, an IS NULL clause will be added.
1358 * - If the value is an array, an IN(...) clause will be constructed,
1359 * such that the field name may match any of the elements in the
1360 * array. The elements of the array will be quoted.
1362 * Note that expressions are often DBMS-dependent in their syntax.
1363 * DBMS-independent wrappers are provided for constructing several types of
1364 * expression commonly used in condition queries. See:
1365 * - DatabaseBase::buildLike()
1366 * - DatabaseBase::conditional()
1369 * @param $options string|array
1371 * Optional: Array of query options. Boolean options are specified by
1372 * including them in the array as a string value with a numeric key, for
1375 * array( 'FOR UPDATE' )
1377 * The supported options are:
1379 * - OFFSET: Skip this many rows at the start of the result set. OFFSET
1380 * with LIMIT can theoretically be used for paging through a result set,
1381 * but this is discouraged in MediaWiki for performance reasons.
1383 * - LIMIT: Integer: return at most this many rows. The rows are sorted
1384 * and then the first rows are taken until the limit is reached. LIMIT
1385 * is applied to a result set after OFFSET.
1387 * - FOR UPDATE: Boolean: lock the returned rows so that they can't be
1388 * changed until the next COMMIT.
1390 * - DISTINCT: Boolean: return only unique result rows.
1392 * - GROUP BY: May be either an SQL fragment string naming a field or
1393 * expression to group by, or an array of such SQL fragments.
1395 * - HAVING: May be either an string containing a HAVING clause or an array of
1396 * conditions building the HAVING clause. If an array is given, the conditions
1397 * constructed from each element are combined with AND.
1399 * - ORDER BY: May be either an SQL fragment giving a field name or
1400 * expression to order by, or an array of such SQL fragments.
1402 * - USE INDEX: This may be either a string giving the index name to use
1403 * for the query, or an array. If it is an associative array, each key
1404 * gives the table name (or alias), each value gives the index name to
1405 * use for that table. All strings are SQL fragments and so should be
1406 * validated by the caller.
1408 * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run,
1409 * instead of SELECT.
1411 * And also the following boolean MySQL extensions, see the MySQL manual
1412 * for documentation:
1414 * - LOCK IN SHARE MODE
1418 * - SQL_BUFFER_RESULT
1419 * - SQL_SMALL_RESULT
1420 * - SQL_CALC_FOUND_ROWS
1425 * @param $join_conds string|array
1427 * Optional associative array of table-specific join conditions. In the
1428 * most common case, this is unnecessary, since the join condition can be
1429 * in $conds. However, it is useful for doing a LEFT JOIN.
1431 * The key of the array contains the table name or alias. The value is an
1432 * array with two elements, numbered 0 and 1. The first gives the type of
1433 * join, the second is an SQL fragment giving the join condition for that
1434 * table. For example:
1436 * array( 'page' => array( 'LEFT JOIN', 'page_latest=rev_id' ) )
1438 * @return ResultWrapper. If the query returned no rows, a ResultWrapper
1439 * with no rows in it will be returned. If there was a query error, a
1440 * DBQueryError exception will be thrown, except if the "ignore errors"
1441 * option was set, in which case false will be returned.
1443 public function select( $table, $vars, $conds = '', $fname = __METHOD__
,
1444 $options = array(), $join_conds = array() ) {
1445 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1447 return $this->query( $sql, $fname );
1451 * The equivalent of DatabaseBase::select() except that the constructed SQL
1452 * is returned, instead of being immediately executed. This can be useful for
1453 * doing UNION queries, where the SQL text of each query is needed. In general,
1454 * however, callers outside of Database classes should just use select().
1456 * @param string|array $table Table name
1457 * @param string|array $vars Field names
1458 * @param string|array $conds Conditions
1459 * @param string $fname Caller function name
1460 * @param string|array $options Query options
1461 * @param $join_conds string|array Join conditions
1463 * @return string SQL query string.
1464 * @see DatabaseBase::select()
1466 public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__
,
1467 $options = array(), $join_conds = array() )
1469 if ( is_array( $vars ) ) {
1470 $vars = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1473 $options = (array)$options;
1474 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1475 ?
$options['USE INDEX']
1478 if ( is_array( $table ) ) {
1480 $this->tableNamesWithUseIndexOrJOIN( $table, $useIndexes, $join_conds );
1481 } elseif ( $table != '' ) {
1482 if ( $table[0] == ' ' ) {
1483 $from = ' FROM ' . $table;
1486 $this->tableNamesWithUseIndexOrJOIN( array( $table ), $useIndexes, array() );
1492 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail ) =
1493 $this->makeSelectOptions( $options );
1495 if ( !empty( $conds ) ) {
1496 if ( is_array( $conds ) ) {
1497 $conds = $this->makeList( $conds, LIST_AND
);
1499 $sql = "SELECT $startOpts $vars $from $useIndex WHERE $conds $preLimitTail";
1501 $sql = "SELECT $startOpts $vars $from $useIndex $preLimitTail";
1504 if ( isset( $options['LIMIT'] ) ) {
1505 $sql = $this->limitResult( $sql, $options['LIMIT'],
1506 isset( $options['OFFSET'] ) ?
$options['OFFSET'] : false );
1508 $sql = "$sql $postLimitTail";
1510 if ( isset( $options['EXPLAIN'] ) ) {
1511 $sql = 'EXPLAIN ' . $sql;
1518 * Single row SELECT wrapper. Equivalent to DatabaseBase::select(), except
1519 * that a single row object is returned. If the query returns no rows,
1520 * false is returned.
1522 * @param string|array $table Table name
1523 * @param string|array $vars Field names
1524 * @param array $conds Conditions
1525 * @param string $fname Caller function name
1526 * @param string|array $options Query options
1527 * @param $join_conds array|string Join conditions
1529 * @return object|bool
1531 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
1532 $options = array(), $join_conds = array() )
1534 $options = (array)$options;
1535 $options['LIMIT'] = 1;
1536 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1538 if ( $res === false ) {
1542 if ( !$this->numRows( $res ) ) {
1546 $obj = $this->fetchObject( $res );
1552 * Estimate rows in dataset.
1554 * MySQL allows you to estimate the number of rows that would be returned
1555 * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using
1556 * index cardinality statistics, and is notoriously inaccurate, especially
1557 * when large numbers of rows have recently been added or deleted.
1559 * For DBMSs that don't support fast result size estimation, this function
1560 * will actually perform the SELECT COUNT(*).
1562 * Takes the same arguments as DatabaseBase::select().
1564 * @param string $table table name
1565 * @param array|string $vars : unused
1566 * @param array|string $conds : filters on the table
1567 * @param string $fname function name for profiling
1568 * @param array $options options for select
1569 * @return Integer: row count
1571 public function estimateRowCount( $table, $vars = '*', $conds = '',
1572 $fname = __METHOD__
, $options = array() )
1575 $res = $this->select( $table, array( 'rowcount' => 'COUNT(*)' ), $conds, $fname, $options );
1578 $row = $this->fetchRow( $res );
1579 $rows = ( isset( $row['rowcount'] ) ) ?
$row['rowcount'] : 0;
1586 * Removes most variables from an SQL query and replaces them with X or N for numbers.
1587 * It's only slightly flawed. Don't use for anything important.
1589 * @param string $sql A SQL Query
1593 static function generalizeSQL( $sql ) {
1594 # This does the same as the regexp below would do, but in such a way
1595 # as to avoid crashing php on some large strings.
1596 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
1598 $sql = str_replace( "\\\\", '', $sql );
1599 $sql = str_replace( "\\'", '', $sql );
1600 $sql = str_replace( "\\\"", '', $sql );
1601 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
1602 $sql = preg_replace( '/".*"/s', "'X'", $sql );
1604 # All newlines, tabs, etc replaced by single space
1605 $sql = preg_replace( '/\s+/', ' ', $sql );
1608 $sql = preg_replace( '/-?\d+(,-?\d+)+/s', 'N,...,N', $sql );
1609 $sql = preg_replace( '/-?\d+/s', 'N', $sql );
1615 * Determines whether a field exists in a table
1617 * @param string $table table name
1618 * @param string $field filed to check on that table
1619 * @param string $fname calling function name (optional)
1620 * @return Boolean: whether $table has filed $field
1622 public function fieldExists( $table, $field, $fname = __METHOD__
) {
1623 $info = $this->fieldInfo( $table, $field );
1629 * Determines whether an index exists
1630 * Usually throws a DBQueryError on failure
1631 * If errors are explicitly ignored, returns NULL on failure
1635 * @param $fname string
1639 public function indexExists( $table, $index, $fname = __METHOD__
) {
1640 if ( !$this->tableExists( $table ) ) {
1644 $info = $this->indexInfo( $table, $index, $fname );
1645 if ( is_null( $info ) ) {
1648 return $info !== false;
1653 * Query whether a given table exists
1655 * @param $table string
1656 * @param $fname string
1660 public function tableExists( $table, $fname = __METHOD__
) {
1661 $table = $this->tableName( $table );
1662 $old = $this->ignoreErrors( true );
1663 $res = $this->query( "SELECT 1 FROM $table LIMIT 1", $fname );
1664 $this->ignoreErrors( $old );
1670 * mysql_field_type() wrapper
1675 public function fieldType( $res, $index ) {
1676 if ( $res instanceof ResultWrapper
) {
1677 $res = $res->result
;
1680 return mysql_field_type( $res, $index );
1684 * Determines if a given index is unique
1686 * @param $table string
1687 * @param $index string
1691 public function indexUnique( $table, $index ) {
1692 $indexInfo = $this->indexInfo( $table, $index );
1694 if ( !$indexInfo ) {
1698 return !$indexInfo[0]->Non_unique
;
1702 * Helper for DatabaseBase::insert().
1704 * @param $options array
1707 protected function makeInsertOptions( $options ) {
1708 return implode( ' ', $options );
1712 * INSERT wrapper, inserts an array into a table.
1716 * - A single associative array. The array keys are the field names, and
1717 * the values are the values to insert. The values are treated as data
1718 * and will be quoted appropriately. If NULL is inserted, this will be
1719 * converted to a database NULL.
1720 * - An array with numeric keys, holding a list of associative arrays.
1721 * This causes a multi-row INSERT on DBMSs that support it. The keys in
1722 * each subarray must be identical to each other, and in the same order.
1724 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
1727 * $options is an array of options, with boolean options encoded as values
1728 * with numeric keys, in the same style as $options in
1729 * DatabaseBase::select(). Supported options are:
1731 * - IGNORE: Boolean: if present, duplicate key errors are ignored, and
1732 * any rows which cause duplicate key errors are not inserted. It's
1733 * possible to determine how many rows were successfully inserted using
1734 * DatabaseBase::affectedRows().
1736 * @param $table String Table name. This will be passed through
1737 * DatabaseBase::tableName().
1738 * @param $a Array of rows to insert
1739 * @param $fname String Calling function name (use __METHOD__) for logs/profiling
1740 * @param array $options of options
1744 public function insert( $table, $a, $fname = __METHOD__
, $options = array() ) {
1745 # No rows to insert, easy just return now
1746 if ( !count( $a ) ) {
1750 $table = $this->tableName( $table );
1752 if ( !is_array( $options ) ) {
1753 $options = array( $options );
1757 if ( isset( $options['fileHandle'] ) ) {
1758 $fh = $options['fileHandle'];
1760 $options = $this->makeInsertOptions( $options );
1762 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
1764 $keys = array_keys( $a[0] );
1767 $keys = array_keys( $a );
1770 $sql = 'INSERT ' . $options .
1771 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
1775 foreach ( $a as $row ) {
1781 $sql .= '(' . $this->makeList( $row ) . ')';
1784 $sql .= '(' . $this->makeList( $a ) . ')';
1787 if ( $fh !== null && false === fwrite( $fh, $sql ) ) {
1789 } elseif ( $fh !== null ) {
1793 return (bool)$this->query( $sql, $fname );
1797 * Make UPDATE options for the DatabaseBase::update function
1799 * @param array $options The options passed to DatabaseBase::update
1802 protected function makeUpdateOptions( $options ) {
1803 if ( !is_array( $options ) ) {
1804 $options = array( $options );
1809 if ( in_array( 'LOW_PRIORITY', $options ) ) {
1810 $opts[] = $this->lowPriorityOption();
1813 if ( in_array( 'IGNORE', $options ) ) {
1817 return implode( ' ', $opts );
1821 * UPDATE wrapper. Takes a condition array and a SET array.
1823 * @param $table String name of the table to UPDATE. This will be passed through
1824 * DatabaseBase::tableName().
1826 * @param array $values An array of values to SET. For each array element,
1827 * the key gives the field name, and the value gives the data
1828 * to set that field to. The data will be quoted by
1829 * DatabaseBase::addQuotes().
1831 * @param $conds Array: An array of conditions (WHERE). See
1832 * DatabaseBase::select() for the details of the format of
1833 * condition arrays. Use '*' to update all rows.
1835 * @param $fname String: The function name of the caller (from __METHOD__),
1836 * for logging and profiling.
1838 * @param array $options An array of UPDATE options, can be:
1839 * - IGNORE: Ignore unique key conflicts
1840 * - LOW_PRIORITY: MySQL-specific, see MySQL manual.
1843 function update( $table, $values, $conds, $fname = __METHOD__
, $options = array() ) {
1844 $table = $this->tableName( $table );
1845 $opts = $this->makeUpdateOptions( $options );
1846 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, LIST_SET
);
1848 if ( $conds !== array() && $conds !== '*' ) {
1849 $sql .= " WHERE " . $this->makeList( $conds, LIST_AND
);
1852 return $this->query( $sql, $fname );
1856 * Makes an encoded list of strings from an array
1857 * @param array $a containing the data
1858 * @param int $mode Constant
1859 * - LIST_COMMA: comma separated, no field names
1860 * - LIST_AND: ANDed WHERE clause (without the WHERE). See
1861 * the documentation for $conds in DatabaseBase::select().
1862 * - LIST_OR: ORed WHERE clause (without the WHERE)
1863 * - LIST_SET: comma separated with field names, like a SET clause
1864 * - LIST_NAMES: comma separated field names
1866 * @throws MWException|DBUnexpectedError
1869 public function makeList( $a, $mode = LIST_COMMA
) {
1870 if ( !is_array( $a ) ) {
1871 throw new DBUnexpectedError( $this, 'DatabaseBase::makeList called with incorrect parameters' );
1877 foreach ( $a as $field => $value ) {
1879 if ( $mode == LIST_AND
) {
1881 } elseif ( $mode == LIST_OR
) {
1890 if ( ( $mode == LIST_AND ||
$mode == LIST_OR
) && is_numeric( $field ) ) {
1891 $list .= "($value)";
1892 } elseif ( ( $mode == LIST_SET
) && is_numeric( $field ) ) {
1894 } elseif ( ( $mode == LIST_AND ||
$mode == LIST_OR
) && is_array( $value ) ) {
1895 if ( count( $value ) == 0 ) {
1896 throw new MWException( __METHOD__
. ": empty input for field $field" );
1897 } elseif ( count( $value ) == 1 ) {
1898 // Special-case single values, as IN isn't terribly efficient
1899 // Don't necessarily assume the single key is 0; we don't
1900 // enforce linear numeric ordering on other arrays here.
1901 $value = array_values( $value );
1902 $list .= $field . " = " . $this->addQuotes( $value[0] );
1904 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
1906 } elseif ( $value === null ) {
1907 if ( $mode == LIST_AND ||
$mode == LIST_OR
) {
1908 $list .= "$field IS ";
1909 } elseif ( $mode == LIST_SET
) {
1910 $list .= "$field = ";
1914 if ( $mode == LIST_AND ||
$mode == LIST_OR ||
$mode == LIST_SET
) {
1915 $list .= "$field = ";
1917 $list .= $mode == LIST_NAMES ?
$value : $this->addQuotes( $value );
1925 * Build a partial where clause from a 2-d array such as used for LinkBatch.
1926 * The keys on each level may be either integers or strings.
1928 * @param array $data organized as 2-d
1929 * array(baseKeyVal => array(subKeyVal => [ignored], ...), ...)
1930 * @param string $baseKey field name to match the base-level keys to (eg 'pl_namespace')
1931 * @param string $subKey field name to match the sub-level keys to (eg 'pl_title')
1932 * @return Mixed: string SQL fragment, or false if no items in array.
1934 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
1937 foreach ( $data as $base => $sub ) {
1938 if ( count( $sub ) ) {
1939 $conds[] = $this->makeList(
1940 array( $baseKey => $base, $subKey => array_keys( $sub ) ),
1946 return $this->makeList( $conds, LIST_OR
);
1948 // Nothing to search for...
1954 * Return aggregated value alias
1957 * @param $valuename string
1961 public function aggregateValue( $valuedata, $valuename = 'value' ) {
1969 public function bitNot( $field ) {
1975 * @param $fieldRight
1978 public function bitAnd( $fieldLeft, $fieldRight ) {
1979 return "($fieldLeft & $fieldRight)";
1984 * @param $fieldRight
1987 public function bitOr( $fieldLeft, $fieldRight ) {
1988 return "($fieldLeft | $fieldRight)";
1992 * Build a concatenation list to feed into a SQL query
1993 * @param array $stringList list of raw SQL expressions; caller is responsible for any quoting
1996 public function buildConcat( $stringList ) {
1997 return 'CONCAT(' . implode( ',', $stringList ) . ')';
2001 * Change the current database
2003 * @todo Explain what exactly will fail if this is not overridden.
2007 * @return bool Success or failure
2009 public function selectDB( $db ) {
2010 # Stub. Shouldn't cause serious problems if it's not overridden, but
2011 # if your database engine supports a concept similar to MySQL's
2012 # databases you may as well.
2013 $this->mDBname
= $db;
2018 * Get the current DB name
2020 public function getDBname() {
2021 return $this->mDBname
;
2025 * Get the server hostname or IP address
2027 public function getServer() {
2028 return $this->mServer
;
2032 * Format a table name ready for use in constructing an SQL query
2034 * This does two important things: it quotes the table names to clean them up,
2035 * and it adds a table prefix if only given a table name with no quotes.
2037 * All functions of this object which require a table name call this function
2038 * themselves. Pass the canonical name to such functions. This is only needed
2039 * when calling query() directly.
2041 * @param string $name database table name
2042 * @param string $format One of:
2043 * quoted - Automatically pass the table name through addIdentifierQuotes()
2044 * so that it can be used in a query.
2045 * raw - Do not add identifier quotes to the table name
2046 * @return String: full database name
2048 public function tableName( $name, $format = 'quoted' ) {
2049 global $wgSharedDB, $wgSharedPrefix, $wgSharedTables;
2050 # Skip the entire process when we have a string quoted on both ends.
2051 # Note that we check the end so that we will still quote any use of
2052 # use of `database`.table. But won't break things if someone wants
2053 # to query a database table with a dot in the name.
2054 if ( $this->isQuotedIdentifier( $name ) ) {
2058 # Lets test for any bits of text that should never show up in a table
2059 # name. Basically anything like JOIN or ON which are actually part of
2060 # SQL queries, but may end up inside of the table value to combine
2061 # sql. Such as how the API is doing.
2062 # Note that we use a whitespace test rather than a \b test to avoid
2063 # any remote case where a word like on may be inside of a table name
2064 # surrounded by symbols which may be considered word breaks.
2065 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
2069 # Split database and table into proper variables.
2070 # We reverse the explode so that database.table and table both output
2071 # the correct table.
2072 $dbDetails = explode( '.', $name, 2 );
2073 if ( count( $dbDetails ) == 2 ) {
2074 list( $database, $table ) = $dbDetails;
2075 # We don't want any prefix added in this case
2078 list( $table ) = $dbDetails;
2079 if ( $wgSharedDB !== null # We have a shared database
2080 && $this->mForeign
== false # We're not working on a foreign database
2081 && !$this->isQuotedIdentifier( $table ) # Paranoia check to prevent shared tables listing '`table`'
2082 && in_array( $table, $wgSharedTables ) # A shared table is selected
2084 $database = $wgSharedDB;
2085 $prefix = $wgSharedPrefix === null ?
$this->mTablePrefix
: $wgSharedPrefix;
2088 $prefix = $this->mTablePrefix
; # Default prefix
2092 # Quote $table and apply the prefix if not quoted.
2093 $tableName = "{$prefix}{$table}";
2094 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $tableName ) ) {
2095 $tableName = $this->addIdentifierQuotes( $tableName );
2098 # Quote $database and merge it with the table name if needed
2099 if ( $database !== null ) {
2100 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $database ) ) {
2101 $database = $this->addIdentifierQuotes( $database );
2103 $tableName = $database . '.' . $tableName;
2110 * Fetch a number of table names into an array
2111 * This is handy when you need to construct SQL for joins
2114 * extract( $dbr->tableNames( 'user', 'watchlist' ) );
2115 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
2116 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
2120 public function tableNames() {
2121 $inArray = func_get_args();
2124 foreach ( $inArray as $name ) {
2125 $retVal[$name] = $this->tableName( $name );
2132 * Fetch a number of table names into an zero-indexed numerical array
2133 * This is handy when you need to construct SQL for joins
2136 * list( $user, $watchlist ) = $dbr->tableNamesN( 'user', 'watchlist' );
2137 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
2138 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
2142 public function tableNamesN() {
2143 $inArray = func_get_args();
2146 foreach ( $inArray as $name ) {
2147 $retVal[] = $this->tableName( $name );
2154 * Get an aliased table name
2155 * e.g. tableName AS newTableName
2157 * @param string $name Table name, see tableName()
2158 * @param string|bool $alias Alias (optional)
2159 * @return string SQL name for aliased table. Will not alias a table to its own name
2161 public function tableNameWithAlias( $name, $alias = false ) {
2162 if ( !$alias ||
$alias == $name ) {
2163 return $this->tableName( $name );
2165 return $this->tableName( $name ) . ' ' . $this->addIdentifierQuotes( $alias );
2170 * Gets an array of aliased table names
2172 * @param $tables array( [alias] => table )
2173 * @return array of strings, see tableNameWithAlias()
2175 public function tableNamesWithAlias( $tables ) {
2177 foreach ( $tables as $alias => $table ) {
2178 if ( is_numeric( $alias ) ) {
2181 $retval[] = $this->tableNameWithAlias( $table, $alias );
2187 * Get an aliased field name
2188 * e.g. fieldName AS newFieldName
2190 * @param string $name Field name
2191 * @param string|bool $alias Alias (optional)
2192 * @return string SQL name for aliased field. Will not alias a field to its own name
2194 public function fieldNameWithAlias( $name, $alias = false ) {
2195 if ( !$alias ||
(string)$alias === (string)$name ) {
2198 return $name . ' AS ' . $alias; //PostgreSQL needs AS
2203 * Gets an array of aliased field names
2205 * @param $fields array( [alias] => field )
2206 * @return array of strings, see fieldNameWithAlias()
2208 public function fieldNamesWithAlias( $fields ) {
2210 foreach ( $fields as $alias => $field ) {
2211 if ( is_numeric( $alias ) ) {
2214 $retval[] = $this->fieldNameWithAlias( $field, $alias );
2220 * Get the aliased table name clause for a FROM clause
2221 * which might have a JOIN and/or USE INDEX clause
2223 * @param array $tables ( [alias] => table )
2224 * @param $use_index array Same as for select()
2225 * @param $join_conds array Same as for select()
2228 protected function tableNamesWithUseIndexOrJOIN(
2229 $tables, $use_index = array(), $join_conds = array()
2233 $use_index = (array)$use_index;
2234 $join_conds = (array)$join_conds;
2236 foreach ( $tables as $alias => $table ) {
2237 if ( !is_string( $alias ) ) {
2238 // No alias? Set it equal to the table name
2241 // Is there a JOIN clause for this table?
2242 if ( isset( $join_conds[$alias] ) ) {
2243 list( $joinType, $conds ) = $join_conds[$alias];
2244 $tableClause = $joinType;
2245 $tableClause .= ' ' . $this->tableNameWithAlias( $table, $alias );
2246 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2247 $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2249 $tableClause .= ' ' . $use;
2252 $on = $this->makeList( (array)$conds, LIST_AND
);
2254 $tableClause .= ' ON (' . $on . ')';
2257 $retJOIN[] = $tableClause;
2258 // Is there an INDEX clause for this table?
2259 } elseif ( isset( $use_index[$alias] ) ) {
2260 $tableClause = $this->tableNameWithAlias( $table, $alias );
2261 $tableClause .= ' ' . $this->useIndexClause(
2262 implode( ',', (array)$use_index[$alias] ) );
2264 $ret[] = $tableClause;
2266 $tableClause = $this->tableNameWithAlias( $table, $alias );
2268 $ret[] = $tableClause;
2272 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2273 $implicitJoins = !empty( $ret ) ?
implode( ',', $ret ) : "";
2274 $explicitJoins = !empty( $retJOIN ) ?
implode( ' ', $retJOIN ) : "";
2276 // Compile our final table clause
2277 return implode( ' ', array( $implicitJoins, $explicitJoins ) );
2281 * Get the name of an index in a given table
2287 protected function indexName( $index ) {
2288 // Backwards-compatibility hack
2290 'ar_usertext_timestamp' => 'usertext_timestamp',
2291 'un_user_id' => 'user_id',
2292 'un_user_ip' => 'user_ip',
2295 if ( isset( $renamed[$index] ) ) {
2296 return $renamed[$index];
2303 * If it's a string, adds quotes and backslashes
2304 * Otherwise returns as-is
2310 public function addQuotes( $s ) {
2311 if ( $s === null ) {
2314 # This will also quote numeric values. This should be harmless,
2315 # and protects against weird problems that occur when they really
2316 # _are_ strings such as article titles and string->number->string
2317 # conversion is not 1:1.
2318 return "'" . $this->strencode( $s ) . "'";
2323 * Quotes an identifier using `backticks` or "double quotes" depending on the database type.
2324 * MySQL uses `backticks` while basically everything else uses double quotes.
2325 * Since MySQL is the odd one out here the double quotes are our generic
2326 * and we implement backticks in DatabaseMysql.
2332 public function addIdentifierQuotes( $s ) {
2333 return '"' . str_replace( '"', '""', $s ) . '"';
2337 * Returns if the given identifier looks quoted or not according to
2338 * the database convention for quoting identifiers .
2340 * @param $name string
2344 public function isQuotedIdentifier( $name ) {
2345 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2352 protected function escapeLikeInternal( $s ) {
2353 $s = str_replace( '\\', '\\\\', $s );
2354 $s = $this->strencode( $s );
2355 $s = str_replace( array( '%', '_' ), array( '\%', '\_' ), $s );
2361 * LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match
2362 * containing either string literals that will be escaped or tokens returned by anyChar() or anyString().
2363 * Alternatively, the function could be provided with an array of aforementioned parameters.
2365 * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches
2366 * for subpages of 'My page title'.
2367 * Alternatively: $pattern = array( 'My_page_title/', $dbr->anyString() ); $query .= $dbr->buildLike( $pattern );
2370 * @return String: fully built LIKE statement
2372 public function buildLike() {
2373 $params = func_get_args();
2375 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2376 $params = $params[0];
2381 foreach ( $params as $value ) {
2382 if ( $value instanceof LikeMatch
) {
2383 $s .= $value->toString();
2385 $s .= $this->escapeLikeInternal( $value );
2389 return " LIKE '" . $s . "' ";
2393 * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
2397 public function anyChar() {
2398 return new LikeMatch( '_' );
2402 * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
2406 public function anyString() {
2407 return new LikeMatch( '%' );
2411 * Returns an appropriately quoted sequence value for inserting a new row.
2412 * MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
2413 * subclass will return an integer, and save the value for insertId()
2415 * Any implementation of this function should *not* involve reusing
2416 * sequence numbers created for rolled-back transactions.
2417 * See http://bugs.mysql.com/bug.php?id=30767 for details.
2418 * @param $seqName string
2421 public function nextSequenceValue( $seqName ) {
2426 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2427 * is only needed because a) MySQL must be as efficient as possible due to
2428 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2429 * which index to pick. Anyway, other databases might have different
2430 * indexes on a given table. So don't bother overriding this unless you're
2435 public function useIndexClause( $index ) {
2440 * REPLACE query wrapper.
2442 * REPLACE is a very handy MySQL extension, which functions like an INSERT
2443 * except that when there is a duplicate key error, the old row is deleted
2444 * and the new row is inserted in its place.
2446 * We simulate this with standard SQL with a DELETE followed by INSERT. To
2447 * perform the delete, we need to know what the unique indexes are so that
2448 * we know how to find the conflicting rows.
2450 * It may be more efficient to leave off unique indexes which are unlikely
2451 * to collide. However if you do this, you run the risk of encountering
2452 * errors which wouldn't have occurred in MySQL.
2454 * @param string $table The table to replace the row(s) in.
2455 * @param array $rows Can be either a single row to insert, or multiple rows,
2456 * in the same format as for DatabaseBase::insert()
2457 * @param array $uniqueIndexes is an array of indexes. Each element may be either
2458 * a field name or an array of field names
2459 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
2461 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
2462 $quotedTable = $this->tableName( $table );
2464 if ( count( $rows ) == 0 ) {
2469 if ( !is_array( reset( $rows ) ) ) {
2470 $rows = array( $rows );
2473 foreach ( $rows as $row ) {
2474 # Delete rows which collide
2475 if ( $uniqueIndexes ) {
2476 $sql = "DELETE FROM $quotedTable WHERE ";
2478 foreach ( $uniqueIndexes as $index ) {
2485 if ( is_array( $index ) ) {
2487 foreach ( $index as $col ) {
2493 $sql .= $col . '=' . $this->addQuotes( $row[$col] );
2496 $sql .= $index . '=' . $this->addQuotes( $row[$index] );
2500 $this->query( $sql, $fname );
2503 # Now insert the row
2504 $this->insert( $table, $row, $fname );
2509 * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2512 * @param string $table Table name
2513 * @param array $rows Rows to insert
2514 * @param string $fname Caller function name
2516 * @return ResultWrapper
2518 protected function nativeReplace( $table, $rows, $fname ) {
2519 $table = $this->tableName( $table );
2522 if ( !is_array( reset( $rows ) ) ) {
2523 $rows = array( $rows );
2526 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2529 foreach ( $rows as $row ) {
2536 $sql .= '(' . $this->makeList( $row ) . ')';
2539 return $this->query( $sql, $fname );
2543 * INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
2545 * This updates any conflicting rows (according to the unique indexes) using
2546 * the provided SET clause and inserts any remaining (non-conflicted) rows.
2548 * $rows may be either:
2549 * - A single associative array. The array keys are the field names, and
2550 * the values are the values to insert. The values are treated as data
2551 * and will be quoted appropriately. If NULL is inserted, this will be
2552 * converted to a database NULL.
2553 * - An array with numeric keys, holding a list of associative arrays.
2554 * This causes a multi-row INSERT on DBMSs that support it. The keys in
2555 * each subarray must be identical to each other, and in the same order.
2557 * It may be more efficient to leave off unique indexes which are unlikely
2558 * to collide. However if you do this, you run the risk of encountering
2559 * errors which wouldn't have occurred in MySQL.
2561 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
2564 * @param string $table Table name. This will be passed through DatabaseBase::tableName().
2565 * @param array $rows A single row or list of rows to insert
2566 * @param array $uniqueIndexes List of single field names or field name tuples
2567 * @param array $set An array of values to SET. For each array element,
2568 * the key gives the field name, and the value gives the data
2569 * to set that field to. The data will be quoted by
2570 * DatabaseBase::addQuotes().
2571 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
2572 * @param array $options of options
2577 public function upsert(
2578 $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
2580 if ( !count( $rows ) ) {
2581 return true; // nothing to do
2583 $rows = is_array( reset( $rows ) ) ?
$rows : array( $rows );
2585 if ( count( $uniqueIndexes ) ) {
2586 $clauses = array(); // list WHERE clauses that each identify a single row
2587 foreach ( $rows as $row ) {
2588 foreach ( $uniqueIndexes as $index ) {
2589 $index = is_array( $index ) ?
$index : array( $index ); // columns
2590 $rowKey = array(); // unique key to this row
2591 foreach ( $index as $column ) {
2592 $rowKey[$column] = $row[$column];
2594 $clauses[] = $this->makeList( $rowKey, LIST_AND
);
2597 $where = array( $this->makeList( $clauses, LIST_OR
) );
2602 $useTrx = !$this->mTrxLevel
;
2604 $this->begin( $fname );
2607 # Update any existing conflicting row(s)
2608 if ( $where !== false ) {
2609 $ok = $this->update( $table, $set, $where, $fname );
2613 # Now insert any non-conflicting row(s)
2614 $ok = $this->insert( $table, $rows, $fname, array( 'IGNORE' ) ) && $ok;
2615 } catch ( Exception
$e ) {
2617 $this->rollback( $fname );
2622 $this->commit( $fname );
2629 * DELETE where the condition is a join.
2631 * MySQL overrides this to use a multi-table DELETE syntax, in other databases
2632 * we use sub-selects
2634 * For safety, an empty $conds will not delete everything. If you want to
2635 * delete all rows where the join condition matches, set $conds='*'.
2637 * DO NOT put the join condition in $conds.
2639 * @param $delTable String: The table to delete from.
2640 * @param $joinTable String: The other table.
2641 * @param $delVar String: The variable to join on, in the first table.
2642 * @param $joinVar String: The variable to join on, in the second table.
2643 * @param $conds Array: Condition array of field names mapped to variables,
2644 * ANDed together in the WHERE clause
2645 * @param $fname String: Calling function name (use __METHOD__) for
2647 * @throws DBUnexpectedError
2649 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2650 $fname = __METHOD__
)
2653 throw new DBUnexpectedError( $this,
2654 'DatabaseBase::deleteJoin() called with empty $conds' );
2657 $delTable = $this->tableName( $delTable );
2658 $joinTable = $this->tableName( $joinTable );
2659 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2660 if ( $conds != '*' ) {
2661 $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND
);
2665 $this->query( $sql, $fname );
2669 * Returns the size of a text field, or -1 for "unlimited"
2671 * @param $table string
2672 * @param $field string
2676 public function textFieldSize( $table, $field ) {
2677 $table = $this->tableName( $table );
2678 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2679 $res = $this->query( $sql, 'DatabaseBase::textFieldSize' );
2680 $row = $this->fetchObject( $res );
2684 if ( preg_match( '/\((.*)\)/', $row->Type
, $m ) ) {
2694 * A string to insert into queries to show that they're low-priority, like
2695 * MySQL's LOW_PRIORITY. If no such feature exists, return an empty
2696 * string and nothing bad should happen.
2698 * @return string Returns the text of the low priority option if it is
2699 * supported, or a blank string otherwise
2701 public function lowPriorityOption() {
2706 * DELETE query wrapper.
2708 * @param array $table Table name
2709 * @param string|array $conds of conditions. See $conds in DatabaseBase::select() for
2710 * the format. Use $conds == "*" to delete all rows
2711 * @param string $fname name of the calling function
2713 * @throws DBUnexpectedError
2714 * @return bool|ResultWrapper
2716 public function delete( $table, $conds, $fname = __METHOD__
) {
2718 throw new DBUnexpectedError( $this, 'DatabaseBase::delete() called with no conditions' );
2721 $table = $this->tableName( $table );
2722 $sql = "DELETE FROM $table";
2724 if ( $conds != '*' ) {
2725 if ( is_array( $conds ) ) {
2726 $conds = $this->makeList( $conds, LIST_AND
);
2728 $sql .= ' WHERE ' . $conds;
2731 return $this->query( $sql, $fname );
2735 * INSERT SELECT wrapper. Takes data from a SELECT query and inserts it
2736 * into another table.
2738 * @param string $destTable The table name to insert into
2739 * @param string|array $srcTable May be either a table name, or an array of table names
2740 * to include in a join.
2742 * @param array $varMap must be an associative array of the form
2743 * array( 'dest1' => 'source1', ...). Source items may be literals
2744 * rather than field names, but strings should be quoted with
2745 * DatabaseBase::addQuotes()
2747 * @param array $conds Condition array. See $conds in DatabaseBase::select() for
2748 * the details of the format of condition arrays. May be "*" to copy the
2751 * @param string $fname The function name of the caller, from __METHOD__
2753 * @param array $insertOptions Options for the INSERT part of the query, see
2754 * DatabaseBase::insert() for details.
2755 * @param array $selectOptions Options for the SELECT part of the query, see
2756 * DatabaseBase::select() for details.
2758 * @return ResultWrapper
2760 public function insertSelect( $destTable, $srcTable, $varMap, $conds,
2761 $fname = __METHOD__
,
2762 $insertOptions = array(), $selectOptions = array() )
2764 $destTable = $this->tableName( $destTable );
2766 if ( is_array( $insertOptions ) ) {
2767 $insertOptions = implode( ' ', $insertOptions );
2770 if ( !is_array( $selectOptions ) ) {
2771 $selectOptions = array( $selectOptions );
2774 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
2776 if ( is_array( $srcTable ) ) {
2777 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
2779 $srcTable = $this->tableName( $srcTable );
2782 $sql = "INSERT $insertOptions INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
2783 " SELECT $startOpts " . implode( ',', $varMap ) .
2784 " FROM $srcTable $useIndex ";
2786 if ( $conds != '*' ) {
2787 if ( is_array( $conds ) ) {
2788 $conds = $this->makeList( $conds, LIST_AND
);
2790 $sql .= " WHERE $conds";
2793 $sql .= " $tailOpts";
2795 return $this->query( $sql, $fname );
2799 * Construct a LIMIT query with optional offset. This is used for query
2800 * pages. The SQL should be adjusted so that only the first $limit rows
2801 * are returned. If $offset is provided as well, then the first $offset
2802 * rows should be discarded, and the next $limit rows should be returned.
2803 * If the result of the query is not ordered, then the rows to be returned
2804 * are theoretically arbitrary.
2806 * $sql is expected to be a SELECT, if that makes a difference.
2808 * The version provided by default works in MySQL and SQLite. It will very
2809 * likely need to be overridden for most other DBMSes.
2811 * @param string $sql SQL query we will append the limit too
2812 * @param $limit Integer the SQL limit
2813 * @param $offset Integer|bool the SQL offset (default false)
2815 * @throws DBUnexpectedError
2818 public function limitResult( $sql, $limit, $offset = false ) {
2819 if ( !is_numeric( $limit ) ) {
2820 throw new DBUnexpectedError( $this, "Invalid non-numeric limit passed to limitResult()\n" );
2822 return "$sql LIMIT "
2823 . ( ( is_numeric( $offset ) && $offset != 0 ) ?
"{$offset}," : "" )
2828 * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
2829 * within the UNION construct.
2832 public function unionSupportsOrderAndLimit() {
2833 return true; // True for almost every DB supported
2837 * Construct a UNION query
2838 * This is used for providing overload point for other DB abstractions
2839 * not compatible with the MySQL syntax.
2840 * @param array $sqls SQL statements to combine
2841 * @param $all Boolean: use UNION ALL
2842 * @return String: SQL fragment
2844 public function unionQueries( $sqls, $all ) {
2845 $glue = $all ?
') UNION ALL (' : ') UNION (';
2846 return '(' . implode( $glue, $sqls ) . ')';
2850 * Returns an SQL expression for a simple conditional. This doesn't need
2851 * to be overridden unless CASE isn't supported in your DBMS.
2853 * @param string|array $cond SQL expression which will result in a boolean value
2854 * @param string $trueVal SQL expression to return if true
2855 * @param string $falseVal SQL expression to return if false
2856 * @return String: SQL fragment
2858 public function conditional( $cond, $trueVal, $falseVal ) {
2859 if ( is_array( $cond ) ) {
2860 $cond = $this->makeList( $cond, LIST_AND
);
2862 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
2866 * Returns a comand for str_replace function in SQL query.
2867 * Uses REPLACE() in MySQL
2869 * @param string $orig column to modify
2870 * @param string $old column to seek
2871 * @param string $new column to replace with
2875 public function strreplace( $orig, $old, $new ) {
2876 return "REPLACE({$orig}, {$old}, {$new})";
2880 * Determines how long the server has been up
2885 public function getServerUptime() {
2890 * Determines if the last failure was due to a deadlock
2895 public function wasDeadlock() {
2900 * Determines if the last failure was due to a lock timeout
2905 public function wasLockTimeout() {
2910 * Determines if the last query error was something that should be dealt
2911 * with by pinging the connection and reissuing the query.
2916 public function wasErrorReissuable() {
2921 * Determines if the last failure was due to the database being read-only.
2926 public function wasReadOnlyError() {
2931 * Perform a deadlock-prone transaction.
2933 * This function invokes a callback function to perform a set of write
2934 * queries. If a deadlock occurs during the processing, the transaction
2935 * will be rolled back and the callback function will be called again.
2938 * $dbw->deadlockLoop( callback, ... );
2940 * Extra arguments are passed through to the specified callback function.
2942 * Returns whatever the callback function returned on its successful,
2943 * iteration, or false on error, for example if the retry limit was
2948 public function deadlockLoop() {
2949 $this->begin( __METHOD__
);
2950 $args = func_get_args();
2951 $function = array_shift( $args );
2952 $oldIgnore = $this->ignoreErrors( true );
2953 $tries = self
::DEADLOCK_TRIES
;
2955 if ( is_array( $function ) ) {
2956 $fname = $function[0];
2962 $retVal = call_user_func_array( $function, $args );
2963 $error = $this->lastError();
2964 $errno = $this->lastErrno();
2965 $sql = $this->lastQuery();
2968 if ( $this->wasDeadlock() ) {
2970 usleep( mt_rand( self
::DEADLOCK_DELAY_MIN
, self
::DEADLOCK_DELAY_MAX
) );
2972 $this->reportQueryError( $error, $errno, $sql, $fname );
2975 } while ( $this->wasDeadlock() && --$tries > 0 );
2977 $this->ignoreErrors( $oldIgnore );
2979 if ( $tries <= 0 ) {
2980 $this->rollback( __METHOD__
);
2981 $this->reportQueryError( $error, $errno, $sql, $fname );
2984 $this->commit( __METHOD__
);
2990 * Wait for the slave to catch up to a given master position.
2992 * @param $pos DBMasterPos object
2993 * @param $timeout Integer: the maximum number of seconds to wait for
2996 * @return integer: zero if the slave was past that position already,
2997 * greater than zero if we waited for some period of time, less than
2998 * zero if we timed out.
3000 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
3001 wfProfileIn( __METHOD__
);
3003 if ( !is_null( $this->mFakeSlaveLag
) ) {
3004 $wait = intval( ( $pos->pos
- microtime( true ) +
$this->mFakeSlaveLag
) * 1e6
);
3006 if ( $wait > $timeout * 1e6
) {
3007 wfDebug( "Fake slave timed out waiting for $pos ($wait us)\n" );
3008 wfProfileOut( __METHOD__
);
3010 } elseif ( $wait > 0 ) {
3011 wfDebug( "Fake slave waiting $wait us\n" );
3013 wfProfileOut( __METHOD__
);
3016 wfDebug( "Fake slave up to date ($wait us)\n" );
3017 wfProfileOut( __METHOD__
);
3022 wfProfileOut( __METHOD__
);
3024 # Real waits are implemented in the subclass.
3029 * Get the replication position of this slave
3031 * @return DBMasterPos, or false if this is not a slave.
3033 public function getSlavePos() {
3034 if ( !is_null( $this->mFakeSlaveLag
) ) {
3035 $pos = new MySQLMasterPos( 'fake', microtime( true ) - $this->mFakeSlaveLag
);
3036 wfDebug( __METHOD__
. ": fake slave pos = $pos\n" );
3045 * Get the position of this master
3047 * @return DBMasterPos, or false if this is not a master
3049 public function getMasterPos() {
3050 if ( $this->mFakeMaster
) {
3051 return new MySQLMasterPos( 'fake', microtime( true ) );
3058 * Run an anonymous function as soon as there is no transaction pending.
3059 * If there is a transaction and it is rolled back, then the callback is cancelled.
3060 * Queries in the function will run in AUTO-COMMIT mode unless there are begin() calls.
3061 * Callbacks must commit any transactions that they begin.
3063 * This is useful for updates to different systems or when separate transactions are needed.
3064 * For example, one might want to enqueue jobs into a system outside the database, but only
3065 * after the database is updated so that the jobs will see the data when they actually run.
3066 * It can also be used for updates that easily cause deadlocks if locks are held too long.
3068 * @param callable $callback
3071 final public function onTransactionIdle( $callback ) {
3072 $this->mTrxIdleCallbacks
[] = $callback;
3073 if ( !$this->mTrxLevel
) {
3074 $this->runOnTransactionIdleCallbacks();
3079 * Run an anonymous function before the current transaction commits or now if there is none.
3080 * If there is a transaction and it is rolled back, then the callback is cancelled.
3081 * Callbacks must not start nor commit any transactions.
3083 * This is useful for updates that easily cause deadlocks if locks are held too long
3084 * but where atomicity is strongly desired for these updates and some related updates.
3086 * @param callable $callback
3089 final public function onTransactionPreCommitOrIdle( $callback ) {
3090 if ( $this->mTrxLevel
) {
3091 $this->mTrxPreCommitCallbacks
[] = $callback;
3093 $this->onTransactionIdle( $callback ); // this will trigger immediately
3098 * Actually any "on transaction idle" callbacks.
3102 protected function runOnTransactionIdleCallbacks() {
3103 $autoTrx = $this->getFlag( DBO_TRX
); // automatic begin() enabled?
3105 $e = null; // last exception
3106 do { // callbacks may add callbacks :)
3107 $callbacks = $this->mTrxIdleCallbacks
;
3108 $this->mTrxIdleCallbacks
= array(); // recursion guard
3109 foreach ( $callbacks as $callback ) {
3111 $this->clearFlag( DBO_TRX
); // make each query its own transaction
3112 call_user_func( $callback );
3113 $this->setFlag( $autoTrx ? DBO_TRX
: 0 ); // restore automatic begin()
3114 } catch ( Exception
$e ) {}
3116 } while ( count( $this->mTrxIdleCallbacks
) );
3118 if ( $e instanceof Exception
) {
3119 throw $e; // re-throw any last exception
3124 * Actually any "on transaction pre-commit" callbacks.
3128 protected function runOnTransactionPreCommitCallbacks() {
3129 $e = null; // last exception
3130 do { // callbacks may add callbacks :)
3131 $callbacks = $this->mTrxPreCommitCallbacks
;
3132 $this->mTrxPreCommitCallbacks
= array(); // recursion guard
3133 foreach ( $callbacks as $callback ) {
3135 call_user_func( $callback );
3136 } catch ( Exception
$e ) {}
3138 } while ( count( $this->mTrxPreCommitCallbacks
) );
3140 if ( $e instanceof Exception
) {
3141 throw $e; // re-throw any last exception
3146 * Begin a transaction. If a transaction is already in progress, that transaction will be committed before the
3147 * new transaction is started.
3149 * Note that when the DBO_TRX flag is set (which is usually the case for web requests, but not for maintenance scripts),
3150 * any previous database query will have started a transaction automatically.
3152 * Nesting of transactions is not supported. Attempts to nest transactions will cause a warning, unless the current
3153 * transaction was started automatically because of the DBO_TRX flag.
3155 * @param $fname string
3157 final public function begin( $fname = __METHOD__
) {
3158 global $wgDebugDBTransactions;
3160 if ( $this->mTrxLevel
) { // implicit commit
3161 if ( !$this->mTrxAutomatic
) {
3162 // We want to warn about inadvertently nested begin/commit pairs, but not about
3163 // auto-committing implicit transactions that were started by query() via DBO_TRX
3164 $msg = "$fname: Transaction already in progress (from {$this->mTrxFname}), " .
3165 " performing implicit commit!";
3167 wfLogDBError( $msg );
3169 // if the transaction was automatic and has done write operations,
3170 // log it if $wgDebugDBTransactions is enabled.
3171 if ( $this->mTrxDoneWrites
&& $wgDebugDBTransactions ) {
3172 wfDebug( "$fname: Automatic transaction with writes in progress" .
3173 " (from {$this->mTrxFname}), performing implicit commit!\n"
3178 $this->runOnTransactionPreCommitCallbacks();
3179 $this->doCommit( $fname );
3180 if ( $this->mTrxDoneWrites
) {
3181 Profiler
::instance()->transactionWritingOut( $this->mServer
, $this->mDBname
);
3183 $this->runOnTransactionIdleCallbacks();
3186 $this->doBegin( $fname );
3187 $this->mTrxFname
= $fname;
3188 $this->mTrxDoneWrites
= false;
3189 $this->mTrxAutomatic
= false;
3193 * Issues the BEGIN command to the database server.
3195 * @see DatabaseBase::begin()
3196 * @param type $fname
3198 protected function doBegin( $fname ) {
3199 $this->query( 'BEGIN', $fname );
3200 $this->mTrxLevel
= 1;
3204 * Commits a transaction previously started using begin().
3205 * If no transaction is in progress, a warning is issued.
3207 * Nesting of transactions is not supported.
3209 * @param $fname string
3210 * @param string $flush Flush flag, set to 'flush' to disable warnings about explicitly committing implicit
3211 * transactions, or calling commit when no transaction is in progress.
3212 * This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure
3213 * that it is safe to ignore these warnings in your context.
3215 final public function commit( $fname = __METHOD__
, $flush = '' ) {
3216 if ( $flush != 'flush' ) {
3217 if ( !$this->mTrxLevel
) {
3218 wfWarn( "$fname: No transaction to commit, something got out of sync!" );
3219 } elseif ( $this->mTrxAutomatic
) {
3220 wfWarn( "$fname: Explicit commit of implicit transaction. Something may be out of sync!" );
3223 if ( !$this->mTrxLevel
) {
3224 return; // nothing to do
3225 } elseif ( !$this->mTrxAutomatic
) {
3226 wfWarn( "$fname: Flushing an explicit transaction, getting out of sync!" );
3230 $this->runOnTransactionPreCommitCallbacks();
3231 $this->doCommit( $fname );
3232 if ( $this->mTrxDoneWrites
) {
3233 Profiler
::instance()->transactionWritingOut( $this->mServer
, $this->mDBname
);
3235 $this->runOnTransactionIdleCallbacks();
3239 * Issues the COMMIT command to the database server.
3241 * @see DatabaseBase::commit()
3242 * @param type $fname
3244 protected function doCommit( $fname ) {
3245 if ( $this->mTrxLevel
) {
3246 $this->query( 'COMMIT', $fname );
3247 $this->mTrxLevel
= 0;
3252 * Rollback a transaction previously started using begin().
3253 * If no transaction is in progress, a warning is issued.
3255 * No-op on non-transactional databases.
3257 * @param $fname string
3259 final public function rollback( $fname = __METHOD__
) {
3260 if ( !$this->mTrxLevel
) {
3261 wfWarn( "$fname: No transaction to rollback, something got out of sync!" );
3263 $this->doRollback( $fname );
3264 $this->mTrxIdleCallbacks
= array(); // cancel
3265 $this->mTrxPreCommitCallbacks
= array(); // cancel
3266 if ( $this->mTrxDoneWrites
) {
3267 Profiler
::instance()->transactionWritingOut( $this->mServer
, $this->mDBname
);
3272 * Issues the ROLLBACK command to the database server.
3274 * @see DatabaseBase::rollback()
3275 * @param type $fname
3277 protected function doRollback( $fname ) {
3278 if ( $this->mTrxLevel
) {
3279 $this->query( 'ROLLBACK', $fname, true );
3280 $this->mTrxLevel
= 0;
3285 * Creates a new table with structure copied from existing table
3286 * Note that unlike most database abstraction functions, this function does not
3287 * automatically append database prefix, because it works at a lower
3288 * abstraction level.
3289 * The table names passed to this function shall not be quoted (this
3290 * function calls addIdentifierQuotes when needed).
3292 * @param string $oldName name of table whose structure should be copied
3293 * @param string $newName name of table to be created
3294 * @param $temporary Boolean: whether the new table should be temporary
3295 * @param string $fname calling function name
3296 * @throws MWException
3297 * @return Boolean: true if operation was successful
3299 public function duplicateTableStructure( $oldName, $newName, $temporary = false,
3302 throw new MWException(
3303 'DatabaseBase::duplicateTableStructure is not implemented in descendant class' );
3307 * List all tables on the database
3309 * @param string $prefix Only show tables with this prefix, e.g. mw_
3310 * @param string $fname calling function name
3311 * @throws MWException
3313 function listTables( $prefix = null, $fname = __METHOD__
) {
3314 throw new MWException( 'DatabaseBase::listTables is not implemented in descendant class' );
3318 * Convert a timestamp in one of the formats accepted by wfTimestamp()
3319 * to the format used for inserting into timestamp fields in this DBMS.
3321 * The result is unquoted, and needs to be passed through addQuotes()
3322 * before it can be included in raw SQL.
3324 * @param $ts string|int
3328 public function timestamp( $ts = 0 ) {
3329 return wfTimestamp( TS_MW
, $ts );
3333 * Convert a timestamp in one of the formats accepted by wfTimestamp()
3334 * to the format used for inserting into timestamp fields in this DBMS. If
3335 * NULL is input, it is passed through, allowing NULL values to be inserted
3336 * into timestamp fields.
3338 * The result is unquoted, and needs to be passed through addQuotes()
3339 * before it can be included in raw SQL.
3341 * @param $ts string|int
3345 public function timestampOrNull( $ts = null ) {
3346 if ( is_null( $ts ) ) {
3349 return $this->timestamp( $ts );
3354 * Take the result from a query, and wrap it in a ResultWrapper if
3355 * necessary. Boolean values are passed through as is, to indicate success
3356 * of write queries or failure.
3358 * Once upon a time, DatabaseBase::query() returned a bare MySQL result
3359 * resource, and it was necessary to call this function to convert it to
3360 * a wrapper. Nowadays, raw database objects are never exposed to external
3361 * callers, so this is unnecessary in external code. For compatibility with
3362 * old code, ResultWrapper objects are passed through unaltered.
3364 * @param $result bool|ResultWrapper
3366 * @return bool|ResultWrapper
3368 public function resultObject( $result ) {
3369 if ( empty( $result ) ) {
3371 } elseif ( $result instanceof ResultWrapper
) {
3373 } elseif ( $result === true ) {
3374 // Successful write query
3377 return new ResultWrapper( $this, $result );
3382 * Ping the server and try to reconnect if it there is no connection
3384 * @return bool Success or failure
3386 public function ping() {
3387 # Stub. Not essential to override.
3392 * Get slave lag. Currently supported only by MySQL.
3394 * Note that this function will generate a fatal error on many
3395 * installations. Most callers should use LoadBalancer::safeGetLag()
3398 * @return int Database replication lag in seconds
3400 public function getLag() {
3401 return intval( $this->mFakeSlaveLag
);
3405 * Return the maximum number of items allowed in a list, or 0 for unlimited.
3409 function maxListLen() {
3414 * Some DBMSs have a special format for inserting into blob fields, they
3415 * don't allow simple quoted strings to be inserted. To insert into such
3416 * a field, pass the data through this function before passing it to
3417 * DatabaseBase::insert().
3421 public function encodeBlob( $b ) {
3426 * Some DBMSs return a special placeholder object representing blob fields
3427 * in result objects. Pass the object through this function to return the
3432 public function decodeBlob( $b ) {
3437 * Override database's default behavior. $options include:
3438 * 'connTimeout' : Set the connection timeout value in seconds.
3439 * May be useful for very long batch queries such as
3440 * full-wiki dumps, where a single query reads out over
3443 * @param $options Array
3446 public function setSessionOptions( array $options ) {
3450 * Read and execute SQL commands from a file.
3452 * Returns true on success, error string or exception on failure (depending
3453 * on object's error ignore settings).
3455 * @param string $filename File name to open
3456 * @param bool|callable $lineCallback Optional function called before reading each line
3457 * @param bool|callable $resultCallback Optional function called for each MySQL result
3458 * @param bool|string $fname Calling function name or false if name should be
3459 * generated dynamically using $filename
3460 * @param bool|callable $inputCallback Callback: Optional function called for each complete line sent
3461 * @throws MWException
3462 * @throws Exception|MWException
3463 * @return bool|string
3465 public function sourceFile(
3466 $filename, $lineCallback = false, $resultCallback = false, $fname = false, $inputCallback = false
3468 wfSuppressWarnings();
3469 $fp = fopen( $filename, 'r' );
3470 wfRestoreWarnings();
3472 if ( false === $fp ) {
3473 throw new MWException( "Could not open \"{$filename}\".\n" );
3477 $fname = __METHOD__
. "( $filename )";
3481 $error = $this->sourceStream( $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
3483 catch ( MWException
$e ) {
3494 * Get the full path of a patch file. Originally based on archive()
3495 * from updaters.inc. Keep in mind this always returns a patch, as
3496 * it fails back to MySQL if no DB-specific patch can be found
3498 * @param string $patch The name of the patch, like patch-something.sql
3499 * @return String Full path to patch file
3501 public function patchPath( $patch ) {
3504 $dbType = $this->getType();
3505 if ( file_exists( "$IP/maintenance/$dbType/archives/$patch" ) ) {
3506 return "$IP/maintenance/$dbType/archives/$patch";
3508 return "$IP/maintenance/archives/$patch";
3513 * Set variables to be used in sourceFile/sourceStream, in preference to the
3514 * ones in $GLOBALS. If an array is set here, $GLOBALS will not be used at
3515 * all. If it's set to false, $GLOBALS will be used.
3517 * @param bool|array $vars mapping variable name to value.
3519 public function setSchemaVars( $vars ) {
3520 $this->mSchemaVars
= $vars;
3524 * Read and execute commands from an open file handle.
3526 * Returns true on success, error string or exception on failure (depending
3527 * on object's error ignore settings).
3529 * @param $fp Resource: File handle
3530 * @param $lineCallback Callback: Optional function called before reading each query
3531 * @param $resultCallback Callback: Optional function called for each MySQL result
3532 * @param string $fname Calling function name
3533 * @param $inputCallback Callback: Optional function called for each complete query sent
3534 * @return bool|string
3536 public function sourceStream( $fp, $lineCallback = false, $resultCallback = false,
3537 $fname = __METHOD__
, $inputCallback = false )
3541 while ( !feof( $fp ) ) {
3542 if ( $lineCallback ) {
3543 call_user_func( $lineCallback );
3546 $line = trim( fgets( $fp ) );
3548 if ( $line == '' ) {
3552 if ( '-' == $line[0] && '-' == $line[1] ) {
3560 $done = $this->streamStatementEnd( $cmd, $line );
3564 if ( $done ||
feof( $fp ) ) {
3565 $cmd = $this->replaceVars( $cmd );
3567 if ( ( $inputCallback && call_user_func( $inputCallback, $cmd ) ) ||
!$inputCallback ) {
3568 $res = $this->query( $cmd, $fname );
3570 if ( $resultCallback ) {
3571 call_user_func( $resultCallback, $res, $this );
3574 if ( false === $res ) {
3575 $err = $this->lastError();
3576 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
3587 * Called by sourceStream() to check if we've reached a statement end
3589 * @param string $sql SQL assembled so far
3590 * @param string $newLine New line about to be added to $sql
3591 * @return Bool Whether $newLine contains end of the statement
3593 public function streamStatementEnd( &$sql, &$newLine ) {
3594 if ( $this->delimiter
) {
3596 $newLine = preg_replace( '/' . preg_quote( $this->delimiter
, '/' ) . '$/', '', $newLine );
3597 if ( $newLine != $prev ) {
3605 * Database independent variable replacement. Replaces a set of variables
3606 * in an SQL statement with their contents as given by $this->getSchemaVars().
3608 * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
3610 * - '{$var}' should be used for text and is passed through the database's
3612 * - `{$var}` should be used for identifiers (eg: table and database names),
3613 * it is passed through the database's addIdentifierQuotes method which
3614 * can be overridden if the database uses something other than backticks.
3615 * - / *$var* / is just encoded, besides traditional table prefix and
3616 * table options its use should be avoided.
3618 * @param string $ins SQL statement to replace variables in
3619 * @return String The new SQL statement with variables replaced
3621 protected function replaceSchemaVars( $ins ) {
3622 $vars = $this->getSchemaVars();
3623 foreach ( $vars as $var => $value ) {
3625 $ins = str_replace( '\'{$' . $var . '}\'', $this->addQuotes( $value ), $ins );
3627 $ins = str_replace( '`{$' . $var . '}`', $this->addIdentifierQuotes( $value ), $ins );
3629 $ins = str_replace( '/*$' . $var . '*/', $this->strencode( $value ), $ins );
3635 * Replace variables in sourced SQL
3637 * @param $ins string
3641 protected function replaceVars( $ins ) {
3642 $ins = $this->replaceSchemaVars( $ins );
3645 $ins = preg_replace_callback( '!/\*(?:\$wgDBprefix|_)\*/([a-zA-Z_0-9]*)!',
3646 array( $this, 'tableNameCallback' ), $ins );
3649 $ins = preg_replace_callback( '!/\*i\*/([a-zA-Z_0-9]*)!',
3650 array( $this, 'indexNameCallback' ), $ins );
3656 * Get schema variables. If none have been set via setSchemaVars(), then
3657 * use some defaults from the current object.
3661 protected function getSchemaVars() {
3662 if ( $this->mSchemaVars
) {
3663 return $this->mSchemaVars
;
3665 return $this->getDefaultSchemaVars();
3670 * Get schema variables to use if none have been set via setSchemaVars().
3672 * Override this in derived classes to provide variables for tables.sql
3673 * and SQL patch files.
3677 protected function getDefaultSchemaVars() {
3682 * Table name callback
3684 * @param $matches array
3688 protected function tableNameCallback( $matches ) {
3689 return $this->tableName( $matches[1] );
3693 * Index name callback
3695 * @param $matches array
3699 protected function indexNameCallback( $matches ) {
3700 return $this->indexName( $matches[1] );
3704 * Check to see if a named lock is available. This is non-blocking.
3706 * @param string $lockName name of lock to poll
3707 * @param string $method name of method calling us
3711 public function lockIsFree( $lockName, $method ) {
3716 * Acquire a named lock
3718 * Abstracted from Filestore::lock() so child classes can implement for
3721 * @param string $lockName name of lock to aquire
3722 * @param string $method name of method calling us
3723 * @param $timeout Integer: timeout
3726 public function lock( $lockName, $method, $timeout = 5 ) {
3733 * @param string $lockName Name of lock to release
3734 * @param string $method Name of method calling us
3736 * @return int Returns 1 if the lock was released, 0 if the lock was not established
3737 * by this thread (in which case the lock is not released), and NULL if the named
3738 * lock did not exist
3740 public function unlock( $lockName, $method ) {
3745 * Lock specific tables
3747 * @param array $read of tables to lock for read access
3748 * @param array $write of tables to lock for write access
3749 * @param string $method name of caller
3750 * @param bool $lowPriority Whether to indicate writes to be LOW PRIORITY
3754 public function lockTables( $read, $write, $method, $lowPriority = true ) {
3759 * Unlock specific tables
3761 * @param string $method the caller
3765 public function unlockTables( $method ) {
3771 * @param $tableName string
3772 * @param $fName string
3773 * @return bool|ResultWrapper
3776 public function dropTable( $tableName, $fName = __METHOD__
) {
3777 if ( !$this->tableExists( $tableName, $fName ) ) {
3780 $sql = "DROP TABLE " . $this->tableName( $tableName );
3781 if ( $this->cascadingDeletes() ) {
3784 return $this->query( $sql, $fName );
3788 * Get search engine class. All subclasses of this need to implement this
3789 * if they wish to use searching.
3793 public function getSearchEngine() {
3794 return 'SearchEngineDummy';
3798 * Find out when 'infinity' is. Most DBMSes support this. This is a special
3799 * keyword for timestamps in PostgreSQL, and works with CHAR(14) as well
3800 * because "i" sorts after all numbers.
3804 public function getInfinity() {
3809 * Encode an expiry time into the DBMS dependent format
3811 * @param string $expiry timestamp for expiry, or the 'infinity' string
3814 public function encodeExpiry( $expiry ) {
3815 return ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() )
3816 ?
$this->getInfinity()
3817 : $this->timestamp( $expiry );
3821 * Decode an expiry time into a DBMS independent format
3823 * @param string $expiry DB timestamp field value for expiry
3824 * @param $format integer: TS_* constant, defaults to TS_MW
3827 public function decodeExpiry( $expiry, $format = TS_MW
) {
3828 return ( $expiry == '' ||
$expiry == $this->getInfinity() )
3830 : wfTimestamp( $format, $expiry );
3834 * Allow or deny "big selects" for this session only. This is done by setting
3835 * the sql_big_selects session variable.
3837 * This is a MySQL-specific feature.
3839 * @param $value Mixed: true for allow, false for deny, or "default" to
3840 * restore the initial value
3842 public function setBigSelects( $value = true ) {
3849 public function __toString() {
3850 return (string)$this->mConn
;
3853 public function __destruct() {
3854 if ( count( $this->mTrxIdleCallbacks
) ||
count( $this->mTrxPreCommitCallbacks
) ) {
3855 trigger_error( "Transaction idle or pre-commit callbacks still pending." ); // sanity