docs/admin/Import-and-Update.md

   1 # Importing and Updating the Database
   2
   3 The following instructions explain how to create a Nominatim database
   4 from an OSM planet file and how to keep the database up to date. It
   5 is assumed that you have already successfully installed the Nominatim
   6 software itself, if not return to the [installation page](Installation.md).
   7
   8 ## Configuration setup in settings/local.php
   9
  10 The Nominatim server can be customized via the file `settings/local.php`
  11 in the build directory. Note that this is a PHP file, so it must always
  12 start like this:
  13
  14     <?php
  15
  16 without any leading spaces.
  17
  18 There are lots of configuration settings you can tweak. Have a look
  19 at `settings/default.php` for a full list. Most should have a sensible default.
  20
  21 #### Flatnode files
  22
  23 If you plan to import a large dataset (e.g. Europe, North America, planet),
  24 you should also enable flatnode storage of node locations. With this
  25 setting enabled, node coordinates are stored in a simple file instead
  26 of the database. This will save you import time and disk storage.
  27 Add to your `settings/local.php`:
  28
  29     @define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file');
  30
  31 Replace the second part with a suitable path on your system and make sure
  32 the directory exists. There should be at least 40GB of free space.
  33
  34 ## Downloading additional data
  35
  36 ### Wikipedia rankings
  37
  38 Wikipedia can be used as an optional auxiliary data source to help indicate
  39 the importance of osm features. Nominatim will work without this information
  40 but it will improve the quality of the results if this is installed.
  41 This data is available as a binary download:
  42
  43     cd $NOMINATIM_SOURCE_DIR/data
  44     wget https://www.nominatim.org/data/wikipedia_article.sql.bin
  45     wget https://www.nominatim.org/data/wikipedia_redirect.sql.bin
  46
  47 Combined the 2 files are around 1.5GB and add around 30GB to the install
  48 size of nominatim. They also increase the install time by an hour or so.
  49
  50 *NOTE:* you'll need to download the Wikipedia rankings before performing
  51 the initial import of the data if you want the rankings applied to the
  52 loaded data.
  53
  54 ### UK postcodes
  55
  56 Nominatim can use postcodes from an external source to improve searches that involve a UK postcode. This data can be optionally downloaded:
  57
  58     cd $NOMINATIM_SOURCE_DIR/data
  59     wget https://www.nominatim.org/data/gb_postcode_data.sql.gz
  60
  61
  62 ## Initial import of the data
  63
  64 **Important:** first try the import with a small excerpt, for example from
  65 [Geofabrik](https://download.geofabrik.de).
  66
  67 Download the data to import and load the data with the following command:
  68
  69 ```sh
  70 ./utils/setup.php --osm-file <data file> --all [--osm2pgsql-cache 28000] 2>&1 | tee setup.log
  71 ```
  72
  73 The `--osm2pgsql-cache` parameter is optional but strongly recommended for
  74 planet imports. It sets the node cache size for the osm2pgsql import part
  75 (see `-C` parameter in osm2pgsql help). As a rule of thumb, this should be
  76 about the same size as the file you are importing but never more than
  77 2/3 of RAM available. If your machine starts swapping reduce the size.
  78
  79 Computing word frequency for search terms can improve the performance of
  80 forward geocoding in particular under high load as it helps Postgres' query
  81 planner to make the right decisions. To recompute word counts run:
  82
  83 ```sh
  84 ./utils/update.php --recompute-word-counts
  85 ```
  86
  87 This will take a couple of hours for a full planet installation. You can
  88 also defer that step to a later point in time when you realise that
  89 performance becomes an issue. Just make sure that updates are stopped before
  90 running this function.
  91
  92 If you want to be able to search for places by their type through
  93 [special key phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases)
  94 you also need to enable these key phrases like this:
  95
  96     ./utils/specialphrases.php --wiki-import > specialphrases.sql
  97     psql -d nominatim -f specialphrases.sql
  98
  99 Note that this command downloads the phrases from the wiki link above.
 100
 101
 102 ## Installing Tiger housenumber data for the US
 103
 104 Nominatim is able to use the official [TIGER](https://www.census.gov/geo/maps-data/data/tiger.html)
 105 address set to complement the OSM house number data in the US. You can add
 106 TIGER data to your own Nominatim instance by following these steps. The
 107 entire US adds about 10GB to your database.
 108
 109   1. Get preprocessed TIGER 2018 data and unpack it into the
 110      data directory in your Nominatim sources:
 111
 112         cd Nominatim/data
 113         wget https://nominatim.org/data/tiger2018-nominatim-preprocessed.tar.gz
 114         tar xf tiger2018-nominatim-preprocessed.tar.gz
 115
 116     `data-source/us-tiger/README.md` explains how the data got preprocessed.
 117
 118   2. Import the data into your Nominatim database:
 119
 120         ./utils/setup.php --import-tiger-data
 121
 122   3. Enable use of the Tiger data in your `settings/local.php` by adding:
 123
 124          @define('CONST_Use_US_Tiger_Data', true);
 125
 126   4. Apply the new settings:
 127
 128 ```sh
 129     ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
 130 ```
 131
 132
 133 ## Updates
 134
 135 There are many different possibilities to update your Nominatim database.
 136 The following section describes how to keep it up-to-date with Pyosmium.
 137 For a list of other methods see the output of `./utils/update.php --help`.
 138
 139 #### Installing the newest version of Pyosmium
 140
 141 It is recommended to install Pyosmium via pip. Run (as the same user who
 142 will later run the updates):
 143
 144 ```sh
 145 pip install --user osmium
 146 ```
 147
 148 Nominatim needs a tool called `pyosmium-get-updates`, which comes with
 149 Pyosmium. You need to tell Nominatim where to find it. Add the
 150 following line to your `settings/local.php`:
 151
 152     @define('CONST_Pyosmium_Binary', '/home/user/.local/bin/pyosmium-get-changes');
 153
 154 The path above is fine if you used the `--user` parameter with pip.
 155 Replace `user` with your user name.
 156
 157 #### Setting up the update process
 158
 159 Next the update needs to be initialised. By default Nominatim is configured
 160 to update using the global minutely diffs.
 161
 162 If you want a different update source you will need to add some settings
 163 to `settings/local.php`. For example, to use the daily country extracts
 164 diffs for Ireland from geofabrik add the following:
 165
 166     // base URL of the replication service
 167     @define('CONST_Replication_Url', 'https://download.geofabrik.de/europe/ireland-and-northern-ireland-updates');
 168     // How often upstream publishes diffs
 169     @define('CONST_Replication_Update_Interval', '86400');
 170     // How long to sleep if no update found yet
 171     @define('CONST_Replication_Recheck_Interval', '900');
 172
 173 To set up the update process now run the following command:
 174
 175     ./utils/update.php --init-updates
 176
 177 It outputs the date where updates will start. Recheck that this date is
 178 what you expect.
 179
 180 The --init-updates command needs to be rerun whenever the replication service
 181 is changed.
 182
 183 #### Updating Nominatim
 184
 185 The following command will keep your database constantly up to date:
 186
 187     ./utils/update.php --import-osmosis-all
 188
 189 (Note that even though the old name "import-osmosis-all" has been kept for compatibility reasons, Osmosis is not required to run this - it uses pyosmium behind the scenes.)
 190
 191 If you have imported multiple country extracts and want to keep them
 192 up-to-date, have a look at the script in
 193 [issue #60](https://github.com/openstreetmap/Nominatim/issues/60).
 194