X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/8c7140d92b7a679ae5ef5bb3655c69bd39b7dfeb..HEAD:/docs/admin/Migration.md?ds=sidebyside diff --git a/docs/admin/Migration.md b/docs/admin/Migration.md index 3e62d219..becf2f7b 100644 --- a/docs/admin/Migration.md +++ b/docs/admin/Migration.md @@ -1,19 +1,85 @@ # Database Migrations -Since version 3.7.0 Nominatim offers automatic migrations. Please follow +Nominatim offers automatic migrations for versions 4.3+. 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 Below you find additional migrations and hints about other structural and breaking changes. **Please read them before running the migration.** !!! note - If you are migrating from a version <3.6, then you still have to follow - the manual migration steps up to 3.6. + If you are migrating from a version <4.3, you need to install 4.3 + and migrate to 4.3 first. Then you can migrate to the current + version. It is strongly recommended to do a reimport instead. + +## 4.5.0 -> 5.0.0 + +### PHP frontend removed + +The PHP frontend has been completely removed. Please switch to the Python +frontend. + +Without the PHP code, the `nominatim refresh --website` command is no longer +needed. It currently omits a warning and does otherwise nothing. It will be +removed in later versions of Nominatim. So make sure you remove it from your +scripts. + +### CMake building removed + +Nominatim can now only be installed via pip. Please follow the installation +instructions for the current version to change to pip. + +### osm2pgsql no longer vendored in + +Nominatim no longer ships its own version of osm2pgsql. Please install a +stock version of osm2pgsql from your distribution. See the +[installation instruction for osm2pgsql](https://osm2pgsql.org/doc/install.html) +for details. A minimum version of 1.8 is required. The current stable versions +of Ubuntu and Debian already ship with an appropriate versions. For older +installation, you may have to compile a newer osm2pgsql yourself. + +### Legacy tokenizer removed + +The `legacy` tokenizer is no longer enabled. This tokenizer has been superseded +by the `ICU` tokenizer a long time ago. In the unlikely case that your database +still uses the `legacy` tokenizer, you must reimport your database. + +### osm2pgsql style overhauled + +There are some fundamental changes to how customized osm2pgsql styles should +be written. The changes are mostly backwards compatible, i.e. custom styles +should still work with the new implementation. The only exception is a +customization of the `process_tags()` function. This function is no longer +considered public and neither are the helper functions used in it. +They currently still work but will be removed at some point. If you have +been making changes to `process_tags`, please review your style and try +to switch to the new convenience functions. + +For more information on the changes, see the +[pull request](https://github.com/osm-search/Nominatim/pull/3615) +and read the new +[customization documentation](https://nominatim.org/release-docs/latest/customize/Import-Styles/). + +## 4.4.0 -> 4.5.0 + +### 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