Special phrases documentation updated

[nominatim.git] / docs / admin / Import.md

diff --git a/docs/admin/Import.md b/docs/admin/Import.md
index 280231b670dfaab8a948bbb4c14874022b46ecdd..def513aa4b1c8c6b23b2fcc5f2de7bf2d5ede2bc 100644 (file)
--- a/docs/admin/Import.md
+++ b/docs/admin/Import.md
@@ -2,7 +2,8 @@
 
 The following instructions explain how to create a Nominatim database
 from an OSM planet file. It is assumed that you have already successfully
 
 The following instructions explain how to create a Nominatim database
 from an OSM planet file. It is assumed that you have already successfully

-installed the Nominatim software itself. If this is not the case, return to the
+installed the Nominatim software itself and the `nominatim` tool can be found
+in your `PATH`. If this is not the case, return to the

 [installation page](Installation.md).
 
 ## Creating the project directory
 [installation page](Installation.md).
 
 ## Creating the project directory


@@ -10,10 +11,11 @@ installed the Nominatim software itself. If this is not the case, return to the
 Before you start the import, you should create a project directory for your
 new database installation. This directory receives all data that is related
 to a single Nominatim setup: configuration, extra data, etc. Create a project
 Before you start the import, you should create a project directory for your
 new database installation. This directory receives all data that is related
 to a single Nominatim setup: configuration, extra data, etc. Create a project

-directory apart from the Nominatim software:
+directory apart from the Nominatim software and change into the directory:

 
 ```
 mkdir ~/nominatim-planet
 
 ```
 mkdir ~/nominatim-planet

+cd ~/nominatim-planet

 ```
 
 In the following, we refer to the project directory as `$PROJECT_DIR`. To be
 ```
 
 In the following, we refer to the project directory as `$PROJECT_DIR`. To be


@@ -25,18 +27,8 @@ export PROJECT_DIR=~/nominatim-planet
 
 The Nominatim tool assumes per default that the current working directory is
 the project directory but you may explicitly state a different directory using
 
 The Nominatim tool assumes per default that the current working directory is
 the project directory but you may explicitly state a different directory using

-the `--project-dir` parameter. The following instructions assume that you have
-added the Nominatim build directory to your PATH and run all directories from
-the project directory. If you haven't done yet, add the build directory to your
-path and change to the new project directory:
-
-```
-export PATH=~/Nominatim/build:$PATH
-cd $PROJECT_DIR
-```
-
-Of course, you have to replace the path above with the location of your build
-directory.
+the `--project-dir` parameter. The following instructions assume that you run
+all commands from the project directory.

 
 !!! tip "Migration Tip"
 
 
 !!! tip "Migration Tip"
 


@@ -48,9 +40,9 @@ directory.
 
 ### Configuration setup in `.env`
 
 
 ### Configuration setup in `.env`
 

-The Nominatim server can be customized via a `.env` in the project directory.
-This is a file in [dotenv](https://github.com/theskumar/python-dotenv) format
-which looks the same as variable settings in a standard shell environment.
+The Nominatim server can be customized via an `.env` configuration file in the
+project directory. This is a file in [dotenv](https://github.com/theskumar/python-dotenv)
+format which looks the same as variable settings in a standard shell environment.

 You can also set the same configuration via environment variables. All
 settings have a `NOMINATIM_` prefix to avoid conflicts with other environment
 variables.
 You can also set the same configuration via environment variables. All
 settings have a `NOMINATIM_` prefix to avoid conflicts with other environment
 variables.


@@ -242,7 +234,7 @@ reduce the cache size or even consider using a flatnode file.
 Run this script to verify all required tables and indices got created successfully.
 
 ```sh
 Run this script to verify all required tables and indices got created successfully.
 
 ```sh

-nominatim check-database
+nominatim admin --check-database

 ```
 
 Now you can try out your installation by running:
 ```
 
 Now you can try out your installation by running:


@@ -276,14 +268,36 @@ running this function.
 
 If you want to be able to search for places by their type through
 [special key phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases)
 
 If you want to be able to search for places by their type through
 [special key phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases)

-you also need to enable these key phrases like this:
+you also need to import these key phrases like this:

 
 

-    nominatim special-phrases --from-wiki > specialphrases.sql
-    psql -d nominatim -f specialphrases.sql
+```sh
+nominatim special-phrases --import-from-wiki
+```

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

+You can also import some phrases from a csv file. 
+To do so, you have access to the following command:
+
+```sh
+nominatim special-phrases --import-from-csv <csv file>
+```
+
+Note that the 2 previous commands will update the phrases from your database.
+This mean that if you import some phrases from a csv file, only the phrases
+present in the csv file will be kept into the database. All other phrases will
+be removed.
+
+If you want to only add new phrases and not update the other ones you can add
+the argument `--no-replace` to the import command. For example:
+
+```sh
+nominatim special-phrases --import-from-csv <csv file> --no-replace
+```
+
+This will add the phrases present in the csv file into the database without
+removing the other ones.

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


@@ -292,16 +306,14 @@ 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 2019 data and unpack it into your project
-     directory:
+  1. Get preprocessed TIGER 2020 data:

 
         cd $PROJECT_DIR
 
         cd $PROJECT_DIR

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

 
   2. Import the data into your Nominatim database:
 
 
   2. Import the data into your Nominatim database:
 

-        nominatim add-data --tiger-data tiger
+        nominatim add-data --tiger-data tiger2020-nominatim-preprocessed.tar.gz

 
   3. Enable use of the Tiger data in your `.env` by adding:
 
 
   3. Enable use of the Tiger data in your `.env` by adding: