X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/139cea5720e3b1030ec9a10c678d723752d707f4..f52212abbd21d5139e893b53d75fff5a17893010:/docs/admin/Migration.md diff --git a/docs/admin/Migration.md b/docs/admin/Migration.md index 59702e7b..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.** @@ -19,7 +24,7 @@ breaking changes. **Please read them before running the migration.** ### New structure for Python packages -The nominatim Python package has been split into nominatim-db and nominatim-api. +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