Manual:SQLite

From MediaWiki.org

Jump to: navigation, search
SQLite logo

SQLite support for MediaWiki is mostly functional as of MediaWiki 1.16, but still in active development. Since MediaWiki version 1.13 the SQLite support is part of the main code-base. There are some notes below on installing the SQLite library into your PHP environment. The development notes and future plans are at OrganicDesign:MediaWikiLite.

Contents

[edit] 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:

Pro
  • 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.
Contra
  • SQLite is not that scalable, so if you have a large and popular wiki, you may want to use MySQL or Postgres.
  • Although SQLite has its own search engine, it's not supported by more advanced solutions such as Lucene.
  • Some PHP builds (XAMPP, RHEL) come with outdated SQLite versions that limit the functionality and may contain bugs.

[edit] SQLite installation

Although all SQLite versions above 3.1.2 (required for ADD COLUMN) are supported, SQLite 3.6 is recommended, as it has some data integrity bugs fixed. 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 based system, use apt-get install php5-sqlite3.
  • Since PHP 5.1.0, SQLite depends on PDO. You should uncomment the following two lines in your php.ini (note: sometimes you can't even use phpinfo() to check if they are present, because an SQLite-enabled PHP tend to crash or fail when PDO is absent, especially on Windows):
    • extension=php_pdo_sqlite.so (or extension=php_pdo_sqlite.dll for Windows)
    • extension=php_pdo.so (or extension=php_pdo.dll for Windows)

[edit] Installing MediaWiki on SQLite backend

  • If SQLite module for PHP is properly installed, MediaWiki installer (/config/index.php) should offer you an option to use SQLite. On MediaWiki versions prior to 1.16, you need to enter something into the "DB username" and "DB password" fields for installer to continue even though SQLite does not need them.
  • 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.

[edit] Search engine

Search capabilities for SQLite backend will be released 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.

[edit] Problems?

Bugs should be reported to Wikimedia's bug tracker. First check if your problem was already reported - check the dependencies of tracking bug 20257 and use search. If you can't find your problem, create a new issue. If the problem is directly related to SQLite backend, report it under MediaWiki → Database component. Otherwise (if the problem is related to one very specific aspect, of the software or an extension), select an appropriate product and component. In any case please take some steps to make your bug easy to find and track: mention SQLite is its summary field and make it depend on bug 20257.

[edit] See also

[edit] External links

Databases
Engines: MySQL – PostgreSQL – SQLite – IBM DB2
Technical documentation: Schema (tables) – Access
Retrieved from "http://www.mediawiki.org/wiki/Manual:SQLite"