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
24 namespace Wikimedia\Rdbms
;
38 class DatabaseSqlite
extends Database
{
39 /** @var string|null Directory for SQLite database files listed under their DB name */
41 /** @var string|null Explicit path for the SQLite database file */
43 /** @var string Transaction mode */
46 /** @var int The number of rows affected as an integer */
47 protected $lastAffectedRowCount;
49 protected $lastResultHandle;
54 /** @var FSLockManager (hopefully on the same server as the DB) */
57 /** @var array List of shared database already attached to this connection */
58 private $alreadyAttached = [];
60 /** @var bool Whether full text is enabled */
61 private static $fulltextEnabled = null;
63 /** @var string[] See https://www.sqlite.org/lang_transaction.html */
64 private static $VALID_TRX_MODES = [ '', 'DEFERRED', 'IMMEDIATE', 'EXCLUSIVE' ];
67 * Additional params include:
68 * - dbDirectory : directory containing the DB and the lock file directory
69 * - dbFilePath : use this to force the path of the DB file
70 * - trxMode : one of (deferred, immediate, exclusive)
71 * @param array $params
73 public function __construct( array $params ) {
74 if ( isset( $params['dbFilePath'] ) ) {
75 $this->dbPath
= $params['dbFilePath'];
76 if ( !strlen( $params['dbname'] ) ) {
77 $params['dbname'] = self
::generateDatabaseName( $this->dbPath
);
79 } elseif ( isset( $params['dbDirectory'] ) ) {
80 $this->dbDir
= $params['dbDirectory'];
83 parent
::__construct( $params );
85 $this->trxMode
= strtoupper( $params['trxMode'] ??
'' );
87 $lockDirectory = $this->getLockFileDirectory();
88 if ( $lockDirectory !== null ) {
89 $this->lockMgr
= new FSLockManager( [
90 'domain' => $this->getDomainID(),
91 'lockDirectory' => $lockDirectory
94 $this->lockMgr
= new NullLockManager( [ 'domain' => $this->getDomainID() ] );
98 protected static function getAttributes() {
100 self
::ATTR_DB_IS_FILE
=> true,
101 self
::ATTR_DB_LEVEL_LOCKING
=> true
106 * @param string $filename
107 * @param array $p Options map; supports:
108 * - flags : (same as __construct counterpart)
109 * - trxMode : (same as __construct counterpart)
110 * - dbDirectory : (same as __construct counterpart)
111 * @return DatabaseSqlite
114 public static function newStandaloneInstance( $filename, array $p = [] ) {
115 $p['dbFilePath'] = $filename;
117 $p['tablePrefix'] = '';
118 /** @var DatabaseSqlite $db */
119 $db = Database
::factory( 'sqlite', $p );
127 public function getType() {
131 protected function open( $server, $user, $pass, $dbName, $schema, $tablePrefix ) {
134 // Note that for SQLite, $server, $user, and $pass are ignored
136 if ( $schema !== null ) {
137 throw $this->newExceptionAfterConnectError( "Got schema '$schema'; not supported." );
140 if ( $this->dbPath
!== null ) {
141 $path = $this->dbPath
;
142 } elseif ( $this->dbDir
!== null ) {
143 $path = self
::generateFileName( $this->dbDir
, $dbName );
145 throw $this->newExceptionAfterConnectError( "DB path or directory required" );
148 // Check if the database file already exists but is non-readable
150 !self
::isProcessMemoryPath( $path ) &&
151 file_exists( $path ) &&
152 !is_readable( $path )
154 throw $this->newExceptionAfterConnectError( 'SQLite database file is not readable' );
155 } elseif ( !in_array( $this->trxMode
, self
::$VALID_TRX_MODES, true ) ) {
156 throw $this->newExceptionAfterConnectError( "Got mode '{$this->trxMode}' for BEGIN" );
160 if ( $this->getFlag( self
::DBO_PERSISTENT
) ) {
161 // Persistent connections can avoid some schema index reading overhead.
162 // On the other hand, they can cause horrible contention with DBO_TRX.
163 if ( $this->getFlag( self
::DBO_TRX
) ||
$this->getFlag( self
::DBO_DEFAULT
) ) {
164 $this->connLogger
->warning(
165 __METHOD__
. ": ignoring DBO_PERSISTENT due to DBO_TRX or DBO_DEFAULT",
166 $this->getLogContext()
169 $attributes[PDO
::ATTR_PERSISTENT
] = true;
174 // Open the database file, creating it if it does not yet exist
175 $this->conn
= new PDO( "sqlite:$path", null, null, $attributes );
176 } catch ( PDOException
$e ) {
177 throw $this->newExceptionAfterConnectError( $e->getMessage() );
180 $this->currentDomain
= new DatabaseDomain( $dbName, null, $tablePrefix );
183 $flags = self
::QUERY_IGNORE_DBO_TRX | self
::QUERY_NO_RETRY
;
184 // Enforce LIKE to be case sensitive, just like MySQL
185 $this->query( 'PRAGMA case_sensitive_like = 1', __METHOD__
, $flags );
186 // Apply optimizations or requirements regarding fsync() usage
187 $sync = $this->connectionVariables
['synchronous'] ??
null;
188 if ( in_array( $sync, [ 'EXTRA', 'FULL', 'NORMAL', 'OFF' ], true ) ) {
189 $this->query( "PRAGMA synchronous = $sync", __METHOD__
, $flags );
191 } catch ( Exception
$e ) {
192 throw $this->newExceptionAfterConnectError( $e->getMessage() );
197 * @return string|null SQLite DB file path
198 * @throws DBUnexpectedError
201 public function getDbFilePath() {
202 return $this->dbPath ?? self
::generateFileName( $this->dbDir
, $this->getDBname() );
206 * @return string|null Lock file directory
208 public function getLockFileDirectory() {
209 if ( $this->dbPath
!== null && !self
::isProcessMemoryPath( $this->dbPath
) ) {
210 return dirname( $this->dbPath
) . '/locks';
211 } elseif ( $this->dbDir
!== null && !self
::isProcessMemoryPath( $this->dbDir
) ) {
212 return $this->dbDir
. '/locks';
219 * Does not actually close the connection, just destroys the reference for GC to do its work
222 protected function closeConnection() {
229 * Generates a database file name. Explicitly public for installer.
230 * @param string $dir Directory where database resides
231 * @param string|bool $dbName Database name (or false from Database::factory, validated here)
233 * @throws DBUnexpectedError
235 public static function generateFileName( $dir, $dbName ) {
237 throw new DBUnexpectedError( null, __CLASS__
. ": no DB directory specified" );
238 } elseif ( self
::isProcessMemoryPath( $dir ) ) {
239 throw new DBUnexpectedError(
241 __CLASS__
. ": cannot use process memory directory '$dir'"
243 } elseif ( !strlen( $dbName ) ) {
244 throw new DBUnexpectedError( null, __CLASS__
. ": no DB name specified" );
247 return "$dir/$dbName.sqlite";
251 * @param string $path
254 private static function generateDatabaseName( $path ) {
255 if ( preg_match( '/^(:memory:$|file::memory:)/', $path ) ) {
256 // E.g. "file::memory:?cache=shared" => ":memory":
258 } elseif ( preg_match( '/^file::([^?]+)\?mode=memory(&|$)/', $path, $m ) ) {
259 // E.g. "file:memdb1?mode=memory" => ":memdb1:"
262 // E.g. "/home/.../some_db.sqlite3" => "some_db"
263 return preg_replace( '/\.sqlite\d?$/', '', basename( $path ) );
268 * @param string $path
271 private static function isProcessMemoryPath( $path ) {
272 return preg_match( '/^(:memory:$|file:(:memory:|[^?]+\?mode=memory(&|$)))/', $path );
276 * Returns version of currently supported SQLite fulltext search module or false if none present.
279 static function getFulltextSearchModule() {
280 static $cachedResult = null;
281 if ( $cachedResult !== null ) {
282 return $cachedResult;
284 $cachedResult = false;
285 $table = 'dummy_search_test';
287 $db = self
::newStandaloneInstance( ':memory:' );
288 if ( $db->query( "CREATE VIRTUAL TABLE $table USING FTS3(dummy_field)", __METHOD__
, true ) ) {
289 $cachedResult = 'FTS3';
293 return $cachedResult;
297 * Attaches external database to our connection, see https://sqlite.org/lang_attach.html
300 * @param string $name Database name to be used in queries like
301 * SELECT foo FROM dbname.table
302 * @param bool|string $file Database file name. If omitted, will be generated
303 * using $name and configured data directory
304 * @param string $fname Calling function name
305 * @return IResultWrapper
307 public function attachDatabase( $name, $file = false, $fname = __METHOD__
) {
308 $file = is_string( $file ) ?
$file : self
::generateFileName( $this->dbDir
, $name );
309 $encFile = $this->addQuotes( $file );
312 "ATTACH DATABASE $encFile AS $name",
314 self
::QUERY_IGNORE_DBO_TRX
318 protected function isWriteQuery( $sql ) {
319 return parent
::isWriteQuery( $sql ) && !preg_match( '/^(ATTACH|PRAGMA)\b/i', $sql );
322 protected function isTransactableQuery( $sql ) {
323 return parent
::isTransactableQuery( $sql ) && !in_array(
324 $this->getQueryVerb( $sql ),
325 [ 'ATTACH', 'PRAGMA' ],
331 * SQLite doesn't allow buffered results or data seeking etc, so we'll use fetchAll as the result
334 * @return bool|IResultWrapper
336 protected function doQuery( $sql ) {
337 $res = $this->getBindingHandle()->query( $sql );
338 if ( $res === false ) {
342 $resource = ResultWrapper
::unwrap( $res );
343 $this->lastAffectedRowCount
= $resource->rowCount();
344 $res = new ResultWrapper( $this, $resource->fetchAll() );
350 * @param IResultWrapper|mixed $res
352 function freeResult( $res ) {
353 if ( $res instanceof ResultWrapper
) {
359 * @param IResultWrapper|array $res
360 * @return stdClass|bool
362 function fetchObject( $res ) {
363 $resource =& ResultWrapper
::unwrap( $res );
365 $cur = current( $resource );
366 if ( is_array( $cur ) ) {
369 foreach ( $cur as $k => $v ) {
370 if ( !is_numeric( $k ) ) {
382 * @param IResultWrapper|mixed $res
385 function fetchRow( $res ) {
386 $resource =& ResultWrapper
::unwrap( $res );
387 $cur = current( $resource );
388 if ( is_array( $cur ) ) {
398 * The PDO::Statement class implements the array interface so count() will work
400 * @param IResultWrapper|array|false $res
403 function numRows( $res ) {
404 // false does not implement Countable
405 $resource = ResultWrapper
::unwrap( $res );
407 return is_array( $resource ) ?
count( $resource ) : 0;
411 * @param IResultWrapper $res
414 function numFields( $res ) {
415 $resource = ResultWrapper
::unwrap( $res );
416 if ( is_array( $resource ) && count( $resource ) > 0 ) {
417 // The size of the result array is twice the number of fields. (T67578)
418 return count( $resource[0] ) / 2;
420 // If the result is empty return 0
426 * @param IResultWrapper $res
430 function fieldName( $res, $n ) {
431 $resource = ResultWrapper
::unwrap( $res );
432 if ( is_array( $resource ) ) {
433 $keys = array_keys( $resource[0] );
441 protected function doSelectDomain( DatabaseDomain
$domain ) {
442 if ( $domain->getSchema() !== null ) {
443 throw new DBExpectedError(
445 __CLASS__
. ": domain '{$domain->getId()}' has a schema component"
449 $database = $domain->getDatabase();
450 // A null database means "don't care" so leave it as is and update the table prefix
451 if ( $database === null ) {
452 $this->currentDomain
= new DatabaseDomain(
453 $this->currentDomain
->getDatabase(),
455 $domain->getTablePrefix()
461 if ( $database !== $this->getDBname() ) {
462 throw new DBExpectedError(
464 __CLASS__
. ": cannot change database (got '$database')"
472 * Use MySQL's naming (accounts for prefix etc) but remove surrounding backticks
474 * @param string $name
475 * @param string $format
478 function tableName( $name, $format = 'quoted' ) {
479 // table names starting with sqlite_ are reserved
480 if ( strpos( $name, 'sqlite_' ) === 0 ) {
484 return str_replace( '"', '', parent
::tableName( $name, $format ) );
488 * This must be called after nextSequenceVal
492 function insertId() {
493 // PDO::lastInsertId yields a string :(
494 return intval( $this->getBindingHandle()->lastInsertId() );
498 * @param IResultWrapper|array $res
501 function dataSeek( $res, $row ) {
502 $resource =& ResultWrapper
::unwrap( $res );
505 for ( $i = 0; $i < $row; $i++
) {
514 function lastError() {
515 if ( !is_object( $this->conn
) ) {
516 return "Cannot return last error, no db connection";
518 $e = $this->conn
->errorInfo();
526 function lastErrno() {
527 if ( !is_object( $this->conn
) ) {
528 return "Cannot return last error, no db connection";
530 $info = $this->conn
->errorInfo();
539 protected function fetchAffectedRowCount() {
540 return $this->lastAffectedRowCount
;
543 function tableExists( $table, $fname = __METHOD__
) {
544 $tableRaw = $this->tableName( $table, 'raw' );
545 if ( isset( $this->sessionTempTables
[$tableRaw] ) ) {
546 return true; // already known to exist
549 $encTable = $this->addQuotes( $tableRaw );
551 "SELECT 1 FROM sqlite_master WHERE type='table' AND name=$encTable",
553 self
::QUERY_IGNORE_DBO_TRX
556 return $res->numRows() ?
true : false;
560 * Returns information about an index
561 * Returns false if the index does not exist
562 * - if errors are explicitly ignored, returns NULL on failure
564 * @param string $table
565 * @param string $index
566 * @param string $fname
567 * @return array|false
569 function indexInfo( $table, $index, $fname = __METHOD__
) {
570 $sql = 'PRAGMA index_info(' . $this->addQuotes( $this->indexName( $index ) ) . ')';
571 $res = $this->query( $sql, $fname, self
::QUERY_IGNORE_DBO_TRX
);
572 if ( !$res ||
$res->numRows() == 0 ) {
576 foreach ( $res as $row ) {
577 $info[] = $row->name
;
584 * @param string $table
585 * @param string $index
586 * @param string $fname
589 function indexUnique( $table, $index, $fname = __METHOD__
) {
590 $row = $this->selectRow( 'sqlite_master', '*',
593 'name' => $this->indexName( $index ),
595 if ( !$row ||
!isset( $row->sql
) ) {
599 // $row->sql will be of the form CREATE [UNIQUE] INDEX ...
600 $indexPos = strpos( $row->sql
, 'INDEX' );
601 if ( $indexPos === false ) {
604 $firstPart = substr( $row->sql
, 0, $indexPos );
605 $options = explode( ' ', $firstPart );
607 return in_array( 'UNIQUE', $options );
611 * Filter the options used in SELECT statements
613 * @param array $options
616 function makeSelectOptions( $options ) {
617 foreach ( $options as $k => $v ) {
618 if ( is_numeric( $k ) && ( $v == 'FOR UPDATE' ||
$v == 'LOCK IN SHARE MODE' ) ) {
623 return parent
::makeSelectOptions( $options );
627 * @param array $options
630 protected function makeUpdateOptionsArray( $options ) {
631 $options = parent
::makeUpdateOptionsArray( $options );
632 $options = self
::fixIgnore( $options );
638 * @param array $options
641 static function fixIgnore( $options ) {
642 # SQLite uses OR IGNORE not just IGNORE
643 foreach ( $options as $k => $v ) {
644 if ( $v == 'IGNORE' ) {
645 $options[$k] = 'OR IGNORE';
653 * @param array $options
656 function makeInsertOptions( $options ) {
657 $options = self
::fixIgnore( $options );
659 return parent
::makeInsertOptions( $options );
663 * Based on generic method (parent) with some prior SQLite-sepcific adjustments
664 * @param string $table
666 * @param string $fname
667 * @param array $options
670 function insert( $table, $a, $fname = __METHOD__
, $options = [] ) {
671 if ( !count( $a ) ) {
675 # SQLite can't handle multi-row inserts, so divide up into multiple single-row inserts
676 if ( isset( $a[0] ) && is_array( $a[0] ) ) {
677 $affectedRowCount = 0;
679 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
680 foreach ( $a as $v ) {
681 parent
::insert( $table, $v, "$fname/multi-row", $options );
682 $affectedRowCount +
= $this->affectedRows();
684 $this->endAtomic( $fname );
685 } catch ( Exception
$e ) {
686 $this->cancelAtomic( $fname );
689 $this->affectedRowCount
= $affectedRowCount;
691 parent
::insert( $table, $a, "$fname/single-row", $options );
698 * @param string $table
699 * @param array $uniqueIndexes Unused
700 * @param string|array $rows
701 * @param string $fname
703 function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__
) {
704 if ( !count( $rows ) ) {
708 # SQLite can't handle multi-row replaces, so divide up into multiple single-row queries
709 if ( isset( $rows[0] ) && is_array( $rows[0] ) ) {
710 $affectedRowCount = 0;
712 $this->startAtomic( $fname, self
::ATOMIC_CANCELABLE
);
713 foreach ( $rows as $v ) {
714 $this->nativeReplace( $table, $v, "$fname/multi-row" );
715 $affectedRowCount +
= $this->affectedRows();
717 $this->endAtomic( $fname );
718 } catch ( Exception
$e ) {
719 $this->cancelAtomic( $fname );
722 $this->affectedRowCount
= $affectedRowCount;
724 $this->nativeReplace( $table, $rows, "$fname/single-row" );
729 * Returns the size of a text field, or -1 for "unlimited"
730 * In SQLite this is SQLITE_MAX_LENGTH, by default 1GB. No way to query it though.
732 * @param string $table
733 * @param string $field
736 function textFieldSize( $table, $field ) {
743 function unionSupportsOrderAndLimit() {
748 * @param string[] $sqls
749 * @param bool $all Whether to "UNION ALL" or not
752 function unionQueries( $sqls, $all ) {
753 $glue = $all ?
' UNION ALL ' : ' UNION ';
755 return implode( $glue, $sqls );
761 function wasDeadlock() {
762 return $this->lastErrno() == 5; // SQLITE_BUSY
768 function wasReadOnlyError() {
769 return $this->lastErrno() == 8; // SQLITE_READONLY;
772 public function wasConnectionError( $errno ) {
773 return $errno == 17; // SQLITE_SCHEMA;
776 protected function wasKnownStatementRollbackError() {
777 // ON CONFLICT ROLLBACK clauses make it so that SQLITE_CONSTRAINT error is
778 // ambiguous with regard to whether it implies a ROLLBACK or an ABORT happened.
779 // https://sqlite.org/lang_createtable.html#uniqueconst
780 // https://sqlite.org/lang_conflict.html
784 public function serverIsReadOnly() {
785 $this->assertHasConnectionHandle();
787 $path = $this->getDbFilePath();
789 return ( !self
::isProcessMemoryPath( $path ) && !is_writable( $path ) );
793 * @return string Wikitext of a link to the server software's web site
795 public function getSoftwareLink() {
796 return "[{{int:version-db-sqlite-url}} SQLite]";
800 * @return string Version information from the database
802 function getServerVersion() {
803 $ver = $this->getBindingHandle()->getAttribute( PDO
::ATTR_SERVER_VERSION
);
809 * Get information about a given field
810 * Returns false if the field does not exist.
812 * @param string $table
813 * @param string $field
814 * @return SQLiteField|bool False on failure
816 function fieldInfo( $table, $field ) {
817 $tableName = $this->tableName( $table );
818 $sql = 'PRAGMA table_info(' . $this->addQuotes( $tableName ) . ')';
819 $res = $this->query( $sql, __METHOD__
, self
::QUERY_IGNORE_DBO_TRX
);
820 foreach ( $res as $row ) {
821 if ( $row->name
== $field ) {
822 return new SQLiteField( $row, $tableName );
829 protected function doBegin( $fname = '' ) {
830 if ( $this->trxMode
!= '' ) {
831 $this->query( "BEGIN {$this->trxMode}", $fname );
833 $this->query( 'BEGIN', $fname );
841 function strencode( $s ) {
842 return substr( $this->addQuotes( $s ), 1, -1 );
849 function encodeBlob( $b ) {
850 return new Blob( $b );
854 * @param Blob|string $b
857 function decodeBlob( $b ) {
858 if ( $b instanceof Blob
) {
866 * @param string|int|null|bool|Blob $s
869 function addQuotes( $s ) {
870 if ( $s instanceof Blob
) {
871 return "x'" . bin2hex( $s->fetch() ) . "'";
872 } elseif ( is_bool( $s ) ) {
874 } elseif ( strpos( (string)$s, "\0" ) !== false ) {
875 // SQLite doesn't support \0 in strings, so use the hex representation as a workaround.
876 // This is a known limitation of SQLite's mprintf function which PDO
877 // should work around, but doesn't. I have reported this to php.net as bug #63419:
878 // https://bugs.php.net/bug.php?id=63419
879 // There was already a similar report for SQLite3::escapeString, bug #62361:
880 // https://bugs.php.net/bug.php?id=62361
881 // There is an additional bug regarding sorting this data after insert
882 // on older versions of sqlite shipped with ubuntu 12.04
883 // https://phabricator.wikimedia.org/T74367
884 $this->queryLogger
->debug(
886 ': Quoting value containing null byte. ' .
887 'For consistency all binary data should have been ' .
888 'first processed with self::encodeBlob()'
890 return "x'" . bin2hex( (string)$s ) . "'";
892 return $this->getBindingHandle()->quote( (string)$s );
896 public function buildSubstring( $input, $startPosition, $length = null ) {
897 $this->assertBuildSubstringParams( $startPosition, $length );
898 $params = [ $input, $startPosition ];
899 if ( $length !== null ) {
902 return 'SUBSTR(' . implode( ',', $params ) . ')';
906 * @param string $field Field or column to cast
910 public function buildStringCast( $field ) {
911 return 'CAST ( ' . $field . ' AS TEXT )';
915 * No-op version of deadlockLoop
919 public function deadlockLoop( /*...*/ ) {
920 $args = func_get_args();
921 $function = array_shift( $args );
923 return $function( ...$args );
930 protected function replaceVars( $s ) {
931 $s = parent
::replaceVars( $s );
932 if ( preg_match( '/^\s*(CREATE|ALTER) TABLE/i', $s ) ) {
933 // CREATE TABLE hacks to allow schema file sharing with MySQL
935 // binary/varbinary column type -> blob
936 $s = preg_replace( '/\b(var)?binary(\(\d+\))/i', 'BLOB', $s );
937 // no such thing as unsigned
938 $s = preg_replace( '/\b(un)?signed\b/i', '', $s );
940 $s = preg_replace( '/\b(tiny|small|medium|big|)int(\s*\(\s*\d+\s*\)|\b)/i', 'INTEGER', $s );
941 // floating point types -> REAL
943 '/\b(float|double(\s+precision)?)(\s*\(\s*\d+\s*(,\s*\d+\s*)?\)|\b)/i',
948 $s = preg_replace( '/\b(var)?char\s*\(.*?\)/i', 'TEXT', $s );
949 // TEXT normalization
950 $s = preg_replace( '/\b(tiny|medium|long)text\b/i', 'TEXT', $s );
951 // BLOB normalization
952 $s = preg_replace( '/\b(tiny|small|medium|long|)blob\b/i', 'BLOB', $s );
954 $s = preg_replace( '/\bbool(ean)?\b/i', 'INTEGER', $s );
956 $s = preg_replace( '/\b(datetime|timestamp)\b/i', 'TEXT', $s );
958 $s = preg_replace( '/\benum\s*\([^)]*\)/i', 'TEXT', $s );
959 // binary collation type -> nothing
960 $s = preg_replace( '/\bbinary\b/i', '', $s );
961 // auto_increment -> autoincrement
962 $s = preg_replace( '/\bauto_increment\b/i', 'AUTOINCREMENT', $s );
963 // No explicit options
964 $s = preg_replace( '/\)[^);]*(;?)\s*$/', ')\1', $s );
965 // AUTOINCREMENT should immedidately follow PRIMARY KEY
966 $s = preg_replace( '/primary key (.*?) autoincrement/i', 'PRIMARY KEY AUTOINCREMENT $1', $s );
967 } elseif ( preg_match( '/^\s*CREATE (\s*(?:UNIQUE|FULLTEXT)\s+)?INDEX/i', $s ) ) {
968 // No truncated indexes
969 $s = preg_replace( '/\(\d+\)/', '', $s );
971 $s = preg_replace( '/\bfulltext\b/i', '', $s );
972 } elseif ( preg_match( '/^\s*DROP INDEX/i', $s ) ) {
973 // DROP INDEX is database-wide, not table-specific, so no ON <table> clause.
974 $s = preg_replace( '/\sON\s+[^\s]*/i', '', $s );
975 } elseif ( preg_match( '/^\s*INSERT IGNORE\b/i', $s ) ) {
976 // INSERT IGNORE --> INSERT OR IGNORE
977 $s = preg_replace( '/^\s*INSERT IGNORE\b/i', 'INSERT OR IGNORE', $s );
983 public function lock( $lockName, $method, $timeout = 5 ) {
984 $status = $this->lockMgr
->lock( [ $lockName ], LockManager
::LOCK_EX
, $timeout );
986 $this->lockMgr
instanceof FSLockManager
&&
987 $status->hasMessage( 'lockmanager-fail-openlock' )
989 throw new DBError( $this, "Cannot create directory \"{$this->getLockFileDirectory()}\"" );
992 return $status->isOK();
995 public function unlock( $lockName, $method ) {
996 return $this->lockMgr
->unlock( [ $lockName ], LockManager
::LOCK_EX
)->isGood();
1000 * Build a concatenation list to feed into a SQL query
1002 * @param string[] $stringList
1005 function buildConcat( $stringList ) {
1006 return '(' . implode( ') || (', $stringList ) . ')';
1009 public function buildGroupConcatField(
1010 $delim, $table, $field, $conds = '', $join_conds = []
1012 $fld = "group_concat($field," . $this->addQuotes( $delim ) . ')';
1014 return '(' . $this->selectSQLText( $table, $fld, $conds, null, [], $join_conds ) . ')';
1018 * @param string $oldName
1019 * @param string $newName
1020 * @param bool $temporary
1021 * @param string $fname
1022 * @return bool|IResultWrapper
1023 * @throws RuntimeException
1025 function duplicateTableStructure( $oldName, $newName, $temporary = false, $fname = __METHOD__
) {
1026 $res = $this->query( "SELECT sql FROM sqlite_master WHERE tbl_name=" .
1027 $this->addQuotes( $oldName ) . " AND type='table'", $fname );
1028 $obj = $this->fetchObject( $res );
1030 throw new RuntimeException( "Couldn't retrieve structure for table $oldName" );
1033 $sql = preg_replace(
1035 preg_quote( trim( $this->addIdentifierQuotes( $oldName ), '"' ), '/' ) .
1037 $this->addIdentifierQuotes( $newName ),
1042 if ( preg_match( '/^\\s*CREATE\\s+VIRTUAL\\s+TABLE\b/i', $sql ) ) {
1043 $this->queryLogger
->debug(
1044 "Table $oldName is virtual, can't create a temporary duplicate.\n" );
1046 $sql = str_replace( 'CREATE TABLE', 'CREATE TEMPORARY TABLE', $sql );
1050 $res = $this->query( $sql, $fname, self
::QUERY_PSEUDO_PERMANENT
);
1052 // Take over indexes
1053 $indexList = $this->query( 'PRAGMA INDEX_LIST(' . $this->addQuotes( $oldName ) . ')' );
1054 foreach ( $indexList as $index ) {
1055 if ( strpos( $index->name
, 'sqlite_autoindex' ) === 0 ) {
1059 if ( $index->unique
) {
1060 $sql = 'CREATE UNIQUE INDEX';
1062 $sql = 'CREATE INDEX';
1064 // Try to come up with a new index name, given indexes have database scope in SQLite
1065 $indexName = $newName . '_' . $index->name
;
1066 $sql .= ' ' . $indexName . ' ON ' . $newName;
1068 $indexInfo = $this->query( 'PRAGMA INDEX_INFO(' . $this->addQuotes( $index->name
) . ')' );
1070 foreach ( $indexInfo as $indexInfoRow ) {
1071 $fields[$indexInfoRow->seqno
] = $indexInfoRow->name
;
1074 $sql .= '(' . implode( ',', $fields ) . ')';
1076 $this->query( $sql );
1083 * List all tables on the database
1085 * @param string|null $prefix Only show tables with this prefix, e.g. mw_
1086 * @param string $fname Calling function name
1090 function listTables( $prefix = null, $fname = __METHOD__
) {
1091 $result = $this->select(
1099 foreach ( $result as $table ) {
1100 $vars = get_object_vars( $table );
1101 $table = array_pop( $vars );
1103 if ( !$prefix ||
strpos( $table, $prefix ) === 0 ) {
1104 if ( strpos( $table, 'sqlite_' ) !== 0 ) {
1105 $endArray[] = $table;
1114 * Override due to no CASCADE support
1116 * @param string $tableName
1117 * @param string $fName
1118 * @return bool|IResultWrapper
1119 * @throws DBReadOnlyError
1121 public function dropTable( $tableName, $fName = __METHOD__
) {
1122 if ( !$this->tableExists( $tableName, $fName ) ) {
1125 $sql = "DROP TABLE " . $this->tableName( $tableName );
1127 return $this->query( $sql, $fName, self
::QUERY_IGNORE_DBO_TRX
);
1130 public function setTableAliases( array $aliases ) {
1131 parent
::setTableAliases( $aliases );
1132 foreach ( $this->tableAliases
as $params ) {
1133 if ( isset( $this->alreadyAttached
[$params['dbname']] ) ) {
1136 $this->attachDatabase( $params['dbname'] );
1137 $this->alreadyAttached
[$params['dbname']] = true;
1141 public function resetSequenceForTable( $table, $fname = __METHOD__
) {
1142 $encTable = $this->addIdentifierQuotes( 'sqlite_sequence' );
1143 $encName = $this->addQuotes( $this->tableName( $table, 'raw' ) );
1145 "DELETE FROM $encTable WHERE name = $encName",
1147 self
::QUERY_IGNORE_DBO_TRX
1151 public function databasesAreIndependent() {
1158 protected function getBindingHandle() {
1159 return parent
::getBindingHandle();
1164 * @deprecated since 1.29
1166 class_alias( DatabaseSqlite
::class, 'DatabaseSqlite' );