X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/09ae312f091331d6d235f13cbbb2746ff831ea46..d22ca186e4d388c228e90e1e701452c041a34687:/docs/admin/Migration.md?ds=inline diff --git a/docs/admin/Migration.md b/docs/admin/Migration.md index dc2e2f37..75f89141 100644 --- a/docs/admin/Migration.md +++ b/docs/admin/Migration.md @@ -1,12 +1,17 @@ # Database Migrations -Since version 3.7.0 Nominatim offers automatic migrations. Please follow +Nominatim offers automatic migrations since version 3.7. Please follow the following steps: -* stop any updates that are potentially running -* update Nominatim to the newer version -* go to your project directory and run `nominatim admin --migrate` -* (optionally) restart updates +* Stop any updates that are potentially running +* Update the backend: `pip install -U nominatim-db` +* Go to your project directory and run `nominatim admin --migrate` +* Update the frontend: `pip install -U nominatim-api` +* (optionally) Restart updates + +If you are still using CMake for the installation of Nominatim, then you +need to update the software in one step before migrating the database. +It is not recommended to do this while the machine is serving requests. Below you find additional migrations and hints about other structural and breaking changes. **Please read them before running the migration.** @@ -15,7 +20,23 @@ 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.1.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