Use check_import_finished in test suite, document

[nominatim.git] / docs / admin / Import-and-Update.md

diff --git a/docs/admin/Import-and-Update.md b/docs/admin/Import-and-Update.md
index 257e5ebcc5e591245a773554e59fcb4f859c1db3..3c6f11d0f2cd8488ab2977eba19f08bd0c8bc97d 100644 (file)
--- a/docs/admin/Import-and-Update.md
+++ b/docs/admin/Import-and-Update.md
@@ -29,11 +29,11 @@ Add to your `settings/local.php`:
     @define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file');
 
 Replace the second part with a suitable path on your system and make sure
     @define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file');
 
 Replace the second part with a suitable path on your system and make sure

-the directory exists. There should be at least 40GB of free space.
+the directory exists. There should be at least 64GB of free space.

 
 ## Downloading additional data
 
 
 ## Downloading additional data
 

-### Wikipedia rankings
+### Wikipedia/Wikidata rankings

 
 Wikipedia can be used as an optional auxiliary data source to help indicate
 the importance of OSM features. Nominatim will work without this information
 
 Wikipedia can be used as an optional auxiliary data source to help indicate
 the importance of OSM features. Nominatim will work without this information


@@ -41,15 +41,13 @@ but it will improve the quality of the results if this is installed.
 This data is available as a binary download:
 
     cd $NOMINATIM_SOURCE_DIR/data
 This data is available as a binary download:
 
     cd $NOMINATIM_SOURCE_DIR/data

-    wget https://www.nominatim.org/data/wikipedia_article.sql.bin
-    wget https://www.nominatim.org/data/wikipedia_redirect.sql.bin
+    wget https://www.nominatim.org/data/wikimedia-importance.sql.gz

 
 

-Combined the 2 files are around 1.5GB and add around 30GB to the install
-size of Nominatim. They also increase the install time by an hour or so.
+The file is about 400MB and adds around 4GB to Nominatim database.

 
 

-*NOTE:* you'll need to download the Wikipedia rankings before performing
-the initial import of the data if you want the rankings applied to the
-loaded data.
+*NOTE:* if you forgot to download the wikipedia rankings, you can also add
+them after the import by running `./utils/setup.php --import-wikipedia-articles`
+and then `./utils/update.php --recompute-importance`.

 
 ### Great Britain, USA postcodes
 
 
 ### Great Britain, USA postcodes
 


@@ -64,7 +62,7 @@ involve a GB or US postcode. This data can be optionally downloaded:
 
 In its default setup Nominatim is configured to import the full OSM data
 set for the entire planet. Such a setup requires a powerful machine with
 
 In its default setup Nominatim is configured to import the full OSM data
 set for the entire planet. Such a setup requires a powerful machine with

-at least 32GB of RAM and around 800GB of SSD hard disks. Depending on your
+at least 64GB of RAM and around 800GB of SSD hard disks. Depending on your

 use case there are various ways to reduce the amount of data imported. This
 section discusses these methods. They can also be combined.
 
 use case there are various ways to reduce the amount of data imported. This
 section discusses these methods. They can also be combined.
 


@@ -126,7 +124,7 @@ The style can be changed with the configuration `CONST_Import_Style`.
 To give you an idea of the impact of using the different styles, the table
 below gives rough estimates of the final database size after import of a
 2018 planet and after using the `--drop` option. It also shows the time
 To give you an idea of the impact of using the different styles, the table
 below gives rough estimates of the final database size after import of a
 2018 planet and after using the `--drop` option. It also shows the time

-needed for the import on a machine with 32GB RAM, 4 CPUS and SSDs. Note that
+needed for the import on a machine with 64GB RAM, 4 CPUS and SSDs. Note that

 the given sizes are just an estimate meant for comparison of style requirements.
 Your planet import is likely to be larger as the OSM data grows with time.
 
 the given sizes are just an estimate meant for comparison of style requirements.
 Your planet import is likely to be larger as the OSM data grows with time.
 


@@ -137,7 +135,7 @@ street    |   42h        |  400 GB    |  180 GB
 address   |   59h        |  500 GB    |  260 GB
 full      |   80h        |  575 GB    |  300 GB
 
 address   |   59h        |  500 GB    |  260 GB
 full      |   80h        |  575 GB    |  300 GB
 

-You can also customize the styles further. For an description of the
+You can also customize the styles further. For a description of the

 style format see [the development section](../develop/Import.md).
 
 ## Initial import of the data
 style format see [the development section](../develop/Import.md).
 
 ## Initial import of the data


@@ -149,18 +147,53 @@ Download the data to import and load the data with the following command
 from the build directory:
 
 ```sh
 from the build directory:
 
 ```sh

-./utils/setup.php --osm-file <data file> --all [--osm2pgsql-cache 28000] 2>&1 | tee setup.log
+./utils/setup.php --osm-file <data file> --all 2>&1 | tee setup.log

 ```
 
 ```
 

-The `--osm2pgsql-cache` parameter is optional but strongly recommended for
-planet imports. It sets the node cache size for the osm2pgsql import part
-(see `-C` parameter in osm2pgsql help). As a rule of thumb, this should be
-about the same size as the file you are importing but never more than
-2/3 of RAM available. If your machine starts swapping reduce the size.
+***Note for full planet imports:*** Even on a perfectly configured machine
+the import of a full planet takes at least 2 days. Once you see messages
+with `Rank .. ETA` appear, the indexing process has started. This part takes
+the most time. There are 30 ranks to process. Rank 26 and 30 are the most complex.
+They take each about a third of the total import time. If you have not reached
+rank 26 after two days of import, it is worth revisiting your system
+configuration as it may not be optimal for the import.

 
 

-Computing word frequency for search terms can improve the performance of
-forward geocoding in particular under high load as it helps PostgreSQL's query
-planner to make the right decisions. To recompute word counts run:
+### Notes on memory usage
+
+In the first step of the import Nominatim uses osm2pgsql to load the OSM data
+into the PostgreSQL database. This step is very demanding in terms of RAM usage.
+osm2pgsql and PostgreSQL are running in parallel at this point. PostgreSQL
+blocks at least the part of RAM that has been configured with the
+`shared_buffers` parameter during [PostgreSQL tuning](Installation#PostgreSQL_tuning)
+and needs some memory on top of that. osm2pgsql needs at least 2GB of RAM for
+its internal data structures, potentially more when it has to process very large
+relations. In addition it needs to maintain a cache for node locations. The size
+of this cache can be configured with the parameter `--osm2pgsql-cache`.
+
+When importing with a flatnode file, it is best to disable the node cache
+completely and leave the memory for the flatnode file. Nominatim will do this
+by default, so you do not need to configure anything in this case.
+
+For imports without a flatnode file, set `--osm2pgsql-cache` approximately to
+the size of the OSM pbf file (in MB) you are importing. Make sure you leave
+enough RAM for PostgreSQL and osm2pgsql as mentioned above. If the system starts
+swapping or you are getting out-of-memory errors, reduce the cache size or
+even consider using a flatnode file.
+
+### Verify import finished
+
+Run this script to verify all required tables and indices got created successfully.
+
+```sh
+./utils/check_import_finished.php
+```
+
+
+## Tuning the database
+
+Accurate word frequency information for search terms helps PostgreSQL's query
+planner to make the right decisions. Recomputing them can improve the performance
+of forward geocoding in particular under high load. To recompute word counts run:

 
 ```sh
 ./utils/update.php --recompute-word-counts
 
 ```sh
 ./utils/update.php --recompute-word-counts


@@ -178,7 +211,8 @@ you also need to enable these key phrases like this:
     ./utils/specialphrases.php --wiki-import > specialphrases.sql
     psql -d nominatim -f specialphrases.sql
 
     ./utils/specialphrases.php --wiki-import > specialphrases.sql
     psql -d nominatim -f specialphrases.sql
 

-Note that this command downloads the phrases from the wiki link above.
+Note that this command downloads the phrases from the wiki link above. You
+need internet access for the step.

 
 
 ## Installing Tiger housenumber data for the US
 
 
 ## Installing Tiger housenumber data for the US


@@ -188,12 +222,12 @@ address set to complement the OSM house number data in the US. You can add
 TIGER data to your own Nominatim instance by following these steps. The
 entire US adds about 10GB to your database.
 
 TIGER data to your own Nominatim instance by following these steps. The
 entire US adds about 10GB to your database.
 

-  1. Get preprocessed TIGER 2018 data and unpack it into the
+  1. Get preprocessed TIGER 2019 data and unpack it into the

      data directory in your Nominatim sources:
 
         cd Nominatim/data
      data directory in your Nominatim sources:
 
         cd Nominatim/data

-        wget https://nominatim.org/data/tiger2018-nominatim-preprocessed.tar.gz
-        tar xf tiger2018-nominatim-preprocessed.tar.gz
+        wget https://nominatim.org/data/tiger2019-nominatim-preprocessed.tar.gz
+        tar xf tiger2019-nominatim-preprocessed.tar.gz

 
     `data-source/us-tiger/README.md` explains how the data got preprocessed.
 
 
     `data-source/us-tiger/README.md` explains how the data got preprocessed.
 


@@ -220,14 +254,14 @@ For a list of other methods see the output of `./utils/update.php --help`.
 
 #### Installing the newest version of Pyosmium
 
 
 #### Installing the newest version of Pyosmium
 

-It is recommended to install Pyosmium via pip. Run (as the same user who
-will later run the updates):
+It is recommended to install Pyosmium via pip. Make sure to use python3.
+Run (as the same user who will later run the updates):

 
 ```sh
 
 ```sh

-pip install --user osmium
+pip3 install --user osmium

 ```
 
 ```
 

-Nominatim needs a tool called `pyosmium-get-updates`, which comes with
+Nominatim needs a tool called `pyosmium-get-updates` which comes with

 Pyosmium. You need to tell Nominatim where to find it. Add the
 following line to your `settings/local.php`:
 
 Pyosmium. You need to tell Nominatim where to find it. Add the
 following line to your `settings/local.php`:
 


@@ -268,7 +302,9 @@ The following command will keep your database constantly up to date:
 
     ./utils/update.php --import-osmosis-all
 
 
     ./utils/update.php --import-osmosis-all
 

-(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.)
+(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.)

 
 If you have imported multiple country extracts and want to keep them
 up-to-date, have a look at the script in
 
 If you have imported multiple country extracts and want to keep them
 up-to-date, have a look at the script in