]> git.openstreetmap.org Git - nominatim.git/blob - docs/admin/Import.md
Merge remote-tracking branch 'upstream/master'
[nominatim.git] / docs / admin / Import.md
1 # Importing the Database
2
3 The following instructions explain how to create a Nominatim database
4 from an OSM planet file. It is assumed that you have already successfully
5 installed the Nominatim software itself and the `nominatim` tool can be found
6 in your `PATH`. If this is not the case, return to the
7 [installation page](Installation.md).
8
9 ## Creating the project directory
10
11 Before you start the import, you should create a project directory for your
12 new database installation. This directory receives all data that is related
13 to a single Nominatim setup: configuration, extra data, etc. Create a project
14 directory apart from the Nominatim software and change into the directory:
15
16 ```
17 mkdir ~/nominatim-planet
18 cd ~/nominatim-planet
19 ```
20
21 In the following, we refer to the project directory as `$PROJECT_DIR`. To be
22 able to copy&paste instructions, you can export the appropriate variable:
23
24 ```
25 export PROJECT_DIR=~/nominatim-planet
26 ```
27
28 The Nominatim tool assumes per default that the current working directory is
29 the project directory but you may explicitly state a different directory using
30 the `--project-dir` parameter. The following instructions assume that you run
31 all commands from the project directory.
32
33 !!! tip "Migration Tip"
34
35     Nominatim used to be run directly from the build directory until version 3.6.
36     Essentially, the build directory functioned as the project directory
37     for the database installation. This setup still works and can be useful for
38     development purposes. It is not recommended anymore for production setups.
39     Create a project directory that is separate from the Nominatim software.
40
41 ### Configuration setup in `.env`
42
43 The Nominatim server can be customized via an `.env` configuration file in the 
44 project directory. This is a file in [dotenv](https://github.com/theskumar/python-dotenv)
45 format which looks the same as variable settings in a standard shell environment.
46 You can also set the same configuration via environment variables. All
47 settings have a `NOMINATIM_` prefix to avoid conflicts with other environment
48 variables.
49
50 There are lots of configuration settings you can tweak. Have a look
51 at `Nominatim/settings/env.default` for a full list. Most should have a sensible default.
52
53 #### Flatnode files
54
55 If you plan to import a large dataset (e.g. Europe, North America, planet),
56 you should also enable flatnode storage of node locations. With this
57 setting enabled, node coordinates are stored in a simple file instead
58 of the database. This will save you import time and disk storage.
59 Add to your `.env`:
60
61     NOMINATIM_FLATNODE_FILE="/path/to/flatnode.file"
62
63 Replace the second part with a suitable path on your system and make sure
64 the directory exists. There should be at least 75GB of free space.
65
66 ## Downloading additional data
67
68 ### Wikipedia/Wikidata rankings
69
70 Wikipedia can be used as an optional auxiliary data source to help indicate
71 the importance of OSM features. Nominatim will work without this information
72 but it will improve the quality of the results if this is installed.
73 This data is available as a binary download. Put it into your project directory:
74
75     cd $PROJECT_DIR
76     wget https://www.nominatim.org/data/wikimedia-importance.sql.gz
77
78 The file is about 400MB and adds around 4GB to the Nominatim database.
79
80 !!! tip
81     If you forgot to download the wikipedia rankings, you can also add
82     importances after the import. Download the files, then run
83     `nominatim refresh --wiki-data --importance`. Updating importances for
84     a planet can take a couple of hours.
85
86 ### External postcodes
87
88 Nominatim can use postcodes from an external source to improve searching with
89 postcodes. We provide precomputed postcodes sets for the US (using TIGER data)
90 and the UK (using the [CodePoint OpenData set](https://osdatahub.os.uk/downloads/open/CodePointOpen).
91 This data can be optionally downloaded into the project directory:
92
93     cd $PROJECT_DIR
94     wget https://www.nominatim.org/data/gb_postcodes.csv.gz
95     wget https://www.nominatim.org/data/us_postcodes.csv.gz
96
97 You can also add your own custom postcode sources, see
98 [Customization of postcodes](Customization.md#external-postcode-data).
99
100 ## Choosing the data to import
101
102 In its default setup Nominatim is configured to import the full OSM data
103 set for the entire planet. Such a setup requires a powerful machine with
104 at least 64GB of RAM and around 900GB of SSD hard disks. Depending on your
105 use case there are various ways to reduce the amount of data imported. This
106 section discusses these methods. They can also be combined.
107
108 ### Using an extract
109
110 If you only need geocoding for a smaller region, then precomputed OSM extracts
111 are a good way to reduce the database size and import time.
112 [Geofabrik](https://download.geofabrik.de) offers extracts for most countries.
113 They even have daily updates which can be used with the update process described
114 [in the next section](../Update). There are also
115 [other providers for extracts](https://wiki.openstreetmap.org/wiki/Planet.osm#Downloading).
116
117 Please be aware that some extracts are not cut exactly along the country
118 boundaries. As a result some parts of the boundary may be missing which means
119 that Nominatim cannot compute the areas for some administrative areas.
120
121 ### Dropping Data Required for Dynamic Updates
122
123 About half of the data in Nominatim's database is not really used for serving
124 the API. It is only there to allow the data to be updated from the latest
125 changes from OSM. For many uses these dynamic updates are not really required.
126 If you don't plan to apply updates, you can run the import with the
127 `--no-updates` parameter. This will drop the dynamic part of the database as
128 soon as it is not required anymore.
129
130 You can also drop the dynamic part later using the following command:
131
132 ```
133 nominatim freeze
134 ```
135
136 Note that you still need to provide for sufficient disk space for the initial
137 import. So this option is particularly interesting if you plan to transfer the
138 database or reuse the space later.
139
140 ### Reverse-only Imports
141
142 If you only want to use the Nominatim database for reverse lookups or
143 if you plan to use the installation only for exports to a
144 [photon](https://photon.komoot.de/) database, then you can set up a database
145 without search indexes. Add `--reverse-only` to your setup command above.
146
147 This saves about 5% of disk space.
148
149 ### Filtering Imported Data
150
151 Nominatim normally sets up a full search database containing administrative
152 boundaries, places, streets, addresses and POI data. There are also other
153 import styles available which only read selected data:
154
155 * **settings/import-admin.style**
156   Only import administrative boundaries and places.
157 * **settings/import-street.style**
158   Like the admin style but also adds streets.
159 * **settings/import-address.style**
160   Import all data necessary to compute addresses down to house number level.
161 * **settings/import-full.style**
162   Default style that also includes points of interest.
163 * **settings/import-extratags.style**
164   Like the full style but also adds most of the OSM tags into the extratags
165   column.
166
167 The style can be changed with the configuration `NOMINATIM_IMPORT_STYLE`.
168
169 To give you an idea of the impact of using the different styles, the table
170 below gives rough estimates of the final database size after import of a
171 2020 planet and after using the `--drop` option. It also shows the time
172 needed for the import on a machine with 64GB RAM, 4 CPUS and NVME disks.
173 Note that the given sizes are just an estimate meant for comparison of
174 style requirements. Your planet import is likely to be larger as the
175 OSM data grows with time.
176
177 style     | Import time  |  DB size   |  after drop
178 ----------|--------------|------------|------------
179 admin     |    4h        |  215 GB    |   20 GB
180 street    |   22h        |  440 GB    |  185 GB
181 address   |   36h        |  545 GB    |  260 GB
182 full      |   54h        |  640 GB    |  330 GB
183 extratags |   54h        |  650 GB    |  340 GB
184
185 You can also customize the styles further.
186 A [description of the style format](../develop/Import.md#configuring-the-import) 
187 can be found in the development section.
188
189 ## Initial import of the data
190
191 !!! danger "Important"
192     First try the import with a small extract, for example from
193     [Geofabrik](https://download.geofabrik.de).
194
195 Download the data to import. Then issue the following command
196 from the **project directory** to start the import:
197
198 ```sh
199 nominatim import --osm-file <data file> 2>&1 | tee setup.log
200 ```
201
202 The **project directory** is the one that you have set up at the beginning.
203 See [creating the project directory](Import#creating-the-project-directory).
204
205 ### Notes on full planet imports
206
207 Even on a perfectly configured machine
208 the import of a full planet takes around 2 days. Once you see messages
209 with `Rank .. ETA` appear, the indexing process has started. This part takes
210 the most time. There are 30 ranks to process. Rank 26 and 30 are the most complex.
211 They take each about a third of the total import time. If you have not reached
212 rank 26 after two days of import, it is worth revisiting your system
213 configuration as it may not be optimal for the import.
214
215 ### Notes on memory usage
216
217 In the first step of the import Nominatim uses [osm2pgsql](https://osm2pgsql.org)
218 to load the OSM data into the PostgreSQL database. This step is very demanding
219 in terms of RAM usage. osm2pgsql and PostgreSQL are running in parallel at 
220 this point. PostgreSQL blocks at least the part of RAM that has been configured
221 with the `shared_buffers` parameter during
222 [PostgreSQL tuning](Installation#postgresql-tuning)
223 and needs some memory on top of that. osm2pgsql needs at least 2GB of RAM for
224 its internal data structures, potentially more when it has to process very large
225 relations. In addition it needs to maintain a cache for node locations. The size
226 of this cache can be configured with the parameter `--osm2pgsql-cache`.
227
228 When importing with a flatnode file, it is best to disable the node cache
229 completely and leave the memory for the flatnode file. Nominatim will do this
230 by default, so you do not need to configure anything in this case.
231
232 For imports without a flatnode file, set `--osm2pgsql-cache` approximately to
233 the size of the OSM pbf file you are importing. The size needs to be given in
234 MB. Make sure you leave enough RAM for PostgreSQL and osm2pgsql as mentioned
235 above. If the system starts swapping or you are getting out-of-memory errors,
236 reduce the cache size or even consider using a flatnode file.
237
238
239 ### Testing the installation
240
241 Run this script to verify all required tables and indices got created successfully.
242
243 ```sh
244 nominatim admin --check-database
245 ```
246
247 Now you can try out your installation by running:
248
249 ```sh
250 nominatim serve
251 ```
252
253 This runs a small test server normally used for development. You can use it
254 to verify that your installation is working. Go to
255 `http://localhost:8088/status.php` and you should see the message `OK`.
256 You can also run a search query, e.g. `http://localhost:8088/search.php?q=Berlin`.
257
258 Note that search query is not supported for reverse-only imports. You can run a
259 reverse query, e.g. `http://localhost:8088/reverse.php?lat=27.1750090510034&lon=78.04209025`.
260
261 To run Nominatim via webservers like Apache or nginx, please read the
262 [Deployment chapter](Deployment.md).
263
264 ## Tuning the database
265
266 Accurate word frequency information for search terms helps PostgreSQL's query
267 planner to make the right decisions. Recomputing them can improve the performance
268 of forward geocoding in particular under high load. To recompute word counts run:
269
270 ```sh
271 nominatim refresh --word-counts
272 ```
273
274 This will take a couple of hours for a full planet installation. You can
275 also defer that step to a later point in time when you realise that
276 performance becomes an issue. Just make sure that updates are stopped before
277 running this function.
278
279 If you want to be able to search for places by their type through
280 [special key phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases)
281 you also need to import these key phrases like this:
282
283 ```sh
284 nominatim special-phrases --import-from-wiki
285 ```
286
287 Note that this command downloads the phrases from the wiki link above. You
288 need internet access for the step.
289
290 You can also import special phrases from a csv file, for more 
291 information please read the [Customization chapter](Customization.md).