X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/0ea099bfd5bbc4bdb3f770dbc94841f1e818151a..9659afbade47d1ec6d5359b2b21e1e874516ed80:/docs/admin/Migration.md diff --git a/docs/admin/Migration.md b/docs/admin/Migration.md index 11ee7f05..e4db38d1 100644 --- a/docs/admin/Migration.md +++ b/docs/admin/Migration.md @@ -15,7 +15,50 @@ breaking changes. **Please read them before running the migration.** If you are migrating from a version <3.6, then you still have to follow the manual migration steps up to 3.6. -## 4.0.0 -> master +## 4.4.0 -> master + +### New structure for Python packages + +The nominatim Python package has been split into `nominatim-db` and `nominatim-api`. +Any imports need to be adapted accordingly. + +If you are running the Python frontend, change the server module from +`nominatim.server.falcon.server` to `nominatim_api.server.falcon.server`. + +If you are using the Nominatim library, all imports need to be changed +from `nominatim.api.` to `nominatim_api.`. + +If you have written custom tokenizers or sanitizers, the appropriate modules +are now found in `nominatim_db`. + +## 4.2.0 -> 4.3.0 + +### New indexes for reverse lookup + +The reverse lookup algorithm has changed slightly to improve performance. +This change needs a different index in the database. The required index +will be automatically build during migration. Until the new index is available +performance of the /reverse endpoint is significantly reduced. You should +therefore either remove traffic from the machine before attempting a +version update or create the index manually **before** starting the update +using the following SQL: + +```sql +CREATE INDEX IF NOT EXISTS idx_placex_geometry_reverse_lookupPlaceNode + ON placex USING gist (ST_Buffer(geometry, reverse_place_diameter(rank_search))) + WHERE rank_address between 4 and 25 AND type != 'postcode' + AND name is not null AND linked_place_id is null AND osm_type = 'N'; +``` + +## 4.0.0 -> 4.1.0 + +### ICU tokenizer is the new default + +Nominatim now installs the [ICU tokenizer](../customize/Tokenizers.md#icu-tokenizer) +by default. This only has an effect on newly installed databases. When +updating older databases, it keeps its installed tokenizer. If you still +run with the legacy tokenizer, make sure to compile Nominatim with the +PostgreSQL module, see [Installation](Installation.md#building-nominatim). ### geocodejson output changed