Manual:SQLite/en

The purpose of this page is to collect information and experiences about running MediaWiki on SQLite.

MediaWiki supports SQLite since 1.17, but please note that this is second-class support, and you may likely run into some bugs. The database most commonly used with MediaWiki is MySQL . See Phabricator for a list of issues. MediaWiki requires SQLite 3.8.0 or later. Support for SQLite by extensions which make database changes is varied.

Is SQLite a good choice for MediaWiki?

There are two important caveats to using SQLite for MediaWiki. First, while many extensions do support SQLite, there are some popular extensions that still do not support it to this day. Second, SQLite does not scale beyond one server. In case your wiki may grow to have many concurrent users and a large amount of content, it would be better to use a database system that supports the primary-replica model such as MySQL. As a result, if your wiki may depend on using these extensions, or it may need to use a primary-replica database system, it is best to use a MySQL database for your wiki. The decision to use SQLite, MySQL, or another database system should ideally be made before you create your wiki, as it is difficult to convert from a SQLite database to a MySQL database once you have started using your wiki.

About SQLite

SQLite is an open-source database library released into public domain. Unlike client-server database management systems, the SQLite library is linked into PHP and thus becomes an integral part of the server process. MediaWiki uses SQLite's functionality through simple function calls, which reduces latency in database access as function calls are more efficient than inter-process communication.

Using SQLite as database backend for MediaWiki has its own pros and cons:

Pros

You don't have to install and maintain a standalone database server such as MySQL; this significantly reduces efforts spent on administration and removes some points of failure.
The former also means that SQLite is much more suitable for portable MediaWiki installs running from a USB stick.
You are not restricted by artificial database limitations on shared hosts.
The entire database is stored as a single cross-platform file, simplifying backups and migration.

Cons

SQLite is not that scalable, so if you have a large and popular wiki, you should use MySQL.
Although SQLite has its own search engine, it's not supported by more advanced solutions such as Lucene.
Several extensions are known to have database update or installation issues with SQLite: AbuseFilter, Echo, Flow, and LiquidThreads.

SQLite installation

At least SQLite version 3.8.0+ is required. Also, in order to use full text search, SQLite must be compiled with FTS3 module enabled (most builds have it out of the box these days). SQLite3 works via PHP's PDO functions.

To install SQLite3 on a Debian or Ubuntu based system, use apt install php-sqlite3.
Windows binaries from php.net are OK.
The PHP PDO SQLite module needs to be loaded. You should uncomment the following line in your php.ini
- extension=pdo_sqlite
Where should you put the SQLite database itself? The default path seems to be $IP/../data/$dbname.sqlite. Anything outside of the webroot should be safe; it's good to keep it nearby. Or, if you feel like it, you could put it in the web root somewhere and make sure to use webserver config to deny access to it.

Installing MediaWiki on SQLite backend

If SQLite module for PHP is properly installed, MediaWiki installer (/mw-config/index.php) should offer you an option to use SQLite.
If you enter nothing into the "SQLite data directory" field, your $wgSQLiteDataDir will be left empty, which corresponds to data directory in the parent of the document root, however this directory might be different for web scripts and maintenance scripts run from command line, so specifying it explicitly is recommended.

Search engine

MediaWiki version:

<translate> ≥</translate> 1.16

Search capabilities for SQLite backend was introduced in MediaWiki 1.16. They require SQLite with FTS3 module compiled-in, which is usually present in most modern builds. If you've recently updated your SQLite support to a version that includes FTS3, run the updater as if you're upgrading MediaWiki. After the updater script created the search index table, populate it with rebuildtextindex.php . Same applies to switches back to environments without FTS3: re-running the updater will downgrade the table to avoid SQL errors.

Backing up

<translate> If your wiki is currently offline, its database can be backed up by simply copying the database file.</translate> <translate> Otherwise, you should use [[<tvar|1>Special:MyLanguage/Manual:SqliteMaintenance.php</>|a maintenance script]]: <tvar|2>php maintenance/SqliteMaintenance.php --backup-to <backup file name></>, which will make sure that operation is atomic and there are no inconsistencies.</translate> <translate> If your database is not really huge and server is not under heavy load, users editing the wiki will notice nothing but a short lag.</translate> <translate> Users who are just reading will not notice anything in any case.</translate>

Troubleshooting

Unable to access the database on the terminal

To get command-line access to the database, type on the terminal:

sqlite3 /var/data/database_name.sqlite

replacing /var/data with the directory that was set as the "SQLite data directory" during the installation process. Alternatively, look for $wgSQLiteDataDir inside LocalSettings.php .

This can be tricky if you are not experienced about SQLite and run sqlite3 database_name - because this will open a completely different database (creating it if it doesn't exist) since SQLite interprets the argument not as a system-wide database name, but instead as the file name that contains the db.

Problems

Bugs should be reported to Wikimedia's bug tracker. First check if your problem was already reported - check the dependencies of tag #sqlite and use search. If you can't find your problem, create a new issue. In any case please take some steps to make your bug easy to find and track: mention SQLite in its summary field and make it have the project tag SQLite.

Performance Tips

If possible, ensure you have the APCu php extension installed and $wgMainCacheType set to CACHE_ACCEL. If no cache is present, MediaWiki will use the database as a cache backend, which can lead to write contention. On Sqlite this can significantly slow down your wiki.
Make sure your SQLite database is in WAL mode (Write-Ahead Logging – WAL). This can have a major impact on performance when people are viewing and editing your site at the same time. You can do this by using the sqlite command line tool to open the DB, and run the command PRAGMA journal_mode=wal;.

External links