3 * This is the SQLite database abstraction layer.
4 * See maintenance/sqlite/README for development notes and other specific information
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
28 class DatabaseSqlite
extends DatabaseBase
{
29 /** @var bool Whether full text is enabled */
30 private static $fulltextEnabled = null;
32 /** @var string File name for SQLite database file */
33 public $mDatabaseFile;
35 /** @var int The number of rows affected as an integer */
36 protected $mAffectedRows;
39 protected $mLastResult;
44 /** @var FSLockManager (hopefully on the same server as the DB) */
47 function __construct( $p = null ) {
48 global $wgSharedDB, $wgSQLiteDataDir;
50 if ( !is_array( $p ) ) { // legacy calling pattern
51 wfDeprecated( __METHOD__
. " method called without parameter array.", "1.22" );
52 $args = func_get_args();
54 'host' => isset( $args[0] ) ?
$args[0] : false,
55 'user' => isset( $args[1] ) ?
$args[1] : false,
56 'password' => isset( $args[2] ) ?
$args[2] : false,
57 'dbname' => isset( $args[3] ) ?
$args[3] : false,
58 'flags' => isset( $args[4] ) ?
$args[4] : 0,
59 'tablePrefix' => isset( $args[5] ) ?
$args[5] : 'get from global',
60 'schema' => 'get from global',
61 'foreign' => isset( $args[6] ) ?
$args[6] : false
64 $this->mDBname
= $p['dbname'];
65 parent
::__construct( $p );
66 // parent doesn't open when $user is false, but we can work with $dbName
67 if ( $p['dbname'] && !$this->isOpen() ) {
68 if ( $this->open( $p['host'], $p['user'], $p['password'], $p['dbname'] ) ) {
70 $this->attachDatabase( $wgSharedDB );
75 $this->lockMgr
= new FSLockManager( array( 'lockDirectory' => "$wgSQLiteDataDir/locks" ) );
86 * @todo Check if it should be true like parent class
90 function implicitGroupby() {
94 /** Open an SQLite database and return a resource handle to it
95 * NOTE: only $dbName is used, the other parameters are irrelevant for SQLite databases
97 * @param string $server
100 * @param string $dbName
102 * @throws DBConnectionError
105 function open( $server, $user, $pass, $dbName ) {
106 global $wgSQLiteDataDir;
109 $fileName = self
::generateFileName( $wgSQLiteDataDir, $dbName );
110 if ( !is_readable( $fileName ) ) {
111 $this->mConn
= false;
112 throw new DBConnectionError( $this, "SQLite database not accessible" );
114 $this->openFile( $fileName );
120 * Opens a database file
122 * @param string $fileName
123 * @throws DBConnectionError
124 * @return PDO|bool SQL connection or false if failed
126 function openFile( $fileName ) {
129 $this->mDatabaseFile
= $fileName;
131 if ( $this->mFlags
& DBO_PERSISTENT
) {
132 $this->mConn
= new PDO( "sqlite:$fileName", '', '',
133 array( PDO
::ATTR_PERSISTENT
=> true ) );
135 $this->mConn
= new PDO( "sqlite:$fileName", '', '' );
137 } catch ( PDOException
$e ) {
138 $err = $e->getMessage();
141 if ( !$this->mConn
) {
142 wfDebug( "DB connection error: $err\n" );
143 throw new DBConnectionError( $this, $err );
146 $this->mOpened
= !!$this->mConn
;
147 # set error codes only, don't raise exceptions
148 if ( $this->mOpened
) {
149 $this->mConn
->setAttribute( PDO
::ATTR_ERRMODE
, PDO
::ERRMODE_SILENT
);
150 # Enforce LIKE to be case sensitive, just like MySQL
151 $this->query( 'PRAGMA case_sensitive_like = 1' );
160 * Does not actually close the connection, just destroys the reference for GC to do its work
163 protected function closeConnection() {
170 * Generates a database file name. Explicitly public for installer.
171 * @param string $dir Directory where database resides
172 * @param string $dbName Database name
175 public static function generateFileName( $dir, $dbName ) {
176 return "$dir/$dbName.sqlite";
180 * Check if the searchindext table is FTS enabled.
181 * @return bool False if not enabled.
183 function checkForEnabledSearch() {
184 if ( self
::$fulltextEnabled === null ) {
185 self
::$fulltextEnabled = false;
186 $table = $this->tableName( 'searchindex' );
187 $res = $this->query( "SELECT sql FROM sqlite_master WHERE tbl_name = '$table'", __METHOD__
);
189 $row = $res->fetchRow();
190 self
::$fulltextEnabled = stristr( $row['sql'], 'fts' ) !== false;
194 return self
::$fulltextEnabled;
198 * Returns version of currently supported SQLite fulltext search module or false if none present.
201 static function getFulltextSearchModule() {
202 static $cachedResult = null;
203 if ( $cachedResult !== null ) {
204 return $cachedResult;
206 $cachedResult = false;
207 $table = 'dummy_search_test';
209 $db = new DatabaseSqliteStandalone( ':memory:' );
211 if ( $db->query( "CREATE VIRTUAL TABLE $table USING FTS3(dummy_field)", __METHOD__
, true ) ) {
212 $cachedResult = 'FTS3';
216 return $cachedResult;
220 * Attaches external database to our connection, see http://sqlite.org/lang_attach.html
223 * @param string $name Database name to be used in queries like
224 * SELECT foo FROM dbname.table
225 * @param bool|string $file Database file name. If omitted, will be generated
226 * using $name and $wgSQLiteDataDir
227 * @param string $fname Calling function name
228 * @return ResultWrapper
230 function attachDatabase( $name, $file = false, $fname = __METHOD__
) {
231 global $wgSQLiteDataDir;
233 $file = self
::generateFileName( $wgSQLiteDataDir, $name );
235 $file = $this->addQuotes( $file );
237 return $this->query( "ATTACH DATABASE $file AS $name", $fname );
241 * @see DatabaseBase::isWriteQuery()
246 function isWriteQuery( $sql ) {
247 return parent
::isWriteQuery( $sql ) && !preg_match( '/^ATTACH\b/i', $sql );
251 * SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result
254 * @return bool|ResultWrapper
256 protected function doQuery( $sql ) {
257 $res = $this->mConn
->query( $sql );
258 if ( $res === false ) {
261 $r = $res instanceof ResultWrapper ?
$res->result
: $res;
262 $this->mAffectedRows
= $r->rowCount();
263 $res = new ResultWrapper( $this, $r->fetchAll() );
270 * @param ResultWrapper|mixed $res
272 function freeResult( $res ) {
273 if ( $res instanceof ResultWrapper
) {
281 * @param ResultWrapper|array $res
282 * @return stdClass|bool
284 function fetchObject( $res ) {
285 if ( $res instanceof ResultWrapper
) {
291 $cur = current( $r );
292 if ( is_array( $cur ) ) {
295 foreach ( $cur as $k => $v ) {
296 if ( !is_numeric( $k ) ) {
308 * @param ResultWrapper|mixed $res
311 function fetchRow( $res ) {
312 if ( $res instanceof ResultWrapper
) {
317 $cur = current( $r );
318 if ( is_array( $cur ) ) {
328 * The PDO::Statement class implements the array interface so count() will work
330 * @param ResultWrapper|array $res
333 function numRows( $res ) {
334 $r = $res instanceof ResultWrapper ?
$res->result
: $res;
340 * @param ResultWrapper $res
343 function numFields( $res ) {
344 $r = $res instanceof ResultWrapper ?
$res->result
: $res;
345 if ( is_array( $r ) && count( $r ) > 0 ) {
346 // The size of the result array is twice the number of fields. (Bug: 65578)
347 return count( $r[0] ) / 2;
349 // If the result is empty return 0
355 * @param ResultWrapper $res
359 function fieldName( $res, $n ) {
360 $r = $res instanceof ResultWrapper ?
$res->result
: $res;
361 if ( is_array( $r ) ) {
362 $keys = array_keys( $r[0] );
371 * Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks
373 * @param string $name
374 * @param string $format
377 function tableName( $name, $format = 'quoted' ) {
378 // table names starting with sqlite_ are reserved
379 if ( strpos( $name, 'sqlite_' ) === 0 ) {
383 return str_replace( '"', '', parent
::tableName( $name, $format ) );
387 * Index names have DB scope
389 * @param string $index
392 function indexName( $index ) {
397 * This must be called after nextSequenceVal
401 function insertId() {
402 // PDO::lastInsertId yields a string :(
403 return intval( $this->mConn
->lastInsertId() );
407 * @param ResultWrapper|array $res
410 function dataSeek( $res, $row ) {
411 if ( $res instanceof ResultWrapper
) {
418 for ( $i = 0; $i < $row; $i++
) {
427 function lastError() {
428 if ( !is_object( $this->mConn
) ) {
429 return "Cannot return last error, no db connection";
431 $e = $this->mConn
->errorInfo();
433 return isset( $e[2] ) ?
$e[2] : '';
439 function lastErrno() {
440 if ( !is_object( $this->mConn
) ) {
441 return "Cannot return last error, no db connection";
443 $info = $this->mConn
->errorInfo();
452 function affectedRows() {
453 return $this->mAffectedRows
;
457 * Returns information about an index
458 * Returns false if the index does not exist
459 * - if errors are explicitly ignored, returns NULL on failure
461 * @param string $table
462 * @param string $index
463 * @param string $fname
466 function indexInfo( $table, $index, $fname = __METHOD__
) {
467 $sql = 'PRAGMA index_info(' . $this->addQuotes( $this->indexName( $index ) ) . ')';
468 $res = $this->query( $sql, $fname );
472 if ( $res->numRows() == 0 ) {
476 foreach ( $res as $row ) {
477 $info[] = $row->name
;
484 * @param string $table
485 * @param string $index
486 * @param string $fname
489 function indexUnique( $table, $index, $fname = __METHOD__
) {
490 $row = $this->selectRow( 'sqlite_master', '*',
493 'name' => $this->indexName( $index ),
495 if ( !$row ||
!isset( $row->sql
) ) {
499 // $row->sql will be of the form CREATE [UNIQUE] INDEX ...
500 $indexPos = strpos( $row->sql
, 'INDEX' );
501 if ( $indexPos === false ) {
504 $firstPart = substr( $row->sql
, 0, $indexPos );
505 $options = explode( ' ', $firstPart );
507 return in_array( 'UNIQUE', $options );
511 * Filter the options used in SELECT statements
513 * @param array $options
516 function makeSelectOptions( $options ) {
517 foreach ( $options as $k => $v ) {
518 if ( is_numeric( $k ) && ( $v == 'FOR UPDATE' ||
$v == 'LOCK IN SHARE MODE' ) ) {
523 return parent
::makeSelectOptions( $options );
527 * @param array $options
530 protected function makeUpdateOptionsArray( $options ) {
531 $options = parent
::makeUpdateOptionsArray( $options );
532 $options = self
::fixIgnore( $options );
538 * @param array $options
541 static function fixIgnore( $options ) {
542 # SQLite uses OR IGNORE not just IGNORE
543 foreach ( $options as $k => $v ) {
544 if ( $v == 'IGNORE' ) {
545 $options[$k] = 'OR IGNORE';
553 * @param array $options
556 function makeInsertOptions( $options ) {
557 $options = self
::fixIgnore( $options );
559 return parent
::makeInsertOptions( $options );
563 * Based on generic method (parent) with some prior SQLite-sepcific adjustments
564 * @param string $table
566 * @param string $fname
567 * @param array $options
570 function insert( $table, $a, $fname = __METHOD__
, $options = array() ) {
571 if ( !count( $a ) ) {
575 # SQLite can't handle multi-row inserts, so divide up into multiple single-row inserts
576 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
578 foreach ( $a as $v ) {
579 if ( !parent
::insert( $table, $v, "$fname/multi-row", $options ) ) {
584 $ret = parent
::insert( $table, $a, "$fname/single-row", $options );
591 * @param string $table
592 * @param array $uniqueIndexes Unused
593 * @param string|array $rows
594 * @param string $fname
595 * @return bool|ResultWrapper
597 function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
598 if ( !count( $rows ) ) {
602 # SQLite can't handle multi-row replaces, so divide up into multiple single-row queries
603 if ( isset( $rows[0] ) && is_array( $rows[0] ) ) {
605 foreach ( $rows as $v ) {
606 if ( !$this->nativeReplace( $table, $v, "$fname/multi-row" ) ) {
611 $ret = $this->nativeReplace( $table, $rows, "$fname/single-row" );
618 * Returns the size of a text field, or -1 for "unlimited"
619 * In SQLite this is SQLITE_MAX_LENGTH, by default 1GB. No way to query it though.
621 * @param string $table
622 * @param string $field
625 function textFieldSize( $table, $field ) {
632 function unionSupportsOrderAndLimit() {
637 * @param string $sqls
638 * @param bool $all Whether to "UNION ALL" or not
641 function unionQueries( $sqls, $all ) {
642 $glue = $all ?
' UNION ALL ' : ' UNION ';
644 return implode( $glue, $sqls );
650 function wasDeadlock() {
651 return $this->lastErrno() == 5; // SQLITE_BUSY
657 function wasErrorReissuable() {
658 return $this->lastErrno() == 17; // SQLITE_SCHEMA;
664 function wasReadOnlyError() {
665 return $this->lastErrno() == 8; // SQLITE_READONLY;
669 * @return string Wikitext of a link to the server software's web site
671 public function getSoftwareLink() {
672 return "[{{int:version-db-sqlite-url}} SQLite]";
676 * @return string Version information from the database
678 function getServerVersion() {
679 $ver = $this->mConn
->getAttribute( PDO
::ATTR_SERVER_VERSION
);
685 * @return string User-friendly database information
687 public function getServerInfo() {
688 return wfMessage( self
::getFulltextSearchModule()
690 : 'sqlite-no-fts', $this->getServerVersion() )->text();
694 * Get information about a given field
695 * Returns false if the field does not exist.
697 * @param string $table
698 * @param string $field
699 * @return SQLiteField|bool False on failure
701 function fieldInfo( $table, $field ) {
702 $tableName = $this->tableName( $table );
703 $sql = 'PRAGMA table_info(' . $this->addQuotes( $tableName ) . ')';
704 $res = $this->query( $sql, __METHOD__
);
705 foreach ( $res as $row ) {
706 if ( $row->name
== $field ) {
707 return new SQLiteField( $row, $tableName );
714 protected function doBegin( $fname = '' ) {
715 if ( $this->mTrxLevel
== 1 ) {
716 $this->commit( __METHOD__
);
719 $this->mConn
->beginTransaction();
720 } catch ( PDOException
$e ) {
721 throw new DBUnexpectedError( $this, 'Error in BEGIN query: ' . $e->getMessage() );
723 $this->mTrxLevel
= 1;
726 protected function doCommit( $fname = '' ) {
727 if ( $this->mTrxLevel
== 0 ) {
731 $this->mConn
->commit();
732 } catch ( PDOException
$e ) {
733 throw new DBUnexpectedError( $this, 'Error in COMMIT query: ' . $e->getMessage() );
735 $this->mTrxLevel
= 0;
738 protected function doRollback( $fname = '' ) {
739 if ( $this->mTrxLevel
== 0 ) {
742 $this->mConn
->rollBack();
743 $this->mTrxLevel
= 0;
750 function strencode( $s ) {
751 return substr( $this->addQuotes( $s ), 1, -1 );
758 function encodeBlob( $b ) {
759 return new Blob( $b );
763 * @param Blob|string $b
766 function decodeBlob( $b ) {
767 if ( $b instanceof Blob
) {
775 * @param Blob|string $s
778 function addQuotes( $s ) {
779 if ( $s instanceof Blob
) {
780 return "x'" . bin2hex( $s->fetch() ) . "'";
781 } elseif ( is_bool( $s ) ) {
783 } elseif ( strpos( $s, "\0" ) !== false ) {
784 // SQLite doesn't support \0 in strings, so use the hex representation as a workaround.
785 // This is a known limitation of SQLite's mprintf function which PDO should work around,
786 // but doesn't. I have reported this to php.net as bug #63419:
787 // https://bugs.php.net/bug.php?id=63419
788 // There was already a similar report for SQLite3::escapeString, bug #62361:
789 // https://bugs.php.net/bug.php?id=62361
790 return "x'" . bin2hex( $s ) . "'";
792 return $this->mConn
->quote( $s );
799 function buildLike() {
800 $params = func_get_args();
801 if ( count( $params ) > 0 && is_array( $params[0] ) ) {
802 $params = $params[0];
805 return parent
::buildLike( $params ) . "ESCAPE '\' ";
811 public function getSearchEngine() {
812 return "SearchSqlite";
816 * No-op version of deadlockLoop
820 public function deadlockLoop( /*...*/ ) {
821 $args = func_get_args();
822 $function = array_shift( $args );
824 return call_user_func_array( $function, $args );
831 protected function replaceVars( $s ) {
832 $s = parent
::replaceVars( $s );
833 if ( preg_match( '/^\s*(CREATE|ALTER) TABLE/i', $s ) ) {
834 // CREATE TABLE hacks to allow schema file sharing with MySQL
836 // binary/varbinary column type -> blob
837 $s = preg_replace( '/\b(var)?binary(\(\d+\))/i', 'BLOB', $s );
838 // no such thing as unsigned
839 $s = preg_replace( '/\b(un)?signed\b/i', '', $s );
841 $s = preg_replace( '/\b(tiny|small|medium|big|)int(\s*\(\s*\d+\s*\)|\b)/i', 'INTEGER', $s );
842 // floating point types -> REAL
844 '/\b(float|double(\s+precision)?)(\s*\(\s*\d+\s*(,\s*\d+\s*)?\)|\b)/i',
849 $s = preg_replace( '/\b(var)?char\s*\(.*?\)/i', 'TEXT', $s );
850 // TEXT normalization
851 $s = preg_replace( '/\b(tiny|medium|long)text\b/i', 'TEXT', $s );
852 // BLOB normalization
853 $s = preg_replace( '/\b(tiny|small|medium|long|)blob\b/i', 'BLOB', $s );
855 $s = preg_replace( '/\bbool(ean)?\b/i', 'INTEGER', $s );
857 $s = preg_replace( '/\b(datetime|timestamp)\b/i', 'TEXT', $s );
859 $s = preg_replace( '/\benum\s*\([^)]*\)/i', 'TEXT', $s );
860 // binary collation type -> nothing
861 $s = preg_replace( '/\bbinary\b/i', '', $s );
862 // auto_increment -> autoincrement
863 $s = preg_replace( '/\bauto_increment\b/i', 'AUTOINCREMENT', $s );
864 // No explicit options
865 $s = preg_replace( '/\)[^);]*(;?)\s*$/', ')\1', $s );
866 // AUTOINCREMENT should immedidately follow PRIMARY KEY
867 $s = preg_replace( '/primary key (.*?) autoincrement/i', 'PRIMARY KEY AUTOINCREMENT $1', $s );
868 } elseif ( preg_match( '/^\s*CREATE (\s*(?:UNIQUE|FULLTEXT)\s+)?INDEX/i', $s ) ) {
869 // No truncated indexes
870 $s = preg_replace( '/\(\d+\)/', '', $s );
872 $s = preg_replace( '/\bfulltext\b/i', '', $s );
873 } elseif ( preg_match( '/^\s*DROP INDEX/i', $s ) ) {
874 // DROP INDEX is database-wide, not table-specific, so no ON <table> clause.
875 $s = preg_replace( '/\sON\s+[^\s]*/i', '', $s );
876 } elseif ( preg_match( '/^\s*INSERT IGNORE\b/i', $s ) ) {
877 // INSERT IGNORE --> INSERT OR IGNORE
878 $s = preg_replace( '/^\s*INSERT IGNORE\b/i', 'INSERT OR IGNORE', $s );
884 public function lock( $lockName, $method, $timeout = 5 ) {
885 global $wgSQLiteDataDir;
887 if ( !is_dir( "$wgSQLiteDataDir/locks" ) ) { // create dir as needed
888 if ( !is_writable( $wgSQLiteDataDir ) ||
!mkdir( "$wgSQLiteDataDir/locks" ) ) {
889 throw new DBError( "Cannot create directory \"$wgSQLiteDataDir/locks\"." );
893 return $this->lockMgr
->lock( array( $lockName ), LockManager
::LOCK_EX
, $timeout )->isOK();
896 public function unlock( $lockName, $method ) {
897 return $this->lockMgr
->unlock( array( $lockName ), LockManager
::LOCK_EX
)->isOK();
901 * Build a concatenation list to feed into a SQL query
903 * @param string[] $stringList
906 function buildConcat( $stringList ) {
907 return '(' . implode( ') || (', $stringList ) . ')';
910 public function buildGroupConcatField(
911 $delim, $table, $field, $conds = '', $join_conds = array()
913 $fld = "group_concat($field," . $this->addQuotes( $delim ) . ')';
915 return '(' . $this->selectSQLText( $table, $fld, $conds, null, array(), $join_conds ) . ')';
919 * @throws MWException
920 * @param string $oldName
921 * @param string $newName
922 * @param bool $temporary
923 * @param string $fname
924 * @return bool|ResultWrapper
926 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = __METHOD__
) {
927 $res = $this->query( "SELECT sql FROM sqlite_master WHERE tbl_name=" .
928 $this->addQuotes( $oldName ) . " AND type='table'", $fname );
929 $obj = $this->fetchObject( $res );
931 throw new MWException( "Couldn't retrieve structure for table $oldName" );
935 '/(?<=\W)"?' . preg_quote( trim( $this->addIdentifierQuotes( $oldName ), '"' ) ) . '"?(?=\W)/',
936 $this->addIdentifierQuotes( $newName ),
941 if ( preg_match( '/^\\s*CREATE\\s+VIRTUAL\\s+TABLE\b/i', $sql ) ) {
942 wfDebug( "Table $oldName is virtual, can't create a temporary duplicate.\n" );
944 $sql = str_replace( 'CREATE TABLE', 'CREATE TEMPORARY TABLE', $sql );
948 return $this->query( $sql, $fname );
952 * List all tables on the database
954 * @param string $prefix Only show tables with this prefix, e.g. mw_
955 * @param string $fname Calling function name
959 function listTables( $prefix = null, $fname = __METHOD__
) {
960 $result = $this->select(
968 foreach ( $result as $table ) {
969 $vars = get_object_vars( $table );
970 $table = array_pop( $vars );
972 if ( !$prefix ||
strpos( $table, $prefix ) === 0 ) {
973 if ( strpos( $table, 'sqlite_' ) !== 0 ) {
974 $endArray[] = $table;
981 } // end DatabaseSqlite class
984 * This class allows simple acccess to a SQLite database independently from main database settings
987 class DatabaseSqliteStandalone
extends DatabaseSqlite
{
988 public function __construct( $fileName, $flags = 0 ) {
989 $this->mFlags
= $flags;
990 $this->tablePrefix( null );
991 $this->openFile( $fileName );
998 class SQLiteField
implements Field
{
999 private $info, $tableName;
1001 function __construct( $info, $tableName ) {
1002 $this->info
= $info;
1003 $this->tableName
= $tableName;
1007 return $this->info
->name
;
1010 function tableName() {
1011 return $this->tableName
;
1014 function defaultValue() {
1015 if ( is_string( $this->info
->dflt_value
) ) {
1017 if ( preg_match( '/^\'(.*)\'$', $this->info
->dflt_value
) ) {
1018 return str_replace( "''", "'", $this->info
->dflt_value
);
1022 return $this->info
->dflt_value
;
1028 function isNullable() {
1029 return !$this->info
->notnull
;
1033 return $this->info
->type
;
1035 } // end SQLiteField