]> 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. A full reference
51 can be found in the chapter [Configuration Settings](../customize/Settings.md).
52 Most should have a sensible default.
53
54 #### Flatnode files
55
56 If you plan to import a large dataset (e.g. Europe, North America, planet),
57 you should also enable flatnode storage of node locations. With this
58 setting enabled, node coordinates are stored in a simple file instead
59 of the database. This will save you import time and disk storage.
60 Add to your `.env`:
61
62     NOMINATIM_FLATNODE_FILE="/path/to/flatnode.file"
63
64 Replace the second part with a suitable path on your system and make sure
65 the directory exists. There should be at least 75GB of free space.
66
67 ## Downloading additional data
68
69 ### Wikipedia/Wikidata rankings
70
71 Wikipedia can be used as an optional auxiliary data source to help indicate
72 the importance of OSM features. Nominatim will work without this information
73 but it will improve the quality of the results if this is installed.
74 This data is available as a binary download. Put it into your project directory:
75
76     cd $PROJECT_DIR
77     wget https://nominatim.org/data/wikimedia-importance.sql.gz
78
79 The file is about 400MB and adds around 4GB to the Nominatim database.
80
81 !!! tip
82     If you forgot to download the wikipedia rankings, then you can
83     also add importances after the import. Download the SQL files, then
84     run `nominatim refresh --wiki-data --importance`. Updating
85     importances for a planet will take a couple of hours.
86
87 ### External postcodes
88
89 Nominatim can use postcodes from an external source to improve searching with
90 postcodes. We provide precomputed postcodes sets for the US (using TIGER data)
91 and the UK (using the [CodePoint OpenData set](https://osdatahub.os.uk/downloads/open/CodePointOpen).
92 This data can be optionally downloaded into the project directory:
93
94     cd $PROJECT_DIR
95     wget https://nominatim.org/data/gb_postcodes.csv.gz
96     wget https://nominatim.org/data/us_postcodes.csv.gz
97
98 You can also add your own custom postcode sources, see
99 [Customization of postcodes](../customize/Postcodes.md).
100
101 ## Choosing the data to import
102
103 In its default setup Nominatim is configured to import the full OSM data
104 set for the entire planet. Such a setup requires a powerful machine with
105 at least 64GB of RAM and around 900GB of SSD hard disks. Depending on your
106 use case there are various ways to reduce the amount of data imported. This
107 section discusses these methods. They can also be combined.
108
109 ### Using an extract
110
111 If you only need geocoding for a smaller region, then precomputed OSM extracts
112 are a good way to reduce the database size and import time.
113 [Geofabrik](https://download.geofabrik.de) offers extracts for most countries.
114 They even have daily updates which can be used with the update process described
115 [in the next section](Update.md). There are also
116 [other providers for extracts](https://wiki.openstreetmap.org/wiki/Planet.osm#Downloading).
117
118 Please be aware that some extracts are not cut exactly along the country
119 boundaries. As a result some parts of the boundary may be missing which means
120 that Nominatim cannot compute the areas for some administrative areas.
121
122 ### Dropping Data Required for Dynamic Updates
123
124 About half of the data in Nominatim's database is not really used for serving
125 the API. It is only there to allow the data to be updated from the latest
126 changes from OSM. For many uses these dynamic updates are not really required.
127 If you don't plan to apply updates, you can run the import with the
128 `--no-updates` parameter. This will drop the dynamic part of the database as
129 soon as it is not required anymore.
130
131 You can also drop the dynamic part later using the following command:
132
133 ```
134 nominatim freeze
135 ```
136
137 Note that you still need to provide for sufficient disk space for the initial
138 import. So this option is particularly interesting if you plan to transfer the
139 database or reuse the space later.
140
141 !!! warning
142     The data structure for updates are also required when adding additional data
143     after the import, for example [TIGER housenumber data](../customize/Tiger.md).
144     If you plan to use those, you must not use the `--no-updates` parameter.
145     Do a normal import, add the external data and once you are done with
146     everything run `nominatim freeze`.
147
148
149 ### Reverse-only Imports
150
151 If you only want to use the Nominatim database for reverse lookups or
152 if you plan to use the installation only for exports to a
153 [photon](https://photon.komoot.io/) database, then you can set up a database
154 without search indexes. Add `--reverse-only` to your setup command above.
155
156 This saves about 5% of disk space.
157
158 ### Filtering Imported Data
159
160 Nominatim normally sets up a full search database containing administrative
161 boundaries, places, streets, addresses and POI data. There are also other
162 import styles available which only read selected data:
163
164 * **admin**
165   Only import administrative boundaries and places.
166 * **street**
167   Like the admin style but also adds streets.
168 * **address**
169   Import all data necessary to compute addresses down to house number level.
170 * **full**
171   Default style that also includes points of interest.
172 * **extratags**
173   Like the full style but also adds most of the OSM tags into the extratags
174   column.
175
176 The style can be changed with the configuration `NOMINATIM_IMPORT_STYLE`.
177
178 To give you an idea of the impact of using the different styles, the table
179 below gives rough estimates of the final database size after import of a
180 2020 planet and after using the `--drop` option. It also shows the time
181 needed for the import on a machine with 64GB RAM, 4 CPUS and NVME disks.
182 Note that the given sizes are just an estimate meant for comparison of
183 style requirements. Your planet import is likely to be larger as the
184 OSM data grows with time.
185
186 style     | Import time  |  DB size   |  after drop
187 ----------|--------------|------------|------------
188 admin     |    4h        |  215 GB    |   20 GB
189 street    |   22h        |  440 GB    |  185 GB
190 address   |   36h        |  545 GB    |  260 GB
191 full      |   54h        |  640 GB    |  330 GB
192 extratags |   54h        |  650 GB    |  340 GB
193
194 You can also customize the styles further.
195 A [description of the style format](../customize/Import-Styles.md)
196 can be found in the customization guide.
197
198 ## Initial import of the data
199
200 !!! danger "Important"
201     First try the import with a small extract, for example from
202     [Geofabrik](https://download.geofabrik.de).
203
204 Download the data to import. Then issue the following command
205 from the **project directory** to start the import:
206
207 ```sh
208 nominatim import --osm-file <data file> 2>&1 | tee setup.log
209 ```
210
211 The **project directory** is the one that you have set up at the beginning.
212 See [creating the project directory](#creating-the-project-directory).
213
214 ### Notes on full planet imports
215
216 Even on a perfectly configured machine
217 the import of a full planet takes around 2 days. Once you see messages
218 with `Rank .. ETA` appear, the indexing process has started. This part takes
219 the most time. There are 30 ranks to process. Rank 26 and 30 are the most complex.
220 They take each about a third of the total import time. If you have not reached
221 rank 26 after two days of import, it is worth revisiting your system
222 configuration as it may not be optimal for the import.
223
224 ### Notes on memory usage
225
226 In the first step of the import Nominatim uses [osm2pgsql](https://osm2pgsql.org)
227 to load the OSM data into the PostgreSQL database. This step is very demanding
228 in terms of RAM usage. osm2pgsql and PostgreSQL are running in parallel at 
229 this point. PostgreSQL blocks at least the part of RAM that has been configured
230 with the `shared_buffers` parameter during
231 [PostgreSQL tuning](Installation.md#postgresql-tuning)
232 and needs some memory on top of that. osm2pgsql needs at least 2GB of RAM for
233 its internal data structures, potentially more when it has to process very large
234 relations. In addition it needs to maintain a cache for node locations. The size
235 of this cache can be configured with the parameter `--osm2pgsql-cache`.
236
237 When importing with a flatnode file, it is best to disable the node cache
238 completely and leave the memory for the flatnode file. Nominatim will do this
239 by default, so you do not need to configure anything in this case.
240
241 For imports without a flatnode file, set `--osm2pgsql-cache` approximately to
242 the size of the OSM pbf file you are importing. The size needs to be given in
243 MB. Make sure you leave enough RAM for PostgreSQL and osm2pgsql as mentioned
244 above. If the system starts swapping or you are getting out-of-memory errors,
245 reduce the cache size or even consider using a flatnode file.
246
247
248 ### Testing the installation
249
250 Run this script to verify that all required tables and indices got created
251 successfully.
252
253 ```sh
254 nominatim admin --check-database
255 ```
256
257 Now you can try out your installation by executing a simple query on the
258 command line:
259
260 ``` sh
261 nominatim search --query Berlin
262 ```
263
264 or, when you have a reverse-only installation:
265
266 ``` sh
267 nominatim reverse --lat 51 --lon 45
268 ```
269
270 If you want to run Nominatim as a service, you need to make a choice between
271 running the traditional PHP frontend or the new experimental Python frontend.
272 Make sure you have installed the right packages as per
273 [Installation](Installation.md#software).
274
275 #### Testing the PHP frontend
276
277 You can run a small test server with the PHP frontend like this:
278
279 ```sh
280 nominatim serve
281 ```
282
283 Go to `http://localhost:8088/status.php` and you should see the message `OK`.
284 You can also run a search query, e.g. `http://localhost:8088/search.php?q=Berlin`
285 or, for reverse-only installations a reverse query,
286 e.g. `http://localhost:8088/reverse.php?lat=27.1750090510034&lon=78.04209025`.
287
288 Do not use this test server in production.
289 To run Nominatim via webservers like Apache or nginx, please continue reading
290 [Deploy the PHP frontend](Deployment-PHP.md).
291
292 #### Testing the Python frontend
293
294 To run the test server against the Python frontend, you must choose a
295 web framework to use, either starlette or falcon. Make sure the appropriate
296 packages are installed. Then run
297
298 ``` sh
299 nominatim serve --engine falcon
300 ```
301
302 or
303
304 ``` sh
305 nominatim serve --engine starlette
306 ```
307
308 Go to `http://localhost:8088/status.php` and you should see the message `OK`.
309 You can also run a search query, e.g. `http://localhost:8088/search.php?q=Berlin`
310 or, for reverse-only installations a reverse query,
311 e.g. `http://localhost:8088/reverse.php?lat=27.1750090510034&lon=78.04209025`.
312
313 Do not use this test server in production.
314 To run Nominatim via webservers like Apache or nginx, please continue reading
315 [Deploy the Python frontend](Deployment-Python.md).
316
317
318 ## Enabling search by category phrases
319
320 To be able to search for places by their type using
321 [special phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases)
322 you also need to import these key phrases like this:
323
324 ```sh
325 nominatim special-phrases --import-from-wiki
326 ```
327
328 Note that this command downloads the phrases from the wiki link above. You
329 need internet access for the step.
330
331 You can also import special phrases from a csv file, for more 
332 information please see the [Customization part](../customize/Special-Phrases.md).