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 address set to complement the
 105 OSM house number data in the US. You can add TIGER data to your own Nominatim
 106 instance by following these steps:
 107
 108   1. Install the GDAL library and python bindings and the unzip tool
 109
 110        * Ubuntu: `sudo apt-get install python-gdal unzip`
 111        * CentOS: `sudo yum install gdal-python unzip`
 112
 113   2. Get preprocessed TIGER 2017 data and unpack it into the
 114      data directory in your Nominatim sources:
 115
 116         cd Nominatim/data
 117         wget https://nominatim.org/data/tiger2017-nominatim-preprocessed.tar.gz
 118         tar xf tiger2017-nominatim-preprocessed.tar.gz
 119
 120   3. Import the data into your Nominatim database:
 121
 122         ./utils/setup.php --import-tiger-data
 123
 124   4. Enable use of the Tiger data in your `settings/local.php` by adding:
 125
 126          @define('CONST_Use_US_Tiger_Data', true);
 127
 128   5. Apply the new settings:
 129
 130 ```sh
 131     ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
 132 ```
 133
 134 The entire US adds about 10GB to your database.
 135
 136 You can also process the data from the original TIGER data to create the
 137 SQL files, Nominatim needs for the import:
 138
 139   1. Get the TIGER 2017 data. You will need the EDGES files
 140      (3,234 zip files, 11GB total).
 141
 142          wget -r ftp://ftp2.census.gov/geo/tiger/TIGER2017/EDGES/
 143
 144   2. Convert the data into SQL statements:
 145
 146          ./utils/imports.php --parse-tiger <tiger edge data directory>
 147
 148 Be warned that this can take quite a long time. After this process is finished,
 149 the same preprocessed files as above are available in `data/tiger`.
 150
 151 ## Updates
 152
 153 There are many different possibilities to update your Nominatim database.
 154 The following section describes how to keep it up-to-date with Pyosmium.
 155 For a list of other methods see the output of `./utils/update.php --help`.
 156
 157 #### Installing the newest version of Pyosmium
 158
 159 It is recommended to install Pyosmium via pip. Run (as the same user who
 160 will later run the updates):
 161
 162 ```sh
 163 pip install --user osmium
 164 ```
 165
 166 Nominatim needs a tool called `pyosmium-get-updates`, which comes with
 167 Pyosmium. You need to tell Nominatim where to find it. Add the
 168 following line to your `settings/local.php`:
 169
 170     @define('CONST_Pyosmium_Binary', '/home/user/.local/bin/pyosmium-get-changes');
 171
 172 The path above is fine if you used the `--user` parameter with pip.
 173 Replace `user` with your user name.
 174
 175 #### Setting up the update process
 176
 177 Next the update needs to be initialised. By default Nominatim is configured
 178 to update using the global minutely diffs.
 179
 180 If you want a different update source you will need to add some settings
 181 to `settings/local.php`. For example, to use the daily country extracts
 182 diffs for Ireland from geofabrik add the following:
 183
 184     // base URL of the replication service
 185     @define('CONST_Replication_Url', 'https://download.geofabrik.de/europe/ireland-and-northern-ireland-updates');
 186     // How often upstream publishes diffs
 187     @define('CONST_Replication_Update_Interval', '86400');
 188     // How long to sleep if no update found yet
 189     @define('CONST_Replication_Recheck_Interval', '900');
 190
 191 To set up the update process now run the following command:
 192
 193     ./utils/update.php --init-updates
 194
 195 It outputs the date where updates will start. Recheck that this date is
 196 what you expect.
 197
 198 The --init-updates command needs to be rerun whenever the replication service
 199 is changed.
 200
 201 #### Updating Nominatim
 202
 203 The following command will keep your database constantly up to date:
 204
 205     ./utils/update.php --import-osmosis-all
 206
 207 (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.)
 208
 209 If you have imported multiple country extracts and want to keep them
 210 up-to-date, have a look at the script in
 211 [issue #60](https://github.com/openstreetmap/Nominatim/issues/60).
 212