docs/customize/SQLite.md

   1 A Nominatim database can be converted into an SQLite database and used as
   2 a read-only source for geocoding queries. This sections describes how to
   3 create and use an SQLite database.
   4
   5 !!! danger
   6     This feature is in an experimental state at the moment. Use at your own
   7     risk.
   8
   9 ## Installing prerequisites
  10
  11 To use a SQLite database, you need to install:
  12
  13 * SQLite (>= 3.30)
  14 * Spatialite (> 5.0.0)
  15 * aiosqlite
  16
  17 On Ubuntu/Debian, you can run:
  18
  19     sudo apt install sqlite3 libsqlite3-mod-spatialite libspatialite7
  20
  21 Install the aiosqlite Python package in your virtual environment:
  22
  23     /srv/nominatim-venv/bin/pip install aiosqlite
  24
  25 ## Creating a new SQLite database
  26
  27 Nominatim cannot import directly into SQLite database. Instead you have to
  28 first create a geocoding database in PostgreSQL by running a
  29 [regular Nominatim import](../admin/Import.md).
  30
  31 Once this is done, the database can be converted to SQLite with
  32
  33     nominatim convert -o mydb.sqlite
  34
  35 This will create a database where all geocoding functions are available.
  36 Depending on what functions you need, the database can be made smaller:
  37
  38 * `--without-reverse` omits indexes only needed for reverse geocoding
  39 * `--without-search` omit tables and indexes used for forward search
  40 * `--without-details` leaves out extra information only available in the
  41   details API
  42
  43 ## Using an SQLite database
  44
  45 Once you have created the database, you can use it by simply pointing the
  46 database DSN to the SQLite file:
  47
  48     NOMINATIM_DATABASE_DSN=sqlite:dbname=mydb.sqlite
  49
  50 Please note that SQLite support is only available for the Python frontend. To
  51 use the test server with an SQLite database, you therefore need to switch
  52 the frontend engine:
  53
  54     nominatim serve --engine falcon
  55
  56 You need to install falcon or starlette for this, depending on which engine
  57 you choose.
  58
  59 The CLI query commands and the library interface already use the new Python
  60 frontend and therefore work right out of the box.