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
27 /** Number of times to re-try an operation in case of deadlock */
28 define( 'DEADLOCK_TRIES', 4 );
29 /** Minimum time to wait before retry, in microseconds */
30 define( 'DEADLOCK_DELAY_MIN', 500000 );
31 /** Maximum time to wait before retry */
32 define( 'DEADLOCK_DELAY_MAX', 1500000 );
35 * Base interface for all DBMS-specific code. At a bare minimum, all of the
36 * following must be implemented to support MediaWiki
41 interface DatabaseType
{
43 * Get the type of the DBMS, as it appears in $wgDBtype.
50 * Open a connection to the database. Usually aborts on failure
52 * @param string $server database server host
53 * @param string $user database user name
54 * @param string $password database user password
55 * @param string $dbName database name
57 * @throws DBConnectionError
59 function open( $server, $user, $password, $dbName );
62 * Fetch the next row from the given result object, in object form.
63 * Fields can be retrieved with $row->fieldname, with fields acting like
65 * If no more rows are available, false is returned.
67 * @param $res ResultWrapper|object as returned from DatabaseBase::query(), etc.
69 * @throws DBUnexpectedError Thrown if the database returns an error
71 function fetchObject( $res );
74 * Fetch the next row from the given result object, in associative array
75 * form. Fields are retrieved with $row['fieldname'].
76 * If no more rows are available, false is returned.
78 * @param $res ResultWrapper result object as returned from DatabaseBase::query(), etc.
80 * @throws DBUnexpectedError Thrown if the database returns an error
82 function fetchRow( $res );
85 * Get the number of rows in a result object
87 * @param $res Mixed: A SQL result
90 function numRows( $res );
93 * Get the number of fields in a result object
94 * @see http://www.php.net/mysql_num_fields
96 * @param $res Mixed: A SQL result
99 function numFields( $res );
102 * Get a field name in a result object
103 * @see http://www.php.net/mysql_field_name
105 * @param $res Mixed: A SQL result
109 function fieldName( $res, $n );
112 * Get the inserted value of an auto-increment row
114 * The value inserted should be fetched from nextSequenceValue()
117 * $id = $dbw->nextSequenceValue( 'page_page_id_seq' );
118 * $dbw->insert( 'page', array( 'page_id' => $id ) );
119 * $id = $dbw->insertId();
126 * Change the position of the cursor in a result object
127 * @see http://www.php.net/mysql_data_seek
129 * @param $res Mixed: A SQL result
130 * @param $row Mixed: Either MySQL row or ResultWrapper
132 function dataSeek( $res, $row );
135 * Get the last error number
136 * @see http://www.php.net/mysql_errno
140 function lastErrno();
143 * Get a description of the last error
144 * @see http://www.php.net/mysql_error
148 function lastError();
151 * mysql_fetch_field() wrapper
152 * Returns false if the field doesn't exist
154 * @param string $table table name
155 * @param string $field field name
159 function fieldInfo( $table, $field );
162 * Get information about an index into an object
163 * @param string $table Table name
164 * @param string $index Index name
165 * @param string $fname Calling function name
166 * @return Mixed: Database-specific index description class or false if the index does not exist
168 function indexInfo( $table, $index, $fname = 'Database::indexInfo' );
171 * Get the number of rows affected by the last write query
172 * @see http://www.php.net/mysql_affected_rows
176 function affectedRows();
179 * Wrapper for addslashes()
181 * @param string $s to be slashed.
182 * @return string: slashed string.
184 function strencode( $s );
187 * Returns a wikitext link to the DB's website, e.g.,
188 * return "[http://www.mysql.com/ MySQL]";
189 * Should at least contain plain text, if for some reason
190 * your database has no website.
192 * @return string: wikitext of a link to the server software's web site
194 static function getSoftwareLink();
197 * A string describing the current software version, like from
198 * mysql_get_server_info().
200 * @return string: Version information from the database server.
202 function getServerVersion();
205 * A string describing the current software version, and possibly
206 * other details in a user-friendly way. Will be listed on Special:Version, etc.
207 * Use getServerVersion() to get machine-friendly information.
209 * @return string: Version information from the database server
211 function getServerInfo();
215 * Database abstraction object
218 abstract class DatabaseBase
implements DatabaseType
{
220 # ------------------------------------------------------------------------------
222 # ------------------------------------------------------------------------------
224 protected $mLastQuery = '';
225 protected $mDoneWrites = false;
226 protected $mPHPError = false;
228 protected $mServer, $mUser, $mPassword, $mDBname;
230 protected $mConn = null;
231 protected $mOpened = false;
233 /** @var array of Closure */
234 protected $mTrxIdleCallbacks = array();
235 /** @var array of Closure */
236 protected $mTrxPreCommitCallbacks = array();
238 protected $mTablePrefix;
240 protected $mTrxLevel = 0;
241 protected $mErrorCount = 0;
242 protected $mLBInfo = array();
243 protected $mFakeSlaveLag = null, $mFakeMaster = false;
244 protected $mDefaultBigSelects = null;
245 protected $mSchemaVars = false;
247 protected $preparedArgs;
249 protected $htmlErrors;
251 protected $delimiter = ';';
254 * Remembers the function name given for starting the most recent transaction via begin().
255 * Used to provide additional context for error reporting.
258 * @see DatabaseBase::mTrxLevel
260 private $mTrxFname = null;
263 * Record if possible write queries were done in the last transaction started
266 * @see DatabaseBase::mTrxLevel
268 private $mTrxDoneWrites = false;
271 * Record if the current transaction was started implicitly due to DBO_TRX being set.
274 * @see DatabaseBase::mTrxLevel
276 private $mTrxAutomatic = false;
280 * @var file handle for upgrade
282 protected $fileHandle = null;
284 # ------------------------------------------------------------------------------
286 # ------------------------------------------------------------------------------
287 # These optionally set a variable and return the previous state
290 * A string describing the current software version, and possibly
291 * other details in a user-friendly way. Will be listed on Special:Version, etc.
292 * Use getServerVersion() to get machine-friendly information.
294 * @return string: Version information from the database server
296 public function getServerInfo() {
297 return $this->getServerVersion();
301 * @return string: command delimiter used by this database engine
303 public function getDelimiter() {
304 return $this->delimiter
;
308 * Boolean, controls output of large amounts of debug information.
309 * @param $debug bool|null
310 * - true to enable debugging
311 * - false to disable debugging
312 * - omitted or null to do nothing
314 * @return bool|null previous value of the flag
316 public function debug( $debug = null ) {
317 return wfSetBit( $this->mFlags
, DBO_DEBUG
, $debug );
321 * Turns buffering of SQL result sets on (true) or off (false). Default is
324 * Unbuffered queries are very troublesome in MySQL:
326 * - If another query is executed while the first query is being read
327 * out, the first query is killed. This means you can't call normal
328 * MediaWiki functions while you are reading an unbuffered query result
329 * from a normal wfGetDB() connection.
331 * - Unbuffered queries cause the MySQL server to use large amounts of
332 * memory and to hold broad locks which block other queries.
334 * If you want to limit client-side memory, it's almost always better to
335 * split up queries into batches using a LIMIT clause than to switch off
338 * @param $buffer null|bool
340 * @return null|bool The previous value of the flag
342 public function bufferResults( $buffer = null ) {
343 if ( is_null( $buffer ) ) {
344 return !(bool)( $this->mFlags
& DBO_NOBUFFER
);
346 return !wfSetBit( $this->mFlags
, DBO_NOBUFFER
, !$buffer );
351 * Turns on (false) or off (true) the automatic generation and sending
352 * of a "we're sorry, but there has been a database error" page on
353 * database errors. Default is on (false). When turned off, the
354 * code should use lastErrno() and lastError() to handle the
355 * situation as appropriate.
357 * @param $ignoreErrors bool|null
359 * @return bool The previous value of the flag.
361 public function ignoreErrors( $ignoreErrors = null ) {
362 return wfSetBit( $this->mFlags
, DBO_IGNORE
, $ignoreErrors );
366 * Gets or sets the current transaction level.
368 * Historically, transactions were allowed to be "nested". This is no
369 * longer supported, so this function really only returns a boolean.
371 * @param int $level An integer (0 or 1), or omitted to leave it unchanged.
372 * @return int The previous value
374 public function trxLevel( $level = null ) {
375 return wfSetVar( $this->mTrxLevel
, $level );
379 * Get/set the number of errors logged. Only useful when errors are ignored
380 * @param int $count The count to set, or omitted to leave it unchanged.
381 * @return int The error count
383 public function errorCount( $count = null ) {
384 return wfSetVar( $this->mErrorCount
, $count );
388 * Get/set the table prefix.
389 * @param string $prefix The table prefix to set, or omitted to leave it unchanged.
390 * @return string The previous table prefix.
392 public function tablePrefix( $prefix = null ) {
393 return wfSetVar( $this->mTablePrefix
, $prefix );
397 * Set the filehandle to copy write statements to.
399 * @param $fh filehandle
401 public function setFileHandle( $fh ) {
402 $this->fileHandle
= $fh;
406 * Get properties passed down from the server info array of the load
409 * @param string $name The entry of the info array to get, or null to get the
412 * @return LoadBalancer|null
414 public function getLBInfo( $name = null ) {
415 if ( is_null( $name ) ) {
416 return $this->mLBInfo
;
418 if ( array_key_exists( $name, $this->mLBInfo
) ) {
419 return $this->mLBInfo
[$name];
427 * Set the LB info array, or a member of it. If called with one parameter,
428 * the LB info array is set to that parameter. If it is called with two
429 * parameters, the member with the given name is set to the given value.
434 public function setLBInfo( $name, $value = null ) {
435 if ( is_null( $value ) ) {
436 $this->mLBInfo
= $name;
438 $this->mLBInfo
[$name] = $value;
443 * Set lag time in seconds for a fake slave
447 public function setFakeSlaveLag( $lag ) {
448 $this->mFakeSlaveLag
= $lag;
452 * Make this connection a fake master
454 * @param $enabled bool
456 public function setFakeMaster( $enabled = true ) {
457 $this->mFakeMaster
= $enabled;
461 * Returns true if this database supports (and uses) cascading deletes
465 public function cascadingDeletes() {
470 * Returns true if this database supports (and uses) triggers (e.g. on the page table)
474 public function cleanupTriggers() {
479 * Returns true if this database is strict about what can be put into an IP field.
480 * Specifically, it uses a NULL value instead of an empty string.
484 public function strictIPs() {
489 * Returns true if this database uses timestamps rather than integers
493 public function realTimestamps() {
498 * Returns true if this database does an implicit sort when doing GROUP BY
502 public function implicitGroupby() {
507 * Returns true if this database does an implicit order by when the column has an index
508 * For example: SELECT page_title FROM page LIMIT 1
512 public function implicitOrderby() {
517 * Returns true if this database can do a native search on IP columns
518 * e.g. this works as expected: .. WHERE rc_ip = '127.42.12.102/32';
522 public function searchableIPs() {
527 * Returns true if this database can use functional indexes
531 public function functionalIndexes() {
536 * Return the last query that went through DatabaseBase::query()
539 public function lastQuery() {
540 return $this->mLastQuery
;
544 * Returns true if the connection may have been used for write queries.
545 * Should return true if unsure.
549 public function doneWrites() {
550 return $this->mDoneWrites
;
554 * Returns true if there is a transaction open with possible write
555 * queries or transaction pre-commit/idle callbacks waiting on it to finish.
559 public function writesOrCallbacksPending() {
560 return $this->mTrxLevel
&& (
561 $this->mTrxDoneWrites ||
$this->mTrxIdleCallbacks ||
$this->mTrxPreCommitCallbacks
566 * Is a connection to the database open?
569 public function isOpen() {
570 return $this->mOpened
;
574 * Set a flag for this connection
576 * @param $flag Integer: DBO_* constants from Defines.php:
577 * - DBO_DEBUG: output some debug info (same as debug())
578 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
579 * - DBO_IGNORE: ignore errors (same as ignoreErrors())
580 * - DBO_TRX: automatically start transactions
581 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
582 * and removes it in command line mode
583 * - DBO_PERSISTENT: use persistant database connection
585 public function setFlag( $flag ) {
586 global $wgDebugDBTransactions;
587 $this->mFlags |
= $flag;
588 if ( ( $flag & DBO_TRX
) & $wgDebugDBTransactions ) {
589 wfDebug( "Implicit transactions are now disabled.\n" );
594 * Clear a flag for this connection
596 * @param $flag: same as setFlag()'s $flag param
598 public function clearFlag( $flag ) {
599 global $wgDebugDBTransactions;
600 $this->mFlags
&= ~
$flag;
601 if ( ( $flag & DBO_TRX
) && $wgDebugDBTransactions ) {
602 wfDebug( "Implicit transactions are now disabled.\n" );
607 * Returns a boolean whether the flag $flag is set for this connection
609 * @param $flag: same as setFlag()'s $flag param
612 public function getFlag( $flag ) {
613 return !!( $this->mFlags
& $flag );
617 * General read-only accessor
619 * @param $name string
623 public function getProperty( $name ) {
630 public function getWikiID() {
631 if ( $this->mTablePrefix
) {
632 return "{$this->mDBname}-{$this->mTablePrefix}";
634 return $this->mDBname
;
639 * Return a path to the DBMS-specific schema file, otherwise default to tables.sql
643 public function getSchemaPath() {
645 if ( file_exists( "$IP/maintenance/" . $this->getType() . "/tables.sql" ) ) {
646 return "$IP/maintenance/" . $this->getType() . "/tables.sql";
648 return "$IP/maintenance/tables.sql";
652 # ------------------------------------------------------------------------------
654 # ------------------------------------------------------------------------------
658 * @param string $server database server host
659 * @param string $user database user name
660 * @param string $password database user password
661 * @param string $dbName database name
663 * @param string $tablePrefix database table prefixes. By default use the prefix gave in LocalSettings.php
665 function __construct( $server = false, $user = false, $password = false, $dbName = false,
666 $flags = 0, $tablePrefix = 'get from global'
668 global $wgDBprefix, $wgCommandLineMode, $wgDebugDBTransactions;
670 $this->mFlags
= $flags;
672 if ( $this->mFlags
& DBO_DEFAULT
) {
673 if ( $wgCommandLineMode ) {
674 $this->mFlags
&= ~DBO_TRX
;
675 if ( $wgDebugDBTransactions ) {
676 wfDebug( "Implicit transaction open disabled.\n" );
679 $this->mFlags |
= DBO_TRX
;
680 if ( $wgDebugDBTransactions ) {
681 wfDebug( "Implicit transaction open enabled.\n" );
686 /** Get the default table prefix*/
687 if ( $tablePrefix == 'get from global' ) {
688 $this->mTablePrefix
= $wgDBprefix;
690 $this->mTablePrefix
= $tablePrefix;
694 $this->open( $server, $user, $password, $dbName );
699 * Called by serialize. Throw an exception when DB connection is serialized.
700 * This causes problems on some database engines because the connection is
701 * not restored on unserialize.
703 public function __sleep() {
704 throw new MWException( 'Database serialization may cause problems, since the connection is not restored on wakeup.' );
708 * Given a DB type, construct the name of the appropriate child class of
709 * DatabaseBase. This is designed to replace all of the manual stuff like:
710 * $class = 'Database' . ucfirst( strtolower( $type ) );
711 * as well as validate against the canonical list of DB types we have
713 * This factory function is mostly useful for when you need to connect to a
714 * database other than the MediaWiki default (such as for external auth,
715 * an extension, et cetera). Do not use this to connect to the MediaWiki
716 * database. Example uses in core:
717 * @see LoadBalancer::reallyOpenConnection()
718 * @see ForeignDBRepo::getMasterDB()
719 * @see WebInstaller_DBConnect::execute()
723 * @param string $dbType A possible DB type
724 * @param array $p An array of options to pass to the constructor.
725 * Valid options are: host, user, password, dbname, flags, tablePrefix
726 * @return DatabaseBase subclass or null
728 final public static function factory( $dbType, $p = array() ) {
729 $canonicalDBTypes = array(
730 'mysql', 'postgres', 'sqlite', 'oracle', 'mssql'
732 $dbType = strtolower( $dbType );
733 $class = 'Database' . ucfirst( $dbType );
735 if ( in_array( $dbType, $canonicalDBTypes ) ||
( class_exists( $class ) && is_subclass_of( $class, 'DatabaseBase' ) ) ) {
737 isset( $p['host'] ) ?
$p['host'] : false,
738 isset( $p['user'] ) ?
$p['user'] : false,
739 isset( $p['password'] ) ?
$p['password'] : false,
740 isset( $p['dbname'] ) ?
$p['dbname'] : false,
741 isset( $p['flags'] ) ?
$p['flags'] : 0,
742 isset( $p['tablePrefix'] ) ?
$p['tablePrefix'] : 'get from global'
749 protected function installErrorHandler() {
750 $this->mPHPError
= false;
751 $this->htmlErrors
= ini_set( 'html_errors', '0' );
752 set_error_handler( array( $this, 'connectionErrorHandler' ) );
756 * @return bool|string
758 protected function restoreErrorHandler() {
759 restore_error_handler();
760 if ( $this->htmlErrors
!== false ) {
761 ini_set( 'html_errors', $this->htmlErrors
);
763 if ( $this->mPHPError
) {
764 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->mPHPError
);
765 $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
777 public function connectionErrorHandler( $errno, $errstr ) {
778 $this->mPHPError
= $errstr;
782 * Closes a database connection.
783 * if it is open : commits any open transactions
785 * @throws MWException
786 * @return Bool operation success. true if already closed.
788 public function close() {
789 if ( count( $this->mTrxIdleCallbacks
) ) { // sanity
790 throw new MWException( "Transaction idle callbacks still pending." );
792 $this->mOpened
= false;
793 if ( $this->mConn
) {
794 if ( $this->trxLevel() ) {
795 if ( !$this->mTrxAutomatic
) {
796 wfWarn( "Transaction still in progress (from {$this->mTrxFname}), " .
797 " performing implicit commit before closing connection!" );
800 $this->commit( __METHOD__
, 'flush' );
803 $ret = $this->closeConnection();
804 $this->mConn
= false;
812 * Closes underlying database connection
814 * @return bool: Whether connection was closed successfully
816 abstract protected function closeConnection();
819 * @param string $error fallback error message, used if none is given by DB
820 * @throws DBConnectionError
822 function reportConnectionError( $error = 'Unknown error' ) {
823 $myError = $this->lastError();
829 throw new DBConnectionError( $this, $error );
833 * The DBMS-dependent part of query()
835 * @param $sql String: SQL query.
836 * @return ResultWrapper Result object to feed to fetchObject, fetchRow, ...; or false on failure
838 abstract protected function doQuery( $sql );
841 * Determine whether a query writes to the DB.
842 * Should return true if unsure.
848 public function isWriteQuery( $sql ) {
849 return !preg_match( '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SET|SHOW|EXPLAIN|\(SELECT)\b/i', $sql );
853 * Run an SQL query and return the result. Normally throws a DBQueryError
854 * on failure. If errors are ignored, returns false instead.
856 * In new code, the query wrappers select(), insert(), update(), delete(),
857 * etc. should be used where possible, since they give much better DBMS
858 * independence and automatically quote or validate user input in a variety
859 * of contexts. This function is generally only useful for queries which are
860 * explicitly DBMS-dependent and are unsupported by the query wrappers, such
863 * However, the query wrappers themselves should call this function.
865 * @param $sql String: SQL query
866 * @param $fname String: Name of the calling function, for profiling/SHOW PROCESSLIST
867 * comment (you can use __METHOD__ or add some extra info)
868 * @param $tempIgnore Boolean: Whether to avoid throwing an exception on errors...
869 * maybe best to catch the exception instead?
870 * @throws MWException
871 * @return boolean|ResultWrapper. true for a successful write query, ResultWrapper object
872 * for a successful read query, or false on failure if $tempIgnore set
874 public function query( $sql, $fname = '', $tempIgnore = false ) {
875 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
876 if ( !Profiler
::instance()->isStub() ) {
877 # generalizeSQL will probably cut down the query to reasonable
878 # logging size most of the time. The substr is really just a sanity check.
881 $queryProf = 'query-m: ' . substr( DatabaseBase
::generalizeSQL( $sql ), 0, 255 );
882 $totalProf = 'DatabaseBase::query-master';
884 $queryProf = 'query: ' . substr( DatabaseBase
::generalizeSQL( $sql ), 0, 255 );
885 $totalProf = 'DatabaseBase::query';
888 wfProfileIn( $totalProf );
889 wfProfileIn( $queryProf );
892 $this->mLastQuery
= $sql;
893 if ( !$this->mDoneWrites
&& $this->isWriteQuery( $sql ) ) {
894 # Set a flag indicating that writes have been done
895 wfDebug( __METHOD__
. ": Writes done: $sql\n" );
896 $this->mDoneWrites
= true;
899 # Add a comment for easy SHOW PROCESSLIST interpretation
901 if ( is_object( $wgUser ) && $wgUser->isItemLoaded( 'name' ) ) {
902 $userName = $wgUser->getName();
903 if ( mb_strlen( $userName ) > 15 ) {
904 $userName = mb_substr( $userName, 0, 15 ) . '...';
906 $userName = str_replace( '/', '', $userName );
911 // Add trace comment to the begin of the sql string, right after the operator.
912 // Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (bug 42598)
913 $commentedSql = preg_replace( '/\s|$/', " /* $fname $userName */ ", $sql, 1 );
915 # If DBO_TRX is set, start a transaction
916 if ( ( $this->mFlags
& DBO_TRX
) && !$this->mTrxLevel
&&
917 $sql != 'BEGIN' && $sql != 'COMMIT' && $sql != 'ROLLBACK' )
919 # Avoid establishing transactions for SHOW and SET statements too -
920 # that would delay transaction initializations to once connection
921 # is really used by application
922 $sqlstart = substr( $sql, 0, 10 ); // very much worth it, benchmark certified(tm)
923 if ( strpos( $sqlstart, "SHOW " ) !== 0 && strpos( $sqlstart, "SET " ) !== 0 ) {
924 global $wgDebugDBTransactions;
925 if ( $wgDebugDBTransactions ) {
926 wfDebug( "Implicit transaction start.\n" );
928 $this->begin( __METHOD__
. " ($fname)" );
929 $this->mTrxAutomatic
= true;
933 # Keep track of whether the transaction has write queries pending
934 if ( $this->mTrxLevel
&& !$this->mTrxDoneWrites
&& $this->isWriteQuery( $sql ) ) {
935 $this->mTrxDoneWrites
= true;
938 if ( $this->debug() ) {
942 $sqlx = substr( $commentedSql, 0, 500 );
943 $sqlx = strtr( $sqlx, "\t\n", ' ' );
945 $master = $isMaster ?
'master' : 'slave';
946 wfDebug( "Query {$this->mDBname} ($cnt) ($master): $sqlx\n" );
949 $queryId = MWDebug
::query( $sql, $fname, $isMaster );
951 # Do the query and handle errors
952 $ret = $this->doQuery( $commentedSql );
954 MWDebug
::queryTime( $queryId );
956 # Try reconnecting if the connection was lost
957 if ( false === $ret && $this->wasErrorReissuable() ) {
958 # Transaction is gone, like it or not
959 $this->mTrxLevel
= 0;
960 $this->mTrxIdleCallbacks
= array(); // cancel
961 $this->mTrxPreCommitCallbacks
= array(); // cancel
962 wfDebug( "Connection lost, reconnecting...\n" );
964 if ( $this->ping() ) {
965 wfDebug( "Reconnected\n" );
966 $sqlx = substr( $commentedSql, 0, 500 );
967 $sqlx = strtr( $sqlx, "\t\n", ' ' );
968 global $wgRequestTime;
969 $elapsed = round( microtime( true ) - $wgRequestTime, 3 );
970 if ( $elapsed < 300 ) {
971 # Not a database error to lose a transaction after a minute or two
972 wfLogDBError( "Connection lost and reconnected after {$elapsed}s, query: $sqlx\n" );
974 $ret = $this->doQuery( $commentedSql );
976 wfDebug( "Failed\n" );
980 if ( false === $ret ) {
981 $this->reportQueryError( $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
984 if ( !Profiler
::instance()->isStub() ) {
985 wfProfileOut( $queryProf );
986 wfProfileOut( $totalProf );
989 return $this->resultObject( $ret );
993 * Report a query error. Log the error, and if neither the object ignore
994 * flag nor the $tempIgnore flag is set, throw a DBQueryError.
996 * @param $error String
997 * @param $errno Integer
999 * @param $fname String
1000 * @param $tempIgnore Boolean
1001 * @throws DBQueryError
1003 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1004 # Ignore errors during error handling to avoid infinite recursion
1005 $ignore = $this->ignoreErrors( true );
1006 ++
$this->mErrorCount
;
1008 if ( $ignore ||
$tempIgnore ) {
1009 wfDebug( "SQL ERROR (ignored): $error\n" );
1010 $this->ignoreErrors( $ignore );
1012 $sql1line = str_replace( "\n", "\\n", $sql );
1013 wfLogDBError( "$fname\t{$this->mServer}\t$errno\t$error\t$sql1line\n" );
1014 wfDebug( "SQL ERROR: " . $error . "\n" );
1015 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
1020 * Intended to be compatible with the PEAR::DB wrapper functions.
1021 * http://pear.php.net/manual/en/package.database.db.intro-execute.php
1023 * ? = scalar value, quoted as necessary
1024 * ! = raw SQL bit (a function for instance)
1025 * & = filename; reads the file and inserts as a blob
1026 * (we don't use this though...)
1028 * @param $sql string
1029 * @param $func string
1033 protected function prepare( $sql, $func = 'DatabaseBase::prepare' ) {
1034 /* MySQL doesn't support prepared statements (yet), so just
1035 pack up the query for reference. We'll manually replace
1037 return array( 'query' => $sql, 'func' => $func );
1041 * Free a prepared query, generated by prepare().
1044 protected function freePrepared( $prepared ) {
1045 /* No-op by default */
1049 * Execute a prepared query with the various arguments
1050 * @param string $prepared the prepared sql
1051 * @param $args Mixed: Either an array here, or put scalars as varargs
1053 * @return ResultWrapper
1055 public function execute( $prepared, $args = null ) {
1056 if ( !is_array( $args ) ) {
1058 $args = func_get_args();
1059 array_shift( $args );
1062 $sql = $this->fillPrepared( $prepared['query'], $args );
1064 return $this->query( $sql, $prepared['func'] );
1068 * For faking prepared SQL statements on DBs that don't support it directly.
1070 * @param string $preparedQuery a 'preparable' SQL statement
1071 * @param array $args of arguments to fill it with
1072 * @return string executable SQL
1074 public function fillPrepared( $preparedQuery, $args ) {
1076 $this->preparedArgs
=& $args;
1078 return preg_replace_callback( '/(\\\\[?!&]|[?!&])/',
1079 array( &$this, 'fillPreparedArg' ), $preparedQuery );
1083 * preg_callback func for fillPrepared()
1084 * The arguments should be in $this->preparedArgs and must not be touched
1085 * while we're doing this.
1087 * @param $matches Array
1088 * @throws DBUnexpectedError
1091 protected function fillPreparedArg( $matches ) {
1092 switch ( $matches[1] ) {
1101 list( /* $n */, $arg ) = each( $this->preparedArgs
);
1103 switch ( $matches[1] ) {
1105 return $this->addQuotes( $arg );
1109 # return $this->addQuotes( file_get_contents( $arg ) );
1110 throw new DBUnexpectedError( $this, '& mode is not implemented. If it\'s really needed, uncomment the line above.' );
1112 throw new DBUnexpectedError( $this, 'Received invalid match. This should never happen!' );
1117 * Free a result object returned by query() or select(). It's usually not
1118 * necessary to call this, just use unset() or let the variable holding
1119 * the result object go out of scope.
1121 * @param $res Mixed: A SQL result
1123 public function freeResult( $res ) {
1127 * A SELECT wrapper which returns a single field from a single result row.
1129 * Usually throws a DBQueryError on failure. If errors are explicitly
1130 * ignored, returns false on failure.
1132 * If no result rows are returned from the query, false is returned.
1134 * @param string|array $table Table name. See DatabaseBase::select() for details.
1135 * @param string $var The field name to select. This must be a valid SQL
1136 * fragment: do not use unvalidated user input.
1137 * @param string|array $cond The condition array. See DatabaseBase::select() for details.
1138 * @param string $fname The function name of the caller.
1139 * @param string|array $options The query options. See DatabaseBase::select() for details.
1141 * @return bool|mixed The value from the field, or false on failure.
1143 public function selectField( $table, $var, $cond = '', $fname = 'DatabaseBase::selectField',
1146 if ( !is_array( $options ) ) {
1147 $options = array( $options );
1150 $options['LIMIT'] = 1;
1152 $res = $this->select( $table, $var, $cond, $fname, $options );
1154 if ( $res === false ||
!$this->numRows( $res ) ) {
1158 $row = $this->fetchRow( $res );
1160 if ( $row !== false ) {
1161 return reset( $row );
1168 * Returns an optional USE INDEX clause to go after the table, and a
1169 * string to go at the end of the query.
1171 * @param array $options associative array of options to be turned into
1172 * an SQL query, valid keys are listed in the function.
1174 * @see DatabaseBase::select()
1176 public function makeSelectOptions( $options ) {
1177 $preLimitTail = $postLimitTail = '';
1180 $noKeyOptions = array();
1182 foreach ( $options as $key => $option ) {
1183 if ( is_numeric( $key ) ) {
1184 $noKeyOptions[$option] = true;
1188 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1190 $preLimitTail .= $this->makeOrderBy( $options );
1192 // if (isset($options['LIMIT'])) {
1193 // $tailOpts .= $this->limitResult('', $options['LIMIT'],
1194 // isset($options['OFFSET']) ? $options['OFFSET']
1198 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1199 $postLimitTail .= ' FOR UPDATE';
1202 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1203 $postLimitTail .= ' LOCK IN SHARE MODE';
1206 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) {
1207 $startOpts .= 'DISTINCT';
1210 # Various MySQL extensions
1211 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1212 $startOpts .= ' /*! STRAIGHT_JOIN */';
1215 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1216 $startOpts .= ' HIGH_PRIORITY';
1219 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1220 $startOpts .= ' SQL_BIG_RESULT';
1223 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1224 $startOpts .= ' SQL_BUFFER_RESULT';
1227 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1228 $startOpts .= ' SQL_SMALL_RESULT';
1231 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1232 $startOpts .= ' SQL_CALC_FOUND_ROWS';
1235 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1236 $startOpts .= ' SQL_CACHE';
1239 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1240 $startOpts .= ' SQL_NO_CACHE';
1243 if ( isset( $options['USE INDEX'] ) && ! is_array( $options['USE INDEX'] ) ) {
1244 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1249 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1253 * Returns an optional GROUP BY with an optional HAVING
1255 * @param array $options associative array of options
1257 * @see DatabaseBase::select()
1260 public function makeGroupByWithHaving( $options ) {
1262 if ( isset( $options['GROUP BY'] ) ) {
1263 $gb = is_array( $options['GROUP BY'] )
1264 ?
implode( ',', $options['GROUP BY'] )
1265 : $options['GROUP BY'];
1266 $sql .= ' GROUP BY ' . $gb;
1268 if ( isset( $options['HAVING'] ) ) {
1269 $having = is_array( $options['HAVING'] )
1270 ?
$this->makeList( $options['HAVING'], LIST_AND
)
1271 : $options['HAVING'];
1272 $sql .= ' HAVING ' . $having;
1278 * Returns an optional ORDER BY
1280 * @param array $options associative array of options
1282 * @see DatabaseBase::select()
1285 public function makeOrderBy( $options ) {
1286 if ( isset( $options['ORDER BY'] ) ) {
1287 $ob = is_array( $options['ORDER BY'] )
1288 ?
implode( ',', $options['ORDER BY'] )
1289 : $options['ORDER BY'];
1290 return ' ORDER BY ' . $ob;
1296 * Execute a SELECT query constructed using the various parameters provided.
1297 * See below for full details of the parameters.
1299 * @param string|array $table Table name
1300 * @param string|array $vars Field names
1301 * @param string|array $conds Conditions
1302 * @param string $fname Caller function name
1303 * @param array $options Query options
1304 * @param $join_conds Array Join conditions
1306 * @param $table string|array
1308 * May be either an array of table names, or a single string holding a table
1309 * name. If an array is given, table aliases can be specified, for example:
1311 * array( 'a' => 'user' )
1313 * This includes the user table in the query, with the alias "a" available
1314 * for use in field names (e.g. a.user_name).
1316 * All of the table names given here are automatically run through
1317 * DatabaseBase::tableName(), which causes the table prefix (if any) to be
1318 * added, and various other table name mappings to be performed.
1321 * @param $vars string|array
1323 * May be either a field name or an array of field names. The field names
1324 * can be complete fragments of SQL, for direct inclusion into the SELECT
1325 * query. If an array is given, field aliases can be specified, for example:
1327 * array( 'maxrev' => 'MAX(rev_id)' )
1329 * This includes an expression with the alias "maxrev" in the query.
1331 * If an expression is given, care must be taken to ensure that it is
1335 * @param $conds string|array
1337 * May be either a string containing a single condition, or an array of
1338 * conditions. If an array is given, the conditions constructed from each
1339 * element are combined with AND.
1341 * Array elements may take one of two forms:
1343 * - Elements with a numeric key are interpreted as raw SQL fragments.
1344 * - Elements with a string key are interpreted as equality conditions,
1345 * where the key is the field name.
1346 * - If the value of such an array element is a scalar (such as a
1347 * string), it will be treated as data and thus quoted appropriately.
1348 * If it is null, an IS NULL clause will be added.
1349 * - If the value is an array, an IN(...) clause will be constructed,
1350 * such that the field name may match any of the elements in the
1351 * array. The elements of the array will be quoted.
1353 * Note that expressions are often DBMS-dependent in their syntax.
1354 * DBMS-independent wrappers are provided for constructing several types of
1355 * expression commonly used in condition queries. See:
1356 * - DatabaseBase::buildLike()
1357 * - DatabaseBase::conditional()
1360 * @param $options string|array
1362 * Optional: Array of query options. Boolean options are specified by
1363 * including them in the array as a string value with a numeric key, for
1366 * array( 'FOR UPDATE' )
1368 * The supported options are:
1370 * - OFFSET: Skip this many rows at the start of the result set. OFFSET
1371 * with LIMIT can theoretically be used for paging through a result set,
1372 * but this is discouraged in MediaWiki for performance reasons.
1374 * - LIMIT: Integer: return at most this many rows. The rows are sorted
1375 * and then the first rows are taken until the limit is reached. LIMIT
1376 * is applied to a result set after OFFSET.
1378 * - FOR UPDATE: Boolean: lock the returned rows so that they can't be
1379 * changed until the next COMMIT.
1381 * - DISTINCT: Boolean: return only unique result rows.
1383 * - GROUP BY: May be either an SQL fragment string naming a field or
1384 * expression to group by, or an array of such SQL fragments.
1386 * - HAVING: May be either an string containing a HAVING clause or an array of
1387 * conditions building the HAVING clause. If an array is given, the conditions
1388 * constructed from each element are combined with AND.
1390 * - ORDER BY: May be either an SQL fragment giving a field name or
1391 * expression to order by, or an array of such SQL fragments.
1393 * - USE INDEX: This may be either a string giving the index name to use
1394 * for the query, or an array. If it is an associative array, each key
1395 * gives the table name (or alias), each value gives the index name to
1396 * use for that table. All strings are SQL fragments and so should be
1397 * validated by the caller.
1399 * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run,
1400 * instead of SELECT.
1402 * And also the following boolean MySQL extensions, see the MySQL manual
1403 * for documentation:
1405 * - LOCK IN SHARE MODE
1409 * - SQL_BUFFER_RESULT
1410 * - SQL_SMALL_RESULT
1411 * - SQL_CALC_FOUND_ROWS
1416 * @param $join_conds string|array
1418 * Optional associative array of table-specific join conditions. In the
1419 * most common case, this is unnecessary, since the join condition can be
1420 * in $conds. However, it is useful for doing a LEFT JOIN.
1422 * The key of the array contains the table name or alias. The value is an
1423 * array with two elements, numbered 0 and 1. The first gives the type of
1424 * join, the second is an SQL fragment giving the join condition for that
1425 * table. For example:
1427 * array( 'page' => array( 'LEFT JOIN', 'page_latest=rev_id' ) )
1429 * @return ResultWrapper. If the query returned no rows, a ResultWrapper
1430 * with no rows in it will be returned. If there was a query error, a
1431 * DBQueryError exception will be thrown, except if the "ignore errors"
1432 * option was set, in which case false will be returned.
1434 public function select( $table, $vars, $conds = '', $fname = 'DatabaseBase::select',
1435 $options = array(), $join_conds = array() ) {
1436 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1438 return $this->query( $sql, $fname );
1442 * The equivalent of DatabaseBase::select() except that the constructed SQL
1443 * is returned, instead of being immediately executed. This can be useful for
1444 * doing UNION queries, where the SQL text of each query is needed. In general,
1445 * however, callers outside of Database classes should just use select().
1447 * @param string|array $table Table name
1448 * @param string|array $vars Field names
1449 * @param string|array $conds Conditions
1450 * @param string $fname Caller function name
1451 * @param string|array $options Query options
1452 * @param $join_conds string|array Join conditions
1454 * @return string SQL query string.
1455 * @see DatabaseBase::select()
1457 public function selectSQLText( $table, $vars, $conds = '', $fname = 'DatabaseBase::select',
1458 $options = array(), $join_conds = array() )
1460 if ( is_array( $vars ) ) {
1461 $vars = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1464 $options = (array)$options;
1466 if ( is_array( $table ) ) {
1467 $useIndex = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1468 ?
$options['USE INDEX']
1470 if ( count( $join_conds ) ||
count( $useIndex ) ) {
1472 $this->tableNamesWithUseIndexOrJOIN( $table, $useIndex, $join_conds );
1474 $from = ' FROM ' . implode( ',', $this->tableNamesWithAlias( $table ) );
1476 } elseif ( $table != '' ) {
1477 if ( $table[0] == ' ' ) {
1478 $from = ' FROM ' . $table;
1480 $from = ' FROM ' . $this->tableName( $table );
1486 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail ) = $this->makeSelectOptions( $options );
1488 if ( !empty( $conds ) ) {
1489 if ( is_array( $conds ) ) {
1490 $conds = $this->makeList( $conds, LIST_AND
);
1492 $sql = "SELECT $startOpts $vars $from $useIndex WHERE $conds $preLimitTail";
1494 $sql = "SELECT $startOpts $vars $from $useIndex $preLimitTail";
1497 if ( isset( $options['LIMIT'] ) ) {
1498 $sql = $this->limitResult( $sql, $options['LIMIT'],
1499 isset( $options['OFFSET'] ) ?
$options['OFFSET'] : false );
1501 $sql = "$sql $postLimitTail";
1503 if ( isset( $options['EXPLAIN'] ) ) {
1504 $sql = 'EXPLAIN ' . $sql;
1511 * Single row SELECT wrapper. Equivalent to DatabaseBase::select(), except
1512 * that a single row object is returned. If the query returns no rows,
1513 * false is returned.
1515 * @param string|array $table Table name
1516 * @param string|array $vars Field names
1517 * @param array $conds Conditions
1518 * @param string $fname Caller function name
1519 * @param string|array $options Query options
1520 * @param $join_conds array|string Join conditions
1522 * @return object|bool
1524 public function selectRow( $table, $vars, $conds, $fname = 'DatabaseBase::selectRow',
1525 $options = array(), $join_conds = array() )
1527 $options = (array)$options;
1528 $options['LIMIT'] = 1;
1529 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1531 if ( $res === false ) {
1535 if ( !$this->numRows( $res ) ) {
1539 $obj = $this->fetchObject( $res );
1545 * Estimate rows in dataset.
1547 * MySQL allows you to estimate the number of rows that would be returned
1548 * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using
1549 * index cardinality statistics, and is notoriously inaccurate, especially
1550 * when large numbers of rows have recently been added or deleted.
1552 * For DBMSs that don't support fast result size estimation, this function
1553 * will actually perform the SELECT COUNT(*).
1555 * Takes the same arguments as DatabaseBase::select().
1557 * @param string $table table name
1558 * @param array|string $vars : unused
1559 * @param array|string $conds : filters on the table
1560 * @param string $fname function name for profiling
1561 * @param array $options options for select
1562 * @return Integer: row count
1564 public function estimateRowCount( $table, $vars = '*', $conds = '',
1565 $fname = 'DatabaseBase::estimateRowCount', $options = array() )
1568 $res = $this->select( $table, array( 'rowcount' => 'COUNT(*)' ), $conds, $fname, $options );
1571 $row = $this->fetchRow( $res );
1572 $rows = ( isset( $row['rowcount'] ) ) ?
$row['rowcount'] : 0;
1579 * Removes most variables from an SQL query and replaces them with X or N for numbers.
1580 * It's only slightly flawed. Don't use for anything important.
1582 * @param string $sql A SQL Query
1586 static function generalizeSQL( $sql ) {
1587 # This does the same as the regexp below would do, but in such a way
1588 # as to avoid crashing php on some large strings.
1589 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
1591 $sql = str_replace( "\\\\", '', $sql );
1592 $sql = str_replace( "\\'", '', $sql );
1593 $sql = str_replace( "\\\"", '', $sql );
1594 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
1595 $sql = preg_replace( '/".*"/s', "'X'", $sql );
1597 # All newlines, tabs, etc replaced by single space
1598 $sql = preg_replace( '/\s+/', ' ', $sql );
1601 $sql = preg_replace( '/-?[0-9]+/s', 'N', $sql );
1607 * Determines whether a field exists in a table
1609 * @param string $table table name
1610 * @param string $field filed to check on that table
1611 * @param string $fname calling function name (optional)
1612 * @return Boolean: whether $table has filed $field
1614 public function fieldExists( $table, $field, $fname = 'DatabaseBase::fieldExists' ) {
1615 $info = $this->fieldInfo( $table, $field );
1621 * Determines whether an index exists
1622 * Usually throws a DBQueryError on failure
1623 * If errors are explicitly ignored, returns NULL on failure
1627 * @param $fname string
1631 public function indexExists( $table, $index, $fname = 'DatabaseBase::indexExists' ) {
1632 if ( !$this->tableExists( $table ) ) {
1636 $info = $this->indexInfo( $table, $index, $fname );
1637 if ( is_null( $info ) ) {
1640 return $info !== false;
1645 * Query whether a given table exists
1647 * @param $table string
1648 * @param $fname string
1652 public function tableExists( $table, $fname = __METHOD__
) {
1653 $table = $this->tableName( $table );
1654 $old = $this->ignoreErrors( true );
1655 $res = $this->query( "SELECT 1 FROM $table LIMIT 1", $fname );
1656 $this->ignoreErrors( $old );
1662 * mysql_field_type() wrapper
1667 public function fieldType( $res, $index ) {
1668 if ( $res instanceof ResultWrapper
) {
1669 $res = $res->result
;
1672 return mysql_field_type( $res, $index );
1676 * Determines if a given index is unique
1678 * @param $table string
1679 * @param $index string
1683 public function indexUnique( $table, $index ) {
1684 $indexInfo = $this->indexInfo( $table, $index );
1686 if ( !$indexInfo ) {
1690 return !$indexInfo[0]->Non_unique
;
1694 * Helper for DatabaseBase::insert().
1696 * @param $options array
1699 protected function makeInsertOptions( $options ) {
1700 return implode( ' ', $options );
1704 * INSERT wrapper, inserts an array into a table.
1708 * - A single associative array. The array keys are the field names, and
1709 * the values are the values to insert. The values are treated as data
1710 * and will be quoted appropriately. If NULL is inserted, this will be
1711 * converted to a database NULL.
1712 * - An array with numeric keys, holding a list of associative arrays.
1713 * This causes a multi-row INSERT on DBMSs that support it. The keys in
1714 * each subarray must be identical to each other, and in the same order.
1716 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
1719 * $options is an array of options, with boolean options encoded as values
1720 * with numeric keys, in the same style as $options in
1721 * DatabaseBase::select(). Supported options are:
1723 * - IGNORE: Boolean: if present, duplicate key errors are ignored, and
1724 * any rows which cause duplicate key errors are not inserted. It's
1725 * possible to determine how many rows were successfully inserted using
1726 * DatabaseBase::affectedRows().
1728 * @param $table String Table name. This will be passed through
1729 * DatabaseBase::tableName().
1730 * @param $a Array of rows to insert
1731 * @param $fname String Calling function name (use __METHOD__) for logs/profiling
1732 * @param array $options of options
1736 public function insert( $table, $a, $fname = 'DatabaseBase::insert', $options = array() ) {
1737 # No rows to insert, easy just return now
1738 if ( !count( $a ) ) {
1742 $table = $this->tableName( $table );
1744 if ( !is_array( $options ) ) {
1745 $options = array( $options );
1749 if ( isset( $options['fileHandle'] ) ) {
1750 $fh = $options['fileHandle'];
1752 $options = $this->makeInsertOptions( $options );
1754 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
1756 $keys = array_keys( $a[0] );
1759 $keys = array_keys( $a );
1762 $sql = 'INSERT ' . $options .
1763 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
1767 foreach ( $a as $row ) {
1773 $sql .= '(' . $this->makeList( $row ) . ')';
1776 $sql .= '(' . $this->makeList( $a ) . ')';
1779 if ( $fh !== null && false === fwrite( $fh, $sql ) ) {
1781 } elseif ( $fh !== null ) {
1785 return (bool)$this->query( $sql, $fname );
1789 * Make UPDATE options for the DatabaseBase::update function
1791 * @param array $options The options passed to DatabaseBase::update
1794 protected function makeUpdateOptions( $options ) {
1795 if ( !is_array( $options ) ) {
1796 $options = array( $options );
1801 if ( in_array( 'LOW_PRIORITY', $options ) ) {
1802 $opts[] = $this->lowPriorityOption();
1805 if ( in_array( 'IGNORE', $options ) ) {
1809 return implode( ' ', $opts );
1813 * UPDATE wrapper. Takes a condition array and a SET array.
1815 * @param $table String name of the table to UPDATE. This will be passed through
1816 * DatabaseBase::tableName().
1818 * @param array $values An array of values to SET. For each array element,
1819 * the key gives the field name, and the value gives the data
1820 * to set that field to. The data will be quoted by
1821 * DatabaseBase::addQuotes().
1823 * @param $conds Array: An array of conditions (WHERE). See
1824 * DatabaseBase::select() for the details of the format of
1825 * condition arrays. Use '*' to update all rows.
1827 * @param $fname String: The function name of the caller (from __METHOD__),
1828 * for logging and profiling.
1830 * @param array $options An array of UPDATE options, can be:
1831 * - IGNORE: Ignore unique key conflicts
1832 * - LOW_PRIORITY: MySQL-specific, see MySQL manual.
1835 function update( $table, $values, $conds, $fname = 'DatabaseBase::update', $options = array() ) {
1836 $table = $this->tableName( $table );
1837 $opts = $this->makeUpdateOptions( $options );
1838 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, LIST_SET
);
1840 if ( $conds !== array() && $conds !== '*' ) {
1841 $sql .= " WHERE " . $this->makeList( $conds, LIST_AND
);
1844 return $this->query( $sql, $fname );
1848 * Makes an encoded list of strings from an array
1849 * @param array $a containing the data
1850 * @param int $mode Constant
1851 * - LIST_COMMA: comma separated, no field names
1852 * - LIST_AND: ANDed WHERE clause (without the WHERE). See
1853 * the documentation for $conds in DatabaseBase::select().
1854 * - LIST_OR: ORed WHERE clause (without the WHERE)
1855 * - LIST_SET: comma separated with field names, like a SET clause
1856 * - LIST_NAMES: comma separated field names
1858 * @throws MWException|DBUnexpectedError
1861 public function makeList( $a, $mode = LIST_COMMA
) {
1862 if ( !is_array( $a ) ) {
1863 throw new DBUnexpectedError( $this, 'DatabaseBase::makeList called with incorrect parameters' );
1869 foreach ( $a as $field => $value ) {
1871 if ( $mode == LIST_AND
) {
1873 } elseif ( $mode == LIST_OR
) {
1882 if ( ( $mode == LIST_AND ||
$mode == LIST_OR
) && is_numeric( $field ) ) {
1883 $list .= "($value)";
1884 } elseif ( ( $mode == LIST_SET
) && is_numeric( $field ) ) {
1886 } elseif ( ( $mode == LIST_AND ||
$mode == LIST_OR
) && is_array( $value ) ) {
1887 if ( count( $value ) == 0 ) {
1888 throw new MWException( __METHOD__
. ": empty input for field $field" );
1889 } elseif ( count( $value ) == 1 ) {
1890 // Special-case single values, as IN isn't terribly efficient
1891 // Don't necessarily assume the single key is 0; we don't
1892 // enforce linear numeric ordering on other arrays here.
1893 $value = array_values( $value );
1894 $list .= $field . " = " . $this->addQuotes( $value[0] );
1896 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
1898 } elseif ( $value === null ) {
1899 if ( $mode == LIST_AND ||
$mode == LIST_OR
) {
1900 $list .= "$field IS ";
1901 } elseif ( $mode == LIST_SET
) {
1902 $list .= "$field = ";
1906 if ( $mode == LIST_AND ||
$mode == LIST_OR ||
$mode == LIST_SET
) {
1907 $list .= "$field = ";
1909 $list .= $mode == LIST_NAMES ?
$value : $this->addQuotes( $value );
1917 * Build a partial where clause from a 2-d array such as used for LinkBatch.
1918 * The keys on each level may be either integers or strings.
1920 * @param array $data organized as 2-d
1921 * array(baseKeyVal => array(subKeyVal => [ignored], ...), ...)
1922 * @param string $baseKey field name to match the base-level keys to (eg 'pl_namespace')
1923 * @param string $subKey field name to match the sub-level keys to (eg 'pl_title')
1924 * @return Mixed: string SQL fragment, or false if no items in array.
1926 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
1929 foreach ( $data as $base => $sub ) {
1930 if ( count( $sub ) ) {
1931 $conds[] = $this->makeList(
1932 array( $baseKey => $base, $subKey => array_keys( $sub ) ),
1938 return $this->makeList( $conds, LIST_OR
);
1940 // Nothing to search for...
1946 * Return aggregated value alias
1949 * @param $valuename string
1953 public function aggregateValue( $valuedata, $valuename = 'value' ) {
1961 public function bitNot( $field ) {
1967 * @param $fieldRight
1970 public function bitAnd( $fieldLeft, $fieldRight ) {
1971 return "($fieldLeft & $fieldRight)";
1976 * @param $fieldRight
1979 public function bitOr( $fieldLeft, $fieldRight ) {
1980 return "($fieldLeft | $fieldRight)";
1984 * Build a concatenation list to feed into a SQL query
1985 * @param array $stringList list of raw SQL expressions; caller is responsible for any quoting
1988 public function buildConcat( $stringList ) {
1989 return 'CONCAT(' . implode( ',', $stringList ) . ')';
1993 * Change the current database
1995 * @todo Explain what exactly will fail if this is not overridden.
1999 * @return bool Success or failure
2001 public function selectDB( $db ) {
2002 # Stub. Shouldn't cause serious problems if it's not overridden, but
2003 # if your database engine supports a concept similar to MySQL's
2004 # databases you may as well.
2005 $this->mDBname
= $db;
2010 * Get the current DB name
2012 public function getDBname() {
2013 return $this->mDBname
;
2017 * Get the server hostname or IP address
2019 public function getServer() {
2020 return $this->mServer
;
2024 * Format a table name ready for use in constructing an SQL query
2026 * This does two important things: it quotes the table names to clean them up,
2027 * and it adds a table prefix if only given a table name with no quotes.
2029 * All functions of this object which require a table name call this function
2030 * themselves. Pass the canonical name to such functions. This is only needed
2031 * when calling query() directly.
2033 * @param string $name database table name
2034 * @param string $format One of:
2035 * quoted - Automatically pass the table name through addIdentifierQuotes()
2036 * so that it can be used in a query.
2037 * raw - Do not add identifier quotes to the table name
2038 * @return String: full database name
2040 public function tableName( $name, $format = 'quoted' ) {
2041 global $wgSharedDB, $wgSharedPrefix, $wgSharedTables;
2042 # Skip the entire process when we have a string quoted on both ends.
2043 # Note that we check the end so that we will still quote any use of
2044 # use of `database`.table. But won't break things if someone wants
2045 # to query a database table with a dot in the name.
2046 if ( $this->isQuotedIdentifier( $name ) ) {
2050 # Lets test for any bits of text that should never show up in a table
2051 # name. Basically anything like JOIN or ON which are actually part of
2052 # SQL queries, but may end up inside of the table value to combine
2053 # sql. Such as how the API is doing.
2054 # Note that we use a whitespace test rather than a \b test to avoid
2055 # any remote case where a word like on may be inside of a table name
2056 # surrounded by symbols which may be considered word breaks.
2057 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
2061 # Split database and table into proper variables.
2062 # We reverse the explode so that database.table and table both output
2063 # the correct table.
2064 $dbDetails = explode( '.', $name, 2 );
2065 if ( count( $dbDetails ) == 2 ) {
2066 list( $database, $table ) = $dbDetails;
2067 # We don't want any prefix added in this case
2070 list( $table ) = $dbDetails;
2071 if ( $wgSharedDB !== null # We have a shared database
2072 && !$this->isQuotedIdentifier( $table ) # Paranoia check to prevent shared tables listing '`table`'
2073 && in_array( $table, $wgSharedTables ) # A shared table is selected
2075 $database = $wgSharedDB;
2076 $prefix = $wgSharedPrefix === null ?
$this->mTablePrefix
: $wgSharedPrefix;
2079 $prefix = $this->mTablePrefix
; # Default prefix
2083 # Quote $table and apply the prefix if not quoted.
2084 $tableName = "{$prefix}{$table}";
2085 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $tableName ) ) {
2086 $tableName = $this->addIdentifierQuotes( $tableName );
2089 # Quote $database and merge it with the table name if needed
2090 if ( $database !== null ) {
2091 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $database ) ) {
2092 $database = $this->addIdentifierQuotes( $database );
2094 $tableName = $database . '.' . $tableName;
2101 * Fetch a number of table names into an array
2102 * This is handy when you need to construct SQL for joins
2105 * extract( $dbr->tableNames( 'user', 'watchlist' ) );
2106 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
2107 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
2111 public function tableNames() {
2112 $inArray = func_get_args();
2115 foreach ( $inArray as $name ) {
2116 $retVal[$name] = $this->tableName( $name );
2123 * Fetch a number of table names into an zero-indexed numerical array
2124 * This is handy when you need to construct SQL for joins
2127 * list( $user, $watchlist ) = $dbr->tableNamesN( 'user', 'watchlist' );
2128 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
2129 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
2133 public function tableNamesN() {
2134 $inArray = func_get_args();
2137 foreach ( $inArray as $name ) {
2138 $retVal[] = $this->tableName( $name );
2145 * Get an aliased table name
2146 * e.g. tableName AS newTableName
2148 * @param string $name Table name, see tableName()
2149 * @param string|bool $alias Alias (optional)
2150 * @return string SQL name for aliased table. Will not alias a table to its own name
2152 public function tableNameWithAlias( $name, $alias = false ) {
2153 if ( !$alias ||
$alias == $name ) {
2154 return $this->tableName( $name );
2156 return $this->tableName( $name ) . ' ' . $this->addIdentifierQuotes( $alias );
2161 * Gets an array of aliased table names
2163 * @param $tables array( [alias] => table )
2164 * @return array of strings, see tableNameWithAlias()
2166 public function tableNamesWithAlias( $tables ) {
2168 foreach ( $tables as $alias => $table ) {
2169 if ( is_numeric( $alias ) ) {
2172 $retval[] = $this->tableNameWithAlias( $table, $alias );
2178 * Get an aliased field name
2179 * e.g. fieldName AS newFieldName
2181 * @param string $name Field name
2182 * @param string|bool $alias Alias (optional)
2183 * @return string SQL name for aliased field. Will not alias a field to its own name
2185 public function fieldNameWithAlias( $name, $alias = false ) {
2186 if ( !$alias ||
(string)$alias === (string)$name ) {
2189 return $name . ' AS ' . $alias; //PostgreSQL needs AS
2194 * Gets an array of aliased field names
2196 * @param $fields array( [alias] => field )
2197 * @return array of strings, see fieldNameWithAlias()
2199 public function fieldNamesWithAlias( $fields ) {
2201 foreach ( $fields as $alias => $field ) {
2202 if ( is_numeric( $alias ) ) {
2205 $retval[] = $this->fieldNameWithAlias( $field, $alias );
2211 * Get the aliased table name clause for a FROM clause
2212 * which might have a JOIN and/or USE INDEX clause
2214 * @param array $tables ( [alias] => table )
2215 * @param $use_index array Same as for select()
2216 * @param $join_conds array Same as for select()
2219 protected function tableNamesWithUseIndexOrJOIN(
2220 $tables, $use_index = array(), $join_conds = array()
2224 $use_index = (array)$use_index;
2225 $join_conds = (array)$join_conds;
2227 foreach ( $tables as $alias => $table ) {
2228 if ( !is_string( $alias ) ) {
2229 // No alias? Set it equal to the table name
2232 // Is there a JOIN clause for this table?
2233 if ( isset( $join_conds[$alias] ) ) {
2234 list( $joinType, $conds ) = $join_conds[$alias];
2235 $tableClause = $joinType;
2236 $tableClause .= ' ' . $this->tableNameWithAlias( $table, $alias );
2237 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2238 $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2240 $tableClause .= ' ' . $use;
2243 $on = $this->makeList( (array)$conds, LIST_AND
);
2245 $tableClause .= ' ON (' . $on . ')';
2248 $retJOIN[] = $tableClause;
2249 // Is there an INDEX clause for this table?
2250 } elseif ( isset( $use_index[$alias] ) ) {
2251 $tableClause = $this->tableNameWithAlias( $table, $alias );
2252 $tableClause .= ' ' . $this->useIndexClause(
2253 implode( ',', (array)$use_index[$alias] ) );
2255 $ret[] = $tableClause;
2257 $tableClause = $this->tableNameWithAlias( $table, $alias );
2259 $ret[] = $tableClause;
2263 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2264 $straightJoins = !empty( $ret ) ?
implode( ',', $ret ) : "";
2265 $otherJoins = !empty( $retJOIN ) ?
implode( ' ', $retJOIN ) : "";
2267 // Compile our final table clause
2268 return implode( ' ', array( $straightJoins, $otherJoins ) );
2272 * Get the name of an index in a given table
2278 protected function indexName( $index ) {
2279 // Backwards-compatibility hack
2281 'ar_usertext_timestamp' => 'usertext_timestamp',
2282 'un_user_id' => 'user_id',
2283 'un_user_ip' => 'user_ip',
2286 if ( isset( $renamed[$index] ) ) {
2287 return $renamed[$index];
2294 * If it's a string, adds quotes and backslashes
2295 * Otherwise returns as-is
2301 public function addQuotes( $s ) {
2302 if ( $s === null ) {
2305 # This will also quote numeric values. This should be harmless,
2306 # and protects against weird problems that occur when they really
2307 # _are_ strings such as article titles and string->number->string
2308 # conversion is not 1:1.
2309 return "'" . $this->strencode( $s ) . "'";
2314 * Quotes an identifier using `backticks` or "double quotes" depending on the database type.
2315 * MySQL uses `backticks` while basically everything else uses double quotes.
2316 * Since MySQL is the odd one out here the double quotes are our generic
2317 * and we implement backticks in DatabaseMysql.
2323 public function addIdentifierQuotes( $s ) {
2324 return '"' . str_replace( '"', '""', $s ) . '"';
2328 * Returns if the given identifier looks quoted or not according to
2329 * the database convention for quoting identifiers .
2331 * @param $name string
2335 public function isQuotedIdentifier( $name ) {
2336 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2343 protected function escapeLikeInternal( $s ) {
2344 $s = str_replace( '\\', '\\\\', $s );
2345 $s = $this->strencode( $s );
2346 $s = str_replace( array( '%', '_' ), array( '\%', '\_' ), $s );
2352 * LIKE statement wrapper, receives a variable-length argument list with parts of pattern to match
2353 * containing either string literals that will be escaped or tokens returned by anyChar() or anyString().
2354 * Alternatively, the function could be provided with an array of aforementioned parameters.
2356 * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns a LIKE clause that searches
2357 * for subpages of 'My page title'.
2358 * Alternatively: $pattern = array( 'My_page_title/', $dbr->anyString() ); $query .= $dbr->buildLike( $pattern );
2361 * @return String: fully built LIKE statement
2363 public function buildLike() {
2364 $params = func_get_args();
2366 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2367 $params = $params[0];
2372 foreach ( $params as $value ) {
2373 if ( $value instanceof LikeMatch
) {
2374 $s .= $value->toString();
2376 $s .= $this->escapeLikeInternal( $value );
2380 return " LIKE '" . $s . "' ";
2384 * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
2388 public function anyChar() {
2389 return new LikeMatch( '_' );
2393 * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
2397 public function anyString() {
2398 return new LikeMatch( '%' );
2402 * Returns an appropriately quoted sequence value for inserting a new row.
2403 * MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
2404 * subclass will return an integer, and save the value for insertId()
2406 * Any implementation of this function should *not* involve reusing
2407 * sequence numbers created for rolled-back transactions.
2408 * See http://bugs.mysql.com/bug.php?id=30767 for details.
2409 * @param $seqName string
2412 public function nextSequenceValue( $seqName ) {
2417 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2418 * is only needed because a) MySQL must be as efficient as possible due to
2419 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2420 * which index to pick. Anyway, other databases might have different
2421 * indexes on a given table. So don't bother overriding this unless you're
2426 public function useIndexClause( $index ) {
2431 * REPLACE query wrapper.
2433 * REPLACE is a very handy MySQL extension, which functions like an INSERT
2434 * except that when there is a duplicate key error, the old row is deleted
2435 * and the new row is inserted in its place.
2437 * We simulate this with standard SQL with a DELETE followed by INSERT. To
2438 * perform the delete, we need to know what the unique indexes are so that
2439 * we know how to find the conflicting rows.
2441 * It may be more efficient to leave off unique indexes which are unlikely
2442 * to collide. However if you do this, you run the risk of encountering
2443 * errors which wouldn't have occurred in MySQL.
2445 * @param string $table The table to replace the row(s) in.
2446 * @param array $rows Can be either a single row to insert, or multiple rows,
2447 * in the same format as for DatabaseBase::insert()
2448 * @param array $uniqueIndexes is an array of indexes. Each element may be either
2449 * a field name or an array of field names
2450 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
2452 public function replace( $table, $uniqueIndexes, $rows, $fname = 'DatabaseBase::replace' ) {
2453 $quotedTable = $this->tableName( $table );
2455 if ( count( $rows ) == 0 ) {
2460 if ( !is_array( reset( $rows ) ) ) {
2461 $rows = array( $rows );
2464 foreach ( $rows as $row ) {
2465 # Delete rows which collide
2466 if ( $uniqueIndexes ) {
2467 $sql = "DELETE FROM $quotedTable WHERE ";
2469 foreach ( $uniqueIndexes as $index ) {
2476 if ( is_array( $index ) ) {
2478 foreach ( $index as $col ) {
2484 $sql .= $col . '=' . $this->addQuotes( $row[$col] );
2487 $sql .= $index . '=' . $this->addQuotes( $row[$index] );
2491 $this->query( $sql, $fname );
2494 # Now insert the row
2495 $this->insert( $table, $row, $fname );
2500 * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2503 * @param string $table Table name
2504 * @param array $rows Rows to insert
2505 * @param string $fname Caller function name
2507 * @return ResultWrapper
2509 protected function nativeReplace( $table, $rows, $fname ) {
2510 $table = $this->tableName( $table );
2513 if ( !is_array( reset( $rows ) ) ) {
2514 $rows = array( $rows );
2517 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2520 foreach ( $rows as $row ) {
2527 $sql .= '(' . $this->makeList( $row ) . ')';
2530 return $this->query( $sql, $fname );
2534 * DELETE where the condition is a join.
2536 * MySQL overrides this to use a multi-table DELETE syntax, in other databases
2537 * we use sub-selects
2539 * For safety, an empty $conds will not delete everything. If you want to
2540 * delete all rows where the join condition matches, set $conds='*'.
2542 * DO NOT put the join condition in $conds.
2544 * @param $delTable String: The table to delete from.
2545 * @param $joinTable String: The other table.
2546 * @param $delVar String: The variable to join on, in the first table.
2547 * @param $joinVar String: The variable to join on, in the second table.
2548 * @param $conds Array: Condition array of field names mapped to variables,
2549 * ANDed together in the WHERE clause
2550 * @param $fname String: Calling function name (use __METHOD__) for
2552 * @throws DBUnexpectedError
2554 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2555 $fname = 'DatabaseBase::deleteJoin' )
2558 throw new DBUnexpectedError( $this,
2559 'DatabaseBase::deleteJoin() called with empty $conds' );
2562 $delTable = $this->tableName( $delTable );
2563 $joinTable = $this->tableName( $joinTable );
2564 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2565 if ( $conds != '*' ) {
2566 $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND
);
2570 $this->query( $sql, $fname );
2574 * Returns the size of a text field, or -1 for "unlimited"
2576 * @param $table string
2577 * @param $field string
2581 public function textFieldSize( $table, $field ) {
2582 $table = $this->tableName( $table );
2583 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2584 $res = $this->query( $sql, 'DatabaseBase::textFieldSize' );
2585 $row = $this->fetchObject( $res );
2589 if ( preg_match( '/\((.*)\)/', $row->Type
, $m ) ) {
2599 * A string to insert into queries to show that they're low-priority, like
2600 * MySQL's LOW_PRIORITY. If no such feature exists, return an empty
2601 * string and nothing bad should happen.
2603 * @return string Returns the text of the low priority option if it is
2604 * supported, or a blank string otherwise
2606 public function lowPriorityOption() {
2611 * DELETE query wrapper.
2613 * @param array $table Table name
2614 * @param string|array $conds of conditions. See $conds in DatabaseBase::select() for
2615 * the format. Use $conds == "*" to delete all rows
2616 * @param string $fname name of the calling function
2618 * @throws DBUnexpectedError
2619 * @return bool|ResultWrapper
2621 public function delete( $table, $conds, $fname = 'DatabaseBase::delete' ) {
2623 throw new DBUnexpectedError( $this, 'DatabaseBase::delete() called with no conditions' );
2626 $table = $this->tableName( $table );
2627 $sql = "DELETE FROM $table";
2629 if ( $conds != '*' ) {
2630 $sql .= ' WHERE ' . $this->makeList( $conds, LIST_AND
);
2633 return $this->query( $sql, $fname );
2637 * INSERT SELECT wrapper. Takes data from a SELECT query and inserts it
2638 * into another table.
2640 * @param string $destTable The table name to insert into
2641 * @param string|array $srcTable May be either a table name, or an array of table names
2642 * to include in a join.
2644 * @param array $varMap must be an associative array of the form
2645 * array( 'dest1' => 'source1', ...). Source items may be literals
2646 * rather than field names, but strings should be quoted with
2647 * DatabaseBase::addQuotes()
2649 * @param array $conds Condition array. See $conds in DatabaseBase::select() for
2650 * the details of the format of condition arrays. May be "*" to copy the
2653 * @param string $fname The function name of the caller, from __METHOD__
2655 * @param array $insertOptions Options for the INSERT part of the query, see
2656 * DatabaseBase::insert() for details.
2657 * @param array $selectOptions Options for the SELECT part of the query, see
2658 * DatabaseBase::select() for details.
2660 * @return ResultWrapper
2662 public function insertSelect( $destTable, $srcTable, $varMap, $conds,
2663 $fname = 'DatabaseBase::insertSelect',
2664 $insertOptions = array(), $selectOptions = array() )
2666 $destTable = $this->tableName( $destTable );
2668 if ( is_array( $insertOptions ) ) {
2669 $insertOptions = implode( ' ', $insertOptions );
2672 if ( !is_array( $selectOptions ) ) {
2673 $selectOptions = array( $selectOptions );
2676 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
2678 if ( is_array( $srcTable ) ) {
2679 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
2681 $srcTable = $this->tableName( $srcTable );
2684 $sql = "INSERT $insertOptions INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
2685 " SELECT $startOpts " . implode( ',', $varMap ) .
2686 " FROM $srcTable $useIndex ";
2688 if ( $conds != '*' ) {
2689 if ( is_array( $conds ) ) {
2690 $conds = $this->makeList( $conds, LIST_AND
);
2692 $sql .= " WHERE $conds";
2695 $sql .= " $tailOpts";
2697 return $this->query( $sql, $fname );
2701 * Construct a LIMIT query with optional offset. This is used for query
2702 * pages. The SQL should be adjusted so that only the first $limit rows
2703 * are returned. If $offset is provided as well, then the first $offset
2704 * rows should be discarded, and the next $limit rows should be returned.
2705 * If the result of the query is not ordered, then the rows to be returned
2706 * are theoretically arbitrary.
2708 * $sql is expected to be a SELECT, if that makes a difference.
2710 * The version provided by default works in MySQL and SQLite. It will very
2711 * likely need to be overridden for most other DBMSes.
2713 * @param string $sql SQL query we will append the limit too
2714 * @param $limit Integer the SQL limit
2715 * @param $offset Integer|bool the SQL offset (default false)
2717 * @throws DBUnexpectedError
2720 public function limitResult( $sql, $limit, $offset = false ) {
2721 if ( !is_numeric( $limit ) ) {
2722 throw new DBUnexpectedError( $this, "Invalid non-numeric limit passed to limitResult()\n" );
2724 return "$sql LIMIT "
2725 . ( ( is_numeric( $offset ) && $offset != 0 ) ?
"{$offset}," : "" )
2730 * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
2731 * within the UNION construct.
2734 public function unionSupportsOrderAndLimit() {
2735 return true; // True for almost every DB supported
2739 * Construct a UNION query
2740 * This is used for providing overload point for other DB abstractions
2741 * not compatible with the MySQL syntax.
2742 * @param array $sqls SQL statements to combine
2743 * @param $all Boolean: use UNION ALL
2744 * @return String: SQL fragment
2746 public function unionQueries( $sqls, $all ) {
2747 $glue = $all ?
') UNION ALL (' : ') UNION (';
2748 return '(' . implode( $glue, $sqls ) . ')';
2752 * Returns an SQL expression for a simple conditional. This doesn't need
2753 * to be overridden unless CASE isn't supported in your DBMS.
2755 * @param string|array $cond SQL expression which will result in a boolean value
2756 * @param string $trueVal SQL expression to return if true
2757 * @param string $falseVal SQL expression to return if false
2758 * @return String: SQL fragment
2760 public function conditional( $cond, $trueVal, $falseVal ) {
2761 if ( is_array( $cond ) ) {
2762 $cond = $this->makeList( $cond, LIST_AND
);
2764 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
2768 * Returns a comand for str_replace function in SQL query.
2769 * Uses REPLACE() in MySQL
2771 * @param string $orig column to modify
2772 * @param string $old column to seek
2773 * @param string $new column to replace with
2777 public function strreplace( $orig, $old, $new ) {
2778 return "REPLACE({$orig}, {$old}, {$new})";
2782 * Determines how long the server has been up
2787 public function getServerUptime() {
2792 * Determines if the last failure was due to a deadlock
2797 public function wasDeadlock() {
2802 * Determines if the last failure was due to a lock timeout
2807 public function wasLockTimeout() {
2812 * Determines if the last query error was something that should be dealt
2813 * with by pinging the connection and reissuing the query.
2818 public function wasErrorReissuable() {
2823 * Determines if the last failure was due to the database being read-only.
2828 public function wasReadOnlyError() {
2833 * Perform a deadlock-prone transaction.
2835 * This function invokes a callback function to perform a set of write
2836 * queries. If a deadlock occurs during the processing, the transaction
2837 * will be rolled back and the callback function will be called again.
2840 * $dbw->deadlockLoop( callback, ... );
2842 * Extra arguments are passed through to the specified callback function.
2844 * Returns whatever the callback function returned on its successful,
2845 * iteration, or false on error, for example if the retry limit was
2850 public function deadlockLoop() {
2851 $this->begin( __METHOD__
);
2852 $args = func_get_args();
2853 $function = array_shift( $args );
2854 $oldIgnore = $this->ignoreErrors( true );
2855 $tries = DEADLOCK_TRIES
;
2857 if ( is_array( $function ) ) {
2858 $fname = $function[0];
2864 $retVal = call_user_func_array( $function, $args );
2865 $error = $this->lastError();
2866 $errno = $this->lastErrno();
2867 $sql = $this->lastQuery();
2870 if ( $this->wasDeadlock() ) {
2872 usleep( mt_rand( DEADLOCK_DELAY_MIN
, DEADLOCK_DELAY_MAX
) );
2874 $this->reportQueryError( $error, $errno, $sql, $fname );
2877 } while ( $this->wasDeadlock() && --$tries > 0 );
2879 $this->ignoreErrors( $oldIgnore );
2881 if ( $tries <= 0 ) {
2882 $this->rollback( __METHOD__
);
2883 $this->reportQueryError( $error, $errno, $sql, $fname );
2886 $this->commit( __METHOD__
);
2892 * Wait for the slave to catch up to a given master position.
2894 * @param $pos DBMasterPos object
2895 * @param $timeout Integer: the maximum number of seconds to wait for
2898 * @return integer: zero if the slave was past that position already,
2899 * greater than zero if we waited for some period of time, less than
2900 * zero if we timed out.
2902 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
2903 wfProfileIn( __METHOD__
);
2905 if ( !is_null( $this->mFakeSlaveLag
) ) {
2906 $wait = intval( ( $pos->pos
- microtime( true ) +
$this->mFakeSlaveLag
) * 1e6
);
2908 if ( $wait > $timeout * 1e6
) {
2909 wfDebug( "Fake slave timed out waiting for $pos ($wait us)\n" );
2910 wfProfileOut( __METHOD__
);
2912 } elseif ( $wait > 0 ) {
2913 wfDebug( "Fake slave waiting $wait us\n" );
2915 wfProfileOut( __METHOD__
);
2918 wfDebug( "Fake slave up to date ($wait us)\n" );
2919 wfProfileOut( __METHOD__
);
2924 wfProfileOut( __METHOD__
);
2926 # Real waits are implemented in the subclass.
2931 * Get the replication position of this slave
2933 * @return DBMasterPos, or false if this is not a slave.
2935 public function getSlavePos() {
2936 if ( !is_null( $this->mFakeSlaveLag
) ) {
2937 $pos = new MySQLMasterPos( 'fake', microtime( true ) - $this->mFakeSlaveLag
);
2938 wfDebug( __METHOD__
. ": fake slave pos = $pos\n" );
2947 * Get the position of this master
2949 * @return DBMasterPos, or false if this is not a master
2951 public function getMasterPos() {
2952 if ( $this->mFakeMaster
) {
2953 return new MySQLMasterPos( 'fake', microtime( true ) );
2960 * Run an anonymous function as soon as there is no transaction pending.
2961 * If there is a transaction and it is rolled back, then the callback is cancelled.
2962 * Queries in the function will run in AUTO-COMMIT mode unless there are begin() calls.
2963 * Callbacks must commit any transactions that they begin.
2965 * This is useful for updates to different systems or when separate transactions are needed.
2966 * For example, one might want to enqueue jobs into a system outside the database, but only
2967 * after the database is updated so that the jobs will see the data when they actually run.
2968 * It can also be used for updates that easily cause deadlocks if locks are held too long.
2970 * @param Closure $callback
2973 final public function onTransactionIdle( Closure
$callback ) {
2974 $this->mTrxIdleCallbacks
[] = $callback;
2975 if ( !$this->mTrxLevel
) {
2976 $this->runOnTransactionIdleCallbacks();
2981 * Run an anonymous function before the current transaction commits or now if there is none.
2982 * If there is a transaction and it is rolled back, then the callback is cancelled.
2983 * Callbacks must not start nor commit any transactions.
2985 * This is useful for updates that easily cause deadlocks if locks are held too long
2986 * but where atomicity is strongly desired for these updates and some related updates.
2988 * @param Closure $callback
2991 final public function onTransactionPreCommitOrIdle( Closure
$callback ) {
2992 if ( $this->mTrxLevel
) {
2993 $this->mTrxPreCommitCallbacks
[] = $callback;
2995 $this->onTransactionIdle( $callback ); // this will trigger immediately
3000 * Actually any "on transaction idle" callbacks.
3004 protected function runOnTransactionIdleCallbacks() {
3005 $autoTrx = $this->getFlag( DBO_TRX
); // automatic begin() enabled?
3007 $e = null; // last exception
3008 do { // callbacks may add callbacks :)
3009 $callbacks = $this->mTrxIdleCallbacks
;
3010 $this->mTrxIdleCallbacks
= array(); // recursion guard
3011 foreach ( $callbacks as $callback ) {
3013 $this->clearFlag( DBO_TRX
); // make each query its own transaction
3015 $this->setFlag( $autoTrx ? DBO_TRX
: 0 ); // restore automatic begin()
3016 } catch ( Exception
$e ) {
3019 } while ( count( $this->mTrxIdleCallbacks
) );
3021 if ( $e instanceof Exception
) {
3022 throw $e; // re-throw any last exception
3027 * Actually any "on transaction pre-commit" callbacks.
3031 protected function runOnTransactionPreCommitCallbacks() {
3032 $e = null; // last exception
3033 do { // callbacks may add callbacks :)
3034 $callbacks = $this->mTrxPreCommitCallbacks
;
3035 $this->mTrxPreCommitCallbacks
= array(); // recursion guard
3036 foreach ( $callbacks as $callback ) {
3039 } catch ( Exception
$e ) {}
3041 } while ( count( $this->mTrxPreCommitCallbacks
) );
3043 if ( $e instanceof Exception
) {
3044 throw $e; // re-throw any last exception
3049 * Begin a transaction. If a transaction is already in progress, that transaction will be committed before the
3050 * new transaction is started.
3052 * Note that when the DBO_TRX flag is set (which is usually the case for web requests, but not for maintenance scripts),
3053 * any previous database query will have started a transaction automatically.
3055 * Nesting of transactions is not supported. Attempts to nest transactions will cause a warning, unless the current
3056 * transaction was started automatically because of the DBO_TRX flag.
3058 * @param $fname string
3060 final public function begin( $fname = 'DatabaseBase::begin' ) {
3061 global $wgDebugDBTransactions;
3063 if ( $this->mTrxLevel
) { // implicit commit
3064 if ( !$this->mTrxAutomatic
) {
3065 // We want to warn about inadvertently nested begin/commit pairs, but not about
3066 // auto-committing implicit transactions that were started by query() via DBO_TRX
3067 $msg = "$fname: Transaction already in progress (from {$this->mTrxFname}), " .
3068 " performing implicit commit!";
3070 wfLogDBError( $msg );
3072 // if the transaction was automatic and has done write operations,
3073 // log it if $wgDebugDBTransactions is enabled.
3074 if ( $this->mTrxDoneWrites
&& $wgDebugDBTransactions ) {
3075 wfDebug( "$fname: Automatic transaction with writes in progress" .
3076 " (from {$this->mTrxFname}), performing implicit commit!\n"
3081 $this->runOnTransactionPreCommitCallbacks();
3082 $this->doCommit( $fname );
3083 $this->runOnTransactionIdleCallbacks();
3086 $this->doBegin( $fname );
3087 $this->mTrxFname
= $fname;
3088 $this->mTrxDoneWrites
= false;
3089 $this->mTrxAutomatic
= false;
3093 * Issues the BEGIN command to the database server.
3095 * @see DatabaseBase::begin()
3096 * @param type $fname
3098 protected function doBegin( $fname ) {
3099 $this->query( 'BEGIN', $fname );
3100 $this->mTrxLevel
= 1;
3104 * Commits a transaction previously started using begin().
3105 * If no transaction is in progress, a warning is issued.
3107 * Nesting of transactions is not supported.
3109 * @param $fname string
3110 * @param string $flush Flush flag, set to 'flush' to disable warnings about explicitly committing implicit
3111 * transactions, or calling commit when no transaction is in progress.
3112 * This will silently break any ongoing explicit transaction. Only set the flush flag if you are sure
3113 * that it is safe to ignore these warnings in your context.
3115 final public function commit( $fname = 'DatabaseBase::commit', $flush = '' ) {
3116 if ( $flush != 'flush' ) {
3117 if ( !$this->mTrxLevel
) {
3118 wfWarn( "$fname: No transaction to commit, something got out of sync!" );
3119 } elseif ( $this->mTrxAutomatic
) {
3120 wfWarn( "$fname: Explicit commit of implicit transaction. Something may be out of sync!" );
3123 if ( !$this->mTrxLevel
) {
3124 return; // nothing to do
3125 } elseif ( !$this->mTrxAutomatic
) {
3126 wfWarn( "$fname: Flushing an explicit transaction, getting out of sync!" );
3130 $this->runOnTransactionPreCommitCallbacks();
3131 $this->doCommit( $fname );
3132 $this->runOnTransactionIdleCallbacks();
3136 * Issues the COMMIT command to the database server.
3138 * @see DatabaseBase::commit()
3139 * @param type $fname
3141 protected function doCommit( $fname ) {
3142 if ( $this->mTrxLevel
) {
3143 $this->query( 'COMMIT', $fname );
3144 $this->mTrxLevel
= 0;
3149 * Rollback a transaction previously started using begin().
3150 * If no transaction is in progress, a warning is issued.
3152 * No-op on non-transactional databases.
3154 * @param $fname string
3156 final public function rollback( $fname = 'DatabaseBase::rollback' ) {
3157 if ( !$this->mTrxLevel
) {
3158 wfWarn( "$fname: No transaction to rollback, something got out of sync!" );
3160 $this->doRollback( $fname );
3161 $this->mTrxIdleCallbacks
= array(); // cancel
3162 $this->mTrxPreCommitCallbacks
= array(); // cancel
3166 * Issues the ROLLBACK command to the database server.
3168 * @see DatabaseBase::rollback()
3169 * @param type $fname
3171 protected function doRollback( $fname ) {
3172 if ( $this->mTrxLevel
) {
3173 $this->query( 'ROLLBACK', $fname, true );
3174 $this->mTrxLevel
= 0;
3179 * Creates a new table with structure copied from existing table
3180 * Note that unlike most database abstraction functions, this function does not
3181 * automatically append database prefix, because it works at a lower
3182 * abstraction level.
3183 * The table names passed to this function shall not be quoted (this
3184 * function calls addIdentifierQuotes when needed).
3186 * @param string $oldName name of table whose structure should be copied
3187 * @param string $newName name of table to be created
3188 * @param $temporary Boolean: whether the new table should be temporary
3189 * @param string $fname calling function name
3190 * @throws MWException
3191 * @return Boolean: true if operation was successful
3193 public function duplicateTableStructure( $oldName, $newName, $temporary = false,
3194 $fname = 'DatabaseBase::duplicateTableStructure'
3196 throw new MWException(
3197 'DatabaseBase::duplicateTableStructure is not implemented in descendant class' );
3201 * List all tables on the database
3203 * @param string $prefix Only show tables with this prefix, e.g. mw_
3204 * @param string $fname calling function name
3205 * @throws MWException
3207 function listTables( $prefix = null, $fname = 'DatabaseBase::listTables' ) {
3208 throw new MWException( 'DatabaseBase::listTables is not implemented in descendant class' );
3212 * Convert a timestamp in one of the formats accepted by wfTimestamp()
3213 * to the format used for inserting into timestamp fields in this DBMS.
3215 * The result is unquoted, and needs to be passed through addQuotes()
3216 * before it can be included in raw SQL.
3218 * @param $ts string|int
3222 public function timestamp( $ts = 0 ) {
3223 return wfTimestamp( TS_MW
, $ts );
3227 * Convert a timestamp in one of the formats accepted by wfTimestamp()
3228 * to the format used for inserting into timestamp fields in this DBMS. If
3229 * NULL is input, it is passed through, allowing NULL values to be inserted
3230 * into timestamp fields.
3232 * The result is unquoted, and needs to be passed through addQuotes()
3233 * before it can be included in raw SQL.
3235 * @param $ts string|int
3239 public function timestampOrNull( $ts = null ) {
3240 if ( is_null( $ts ) ) {
3243 return $this->timestamp( $ts );
3248 * Take the result from a query, and wrap it in a ResultWrapper if
3249 * necessary. Boolean values are passed through as is, to indicate success
3250 * of write queries or failure.
3252 * Once upon a time, DatabaseBase::query() returned a bare MySQL result
3253 * resource, and it was necessary to call this function to convert it to
3254 * a wrapper. Nowadays, raw database objects are never exposed to external
3255 * callers, so this is unnecessary in external code. For compatibility with
3256 * old code, ResultWrapper objects are passed through unaltered.
3258 * @param $result bool|ResultWrapper
3260 * @return bool|ResultWrapper
3262 public function resultObject( $result ) {
3263 if ( empty( $result ) ) {
3265 } elseif ( $result instanceof ResultWrapper
) {
3267 } elseif ( $result === true ) {
3268 // Successful write query
3271 return new ResultWrapper( $this, $result );
3276 * Ping the server and try to reconnect if it there is no connection
3278 * @return bool Success or failure
3280 public function ping() {
3281 # Stub. Not essential to override.
3286 * Get slave lag. Currently supported only by MySQL.
3288 * Note that this function will generate a fatal error on many
3289 * installations. Most callers should use LoadBalancer::safeGetLag()
3292 * @return int Database replication lag in seconds
3294 public function getLag() {
3295 return intval( $this->mFakeSlaveLag
);
3299 * Return the maximum number of items allowed in a list, or 0 for unlimited.
3303 function maxListLen() {
3308 * Some DBMSs have a special format for inserting into blob fields, they
3309 * don't allow simple quoted strings to be inserted. To insert into such
3310 * a field, pass the data through this function before passing it to
3311 * DatabaseBase::insert().
3315 public function encodeBlob( $b ) {
3320 * Some DBMSs return a special placeholder object representing blob fields
3321 * in result objects. Pass the object through this function to return the
3326 public function decodeBlob( $b ) {
3331 * Override database's default behavior. $options include:
3332 * 'connTimeout' : Set the connection timeout value in seconds.
3333 * May be useful for very long batch queries such as
3334 * full-wiki dumps, where a single query reads out over
3337 * @param $options Array
3340 public function setSessionOptions( array $options ) {
3344 * Read and execute SQL commands from a file.
3346 * Returns true on success, error string or exception on failure (depending
3347 * on object's error ignore settings).
3349 * @param string $filename File name to open
3350 * @param bool|callable $lineCallback Optional function called before reading each line
3351 * @param bool|callable $resultCallback Optional function called for each MySQL result
3352 * @param bool|string $fname Calling function name or false if name should be
3353 * generated dynamically using $filename
3354 * @param bool|callable $inputCallback Callback: Optional function called for each complete line sent
3355 * @throws MWException
3356 * @throws Exception|MWException
3357 * @return bool|string
3359 public function sourceFile(
3360 $filename, $lineCallback = false, $resultCallback = false, $fname = false, $inputCallback = false
3362 wfSuppressWarnings();
3363 $fp = fopen( $filename, 'r' );
3364 wfRestoreWarnings();
3366 if ( false === $fp ) {
3367 throw new MWException( "Could not open \"{$filename}\".\n" );
3371 $fname = __METHOD__
. "( $filename )";
3375 $error = $this->sourceStream( $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
3377 catch ( MWException
$e ) {
3388 * Get the full path of a patch file. Originally based on archive()
3389 * from updaters.inc. Keep in mind this always returns a patch, as
3390 * it fails back to MySQL if no DB-specific patch can be found
3392 * @param string $patch The name of the patch, like patch-something.sql
3393 * @return String Full path to patch file
3395 public function patchPath( $patch ) {
3398 $dbType = $this->getType();
3399 if ( file_exists( "$IP/maintenance/$dbType/archives/$patch" ) ) {
3400 return "$IP/maintenance/$dbType/archives/$patch";
3402 return "$IP/maintenance/archives/$patch";
3407 * Set variables to be used in sourceFile/sourceStream, in preference to the
3408 * ones in $GLOBALS. If an array is set here, $GLOBALS will not be used at
3409 * all. If it's set to false, $GLOBALS will be used.
3411 * @param bool|array $vars mapping variable name to value.
3413 public function setSchemaVars( $vars ) {
3414 $this->mSchemaVars
= $vars;
3418 * Read and execute commands from an open file handle.
3420 * Returns true on success, error string or exception on failure (depending
3421 * on object's error ignore settings).
3423 * @param $fp Resource: File handle
3424 * @param $lineCallback Callback: Optional function called before reading each query
3425 * @param $resultCallback Callback: Optional function called for each MySQL result
3426 * @param string $fname Calling function name
3427 * @param $inputCallback Callback: Optional function called for each complete query sent
3428 * @return bool|string
3430 public function sourceStream( $fp, $lineCallback = false, $resultCallback = false,
3431 $fname = 'DatabaseBase::sourceStream', $inputCallback = false )
3435 while ( !feof( $fp ) ) {
3436 if ( $lineCallback ) {
3437 call_user_func( $lineCallback );
3440 $line = trim( fgets( $fp ) );
3442 if ( $line == '' ) {
3446 if ( '-' == $line[0] && '-' == $line[1] ) {
3454 $done = $this->streamStatementEnd( $cmd, $line );
3458 if ( $done ||
feof( $fp ) ) {
3459 $cmd = $this->replaceVars( $cmd );
3461 if ( ( $inputCallback && call_user_func( $inputCallback, $cmd ) ) ||
!$inputCallback ) {
3462 $res = $this->query( $cmd, $fname );
3464 if ( $resultCallback ) {
3465 call_user_func( $resultCallback, $res, $this );
3468 if ( false === $res ) {
3469 $err = $this->lastError();
3470 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
3481 * Called by sourceStream() to check if we've reached a statement end
3483 * @param string $sql SQL assembled so far
3484 * @param string $newLine New line about to be added to $sql
3485 * @return Bool Whether $newLine contains end of the statement
3487 public function streamStatementEnd( &$sql, &$newLine ) {
3488 if ( $this->delimiter
) {
3490 $newLine = preg_replace( '/' . preg_quote( $this->delimiter
, '/' ) . '$/', '', $newLine );
3491 if ( $newLine != $prev ) {
3499 * Database independent variable replacement. Replaces a set of variables
3500 * in an SQL statement with their contents as given by $this->getSchemaVars().
3502 * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
3504 * - '{$var}' should be used for text and is passed through the database's
3506 * - `{$var}` should be used for identifiers (eg: table and database names),
3507 * it is passed through the database's addIdentifierQuotes method which
3508 * can be overridden if the database uses something other than backticks.
3509 * - / *$var* / is just encoded, besides traditional table prefix and
3510 * table options its use should be avoided.
3512 * @param string $ins SQL statement to replace variables in
3513 * @return String The new SQL statement with variables replaced
3515 protected function replaceSchemaVars( $ins ) {
3516 $vars = $this->getSchemaVars();
3517 foreach ( $vars as $var => $value ) {
3519 $ins = str_replace( '\'{$' . $var . '}\'', $this->addQuotes( $value ), $ins );
3521 $ins = str_replace( '`{$' . $var . '}`', $this->addIdentifierQuotes( $value ), $ins );
3523 $ins = str_replace( '/*$' . $var . '*/', $this->strencode( $value ), $ins );
3529 * Replace variables in sourced SQL
3531 * @param $ins string
3535 protected function replaceVars( $ins ) {
3536 $ins = $this->replaceSchemaVars( $ins );
3539 $ins = preg_replace_callback( '!/\*(?:\$wgDBprefix|_)\*/([a-zA-Z_0-9]*)!',
3540 array( $this, 'tableNameCallback' ), $ins );
3543 $ins = preg_replace_callback( '!/\*i\*/([a-zA-Z_0-9]*)!',
3544 array( $this, 'indexNameCallback' ), $ins );
3550 * Get schema variables. If none have been set via setSchemaVars(), then
3551 * use some defaults from the current object.
3555 protected function getSchemaVars() {
3556 if ( $this->mSchemaVars
) {
3557 return $this->mSchemaVars
;
3559 return $this->getDefaultSchemaVars();
3564 * Get schema variables to use if none have been set via setSchemaVars().
3566 * Override this in derived classes to provide variables for tables.sql
3567 * and SQL patch files.
3571 protected function getDefaultSchemaVars() {
3576 * Table name callback
3578 * @param $matches array
3582 protected function tableNameCallback( $matches ) {
3583 return $this->tableName( $matches[1] );
3587 * Index name callback
3589 * @param $matches array
3593 protected function indexNameCallback( $matches ) {
3594 return $this->indexName( $matches[1] );
3598 * Check to see if a named lock is available. This is non-blocking.
3600 * @param string $lockName name of lock to poll
3601 * @param string $method name of method calling us
3605 public function lockIsFree( $lockName, $method ) {
3610 * Acquire a named lock
3612 * Abstracted from Filestore::lock() so child classes can implement for
3615 * @param string $lockName name of lock to aquire
3616 * @param string $method name of method calling us
3617 * @param $timeout Integer: timeout
3620 public function lock( $lockName, $method, $timeout = 5 ) {
3627 * @param string $lockName Name of lock to release
3628 * @param string $method Name of method calling us
3630 * @return int Returns 1 if the lock was released, 0 if the lock was not established
3631 * by this thread (in which case the lock is not released), and NULL if the named
3632 * lock did not exist
3634 public function unlock( $lockName, $method ) {
3639 * Lock specific tables
3641 * @param array $read of tables to lock for read access
3642 * @param array $write of tables to lock for write access
3643 * @param string $method name of caller
3644 * @param bool $lowPriority Whether to indicate writes to be LOW PRIORITY
3648 public function lockTables( $read, $write, $method, $lowPriority = true ) {
3653 * Unlock specific tables
3655 * @param string $method the caller
3659 public function unlockTables( $method ) {
3665 * @param $tableName string
3666 * @param $fName string
3667 * @return bool|ResultWrapper
3670 public function dropTable( $tableName, $fName = 'DatabaseBase::dropTable' ) {
3671 if ( !$this->tableExists( $tableName, $fName ) ) {
3674 $sql = "DROP TABLE " . $this->tableName( $tableName );
3675 if ( $this->cascadingDeletes() ) {
3678 return $this->query( $sql, $fName );
3682 * Get search engine class. All subclasses of this need to implement this
3683 * if they wish to use searching.
3687 public function getSearchEngine() {
3688 return 'SearchEngineDummy';
3692 * Find out when 'infinity' is. Most DBMSes support this. This is a special
3693 * keyword for timestamps in PostgreSQL, and works with CHAR(14) as well
3694 * because "i" sorts after all numbers.
3698 public function getInfinity() {
3703 * Encode an expiry time into the DBMS dependent format
3705 * @param string $expiry timestamp for expiry, or the 'infinity' string
3708 public function encodeExpiry( $expiry ) {
3709 return ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() )
3710 ?
$this->getInfinity()
3711 : $this->timestamp( $expiry );
3715 * Decode an expiry time into a DBMS independent format
3717 * @param string $expiry DB timestamp field value for expiry
3718 * @param $format integer: TS_* constant, defaults to TS_MW
3721 public function decodeExpiry( $expiry, $format = TS_MW
) {
3722 return ( $expiry == '' ||
$expiry == $this->getInfinity() )
3724 : wfTimestamp( $format, $expiry );
3728 * Allow or deny "big selects" for this session only. This is done by setting
3729 * the sql_big_selects session variable.
3731 * This is a MySQL-specific feature.
3733 * @param $value Mixed: true for allow, false for deny, or "default" to
3734 * restore the initial value
3736 public function setBigSelects( $value = true ) {
3743 public function __toString() {
3744 return (string)$this->mConn
;
3747 public function __destruct() {
3748 if ( count( $this->mTrxIdleCallbacks
) ||
count( $this->mTrxPreCommitCallbacks
) ) {
3749 trigger_error( "Transaction idle or pre-commit callbacks still pending." ); // sanity