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;
245 protected $mTrxLevel = 0;
246 protected $mErrorCount = 0;
247 protected $mLBInfo = array();
248 protected $mFakeSlaveLag = null, $mFakeMaster = false;
249 protected $mDefaultBigSelects = null;
250 protected $mSchemaVars = false;
252 protected $preparedArgs;
254 protected $htmlErrors;
256 protected $delimiter = ';';
259 * Remembers the function name given for starting the most recent transaction via begin().
260 * Used to provide additional context for error reporting.
263 * @see DatabaseBase::mTrxLevel
265 private $mTrxFname = null;
268 * Record if possible write queries were done in the last transaction started
271 * @see DatabaseBase::mTrxLevel
273 private $mTrxDoneWrites = false;
276 * Record if the current transaction was started implicitly due to DBO_TRX being set.
279 * @see DatabaseBase::mTrxLevel
281 private $mTrxAutomatic = false;
285 * @var file handle for upgrade
287 protected $fileHandle = null;
289 # ------------------------------------------------------------------------------
291 # ------------------------------------------------------------------------------
292 # These optionally set a variable and return the previous state
295 * A string describing the current software version, and possibly
296 * other details in a user-friendly way. Will be listed on Special:Version, etc.
297 * Use getServerVersion() to get machine-friendly information.
299 * @return string: Version information from the database server
301 public function getServerInfo() {
302 return $this->getServerVersion();
306 * @return string: command delimiter used by this database engine
308 public function getDelimiter() {
309 return $this->delimiter
;
313 * Boolean, controls output of large amounts of debug information.
314 * @param $debug bool|null
315 * - true to enable debugging
316 * - false to disable debugging
317 * - omitted or null to do nothing
319 * @return bool|null previous value of the flag
321 public function debug( $debug = null ) {
322 return wfSetBit( $this->mFlags
, DBO_DEBUG
, $debug );
326 * Turns buffering of SQL result sets on (true) or off (false). Default is
329 * Unbuffered queries are very troublesome in MySQL:
331 * - If another query is executed while the first query is being read
332 * out, the first query is killed. This means you can't call normal
333 * MediaWiki functions while you are reading an unbuffered query result
334 * from a normal wfGetDB() connection.
336 * - Unbuffered queries cause the MySQL server to use large amounts of
337 * memory and to hold broad locks which block other queries.
339 * If you want to limit client-side memory, it's almost always better to
340 * split up queries into batches using a LIMIT clause than to switch off
343 * @param $buffer null|bool
345 * @return null|bool The previous value of the flag
347 public function bufferResults( $buffer = null ) {
348 if ( is_null( $buffer ) ) {
349 return !(bool)( $this->mFlags
& DBO_NOBUFFER
);
351 return !wfSetBit( $this->mFlags
, DBO_NOBUFFER
, !$buffer );
356 * Turns on (false) or off (true) the automatic generation and sending
357 * of a "we're sorry, but there has been a database error" page on
358 * database errors. Default is on (false). When turned off, the
359 * code should use lastErrno() and lastError() to handle the
360 * situation as appropriate.
362 * @param $ignoreErrors bool|null
364 * @return bool The previous value of the flag.
366 public function ignoreErrors( $ignoreErrors = null ) {
367 return wfSetBit( $this->mFlags
, DBO_IGNORE
, $ignoreErrors );
371 * Gets or sets the current transaction level.
373 * Historically, transactions were allowed to be "nested". This is no
374 * longer supported, so this function really only returns a boolean.
376 * @param int $level An integer (0 or 1), or omitted to leave it unchanged.
377 * @return int The previous value
379 public function trxLevel( $level = null ) {
380 return wfSetVar( $this->mTrxLevel
, $level );
384 * Get/set the number of errors logged. Only useful when errors are ignored
385 * @param int $count The count to set, or omitted to leave it unchanged.
386 * @return int The error count
388 public function errorCount( $count = null ) {
389 return wfSetVar( $this->mErrorCount
, $count );
393 * Get/set the table prefix.
394 * @param string $prefix The table prefix to set, or omitted to leave it unchanged.
395 * @return string The previous table prefix.
397 public function tablePrefix( $prefix = null ) {
398 return wfSetVar( $this->mTablePrefix
, $prefix );
402 * Set the filehandle to copy write statements to.
404 * @param $fh filehandle
406 public function setFileHandle( $fh ) {
407 $this->fileHandle
= $fh;
411 * Get properties passed down from the server info array of the load
414 * @param string $name The entry of the info array to get, or null to get the
417 * @return LoadBalancer|null
419 public function getLBInfo( $name = null ) {
420 if ( is_null( $name ) ) {
421 return $this->mLBInfo
;
423 if ( array_key_exists( $name, $this->mLBInfo
) ) {
424 return $this->mLBInfo
[$name];
432 * Set the LB info array, or a member of it. If called with one parameter,
433 * the LB info array is set to that parameter. If it is called with two
434 * parameters, the member with the given name is set to the given value.
439 public function setLBInfo( $name, $value = null ) {
440 if ( is_null( $value ) ) {
441 $this->mLBInfo
= $name;
443 $this->mLBInfo
[$name] = $value;
448 * Set lag time in seconds for a fake slave
452 public function setFakeSlaveLag( $lag ) {
453 $this->mFakeSlaveLag
= $lag;
457 * Make this connection a fake master
459 * @param $enabled bool
461 public function setFakeMaster( $enabled = true ) {
462 $this->mFakeMaster
= $enabled;
466 * Returns true if this database supports (and uses) cascading deletes
470 public function cascadingDeletes() {
475 * Returns true if this database supports (and uses) triggers (e.g. on the page table)
479 public function cleanupTriggers() {
484 * Returns true if this database is strict about what can be put into an IP field.
485 * Specifically, it uses a NULL value instead of an empty string.
489 public function strictIPs() {
494 * Returns true if this database uses timestamps rather than integers
498 public function realTimestamps() {
503 * Returns true if this database does an implicit sort when doing GROUP BY
507 public function implicitGroupby() {
512 * Returns true if this database does an implicit order by when the column has an index
513 * For example: SELECT page_title FROM page LIMIT 1
517 public function implicitOrderby() {
522 * Returns true if this database can do a native search on IP columns
523 * e.g. this works as expected: .. WHERE rc_ip = '127.42.12.102/32';
527 public function searchableIPs() {
532 * Returns true if this database can use functional indexes
536 public function functionalIndexes() {
541 * Return the last query that went through DatabaseBase::query()
544 public function lastQuery() {
545 return $this->mLastQuery
;
549 * Returns true if the connection may have been used for write queries.
550 * Should return true if unsure.
554 public function doneWrites() {
555 return $this->mDoneWrites
;
559 * Returns true if there is a transaction open with possible write
560 * queries or transaction pre-commit/idle callbacks waiting on it to finish.
564 public function writesOrCallbacksPending() {
565 return $this->mTrxLevel
&& (
566 $this->mTrxDoneWrites ||
$this->mTrxIdleCallbacks ||
$this->mTrxPreCommitCallbacks
571 * Is a connection to the database open?
574 public function isOpen() {
575 return $this->mOpened
;
579 * Set a flag for this connection
581 * @param $flag Integer: DBO_* constants from Defines.php:
582 * - DBO_DEBUG: output some debug info (same as debug())
583 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
584 * - DBO_IGNORE: ignore errors (same as ignoreErrors())
585 * - DBO_TRX: automatically start transactions
586 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
587 * and removes it in command line mode
588 * - DBO_PERSISTENT: use persistant database connection
590 public function setFlag( $flag ) {
591 global $wgDebugDBTransactions;
592 $this->mFlags |
= $flag;
593 if ( ( $flag & DBO_TRX
) & $wgDebugDBTransactions ) {
594 wfDebug( "Implicit transactions are now disabled.\n" );
599 * Clear a flag for this connection
601 * @param $flag: same as setFlag()'s $flag param
603 public function clearFlag( $flag ) {
604 global $wgDebugDBTransactions;
605 $this->mFlags
&= ~
$flag;
606 if ( ( $flag & DBO_TRX
) && $wgDebugDBTransactions ) {
607 wfDebug( "Implicit transactions are now disabled.\n" );
612 * Returns a boolean whether the flag $flag is set for this connection
614 * @param $flag: same as setFlag()'s $flag param
617 public function getFlag( $flag ) {
618 return !!( $this->mFlags
& $flag );
622 * General read-only accessor
624 * @param $name string
628 public function getProperty( $name ) {
635 public function getWikiID() {
636 if ( $this->mTablePrefix
) {
637 return "{$this->mDBname}-{$this->mTablePrefix}";
639 return $this->mDBname
;
644 * Return a path to the DBMS-specific schema file, otherwise default to tables.sql
648 public function getSchemaPath() {
650 if ( file_exists( "$IP/maintenance/" . $this->getType() . "/tables.sql" ) ) {
651 return "$IP/maintenance/" . $this->getType() . "/tables.sql";
653 return "$IP/maintenance/tables.sql";
657 # ------------------------------------------------------------------------------
659 # ------------------------------------------------------------------------------
663 * @param string $server database server host
664 * @param string $user database user name
665 * @param string $password database user password
666 * @param string $dbName database name
668 * @param string $tablePrefix database table prefixes. By default use the prefix gave in LocalSettings.php
670 function __construct( $server = false, $user = false, $password = false, $dbName = false,
671 $flags = 0, $tablePrefix = 'get from global'
673 global $wgDBprefix, $wgCommandLineMode, $wgDebugDBTransactions;
675 $this->mFlags
= $flags;
677 if ( $this->mFlags
& DBO_DEFAULT
) {
678 if ( $wgCommandLineMode ) {
679 $this->mFlags
&= ~DBO_TRX
;
680 if ( $wgDebugDBTransactions ) {
681 wfDebug( "Implicit transaction open disabled.\n" );
684 $this->mFlags |
= DBO_TRX
;
685 if ( $wgDebugDBTransactions ) {
686 wfDebug( "Implicit transaction open enabled.\n" );
691 /** Get the default table prefix*/
692 if ( $tablePrefix == 'get from global' ) {
693 $this->mTablePrefix
= $wgDBprefix;
695 $this->mTablePrefix
= $tablePrefix;
699 $this->open( $server, $user, $password, $dbName );
704 * Called by serialize. Throw an exception when DB connection is serialized.
705 * This causes problems on some database engines because the connection is
706 * not restored on unserialize.
708 public function __sleep() {
709 throw new MWException( 'Database serialization may cause problems, since the connection is not restored on wakeup.' );
713 * Given a DB type, construct the name of the appropriate child class of
714 * DatabaseBase. This is designed to replace all of the manual stuff like:
715 * $class = 'Database' . ucfirst( strtolower( $type ) );
716 * as well as validate against the canonical list of DB types we have
718 * This factory function is mostly useful for when you need to connect to a
719 * database other than the MediaWiki default (such as for external auth,
720 * an extension, et cetera). Do not use this to connect to the MediaWiki
721 * database. Example uses in core:
722 * @see LoadBalancer::reallyOpenConnection()
723 * @see ForeignDBRepo::getMasterDB()
724 * @see WebInstaller_DBConnect::execute()
728 * @param string $dbType A possible DB type
729 * @param array $p An array of options to pass to the constructor.
730 * Valid options are: host, user, password, dbname, flags, tablePrefix
731 * @return DatabaseBase subclass or null
733 final public static function factory( $dbType, $p = array() ) {
734 $canonicalDBTypes = array(
735 'mysql', 'postgres', 'sqlite', 'oracle', 'mssql'
737 $dbType = strtolower( $dbType );
738 $class = 'Database' . ucfirst( $dbType );
740 if ( in_array( $dbType, $canonicalDBTypes ) ||
( class_exists( $class ) && is_subclass_of( $class, 'DatabaseBase' ) ) ) {
742 isset( $p['host'] ) ?
$p['host'] : false,
743 isset( $p['user'] ) ?
$p['user'] : false,
744 isset( $p['password'] ) ?
$p['password'] : false,
745 isset( $p['dbname'] ) ?
$p['dbname'] : false,
746 isset( $p['flags'] ) ?
$p['flags'] : 0,
747 isset( $p['tablePrefix'] ) ?
$p['tablePrefix'] : 'get from global'
754 protected function installErrorHandler() {
755 $this->mPHPError
= false;
756 $this->htmlErrors
= ini_set( 'html_errors', '0' );
757 set_error_handler( array( $this, 'connectionErrorHandler' ) );
761 * @return bool|string
763 protected function restoreErrorHandler() {
764 restore_error_handler();
765 if ( $this->htmlErrors
!== false ) {
766 ini_set( 'html_errors', $this->htmlErrors
);
768 if ( $this->mPHPError
) {
769 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->mPHPError
);
770 $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
782 public function connectionErrorHandler( $errno, $errstr ) {
783 $this->mPHPError
= $errstr;
787 * Closes a database connection.
788 * if it is open : commits any open transactions
790 * @throws MWException
791 * @return Bool operation success. true if already closed.
793 public function close() {
794 if ( count( $this->mTrxIdleCallbacks
) ) { // sanity
795 throw new MWException( "Transaction idle callbacks still pending." );
797 $this->mOpened
= false;
798 if ( $this->mConn
) {
799 if ( $this->trxLevel() ) {
800 if ( !$this->mTrxAutomatic
) {
801 wfWarn( "Transaction still in progress (from {$this->mTrxFname}), " .
802 " performing implicit commit before closing connection!" );
805 $this->commit( __METHOD__
, 'flush' );
808 $ret = $this->closeConnection();
809 $this->mConn
= false;
817 * Closes underlying database connection
819 * @return bool: Whether connection was closed successfully
821 abstract protected function closeConnection();
824 * @param string $error fallback error message, used if none is given by DB
825 * @throws DBConnectionError
827 function reportConnectionError( $error = 'Unknown error' ) {
828 $myError = $this->lastError();
834 throw new DBConnectionError( $this, $error );
838 * The DBMS-dependent part of query()
840 * @param $sql String: SQL query.
841 * @return ResultWrapper Result object to feed to fetchObject, fetchRow, ...; or false on failure
843 abstract protected function doQuery( $sql );
846 * Determine whether a query writes to the DB.
847 * Should return true if unsure.
853 public function isWriteQuery( $sql ) {
854 return !preg_match( '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SET|SHOW|EXPLAIN|\(SELECT)\b/i', $sql );
858 * Run an SQL query and return the result. Normally throws a DBQueryError
859 * on failure. If errors are ignored, returns false instead.
861 * In new code, the query wrappers select(), insert(), update(), delete(),
862 * etc. should be used where possible, since they give much better DBMS
863 * independence and automatically quote or validate user input in a variety
864 * of contexts. This function is generally only useful for queries which are
865 * explicitly DBMS-dependent and are unsupported by the query wrappers, such
868 * However, the query wrappers themselves should call this function.
870 * @param $sql String: SQL query
871 * @param $fname String: Name of the calling function, for profiling/SHOW PROCESSLIST
872 * comment (you can use __METHOD__ or add some extra info)
873 * @param $tempIgnore Boolean: Whether to avoid throwing an exception on errors...
874 * maybe best to catch the exception instead?
875 * @throws MWException
876 * @return boolean|ResultWrapper. true for a successful write query, ResultWrapper object
877 * for a successful read query, or false on failure if $tempIgnore set
879 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false ) {
880 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
881 if ( !Profiler
::instance()->isStub() ) {
882 # generalizeSQL will probably cut down the query to reasonable
883 # logging size most of the time. The substr is really just a sanity check.
886 $queryProf = 'query-m: ' . substr( DatabaseBase
::generalizeSQL( $sql ), 0, 255 );
887 $totalProf = 'DatabaseBase::query-master';
889 $queryProf = 'query: ' . substr( DatabaseBase
::generalizeSQL( $sql ), 0, 255 );
890 $totalProf = 'DatabaseBase::query';
893 wfProfileIn( $totalProf );
894 wfProfileIn( $queryProf );
897 $this->mLastQuery
= $sql;
898 if ( !$this->mDoneWrites
&& $this->isWriteQuery( $sql ) ) {
899 # Set a flag indicating that writes have been done
900 wfDebug( __METHOD__
. ": Writes done: $sql\n" );
901 $this->mDoneWrites
= true;
904 # Add a comment for easy SHOW PROCESSLIST interpretation
906 if ( is_object( $wgUser ) && $wgUser->isItemLoaded( 'name' ) ) {
907 $userName = $wgUser->getName();
908 if ( mb_strlen( $userName ) > 15 ) {
909 $userName = mb_substr( $userName, 0, 15 ) . '...';
911 $userName = str_replace( '/', '', $userName );
916 // Add trace comment to the begin of the sql string, right after the operator.
917 // Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (bug 42598)
918 $commentedSql = preg_replace( '/\s|$/', " /* $fname $userName */ ", $sql, 1 );
920 # If DBO_TRX is set, start a transaction
921 if ( ( $this->mFlags
& DBO_TRX
) && !$this->mTrxLevel
&&
922 $sql != 'BEGIN' && $sql != 'COMMIT' && $sql != 'ROLLBACK' )
924 # Avoid establishing transactions for SHOW and SET statements too -
925 # that would delay transaction initializations to once connection
926 # is really used by application
927 $sqlstart = substr( $sql, 0, 10 ); // very much worth it, benchmark certified(tm)
928 if ( strpos( $sqlstart, "SHOW " ) !== 0 && strpos( $sqlstart, "SET " ) !== 0 ) {
929 global $wgDebugDBTransactions;
930 if ( $wgDebugDBTransactions ) {
931 wfDebug( "Implicit transaction start.\n" );
933 $this->begin( __METHOD__
. " ($fname)" );
934 $this->mTrxAutomatic
= true;
938 # Keep track of whether the transaction has write queries pending
939 if ( $this->mTrxLevel
&& !$this->mTrxDoneWrites
&& $this->isWriteQuery( $sql ) ) {
940 $this->mTrxDoneWrites
= true;
943 if ( $this->debug() ) {
947 $sqlx = substr( $commentedSql, 0, 500 );
948 $sqlx = strtr( $sqlx, "\t\n", ' ' );
950 $master = $isMaster ?
'master' : 'slave';
951 wfDebug( "Query {$this->mDBname} ($cnt) ($master): $sqlx\n" );
954 $queryId = MWDebug
::query( $sql, $fname, $isMaster );
956 # Do the query and handle errors
957 $ret = $this->doQuery( $commentedSql );
959 MWDebug
::queryTime( $queryId );
961 # Try reconnecting if the connection was lost
962 if ( false === $ret && $this->wasErrorReissuable() ) {
963 # Transaction is gone, like it or not
964 $this->mTrxLevel
= 0;
965 $this->mTrxIdleCallbacks
= array(); // cancel
966 $this->mTrxPreCommitCallbacks
= array(); // cancel
967 wfDebug( "Connection lost, reconnecting...\n" );
969 if ( $this->ping() ) {
970 wfDebug( "Reconnected\n" );
971 $sqlx = substr( $commentedSql, 0, 500 );
972 $sqlx = strtr( $sqlx, "\t\n", ' ' );
973 global $wgRequestTime;
974 $elapsed = round( microtime( true ) - $wgRequestTime, 3 );
975 if ( $elapsed < 300 ) {
976 # Not a database error to lose a transaction after a minute or two
977 wfLogDBError( "Connection lost and reconnected after {$elapsed}s, query: $sqlx\n" );
979 $ret = $this->doQuery( $commentedSql );
981 wfDebug( "Failed\n" );
985 if ( false === $ret ) {
986 $this->reportQueryError( $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
989 if ( !Profiler
::instance()->isStub() ) {
990 wfProfileOut( $queryProf );
991 wfProfileOut( $totalProf );
994 return $this->resultObject( $ret );
998 * Report a query error. Log the error, and if neither the object ignore
999 * flag nor the $tempIgnore flag is set, throw a DBQueryError.
1001 * @param $error String
1002 * @param $errno Integer
1003 * @param $sql String
1004 * @param $fname String
1005 * @param $tempIgnore Boolean
1006 * @throws DBQueryError
1008 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1009 # Ignore errors during error handling to avoid infinite recursion
1010 $ignore = $this->ignoreErrors( true );
1011 ++
$this->mErrorCount
;
1013 if ( $ignore ||
$tempIgnore ) {
1014 wfDebug( "SQL ERROR (ignored): $error\n" );
1015 $this->ignoreErrors( $ignore );
1017 $sql1line = str_replace( "\n", "\\n", $sql );
1018 wfLogDBError( "$fname\t{$this->mServer}\t$errno\t$error\t$sql1line\n" );
1019 wfDebug( "SQL ERROR: " . $error . "\n" );
1020 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
1025 * Intended to be compatible with the PEAR::DB wrapper functions.
1026 * http://pear.php.net/manual/en/package.database.db.intro-execute.php
1028 * ? = scalar value, quoted as necessary
1029 * ! = raw SQL bit (a function for instance)
1030 * & = filename; reads the file and inserts as a blob
1031 * (we don't use this though...)
1033 * @param $sql string
1034 * @param $func string
1038 protected function prepare( $sql, $func = 'DatabaseBase::prepare' ) {
1039 /* MySQL doesn't support prepared statements (yet), so just
1040 pack up the query for reference. We'll manually replace
1042 return array( 'query' => $sql, 'func' => $func );
1046 * Free a prepared query, generated by prepare().
1049 protected function freePrepared( $prepared ) {
1050 /* No-op by default */
1054 * Execute a prepared query with the various arguments
1055 * @param string $prepared the prepared sql
1056 * @param $args Mixed: Either an array here, or put scalars as varargs
1058 * @return ResultWrapper
1060 public function execute( $prepared, $args = null ) {
1061 if ( !is_array( $args ) ) {
1063 $args = func_get_args();
1064 array_shift( $args );
1067 $sql = $this->fillPrepared( $prepared['query'], $args );
1069 return $this->query( $sql, $prepared['func'] );
1073 * For faking prepared SQL statements on DBs that don't support it directly.
1075 * @param string $preparedQuery a 'preparable' SQL statement
1076 * @param array $args of arguments to fill it with
1077 * @return string executable SQL
1079 public function fillPrepared( $preparedQuery, $args ) {
1081 $this->preparedArgs
=& $args;
1083 return preg_replace_callback( '/(\\\\[?!&]|[?!&])/',
1084 array( &$this, 'fillPreparedArg' ), $preparedQuery );
1088 * preg_callback func for fillPrepared()
1089 * The arguments should be in $this->preparedArgs and must not be touched
1090 * while we're doing this.
1092 * @param $matches Array
1093 * @throws DBUnexpectedError
1096 protected function fillPreparedArg( $matches ) {
1097 switch ( $matches[1] ) {
1106 list( /* $n */, $arg ) = each( $this->preparedArgs
);
1108 switch ( $matches[1] ) {
1110 return $this->addQuotes( $arg );
1114 # return $this->addQuotes( file_get_contents( $arg ) );
1115 throw new DBUnexpectedError( $this, '& mode is not implemented. If it\'s really needed, uncomment the line above.' );
1117 throw new DBUnexpectedError( $this, 'Received invalid match. This should never happen!' );
1122 * Free a result object returned by query() or select(). It's usually not
1123 * necessary to call this, just use unset() or let the variable holding
1124 * the result object go out of scope.
1126 * @param $res Mixed: A SQL result
1128 public function freeResult( $res ) {
1132 * A SELECT wrapper which returns a single field from a single result row.
1134 * Usually throws a DBQueryError on failure. If errors are explicitly
1135 * ignored, returns false on failure.
1137 * If no result rows are returned from the query, false is returned.
1139 * @param string|array $table Table name. See DatabaseBase::select() for details.
1140 * @param string $var The field name to select. This must be a valid SQL
1141 * fragment: do not use unvalidated user input.
1142 * @param string|array $cond The condition array. See DatabaseBase::select() for details.
1143 * @param string $fname The function name of the caller.
1144 * @param string|array $options The query options. See DatabaseBase::select() for details.
1146 * @return bool|mixed The value from the field, or false on failure.
1148 public function selectField( $table, $var, $cond = '', $fname = __METHOD__
,
1151 if ( !is_array( $options ) ) {
1152 $options = array( $options );
1155 $options['LIMIT'] = 1;
1157 $res = $this->select( $table, $var, $cond, $fname, $options );
1159 if ( $res === false ||
!$this->numRows( $res ) ) {
1163 $row = $this->fetchRow( $res );
1165 if ( $row !== false ) {
1166 return reset( $row );
1173 * Returns an optional USE INDEX clause to go after the table, and a
1174 * string to go at the end of the query.
1176 * @param array $options associative array of options to be turned into
1177 * an SQL query, valid keys are listed in the function.
1179 * @see DatabaseBase::select()
1181 public function makeSelectOptions( $options ) {
1182 $preLimitTail = $postLimitTail = '';
1185 $noKeyOptions = array();
1187 foreach ( $options as $key => $option ) {
1188 if ( is_numeric( $key ) ) {
1189 $noKeyOptions[$option] = true;
1193 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1195 $preLimitTail .= $this->makeOrderBy( $options );
1197 // if (isset($options['LIMIT'])) {
1198 // $tailOpts .= $this->limitResult('', $options['LIMIT'],
1199 // isset($options['OFFSET']) ? $options['OFFSET']
1203 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1204 $postLimitTail .= ' FOR UPDATE';
1207 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1208 $postLimitTail .= ' LOCK IN SHARE MODE';
1211 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) {
1212 $startOpts .= 'DISTINCT';
1215 # Various MySQL extensions
1216 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1217 $startOpts .= ' /*! STRAIGHT_JOIN */';
1220 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1221 $startOpts .= ' HIGH_PRIORITY';
1224 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1225 $startOpts .= ' SQL_BIG_RESULT';
1228 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1229 $startOpts .= ' SQL_BUFFER_RESULT';
1232 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1233 $startOpts .= ' SQL_SMALL_RESULT';
1236 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1237 $startOpts .= ' SQL_CALC_FOUND_ROWS';
1240 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1241 $startOpts .= ' SQL_CACHE';
1244 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1245 $startOpts .= ' SQL_NO_CACHE';
1248 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1249 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1254 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1258 * Returns an optional GROUP BY with an optional HAVING
1260 * @param array $options associative array of options
1262 * @see DatabaseBase::select()
1265 public function makeGroupByWithHaving( $options ) {
1267 if ( isset( $options['GROUP BY'] ) ) {
1268 $gb = is_array( $options['GROUP BY'] )
1269 ?
implode( ',', $options['GROUP BY'] )
1270 : $options['GROUP BY'];
1271 $sql .= ' GROUP BY ' . $gb;
1273 if ( isset( $options['HAVING'] ) ) {
1274 $having = is_array( $options['HAVING'] )
1275 ?
$this->makeList( $options['HAVING'], LIST_AND
)
1276 : $options['HAVING'];
1277 $sql .= ' HAVING ' . $having;
1283 * Returns an optional ORDER BY
1285 * @param array $options associative array of options
1287 * @see DatabaseBase::select()
1290 public function makeOrderBy( $options ) {
1291 if ( isset( $options['ORDER BY'] ) ) {
1292 $ob = is_array( $options['ORDER BY'] )
1293 ?
implode( ',', $options['ORDER BY'] )
1294 : $options['ORDER BY'];
1295 return ' ORDER BY ' . $ob;
1301 * Execute a SELECT query constructed using the various parameters provided.
1302 * See below for full details of the parameters.
1304 * @param string|array $table Table name
1305 * @param string|array $vars Field names
1306 * @param string|array $conds Conditions
1307 * @param string $fname Caller function name
1308 * @param array $options Query options
1309 * @param $join_conds Array Join conditions
1311 * @param $table string|array
1313 * May be either an array of table names, or a single string holding a table
1314 * name. If an array is given, table aliases can be specified, for example:
1316 * array( 'a' => 'user' )
1318 * This includes the user table in the query, with the alias "a" available
1319 * for use in field names (e.g. a.user_name).
1321 * All of the table names given here are automatically run through
1322 * DatabaseBase::tableName(), which causes the table prefix (if any) to be
1323 * added, and various other table name mappings to be performed.
1326 * @param $vars string|array
1328 * May be either a field name or an array of field names. The field names
1329 * can be complete fragments of SQL, for direct inclusion into the SELECT
1330 * query. If an array is given, field aliases can be specified, for example:
1332 * array( 'maxrev' => 'MAX(rev_id)' )
1334 * This includes an expression with the alias "maxrev" in the query.
1336 * If an expression is given, care must be taken to ensure that it is
1340 * @param $conds string|array
1342 * May be either a string containing a single condition, or an array of
1343 * conditions. If an array is given, the conditions constructed from each
1344 * element are combined with AND.
1346 * Array elements may take one of two forms:
1348 * - Elements with a numeric key are interpreted as raw SQL fragments.
1349 * - Elements with a string key are interpreted as equality conditions,
1350 * where the key is the field name.
1351 * - If the value of such an array element is a scalar (such as a
1352 * string), it will be treated as data and thus quoted appropriately.
1353 * If it is null, an IS NULL clause will be added.
1354 * - If the value is an array, an IN(...) clause will be constructed,
1355 * such that the field name may match any of the elements in the
1356 * array. The elements of the array will be quoted.
1358 * Note that expressions are often DBMS-dependent in their syntax.
1359 * DBMS-independent wrappers are provided for constructing several types of
1360 * expression commonly used in condition queries. See:
1361 * - DatabaseBase::buildLike()
1362 * - DatabaseBase::conditional()
1365 * @param $options string|array
1367 * Optional: Array of query options. Boolean options are specified by
1368 * including them in the array as a string value with a numeric key, for
1371 * array( 'FOR UPDATE' )
1373 * The supported options are:
1375 * - OFFSET: Skip this many rows at the start of the result set. OFFSET
1376 * with LIMIT can theoretically be used for paging through a result set,
1377 * but this is discouraged in MediaWiki for performance reasons.
1379 * - LIMIT: Integer: return at most this many rows. The rows are sorted
1380 * and then the first rows are taken until the limit is reached. LIMIT
1381 * is applied to a result set after OFFSET.
1383 * - FOR UPDATE: Boolean: lock the returned rows so that they can't be
1384 * changed until the next COMMIT.
1386 * - DISTINCT: Boolean: return only unique result rows.
1388 * - GROUP BY: May be either an SQL fragment string naming a field or
1389 * expression to group by, or an array of such SQL fragments.
1391 * - HAVING: May be either an string containing a HAVING clause or an array of
1392 * conditions building the HAVING clause. If an array is given, the conditions
1393 * constructed from each element are combined with AND.
1395 * - ORDER BY: May be either an SQL fragment giving a field name or
1396 * expression to order by, or an array of such SQL fragments.
1398 * - USE INDEX: This may be either a string giving the index name to use
1399 * for the query, or an array. If it is an associative array, each key
1400 * gives the table name (or alias), each value gives the index name to
1401 * use for that table. All strings are SQL fragments and so should be
1402 * validated by the caller.
1404 * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run,
1405 * instead of SELECT.
1407 * And also the following boolean MySQL extensions, see the MySQL manual
1408 * for documentation:
1410 * - LOCK IN SHARE MODE
1414 * - SQL_BUFFER_RESULT
1415 * - SQL_SMALL_RESULT
1416 * - SQL_CALC_FOUND_ROWS
1421 * @param $join_conds string|array
1423 * Optional associative array of table-specific join conditions. In the
1424 * most common case, this is unnecessary, since the join condition can be
1425 * in $conds. However, it is useful for doing a LEFT JOIN.
1427 * The key of the array contains the table name or alias. The value is an
1428 * array with two elements, numbered 0 and 1. The first gives the type of
1429 * join, the second is an SQL fragment giving the join condition for that
1430 * table. For example:
1432 * array( 'page' => array( 'LEFT JOIN', 'page_latest=rev_id' ) )
1434 * @return ResultWrapper. If the query returned no rows, a ResultWrapper
1435 * with no rows in it will be returned. If there was a query error, a
1436 * DBQueryError exception will be thrown, except if the "ignore errors"
1437 * option was set, in which case false will be returned.
1439 public function select( $table, $vars, $conds = '', $fname = __METHOD__
,
1440 $options = array(), $join_conds = array() ) {
1441 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1443 return $this->query( $sql, $fname );
1447 * The equivalent of DatabaseBase::select() except that the constructed SQL
1448 * is returned, instead of being immediately executed. This can be useful for
1449 * doing UNION queries, where the SQL text of each query is needed. In general,
1450 * however, callers outside of Database classes should just use select().
1452 * @param string|array $table Table name
1453 * @param string|array $vars Field names
1454 * @param string|array $conds Conditions
1455 * @param string $fname Caller function name
1456 * @param string|array $options Query options
1457 * @param $join_conds string|array Join conditions
1459 * @return string SQL query string.
1460 * @see DatabaseBase::select()
1462 public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__
,
1463 $options = array(), $join_conds = array() )
1465 if ( is_array( $vars ) ) {
1466 $vars = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1469 $options = (array)$options;
1470 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1471 ?
$options['USE INDEX']
1474 if ( is_array( $table ) ) {
1476 $this->tableNamesWithUseIndexOrJOIN( $table, $useIndexes, $join_conds );
1477 } elseif ( $table != '' ) {
1478 if ( $table[0] == ' ' ) {
1479 $from = ' FROM ' . $table;
1482 $this->tableNamesWithUseIndexOrJOIN( array( $table ), $useIndexes, array() );
1488 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail ) =
1489 $this->makeSelectOptions( $options );
1491 if ( !empty( $conds ) ) {
1492 if ( is_array( $conds ) ) {
1493 $conds = $this->makeList( $conds, LIST_AND
);
1495 $sql = "SELECT $startOpts $vars $from $useIndex WHERE $conds $preLimitTail";
1497 $sql = "SELECT $startOpts $vars $from $useIndex $preLimitTail";
1500 if ( isset( $options['LIMIT'] ) ) {
1501 $sql = $this->limitResult( $sql, $options['LIMIT'],
1502 isset( $options['OFFSET'] ) ?
$options['OFFSET'] : false );
1504 $sql = "$sql $postLimitTail";
1506 if ( isset( $options['EXPLAIN'] ) ) {
1507 $sql = 'EXPLAIN ' . $sql;
1514 * Single row SELECT wrapper. Equivalent to DatabaseBase::select(), except
1515 * that a single row object is returned. If the query returns no rows,
1516 * false is returned.
1518 * @param string|array $table Table name
1519 * @param string|array $vars Field names
1520 * @param array $conds Conditions
1521 * @param string $fname Caller function name
1522 * @param string|array $options Query options
1523 * @param $join_conds array|string Join conditions
1525 * @return object|bool
1527 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
1528 $options = array(), $join_conds = array() )
1530 $options = (array)$options;
1531 $options['LIMIT'] = 1;
1532 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1534 if ( $res === false ) {
1538 if ( !$this->numRows( $res ) ) {
1542 $obj = $this->fetchObject( $res );
1548 * Estimate rows in dataset.
1550 * MySQL allows you to estimate the number of rows that would be returned
1551 * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using
1552 * index cardinality statistics, and is notoriously inaccurate, especially
1553 * when large numbers of rows have recently been added or deleted.
1555 * For DBMSs that don't support fast result size estimation, this function
1556 * will actually perform the SELECT COUNT(*).
1558 * Takes the same arguments as DatabaseBase::select().
1560 * @param string $table table name
1561 * @param array|string $vars : unused
1562 * @param array|string $conds : filters on the table
1563 * @param string $fname function name for profiling
1564 * @param array $options options for select
1565 * @return Integer: row count
1567 public function estimateRowCount( $table, $vars = '*', $conds = '',
1568 $fname = __METHOD__
, $options = array() )
1571 $res = $this->select( $table, array( 'rowcount' => 'COUNT(*)' ), $conds, $fname, $options );
1574 $row = $this->fetchRow( $res );
1575 $rows = ( isset( $row['rowcount'] ) ) ?
$row['rowcount'] : 0;
1582 * Removes most variables from an SQL query and replaces them with X or N for numbers.
1583 * It's only slightly flawed. Don't use for anything important.
1585 * @param string $sql A SQL Query
1589 static function generalizeSQL( $sql ) {
1590 # This does the same as the regexp below would do, but in such a way
1591 # as to avoid crashing php on some large strings.
1592 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
1594 $sql = str_replace( "\\\\", '', $sql );
1595 $sql = str_replace( "\\'", '', $sql );
1596 $sql = str_replace( "\\\"", '', $sql );
1597 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
1598 $sql = preg_replace( '/".*"/s', "'X'", $sql );
1600 # All newlines, tabs, etc replaced by single space
1601 $sql = preg_replace( '/\s+/', ' ', $sql );
1604 $sql = preg_replace( '/-?[0-9]+/s', 'N', $sql );
1610 * Determines whether a field exists in a table
1612 * @param string $table table name
1613 * @param string $field filed to check on that table
1614 * @param string $fname calling function name (optional)
1615 * @return Boolean: whether $table has filed $field
1617 public function fieldExists( $table, $field, $fname = __METHOD__
) {
1618 $info = $this->fieldInfo( $table, $field );
1624 * Determines whether an index exists
1625 * Usually throws a DBQueryError on failure
1626 * If errors are explicitly ignored, returns NULL on failure
1630 * @param $fname string
1634 public function indexExists( $table, $index, $fname = __METHOD__
) {
1635 if ( !$this->tableExists( $table ) ) {
1639 $info = $this->indexInfo( $table, $index, $fname );
1640 if ( is_null( $info ) ) {
1643 return $info !== false;
1648 * Query whether a given table exists
1650 * @param $table string
1651 * @param $fname string
1655 public function tableExists( $table, $fname = __METHOD__
) {
1656 $table = $this->tableName( $table );
1657 $old = $this->ignoreErrors( true );
1658 $res = $this->query( "SELECT 1 FROM $table LIMIT 1", $fname );
1659 $this->ignoreErrors( $old );
1665 * mysql_field_type() wrapper
1670 public function fieldType( $res, $index ) {
1671 if ( $res instanceof ResultWrapper
) {
1672 $res = $res->result
;
1675 return mysql_field_type( $res, $index );
1679 * Determines if a given index is unique
1681 * @param $table string
1682 * @param $index string
1686 public function indexUnique( $table, $index ) {
1687 $indexInfo = $this->indexInfo( $table, $index );
1689 if ( !$indexInfo ) {
1693 return !$indexInfo[0]->Non_unique
;
1697 * Helper for DatabaseBase::insert().
1699 * @param $options array
1702 protected function makeInsertOptions( $options ) {
1703 return implode( ' ', $options );
1707 * INSERT wrapper, inserts an array into a table.
1711 * - A single associative array. The array keys are the field names, and
1712 * the values are the values to insert. The values are treated as data
1713 * and will be quoted appropriately. If NULL is inserted, this will be
1714 * converted to a database NULL.
1715 * - An array with numeric keys, holding a list of associative arrays.
1716 * This causes a multi-row INSERT on DBMSs that support it. The keys in
1717 * each subarray must be identical to each other, and in the same order.
1719 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
1722 * $options is an array of options, with boolean options encoded as values
1723 * with numeric keys, in the same style as $options in
1724 * DatabaseBase::select(). Supported options are:
1726 * - IGNORE: Boolean: if present, duplicate key errors are ignored, and
1727 * any rows which cause duplicate key errors are not inserted. It's
1728 * possible to determine how many rows were successfully inserted using
1729 * DatabaseBase::affectedRows().
1731 * @param $table String Table name. This will be passed through
1732 * DatabaseBase::tableName().
1733 * @param $a Array of rows to insert
1734 * @param $fname String Calling function name (use __METHOD__) for logs/profiling
1735 * @param array $options of options
1739 public function insert( $table, $a, $fname = __METHOD__
, $options = array() ) {
1740 # No rows to insert, easy just return now
1741 if ( !count( $a ) ) {
1745 $table = $this->tableName( $table );
1747 if ( !is_array( $options ) ) {
1748 $options = array( $options );
1752 if ( isset( $options['fileHandle'] ) ) {
1753 $fh = $options['fileHandle'];
1755 $options = $this->makeInsertOptions( $options );
1757 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
1759 $keys = array_keys( $a[0] );
1762 $keys = array_keys( $a );
1765 $sql = 'INSERT ' . $options .
1766 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
1770 foreach ( $a as $row ) {
1776 $sql .= '(' . $this->makeList( $row ) . ')';
1779 $sql .= '(' . $this->makeList( $a ) . ')';
1782 if ( $fh !== null && false === fwrite( $fh, $sql ) ) {
1784 } elseif ( $fh !== null ) {
1788 return (bool)$this->query( $sql, $fname );
1792 * Make UPDATE options for the DatabaseBase::update function
1794 * @param array $options The options passed to DatabaseBase::update
1797 protected function makeUpdateOptions( $options ) {
1798 if ( !is_array( $options ) ) {
1799 $options = array( $options );
1804 if ( in_array( 'LOW_PRIORITY', $options ) ) {
1805 $opts[] = $this->lowPriorityOption();
1808 if ( in_array( 'IGNORE', $options ) ) {
1812 return implode( ' ', $opts );
1816 * UPDATE wrapper. Takes a condition array and a SET array.
1818 * @param $table String name of the table to UPDATE. This will be passed through
1819 * DatabaseBase::tableName().
1821 * @param array $values An array of values to SET. For each array element,
1822 * the key gives the field name, and the value gives the data
1823 * to set that field to. The data will be quoted by
1824 * DatabaseBase::addQuotes().
1826 * @param $conds Array: An array of conditions (WHERE). See
1827 * DatabaseBase::select() for the details of the format of
1828 * condition arrays. Use '*' to update all rows.
1830 * @param $fname String: The function name of the caller (from __METHOD__),
1831 * for logging and profiling.
1833 * @param array $options An array of UPDATE options, can be:
1834 * - IGNORE: Ignore unique key conflicts
1835 * - LOW_PRIORITY: MySQL-specific, see MySQL manual.
1838 function update( $table, $values, $conds, $fname = __METHOD__
, $options = array() ) {
1839 $table = $this->tableName( $table );
1840 $opts = $this->makeUpdateOptions( $options );
1841 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, LIST_SET
);
1843 if ( $conds !== array() && $conds !== '*' ) {
1844 $sql .= " WHERE " . $this->makeList( $conds, LIST_AND
);
1847 return $this->query( $sql, $fname );
1851 * Makes an encoded list of strings from an array
1852 * @param array $a containing the data
1853 * @param int $mode Constant
1854 * - LIST_COMMA: comma separated, no field names
1855 * - LIST_AND: ANDed WHERE clause (without the WHERE). See
1856 * the documentation for $conds in DatabaseBase::select().
1857 * - LIST_OR: ORed WHERE clause (without the WHERE)
1858 * - LIST_SET: comma separated with field names, like a SET clause
1859 * - LIST_NAMES: comma separated field names
1861 * @throws MWException|DBUnexpectedError
1864 public function makeList( $a, $mode = LIST_COMMA
) {
1865 if ( !is_array( $a ) ) {
1866 throw new DBUnexpectedError( $this, 'DatabaseBase::makeList called with incorrect parameters' );
1872 foreach ( $a as $field => $value ) {
1874 if ( $mode == LIST_AND
) {
1876 } elseif ( $mode == LIST_OR
) {
1885 if ( ( $mode == LIST_AND ||
$mode == LIST_OR
) && is_numeric( $field ) ) {
1886 $list .= "($value)";
1887 } elseif ( ( $mode == LIST_SET
) && is_numeric( $field ) ) {
1889 } elseif ( ( $mode == LIST_AND ||
$mode == LIST_OR
) && is_array( $value ) ) {
1890 if ( count( $value ) == 0 ) {
1891 throw new MWException( __METHOD__
. ": empty input for field $field" );
1892 } elseif ( count( $value ) == 1 ) {
1893 // Special-case single values, as IN isn't terribly efficient
1894 // Don't necessarily assume the single key is 0; we don't
1895 // enforce linear numeric ordering on other arrays here.
1896 $value = array_values( $value );
1897 $list .= $field . " = " . $this->addQuotes( $value[0] );
1899 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
1901 } elseif ( $value === null ) {
1902 if ( $mode == LIST_AND ||
$mode == LIST_OR
) {
1903 $list .= "$field IS ";
1904 } elseif ( $mode == LIST_SET
) {
1905 $list .= "$field = ";
1909 if ( $mode == LIST_AND ||
$mode == LIST_OR ||
$mode == LIST_SET
) {
1910 $list .= "$field = ";
1912 $list .= $mode == LIST_NAMES ?
$value : $this->addQuotes( $value );
1920 * Build a partial where clause from a 2-d array such as used for LinkBatch.
1921 * The keys on each level may be either integers or strings.
1923 * @param array $data organized as 2-d
1924 * array(baseKeyVal => array(subKeyVal => [ignored], ...), ...)
1925 * @param string $baseKey field name to match the base-level keys to (eg 'pl_namespace')
1926 * @param string $subKey field name to match the sub-level keys to (eg 'pl_title')
1927 * @return Mixed: string SQL fragment, or false if no items in array.
1929 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
1932 foreach ( $data as $base => $sub ) {
1933 if ( count( $sub ) ) {
1934 $conds[] = $this->makeList(
1935 array( $baseKey => $base, $subKey => array_keys( $sub ) ),
1941 return $this->makeList( $conds, LIST_OR
);
1943 // Nothing to search for...
1949 * Return aggregated value alias
1952 * @param $valuename string
1956 public function aggregateValue( $valuedata, $valuename = 'value' ) {
1964 public function bitNot( $field ) {
1970 * @param $fieldRight
1973 public function bitAnd( $fieldLeft, $fieldRight ) {
1974 return "($fieldLeft & $fieldRight)";
1979 * @param $fieldRight
1982 public function bitOr( $fieldLeft, $fieldRight ) {
1983 return "($fieldLeft | $fieldRight)";
1987 * Build a concatenation list to feed into a SQL query
1988 * @param array $stringList list of raw SQL expressions; caller is responsible for any quoting
1991 public function buildConcat( $stringList ) {
1992 return 'CONCAT(' . implode( ',', $stringList ) . ')';
1996 * Change the current database
1998 * @todo Explain what exactly will fail if this is not overridden.
2002 * @return bool Success or failure
2004 public function selectDB( $db ) {
2005 # Stub. Shouldn't cause serious problems if it's not overridden, but
2006 # if your database engine supports a concept similar to MySQL's
2007 # databases you may as well.
2008 $this->mDBname
= $db;
2013 * Get the current DB name
2015 public function getDBname() {
2016 return $this->mDBname
;
2020 * Get the server hostname or IP address
2022 public function getServer() {
2023 return $this->mServer
;
2027 * Format a table name ready for use in constructing an SQL query
2029 * This does two important things: it quotes the table names to clean them up,
2030 * and it adds a table prefix if only given a table name with no quotes.
2032 * All functions of this object which require a table name call this function
2033 * themselves. Pass the canonical name to such functions. This is only needed
2034 * when calling query() directly.
2036 * @param string $name database table name
2037 * @param string $format One of:
2038 * quoted - Automatically pass the table name through addIdentifierQuotes()
2039 * so that it can be used in a query.
2040 * raw - Do not add identifier quotes to the table name
2041 * @return String: full database name
2043 public function tableName( $name, $format = 'quoted' ) {
2044 global $wgSharedDB, $wgSharedPrefix, $wgSharedTables;
2045 # Skip the entire process when we have a string quoted on both ends.
2046 # Note that we check the end so that we will still quote any use of
2047 # use of `database`.table. But won't break things if someone wants
2048 # to query a database table with a dot in the name.
2049 if ( $this->isQuotedIdentifier( $name ) ) {
2053 # Lets test for any bits of text that should never show up in a table
2054 # name. Basically anything like JOIN or ON which are actually part of
2055 # SQL queries, but may end up inside of the table value to combine
2056 # sql. Such as how the API is doing.
2057 # Note that we use a whitespace test rather than a \b test to avoid
2058 # any remote case where a word like on may be inside of a table name
2059 # surrounded by symbols which may be considered word breaks.
2060 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
2064 # Split database and table into proper variables.
2065 # We reverse the explode so that database.table and table both output
2066 # the correct table.
2067 $dbDetails = explode( '.', $name, 2 );
2068 if ( count( $dbDetails ) == 2 ) {
2069 list( $database, $table ) = $dbDetails;
2070 # We don't want any prefix added in this case
2073 list( $table ) = $dbDetails;
2074 if ( $wgSharedDB !== null # We have a shared database
2075 && !$this->isQuotedIdentifier( $table ) # Paranoia check to prevent shared tables listing '`table`'
2076 && in_array( $table, $wgSharedTables ) # A shared table is selected
2078 $database = $wgSharedDB;
2079 $prefix = $wgSharedPrefix === null ?
$this->mTablePrefix
: $wgSharedPrefix;
2082 $prefix = $this->mTablePrefix
; # Default prefix
2086 # Quote $table and apply the prefix if not quoted.
2087 $tableName = "{$prefix}{$table}";
2088 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $tableName ) ) {
2089 $tableName = $this->addIdentifierQuotes( $tableName );
2092 # Quote $database and merge it with the table name if needed
2093 if ( $database !== null ) {
2094 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $database ) ) {
2095 $database = $this->addIdentifierQuotes( $database );
2097 $tableName = $database . '.' . $tableName;
2104 * Fetch a number of table names into an array
2105 * This is handy when you need to construct SQL for joins
2108 * extract( $dbr->tableNames( 'user', 'watchlist' ) );
2109 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
2110 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
2114 public function tableNames() {
2115 $inArray = func_get_args();
2118 foreach ( $inArray as $name ) {
2119 $retVal[$name] = $this->tableName( $name );
2126 * Fetch a number of table names into an zero-indexed numerical array
2127 * This is handy when you need to construct SQL for joins
2130 * list( $user, $watchlist ) = $dbr->tableNamesN( 'user', 'watchlist' );
2131 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
2132 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
2136 public function tableNamesN() {
2137 $inArray = func_get_args();
2140 foreach ( $inArray as $name ) {
2141 $retVal[] = $this->tableName( $name );
2148 * Get an aliased table name
2149 * e.g. tableName AS newTableName
2151 * @param string $name Table name, see tableName()
2152 * @param string|bool $alias Alias (optional)
2153 * @return string SQL name for aliased table. Will not alias a table to its own name
2155 public function tableNameWithAlias( $name, $alias = false ) {
2156 if ( !$alias ||
$alias == $name ) {
2157 return $this->tableName( $name );
2159 return $this->tableName( $name ) . ' ' . $this->addIdentifierQuotes( $alias );
2164 * Gets an array of aliased table names
2166 * @param $tables array( [alias] => table )
2167 * @return array of strings, see tableNameWithAlias()
2169 public function tableNamesWithAlias( $tables ) {
2171 foreach ( $tables as $alias => $table ) {
2172 if ( is_numeric( $alias ) ) {
2175 $retval[] = $this->tableNameWithAlias( $table, $alias );
2181 * Get an aliased field name
2182 * e.g. fieldName AS newFieldName
2184 * @param string $name Field name
2185 * @param string|bool $alias Alias (optional)
2186 * @return string SQL name for aliased field. Will not alias a field to its own name
2188 public function fieldNameWithAlias( $name, $alias = false ) {
2189 if ( !$alias ||
(string)$alias === (string)$name ) {
2192 return $name . ' AS ' . $alias; //PostgreSQL needs AS
2197 * Gets an array of aliased field names
2199 * @param $fields array( [alias] => field )
2200 * @return array of strings, see fieldNameWithAlias()
2202 public function fieldNamesWithAlias( $fields ) {
2204 foreach ( $fields as $alias => $field ) {
2205 if ( is_numeric( $alias ) ) {
2208 $retval[] = $this->fieldNameWithAlias( $field, $alias );
2214 * Get the aliased table name clause for a FROM clause
2215 * which might have a JOIN and/or USE INDEX clause
2217 * @param array $tables ( [alias] => table )
2218 * @param $use_index array Same as for select()
2219 * @param $join_conds array Same as for select()
2222 protected function tableNamesWithUseIndexOrJOIN(
2223 $tables, $use_index = array(), $join_conds = array()
2227 $use_index = (array)$use_index;
2228 $join_conds = (array)$join_conds;
2230 foreach ( $tables as $alias => $table ) {
2231 if ( !is_string( $alias ) ) {
2232 // No alias? Set it equal to the table name
2235 // Is there a JOIN clause for this table?
2236 if ( isset( $join_conds[$alias] ) ) {
2237 list( $joinType, $conds ) = $join_conds[$alias];
2238 $tableClause = $joinType;
2239 $tableClause .= ' ' . $this->tableNameWithAlias( $table, $alias );
2240 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2241 $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2243 $tableClause .= ' ' . $use;
2246 $on = $this->makeList( (array)$conds, LIST_AND
);
2248 $tableClause .= ' ON (' . $on . ')';
2251 $retJOIN[] = $tableClause;
2252 // Is there an INDEX clause for this table?
2253 } elseif ( isset( $use_index[$alias] ) ) {
2254 $tableClause = $this->tableNameWithAlias( $table, $alias );
2255 $tableClause .= ' ' . $this->useIndexClause(
2256 implode( ',', (array)$use_index[$alias] ) );
2258 $ret[] = $tableClause;
2260 $tableClause = $this->tableNameWithAlias( $table, $alias );
2262 $ret[] = $tableClause;
2266 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2267 $implicitJoins = !empty( $ret ) ?
implode( ',', $ret ) : "";
2268 $explicitJoins = !empty( $retJOIN ) ?
implode( ' ', $retJOIN ) : "";
2270 // Compile our final table clause
2271 return implode( ' ', array( $implicitJoins, $explicitJoins ) );
2275 * Get the name of an index in a given table
2281 protected function indexName( $index ) {
2282 // Backwards-compatibility hack
2284 'ar_usertext_timestamp' => 'usertext_timestamp',
2285 'un_user_id' => 'user_id',
2286 'un_user_ip' => 'user_ip',
2289 if ( isset( $renamed[$index] ) ) {
2290 return $renamed[$index];
2297 * If it's a string, adds quotes and backslashes
2298 * Otherwise returns as-is
2304 public function addQuotes( $s ) {
2305 if ( $s === null ) {
2308 # This will also quote numeric values. This should be harmless,
2309 # and protects against weird problems that occur when they really
2310 # _are_ strings such as article titles and string->number->string
2311 # conversion is not 1:1.
2312 return "'" . $this->strencode( $s ) . "'";
2317 * Quotes an identifier using `backticks` or "double quotes" depending on the database type.
2318 * MySQL uses `backticks` while basically everything else uses double quotes.
2319 * Since MySQL is the odd one out here the double quotes are our generic
2320 * and we implement backticks in DatabaseMysql.
2326 public function addIdentifierQuotes( $s ) {
2327 return '"' . str_replace( '"', '""', $s ) . '"';
2331 * Returns if the given identifier looks quoted or not according to
2332 * the database convention for quoting identifiers .
2334 * @param $name string
2338 public function isQuotedIdentifier( $name ) {
2339 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2346 protected function escapeLikeInternal( $s ) {
2347 $s = str_replace( '\\', '\\\\', $s );
2348 $s = $this->strencode( $s );
2349 $s = str_replace( array( '%', '_' ), array( '\%', '\_' ), $s );
2355 * LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match
2356 * containing either string literals that will be escaped or tokens returned by anyChar() or anyString().
2357 * Alternatively, the function could be provided with an array of aforementioned parameters.
2359 * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches
2360 * for subpages of 'My page title'.
2361 * Alternatively: $pattern = array( 'My_page_title/', $dbr->anyString() ); $query .= $dbr->buildLike( $pattern );
2364 * @return String: fully built LIKE statement
2366 public function buildLike() {
2367 $params = func_get_args();
2369 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2370 $params = $params[0];
2375 foreach ( $params as $value ) {
2376 if ( $value instanceof LikeMatch
) {
2377 $s .= $value->toString();
2379 $s .= $this->escapeLikeInternal( $value );
2383 return " LIKE '" . $s . "' ";
2387 * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
2391 public function anyChar() {
2392 return new LikeMatch( '_' );
2396 * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
2400 public function anyString() {
2401 return new LikeMatch( '%' );
2405 * Returns an appropriately quoted sequence value for inserting a new row.
2406 * MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
2407 * subclass will return an integer, and save the value for insertId()
2409 * Any implementation of this function should *not* involve reusing
2410 * sequence numbers created for rolled-back transactions.
2411 * See http://bugs.mysql.com/bug.php?id=30767 for details.
2412 * @param $seqName string
2415 public function nextSequenceValue( $seqName ) {
2420 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2421 * is only needed because a) MySQL must be as efficient as possible due to
2422 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2423 * which index to pick. Anyway, other databases might have different
2424 * indexes on a given table. So don't bother overriding this unless you're
2429 public function useIndexClause( $index ) {
2434 * REPLACE query wrapper.
2436 * REPLACE is a very handy MySQL extension, which functions like an INSERT
2437 * except that when there is a duplicate key error, the old row is deleted
2438 * and the new row is inserted in its place.
2440 * We simulate this with standard SQL with a DELETE followed by INSERT. To
2441 * perform the delete, we need to know what the unique indexes are so that
2442 * we know how to find the conflicting rows.
2444 * It may be more efficient to leave off unique indexes which are unlikely
2445 * to collide. However if you do this, you run the risk of encountering
2446 * errors which wouldn't have occurred in MySQL.
2448 * @param string $table The table to replace the row(s) in.
2449 * @param array $rows Can be either a single row to insert, or multiple rows,
2450 * in the same format as for DatabaseBase::insert()
2451 * @param array $uniqueIndexes is an array of indexes. Each element may be either
2452 * a field name or an array of field names
2453 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
2455 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
2456 $quotedTable = $this->tableName( $table );
2458 if ( count( $rows ) == 0 ) {
2463 if ( !is_array( reset( $rows ) ) ) {
2464 $rows = array( $rows );
2467 foreach ( $rows as $row ) {
2468 # Delete rows which collide
2469 if ( $uniqueIndexes ) {
2470 $sql = "DELETE FROM $quotedTable WHERE ";
2472 foreach ( $uniqueIndexes as $index ) {
2479 if ( is_array( $index ) ) {
2481 foreach ( $index as $col ) {
2487 $sql .= $col . '=' . $this->addQuotes( $row[$col] );
2490 $sql .= $index . '=' . $this->addQuotes( $row[$index] );
2494 $this->query( $sql, $fname );
2497 # Now insert the row
2498 $this->insert( $table, $row, $fname );
2503 * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2506 * @param string $table Table name
2507 * @param array $rows Rows to insert
2508 * @param string $fname Caller function name
2510 * @return ResultWrapper
2512 protected function nativeReplace( $table, $rows, $fname ) {
2513 $table = $this->tableName( $table );
2516 if ( !is_array( reset( $rows ) ) ) {
2517 $rows = array( $rows );
2520 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2523 foreach ( $rows as $row ) {
2530 $sql .= '(' . $this->makeList( $row ) . ')';
2533 return $this->query( $sql, $fname );
2537 * INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
2539 * This updates any conflicting rows (according to the unique indexes) using
2540 * the provided SET clause and inserts any remaining (non-conflicted) rows.
2542 * $rows may be either:
2543 * - A single associative array. The array keys are the field names, and
2544 * the values are the values to insert. The values are treated as data
2545 * and will be quoted appropriately. If NULL is inserted, this will be
2546 * converted to a database NULL.
2547 * - An array with numeric keys, holding a list of associative arrays.
2548 * This causes a multi-row INSERT on DBMSs that support it. The keys in
2549 * each subarray must be identical to each other, and in the same order.
2551 * It may be more efficient to leave off unique indexes which are unlikely
2552 * to collide. However if you do this, you run the risk of encountering
2553 * errors which wouldn't have occurred in MySQL.
2555 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
2558 * @param string $table Table name. This will be passed through DatabaseBase::tableName().
2559 * @param array $rows A single row or list of rows to insert
2560 * @param array $uniqueIndexes List of single field names or field name tuples
2561 * @param array $set An array of values to SET. For each array element,
2562 * the key gives the field name, and the value gives the data
2563 * to set that field to. The data will be quoted by
2564 * DatabaseBase::addQuotes().
2565 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
2566 * @param array $options of options
2571 public function upsert(
2572 $table, array $rows, array $uniqueIndexes, array $set, $fname = __METHOD__
2574 if ( !count( $rows ) ) {
2575 return true; // nothing to do
2577 $rows = is_array( reset( $rows ) ) ?
$rows : array( $rows );
2579 if ( count( $uniqueIndexes ) ) {
2580 $clauses = array(); // list WHERE clauses that each identify a single row
2581 foreach ( $rows as $row ) {
2582 foreach ( $uniqueIndexes as $index ) {
2583 $index = is_array( $index ) ?
$index : array( $index ); // columns
2584 $rowKey = array(); // unique key to this row
2585 foreach ( $index as $column ) {
2586 $rowKey[$column] = $row[$column];
2588 $clauses[] = $this->makeList( $rowKey, LIST_AND
);
2591 $where = array( $this->makeList( $clauses, LIST_OR
) );
2596 $useTrx = !$this->mTrxLevel
;
2598 $this->begin( $fname );
2601 # Update any existing conflicting row(s)
2602 if ( $where !== false ) {
2603 $ok = $this->update( $table, $set, $where, $fname );
2607 # Now insert any non-conflicting row(s)
2608 $ok = $this->insert( $table, $rows, $fname, array( 'IGNORE' ) ) && $ok;
2609 } catch ( Exception
$e ) {
2611 $this->rollback( $fname );
2616 $this->commit( $fname );
2623 * DELETE where the condition is a join.
2625 * MySQL overrides this to use a multi-table DELETE syntax, in other databases
2626 * we use sub-selects
2628 * For safety, an empty $conds will not delete everything. If you want to
2629 * delete all rows where the join condition matches, set $conds='*'.
2631 * DO NOT put the join condition in $conds.
2633 * @param $delTable String: The table to delete from.
2634 * @param $joinTable String: The other table.
2635 * @param $delVar String: The variable to join on, in the first table.
2636 * @param $joinVar String: The variable to join on, in the second table.
2637 * @param $conds Array: Condition array of field names mapped to variables,
2638 * ANDed together in the WHERE clause
2639 * @param $fname String: Calling function name (use __METHOD__) for
2641 * @throws DBUnexpectedError
2643 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2644 $fname = __METHOD__
)
2647 throw new DBUnexpectedError( $this,
2648 'DatabaseBase::deleteJoin() called with empty $conds' );
2651 $delTable = $this->tableName( $delTable );
2652 $joinTable = $this->tableName( $joinTable );
2653 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2654 if ( $conds != '*' ) {
2655 $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND
);
2659 $this->query( $sql, $fname );
2663 * Returns the size of a text field, or -1 for "unlimited"
2665 * @param $table string
2666 * @param $field string
2670 public function textFieldSize( $table, $field ) {
2671 $table = $this->tableName( $table );
2672 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2673 $res = $this->query( $sql, 'DatabaseBase::textFieldSize' );
2674 $row = $this->fetchObject( $res );
2678 if ( preg_match( '/\((.*)\)/', $row->Type
, $m ) ) {
2688 * A string to insert into queries to show that they're low-priority, like
2689 * MySQL's LOW_PRIORITY. If no such feature exists, return an empty
2690 * string and nothing bad should happen.
2692 * @return string Returns the text of the low priority option if it is
2693 * supported, or a blank string otherwise
2695 public function lowPriorityOption() {
2700 * DELETE query wrapper.
2702 * @param array $table Table name
2703 * @param string|array $conds of conditions. See $conds in DatabaseBase::select() for
2704 * the format. Use $conds == "*" to delete all rows
2705 * @param string $fname name of the calling function
2707 * @throws DBUnexpectedError
2708 * @return bool|ResultWrapper
2710 public function delete( $table, $conds, $fname = __METHOD__
) {
2712 throw new DBUnexpectedError( $this, 'DatabaseBase::delete() called with no conditions' );
2715 $table = $this->tableName( $table );
2716 $sql = "DELETE FROM $table";
2718 if ( $conds != '*' ) {
2719 if ( is_array( $conds ) ) {
2720 $conds = $this->makeList( $conds, LIST_AND
);
2722 $sql .= ' WHERE ' . $conds;
2725 return $this->query( $sql, $fname );
2729 * INSERT SELECT wrapper. Takes data from a SELECT query and inserts it
2730 * into another table.
2732 * @param string $destTable The table name to insert into
2733 * @param string|array $srcTable May be either a table name, or an array of table names
2734 * to include in a join.
2736 * @param array $varMap must be an associative array of the form
2737 * array( 'dest1' => 'source1', ...). Source items may be literals
2738 * rather than field names, but strings should be quoted with
2739 * DatabaseBase::addQuotes()
2741 * @param array $conds Condition array. See $conds in DatabaseBase::select() for
2742 * the details of the format of condition arrays. May be "*" to copy the
2745 * @param string $fname The function name of the caller, from __METHOD__
2747 * @param array $insertOptions Options for the INSERT part of the query, see
2748 * DatabaseBase::insert() for details.
2749 * @param array $selectOptions Options for the SELECT part of the query, see
2750 * DatabaseBase::select() for details.
2752 * @return ResultWrapper
2754 public function insertSelect( $destTable, $srcTable, $varMap, $conds,
2755 $fname = __METHOD__
,
2756 $insertOptions = array(), $selectOptions = array() )
2758 $destTable = $this->tableName( $destTable );
2760 if ( is_array( $insertOptions ) ) {
2761 $insertOptions = implode( ' ', $insertOptions );
2764 if ( !is_array( $selectOptions ) ) {
2765 $selectOptions = array( $selectOptions );
2768 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
2770 if ( is_array( $srcTable ) ) {
2771 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
2773 $srcTable = $this->tableName( $srcTable );
2776 $sql = "INSERT $insertOptions INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
2777 " SELECT $startOpts " . implode( ',', $varMap ) .
2778 " FROM $srcTable $useIndex ";
2780 if ( $conds != '*' ) {
2781 if ( is_array( $conds ) ) {
2782 $conds = $this->makeList( $conds, LIST_AND
);
2784 $sql .= " WHERE $conds";
2787 $sql .= " $tailOpts";
2789 return $this->query( $sql, $fname );
2793 * Construct a LIMIT query with optional offset. This is used for query
2794 * pages. The SQL should be adjusted so that only the first $limit rows
2795 * are returned. If $offset is provided as well, then the first $offset
2796 * rows should be discarded, and the next $limit rows should be returned.
2797 * If the result of the query is not ordered, then the rows to be returned
2798 * are theoretically arbitrary.
2800 * $sql is expected to be a SELECT, if that makes a difference.
2802 * The version provided by default works in MySQL and SQLite. It will very
2803 * likely need to be overridden for most other DBMSes.
2805 * @param string $sql SQL query we will append the limit too
2806 * @param $limit Integer the SQL limit
2807 * @param $offset Integer|bool the SQL offset (default false)
2809 * @throws DBUnexpectedError
2812 public function limitResult( $sql, $limit, $offset = false ) {
2813 if ( !is_numeric( $limit ) ) {
2814 throw new DBUnexpectedError( $this, "Invalid non-numeric limit passed to limitResult()\n" );
2816 return "$sql LIMIT "
2817 . ( ( is_numeric( $offset ) && $offset != 0 ) ?
"{$offset}," : "" )
2822 * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
2823 * within the UNION construct.
2826 public function unionSupportsOrderAndLimit() {
2827 return true; // True for almost every DB supported
2831 * Construct a UNION query
2832 * This is used for providing overload point for other DB abstractions
2833 * not compatible with the MySQL syntax.
2834 * @param array $sqls SQL statements to combine
2835 * @param $all Boolean: use UNION ALL
2836 * @return String: SQL fragment
2838 public function unionQueries( $sqls, $all ) {
2839 $glue = $all ?
') UNION ALL (' : ') UNION (';
2840 return '(' . implode( $glue, $sqls ) . ')';
2844 * Returns an SQL expression for a simple conditional. This doesn't need
2845 * to be overridden unless CASE isn't supported in your DBMS.
2847 * @param string|array $cond SQL expression which will result in a boolean value
2848 * @param string $trueVal SQL expression to return if true
2849 * @param string $falseVal SQL expression to return if false
2850 * @return String: SQL fragment
2852 public function conditional( $cond, $trueVal, $falseVal ) {
2853 if ( is_array( $cond ) ) {
2854 $cond = $this->makeList( $cond, LIST_AND
);
2856 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
2860 * Returns a comand for str_replace function in SQL query.
2861 * Uses REPLACE() in MySQL
2863 * @param string $orig column to modify
2864 * @param string $old column to seek
2865 * @param string $new column to replace with
2869 public function strreplace( $orig, $old, $new ) {
2870 return "REPLACE({$orig}, {$old}, {$new})";
2874 * Determines how long the server has been up
2879 public function getServerUptime() {
2884 * Determines if the last failure was due to a deadlock
2889 public function wasDeadlock() {
2894 * Determines if the last failure was due to a lock timeout
2899 public function wasLockTimeout() {
2904 * Determines if the last query error was something that should be dealt
2905 * with by pinging the connection and reissuing the query.
2910 public function wasErrorReissuable() {
2915 * Determines if the last failure was due to the database being read-only.
2920 public function wasReadOnlyError() {
2925 * Perform a deadlock-prone transaction.
2927 * This function invokes a callback function to perform a set of write
2928 * queries. If a deadlock occurs during the processing, the transaction
2929 * will be rolled back and the callback function will be called again.
2932 * $dbw->deadlockLoop( callback, ... );
2934 * Extra arguments are passed through to the specified callback function.
2936 * Returns whatever the callback function returned on its successful,
2937 * iteration, or false on error, for example if the retry limit was
2942 public function deadlockLoop() {
2943 $this->begin( __METHOD__
);
2944 $args = func_get_args();
2945 $function = array_shift( $args );
2946 $oldIgnore = $this->ignoreErrors( true );
2947 $tries = self
::DEADLOCK_TRIES
;
2949 if ( is_array( $function ) ) {
2950 $fname = $function[0];
2956 $retVal = call_user_func_array( $function, $args );
2957 $error = $this->lastError();
2958 $errno = $this->lastErrno();
2959 $sql = $this->lastQuery();
2962 if ( $this->wasDeadlock() ) {
2964 usleep( mt_rand( self
::DEADLOCK_DELAY_MIN
, self
::DEADLOCK_DELAY_MAX
) );
2966 $this->reportQueryError( $error, $errno, $sql, $fname );
2969 } while ( $this->wasDeadlock() && --$tries > 0 );
2971 $this->ignoreErrors( $oldIgnore );
2973 if ( $tries <= 0 ) {
2974 $this->rollback( __METHOD__
);
2975 $this->reportQueryError( $error, $errno, $sql, $fname );
2978 $this->commit( __METHOD__
);
2984 * Wait for the slave to catch up to a given master position.
2986 * @param $pos DBMasterPos object
2987 * @param $timeout Integer: the maximum number of seconds to wait for
2990 * @return integer: zero if the slave was past that position already,
2991 * greater than zero if we waited for some period of time, less than
2992 * zero if we timed out.
2994 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
2995 wfProfileIn( __METHOD__
);
2997 if ( !is_null( $this->mFakeSlaveLag
) ) {
2998 $wait = intval( ( $pos->pos
- microtime( true ) +
$this->mFakeSlaveLag
) * 1e6
);
3000 if ( $wait > $timeout * 1e6
) {
3001 wfDebug( "Fake slave timed out waiting for $pos ($wait us)\n" );
3002 wfProfileOut( __METHOD__
);
3004 } elseif ( $wait > 0 ) {
3005 wfDebug( "Fake slave waiting $wait us\n" );
3007 wfProfileOut( __METHOD__
);
3010 wfDebug( "Fake slave up to date ($wait us)\n" );
3011 wfProfileOut( __METHOD__
);
3016 wfProfileOut( __METHOD__
);
3018 # Real waits are implemented in the subclass.
3023 * Get the replication position of this slave
3025 * @return DBMasterPos, or false if this is not a slave.
3027 public function getSlavePos() {
3028 if ( !is_null( $this->mFakeSlaveLag
) ) {
3029 $pos = new MySQLMasterPos( 'fake', microtime( true ) - $this->mFakeSlaveLag
);
3030 wfDebug( __METHOD__
. ": fake slave pos = $pos\n" );
3039 * Get the position of this master
3041 * @return DBMasterPos, or false if this is not a master
3043 public function getMasterPos() {
3044 if ( $this->mFakeMaster
) {
3045 return new MySQLMasterPos( 'fake', microtime( true ) );
3052 * Run an anonymous function as soon as there is no transaction pending.
3053 * If there is a transaction and it is rolled back, then the callback is cancelled.
3054 * Queries in the function will run in AUTO-COMMIT mode unless there are begin() calls.
3055 * Callbacks must commit any transactions that they begin.
3057 * This is useful for updates to different systems or when separate transactions are needed.
3058 * For example, one might want to enqueue jobs into a system outside the database, but only
3059 * after the database is updated so that the jobs will see the data when they actually run.
3060 * It can also be used for updates that easily cause deadlocks if locks are held too long.
3062 * @param callable $callback
3065 final public function onTransactionIdle( $callback ) {
3066 $this->mTrxIdleCallbacks
[] = $callback;
3067 if ( !$this->mTrxLevel
) {
3068 $this->runOnTransactionIdleCallbacks();
3073 * Run an anonymous function before the current transaction commits or now if there is none.
3074 * If there is a transaction and it is rolled back, then the callback is cancelled.
3075 * Callbacks must not start nor commit any transactions.
3077 * This is useful for updates that easily cause deadlocks if locks are held too long
3078 * but where atomicity is strongly desired for these updates and some related updates.
3080 * @param callable $callback
3083 final public function onTransactionPreCommitOrIdle( $callback ) {
3084 if ( $this->mTrxLevel
) {
3085 $this->mTrxPreCommitCallbacks
[] = $callback;
3087 $this->onTransactionIdle( $callback ); // this will trigger immediately
3092 * Actually any "on transaction idle" callbacks.
3096 protected function runOnTransactionIdleCallbacks() {
3097 $autoTrx = $this->getFlag( DBO_TRX
); // automatic begin() enabled?
3099 $e = null; // last exception
3100 do { // callbacks may add callbacks :)
3101 $callbacks = $this->mTrxIdleCallbacks
;
3102 $this->mTrxIdleCallbacks
= array(); // recursion guard
3103 foreach ( $callbacks as $callback ) {
3105 $this->clearFlag( DBO_TRX
); // make each query its own transaction
3107 $this->setFlag( $autoTrx ? DBO_TRX
: 0 ); // restore automatic begin()
3108 } catch ( Exception
$e ) {
3111 } while ( count( $this->mTrxIdleCallbacks
) );
3113 if ( $e instanceof Exception
) {
3114 throw $e; // re-throw any last exception
3119 * Actually any "on transaction pre-commit" callbacks.
3123 protected function runOnTransactionPreCommitCallbacks() {
3124 $e = null; // last exception
3125 do { // callbacks may add callbacks :)
3126 $callbacks = $this->mTrxPreCommitCallbacks
;
3127 $this->mTrxPreCommitCallbacks
= array(); // recursion guard
3128 foreach ( $callbacks as $callback ) {
3131 } catch ( Exception
$e ) {}
3133 } while ( count( $this->mTrxPreCommitCallbacks
) );
3135 if ( $e instanceof Exception
) {
3136 throw $e; // re-throw any last exception
3141 * Begin a transaction. If a transaction is already in progress, that transaction will be committed before the
3142 * new transaction is started.
3144 * Note that when the DBO_TRX flag is set (which is usually the case for web requests, but not for maintenance scripts),
3145 * any previous database query will have started a transaction automatically.
3147 * Nesting of transactions is not supported. Attempts to nest transactions will cause a warning, unless the current
3148 * transaction was started automatically because of the DBO_TRX flag.
3150 * @param $fname string
3152 final public function begin( $fname = __METHOD__
) {
3153 global $wgDebugDBTransactions;
3155 if ( $this->mTrxLevel
) { // implicit commit
3156 if ( !$this->mTrxAutomatic
) {
3157 // We want to warn about inadvertently nested begin/commit pairs, but not about
3158 // auto-committing implicit transactions that were started by query() via DBO_TRX
3159 $msg = "$fname: Transaction already in progress (from {$this->mTrxFname}), " .
3160 " performing implicit commit!";
3162 wfLogDBError( $msg );
3164 // if the transaction was automatic and has done write operations,
3165 // log it if $wgDebugDBTransactions is enabled.
3166 if ( $this->mTrxDoneWrites
&& $wgDebugDBTransactions ) {
3167 wfDebug( "$fname: Automatic transaction with writes in progress" .
3168 " (from {$this->mTrxFname}), performing implicit commit!\n"
3173 $this->runOnTransactionPreCommitCallbacks();
3174 $this->doCommit( $fname );
3175 $this->runOnTransactionIdleCallbacks();
3178 $this->doBegin( $fname );
3179 $this->mTrxFname
= $fname;
3180 $this->mTrxDoneWrites
= false;
3181 $this->mTrxAutomatic
= false;
3185 * Issues the BEGIN command to the database server.
3187 * @see DatabaseBase::begin()
3188 * @param type $fname
3190 protected function doBegin( $fname ) {
3191 $this->query( 'BEGIN', $fname );
3192 $this->mTrxLevel
= 1;
3196 * Commits a transaction previously started using begin().
3197 * If no transaction is in progress, a warning is issued.
3199 * Nesting of transactions is not supported.
3201 * @param $fname string
3202 * @param string $flush Flush flag, set to 'flush' to disable warnings about explicitly committing implicit
3203 * transactions, or calling commit when no transaction is in progress.
3204 * This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure
3205 * that it is safe to ignore these warnings in your context.
3207 final public function commit( $fname = __METHOD__
, $flush = '' ) {
3208 if ( $flush != 'flush' ) {
3209 if ( !$this->mTrxLevel
) {
3210 wfWarn( "$fname: No transaction to commit, something got out of sync!" );
3211 } elseif ( $this->mTrxAutomatic
) {
3212 wfWarn( "$fname: Explicit commit of implicit transaction. Something may be out of sync!" );
3215 if ( !$this->mTrxLevel
) {
3216 return; // nothing to do
3217 } elseif ( !$this->mTrxAutomatic
) {
3218 wfWarn( "$fname: Flushing an explicit transaction, getting out of sync!" );
3222 $this->runOnTransactionPreCommitCallbacks();
3223 $this->doCommit( $fname );
3224 $this->runOnTransactionIdleCallbacks();
3228 * Issues the COMMIT command to the database server.
3230 * @see DatabaseBase::commit()
3231 * @param type $fname
3233 protected function doCommit( $fname ) {
3234 if ( $this->mTrxLevel
) {
3235 $this->query( 'COMMIT', $fname );
3236 $this->mTrxLevel
= 0;
3241 * Rollback a transaction previously started using begin().
3242 * If no transaction is in progress, a warning is issued.
3244 * No-op on non-transactional databases.
3246 * @param $fname string
3248 final public function rollback( $fname = __METHOD__
) {
3249 if ( !$this->mTrxLevel
) {
3250 wfWarn( "$fname: No transaction to rollback, something got out of sync!" );
3252 $this->doRollback( $fname );
3253 $this->mTrxIdleCallbacks
= array(); // cancel
3254 $this->mTrxPreCommitCallbacks
= array(); // cancel
3258 * Issues the ROLLBACK command to the database server.
3260 * @see DatabaseBase::rollback()
3261 * @param type $fname
3263 protected function doRollback( $fname ) {
3264 if ( $this->mTrxLevel
) {
3265 $this->query( 'ROLLBACK', $fname, true );
3266 $this->mTrxLevel
= 0;
3271 * Creates a new table with structure copied from existing table
3272 * Note that unlike most database abstraction functions, this function does not
3273 * automatically append database prefix, because it works at a lower
3274 * abstraction level.
3275 * The table names passed to this function shall not be quoted (this
3276 * function calls addIdentifierQuotes when needed).
3278 * @param string $oldName name of table whose structure should be copied
3279 * @param string $newName name of table to be created
3280 * @param $temporary Boolean: whether the new table should be temporary
3281 * @param string $fname calling function name
3282 * @throws MWException
3283 * @return Boolean: true if operation was successful
3285 public function duplicateTableStructure( $oldName, $newName, $temporary = false,
3288 throw new MWException(
3289 'DatabaseBase::duplicateTableStructure is not implemented in descendant class' );
3293 * List all tables on the database
3295 * @param string $prefix Only show tables with this prefix, e.g. mw_
3296 * @param string $fname calling function name
3297 * @throws MWException
3299 function listTables( $prefix = null, $fname = __METHOD__
) {
3300 throw new MWException( 'DatabaseBase::listTables is not implemented in descendant class' );
3304 * Convert a timestamp in one of the formats accepted by wfTimestamp()
3305 * to the format used for inserting into timestamp fields in this DBMS.
3307 * The result is unquoted, and needs to be passed through addQuotes()
3308 * before it can be included in raw SQL.
3310 * @param $ts string|int
3314 public function timestamp( $ts = 0 ) {
3315 return wfTimestamp( TS_MW
, $ts );
3319 * Convert a timestamp in one of the formats accepted by wfTimestamp()
3320 * to the format used for inserting into timestamp fields in this DBMS. If
3321 * NULL is input, it is passed through, allowing NULL values to be inserted
3322 * into timestamp fields.
3324 * The result is unquoted, and needs to be passed through addQuotes()
3325 * before it can be included in raw SQL.
3327 * @param $ts string|int
3331 public function timestampOrNull( $ts = null ) {
3332 if ( is_null( $ts ) ) {
3335 return $this->timestamp( $ts );
3340 * Take the result from a query, and wrap it in a ResultWrapper if
3341 * necessary. Boolean values are passed through as is, to indicate success
3342 * of write queries or failure.
3344 * Once upon a time, DatabaseBase::query() returned a bare MySQL result
3345 * resource, and it was necessary to call this function to convert it to
3346 * a wrapper. Nowadays, raw database objects are never exposed to external
3347 * callers, so this is unnecessary in external code. For compatibility with
3348 * old code, ResultWrapper objects are passed through unaltered.
3350 * @param $result bool|ResultWrapper
3352 * @return bool|ResultWrapper
3354 public function resultObject( $result ) {
3355 if ( empty( $result ) ) {
3357 } elseif ( $result instanceof ResultWrapper
) {
3359 } elseif ( $result === true ) {
3360 // Successful write query
3363 return new ResultWrapper( $this, $result );
3368 * Ping the server and try to reconnect if it there is no connection
3370 * @return bool Success or failure
3372 public function ping() {
3373 # Stub. Not essential to override.
3378 * Get slave lag. Currently supported only by MySQL.
3380 * Note that this function will generate a fatal error on many
3381 * installations. Most callers should use LoadBalancer::safeGetLag()
3384 * @return int Database replication lag in seconds
3386 public function getLag() {
3387 return intval( $this->mFakeSlaveLag
);
3391 * Return the maximum number of items allowed in a list, or 0 for unlimited.
3395 function maxListLen() {
3400 * Some DBMSs have a special format for inserting into blob fields, they
3401 * don't allow simple quoted strings to be inserted. To insert into such
3402 * a field, pass the data through this function before passing it to
3403 * DatabaseBase::insert().
3407 public function encodeBlob( $b ) {
3412 * Some DBMSs return a special placeholder object representing blob fields
3413 * in result objects. Pass the object through this function to return the
3418 public function decodeBlob( $b ) {
3423 * Override database's default behavior. $options include:
3424 * 'connTimeout' : Set the connection timeout value in seconds.
3425 * May be useful for very long batch queries such as
3426 * full-wiki dumps, where a single query reads out over
3429 * @param $options Array
3432 public function setSessionOptions( array $options ) {
3436 * Read and execute SQL commands from a file.
3438 * Returns true on success, error string or exception on failure (depending
3439 * on object's error ignore settings).
3441 * @param string $filename File name to open
3442 * @param bool|callable $lineCallback Optional function called before reading each line
3443 * @param bool|callable $resultCallback Optional function called for each MySQL result
3444 * @param bool|string $fname Calling function name or false if name should be
3445 * generated dynamically using $filename
3446 * @param bool|callable $inputCallback Callback: Optional function called for each complete line sent
3447 * @throws MWException
3448 * @throws Exception|MWException
3449 * @return bool|string
3451 public function sourceFile(
3452 $filename, $lineCallback = false, $resultCallback = false, $fname = false, $inputCallback = false
3454 wfSuppressWarnings();
3455 $fp = fopen( $filename, 'r' );
3456 wfRestoreWarnings();
3458 if ( false === $fp ) {
3459 throw new MWException( "Could not open \"{$filename}\".\n" );
3463 $fname = __METHOD__
. "( $filename )";
3467 $error = $this->sourceStream( $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
3469 catch ( MWException
$e ) {
3480 * Get the full path of a patch file. Originally based on archive()
3481 * from updaters.inc. Keep in mind this always returns a patch, as
3482 * it fails back to MySQL if no DB-specific patch can be found
3484 * @param string $patch The name of the patch, like patch-something.sql
3485 * @return String Full path to patch file
3487 public function patchPath( $patch ) {
3490 $dbType = $this->getType();
3491 if ( file_exists( "$IP/maintenance/$dbType/archives/$patch" ) ) {
3492 return "$IP/maintenance/$dbType/archives/$patch";
3494 return "$IP/maintenance/archives/$patch";
3499 * Set variables to be used in sourceFile/sourceStream, in preference to the
3500 * ones in $GLOBALS. If an array is set here, $GLOBALS will not be used at
3501 * all. If it's set to false, $GLOBALS will be used.
3503 * @param bool|array $vars mapping variable name to value.
3505 public function setSchemaVars( $vars ) {
3506 $this->mSchemaVars
= $vars;
3510 * Read and execute commands from an open file handle.
3512 * Returns true on success, error string or exception on failure (depending
3513 * on object's error ignore settings).
3515 * @param $fp Resource: File handle
3516 * @param $lineCallback Callback: Optional function called before reading each query
3517 * @param $resultCallback Callback: Optional function called for each MySQL result
3518 * @param string $fname Calling function name
3519 * @param $inputCallback Callback: Optional function called for each complete query sent
3520 * @return bool|string
3522 public function sourceStream( $fp, $lineCallback = false, $resultCallback = false,
3523 $fname = __METHOD__
, $inputCallback = false )
3527 while ( !feof( $fp ) ) {
3528 if ( $lineCallback ) {
3529 call_user_func( $lineCallback );
3532 $line = trim( fgets( $fp ) );
3534 if ( $line == '' ) {
3538 if ( '-' == $line[0] && '-' == $line[1] ) {
3546 $done = $this->streamStatementEnd( $cmd, $line );
3550 if ( $done ||
feof( $fp ) ) {
3551 $cmd = $this->replaceVars( $cmd );
3553 if ( ( $inputCallback && call_user_func( $inputCallback, $cmd ) ) ||
!$inputCallback ) {
3554 $res = $this->query( $cmd, $fname );
3556 if ( $resultCallback ) {
3557 call_user_func( $resultCallback, $res, $this );
3560 if ( false === $res ) {
3561 $err = $this->lastError();
3562 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
3573 * Called by sourceStream() to check if we've reached a statement end
3575 * @param string $sql SQL assembled so far
3576 * @param string $newLine New line about to be added to $sql
3577 * @return Bool Whether $newLine contains end of the statement
3579 public function streamStatementEnd( &$sql, &$newLine ) {
3580 if ( $this->delimiter
) {
3582 $newLine = preg_replace( '/' . preg_quote( $this->delimiter
, '/' ) . '$/', '', $newLine );
3583 if ( $newLine != $prev ) {
3591 * Database independent variable replacement. Replaces a set of variables
3592 * in an SQL statement with their contents as given by $this->getSchemaVars().
3594 * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
3596 * - '{$var}' should be used for text and is passed through the database's
3598 * - `{$var}` should be used for identifiers (eg: table and database names),
3599 * it is passed through the database's addIdentifierQuotes method which
3600 * can be overridden if the database uses something other than backticks.
3601 * - / *$var* / is just encoded, besides traditional table prefix and
3602 * table options its use should be avoided.
3604 * @param string $ins SQL statement to replace variables in
3605 * @return String The new SQL statement with variables replaced
3607 protected function replaceSchemaVars( $ins ) {
3608 $vars = $this->getSchemaVars();
3609 foreach ( $vars as $var => $value ) {
3611 $ins = str_replace( '\'{$' . $var . '}\'', $this->addQuotes( $value ), $ins );
3613 $ins = str_replace( '`{$' . $var . '}`', $this->addIdentifierQuotes( $value ), $ins );
3615 $ins = str_replace( '/*$' . $var . '*/', $this->strencode( $value ), $ins );
3621 * Replace variables in sourced SQL
3623 * @param $ins string
3627 protected function replaceVars( $ins ) {
3628 $ins = $this->replaceSchemaVars( $ins );
3631 $ins = preg_replace_callback( '!/\*(?:\$wgDBprefix|_)\*/([a-zA-Z_0-9]*)!',
3632 array( $this, 'tableNameCallback' ), $ins );
3635 $ins = preg_replace_callback( '!/\*i\*/([a-zA-Z_0-9]*)!',
3636 array( $this, 'indexNameCallback' ), $ins );
3642 * Get schema variables. If none have been set via setSchemaVars(), then
3643 * use some defaults from the current object.
3647 protected function getSchemaVars() {
3648 if ( $this->mSchemaVars
) {
3649 return $this->mSchemaVars
;
3651 return $this->getDefaultSchemaVars();
3656 * Get schema variables to use if none have been set via setSchemaVars().
3658 * Override this in derived classes to provide variables for tables.sql
3659 * and SQL patch files.
3663 protected function getDefaultSchemaVars() {
3668 * Table name callback
3670 * @param $matches array
3674 protected function tableNameCallback( $matches ) {
3675 return $this->tableName( $matches[1] );
3679 * Index name callback
3681 * @param $matches array
3685 protected function indexNameCallback( $matches ) {
3686 return $this->indexName( $matches[1] );
3690 * Check to see if a named lock is available. This is non-blocking.
3692 * @param string $lockName name of lock to poll
3693 * @param string $method name of method calling us
3697 public function lockIsFree( $lockName, $method ) {
3702 * Acquire a named lock
3704 * Abstracted from Filestore::lock() so child classes can implement for
3707 * @param string $lockName name of lock to aquire
3708 * @param string $method name of method calling us
3709 * @param $timeout Integer: timeout
3712 public function lock( $lockName, $method, $timeout = 5 ) {
3719 * @param string $lockName Name of lock to release
3720 * @param string $method Name of method calling us
3722 * @return int Returns 1 if the lock was released, 0 if the lock was not established
3723 * by this thread (in which case the lock is not released), and NULL if the named
3724 * lock did not exist
3726 public function unlock( $lockName, $method ) {
3731 * Lock specific tables
3733 * @param array $read of tables to lock for read access
3734 * @param array $write of tables to lock for write access
3735 * @param string $method name of caller
3736 * @param bool $lowPriority Whether to indicate writes to be LOW PRIORITY
3740 public function lockTables( $read, $write, $method, $lowPriority = true ) {
3745 * Unlock specific tables
3747 * @param string $method the caller
3751 public function unlockTables( $method ) {
3757 * @param $tableName string
3758 * @param $fName string
3759 * @return bool|ResultWrapper
3762 public function dropTable( $tableName, $fName = __METHOD__
) {
3763 if ( !$this->tableExists( $tableName, $fName ) ) {
3766 $sql = "DROP TABLE " . $this->tableName( $tableName );
3767 if ( $this->cascadingDeletes() ) {
3770 return $this->query( $sql, $fName );
3774 * Get search engine class. All subclasses of this need to implement this
3775 * if they wish to use searching.
3779 public function getSearchEngine() {
3780 return 'SearchEngineDummy';
3784 * Find out when 'infinity' is. Most DBMSes support this. This is a special
3785 * keyword for timestamps in PostgreSQL, and works with CHAR(14) as well
3786 * because "i" sorts after all numbers.
3790 public function getInfinity() {
3795 * Encode an expiry time into the DBMS dependent format
3797 * @param string $expiry timestamp for expiry, or the 'infinity' string
3800 public function encodeExpiry( $expiry ) {
3801 return ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() )
3802 ?
$this->getInfinity()
3803 : $this->timestamp( $expiry );
3807 * Decode an expiry time into a DBMS independent format
3809 * @param string $expiry DB timestamp field value for expiry
3810 * @param $format integer: TS_* constant, defaults to TS_MW
3813 public function decodeExpiry( $expiry, $format = TS_MW
) {
3814 return ( $expiry == '' ||
$expiry == $this->getInfinity() )
3816 : wfTimestamp( $format, $expiry );
3820 * Allow or deny "big selects" for this session only. This is done by setting
3821 * the sql_big_selects session variable.
3823 * This is a MySQL-specific feature.
3825 * @param $value Mixed: true for allow, false for deny, or "default" to
3826 * restore the initial value
3828 public function setBigSelects( $value = true ) {
3835 public function __toString() {
3836 return (string)$this->mConn
;
3839 public function __destruct() {
3840 if ( count( $this->mTrxIdleCallbacks
) ||
count( $this->mTrxPreCommitCallbacks
) ) {
3841 trigger_error( "Transaction idle or pre-commit callbacks still pending." ); // sanity