docs/Import_and_update.md

   1 Importing a new database
   2 ========================
   3
   4 The following instructions explain how to create a Nominatim database
   5 from an OSM planet file and how to keep the database up to date. It
   6 is assumed that you have already sucessfully installed the Nominatim
   7 software itself, if not return to the [installation page](Installation.md).
   8
   9 Configuration setup in settings/local.php
  10 -----------------------------------------
  11
  12 There are lots of configuration settings you can tweak. Have a look
  13 at `settings/settings.php` for a full list. Most should have a sensible default.
  14 If you plan to import a large dataset (e.g. Europe, North America, planet),
  15 you should also enable flatnode storage of node locations. With this
  16 setting enabled, node coordinates are stored in a simple file instead
  17 of the database. This will save you import time and disk storage.
  18 Add to your settings/local.php:
  19
  20     @define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file');
  21
  22 Replace the second part with a suitable path on your system and make sure
  23 the directory exists. There should be at least 35GB of free space.
  24
  25 Downloading additional data
  26 ---------------------------
  27
  28 ### Wikipedia rankings
  29
  30 Wikipedia can be used as an optional auxiliary data source to help indicate
  31 the importance of osm features. Nominatim will work without this information
  32 but it will improve the quality of the results if this is installed.
  33 This data is available as a binary download:
  34
  35     cd $NOMINATIM_SOURCE_DIR/data
  36     wget http://www.nominatim.org/data/wikipedia_article.sql.bin
  37     wget http://www.nominatim.org/data/wikipedia_redirect.sql.bin
  38
  39 Combined the 2 files are around 1.5GB and add around 30GB to the install
  40 size of nominatim. They also increase the install time by an hour or so.
  41
  42 ### UK postcodes
  43
  44 Nominatim can use postcodes from an external source to improve searches that involve a UK postcode. This data can be optionally downloaded:
  45
  46     cd $NOMINATIM_SOURCE_DIR/data
  47     wget http://www.nominatim.org/data/gb_postcode_data.sql.gz
  48
  49
  50 Initial import of the data
  51 --------------------------
  52
  53 **Important:** first try the import with a small excerpt, for example from
  54 [Geofabrik](http://download.geofabrik.de).
  55
  56 Download the data to import and load the data with the following command:
  57
  58     ./utils/setup.php --osm-file <your data file> --all [--osm2pgsql-cache 28000] 2>&1 | tee setup.log
  59
  60 The --osm2pgsql-cache parameter is optional but strongly recommended for
  61 planet imports. It sets the node cache size for the osm2pgsql import part
  62 (see -C parameter in osm2pgsql help). 28GB are recommended for a full planet
  63 import, for excerpts you can use less. Adapt to your available RAM to
  64 avoid swapping, never give more than 2/3 of RAM to osm2pgsql.
  65
  66
  67 Loading additional datasets
  68 ---------------------------
  69
  70 The following commands will create additional entries for countries and POI searches:
  71
  72     ./utils/specialphrases.php --countries > specialphrases_countries.sql
  73     psql -d nominatim -f specialphrases_countries.sql
  74     ./utils/specialphrases.php --wiki-import > specialphrases.sql
  75     psql -d nominatim -f specialphrases.sql
  76
  77
  78 Installing Tiger housenumber data for the US
  79 ============================================
  80
  81 Nominatim is able to use the official TIGER address set to complement the
  82 OSM housenumber data in the US. You can add TIGER data to your own Nominatim
  83 instance by following these steps:
  84
  85   1. Install the GDAL library and python bindings
  86
  87        * Ubuntu: `sudo apt-get install python-gdal`
  88        * CentOS: `sudo yum install gdal-python`
  89
  90   2. Get the TIGER 2015 data. You will need the EDGES files
  91      (3,234 zip files, 11GB total). Choose one of the two sources:
  92
  93          wget -r ftp://ftp2.census.gov/geo/tiger/TIGER2015/EDGES/
  94          wget -r ftp://mirror1.shellbot.com/census/geo/tiger/TIGER2015/EDGES/
  95
  96      The first one is the original source, the second a considerably faster
  97      mirror.
  98
  99   3. Convert the data into SQL statements (stored in data/tiger):
 100
 101          ./utils/imports.php --parse-tiger <tiger edge data directory>
 102
 103   4. Import the data into your Nominatim database:
 104
 105          ./utils/setup.php --import-tiger-data
 106
 107   5. Enable use of the Tiger data in your `settings/local.php` by adding:
 108
 109          @define('CONST_Use_US_Tiger_Data', true);
 110
 111   6. Apply the new settings:
 112
 113         ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
 114
 115 Be warned that the import can take a very long time, especially if you
 116 import all of the US. The entire US adds about 10GB to your database.
 117
 118
 119 Updates
 120 =======
 121
 122 There are many different possibilities to update your Nominatim database.
 123 The following section describes how to keep it up-to-date with osmosis.
 124 For a list of other methods see the output of `./utils/update.php --help`.
 125
 126 Installing the newest version of osmosis
 127 ----------------------------------------
 128
 129 The version of osmosis that comes with your distribution should be sufficient
 130 in most cases.
 131
 132 If you want to install it by hand, get the latest version from the
 133 [Osmosis website](http://wiki.openstreetmap.org/wiki/Osmosis). Then
 134 tell Nominatim to use this version by adding the following line to
 135 your `settings/local.php`:
 136
 137     @define('CONST_Osmosis_Binary', '/usr/local/bin/osmosis');
 138
 139 Setting up the update process
 140 -----------------------------
 141
 142 Next the update needs to be initialised. By default Nominatim is configured
 143 to update using the global minutely diffs.
 144
 145 If you want a different update source you will need to add some settings
 146 to `settings/local.php`. For example, to use the daily country extracts
 147 diffs for Ireland from geofabrik add the following:
 148
 149     // base URL of the replication service
 150     @define('CONST_Replication_Url', 'http://download.geofabrik.de/europe/ireland-and-northern-ireland-updates');
 151     // Process each update separately, osmosis cannot merge multiple updates
 152     @define('CONST_Replication_MaxInterval', '40000');
 153     // How often upstream publishes diffs
 154     @define('CONST_Replication_Update_Interval', '86400');
 155     // How long to sleep if no update found yet
 156     @define('CONST_Replication_Recheck_Interval', '900');
 157
 158
 159 Delete any existing `settings/configuration.txt`, then run the following command
 160 to create the osmosis configuration files:
 161
 162     ./utils/setup.php --osmosis-init
 163
 164 Enabling hierarchical updates
 165 -----------------------------
 166
 167 When a place is updated in the database, all places that contain this place
 168 in their address need to be updated as well. These hierarchical updates are
 169 disabled by default because they slow down the initial import.
 170 Enable them with the following command:
 171
 172     ./utils/setup.php --create-functions --enable-diff-updates
 173
 174 Updating Nominatim
 175 ------------------
 176
 177 The following command will keep your database constantly up to date:
 178
 179     ./utils/update.php --import-osmosis-all --no-npi
 180
 181 If you have imported multiple country extracts and want to keep them
 182 up-to-date, have a look at the script in
 183 (issue #60)[https://github.com/twain47/Nominatim/issues/60].
 184