mirror of
https://github.com/osm-search/Nominatim.git
synced 2024-11-22 12:06:27 +03:00
update and extend man page
Provide extended descriptions for most subcommands.
This commit is contained in:
Sarah Hoffmann
parent
381aecb952
commit
47417d1871
@ -8,8 +8,8 @@ ADD_CUSTOM_TARGET(manpage
|
||||
COMMAND ${ARGPARSEMANPAGE} --pyfile ${CMAKE_CURRENT_BINARY_DIR}/create_manpage.py
|
||||
--function get_parser --project-name Nominatim
|
||||
--url https://nominatim.org > ${CMAKE_CURRENT_SOURCE_DIR}/nominatim.1
|
||||
|
||||
COMMAND sed -i '/.SH AUTHORS/I,+2 d' ${CMAKE_CURRENT_SOURCE_DIR}/nominatim.1
|
||||
--author 'the Nominatim developer community'
|
||||
--author-email info@nominatim.org
|
||||
)
|
||||
|
||||
install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/nominatim.1 DESTINATION share/man/man1 )
|
||||
|
||||
294
man/nominatim.1
294
man/nominatim.1
@ -6,7 +6,9 @@ nominatim
|
||||
[-h] {import,freeze,replication,special-phrases,add-data,index,refresh,admin,export,serve,search,reverse,lookup,details,status} ...
|
||||
.SH DESCRIPTION
|
||||
Command\-line tools for importing, updating, administrating and
|
||||
.br
|
||||
querying the Nominatim database.
|
||||
.br
|
||||
|
||||
.SH OPTIONS
|
||||
|
||||
@ -45,7 +47,7 @@ nominatim
|
||||
Start a simple web server for serving the API.
|
||||
.TP
|
||||
\fBnominatim\fR \fI\,search\/\fR
|
||||
Execute API search query.
|
||||
Execute a search query.
|
||||
.TP
|
||||
\fBnominatim\fR \fI\,reverse\/\fR
|
||||
Execute API reverse query.
|
||||
@ -66,6 +68,15 @@ usage: nominatim import [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
[--index-noanalyse]
|
||||
|
||||
Create a new Nominatim database from an OSM file.
|
||||
.br
|
||||
|
||||
.br
|
||||
This sub\-command sets up a new Nominatim database from scratch starting
|
||||
.br
|
||||
with creating a new database in Postgresql. The user running this command
|
||||
.br
|
||||
needs superuser rights on the database.
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -88,7 +99,7 @@ Number of parallel threads to use
|
||||
|
||||
.TP
|
||||
\fB\-\-osm\-file\fR FILE
|
||||
OSM file to be imported.
|
||||
OSM file to be imported (repeat for importing multiple files)
|
||||
|
||||
.TP
|
||||
\fB\-\-continue\fR {load\-data,indexing,db\-postprocess}
|
||||
@ -116,19 +127,27 @@ Continue import even when errors in SQL are present
|
||||
|
||||
.TP
|
||||
\fB\-\-index\-noanalyse\fR
|
||||
Do not perform analyse operations during index
|
||||
Do not perform analyse operations during index (expert only)
|
||||
|
||||
.SH OPTIONS 'nominatim freeze'
|
||||
usage: nominatim freeze [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
|
||||
Make database read\-only.
|
||||
.br
|
||||
|
||||
.br
|
||||
About half of data in the Nominatim database is kept only to be able to
|
||||
.br
|
||||
keep the data up\-to\-date with new changes made in OpenStreetMap. This
|
||||
.br
|
||||
command drops all this data and only keeps the part needed for geocoding
|
||||
.br
|
||||
itself.
|
||||
.br
|
||||
|
||||
.br
|
||||
This command has the same effect as the `\-\-no\-updates` option for imports.
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -157,6 +176,33 @@ usage: nominatim replication [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
[--socket-timeout SOCKET_TIMEOUT]
|
||||
|
||||
Update the database using an online replication service.
|
||||
.br
|
||||
|
||||
.br
|
||||
An OSM replication service is an online service that provides regular
|
||||
.br
|
||||
updates (OSM diff files) for the planet or update they provide. The OSMF
|
||||
.br
|
||||
provides the primary replication service for the full planet at
|
||||
.br
|
||||
https://planet.osm.org/replication/ but there are other providers of
|
||||
.br
|
||||
extracts of OSM data who provide such a service as well.
|
||||
.br
|
||||
|
||||
.br
|
||||
This sub\-command allows to set up such a replication service and download
|
||||
.br
|
||||
and import updates at regular intervals. You need to call '\-\-init' once to
|
||||
.br
|
||||
set up the process or whenever you change the replication configuration
|
||||
.br
|
||||
parameters. Without any arguments, the sub\-command will go into a loop and
|
||||
.br
|
||||
continuously apply updates as they become available. Giving `\-\-once` just
|
||||
.br
|
||||
downloads and imports the next batch of updates.
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -195,7 +241,7 @@ Download and apply updates only once. When not set, updates are continuously app
|
||||
|
||||
.TP
|
||||
\fB\-\-no\-index\fR
|
||||
Do not index the new data. Only applicable together with \-\-once
|
||||
Do not index the new data. Only usable together with \-\-once
|
||||
|
||||
.TP
|
||||
\fB\-\-osm2pgsql\-cache\fR SIZE
|
||||
@ -203,13 +249,47 @@ Size of cache to be used by osm2pgsql (in MB)
|
||||
|
||||
.TP
|
||||
\fB\-\-socket\-timeout\fR \fI\,SOCKET_TIMEOUT\/\fR
|
||||
Set timeout for file downloads.
|
||||
Set timeout for file downloads
|
||||
|
||||
.SH OPTIONS 'nominatim special-phrases'
|
||||
usage: nominatim special-phrases [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
[--import-from-wiki]
|
||||
[--import-from-wiki] [--import-from-csv FILE]
|
||||
[--no-replace]
|
||||
|
||||
Import special phrases.
|
||||
.br
|
||||
|
||||
.br
|
||||
Special phrases are search terms that narrow down the type of object
|
||||
.br
|
||||
that should be searched. For example, you might want to search for
|
||||
.br
|
||||
'Hotels in Barcelona'. The OSM wiki has a selection of special phrases
|
||||
.br
|
||||
in many languages, which can be imported with this command.
|
||||
.br
|
||||
|
||||
.br
|
||||
You can also provide your own phrases in a CSV file. The file needs to have
|
||||
.br
|
||||
the following five columns:
|
||||
.br
|
||||
* phrase \- the term expected for searching
|
||||
.br
|
||||
* class \- the OSM tag key of the object type
|
||||
.br
|
||||
* type \- the OSM tag value of the object type
|
||||
.br
|
||||
* operator \- the kind of search to be done (one of: in, near, name, \-)
|
||||
.br
|
||||
* plural \- whether the term is a plural or not (Y/N)
|
||||
.br
|
||||
|
||||
.br
|
||||
An example file can be found in the Nominatim sources at
|
||||
.br
|
||||
'test/testdb/full_en_phrases_test.csv'.
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -232,17 +312,48 @@ Number of parallel threads to use
|
||||
|
||||
.TP
|
||||
\fB\-\-import\-from\-wiki\fR
|
||||
Import special phrases from the OSM wiki to the database.
|
||||
Import special phrases from the OSM wiki to the database
|
||||
|
||||
.TP
|
||||
\fB\-\-import\-from\-csv\fR FILE
|
||||
Import special phrases from a CSV file
|
||||
|
||||
.TP
|
||||
\fB\-\-no\-replace\fR
|
||||
Keep the old phrases and only add the new ones
|
||||
|
||||
.SH OPTIONS 'nominatim add-data'
|
||||
usage: nominatim add-data [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
(--file FILE | --diff FILE | --node ID | --way ID | --relation ID | --tiger-data DIR)
|
||||
[--use-main-api]
|
||||
[--use-main-api] [--osm2pgsql-cache SIZE]
|
||||
[--socket-timeout SOCKET_TIMEOUT]
|
||||
|
||||
Add additional data from a file or an online source.
|
||||
.br
|
||||
|
||||
Data is only imported, not indexed. You need to call `nominatim index`
|
||||
to complete the process.
|
||||
.br
|
||||
This command allows to add or update the search data in the database.
|
||||
.br
|
||||
The data can come either from an OSM file or single OSM objects can
|
||||
.br
|
||||
directly be downloaded from the OSM API. This function only loads the
|
||||
.br
|
||||
data into the database. Afterwards it still needs to be integrated
|
||||
.br
|
||||
in the search index. Use the `nominatim index` command for that.
|
||||
.br
|
||||
|
||||
.br
|
||||
The command can also be used to add external non\-OSM data to the
|
||||
.br
|
||||
database. At the moment the only supported format is TIGER housenumber
|
||||
.br
|
||||
data. See the online documentation at
|
||||
.br
|
||||
https://nominatim.org/release\-docs/latest/admin/Import/#installing\-tiger\-housenumber\-data\-for\-the\-us
|
||||
.br
|
||||
for more information.
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -265,11 +376,11 @@ Number of parallel threads to use
|
||||
|
||||
.TP
|
||||
\fB\-\-file\fR FILE
|
||||
Import data from an OSM file
|
||||
Import data from an OSM file or diff file
|
||||
|
||||
.TP
|
||||
\fB\-\-diff\fR FILE
|
||||
Import data from an OSM diff file
|
||||
Import data from an OSM diff file (deprecated: use \-\-file)
|
||||
|
||||
.TP
|
||||
\fB\-\-node\fR ID
|
||||
@ -285,18 +396,37 @@ Import a single relation from the API
|
||||
|
||||
.TP
|
||||
\fB\-\-tiger\-data\fR DIR
|
||||
Add housenumbers from the US TIGER census database.
|
||||
Add housenumbers from the US TIGER census database
|
||||
|
||||
.TP
|
||||
\fB\-\-use\-main\-api\fR
|
||||
Use OSM API instead of Overpass to download objects
|
||||
|
||||
.TP
|
||||
\fB\-\-osm2pgsql\-cache\fR SIZE
|
||||
Size of cache to be used by osm2pgsql (in MB)
|
||||
|
||||
.TP
|
||||
\fB\-\-socket\-timeout\fR \fI\,SOCKET_TIMEOUT\/\fR
|
||||
Set timeout for file downloads
|
||||
|
||||
.SH OPTIONS 'nominatim index'
|
||||
usage: nominatim index [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
[--boundaries-only] [--no-boundaries] [--minrank RANK]
|
||||
[--maxrank RANK]
|
||||
|
||||
Reindex all new and modified data.
|
||||
.br
|
||||
|
||||
.br
|
||||
Indexing is the process of computing the address and search terms for
|
||||
.br
|
||||
the places in the database. Every time data is added or changed, indexing
|
||||
.br
|
||||
needs to be run. Imports and replication updates automatically take care
|
||||
.br
|
||||
of indexing. For other cases, this function allows to run indexing manually.
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -341,8 +471,23 @@ usage: nominatim refresh [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
[--enable-debug-statements]
|
||||
|
||||
Recompute auxiliary data used by the indexing process.
|
||||
.br
|
||||
|
||||
These functions must not be run in parallel with other update commands.
|
||||
.br
|
||||
This sub\-commands updates various static data and functions in the database.
|
||||
.br
|
||||
It usually needs to be run after changing various aspects of the
|
||||
.br
|
||||
configuration. The configuration documentation will mention the exact
|
||||
.br
|
||||
command to use in such case.
|
||||
.br
|
||||
|
||||
.br
|
||||
Warning: the 'update' command must not be run in parallel with other update
|
||||
.br
|
||||
commands like 'replication' or 'add\-data'.
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -381,7 +526,7 @@ Update the PL/pgSQL functions in the database
|
||||
|
||||
.TP
|
||||
\fB\-\-wiki\-data\fR
|
||||
Update Wikipedia/data importance numbers.
|
||||
Update Wikipedia/data importance numbers
|
||||
|
||||
.TP
|
||||
\fB\-\-importance\fR
|
||||
@ -406,6 +551,7 @@ usage: nominatim admin [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
[--osm-id OSM_ID | --place-id PLACE_ID]
|
||||
|
||||
Analyse and maintain the database.
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -428,19 +574,19 @@ Number of parallel threads to use
|
||||
|
||||
.TP
|
||||
\fB\-\-warm\fR
|
||||
Warm database caches for search and reverse queries.
|
||||
Warm database caches for search and reverse queries
|
||||
|
||||
.TP
|
||||
\fB\-\-check\-database\fR
|
||||
Check that the database is complete and operational.
|
||||
Check that the database is complete and operational
|
||||
|
||||
.TP
|
||||
\fB\-\-migrate\fR
|
||||
Migrate the database to a new software version.
|
||||
Migrate the database to a new software version
|
||||
|
||||
.TP
|
||||
\fB\-\-analyse\-indexing\fR
|
||||
Print performance analysis of the indexing process.
|
||||
Print performance analysis of the indexing process
|
||||
|
||||
.TP
|
||||
\fB\-\-search\-only\fR
|
||||
@ -468,6 +614,7 @@ usage: nominatim export [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
[--restrict-to-osm-relation ID]
|
||||
|
||||
Export addresses as CSV file from the database.
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -525,12 +672,19 @@ usage: nominatim serve [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
[--server SERVER]
|
||||
|
||||
Start a simple web server for serving the API.
|
||||
.br
|
||||
|
||||
.br
|
||||
This command starts the built\-in PHP webserver to serve the website
|
||||
.br
|
||||
from the current project directory. This webserver is only suitable
|
||||
for testing and develop. Do not use it in production setups!
|
||||
.br
|
||||
for testing and development. Do not use it in production setups!
|
||||
.br
|
||||
|
||||
.br
|
||||
By the default, the webserver can be accessed at: http://127.0.0.1:8088
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -568,7 +722,18 @@ usage: nominatim search [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
[--exclude_place_ids ID,..] [--limit LIMIT]
|
||||
[--viewbox X1,Y1,X2,Y2] [--bounded] [--no-dedupe]
|
||||
|
||||
Execute API search query.
|
||||
Execute a search query.
|
||||
.br
|
||||
|
||||
.br
|
||||
This command works exactly the same as if calling the /search endpoint on
|
||||
.br
|
||||
the web API. See the online documentation for more details on the
|
||||
.br
|
||||
various parameters:
|
||||
.br
|
||||
https://nominatim.org/release\-docs/latest/api/Search/
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -623,15 +788,15 @@ Format of result
|
||||
|
||||
.TP
|
||||
\fB\-\-addressdetails\fR
|
||||
Include a breakdown of the address into elements.
|
||||
Include a breakdown of the address into elements
|
||||
|
||||
.TP
|
||||
\fB\-\-extratags\fR
|
||||
Include additional information if available (e.g. wikipedia link, opening hours).
|
||||
Include additional information if available (e.g. wikipedia link, opening hours)
|
||||
|
||||
.TP
|
||||
\fB\-\-namedetails\fR
|
||||
Include a list of alternative names.
|
||||
Include a list of alternative names
|
||||
|
||||
.TP
|
||||
\fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
|
||||
@ -639,7 +804,7 @@ Preferred language order for presenting search results
|
||||
|
||||
.TP
|
||||
\fB\-\-polygon\-output\fR {geojson,kml,svg,text}
|
||||
Output geometry of results as a GeoJSON, KML, SVG or WKT.
|
||||
Output geometry of results as a GeoJSON, KML, SVG or WKT
|
||||
|
||||
.TP
|
||||
\fB\-\-polygon\-threshold\fR TOLERANCE
|
||||
@ -647,7 +812,7 @@ Simplify output geometry.Parameter is difference tolerance in degrees.
|
||||
|
||||
.TP
|
||||
\fB\-\-countrycodes\fR CC,..
|
||||
Limit search results to one or more countries.
|
||||
Limit search results to one or more countries
|
||||
|
||||
.TP
|
||||
\fB\-\-exclude_place_ids\fR ID,..
|
||||
@ -679,6 +844,17 @@ usage: nominatim reverse [-h] [-q] [-v] [--project-dir DIR] [-j NUM] --lat LAT
|
||||
[--polygon-threshold TOLERANCE]
|
||||
|
||||
Execute API reverse query.
|
||||
.br
|
||||
|
||||
.br
|
||||
This command works exactly the same as if calling the /reverse endpoint on
|
||||
.br
|
||||
the web API. See the online documentation for more details on the
|
||||
.br
|
||||
various parameters:
|
||||
.br
|
||||
https://nominatim.org/release\-docs/latest/api/Reverse/
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -717,15 +893,15 @@ Format of result
|
||||
|
||||
.TP
|
||||
\fB\-\-addressdetails\fR
|
||||
Include a breakdown of the address into elements.
|
||||
Include a breakdown of the address into elements
|
||||
|
||||
.TP
|
||||
\fB\-\-extratags\fR
|
||||
Include additional information if available (e.g. wikipedia link, opening hours).
|
||||
Include additional information if available (e.g. wikipedia link, opening hours)
|
||||
|
||||
.TP
|
||||
\fB\-\-namedetails\fR
|
||||
Include a list of alternative names.
|
||||
Include a list of alternative names
|
||||
|
||||
.TP
|
||||
\fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
|
||||
@ -733,7 +909,7 @@ Preferred language order for presenting search results
|
||||
|
||||
.TP
|
||||
\fB\-\-polygon\-output\fR {geojson,kml,svg,text}
|
||||
Output geometry of results as a GeoJSON, KML, SVG or WKT.
|
||||
Output geometry of results as a GeoJSON, KML, SVG or WKT
|
||||
|
||||
.TP
|
||||
\fB\-\-polygon\-threshold\fR TOLERANCE
|
||||
@ -748,6 +924,17 @@ usage: nominatim lookup [-h] [-q] [-v] [--project-dir DIR] [-j NUM] --id OSMID
|
||||
[--polygon-threshold TOLERANCE]
|
||||
|
||||
Execute API lookup query.
|
||||
.br
|
||||
|
||||
.br
|
||||
This command works exactly the same as if calling the /lookup endpoint on
|
||||
.br
|
||||
the web API. See the online documentation for more details on the
|
||||
.br
|
||||
various parameters:
|
||||
.br
|
||||
https://nominatim.org/release\-docs/latest/api/Lookup/
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -778,15 +965,15 @@ Format of result
|
||||
|
||||
.TP
|
||||
\fB\-\-addressdetails\fR
|
||||
Include a breakdown of the address into elements.
|
||||
Include a breakdown of the address into elements
|
||||
|
||||
.TP
|
||||
\fB\-\-extratags\fR
|
||||
Include additional information if available (e.g. wikipedia link, opening hours).
|
||||
Include additional information if available (e.g. wikipedia link, opening hours)
|
||||
|
||||
.TP
|
||||
\fB\-\-namedetails\fR
|
||||
Include a list of alternative names.
|
||||
Include a list of alternative names
|
||||
|
||||
.TP
|
||||
\fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
|
||||
@ -794,7 +981,7 @@ Preferred language order for presenting search results
|
||||
|
||||
.TP
|
||||
\fB\-\-polygon\-output\fR {geojson,kml,svg,text}
|
||||
Output geometry of results as a GeoJSON, KML, SVG or WKT.
|
||||
Output geometry of results as a GeoJSON, KML, SVG or WKT
|
||||
|
||||
.TP
|
||||
\fB\-\-polygon\-threshold\fR TOLERANCE
|
||||
@ -809,6 +996,17 @@ usage: nominatim details [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
[--lang LANGS]
|
||||
|
||||
Execute API details query.
|
||||
.br
|
||||
|
||||
.br
|
||||
This command works exactly the same as if calling the /details endpoint on
|
||||
.br
|
||||
the web API. See the online documentation for more details on the
|
||||
.br
|
||||
various parameters:
|
||||
.br
|
||||
https://nominatim.org/release\-docs/latest/api/Details/
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -843,7 +1041,7 @@ Look up the OSM relation with the given ID.
|
||||
|
||||
.TP
|
||||
\fB\-\-place_id\fR \fI\,PLACE_ID\/\fR, \fB\-p\fR \fI\,PLACE_ID\/\fR
|
||||
Database internal identifier of the OSM object to look up.
|
||||
Database internal identifier of the OSM object to look up
|
||||
|
||||
.TP
|
||||
\fB\-\-class\fR \fI\,OBJECT_CLASS\/\fR
|
||||
@ -851,27 +1049,27 @@ Class type to disambiguated multiple entries of the same object.
|
||||
|
||||
.TP
|
||||
\fB\-\-addressdetails\fR
|
||||
Include a breakdown of the address into elements.
|
||||
Include a breakdown of the address into elements
|
||||
|
||||
.TP
|
||||
\fB\-\-keywords\fR
|
||||
Include a list of name keywords and address keywords.
|
||||
Include a list of name keywords and address keywords
|
||||
|
||||
.TP
|
||||
\fB\-\-linkedplaces\fR
|
||||
Include a details of places that are linked with this one.
|
||||
Include a details of places that are linked with this one
|
||||
|
||||
.TP
|
||||
\fB\-\-hierarchy\fR
|
||||
Include details of places lower in the address hierarchy.
|
||||
Include details of places lower in the address hierarchy
|
||||
|
||||
.TP
|
||||
\fB\-\-group_hierarchy\fR
|
||||
Group the places by type.
|
||||
Group the places by type
|
||||
|
||||
.TP
|
||||
\fB\-\-polygon_geojson\fR
|
||||
Include geometry of result.
|
||||
Include geometry of result
|
||||
|
||||
.TP
|
||||
\fB\-\-lang\fR LANGS, \fB\-\-accept\-language\fR LANGS
|
||||
@ -882,6 +1080,17 @@ usage: nominatim status [-h] [-q] [-v] [--project-dir DIR] [-j NUM]
|
||||
[--format {text,json}]
|
||||
|
||||
Execute API status query.
|
||||
.br
|
||||
|
||||
.br
|
||||
This command works exactly the same as if calling the /status endpoint on
|
||||
.br
|
||||
the web API. See the online documentation for more details on the
|
||||
.br
|
||||
various parameters:
|
||||
.br
|
||||
https://nominatim.org/release\-docs/latest/api/Status/
|
||||
.br
|
||||
|
||||
|
||||
|
||||
@ -906,6 +1115,9 @@ Number of parallel threads to use
|
||||
\fB\-\-format\fR {text,json}
|
||||
Format of result
|
||||
|
||||
.SH AUTHORS
|
||||
.B Nominatim
|
||||
was written by the Nominatim developer community <info@nominatim.org>.
|
||||
.SH DISTRIBUTION
|
||||
The latest version of Nominatim may be downloaded from
|
||||
.UR https://nominatim.org
|
||||
|
||||
@ -176,7 +176,7 @@ class AdminServe:
|
||||
|
||||
This command starts the built-in PHP webserver to serve the website
|
||||
from the current project directory. This webserver is only suitable
|
||||
for testing and develop. Do not use it in production setups!
|
||||
for testing and development. Do not use it in production setups!
|
||||
|
||||
By the default, the webserver can be accessed at: http://127.0.0.1:8088
|
||||
"""
|
||||
|
||||
@ -14,8 +14,17 @@ class UpdateAddData:
|
||||
"""\
|
||||
Add additional data from a file or an online source.
|
||||
|
||||
Data is only imported, not indexed. You need to call `nominatim index`
|
||||
to complete the process.
|
||||
This command allows to add or update the search data in the database.
|
||||
The data can come either from an OSM file or single OSM objects can
|
||||
directly be downloaded from the OSM API. This function only loads the
|
||||
data into the database. Afterwards it still needs to be integrated
|
||||
in the search index. Use the `nominatim index` command for that.
|
||||
|
||||
The command can also be used to add external non-OSM data to the
|
||||
database. At the moment the only supported format is TIGER housenumber
|
||||
data. See the online documentation at
|
||||
https://nominatim.org/release-docs/latest/admin/Import/#installing-tiger-housenumber-data-for-the-us
|
||||
for more information.
|
||||
"""
|
||||
|
||||
@staticmethod
|
||||
@ -33,14 +42,14 @@ class UpdateAddData:
|
||||
group.add_argument('--relation', metavar='ID', type=int,
|
||||
help='Import a single relation from the API')
|
||||
group.add_argument('--tiger-data', metavar='DIR',
|
||||
help='Add housenumbers from the US TIGER census database.')
|
||||
help='Add housenumbers from the US TIGER census database')
|
||||
group = parser.add_argument_group('Extra arguments')
|
||||
group.add_argument('--use-main-api', action='store_true',
|
||||
help='Use OSM API instead of Overpass to download objects')
|
||||
group.add_argument('--osm2pgsql-cache', metavar='SIZE', type=int,
|
||||
help='Size of cache to be used by osm2pgsql (in MB)')
|
||||
group.add_argument('--socket-timeout', dest='socket_timeout', type=int, default=60,
|
||||
help='Set timeout for file downloads.')
|
||||
help='Set timeout for file downloads')
|
||||
|
||||
@staticmethod
|
||||
def run(args):
|
||||
|
||||
@ -23,13 +23,13 @@ class AdminFuncs:
|
||||
group = parser.add_argument_group('Admin tasks')
|
||||
objs = group.add_mutually_exclusive_group(required=True)
|
||||
objs.add_argument('--warm', action='store_true',
|
||||
help='Warm database caches for search and reverse queries.')
|
||||
help='Warm database caches for search and reverse queries')
|
||||
objs.add_argument('--check-database', action='store_true',
|
||||
help='Check that the database is complete and operational.')
|
||||
help='Check that the database is complete and operational')
|
||||
objs.add_argument('--migrate', action='store_true',
|
||||
help='Migrate the database to a new software version.')
|
||||
help='Migrate the database to a new software version')
|
||||
objs.add_argument('--analyse-indexing', action='store_true',
|
||||
help='Print performance analysis of the indexing process.')
|
||||
help='Print performance analysis of the indexing process')
|
||||
group = parser.add_argument_group('Arguments for cache warming')
|
||||
group.add_argument('--search-only', action='store_const', dest='target',
|
||||
const='search',
|
||||
|
||||
@ -20,19 +20,19 @@ STRUCTURED_QUERY = (
|
||||
)
|
||||
|
||||
EXTRADATA_PARAMS = (
|
||||
('addressdetails', 'Include a breakdown of the address into elements.'),
|
||||
('addressdetails', 'Include a breakdown of the address into elements'),
|
||||
('extratags', ("Include additional information if available "
|
||||
"(e.g. wikipedia link, opening hours).")),
|
||||
('namedetails', 'Include a list of alternative names.')
|
||||
"(e.g. wikipedia link, opening hours)")),
|
||||
('namedetails', 'Include a list of alternative names')
|
||||
)
|
||||
|
||||
DETAILS_SWITCHES = (
|
||||
('addressdetails', 'Include a breakdown of the address into elements.'),
|
||||
('keywords', 'Include a list of name keywords and address keywords.'),
|
||||
('linkedplaces', 'Include a details of places that are linked with this one.'),
|
||||
('hierarchy', 'Include details of places lower in the address hierarchy.'),
|
||||
('group_hierarchy', 'Group the places by type.'),
|
||||
('polygon_geojson', 'Include geometry of result.')
|
||||
('addressdetails', 'Include a breakdown of the address into elements'),
|
||||
('keywords', 'Include a list of name keywords and address keywords'),
|
||||
('linkedplaces', 'Include a details of places that are linked with this one'),
|
||||
('hierarchy', 'Include details of places lower in the address hierarchy'),
|
||||
('group_hierarchy', 'Group the places by type'),
|
||||
('polygon_geojson', 'Include geometry of result')
|
||||
)
|
||||
|
||||
def _add_api_output_arguments(parser):
|
||||
@ -47,7 +47,7 @@ def _add_api_output_arguments(parser):
|
||||
help='Preferred language order for presenting search results')
|
||||
group.add_argument('--polygon-output',
|
||||
choices=['geojson', 'kml', 'svg', 'text'],
|
||||
help='Output geometry of results as a GeoJSON, KML, SVG or WKT.')
|
||||
help='Output geometry of results as a GeoJSON, KML, SVG or WKT')
|
||||
group.add_argument('--polygon-threshold', type=float, metavar='TOLERANCE',
|
||||
help=("Simplify output geometry."
|
||||
"Parameter is difference tolerance in degrees."))
|
||||
@ -55,7 +55,12 @@ def _add_api_output_arguments(parser):
|
||||
|
||||
class APISearch:
|
||||
"""\
|
||||
Execute API search query.
|
||||
Execute a search query.
|
||||
|
||||
This command works exactly the same as if calling the /search endpoint on
|
||||
the web API. See the online documentation for more details on the
|
||||
various parameters:
|
||||
https://nominatim.org/release-docs/latest/api/Search/
|
||||
"""
|
||||
|
||||
@staticmethod
|
||||
@ -70,7 +75,7 @@ class APISearch:
|
||||
|
||||
group = parser.add_argument_group('Result limitation')
|
||||
group.add_argument('--countrycodes', metavar='CC,..',
|
||||
help='Limit search results to one or more countries.')
|
||||
help='Limit search results to one or more countries')
|
||||
group.add_argument('--exclude_place_ids', metavar='ID,..',
|
||||
help='List of search object to be excluded')
|
||||
group.add_argument('--limit', type=int,
|
||||
@ -115,6 +120,11 @@ class APISearch:
|
||||
class APIReverse:
|
||||
"""\
|
||||
Execute API reverse query.
|
||||
|
||||
This command works exactly the same as if calling the /reverse endpoint on
|
||||
the web API. See the online documentation for more details on the
|
||||
various parameters:
|
||||
https://nominatim.org/release-docs/latest/api/Reverse/
|
||||
"""
|
||||
|
||||
@staticmethod
|
||||
@ -155,6 +165,11 @@ class APIReverse:
|
||||
class APILookup:
|
||||
"""\
|
||||
Execute API lookup query.
|
||||
|
||||
This command works exactly the same as if calling the /lookup endpoint on
|
||||
the web API. See the online documentation for more details on the
|
||||
various parameters:
|
||||
https://nominatim.org/release-docs/latest/api/Lookup/
|
||||
"""
|
||||
|
||||
@staticmethod
|
||||
@ -190,6 +205,11 @@ class APILookup:
|
||||
class APIDetails:
|
||||
"""\
|
||||
Execute API details query.
|
||||
|
||||
This command works exactly the same as if calling the /details endpoint on
|
||||
the web API. See the online documentation for more details on the
|
||||
various parameters:
|
||||
https://nominatim.org/release-docs/latest/api/Details/
|
||||
"""
|
||||
|
||||
@staticmethod
|
||||
@ -203,7 +223,7 @@ class APIDetails:
|
||||
objs.add_argument('--relation', '-r', type=int,
|
||||
help="Look up the OSM relation with the given ID.")
|
||||
objs.add_argument('--place_id', '-p', type=int,
|
||||
help='Database internal identifier of the OSM object to look up.')
|
||||
help='Database internal identifier of the OSM object to look up')
|
||||
group.add_argument('--class', dest='object_class',
|
||||
help=("Class type to disambiguated multiple entries "
|
||||
"of the same object."))
|
||||
@ -236,6 +256,11 @@ class APIDetails:
|
||||
class APIStatus:
|
||||
"""\
|
||||
Execute API status query.
|
||||
|
||||
This command works exactly the same as if calling the /status endpoint on
|
||||
the web API. See the online documentation for more details on the
|
||||
various parameters:
|
||||
https://nominatim.org/release-docs/latest/api/Status/
|
||||
"""
|
||||
|
||||
@staticmethod
|
||||
|
||||
@ -15,6 +15,11 @@ from nominatim.db.connection import connect
|
||||
class UpdateIndex:
|
||||
"""\
|
||||
Reindex all new and modified data.
|
||||
|
||||
Indexing is the process of computing the address and search terms for
|
||||
the places in the database. Every time data is added or changed, indexing
|
||||
needs to be run. Imports and replication updates automatically take care
|
||||
of indexing. For other cases, this function allows to run indexing manually.
|
||||
"""
|
||||
|
||||
@staticmethod
|
||||
|
||||
@ -17,7 +17,13 @@ class UpdateRefresh:
|
||||
"""\
|
||||
Recompute auxiliary data used by the indexing process.
|
||||
|
||||
These functions must not be run in parallel with other update commands.
|
||||
This sub-commands updates various static data and functions in the database.
|
||||
It usually needs to be run after changing various aspects of the
|
||||
configuration. The configuration documentation will mention the exact
|
||||
command to use in such case.
|
||||
|
||||
Warning: the 'update' command must not be run in parallel with other update
|
||||
commands like 'replication' or 'add-data'.
|
||||
"""
|
||||
def __init__(self):
|
||||
self.tokenizer = None
|
||||
@ -34,7 +40,7 @@ class UpdateRefresh:
|
||||
group.add_argument('--functions', action='store_true',
|
||||
help='Update the PL/pgSQL functions in the database')
|
||||
group.add_argument('--wiki-data', action='store_true',
|
||||
help='Update Wikipedia/data importance numbers.')
|
||||
help='Update Wikipedia/data importance numbers')
|
||||
group.add_argument('--importance', action='store_true',
|
||||
help='Recompute place importances (expensive!)')
|
||||
group.add_argument('--website', action='store_true',
|
||||
|
||||
@ -20,6 +20,19 @@ LOG = logging.getLogger()
|
||||
class UpdateReplication:
|
||||
"""\
|
||||
Update the database using an online replication service.
|
||||
|
||||
An OSM replication service is an online service that provides regular
|
||||
updates (OSM diff files) for the planet or update they provide. The OSMF
|
||||
provides the primary replication service for the full planet at
|
||||
https://planet.osm.org/replication/ but there are other providers of
|
||||
extracts of OSM data who provide such a service as well.
|
||||
|
||||
This sub-command allows to set up such a replication service and download
|
||||
and import updates at regular intervals. You need to call '--init' once to
|
||||
set up the process or whenever you change the replication configuration
|
||||
parameters. Without any arguments, the sub-command will go into a loop and
|
||||
continuously apply updates as they become available. Giving `--once` just
|
||||
downloads and imports the next batch of updates.
|
||||
"""
|
||||
|
||||
@staticmethod
|
||||
@ -38,13 +51,13 @@ class UpdateReplication:
|
||||
help=("Download and apply updates only once. When "
|
||||
"not set, updates are continuously applied"))
|
||||
group.add_argument('--no-index', action='store_false', dest='do_index',
|
||||
help=("Do not index the new data. Only applicable "
|
||||
help=("Do not index the new data. Only usable "
|
||||
"together with --once"))
|
||||
group.add_argument('--osm2pgsql-cache', metavar='SIZE', type=int,
|
||||
help='Size of cache to be used by osm2pgsql (in MB)')
|
||||
group = parser.add_argument_group('Download parameters')
|
||||
group.add_argument('--socket-timeout', dest='socket_timeout', type=int, default=60,
|
||||
help='Set timeout for file downloads.')
|
||||
help='Set timeout for file downloads')
|
||||
|
||||
@staticmethod
|
||||
def _init_replication(args):
|
||||
|
||||
@ -20,6 +20,10 @@ LOG = logging.getLogger()
|
||||
class SetupAll:
|
||||
"""\
|
||||
Create a new Nominatim database from an OSM file.
|
||||
|
||||
This sub-command sets up a new Nominatim database from scratch starting
|
||||
with creating a new database in Postgresql. The user running this command
|
||||
needs superuser rights on the database.
|
||||
"""
|
||||
|
||||
@staticmethod
|
||||
@ -28,7 +32,7 @@ class SetupAll:
|
||||
group = group_name.add_mutually_exclusive_group(required=True)
|
||||
group.add_argument('--osm-file', metavar='FILE', action='append',
|
||||
help='OSM file to be imported'
|
||||
' (repeat for importing multiple files.')
|
||||
' (repeat for importing multiple files)')
|
||||
group.add_argument('--continue', dest='continue_at',
|
||||
choices=['load-data', 'indexing', 'db-postprocess'],
|
||||
help='Continue an import that was interrupted')
|
||||
@ -47,7 +51,7 @@ class SetupAll:
|
||||
group.add_argument('--ignore-errors', action='store_true',
|
||||
help='Continue import even when errors in SQL are present')
|
||||
group.add_argument('--index-noanalyse', action='store_true',
|
||||
help='Do not perform analyse operations during index')
|
||||
help='Do not perform analyse operations during index (expert only)')
|
||||
|
||||
|
||||
@staticmethod
|
||||
|
||||
@ -19,16 +19,32 @@ LOG = logging.getLogger()
|
||||
class ImportSpecialPhrases:
|
||||
"""\
|
||||
Import special phrases.
|
||||
|
||||
Special phrases are search terms that narrow down the type of object
|
||||
that should be searched. For example, you might want to search for
|
||||
'Hotels in Barcelona'. The OSM wiki has a selection of special phrases
|
||||
in many languages, which can be imported with this command.
|
||||
|
||||
You can also provide your own phrases in a CSV file. The file needs to have
|
||||
the following five columns:
|
||||
* phrase - the term expected for searching
|
||||
* class - the OSM tag key of the object type
|
||||
* type - the OSM tag value of the object type
|
||||
* operator - the kind of search to be done (one of: in, near, name, -)
|
||||
* plural - whether the term is a plural or not (Y/N)
|
||||
|
||||
An example file can be found in the Nominatim sources at
|
||||
'test/testdb/full_en_phrases_test.csv'.
|
||||
"""
|
||||
@staticmethod
|
||||
def add_args(parser):
|
||||
group = parser.add_argument_group('Input arguments')
|
||||
group.add_argument('--import-from-wiki', action='store_true',
|
||||
help='Import special phrases from the OSM wiki to the database.')
|
||||
help='Import special phrases from the OSM wiki to the database')
|
||||
group.add_argument('--import-from-csv', metavar='FILE',
|
||||
help='Import special phrases from a CSV file.')
|
||||
help='Import special phrases from a CSV file')
|
||||
group.add_argument('--no-replace', action='store_true',
|
||||
help='Keep the old phrases and only add the new ones.')
|
||||
help='Keep the old phrases and only add the new ones')
|
||||
|
||||
@staticmethod
|
||||
def run(args):
|
||||
|
||||
Loading…
Reference in New Issue
Block a user