4 * @defgroup Database Database
6 * This file deals with database interface functions
7 * and query specifics/optimisations.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
29 * Base interface for all DBMS-specific code. At a bare minimum, all of the
30 * following must be implemented to support MediaWiki
35 interface DatabaseType
{
37 * Get the type of the DBMS, as it appears in $wgDBtype.
44 * Open a connection to the database. Usually aborts on failure
46 * @param string $server Database server host
47 * @param string $user Database user name
48 * @param string $password Database user password
49 * @param string $dbName Database name
51 * @throws DBConnectionError
53 function open( $server, $user, $password, $dbName );
56 * Fetch the next row from the given result object, in object form.
57 * Fields can be retrieved with $row->fieldname, with fields acting like
59 * If no more rows are available, false is returned.
61 * @param ResultWrapper|stdClass $res Object as returned from DatabaseBase::query(), etc.
62 * @return stdClass|bool
63 * @throws DBUnexpectedError Thrown if the database returns an error
65 function fetchObject( $res );
68 * Fetch the next row from the given result object, in associative array
69 * form. Fields are retrieved with $row['fieldname'].
70 * If no more rows are available, false is returned.
72 * @param ResultWrapper $res Result object as returned from DatabaseBase::query(), etc.
74 * @throws DBUnexpectedError Thrown if the database returns an error
76 function fetchRow( $res );
79 * Get the number of rows in a result object
81 * @param mixed $res A SQL result
84 function numRows( $res );
87 * Get the number of fields in a result object
88 * @see http://www.php.net/mysql_num_fields
90 * @param mixed $res A SQL result
93 function numFields( $res );
96 * Get a field name in a result object
97 * @see http://www.php.net/mysql_field_name
99 * @param mixed $res A SQL result
103 function fieldName( $res, $n );
106 * Get the inserted value of an auto-increment row
108 * The value inserted should be fetched from nextSequenceValue()
111 * $id = $dbw->nextSequenceValue( 'page_page_id_seq' );
112 * $dbw->insert( 'page', array( 'page_id' => $id ) );
113 * $id = $dbw->insertId();
120 * Change the position of the cursor in a result object
121 * @see http://www.php.net/mysql_data_seek
123 * @param mixed $res A SQL result
126 function dataSeek( $res, $row );
129 * Get the last error number
130 * @see http://www.php.net/mysql_errno
134 function lastErrno();
137 * Get a description of the last error
138 * @see http://www.php.net/mysql_error
142 function lastError();
145 * mysql_fetch_field() wrapper
146 * Returns false if the field doesn't exist
148 * @param string $table Table name
149 * @param string $field Field name
153 function fieldInfo( $table, $field );
156 * Get information about an index into an object
157 * @param string $table Table name
158 * @param string $index Index name
159 * @param string $fname Calling function name
160 * @return mixed Database-specific index description class or false if the index does not exist
162 function indexInfo( $table, $index, $fname = __METHOD__
);
165 * Get the number of rows affected by the last write query
166 * @see http://www.php.net/mysql_affected_rows
170 function affectedRows();
173 * Wrapper for addslashes()
175 * @param string $s String to be slashed.
176 * @return string Slashed string.
178 function strencode( $s );
181 * Returns a wikitext link to the DB's website, e.g.,
182 * return "[http://www.mysql.com/ MySQL]";
183 * Should at least contain plain text, if for some reason
184 * your database has no website.
186 * @return string Wikitext of a link to the server software's web site
188 function getSoftwareLink();
191 * A string describing the current software version, like from
192 * mysql_get_server_info().
194 * @return string Version information from the database server.
196 function getServerVersion();
199 * A string describing the current software version, and possibly
200 * other details in a user-friendly way. Will be listed on Special:Version, etc.
201 * Use getServerVersion() to get machine-friendly information.
203 * @return string Version information from the database server
205 function getServerInfo();
209 * Interface for classes that implement or wrap DatabaseBase
212 interface IDatabase
{
216 * Database abstraction object
219 abstract class DatabaseBase
implements IDatabase
, DatabaseType
{
220 /** Number of times to re-try an operation in case of deadlock */
221 const DEADLOCK_TRIES
= 4;
223 /** Minimum time to wait before retry, in microseconds */
224 const DEADLOCK_DELAY_MIN
= 500000;
226 /** Maximum time to wait before retry */
227 const DEADLOCK_DELAY_MAX
= 1500000;
229 # ------------------------------------------------------------------------------
231 # ------------------------------------------------------------------------------
233 protected $mLastQuery = '';
234 protected $mDoneWrites = false;
235 protected $mPHPError = false;
237 protected $mServer, $mUser, $mPassword, $mDBname;
239 /** @var resource Database connection */
240 protected $mConn = null;
241 protected $mOpened = false;
243 /** @var callable[] */
244 protected $mTrxIdleCallbacks = array();
245 /** @var callable[] */
246 protected $mTrxPreCommitCallbacks = array();
248 protected $mTablePrefix;
252 protected $mErrorCount = 0;
253 protected $mLBInfo = array();
254 protected $mDefaultBigSelects = null;
255 protected $mSchemaVars = false;
257 protected $preparedArgs;
259 protected $htmlErrors;
261 protected $delimiter = ';';
264 * Either 1 if a transaction is active or 0 otherwise.
265 * The other Trx fields may not be meaningfull if this is 0.
269 protected $mTrxLevel = 0;
272 * Either a short hexidecimal string if a transaction is active or ""
275 * @see DatabaseBase::mTrxLevel
277 protected $mTrxShortId = '';
280 * The UNIX time that the transaction started. Callers can assume that if
281 * snapshot isolation is used, then the data is *at least* up to date to that
282 * point (possibly more up-to-date since the first SELECT defines the snapshot).
285 * @see DatabaseBase::mTrxLevel
287 private $mTrxTimestamp = null;
290 * Remembers the function name given for starting the most recent transaction via begin().
291 * Used to provide additional context for error reporting.
294 * @see DatabaseBase::mTrxLevel
296 private $mTrxFname = null;
299 * Record if possible write queries were done in the last transaction started
302 * @see DatabaseBase::mTrxLevel
304 private $mTrxDoneWrites = false;
307 * Record if the current transaction was started implicitly due to DBO_TRX being set.
310 * @see DatabaseBase::mTrxLevel
312 private $mTrxAutomatic = false;
315 * Array of levels of atomicity within transactions
319 private $mTrxAtomicLevels;
322 * Record if the current transaction was started implicitly by DatabaseBase::startAtomic
326 private $mTrxAutomaticAtomic = false;
330 * @var resource File handle for upgrade
332 protected $fileHandle = null;
336 * @var string[] Process cache of VIEWs names in the database
338 protected $allViews = null;
340 # ------------------------------------------------------------------------------
342 # ------------------------------------------------------------------------------
343 # These optionally set a variable and return the previous state
346 * A string describing the current software version, and possibly
347 * other details in a user-friendly way. Will be listed on Special:Version, etc.
348 * Use getServerVersion() to get machine-friendly information.
350 * @return string Version information from the database server
352 public function getServerInfo() {
353 return $this->getServerVersion();
357 * @return string Command delimiter used by this database engine
359 public function getDelimiter() {
360 return $this->delimiter
;
364 * Boolean, controls output of large amounts of debug information.
365 * @param bool|null $debug
366 * - true to enable debugging
367 * - false to disable debugging
368 * - omitted or null to do nothing
370 * @return bool|null Previous value of the flag
372 public function debug( $debug = null ) {
373 return wfSetBit( $this->mFlags
, DBO_DEBUG
, $debug );
377 * Turns buffering of SQL result sets on (true) or off (false). Default is
380 * Unbuffered queries are very troublesome in MySQL:
382 * - If another query is executed while the first query is being read
383 * out, the first query is killed. This means you can't call normal
384 * MediaWiki functions while you are reading an unbuffered query result
385 * from a normal wfGetDB() connection.
387 * - Unbuffered queries cause the MySQL server to use large amounts of
388 * memory and to hold broad locks which block other queries.
390 * If you want to limit client-side memory, it's almost always better to
391 * split up queries into batches using a LIMIT clause than to switch off
394 * @param null|bool $buffer
395 * @return null|bool The previous value of the flag
397 public function bufferResults( $buffer = null ) {
398 if ( is_null( $buffer ) ) {
399 return !(bool)( $this->mFlags
& DBO_NOBUFFER
);
401 return !wfSetBit( $this->mFlags
, DBO_NOBUFFER
, !$buffer );
406 * Turns on (false) or off (true) the automatic generation and sending
407 * of a "we're sorry, but there has been a database error" page on
408 * database errors. Default is on (false). When turned off, the
409 * code should use lastErrno() and lastError() to handle the
410 * situation as appropriate.
412 * Do not use this function outside of the Database classes.
414 * @param null|bool $ignoreErrors
415 * @return bool The previous value of the flag.
417 public function ignoreErrors( $ignoreErrors = null ) {
418 return wfSetBit( $this->mFlags
, DBO_IGNORE
, $ignoreErrors );
422 * Gets the current transaction level.
424 * Historically, transactions were allowed to be "nested". This is no
425 * longer supported, so this function really only returns a boolean.
427 * @return int The previous value
429 public function trxLevel() {
430 return $this->mTrxLevel
;
434 * Get the UNIX timestamp of the time that the transaction was established
436 * This can be used to reason about the staleness of SELECT data
437 * in REPEATABLE-READ transaction isolation level.
439 * @return float|null Returns null if there is not active transaction
442 public function trxTimestamp() {
443 return $this->mTrxLevel ?
$this->mTrxTimestamp
: null;
447 * Get/set the number of errors logged. Only useful when errors are ignored
448 * @param int $count The count to set, or omitted to leave it unchanged.
449 * @return int The error count
451 public function errorCount( $count = null ) {
452 return wfSetVar( $this->mErrorCount
, $count );
456 * Get/set the table prefix.
457 * @param string $prefix The table prefix to set, or omitted to leave it unchanged.
458 * @return string The previous table prefix.
460 public function tablePrefix( $prefix = null ) {
461 return wfSetVar( $this->mTablePrefix
, $prefix );
465 * Get/set the db schema.
466 * @param string $schema The database schema to set, or omitted to leave it unchanged.
467 * @return string The previous db schema.
469 public function dbSchema( $schema = null ) {
470 return wfSetVar( $this->mSchema
, $schema );
474 * Set the filehandle to copy write statements to.
476 * @param resource $fh File handle
478 public function setFileHandle( $fh ) {
479 $this->fileHandle
= $fh;
483 * Get properties passed down from the server info array of the load
486 * @param string $name The entry of the info array to get, or null to get the
489 * @return array|mixed|null
491 public function getLBInfo( $name = null ) {
492 if ( is_null( $name ) ) {
493 return $this->mLBInfo
;
495 if ( array_key_exists( $name, $this->mLBInfo
) ) {
496 return $this->mLBInfo
[$name];
504 * Set the LB info array, or a member of it. If called with one parameter,
505 * the LB info array is set to that parameter. If it is called with two
506 * parameters, the member with the given name is set to the given value.
508 * @param string $name
509 * @param array $value
511 public function setLBInfo( $name, $value = null ) {
512 if ( is_null( $value ) ) {
513 $this->mLBInfo
= $name;
515 $this->mLBInfo
[$name] = $value;
520 * Set lag time in seconds for a fake slave
522 * @param mixed $lag Valid values for this parameter are determined by the
523 * subclass, but should be a PHP scalar or array that would be sensible
524 * as part of $wgLBFactoryConf.
526 public function setFakeSlaveLag( $lag ) {
530 * Make this connection a fake master
532 * @param bool $enabled
534 public function setFakeMaster( $enabled = true ) {
538 * Returns true if this database supports (and uses) cascading deletes
542 public function cascadingDeletes() {
547 * Returns true if this database supports (and uses) triggers (e.g. on the page table)
551 public function cleanupTriggers() {
556 * Returns true if this database is strict about what can be put into an IP field.
557 * Specifically, it uses a NULL value instead of an empty string.
561 public function strictIPs() {
566 * Returns true if this database uses timestamps rather than integers
570 public function realTimestamps() {
575 * Returns true if this database does an implicit sort when doing GROUP BY
579 public function implicitGroupby() {
584 * Returns true if this database does an implicit order by when the column has an index
585 * For example: SELECT page_title FROM page LIMIT 1
589 public function implicitOrderby() {
594 * Returns true if this database can do a native search on IP columns
595 * e.g. this works as expected: .. WHERE rc_ip = '127.42.12.102/32';
599 public function searchableIPs() {
604 * Returns true if this database can use functional indexes
608 public function functionalIndexes() {
613 * Return the last query that went through DatabaseBase::query()
616 public function lastQuery() {
617 return $this->mLastQuery
;
621 * Returns true if the connection may have been used for write queries.
622 * Should return true if unsure.
626 public function doneWrites() {
627 return (bool)$this->mDoneWrites
;
631 * Returns the last time the connection may have been used for write queries.
632 * Should return a timestamp if unsure.
634 * @return int|float UNIX timestamp or false
637 public function lastDoneWrites() {
638 return $this->mDoneWrites ?
: false;
642 * Returns true if there is a transaction open with possible write
643 * queries or transaction pre-commit/idle callbacks waiting on it to finish.
647 public function writesOrCallbacksPending() {
648 return $this->mTrxLevel
&& (
649 $this->mTrxDoneWrites ||
$this->mTrxIdleCallbacks ||
$this->mTrxPreCommitCallbacks
654 * Is a connection to the database open?
657 public function isOpen() {
658 return $this->mOpened
;
662 * Set a flag for this connection
664 * @param int $flag DBO_* constants from Defines.php:
665 * - DBO_DEBUG: output some debug info (same as debug())
666 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
667 * - DBO_TRX: automatically start transactions
668 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
669 * and removes it in command line mode
670 * - DBO_PERSISTENT: use persistant database connection
672 public function setFlag( $flag ) {
673 global $wgDebugDBTransactions;
674 $this->mFlags |
= $flag;
675 if ( ( $flag & DBO_TRX
) && $wgDebugDBTransactions ) {
676 wfDebug( "Implicit transactions are now enabled.\n" );
681 * Clear a flag for this connection
683 * @param int $flag DBO_* constants from Defines.php:
684 * - DBO_DEBUG: output some debug info (same as debug())
685 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
686 * - DBO_TRX: automatically start transactions
687 * - DBO_DEFAULT: automatically sets DBO_TRX if not in command line mode
688 * and removes it in command line mode
689 * - DBO_PERSISTENT: use persistant database connection
691 public function clearFlag( $flag ) {
692 global $wgDebugDBTransactions;
693 $this->mFlags
&= ~
$flag;
694 if ( ( $flag & DBO_TRX
) && $wgDebugDBTransactions ) {
695 wfDebug( "Implicit transactions are now disabled.\n" );
700 * Returns a boolean whether the flag $flag is set for this connection
702 * @param int $flag DBO_* constants from Defines.php:
703 * - DBO_DEBUG: output some debug info (same as debug())
704 * - DBO_NOBUFFER: don't buffer results (inverse of bufferResults())
705 * - DBO_TRX: automatically start transactions
706 * - DBO_PERSISTENT: use persistant database connection
709 public function getFlag( $flag ) {
710 return !!( $this->mFlags
& $flag );
714 * General read-only accessor
716 * @param string $name
719 public function getProperty( $name ) {
726 public function getWikiID() {
727 if ( $this->mTablePrefix
) {
728 return "{$this->mDBname}-{$this->mTablePrefix}";
730 return $this->mDBname
;
735 * Return a path to the DBMS-specific SQL file if it exists,
736 * otherwise default SQL file
738 * @param string $filename
741 private function getSqlFilePath( $filename ) {
743 $dbmsSpecificFilePath = "$IP/maintenance/" . $this->getType() . "/$filename";
744 if ( file_exists( $dbmsSpecificFilePath ) ) {
745 return $dbmsSpecificFilePath;
747 return "$IP/maintenance/$filename";
752 * Return a path to the DBMS-specific schema file,
753 * otherwise default to tables.sql
757 public function getSchemaPath() {
758 return $this->getSqlFilePath( 'tables.sql' );
762 * Return a path to the DBMS-specific update key file,
763 * otherwise default to update-keys.sql
767 public function getUpdateKeysPath() {
768 return $this->getSqlFilePath( 'update-keys.sql' );
771 # ------------------------------------------------------------------------------
773 # ------------------------------------------------------------------------------
778 * FIXME: It is possible to construct a Database object with no associated
779 * connection object, by specifying no parameters to __construct(). This
780 * feature is deprecated and should be removed.
782 * DatabaseBase subclasses should not be constructed directly in external
783 * code. DatabaseBase::factory() should be used instead.
785 * @param array $params Parameters passed from DatabaseBase::factory()
787 function __construct( $params = null ) {
788 global $wgDBprefix, $wgDBmwschema, $wgCommandLineMode, $wgDebugDBTransactions;
790 $this->mTrxAtomicLevels
= new SplStack
;
792 if ( is_array( $params ) ) { // MW 1.22
793 $server = $params['host'];
794 $user = $params['user'];
795 $password = $params['password'];
796 $dbName = $params['dbname'];
797 $flags = $params['flags'];
798 $tablePrefix = $params['tablePrefix'];
799 $schema = $params['schema'];
800 $foreign = $params['foreign'];
801 } else { // legacy calling pattern
802 wfDeprecated( __METHOD__
. " method called without parameter array.", "1.23" );
803 $args = func_get_args();
804 $server = isset( $args[0] ) ?
$args[0] : false;
805 $user = isset( $args[1] ) ?
$args[1] : false;
806 $password = isset( $args[2] ) ?
$args[2] : false;
807 $dbName = isset( $args[3] ) ?
$args[3] : false;
808 $flags = isset( $args[4] ) ?
$args[4] : 0;
809 $tablePrefix = isset( $args[5] ) ?
$args[5] : 'get from global';
810 $schema = 'get from global';
811 $foreign = isset( $args[6] ) ?
$args[6] : false;
814 $this->mFlags
= $flags;
815 if ( $this->mFlags
& DBO_DEFAULT
) {
816 if ( $wgCommandLineMode ) {
817 $this->mFlags
&= ~DBO_TRX
;
818 if ( $wgDebugDBTransactions ) {
819 wfDebug( "Implicit transaction open disabled.\n" );
822 $this->mFlags |
= DBO_TRX
;
823 if ( $wgDebugDBTransactions ) {
824 wfDebug( "Implicit transaction open enabled.\n" );
829 /** Get the default table prefix*/
830 if ( $tablePrefix == 'get from global' ) {
831 $this->mTablePrefix
= $wgDBprefix;
833 $this->mTablePrefix
= $tablePrefix;
836 /** Get the database schema*/
837 if ( $schema == 'get from global' ) {
838 $this->mSchema
= $wgDBmwschema;
840 $this->mSchema
= $schema;
843 $this->mForeign
= $foreign;
846 $this->open( $server, $user, $password, $dbName );
851 * Called by serialize. Throw an exception when DB connection is serialized.
852 * This causes problems on some database engines because the connection is
853 * not restored on unserialize.
855 public function __sleep() {
856 throw new MWException( 'Database serialization may cause problems, since ' .
857 'the connection is not restored on wakeup.' );
861 * Given a DB type, construct the name of the appropriate child class of
862 * DatabaseBase. This is designed to replace all of the manual stuff like:
863 * $class = 'Database' . ucfirst( strtolower( $dbType ) );
864 * as well as validate against the canonical list of DB types we have
866 * This factory function is mostly useful for when you need to connect to a
867 * database other than the MediaWiki default (such as for external auth,
868 * an extension, et cetera). Do not use this to connect to the MediaWiki
869 * database. Example uses in core:
870 * @see LoadBalancer::reallyOpenConnection()
871 * @see ForeignDBRepo::getMasterDB()
872 * @see WebInstallerDBConnect::execute()
876 * @param string $dbType A possible DB type
877 * @param array $p An array of options to pass to the constructor.
878 * Valid options are: host, user, password, dbname, flags, tablePrefix, schema, driver
879 * @throws MWException If the database driver or extension cannot be found
880 * @return DatabaseBase|null DatabaseBase subclass or null
882 final public static function factory( $dbType, $p = array() ) {
883 $canonicalDBTypes = array(
884 'mysql' => array( 'mysqli', 'mysql' ),
885 'postgres' => array(),
892 $dbType = strtolower( $dbType );
893 if ( isset( $canonicalDBTypes[$dbType] ) && $canonicalDBTypes[$dbType] ) {
894 $possibleDrivers = $canonicalDBTypes[$dbType];
895 if ( !empty( $p['driver'] ) ) {
896 if ( in_array( $p['driver'], $possibleDrivers ) ) {
897 $driver = $p['driver'];
899 throw new MWException( __METHOD__
.
900 " cannot construct Database with type '$dbType' and driver '{$p['driver']}'" );
903 foreach ( $possibleDrivers as $posDriver ) {
904 if ( extension_loaded( $posDriver ) ) {
905 $driver = $posDriver;
913 if ( $driver === false ) {
914 throw new MWException( __METHOD__
.
915 " no viable database extension found for type '$dbType'" );
918 // Determine schema defaults. Currently Microsoft SQL Server uses $wgDBmwschema,
919 // and everything else doesn't use a schema (e.g. null)
920 // Although postgres and oracle support schemas, we don't use them (yet)
921 // to maintain backwards compatibility
922 $defaultSchemas = array(
927 'mssql' => 'get from global',
930 $class = 'Database' . ucfirst( $driver );
931 if ( class_exists( $class ) && is_subclass_of( $class, 'DatabaseBase' ) ) {
933 'host' => isset( $p['host'] ) ?
$p['host'] : false,
934 'user' => isset( $p['user'] ) ?
$p['user'] : false,
935 'password' => isset( $p['password'] ) ?
$p['password'] : false,
936 'dbname' => isset( $p['dbname'] ) ?
$p['dbname'] : false,
937 'flags' => isset( $p['flags'] ) ?
$p['flags'] : 0,
938 'tablePrefix' => isset( $p['tablePrefix'] ) ?
$p['tablePrefix'] : 'get from global',
939 'schema' => isset( $p['schema'] ) ?
$p['schema'] : $defaultSchemas[$dbType],
940 'foreign' => isset( $p['foreign'] ) ?
$p['foreign'] : false
943 return new $class( $params );
949 protected function installErrorHandler() {
950 $this->mPHPError
= false;
951 $this->htmlErrors
= ini_set( 'html_errors', '0' );
952 set_error_handler( array( $this, 'connectionErrorHandler' ) );
956 * @return bool|string
958 protected function restoreErrorHandler() {
959 restore_error_handler();
960 if ( $this->htmlErrors
!== false ) {
961 ini_set( 'html_errors', $this->htmlErrors
);
963 if ( $this->mPHPError
) {
964 $error = preg_replace( '!\[<a.*</a>\]!', '', $this->mPHPError
);
965 $error = preg_replace( '!^.*?:\s?(.*)$!', '$1', $error );
975 * @param string $errstr
977 public function connectionErrorHandler( $errno, $errstr ) {
978 $this->mPHPError
= $errstr;
982 * Closes a database connection.
983 * if it is open : commits any open transactions
985 * @throws MWException
986 * @return bool Operation success. true if already closed.
988 public function close() {
989 if ( count( $this->mTrxIdleCallbacks
) ) { // sanity
990 throw new MWException( "Transaction idle callbacks still pending." );
992 if ( $this->mConn
) {
993 if ( $this->trxLevel() ) {
994 if ( !$this->mTrxAutomatic
) {
995 wfWarn( "Transaction still in progress (from {$this->mTrxFname}), " .
996 " performing implicit commit before closing connection!" );
999 $this->commit( __METHOD__
, 'flush' );
1002 $closed = $this->closeConnection();
1003 $this->mConn
= false;
1007 $this->mOpened
= false;
1013 * Closes underlying database connection
1015 * @return bool Whether connection was closed successfully
1017 abstract protected function closeConnection();
1020 * @param string $error Fallback error message, used if none is given by DB
1021 * @throws DBConnectionError
1023 function reportConnectionError( $error = 'Unknown error' ) {
1024 $myError = $this->lastError();
1030 throw new DBConnectionError( $this, $error );
1034 * The DBMS-dependent part of query()
1036 * @param string $sql SQL query.
1037 * @return ResultWrapper|bool Result object to feed to fetchObject,
1038 * fetchRow, ...; or false on failure
1040 abstract protected function doQuery( $sql );
1043 * Determine whether a query writes to the DB.
1044 * Should return true if unsure.
1046 * @param string $sql
1049 public function isWriteQuery( $sql ) {
1050 return !preg_match( '/^(?:SELECT|BEGIN|ROLLBACK|COMMIT|SET|SHOW|EXPLAIN|\(SELECT)\b/i', $sql );
1054 * Run an SQL query and return the result. Normally throws a DBQueryError
1055 * on failure. If errors are ignored, returns false instead.
1057 * In new code, the query wrappers select(), insert(), update(), delete(),
1058 * etc. should be used where possible, since they give much better DBMS
1059 * independence and automatically quote or validate user input in a variety
1060 * of contexts. This function is generally only useful for queries which are
1061 * explicitly DBMS-dependent and are unsupported by the query wrappers, such
1064 * However, the query wrappers themselves should call this function.
1066 * @param string $sql SQL query
1067 * @param string $fname Name of the calling function, for profiling/SHOW PROCESSLIST
1068 * comment (you can use __METHOD__ or add some extra info)
1069 * @param bool $tempIgnore Whether to avoid throwing an exception on errors...
1070 * maybe best to catch the exception instead?
1071 * @throws MWException
1072 * @return bool|ResultWrapper True for a successful write query, ResultWrapper object
1073 * for a successful read query, or false on failure if $tempIgnore set
1075 public function query( $sql, $fname = __METHOD__
, $tempIgnore = false ) {
1076 global $wgUser, $wgDebugDBTransactions, $wgDebugDumpSqlLength;
1078 $this->mLastQuery
= $sql;
1079 if ( $this->isWriteQuery( $sql ) ) {
1080 # Set a flag indicating that writes have been done
1081 wfDebug( __METHOD__
. ': Writes done: ' . DatabaseBase
::generalizeSQL( $sql ) . "\n" );
1082 $this->mDoneWrites
= microtime( true );
1085 # Add a comment for easy SHOW PROCESSLIST interpretation
1086 if ( is_object( $wgUser ) && $wgUser->isItemLoaded( 'name' ) ) {
1087 $userName = $wgUser->getName();
1088 if ( mb_strlen( $userName ) > 15 ) {
1089 $userName = mb_substr( $userName, 0, 15 ) . '...';
1091 $userName = str_replace( '/', '', $userName );
1096 // Add trace comment to the begin of the sql string, right after the operator.
1097 // Or, for one-word queries (like "BEGIN" or COMMIT") add it to the end (bug 42598)
1098 $commentedSql = preg_replace( '/\s|$/', " /* $fname $userName */ ", $sql, 1 );
1100 # If DBO_TRX is set, start a transaction
1101 if ( ( $this->mFlags
& DBO_TRX
) && !$this->mTrxLevel
&&
1102 $sql != 'BEGIN' && $sql != 'COMMIT' && $sql != 'ROLLBACK'
1104 # Avoid establishing transactions for SHOW and SET statements too -
1105 # that would delay transaction initializations to once connection
1106 # is really used by application
1107 $sqlstart = substr( $sql, 0, 10 ); // very much worth it, benchmark certified(tm)
1108 if ( strpos( $sqlstart, "SHOW " ) !== 0 && strpos( $sqlstart, "SET " ) !== 0 ) {
1109 if ( $wgDebugDBTransactions ) {
1110 wfDebug( "Implicit transaction start.\n" );
1112 $this->begin( __METHOD__
. " ($fname)" );
1113 $this->mTrxAutomatic
= true;
1117 # Keep track of whether the transaction has write queries pending
1118 if ( $this->mTrxLevel
&& !$this->mTrxDoneWrites
&& $this->isWriteQuery( $sql ) ) {
1119 $this->mTrxDoneWrites
= true;
1120 Profiler
::instance()->getTransactionProfiler()->transactionWritingIn(
1121 $this->mServer
, $this->mDBname
, $this->mTrxShortId
);
1126 $isMaster = !is_null( $this->getLBInfo( 'master' ) );
1128 if ( !Profiler
::instance()->isStub() ) {
1129 # generalizeSQL will probably cut down the query to reasonable
1130 # logging size most of the time. The substr is really just a sanity check.
1132 $queryProf = 'query-m: ' . substr( DatabaseBase
::generalizeSQL( $sql ), 0, 255 );
1133 $totalProf = 'DatabaseBase::query-master';
1135 $queryProf = 'query: ' . substr( DatabaseBase
::generalizeSQL( $sql ), 0, 255 );
1136 $totalProf = 'DatabaseBase::query';
1138 # Include query transaction state
1139 $queryProf .= $this->mTrxShortId ?
" [TRX#{$this->mTrxShortId}]" : "";
1141 $trx = $this->mTrxLevel ?
'TRX=yes' : 'TRX=no';
1142 wfProfileIn( $totalProf );
1143 wfProfileIn( $queryProf );
1146 if ( $this->debug() ) {
1150 $sqlx = $wgDebugDumpSqlLength ?
substr( $commentedSql, 0, $wgDebugDumpSqlLength )
1152 $sqlx = strtr( $sqlx, "\t\n", ' ' );
1154 $master = $isMaster ?
'master' : 'slave';
1155 wfDebug( "Query {$this->mDBname} ($cnt) ($master): $sqlx\n" );
1158 $queryId = MWDebug
::query( $sql, $fname, $isMaster );
1160 # Avoid fatals if close() was called
1161 if ( !$this->isOpen() ) {
1162 throw new DBUnexpectedError( $this, "DB connection was already closed." );
1165 # Log the query time and feed it into the DB trx profiler
1166 $queryStartTime = microtime( true );
1167 $queryProfile = new ScopedCallback( function() use ( $queryStartTime, $queryProf ) {
1168 $elapsed = microtime( true ) - $queryStartTime;
1169 $trxProfiler = Profiler
::instance()->getTransactionProfiler();
1170 $trxProfiler->recordFunctionCompletion( $queryProf, $elapsed );
1173 # Do the query and handle errors
1174 $ret = $this->doQuery( $commentedSql );
1176 MWDebug
::queryTime( $queryId );
1178 # Try reconnecting if the connection was lost
1179 if ( false === $ret && $this->wasErrorReissuable() ) {
1180 # Transaction is gone, like it or not
1181 $hadTrx = $this->mTrxLevel
; // possible lost transaction
1182 $this->mTrxLevel
= 0;
1183 $this->mTrxIdleCallbacks
= array(); // bug 65263
1184 $this->mTrxPreCommitCallbacks
= array(); // bug 65263
1185 wfDebug( "Connection lost, reconnecting...\n" );
1186 # Stash the last error values since ping() might clear them
1187 $lastError = $this->lastError();
1188 $lastErrno = $this->lastErrno();
1189 if ( $this->ping() ) {
1190 global $wgRequestTime;
1191 wfDebug( "Reconnected\n" );
1192 $sqlx = $wgDebugDumpSqlLength ?
substr( $commentedSql, 0, $wgDebugDumpSqlLength )
1194 $sqlx = strtr( $sqlx, "\t\n", ' ' );
1195 $elapsed = round( microtime( true ) - $wgRequestTime, 3 );
1196 if ( $elapsed < 300 ) {
1197 # Not a database error to lose a transaction after a minute or two
1198 wfLogDBError( "Connection lost and reconnected after {$elapsed}s, query: $sqlx" );
1201 # Leave $ret as false and let an error be reported.
1202 # Callers may catch the exception and continue to use the DB.
1203 $this->reportQueryError( $lastError, $lastErrno, $sql, $fname, $tempIgnore );
1205 # Should be safe to silently retry (no trx and thus no callbacks)
1206 $ret = $this->doQuery( $commentedSql );
1209 wfDebug( "Failed\n" );
1213 if ( false === $ret ) {
1214 $this->reportQueryError( $this->lastError(), $this->lastErrno(), $sql, $fname, $tempIgnore );
1217 if ( !Profiler
::instance()->isStub() ) {
1218 wfProfileOut( $queryProf );
1219 wfProfileOut( $totalProf );
1222 return $this->resultObject( $ret );
1226 * Report a query error. Log the error, and if neither the object ignore
1227 * flag nor the $tempIgnore flag is set, throw a DBQueryError.
1229 * @param string $error
1231 * @param string $sql
1232 * @param string $fname
1233 * @param bool $tempIgnore
1234 * @throws DBQueryError
1236 public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) {
1237 # Ignore errors during error handling to avoid infinite recursion
1238 $ignore = $this->ignoreErrors( true );
1239 ++
$this->mErrorCount
;
1241 if ( $ignore ||
$tempIgnore ) {
1242 wfDebug( "SQL ERROR (ignored): $error\n" );
1243 $this->ignoreErrors( $ignore );
1245 $sql1line = mb_substr( str_replace( "\n", "\\n", $sql ), 0, 5 * 1024 );
1246 wfLogDBError( "$fname\t{$this->mServer}\t$errno\t$error\t$sql1line" );
1247 wfDebug( "SQL ERROR: " . $error . "\n" );
1248 throw new DBQueryError( $this, $error, $errno, $sql, $fname );
1253 * Intended to be compatible with the PEAR::DB wrapper functions.
1254 * http://pear.php.net/manual/en/package.database.db.intro-execute.php
1256 * ? = scalar value, quoted as necessary
1257 * ! = raw SQL bit (a function for instance)
1258 * & = filename; reads the file and inserts as a blob
1259 * (we don't use this though...)
1261 * @param string $sql
1262 * @param string $func
1266 protected function prepare( $sql, $func = 'DatabaseBase::prepare' ) {
1267 /* MySQL doesn't support prepared statements (yet), so just
1268 * pack up the query for reference. We'll manually replace
1271 return array( 'query' => $sql, 'func' => $func );
1275 * Free a prepared query, generated by prepare().
1276 * @param string $prepared
1278 protected function freePrepared( $prepared ) {
1279 /* No-op by default */
1283 * Execute a prepared query with the various arguments
1284 * @param string $prepared The prepared sql
1285 * @param mixed $args Either an array here, or put scalars as varargs
1287 * @return ResultWrapper
1289 public function execute( $prepared, $args = null ) {
1290 if ( !is_array( $args ) ) {
1292 $args = func_get_args();
1293 array_shift( $args );
1296 $sql = $this->fillPrepared( $prepared['query'], $args );
1298 return $this->query( $sql, $prepared['func'] );
1302 * For faking prepared SQL statements on DBs that don't support it directly.
1304 * @param string $preparedQuery A 'preparable' SQL statement
1305 * @param array $args Array of Arguments to fill it with
1306 * @return string Executable SQL
1308 public function fillPrepared( $preparedQuery, $args ) {
1310 $this->preparedArgs
=& $args;
1312 return preg_replace_callback( '/(\\\\[?!&]|[?!&])/',
1313 array( &$this, 'fillPreparedArg' ), $preparedQuery );
1317 * preg_callback func for fillPrepared()
1318 * The arguments should be in $this->preparedArgs and must not be touched
1319 * while we're doing this.
1321 * @param array $matches
1322 * @throws DBUnexpectedError
1325 protected function fillPreparedArg( $matches ) {
1326 switch ( $matches[1] ) {
1335 list( /* $n */, $arg ) = each( $this->preparedArgs
);
1337 switch ( $matches[1] ) {
1339 return $this->addQuotes( $arg );
1343 # return $this->addQuotes( file_get_contents( $arg ) );
1344 throw new DBUnexpectedError(
1346 '& mode is not implemented. If it\'s really needed, uncomment the line above.'
1349 throw new DBUnexpectedError(
1351 'Received invalid match. This should never happen!'
1357 * Free a result object returned by query() or select(). It's usually not
1358 * necessary to call this, just use unset() or let the variable holding
1359 * the result object go out of scope.
1361 * @param mixed $res A SQL result
1363 public function freeResult( $res ) {
1367 * A SELECT wrapper which returns a single field from a single result row.
1369 * Usually throws a DBQueryError on failure. If errors are explicitly
1370 * ignored, returns false on failure.
1372 * If no result rows are returned from the query, false is returned.
1374 * @param string|array $table Table name. See DatabaseBase::select() for details.
1375 * @param string $var The field name to select. This must be a valid SQL
1376 * fragment: do not use unvalidated user input.
1377 * @param string|array $cond The condition array. See DatabaseBase::select() for details.
1378 * @param string $fname The function name of the caller.
1379 * @param string|array $options The query options. See DatabaseBase::select() for details.
1381 * @return bool|mixed The value from the field, or false on failure.
1383 public function selectField( $table, $var, $cond = '', $fname = __METHOD__
,
1386 if ( !is_array( $options ) ) {
1387 $options = array( $options );
1390 $options['LIMIT'] = 1;
1392 $res = $this->select( $table, $var, $cond, $fname, $options );
1394 if ( $res === false ||
!$this->numRows( $res ) ) {
1398 $row = $this->fetchRow( $res );
1400 if ( $row !== false ) {
1401 return reset( $row );
1408 * Returns an optional USE INDEX clause to go after the table, and a
1409 * string to go at the end of the query.
1411 * @param array $options Associative array of options to be turned into
1412 * an SQL query, valid keys are listed in the function.
1414 * @see DatabaseBase::select()
1416 public function makeSelectOptions( $options ) {
1417 $preLimitTail = $postLimitTail = '';
1420 $noKeyOptions = array();
1422 foreach ( $options as $key => $option ) {
1423 if ( is_numeric( $key ) ) {
1424 $noKeyOptions[$option] = true;
1428 $preLimitTail .= $this->makeGroupByWithHaving( $options );
1430 $preLimitTail .= $this->makeOrderBy( $options );
1432 // if (isset($options['LIMIT'])) {
1433 // $tailOpts .= $this->limitResult('', $options['LIMIT'],
1434 // isset($options['OFFSET']) ? $options['OFFSET']
1438 if ( isset( $noKeyOptions['FOR UPDATE'] ) ) {
1439 $postLimitTail .= ' FOR UPDATE';
1442 if ( isset( $noKeyOptions['LOCK IN SHARE MODE'] ) ) {
1443 $postLimitTail .= ' LOCK IN SHARE MODE';
1446 if ( isset( $noKeyOptions['DISTINCT'] ) ||
isset( $noKeyOptions['DISTINCTROW'] ) ) {
1447 $startOpts .= 'DISTINCT';
1450 # Various MySQL extensions
1451 if ( isset( $noKeyOptions['STRAIGHT_JOIN'] ) ) {
1452 $startOpts .= ' /*! STRAIGHT_JOIN */';
1455 if ( isset( $noKeyOptions['HIGH_PRIORITY'] ) ) {
1456 $startOpts .= ' HIGH_PRIORITY';
1459 if ( isset( $noKeyOptions['SQL_BIG_RESULT'] ) ) {
1460 $startOpts .= ' SQL_BIG_RESULT';
1463 if ( isset( $noKeyOptions['SQL_BUFFER_RESULT'] ) ) {
1464 $startOpts .= ' SQL_BUFFER_RESULT';
1467 if ( isset( $noKeyOptions['SQL_SMALL_RESULT'] ) ) {
1468 $startOpts .= ' SQL_SMALL_RESULT';
1471 if ( isset( $noKeyOptions['SQL_CALC_FOUND_ROWS'] ) ) {
1472 $startOpts .= ' SQL_CALC_FOUND_ROWS';
1475 if ( isset( $noKeyOptions['SQL_CACHE'] ) ) {
1476 $startOpts .= ' SQL_CACHE';
1479 if ( isset( $noKeyOptions['SQL_NO_CACHE'] ) ) {
1480 $startOpts .= ' SQL_NO_CACHE';
1483 if ( isset( $options['USE INDEX'] ) && is_string( $options['USE INDEX'] ) ) {
1484 $useIndex = $this->useIndexClause( $options['USE INDEX'] );
1489 return array( $startOpts, $useIndex, $preLimitTail, $postLimitTail );
1493 * Returns an optional GROUP BY with an optional HAVING
1495 * @param array $options Associative array of options
1497 * @see DatabaseBase::select()
1500 public function makeGroupByWithHaving( $options ) {
1502 if ( isset( $options['GROUP BY'] ) ) {
1503 $gb = is_array( $options['GROUP BY'] )
1504 ?
implode( ',', $options['GROUP BY'] )
1505 : $options['GROUP BY'];
1506 $sql .= ' GROUP BY ' . $gb;
1508 if ( isset( $options['HAVING'] ) ) {
1509 $having = is_array( $options['HAVING'] )
1510 ?
$this->makeList( $options['HAVING'], LIST_AND
)
1511 : $options['HAVING'];
1512 $sql .= ' HAVING ' . $having;
1519 * Returns an optional ORDER BY
1521 * @param array $options Associative array of options
1523 * @see DatabaseBase::select()
1526 public function makeOrderBy( $options ) {
1527 if ( isset( $options['ORDER BY'] ) ) {
1528 $ob = is_array( $options['ORDER BY'] )
1529 ?
implode( ',', $options['ORDER BY'] )
1530 : $options['ORDER BY'];
1532 return ' ORDER BY ' . $ob;
1539 * Execute a SELECT query constructed using the various parameters provided.
1540 * See below for full details of the parameters.
1542 * @param string|array $table Table name
1543 * @param string|array $vars Field names
1544 * @param string|array $conds Conditions
1545 * @param string $fname Caller function name
1546 * @param array $options Query options
1547 * @param array $join_conds Join conditions
1550 * @param string|array $table
1552 * May be either an array of table names, or a single string holding a table
1553 * name. If an array is given, table aliases can be specified, for example:
1555 * array( 'a' => 'user' )
1557 * This includes the user table in the query, with the alias "a" available
1558 * for use in field names (e.g. a.user_name).
1560 * All of the table names given here are automatically run through
1561 * DatabaseBase::tableName(), which causes the table prefix (if any) to be
1562 * added, and various other table name mappings to be performed.
1565 * @param string|array $vars
1567 * May be either a field name or an array of field names. The field names
1568 * can be complete fragments of SQL, for direct inclusion into the SELECT
1569 * query. If an array is given, field aliases can be specified, for example:
1571 * array( 'maxrev' => 'MAX(rev_id)' )
1573 * This includes an expression with the alias "maxrev" in the query.
1575 * If an expression is given, care must be taken to ensure that it is
1579 * @param string|array $conds
1581 * May be either a string containing a single condition, or an array of
1582 * conditions. If an array is given, the conditions constructed from each
1583 * element are combined with AND.
1585 * Array elements may take one of two forms:
1587 * - Elements with a numeric key are interpreted as raw SQL fragments.
1588 * - Elements with a string key are interpreted as equality conditions,
1589 * where the key is the field name.
1590 * - If the value of such an array element is a scalar (such as a
1591 * string), it will be treated as data and thus quoted appropriately.
1592 * If it is null, an IS NULL clause will be added.
1593 * - If the value is an array, an IN(...) clause will be constructed,
1594 * such that the field name may match any of the elements in the
1595 * array. The elements of the array will be quoted.
1597 * Note that expressions are often DBMS-dependent in their syntax.
1598 * DBMS-independent wrappers are provided for constructing several types of
1599 * expression commonly used in condition queries. See:
1600 * - DatabaseBase::buildLike()
1601 * - DatabaseBase::conditional()
1604 * @param string|array $options
1606 * Optional: Array of query options. Boolean options are specified by
1607 * including them in the array as a string value with a numeric key, for
1610 * array( 'FOR UPDATE' )
1612 * The supported options are:
1614 * - OFFSET: Skip this many rows at the start of the result set. OFFSET
1615 * with LIMIT can theoretically be used for paging through a result set,
1616 * but this is discouraged in MediaWiki for performance reasons.
1618 * - LIMIT: Integer: return at most this many rows. The rows are sorted
1619 * and then the first rows are taken until the limit is reached. LIMIT
1620 * is applied to a result set after OFFSET.
1622 * - FOR UPDATE: Boolean: lock the returned rows so that they can't be
1623 * changed until the next COMMIT.
1625 * - DISTINCT: Boolean: return only unique result rows.
1627 * - GROUP BY: May be either an SQL fragment string naming a field or
1628 * expression to group by, or an array of such SQL fragments.
1630 * - HAVING: May be either an string containing a HAVING clause or an array of
1631 * conditions building the HAVING clause. If an array is given, the conditions
1632 * constructed from each element are combined with AND.
1634 * - ORDER BY: May be either an SQL fragment giving a field name or
1635 * expression to order by, or an array of such SQL fragments.
1637 * - USE INDEX: This may be either a string giving the index name to use
1638 * for the query, or an array. If it is an associative array, each key
1639 * gives the table name (or alias), each value gives the index name to
1640 * use for that table. All strings are SQL fragments and so should be
1641 * validated by the caller.
1643 * - EXPLAIN: In MySQL, this causes an EXPLAIN SELECT query to be run,
1644 * instead of SELECT.
1646 * And also the following boolean MySQL extensions, see the MySQL manual
1647 * for documentation:
1649 * - LOCK IN SHARE MODE
1653 * - SQL_BUFFER_RESULT
1654 * - SQL_SMALL_RESULT
1655 * - SQL_CALC_FOUND_ROWS
1660 * @param string|array $join_conds
1662 * Optional associative array of table-specific join conditions. In the
1663 * most common case, this is unnecessary, since the join condition can be
1664 * in $conds. However, it is useful for doing a LEFT JOIN.
1666 * The key of the array contains the table name or alias. The value is an
1667 * array with two elements, numbered 0 and 1. The first gives the type of
1668 * join, the second is an SQL fragment giving the join condition for that
1669 * table. For example:
1671 * array( 'page' => array( 'LEFT JOIN', 'page_latest=rev_id' ) )
1673 * @return ResultWrapper|bool If the query returned no rows, a ResultWrapper
1674 * with no rows in it will be returned. If there was a query error, a
1675 * DBQueryError exception will be thrown, except if the "ignore errors"
1676 * option was set, in which case false will be returned.
1678 public function select( $table, $vars, $conds = '', $fname = __METHOD__
,
1679 $options = array(), $join_conds = array() ) {
1680 $sql = $this->selectSQLText( $table, $vars, $conds, $fname, $options, $join_conds );
1682 return $this->query( $sql, $fname );
1686 * The equivalent of DatabaseBase::select() except that the constructed SQL
1687 * is returned, instead of being immediately executed. This can be useful for
1688 * doing UNION queries, where the SQL text of each query is needed. In general,
1689 * however, callers outside of Database classes should just use select().
1691 * @param string|array $table Table name
1692 * @param string|array $vars Field names
1693 * @param string|array $conds Conditions
1694 * @param string $fname Caller function name
1695 * @param string|array $options Query options
1696 * @param string|array $join_conds Join conditions
1698 * @return string SQL query string.
1699 * @see DatabaseBase::select()
1701 public function selectSQLText( $table, $vars, $conds = '', $fname = __METHOD__
,
1702 $options = array(), $join_conds = array()
1704 if ( is_array( $vars ) ) {
1705 $vars = implode( ',', $this->fieldNamesWithAlias( $vars ) );
1708 $options = (array)$options;
1709 $useIndexes = ( isset( $options['USE INDEX'] ) && is_array( $options['USE INDEX'] ) )
1710 ?
$options['USE INDEX']
1713 if ( is_array( $table ) ) {
1715 $this->tableNamesWithUseIndexOrJOIN( $table, $useIndexes, $join_conds );
1716 } elseif ( $table != '' ) {
1717 if ( $table[0] == ' ' ) {
1718 $from = ' FROM ' . $table;
1721 $this->tableNamesWithUseIndexOrJOIN( array( $table ), $useIndexes, array() );
1727 list( $startOpts, $useIndex, $preLimitTail, $postLimitTail ) =
1728 $this->makeSelectOptions( $options );
1730 if ( !empty( $conds ) ) {
1731 if ( is_array( $conds ) ) {
1732 $conds = $this->makeList( $conds, LIST_AND
);
1734 $sql = "SELECT $startOpts $vars $from $useIndex WHERE $conds $preLimitTail";
1736 $sql = "SELECT $startOpts $vars $from $useIndex $preLimitTail";
1739 if ( isset( $options['LIMIT'] ) ) {
1740 $sql = $this->limitResult( $sql, $options['LIMIT'],
1741 isset( $options['OFFSET'] ) ?
$options['OFFSET'] : false );
1743 $sql = "$sql $postLimitTail";
1745 if ( isset( $options['EXPLAIN'] ) ) {
1746 $sql = 'EXPLAIN ' . $sql;
1753 * Single row SELECT wrapper. Equivalent to DatabaseBase::select(), except
1754 * that a single row object is returned. If the query returns no rows,
1755 * false is returned.
1757 * @param string|array $table Table name
1758 * @param string|array $vars Field names
1759 * @param array $conds Conditions
1760 * @param string $fname Caller function name
1761 * @param string|array $options Query options
1762 * @param array|string $join_conds Join conditions
1764 * @return stdClass|bool
1766 public function selectRow( $table, $vars, $conds, $fname = __METHOD__
,
1767 $options = array(), $join_conds = array()
1769 $options = (array)$options;
1770 $options['LIMIT'] = 1;
1771 $res = $this->select( $table, $vars, $conds, $fname, $options, $join_conds );
1773 if ( $res === false ) {
1777 if ( !$this->numRows( $res ) ) {
1781 $obj = $this->fetchObject( $res );
1787 * Estimate the number of rows in dataset
1789 * MySQL allows you to estimate the number of rows that would be returned
1790 * by a SELECT query, using EXPLAIN SELECT. The estimate is provided using
1791 * index cardinality statistics, and is notoriously inaccurate, especially
1792 * when large numbers of rows have recently been added or deleted.
1794 * For DBMSs that don't support fast result size estimation, this function
1795 * will actually perform the SELECT COUNT(*).
1797 * Takes the same arguments as DatabaseBase::select().
1799 * @param string $table Table name
1800 * @param string $vars Unused
1801 * @param array|string $conds Filters on the table
1802 * @param string $fname Function name for profiling
1803 * @param array $options Options for select
1804 * @return int Row count
1806 public function estimateRowCount(
1807 $table, $vars = '*', $conds = '', $fname = __METHOD__
, $options = array()
1810 $res = $this->select( $table, array( 'rowcount' => 'COUNT(*)' ), $conds, $fname, $options );
1813 $row = $this->fetchRow( $res );
1814 $rows = ( isset( $row['rowcount'] ) ) ?
$row['rowcount'] : 0;
1821 * Get the number of rows in dataset
1823 * This is useful when trying to do COUNT(*) but with a LIMIT for performance.
1825 * Takes the same arguments as DatabaseBase::select().
1827 * @param string $table Table name
1828 * @param string $vars Unused
1829 * @param array|string $conds Filters on the table
1830 * @param string $fname Function name for profiling
1831 * @param array $options Options for select
1832 * @return int Row count
1835 public function selectRowCount(
1836 $table, $vars = '*', $conds = '', $fname = __METHOD__
, $options = array()
1839 $sql = $this->selectSQLText( $table, '1', $conds, $fname, $options );
1840 $res = $this->query( "SELECT COUNT(*) AS rowcount FROM ($sql) tmp_count" );
1843 $row = $this->fetchRow( $res );
1844 $rows = ( isset( $row['rowcount'] ) ) ?
$row['rowcount'] : 0;
1851 * Removes most variables from an SQL query and replaces them with X or N for numbers.
1852 * It's only slightly flawed. Don't use for anything important.
1854 * @param string $sql A SQL Query
1858 static function generalizeSQL( $sql ) {
1859 # This does the same as the regexp below would do, but in such a way
1860 # as to avoid crashing php on some large strings.
1861 # $sql = preg_replace( "/'([^\\\\']|\\\\.)*'|\"([^\\\\\"]|\\\\.)*\"/", "'X'", $sql );
1863 $sql = str_replace( "\\\\", '', $sql );
1864 $sql = str_replace( "\\'", '', $sql );
1865 $sql = str_replace( "\\\"", '', $sql );
1866 $sql = preg_replace( "/'.*'/s", "'X'", $sql );
1867 $sql = preg_replace( '/".*"/s', "'X'", $sql );
1869 # All newlines, tabs, etc replaced by single space
1870 $sql = preg_replace( '/\s+/', ' ', $sql );
1873 # except the ones surrounded by characters, e.g. l10n
1874 $sql = preg_replace( '/-?\d+(,-?\d+)+/s', 'N,...,N', $sql );
1875 $sql = preg_replace( '/(?<![a-zA-Z])-?\d+(?![a-zA-Z])/s', 'N', $sql );
1881 * Determines whether a field exists in a table
1883 * @param string $table Table name
1884 * @param string $field Filed to check on that table
1885 * @param string $fname Calling function name (optional)
1886 * @return bool Whether $table has filed $field
1888 public function fieldExists( $table, $field, $fname = __METHOD__
) {
1889 $info = $this->fieldInfo( $table, $field );
1895 * Determines whether an index exists
1896 * Usually throws a DBQueryError on failure
1897 * If errors are explicitly ignored, returns NULL on failure
1899 * @param string $table
1900 * @param string $index
1901 * @param string $fname
1904 public function indexExists( $table, $index, $fname = __METHOD__
) {
1905 if ( !$this->tableExists( $table ) ) {
1909 $info = $this->indexInfo( $table, $index, $fname );
1910 if ( is_null( $info ) ) {
1913 return $info !== false;
1918 * Query whether a given table exists
1920 * @param string $table
1921 * @param string $fname
1924 public function tableExists( $table, $fname = __METHOD__
) {
1925 $table = $this->tableName( $table );
1926 $old = $this->ignoreErrors( true );
1927 $res = $this->query( "SELECT 1 FROM $table LIMIT 1", $fname );
1928 $this->ignoreErrors( $old );
1934 * Determines if a given index is unique
1936 * @param string $table
1937 * @param string $index
1941 public function indexUnique( $table, $index ) {
1942 $indexInfo = $this->indexInfo( $table, $index );
1944 if ( !$indexInfo ) {
1948 return !$indexInfo[0]->Non_unique
;
1952 * Helper for DatabaseBase::insert().
1954 * @param array $options
1957 protected function makeInsertOptions( $options ) {
1958 return implode( ' ', $options );
1962 * INSERT wrapper, inserts an array into a table.
1966 * - A single associative array. The array keys are the field names, and
1967 * the values are the values to insert. The values are treated as data
1968 * and will be quoted appropriately. If NULL is inserted, this will be
1969 * converted to a database NULL.
1970 * - An array with numeric keys, holding a list of associative arrays.
1971 * This causes a multi-row INSERT on DBMSs that support it. The keys in
1972 * each subarray must be identical to each other, and in the same order.
1974 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
1977 * $options is an array of options, with boolean options encoded as values
1978 * with numeric keys, in the same style as $options in
1979 * DatabaseBase::select(). Supported options are:
1981 * - IGNORE: Boolean: if present, duplicate key errors are ignored, and
1982 * any rows which cause duplicate key errors are not inserted. It's
1983 * possible to determine how many rows were successfully inserted using
1984 * DatabaseBase::affectedRows().
1986 * @param string $table Table name. This will be passed through
1987 * DatabaseBase::tableName().
1988 * @param array $a Array of rows to insert
1989 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
1990 * @param array $options Array of options
1994 public function insert( $table, $a, $fname = __METHOD__
, $options = array() ) {
1995 # No rows to insert, easy just return now
1996 if ( !count( $a ) ) {
2000 $table = $this->tableName( $table );
2002 if ( !is_array( $options ) ) {
2003 $options = array( $options );
2007 if ( isset( $options['fileHandle'] ) ) {
2008 $fh = $options['fileHandle'];
2010 $options = $this->makeInsertOptions( $options );
2012 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
2014 $keys = array_keys( $a[0] );
2017 $keys = array_keys( $a );
2020 $sql = 'INSERT ' . $options .
2021 " INTO $table (" . implode( ',', $keys ) . ') VALUES ';
2025 foreach ( $a as $row ) {
2031 $sql .= '(' . $this->makeList( $row ) . ')';
2034 $sql .= '(' . $this->makeList( $a ) . ')';
2037 if ( $fh !== null && false === fwrite( $fh, $sql ) ) {
2039 } elseif ( $fh !== null ) {
2043 return (bool)$this->query( $sql, $fname );
2047 * Make UPDATE options array for DatabaseBase::makeUpdateOptions
2049 * @param array $options
2052 protected function makeUpdateOptionsArray( $options ) {
2053 if ( !is_array( $options ) ) {
2054 $options = array( $options );
2059 if ( in_array( 'LOW_PRIORITY', $options ) ) {
2060 $opts[] = $this->lowPriorityOption();
2063 if ( in_array( 'IGNORE', $options ) ) {
2071 * Make UPDATE options for the DatabaseBase::update function
2073 * @param array $options The options passed to DatabaseBase::update
2076 protected function makeUpdateOptions( $options ) {
2077 $opts = $this->makeUpdateOptionsArray( $options );
2079 return implode( ' ', $opts );
2083 * UPDATE wrapper. Takes a condition array and a SET array.
2085 * @param string $table Name of the table to UPDATE. This will be passed through
2086 * DatabaseBase::tableName().
2087 * @param array $values An array of values to SET. For each array element,
2088 * the key gives the field name, and the value gives the data to set
2089 * that field to. The data will be quoted by DatabaseBase::addQuotes().
2090 * @param array $conds An array of conditions (WHERE). See
2091 * DatabaseBase::select() for the details of the format of condition
2092 * arrays. Use '*' to update all rows.
2093 * @param string $fname The function name of the caller (from __METHOD__),
2094 * for logging and profiling.
2095 * @param array $options An array of UPDATE options, can be:
2096 * - IGNORE: Ignore unique key conflicts
2097 * - LOW_PRIORITY: MySQL-specific, see MySQL manual.
2100 function update( $table, $values, $conds, $fname = __METHOD__
, $options = array() ) {
2101 $table = $this->tableName( $table );
2102 $opts = $this->makeUpdateOptions( $options );
2103 $sql = "UPDATE $opts $table SET " . $this->makeList( $values, LIST_SET
);
2105 if ( $conds !== array() && $conds !== '*' ) {
2106 $sql .= " WHERE " . $this->makeList( $conds, LIST_AND
);
2109 return $this->query( $sql, $fname );
2113 * Makes an encoded list of strings from an array
2115 * @param array $a Containing the data
2116 * @param int $mode Constant
2117 * - LIST_COMMA: Comma separated, no field names
2118 * - LIST_AND: ANDed WHERE clause (without the WHERE). See the
2119 * documentation for $conds in DatabaseBase::select().
2120 * - LIST_OR: ORed WHERE clause (without the WHERE)
2121 * - LIST_SET: Comma separated with field names, like a SET clause
2122 * - LIST_NAMES: Comma separated field names
2123 * @throws MWException|DBUnexpectedError
2126 public function makeList( $a, $mode = LIST_COMMA
) {
2127 if ( !is_array( $a ) ) {
2128 throw new DBUnexpectedError( $this, 'DatabaseBase::makeList called with incorrect parameters' );
2134 foreach ( $a as $field => $value ) {
2136 if ( $mode == LIST_AND
) {
2138 } elseif ( $mode == LIST_OR
) {
2147 if ( ( $mode == LIST_AND ||
$mode == LIST_OR
) && is_numeric( $field ) ) {
2148 $list .= "($value)";
2149 } elseif ( ( $mode == LIST_SET
) && is_numeric( $field ) ) {
2151 } elseif ( ( $mode == LIST_AND ||
$mode == LIST_OR
) && is_array( $value ) ) {
2152 if ( count( $value ) == 0 ) {
2153 throw new MWException( __METHOD__
. ": empty input for field $field" );
2154 } elseif ( count( $value ) == 1 ) {
2155 // Special-case single values, as IN isn't terribly efficient
2156 // Don't necessarily assume the single key is 0; we don't
2157 // enforce linear numeric ordering on other arrays here.
2158 $value = array_values( $value );
2159 $list .= $field . " = " . $this->addQuotes( $value[0] );
2161 $list .= $field . " IN (" . $this->makeList( $value ) . ") ";
2163 } elseif ( $value === null ) {
2164 if ( $mode == LIST_AND ||
$mode == LIST_OR
) {
2165 $list .= "$field IS ";
2166 } elseif ( $mode == LIST_SET
) {
2167 $list .= "$field = ";
2171 if ( $mode == LIST_AND ||
$mode == LIST_OR ||
$mode == LIST_SET
) {
2172 $list .= "$field = ";
2174 $list .= $mode == LIST_NAMES ?
$value : $this->addQuotes( $value );
2182 * Build a partial where clause from a 2-d array such as used for LinkBatch.
2183 * The keys on each level may be either integers or strings.
2185 * @param array $data Organized as 2-d
2186 * array(baseKeyVal => array(subKeyVal => [ignored], ...), ...)
2187 * @param string $baseKey Field name to match the base-level keys to (eg 'pl_namespace')
2188 * @param string $subKey Field name to match the sub-level keys to (eg 'pl_title')
2189 * @return string|bool SQL fragment, or false if no items in array
2191 public function makeWhereFrom2d( $data, $baseKey, $subKey ) {
2194 foreach ( $data as $base => $sub ) {
2195 if ( count( $sub ) ) {
2196 $conds[] = $this->makeList(
2197 array( $baseKey => $base, $subKey => array_keys( $sub ) ),
2203 return $this->makeList( $conds, LIST_OR
);
2205 // Nothing to search for...
2211 * Return aggregated value alias
2213 * @param array $valuedata
2214 * @param string $valuename
2218 public function aggregateValue( $valuedata, $valuename = 'value' ) {
2223 * @param string $field
2226 public function bitNot( $field ) {
2231 * @param string $fieldLeft
2232 * @param string $fieldRight
2235 public function bitAnd( $fieldLeft, $fieldRight ) {
2236 return "($fieldLeft & $fieldRight)";
2240 * @param string $fieldLeft
2241 * @param string $fieldRight
2244 public function bitOr( $fieldLeft, $fieldRight ) {
2245 return "($fieldLeft | $fieldRight)";
2249 * Build a concatenation list to feed into a SQL query
2250 * @param array $stringList List of raw SQL expressions; caller is
2251 * responsible for any quoting
2254 public function buildConcat( $stringList ) {
2255 return 'CONCAT(' . implode( ',', $stringList ) . ')';
2259 * Build a GROUP_CONCAT or equivalent statement for a query.
2261 * This is useful for combining a field for several rows into a single string.
2262 * NULL values will not appear in the output, duplicated values will appear,
2263 * and the resulting delimiter-separated values have no defined sort order.
2264 * Code using the results may need to use the PHP unique() or sort() methods.
2266 * @param string $delim Glue to bind the results together
2267 * @param string|array $table Table name
2268 * @param string $field Field name
2269 * @param string|array $conds Conditions
2270 * @param string|array $join_conds Join conditions
2271 * @return string SQL text
2274 public function buildGroupConcatField(
2275 $delim, $table, $field, $conds = '', $join_conds = array()
2277 $fld = "GROUP_CONCAT($field SEPARATOR " . $this->addQuotes( $delim ) . ')';
2279 return '(' . $this->selectSQLText( $table, $fld, $conds, null, array(), $join_conds ) . ')';
2283 * Change the current database
2285 * @todo Explain what exactly will fail if this is not overridden.
2289 * @return bool Success or failure
2291 public function selectDB( $db ) {
2292 # Stub. Shouldn't cause serious problems if it's not overridden, but
2293 # if your database engine supports a concept similar to MySQL's
2294 # databases you may as well.
2295 $this->mDBname
= $db;
2301 * Get the current DB name
2304 public function getDBname() {
2305 return $this->mDBname
;
2309 * Get the server hostname or IP address
2312 public function getServer() {
2313 return $this->mServer
;
2317 * Format a table name ready for use in constructing an SQL query
2319 * This does two important things: it quotes the table names to clean them up,
2320 * and it adds a table prefix if only given a table name with no quotes.
2322 * All functions of this object which require a table name call this function
2323 * themselves. Pass the canonical name to such functions. This is only needed
2324 * when calling query() directly.
2326 * @param string $name Database table name
2327 * @param string $format One of:
2328 * quoted - Automatically pass the table name through addIdentifierQuotes()
2329 * so that it can be used in a query.
2330 * raw - Do not add identifier quotes to the table name
2331 * @return string Full database name
2333 public function tableName( $name, $format = 'quoted' ) {
2334 global $wgSharedDB, $wgSharedPrefix, $wgSharedTables, $wgSharedSchema;
2335 # Skip the entire process when we have a string quoted on both ends.
2336 # Note that we check the end so that we will still quote any use of
2337 # use of `database`.table. But won't break things if someone wants
2338 # to query a database table with a dot in the name.
2339 if ( $this->isQuotedIdentifier( $name ) ) {
2343 # Lets test for any bits of text that should never show up in a table
2344 # name. Basically anything like JOIN or ON which are actually part of
2345 # SQL queries, but may end up inside of the table value to combine
2346 # sql. Such as how the API is doing.
2347 # Note that we use a whitespace test rather than a \b test to avoid
2348 # any remote case where a word like on may be inside of a table name
2349 # surrounded by symbols which may be considered word breaks.
2350 if ( preg_match( '/(^|\s)(DISTINCT|JOIN|ON|AS)(\s|$)/i', $name ) !== 0 ) {
2354 # Split database and table into proper variables.
2355 # We reverse the explode so that database.table and table both output
2356 # the correct table.
2357 $dbDetails = explode( '.', $name, 3 );
2358 if ( count( $dbDetails ) == 3 ) {
2359 list( $database, $schema, $table ) = $dbDetails;
2360 # We don't want any prefix added in this case
2362 } elseif ( count( $dbDetails ) == 2 ) {
2363 list( $database, $table ) = $dbDetails;
2364 # We don't want any prefix added in this case
2365 # In dbs that support it, $database may actually be the schema
2366 # but that doesn't affect any of the functionality here
2370 list( $table ) = $dbDetails;
2371 if ( $wgSharedDB !== null # We have a shared database
2372 && $this->mForeign
== false # We're not working on a foreign database
2373 && !$this->isQuotedIdentifier( $table ) # Prevent shared tables listing '`table`'
2374 && in_array( $table, $wgSharedTables ) # A shared table is selected
2376 $database = $wgSharedDB;
2377 $schema = $wgSharedSchema === null ?
$this->mSchema
: $wgSharedSchema;
2378 $prefix = $wgSharedPrefix === null ?
$this->mTablePrefix
: $wgSharedPrefix;
2381 $schema = $this->mSchema
; # Default schema
2382 $prefix = $this->mTablePrefix
; # Default prefix
2386 # Quote $table and apply the prefix if not quoted.
2387 # $tableName might be empty if this is called from Database::replaceVars()
2388 $tableName = "{$prefix}{$table}";
2389 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $tableName ) && $tableName !== '' ) {
2390 $tableName = $this->addIdentifierQuotes( $tableName );
2393 # Quote $schema and merge it with the table name if needed
2394 if ( $schema !== null ) {
2395 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $schema ) ) {
2396 $schema = $this->addIdentifierQuotes( $schema );
2398 $tableName = $schema . '.' . $tableName;
2401 # Quote $database and merge it with the table name if needed
2402 if ( $database !== null ) {
2403 if ( $format == 'quoted' && !$this->isQuotedIdentifier( $database ) ) {
2404 $database = $this->addIdentifierQuotes( $database );
2406 $tableName = $database . '.' . $tableName;
2413 * Fetch a number of table names into an array
2414 * This is handy when you need to construct SQL for joins
2417 * extract( $dbr->tableNames( 'user', 'watchlist' ) );
2418 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
2419 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
2423 public function tableNames() {
2424 $inArray = func_get_args();
2427 foreach ( $inArray as $name ) {
2428 $retVal[$name] = $this->tableName( $name );
2435 * Fetch a number of table names into an zero-indexed numerical array
2436 * This is handy when you need to construct SQL for joins
2439 * list( $user, $watchlist ) = $dbr->tableNamesN( 'user', 'watchlist' );
2440 * $sql = "SELECT wl_namespace,wl_title FROM $watchlist,$user
2441 * WHERE wl_user=user_id AND wl_user=$nameWithQuotes";
2445 public function tableNamesN() {
2446 $inArray = func_get_args();
2449 foreach ( $inArray as $name ) {
2450 $retVal[] = $this->tableName( $name );
2457 * Get an aliased table name
2458 * e.g. tableName AS newTableName
2460 * @param string $name Table name, see tableName()
2461 * @param string|bool $alias Alias (optional)
2462 * @return string SQL name for aliased table. Will not alias a table to its own name
2464 public function tableNameWithAlias( $name, $alias = false ) {
2465 if ( !$alias ||
$alias == $name ) {
2466 return $this->tableName( $name );
2468 return $this->tableName( $name ) . ' ' . $this->addIdentifierQuotes( $alias );
2473 * Gets an array of aliased table names
2475 * @param array $tables Array( [alias] => table )
2476 * @return string[] See tableNameWithAlias()
2478 public function tableNamesWithAlias( $tables ) {
2480 foreach ( $tables as $alias => $table ) {
2481 if ( is_numeric( $alias ) ) {
2484 $retval[] = $this->tableNameWithAlias( $table, $alias );
2491 * Get an aliased field name
2492 * e.g. fieldName AS newFieldName
2494 * @param string $name Field name
2495 * @param string|bool $alias Alias (optional)
2496 * @return string SQL name for aliased field. Will not alias a field to its own name
2498 public function fieldNameWithAlias( $name, $alias = false ) {
2499 if ( !$alias ||
(string)$alias === (string)$name ) {
2502 return $name . ' AS ' . $alias; //PostgreSQL needs AS
2507 * Gets an array of aliased field names
2509 * @param array $fields Array( [alias] => field )
2510 * @return string[] See fieldNameWithAlias()
2512 public function fieldNamesWithAlias( $fields ) {
2514 foreach ( $fields as $alias => $field ) {
2515 if ( is_numeric( $alias ) ) {
2518 $retval[] = $this->fieldNameWithAlias( $field, $alias );
2525 * Get the aliased table name clause for a FROM clause
2526 * which might have a JOIN and/or USE INDEX clause
2528 * @param array $tables ( [alias] => table )
2529 * @param array $use_index Same as for select()
2530 * @param array $join_conds Same as for select()
2533 protected function tableNamesWithUseIndexOrJOIN(
2534 $tables, $use_index = array(), $join_conds = array()
2538 $use_index = (array)$use_index;
2539 $join_conds = (array)$join_conds;
2541 foreach ( $tables as $alias => $table ) {
2542 if ( !is_string( $alias ) ) {
2543 // No alias? Set it equal to the table name
2546 // Is there a JOIN clause for this table?
2547 if ( isset( $join_conds[$alias] ) ) {
2548 list( $joinType, $conds ) = $join_conds[$alias];
2549 $tableClause = $joinType;
2550 $tableClause .= ' ' . $this->tableNameWithAlias( $table, $alias );
2551 if ( isset( $use_index[$alias] ) ) { // has USE INDEX?
2552 $use = $this->useIndexClause( implode( ',', (array)$use_index[$alias] ) );
2554 $tableClause .= ' ' . $use;
2557 $on = $this->makeList( (array)$conds, LIST_AND
);
2559 $tableClause .= ' ON (' . $on . ')';
2562 $retJOIN[] = $tableClause;
2563 } elseif ( isset( $use_index[$alias] ) ) {
2564 // Is there an INDEX clause for this table?
2565 $tableClause = $this->tableNameWithAlias( $table, $alias );
2566 $tableClause .= ' ' . $this->useIndexClause(
2567 implode( ',', (array)$use_index[$alias] )
2570 $ret[] = $tableClause;
2572 $tableClause = $this->tableNameWithAlias( $table, $alias );
2574 $ret[] = $tableClause;
2578 // We can't separate explicit JOIN clauses with ',', use ' ' for those
2579 $implicitJoins = !empty( $ret ) ?
implode( ',', $ret ) : "";
2580 $explicitJoins = !empty( $retJOIN ) ?
implode( ' ', $retJOIN ) : "";
2582 // Compile our final table clause
2583 return implode( ' ', array( $implicitJoins, $explicitJoins ) );
2587 * Get the name of an index in a given table
2589 * @param string $index
2592 protected function indexName( $index ) {
2593 // Backwards-compatibility hack
2595 'ar_usertext_timestamp' => 'usertext_timestamp',
2596 'un_user_id' => 'user_id',
2597 'un_user_ip' => 'user_ip',
2600 if ( isset( $renamed[$index] ) ) {
2601 return $renamed[$index];
2608 * Adds quotes and backslashes.
2613 public function addQuotes( $s ) {
2614 if ( $s === null ) {
2617 # This will also quote numeric values. This should be harmless,
2618 # and protects against weird problems that occur when they really
2619 # _are_ strings such as article titles and string->number->string
2620 # conversion is not 1:1.
2621 return "'" . $this->strencode( $s ) . "'";
2626 * Quotes an identifier using `backticks` or "double quotes" depending on the database type.
2627 * MySQL uses `backticks` while basically everything else uses double quotes.
2628 * Since MySQL is the odd one out here the double quotes are our generic
2629 * and we implement backticks in DatabaseMysql.
2634 public function addIdentifierQuotes( $s ) {
2635 return '"' . str_replace( '"', '""', $s ) . '"';
2639 * Returns if the given identifier looks quoted or not according to
2640 * the database convention for quoting identifiers .
2642 * @param string $name
2645 public function isQuotedIdentifier( $name ) {
2646 return $name[0] == '"' && substr( $name, -1, 1 ) == '"';
2653 protected function escapeLikeInternal( $s ) {
2654 return addcslashes( $s, '\%_' );
2658 * LIKE statement wrapper, receives a variable-length argument list with
2659 * parts of pattern to match containing either string literals that will be
2660 * escaped or tokens returned by anyChar() or anyString(). Alternatively,
2661 * the function could be provided with an array of aforementioned
2664 * Example: $dbr->buildLike( 'My_page_title/', $dbr->anyString() ) returns
2665 * a LIKE clause that searches for subpages of 'My page title'.
2667 * $pattern = array( 'My_page_title/', $dbr->anyString() );
2668 * $query .= $dbr->buildLike( $pattern );
2671 * @return string Fully built LIKE statement
2673 public function buildLike() {
2674 $params = func_get_args();
2676 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
2677 $params = $params[0];
2682 foreach ( $params as $value ) {
2683 if ( $value instanceof LikeMatch
) {
2684 $s .= $value->toString();
2686 $s .= $this->escapeLikeInternal( $value );
2690 return " LIKE {$this->addQuotes( $s )} ";
2694 * Returns a token for buildLike() that denotes a '_' to be used in a LIKE query
2698 public function anyChar() {
2699 return new LikeMatch( '_' );
2703 * Returns a token for buildLike() that denotes a '%' to be used in a LIKE query
2707 public function anyString() {
2708 return new LikeMatch( '%' );
2712 * Returns an appropriately quoted sequence value for inserting a new row.
2713 * MySQL has autoincrement fields, so this is just NULL. But the PostgreSQL
2714 * subclass will return an integer, and save the value for insertId()
2716 * Any implementation of this function should *not* involve reusing
2717 * sequence numbers created for rolled-back transactions.
2718 * See http://bugs.mysql.com/bug.php?id=30767 for details.
2719 * @param string $seqName
2722 public function nextSequenceValue( $seqName ) {
2727 * USE INDEX clause. Unlikely to be useful for anything but MySQL. This
2728 * is only needed because a) MySQL must be as efficient as possible due to
2729 * its use on Wikipedia, and b) MySQL 4.0 is kind of dumb sometimes about
2730 * which index to pick. Anyway, other databases might have different
2731 * indexes on a given table. So don't bother overriding this unless you're
2733 * @param string $index
2736 public function useIndexClause( $index ) {
2741 * REPLACE query wrapper.
2743 * REPLACE is a very handy MySQL extension, which functions like an INSERT
2744 * except that when there is a duplicate key error, the old row is deleted
2745 * and the new row is inserted in its place.
2747 * We simulate this with standard SQL with a DELETE followed by INSERT. To
2748 * perform the delete, we need to know what the unique indexes are so that
2749 * we know how to find the conflicting rows.
2751 * It may be more efficient to leave off unique indexes which are unlikely
2752 * to collide. However if you do this, you run the risk of encountering
2753 * errors which wouldn't have occurred in MySQL.
2755 * @param string $table The table to replace the row(s) in.
2756 * @param array $uniqueIndexes Is an array of indexes. Each element may be either
2757 * a field name or an array of field names
2758 * @param array $rows Can be either a single row to insert, or multiple rows,
2759 * in the same format as for DatabaseBase::insert()
2760 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
2762 public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
2763 $quotedTable = $this->tableName( $table );
2765 if ( count( $rows ) == 0 ) {
2770 if ( !is_array( reset( $rows ) ) ) {
2771 $rows = array( $rows );
2774 foreach ( $rows as $row ) {
2775 # Delete rows which collide
2776 if ( $uniqueIndexes ) {
2777 $sql = "DELETE FROM $quotedTable WHERE ";
2779 foreach ( $uniqueIndexes as $index ) {
2786 if ( is_array( $index ) ) {
2788 foreach ( $index as $col ) {
2794 $sql .= $col . '=' . $this->addQuotes( $row[$col] );
2797 $sql .= $index . '=' . $this->addQuotes( $row[$index] );
2801 $this->query( $sql, $fname );
2804 # Now insert the row
2805 $this->insert( $table, $row, $fname );
2810 * REPLACE query wrapper for MySQL and SQLite, which have a native REPLACE
2813 * @param string $table Table name
2814 * @param array|string $rows Row(s) to insert
2815 * @param string $fname Caller function name
2817 * @return ResultWrapper
2819 protected function nativeReplace( $table, $rows, $fname ) {
2820 $table = $this->tableName( $table );
2823 if ( !is_array( reset( $rows ) ) ) {
2824 $rows = array( $rows );
2827 $sql = "REPLACE INTO $table (" . implode( ',', array_keys( $rows[0] ) ) . ') VALUES ';
2830 foreach ( $rows as $row ) {
2837 $sql .= '(' . $this->makeList( $row ) . ')';
2840 return $this->query( $sql, $fname );
2844 * INSERT ON DUPLICATE KEY UPDATE wrapper, upserts an array into a table.
2846 * This updates any conflicting rows (according to the unique indexes) using
2847 * the provided SET clause and inserts any remaining (non-conflicted) rows.
2849 * $rows may be either:
2850 * - A single associative array. The array keys are the field names, and
2851 * the values are the values to insert. The values are treated as data
2852 * and will be quoted appropriately. If NULL is inserted, this will be
2853 * converted to a database NULL.
2854 * - An array with numeric keys, holding a list of associative arrays.
2855 * This causes a multi-row INSERT on DBMSs that support it. The keys in
2856 * each subarray must be identical to each other, and in the same order.
2858 * It may be more efficient to leave off unique indexes which are unlikely
2859 * to collide. However if you do this, you run the risk of encountering
2860 * errors which wouldn't have occurred in MySQL.
2862 * Usually throws a DBQueryError on failure. If errors are explicitly ignored,
2867 * @param string $table Table name. This will be passed through DatabaseBase::tableName().
2868 * @param array $rows A single row or list of rows to insert
2869 * @param array $uniqueIndexes List of single field names or field name tuples
2870 * @param array $set An array of values to SET. For each array element, the
2871 * key gives the field name, and the value gives the data to set that
2872 * field to. The data will be quoted by DatabaseBase::addQuotes().
2873 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
2877 public function upsert( $table, array $rows, array $uniqueIndexes, array $set,
2880 if ( !count( $rows ) ) {
2881 return true; // nothing to do
2884 if ( !is_array( reset( $rows ) ) ) {
2885 $rows = array( $rows );
2888 if ( count( $uniqueIndexes ) ) {
2889 $clauses = array(); // list WHERE clauses that each identify a single row
2890 foreach ( $rows as $row ) {
2891 foreach ( $uniqueIndexes as $index ) {
2892 $index = is_array( $index ) ?
$index : array( $index ); // columns
2893 $rowKey = array(); // unique key to this row
2894 foreach ( $index as $column ) {
2895 $rowKey[$column] = $row[$column];
2897 $clauses[] = $this->makeList( $rowKey, LIST_AND
);
2900 $where = array( $this->makeList( $clauses, LIST_OR
) );
2905 $useTrx = !$this->mTrxLevel
;
2907 $this->begin( $fname );
2910 # Update any existing conflicting row(s)
2911 if ( $where !== false ) {
2912 $ok = $this->update( $table, $set, $where, $fname );
2916 # Now insert any non-conflicting row(s)
2917 $ok = $this->insert( $table, $rows, $fname, array( 'IGNORE' ) ) && $ok;
2918 } catch ( Exception
$e ) {
2920 $this->rollback( $fname );
2925 $this->commit( $fname );
2932 * DELETE where the condition is a join.
2934 * MySQL overrides this to use a multi-table DELETE syntax, in other databases
2935 * we use sub-selects
2937 * For safety, an empty $conds will not delete everything. If you want to
2938 * delete all rows where the join condition matches, set $conds='*'.
2940 * DO NOT put the join condition in $conds.
2942 * @param string $delTable The table to delete from.
2943 * @param string $joinTable The other table.
2944 * @param string $delVar The variable to join on, in the first table.
2945 * @param string $joinVar The variable to join on, in the second table.
2946 * @param array $conds Condition array of field names mapped to variables,
2947 * ANDed together in the WHERE clause
2948 * @param string $fname Calling function name (use __METHOD__) for logs/profiling
2949 * @throws DBUnexpectedError
2951 public function deleteJoin( $delTable, $joinTable, $delVar, $joinVar, $conds,
2955 throw new DBUnexpectedError( $this,
2956 'DatabaseBase::deleteJoin() called with empty $conds' );
2959 $delTable = $this->tableName( $delTable );
2960 $joinTable = $this->tableName( $joinTable );
2961 $sql = "DELETE FROM $delTable WHERE $delVar IN (SELECT $joinVar FROM $joinTable ";
2962 if ( $conds != '*' ) {
2963 $sql .= 'WHERE ' . $this->makeList( $conds, LIST_AND
);
2967 $this->query( $sql, $fname );
2971 * Returns the size of a text field, or -1 for "unlimited"
2973 * @param string $table
2974 * @param string $field
2977 public function textFieldSize( $table, $field ) {
2978 $table = $this->tableName( $table );
2979 $sql = "SHOW COLUMNS FROM $table LIKE \"$field\";";
2980 $res = $this->query( $sql, 'DatabaseBase::textFieldSize' );
2981 $row = $this->fetchObject( $res );
2985 if ( preg_match( '/\((.*)\)/', $row->Type
, $m ) ) {
2995 * A string to insert into queries to show that they're low-priority, like
2996 * MySQL's LOW_PRIORITY. If no such feature exists, return an empty
2997 * string and nothing bad should happen.
2999 * @return string Returns the text of the low priority option if it is
3000 * supported, or a blank string otherwise
3002 public function lowPriorityOption() {
3007 * DELETE query wrapper.
3009 * @param array $table Table name
3010 * @param string|array $conds Array of conditions. See $conds in DatabaseBase::select()
3011 * for the format. Use $conds == "*" to delete all rows
3012 * @param string $fname Name of the calling function
3013 * @throws DBUnexpectedError
3014 * @return bool|ResultWrapper
3016 public function delete( $table, $conds, $fname = __METHOD__
) {
3018 throw new DBUnexpectedError( $this, 'DatabaseBase::delete() called with no conditions' );
3021 $table = $this->tableName( $table );
3022 $sql = "DELETE FROM $table";
3024 if ( $conds != '*' ) {
3025 if ( is_array( $conds ) ) {
3026 $conds = $this->makeList( $conds, LIST_AND
);
3028 $sql .= ' WHERE ' . $conds;
3031 return $this->query( $sql, $fname );
3035 * INSERT SELECT wrapper. Takes data from a SELECT query and inserts it
3036 * into another table.
3038 * @param string $destTable The table name to insert into
3039 * @param string|array $srcTable May be either a table name, or an array of table names
3040 * to include in a join.
3042 * @param array $varMap Must be an associative array of the form
3043 * array( 'dest1' => 'source1', ...). Source items may be literals
3044 * rather than field names, but strings should be quoted with
3045 * DatabaseBase::addQuotes()
3047 * @param array $conds Condition array. See $conds in DatabaseBase::select() for
3048 * the details of the format of condition arrays. May be "*" to copy the
3051 * @param string $fname The function name of the caller, from __METHOD__
3053 * @param array $insertOptions Options for the INSERT part of the query, see
3054 * DatabaseBase::insert() for details.
3055 * @param array $selectOptions Options for the SELECT part of the query, see
3056 * DatabaseBase::select() for details.
3058 * @return ResultWrapper
3060 public function insertSelect( $destTable, $srcTable, $varMap, $conds,
3061 $fname = __METHOD__
,
3062 $insertOptions = array(), $selectOptions = array()
3064 $destTable = $this->tableName( $destTable );
3066 if ( !is_array( $insertOptions ) ) {
3067 $insertOptions = array( $insertOptions );
3070 $insertOptions = $this->makeInsertOptions( $insertOptions );
3072 if ( !is_array( $selectOptions ) ) {
3073 $selectOptions = array( $selectOptions );
3076 list( $startOpts, $useIndex, $tailOpts ) = $this->makeSelectOptions( $selectOptions );
3078 if ( is_array( $srcTable ) ) {
3079 $srcTable = implode( ',', array_map( array( &$this, 'tableName' ), $srcTable ) );
3081 $srcTable = $this->tableName( $srcTable );
3084 $sql = "INSERT $insertOptions INTO $destTable (" . implode( ',', array_keys( $varMap ) ) . ')' .
3085 " SELECT $startOpts " . implode( ',', $varMap ) .
3086 " FROM $srcTable $useIndex ";
3088 if ( $conds != '*' ) {
3089 if ( is_array( $conds ) ) {
3090 $conds = $this->makeList( $conds, LIST_AND
);
3092 $sql .= " WHERE $conds";
3095 $sql .= " $tailOpts";
3097 return $this->query( $sql, $fname );
3101 * Construct a LIMIT query with optional offset. This is used for query
3102 * pages. The SQL should be adjusted so that only the first $limit rows
3103 * are returned. If $offset is provided as well, then the first $offset
3104 * rows should be discarded, and the next $limit rows should be returned.
3105 * If the result of the query is not ordered, then the rows to be returned
3106 * are theoretically arbitrary.
3108 * $sql is expected to be a SELECT, if that makes a difference.
3110 * The version provided by default works in MySQL and SQLite. It will very
3111 * likely need to be overridden for most other DBMSes.
3113 * @param string $sql SQL query we will append the limit too
3114 * @param int $limit The SQL limit
3115 * @param int|bool $offset The SQL offset (default false)
3116 * @throws DBUnexpectedError
3119 public function limitResult( $sql, $limit, $offset = false ) {
3120 if ( !is_numeric( $limit ) ) {
3121 throw new DBUnexpectedError( $this, "Invalid non-numeric limit passed to limitResult()\n" );
3124 return "$sql LIMIT "
3125 . ( ( is_numeric( $offset ) && $offset != 0 ) ?
"{$offset}," : "" )
3130 * Returns true if current database backend supports ORDER BY or LIMIT for separate subqueries
3131 * within the UNION construct.
3134 public function unionSupportsOrderAndLimit() {
3135 return true; // True for almost every DB supported
3139 * Construct a UNION query
3140 * This is used for providing overload point for other DB abstractions
3141 * not compatible with the MySQL syntax.
3142 * @param array $sqls SQL statements to combine
3143 * @param bool $all Use UNION ALL
3144 * @return string SQL fragment
3146 public function unionQueries( $sqls, $all ) {
3147 $glue = $all ?
') UNION ALL (' : ') UNION (';
3149 return '(' . implode( $glue, $sqls ) . ')';
3153 * Returns an SQL expression for a simple conditional. This doesn't need
3154 * to be overridden unless CASE isn't supported in your DBMS.
3156 * @param string|array $cond SQL expression which will result in a boolean value
3157 * @param string $trueVal SQL expression to return if true
3158 * @param string $falseVal SQL expression to return if false
3159 * @return string SQL fragment
3161 public function conditional( $cond, $trueVal, $falseVal ) {
3162 if ( is_array( $cond ) ) {
3163 $cond = $this->makeList( $cond, LIST_AND
);
3166 return " (CASE WHEN $cond THEN $trueVal ELSE $falseVal END) ";
3170 * Returns a comand for str_replace function in SQL query.
3171 * Uses REPLACE() in MySQL
3173 * @param string $orig Column to modify
3174 * @param string $old Column to seek
3175 * @param string $new Column to replace with
3179 public function strreplace( $orig, $old, $new ) {
3180 return "REPLACE({$orig}, {$old}, {$new})";
3184 * Determines how long the server has been up
3189 public function getServerUptime() {
3194 * Determines if the last failure was due to a deadlock
3199 public function wasDeadlock() {
3204 * Determines if the last failure was due to a lock timeout
3209 public function wasLockTimeout() {
3214 * Determines if the last query error was something that should be dealt
3215 * with by pinging the connection and reissuing the query.
3220 public function wasErrorReissuable() {
3225 * Determines if the last failure was due to the database being read-only.
3230 public function wasReadOnlyError() {
3235 * Perform a deadlock-prone transaction.
3237 * This function invokes a callback function to perform a set of write
3238 * queries. If a deadlock occurs during the processing, the transaction
3239 * will be rolled back and the callback function will be called again.
3242 * $dbw->deadlockLoop( callback, ... );
3244 * Extra arguments are passed through to the specified callback function.
3246 * Returns whatever the callback function returned on its successful,
3247 * iteration, or false on error, for example if the retry limit was
3252 public function deadlockLoop() {
3253 $this->begin( __METHOD__
);
3254 $args = func_get_args();
3255 $function = array_shift( $args );
3256 $oldIgnore = $this->ignoreErrors( true );
3257 $tries = self
::DEADLOCK_TRIES
;
3259 if ( is_array( $function ) ) {
3260 $fname = $function[0];
3266 $retVal = call_user_func_array( $function, $args );
3267 $error = $this->lastError();
3268 $errno = $this->lastErrno();
3269 $sql = $this->lastQuery();
3272 if ( $this->wasDeadlock() ) {
3274 usleep( mt_rand( self
::DEADLOCK_DELAY_MIN
, self
::DEADLOCK_DELAY_MAX
) );
3276 $this->reportQueryError( $error, $errno, $sql, $fname );
3279 } while ( $this->wasDeadlock() && --$tries > 0 );
3281 $this->ignoreErrors( $oldIgnore );
3283 if ( $tries <= 0 ) {
3284 $this->rollback( __METHOD__
);
3285 $this->reportQueryError( $error, $errno, $sql, $fname );
3289 $this->commit( __METHOD__
);
3296 * Wait for the slave to catch up to a given master position.
3298 * @param DBMasterPos $pos
3299 * @param int $timeout The maximum number of seconds to wait for
3301 * @return int Zero if the slave was past that position already,
3302 * greater than zero if we waited for some period of time, less than
3303 * zero if we timed out.
3305 public function masterPosWait( DBMasterPos
$pos, $timeout ) {
3306 # Real waits are implemented in the subclass.
3311 * Get the replication position of this slave
3313 * @return DBMasterPos|bool False if this is not a slave.
3315 public function getSlavePos() {
3321 * Get the position of this master
3323 * @return DBMasterPos|bool False if this is not a master
3325 public function getMasterPos() {
3331 * Run an anonymous function as soon as there is no transaction pending.
3332 * If there is a transaction and it is rolled back, then the callback is cancelled.
3333 * Queries in the function will run in AUTO-COMMIT mode unless there are begin() calls.
3334 * Callbacks must commit any transactions that they begin.
3336 * This is useful for updates to different systems or when separate transactions are needed.
3337 * For example, one might want to enqueue jobs into a system outside the database, but only
3338 * after the database is updated so that the jobs will see the data when they actually run.
3339 * It can also be used for updates that easily cause deadlocks if locks are held too long.
3341 * @param callable $callback
3344 final public function onTransactionIdle( $callback ) {
3345 $this->mTrxIdleCallbacks
[] = array( $callback, wfGetCaller() );
3346 if ( !$this->mTrxLevel
) {
3347 $this->runOnTransactionIdleCallbacks();
3352 * Run an anonymous function before the current transaction commits or now if there is none.
3353 * If there is a transaction and it is rolled back, then the callback is cancelled.
3354 * Callbacks must not start nor commit any transactions.
3356 * This is useful for updates that easily cause deadlocks if locks are held too long
3357 * but where atomicity is strongly desired for these updates and some related updates.
3359 * @param callable $callback
3362 final public function onTransactionPreCommitOrIdle( $callback ) {
3363 if ( $this->mTrxLevel
) {
3364 $this->mTrxPreCommitCallbacks
[] = array( $callback, wfGetCaller() );
3366 $this->onTransactionIdle( $callback ); // this will trigger immediately
3371 * Actually any "on transaction idle" callbacks.
3375 protected function runOnTransactionIdleCallbacks() {
3376 $autoTrx = $this->getFlag( DBO_TRX
); // automatic begin() enabled?
3378 $e = $ePrior = null; // last exception
3379 do { // callbacks may add callbacks :)
3380 $callbacks = $this->mTrxIdleCallbacks
;
3381 $this->mTrxIdleCallbacks
= array(); // recursion guard
3382 foreach ( $callbacks as $callback ) {
3384 list( $phpCallback ) = $callback;
3385 $this->clearFlag( DBO_TRX
); // make each query its own transaction
3386 call_user_func( $phpCallback );
3387 $this->setFlag( $autoTrx ? DBO_TRX
: 0 ); // restore automatic begin()
3388 } catch ( Exception
$e ) {
3390 MWExceptionHandler
::logException( $ePrior );
3395 } while ( count( $this->mTrxIdleCallbacks
) );
3397 if ( $e instanceof Exception
) {
3398 throw $e; // re-throw any last exception
3403 * Actually any "on transaction pre-commit" callbacks.
3407 protected function runOnTransactionPreCommitCallbacks() {
3408 $e = $ePrior = null; // last exception
3409 do { // callbacks may add callbacks :)
3410 $callbacks = $this->mTrxPreCommitCallbacks
;
3411 $this->mTrxPreCommitCallbacks
= array(); // recursion guard
3412 foreach ( $callbacks as $callback ) {
3414 list( $phpCallback ) = $callback;
3415 call_user_func( $phpCallback );
3416 } catch ( Exception
$e ) {
3418 MWExceptionHandler
::logException( $ePrior );
3423 } while ( count( $this->mTrxPreCommitCallbacks
) );
3425 if ( $e instanceof Exception
) {
3426 throw $e; // re-throw any last exception
3431 * Begin an atomic section of statements
3433 * If a transaction has been started already, just keep track of the given
3434 * section name to make sure the transaction is not committed pre-maturely.
3435 * This function can be used in layers (with sub-sections), so use a stack
3436 * to keep track of the different atomic sections. If there is no transaction,
3437 * start one implicitly.
3439 * The goal of this function is to create an atomic section of SQL queries
3440 * without having to start a new transaction if it already exists.
3442 * Atomic sections are more strict than transactions. With transactions,
3443 * attempting to begin a new transaction when one is already running results
3444 * in MediaWiki issuing a brief warning and doing an implicit commit. All
3445 * atomic levels *must* be explicitly closed using DatabaseBase::endAtomic(),
3446 * and any database transactions cannot be began or committed until all atomic
3447 * levels are closed. There is no such thing as implicitly opening or closing
3448 * an atomic section.
3451 * @param string $fname
3454 final public function startAtomic( $fname = __METHOD__
) {
3455 if ( !$this->mTrxLevel
) {
3456 $this->begin( $fname );
3457 $this->mTrxAutomatic
= true;
3458 $this->mTrxAutomaticAtomic
= true;
3461 $this->mTrxAtomicLevels
->push( $fname );
3465 * Ends an atomic section of SQL statements
3467 * Ends the next section of atomic SQL statements and commits the transaction
3471 * @see DatabaseBase::startAtomic
3472 * @param string $fname
3475 final public function endAtomic( $fname = __METHOD__
) {
3476 if ( !$this->mTrxLevel
) {
3477 throw new DBUnexpectedError( $this, 'No atomic transaction is open.' );
3479 if ( $this->mTrxAtomicLevels
->isEmpty() ||
3480 $this->mTrxAtomicLevels
->pop() !== $fname
3482 throw new DBUnexpectedError( $this, 'Invalid atomic section ended.' );
3485 if ( $this->mTrxAtomicLevels
->isEmpty() && $this->mTrxAutomaticAtomic
) {
3486 $this->commit( $fname, 'flush' );
3491 * Begin a transaction. If a transaction is already in progress,
3492 * that transaction will be committed before the new transaction is started.
3494 * Note that when the DBO_TRX flag is set (which is usually the case for web
3495 * requests, but not for maintenance scripts), any previous database query
3496 * will have started a transaction automatically.
3498 * Nesting of transactions is not supported. Attempts to nest transactions
3499 * will cause a warning, unless the current transaction was started
3500 * automatically because of the DBO_TRX flag.
3502 * @param string $fname
3505 final public function begin( $fname = __METHOD__
) {
3506 global $wgDebugDBTransactions;
3508 if ( $this->mTrxLevel
) { // implicit commit
3509 if ( !$this->mTrxAtomicLevels
->isEmpty() ) {
3510 // If the current transaction was an automatic atomic one, then we definitely have
3511 // a problem. Same if there is any unclosed atomic level.
3512 throw new DBUnexpectedError( $this,
3513 "Attempted to start explicit transaction when atomic levels are still open."
3515 } elseif ( !$this->mTrxAutomatic
) {
3516 // We want to warn about inadvertently nested begin/commit pairs, but not about
3517 // auto-committing implicit transactions that were started by query() via DBO_TRX
3518 $msg = "$fname: Transaction already in progress (from {$this->mTrxFname}), " .
3519 " performing implicit commit!";
3521 wfLogDBError( $msg );
3523 // if the transaction was automatic and has done write operations,
3524 // log it if $wgDebugDBTransactions is enabled.
3525 if ( $this->mTrxDoneWrites
&& $wgDebugDBTransactions ) {
3526 wfDebug( "$fname: Automatic transaction with writes in progress" .
3527 " (from {$this->mTrxFname}), performing implicit commit!\n"
3532 $this->runOnTransactionPreCommitCallbacks();
3533 $this->doCommit( $fname );
3534 if ( $this->mTrxDoneWrites
) {
3535 Profiler
::instance()->getTransactionProfiler()->transactionWritingOut(
3536 $this->mServer
, $this->mDBname
, $this->mTrxShortId
);
3538 $this->runOnTransactionIdleCallbacks();
3541 # Avoid fatals if close() was called
3542 if ( !$this->isOpen() ) {
3543 throw new DBUnexpectedError( $this, "DB connection was already closed." );
3546 $this->doBegin( $fname );
3547 $this->mTrxTimestamp
= microtime( true );
3548 $this->mTrxFname
= $fname;
3549 $this->mTrxDoneWrites
= false;
3550 $this->mTrxAutomatic
= false;
3551 $this->mTrxAutomaticAtomic
= false;
3552 $this->mTrxAtomicLevels
= new SplStack
;
3553 $this->mTrxIdleCallbacks
= array();
3554 $this->mTrxPreCommitCallbacks
= array();
3555 $this->mTrxShortId
= wfRandomString( 12 );
3559 * Issues the BEGIN command to the database server.
3561 * @see DatabaseBase::begin()
3562 * @param string $fname
3564 protected function doBegin( $fname ) {
3565 $this->query( 'BEGIN', $fname );
3566 $this->mTrxLevel
= 1;
3570 * Commits a transaction previously started using begin().
3571 * If no transaction is in progress, a warning is issued.
3573 * Nesting of transactions is not supported.
3575 * @param string $fname
3576 * @param string $flush Flush flag, set to 'flush' to disable warnings about
3577 * explicitly committing implicit transactions, or calling commit when no
3578 * transaction is in progress. This will silently break any ongoing
3579 * explicit transaction. Only set the flush flag if you are sure that it
3580 * is safe to ignore these warnings in your context.
3581 * @throws DBUnexpectedError
3583 final public function commit( $fname = __METHOD__
, $flush = '' ) {
3584 if ( !$this->mTrxAtomicLevels
->isEmpty() ) {
3585 // There are still atomic sections open. This cannot be ignored
3586 throw new DBUnexpectedError(
3588 "Attempted to commit transaction while atomic sections are still open"
3592 if ( $flush === 'flush' ) {
3593 if ( !$this->mTrxLevel
) {
3594 return; // nothing to do
3595 } elseif ( !$this->mTrxAutomatic
) {
3596 wfWarn( "$fname: Flushing an explicit transaction, getting out of sync!" );
3599 if ( !$this->mTrxLevel
) {
3600 wfWarn( "$fname: No transaction to commit, something got out of sync!" );
3601 return; // nothing to do
3602 } elseif ( $this->mTrxAutomatic
) {
3603 wfWarn( "$fname: Explicit commit of implicit transaction. Something may be out of sync!" );
3607 # Avoid fatals if close() was called
3608 if ( !$this->isOpen() ) {
3609 throw new DBUnexpectedError( $this, "DB connection was already closed." );
3612 $this->runOnTransactionPreCommitCallbacks();
3613 $this->doCommit( $fname );
3614 if ( $this->mTrxDoneWrites
) {
3615 Profiler
::instance()->getTransactionProfiler()->transactionWritingOut(
3616 $this->mServer
, $this->mDBname
, $this->mTrxShortId
);
3618 $this->runOnTransactionIdleCallbacks();
3622 * Issues the COMMIT command to the database server.
3624 * @see DatabaseBase::commit()
3625 * @param string $fname
3627 protected function doCommit( $fname ) {
3628 if ( $this->mTrxLevel
) {
3629 $this->query( 'COMMIT', $fname );
3630 $this->mTrxLevel
= 0;
3635 * Rollback a transaction previously started using begin().
3636 * If no transaction is in progress, a warning is issued.
3638 * No-op on non-transactional databases.
3640 * @param string $fname
3641 * @param string $flush Flush flag, set to 'flush' to disable warnings about
3642 * calling rollback when no transaction is in progress. This will silently
3643 * break any ongoing explicit transaction. Only set the flush flag if you
3644 * are sure that it is safe to ignore these warnings in your context.
3645 * @since 1.23 Added $flush parameter
3647 final public function rollback( $fname = __METHOD__
, $flush = '' ) {
3648 if ( $flush !== 'flush' ) {
3649 if ( !$this->mTrxLevel
) {
3650 wfWarn( "$fname: No transaction to rollback, something got out of sync!" );
3651 return; // nothing to do
3652 } elseif ( $this->mTrxAutomatic
) {
3653 wfWarn( "$fname: Explicit rollback of implicit transaction. Something may be out of sync!" );
3656 if ( !$this->mTrxLevel
) {
3657 return; // nothing to do
3658 } elseif ( !$this->mTrxAutomatic
) {
3659 wfWarn( "$fname: Flushing an explicit transaction, getting out of sync!" );
3663 # Avoid fatals if close() was called
3664 if ( !$this->isOpen() ) {
3665 throw new DBUnexpectedError( $this, "DB connection was already closed." );
3668 $this->doRollback( $fname );
3669 $this->mTrxIdleCallbacks
= array(); // cancel
3670 $this->mTrxPreCommitCallbacks
= array(); // cancel
3671 $this->mTrxAtomicLevels
= new SplStack
;
3672 if ( $this->mTrxDoneWrites
) {
3673 Profiler
::instance()->getTransactionProfiler()->transactionWritingOut(
3674 $this->mServer
, $this->mDBname
, $this->mTrxShortId
);
3679 * Issues the ROLLBACK command to the database server.
3681 * @see DatabaseBase::rollback()
3682 * @param string $fname
3684 protected function doRollback( $fname ) {
3685 if ( $this->mTrxLevel
) {
3686 $this->query( 'ROLLBACK', $fname, true );
3687 $this->mTrxLevel
= 0;
3692 * Creates a new table with structure copied from existing table
3693 * Note that unlike most database abstraction functions, this function does not
3694 * automatically append database prefix, because it works at a lower
3695 * abstraction level.
3696 * The table names passed to this function shall not be quoted (this
3697 * function calls addIdentifierQuotes when needed).
3699 * @param string $oldName Name of table whose structure should be copied
3700 * @param string $newName Name of table to be created
3701 * @param bool $temporary Whether the new table should be temporary
3702 * @param string $fname Calling function name
3703 * @throws MWException
3704 * @return bool True if operation was successful
3706 public function duplicateTableStructure( $oldName, $newName, $temporary = false,
3709 throw new MWException(
3710 'DatabaseBase::duplicateTableStructure is not implemented in descendant class' );
3714 * List all tables on the database
3716 * @param string $prefix Only show tables with this prefix, e.g. mw_
3717 * @param string $fname Calling function name
3718 * @throws MWException
3720 function listTables( $prefix = null, $fname = __METHOD__
) {
3721 throw new MWException( 'DatabaseBase::listTables is not implemented in descendant class' );
3725 * Reset the views process cache set by listViews()
3728 final public function clearViewsCache() {
3729 $this->allViews
= null;
3733 * Lists all the VIEWs in the database
3735 * For caching purposes the list of all views should be stored in
3736 * $this->allViews. The process cache can be cleared with clearViewsCache()
3738 * @param string $prefix Only show VIEWs with this prefix, eg. unit_test_
3739 * @param string $fname Name of calling function
3740 * @throws MWException
3743 public function listViews( $prefix = null, $fname = __METHOD__
) {
3744 throw new MWException( 'DatabaseBase::listViews is not implemented in descendant class' );
3748 * Differentiates between a TABLE and a VIEW
3750 * @param string $name Name of the database-structure to test.
3751 * @throws MWException
3754 public function isView( $name ) {
3755 throw new MWException( 'DatabaseBase::isView is not implemented in descendant class' );
3759 * Convert a timestamp in one of the formats accepted by wfTimestamp()
3760 * to the format used for inserting into timestamp fields in this DBMS.
3762 * The result is unquoted, and needs to be passed through addQuotes()
3763 * before it can be included in raw SQL.
3765 * @param string|int $ts
3769 public function timestamp( $ts = 0 ) {
3770 return wfTimestamp( TS_MW
, $ts );
3774 * Convert a timestamp in one of the formats accepted by wfTimestamp()
3775 * to the format used for inserting into timestamp fields in this DBMS. If
3776 * NULL is input, it is passed through, allowing NULL values to be inserted
3777 * into timestamp fields.
3779 * The result is unquoted, and needs to be passed through addQuotes()
3780 * before it can be included in raw SQL.
3782 * @param string|int $ts
3786 public function timestampOrNull( $ts = null ) {
3787 if ( is_null( $ts ) ) {
3790 return $this->timestamp( $ts );
3795 * Take the result from a query, and wrap it in a ResultWrapper if
3796 * necessary. Boolean values are passed through as is, to indicate success
3797 * of write queries or failure.
3799 * Once upon a time, DatabaseBase::query() returned a bare MySQL result
3800 * resource, and it was necessary to call this function to convert it to
3801 * a wrapper. Nowadays, raw database objects are never exposed to external
3802 * callers, so this is unnecessary in external code. For compatibility with
3803 * old code, ResultWrapper objects are passed through unaltered.
3805 * @param bool|ResultWrapper|resource $result
3806 * @return bool|ResultWrapper
3808 public function resultObject( $result ) {
3809 if ( empty( $result ) ) {
3811 } elseif ( $result instanceof ResultWrapper
) {
3813 } elseif ( $result === true ) {
3814 // Successful write query
3817 return new ResultWrapper( $this, $result );
3822 * Ping the server and try to reconnect if it there is no connection
3824 * @return bool Success or failure
3826 public function ping() {
3827 # Stub. Not essential to override.
3832 * Get slave lag. Currently supported only by MySQL.
3834 * Note that this function will generate a fatal error on many
3835 * installations. Most callers should use LoadBalancer::safeGetLag()
3838 * @return int Database replication lag in seconds
3840 public function getLag() {
3845 * Return the maximum number of items allowed in a list, or 0 for unlimited.
3849 function maxListLen() {
3854 * Some DBMSs have a special format for inserting into blob fields, they
3855 * don't allow simple quoted strings to be inserted. To insert into such
3856 * a field, pass the data through this function before passing it to
3857 * DatabaseBase::insert().
3862 public function encodeBlob( $b ) {
3867 * Some DBMSs return a special placeholder object representing blob fields
3868 * in result objects. Pass the object through this function to return the
3874 public function decodeBlob( $b ) {
3879 * Override database's default behavior. $options include:
3880 * 'connTimeout' : Set the connection timeout value in seconds.
3881 * May be useful for very long batch queries such as
3882 * full-wiki dumps, where a single query reads out over
3885 * @param array $options
3888 public function setSessionOptions( array $options ) {
3892 * Read and execute SQL commands from a file.
3894 * Returns true on success, error string or exception on failure (depending
3895 * on object's error ignore settings).
3897 * @param string $filename File name to open
3898 * @param bool|callable $lineCallback Optional function called before reading each line
3899 * @param bool|callable $resultCallback Optional function called for each MySQL result
3900 * @param bool|string $fname Calling function name or false if name should be
3901 * generated dynamically using $filename
3902 * @param bool|callable $inputCallback Optional function called for each
3903 * complete line sent
3904 * @throws Exception|MWException
3905 * @return bool|string
3907 public function sourceFile(
3908 $filename, $lineCallback = false, $resultCallback = false, $fname = false, $inputCallback = false
3910 wfSuppressWarnings();
3911 $fp = fopen( $filename, 'r' );
3912 wfRestoreWarnings();
3914 if ( false === $fp ) {
3915 throw new MWException( "Could not open \"{$filename}\".\n" );
3919 $fname = __METHOD__
. "( $filename )";
3923 $error = $this->sourceStream( $fp, $lineCallback, $resultCallback, $fname, $inputCallback );
3924 } catch ( MWException
$e ) {
3935 * Get the full path of a patch file. Originally based on archive()
3936 * from updaters.inc. Keep in mind this always returns a patch, as
3937 * it fails back to MySQL if no DB-specific patch can be found
3939 * @param string $patch The name of the patch, like patch-something.sql
3940 * @return string Full path to patch file
3942 public function patchPath( $patch ) {
3945 $dbType = $this->getType();
3946 if ( file_exists( "$IP/maintenance/$dbType/archives/$patch" ) ) {
3947 return "$IP/maintenance/$dbType/archives/$patch";
3949 return "$IP/maintenance/archives/$patch";
3954 * Set variables to be used in sourceFile/sourceStream, in preference to the
3955 * ones in $GLOBALS. If an array is set here, $GLOBALS will not be used at
3956 * all. If it's set to false, $GLOBALS will be used.
3958 * @param bool|array $vars Mapping variable name to value.
3960 public function setSchemaVars( $vars ) {
3961 $this->mSchemaVars
= $vars;
3965 * Read and execute commands from an open file handle.
3967 * Returns true on success, error string or exception on failure (depending
3968 * on object's error ignore settings).
3970 * @param resource $fp File handle
3971 * @param bool|callable $lineCallback Optional function called before reading each query
3972 * @param bool|callable $resultCallback Optional function called for each MySQL result
3973 * @param string $fname Calling function name
3974 * @param bool|callable $inputCallback Optional function called for each complete query sent
3975 * @return bool|string
3977 public function sourceStream( $fp, $lineCallback = false, $resultCallback = false,
3978 $fname = __METHOD__
, $inputCallback = false
3982 while ( !feof( $fp ) ) {
3983 if ( $lineCallback ) {
3984 call_user_func( $lineCallback );
3987 $line = trim( fgets( $fp ) );
3989 if ( $line == '' ) {
3993 if ( '-' == $line[0] && '-' == $line[1] ) {
4001 $done = $this->streamStatementEnd( $cmd, $line );
4005 if ( $done ||
feof( $fp ) ) {
4006 $cmd = $this->replaceVars( $cmd );
4008 if ( ( $inputCallback && call_user_func( $inputCallback, $cmd ) ) ||
!$inputCallback ) {
4009 $res = $this->query( $cmd, $fname );
4011 if ( $resultCallback ) {
4012 call_user_func( $resultCallback, $res, $this );
4015 if ( false === $res ) {
4016 $err = $this->lastError();
4018 return "Query \"{$cmd}\" failed with error code \"$err\".\n";
4029 * Called by sourceStream() to check if we've reached a statement end
4031 * @param string $sql SQL assembled so far
4032 * @param string $newLine New line about to be added to $sql
4033 * @return bool Whether $newLine contains end of the statement
4035 public function streamStatementEnd( &$sql, &$newLine ) {
4036 if ( $this->delimiter
) {
4038 $newLine = preg_replace( '/' . preg_quote( $this->delimiter
, '/' ) . '$/', '', $newLine );
4039 if ( $newLine != $prev ) {
4048 * Database independent variable replacement. Replaces a set of variables
4049 * in an SQL statement with their contents as given by $this->getSchemaVars().
4051 * Supports '{$var}' `{$var}` and / *$var* / (without the spaces) style variables.
4053 * - '{$var}' should be used for text and is passed through the database's
4055 * - `{$var}` should be used for identifiers (eg: table and database names),
4056 * it is passed through the database's addIdentifierQuotes method which
4057 * can be overridden if the database uses something other than backticks.
4058 * - / *$var* / is just encoded, besides traditional table prefix and
4059 * table options its use should be avoided.
4061 * @param string $ins SQL statement to replace variables in
4062 * @return string The new SQL statement with variables replaced
4064 protected function replaceSchemaVars( $ins ) {
4065 $vars = $this->getSchemaVars();
4066 foreach ( $vars as $var => $value ) {
4068 $ins = str_replace( '\'{$' . $var . '}\'', $this->addQuotes( $value ), $ins );
4070 $ins = str_replace( '`{$' . $var . '}`', $this->addIdentifierQuotes( $value ), $ins );
4072 $ins = str_replace( '/*$' . $var . '*/', $this->strencode( $value ), $ins );
4079 * Replace variables in sourced SQL
4081 * @param string $ins
4084 protected function replaceVars( $ins ) {
4085 $ins = $this->replaceSchemaVars( $ins );
4088 $ins = preg_replace_callback( '!/\*(?:\$wgDBprefix|_)\*/([a-zA-Z_0-9]*)!',
4089 array( $this, 'tableNameCallback' ), $ins );
4092 $ins = preg_replace_callback( '!/\*i\*/([a-zA-Z_0-9]*)!',
4093 array( $this, 'indexNameCallback' ), $ins );
4099 * Get schema variables. If none have been set via setSchemaVars(), then
4100 * use some defaults from the current object.
4104 protected function getSchemaVars() {
4105 if ( $this->mSchemaVars
) {
4106 return $this->mSchemaVars
;
4108 return $this->getDefaultSchemaVars();
4113 * Get schema variables to use if none have been set via setSchemaVars().
4115 * Override this in derived classes to provide variables for tables.sql
4116 * and SQL patch files.
4120 protected function getDefaultSchemaVars() {
4125 * Table name callback
4127 * @param array $matches
4130 protected function tableNameCallback( $matches ) {
4131 return $this->tableName( $matches[1] );
4135 * Index name callback
4137 * @param array $matches
4140 protected function indexNameCallback( $matches ) {
4141 return $this->indexName( $matches[1] );
4145 * Check to see if a named lock is available. This is non-blocking.
4147 * @param string $lockName Name of lock to poll
4148 * @param string $method Name of method calling us
4152 public function lockIsFree( $lockName, $method ) {
4157 * Acquire a named lock
4159 * Abstracted from Filestore::lock() so child classes can implement for
4162 * @param string $lockName Name of lock to aquire
4163 * @param string $method Name of method calling us
4164 * @param int $timeout
4167 public function lock( $lockName, $method, $timeout = 5 ) {
4174 * @param string $lockName Name of lock to release
4175 * @param string $method Name of method calling us
4177 * @return int Returns 1 if the lock was released, 0 if the lock was not established
4178 * by this thread (in which case the lock is not released), and NULL if the named
4179 * lock did not exist
4181 public function unlock( $lockName, $method ) {
4186 * Lock specific tables
4188 * @param array $read Array of tables to lock for read access
4189 * @param array $write Array of tables to lock for write access
4190 * @param string $method Name of caller
4191 * @param bool $lowPriority Whether to indicate writes to be LOW PRIORITY
4194 public function lockTables( $read, $write, $method, $lowPriority = true ) {
4199 * Unlock specific tables
4201 * @param string $method The caller
4204 public function unlockTables( $method ) {
4210 * @param string $tableName
4211 * @param string $fName
4212 * @return bool|ResultWrapper
4215 public function dropTable( $tableName, $fName = __METHOD__
) {
4216 if ( !$this->tableExists( $tableName, $fName ) ) {
4219 $sql = "DROP TABLE " . $this->tableName( $tableName );
4220 if ( $this->cascadingDeletes() ) {
4224 return $this->query( $sql, $fName );
4228 * Get search engine class. All subclasses of this need to implement this
4229 * if they wish to use searching.
4233 public function getSearchEngine() {
4234 return 'SearchEngineDummy';
4238 * Find out when 'infinity' is. Most DBMSes support this. This is a special
4239 * keyword for timestamps in PostgreSQL, and works with CHAR(14) as well
4240 * because "i" sorts after all numbers.
4244 public function getInfinity() {
4249 * Encode an expiry time into the DBMS dependent format
4251 * @param string $expiry Timestamp for expiry, or the 'infinity' string
4254 public function encodeExpiry( $expiry ) {
4255 return ( $expiry == '' ||
$expiry == 'infinity' ||
$expiry == $this->getInfinity() )
4256 ?
$this->getInfinity()
4257 : $this->timestamp( $expiry );
4261 * Decode an expiry time into a DBMS independent format
4263 * @param string $expiry DB timestamp field value for expiry
4264 * @param int $format TS_* constant, defaults to TS_MW
4267 public function decodeExpiry( $expiry, $format = TS_MW
) {
4268 return ( $expiry == '' ||
$expiry == $this->getInfinity() )
4270 : wfTimestamp( $format, $expiry );
4274 * Allow or deny "big selects" for this session only. This is done by setting
4275 * the sql_big_selects session variable.
4277 * This is a MySQL-specific feature.
4279 * @param bool|string $value True for allow, false for deny, or "default" to
4280 * restore the initial value
4282 public function setBigSelects( $value = true ) {
4290 public function __toString() {
4291 return (string)$this->mConn
;
4295 * Run a few simple sanity checks
4297 public function __destruct() {
4298 if ( $this->mTrxLevel
&& $this->mTrxDoneWrites
) {
4299 trigger_error( "Uncommitted DB writes (transaction from {$this->mTrxFname})." );
4301 if ( count( $this->mTrxIdleCallbacks
) ||
count( $this->mTrxPreCommitCallbacks
) ) {
4303 foreach ( $this->mTrxIdleCallbacks
as $callbackInfo ) {
4304 $callers[] = $callbackInfo[1];
4306 $callers = implode( ', ', $callers );
4307 trigger_error( "DB transaction callbacks still pending (from $callers)." );