docs/admin/Migration.md

   1 # Database Migrations
   2
   3 Since version 3.7.0 Nominatim offers automatic migrations. Please follow
   4 the following steps:
   5
   6 * stop any updates that are potentially running
   7 * update Nominatim to the newer version
   8 * go to your project directory and run `nominatim admin --migrate`
   9 * (optionally) restart updates
  10
  11 Below you find additional migrations and hints about other structural and
  12 breaking changes. **Please read them before running the migration.**
  13
  14 !!! note
  15     If you are migrating from a version <3.6, then you still have to follow
  16     the manual migration steps up to 3.6.
  17
  18 ## 3.6.0 -> 3.7.0
  19
  20 ### New format and name of configuration file
  21
  22 The configuration for an import is now saved in a `.env` file in the project
  23 directory. This file follows the dotenv format. For more information, see
  24 the [installation chapter](Import.md#configuration-setup-in-env).
  25
  26 To migrate to the new system, create a new project directory, add the `.env`
  27 file and port your custom configuration from `settings/local.php`. Most
  28 settings are named similar and only have received a `NOMINATIM_` prefix.
  29 Use the default settings in `settings/env.defaults` as a reference.
  30
  31 ### New location for data files
  32
  33 External data files for Wikipedia importance, postcodes etc. are no longer
  34 expected to reside in the source tree by default. Instead they will be searched
  35 in the project directory. If you have an automated setup script you must
  36 either adapt the download location or explicitly set the location of the
  37 files to the old place in your `.env`.
  38
  39 ### Introducing `nominatim` command line tool
  40
  41 The various php utilities have been replaced with a single `nominatim`
  42 command line tool. Make sure to adapt any scripts. There is no direct 1:1
  43 matching between the old utilities and the commands of nominatim CLI. The
  44 following list gives you a list of nominatim sub-commands that contain
  45 functionality of each script:
  46
  47 * ./utils/setup.php: `import`, `freeze`, `refresh`
  48 * ./utils/update.php: `replication`, `add-data`, `index`, `refresh`
  49 * ./utils/specialphrases.php: `special-phrases`
  50 * ./utils/check_import_finished.php: `admin`
  51 * ./utils/warm.php: `admin`
  52 * ./utils/export.php: `export`
  53
  54 Try `nominatim <command> --help` for more information about each subcommand.
  55
  56 `./utils/query.php` no longer exists in its old form. `nominatim search`
  57 provides a replacement but returns different output.
  58
  59 ### Switch to normalized house numbers
  60
  61 The housenumber column in the placex table uses now normalized version.
  62 The automatic migration step will convert the column but this may take a
  63 very long time. It is advisable to take the machine offline while doing that.
  64
  65 ## 3.5.0 -> 3.6.0
  66
  67 ### Change of layout of search_name_* tables
  68
  69 The table need a different index for nearest place lookup. Recreate the
  70 indexes using the following shell script:
  71
  72 ```bash
  73 for table in `psql -d nominatim -c "SELECT tablename FROM pg_tables WHERE tablename LIKE 'search_name_%'" -tA | grep -v search_name_blank`;
  74 do
  75     psql -d nominatim -c "DROP INDEX idx_${table}_centroid_place; CREATE INDEX idx_${table}_centroid_place ON ${table} USING gist (centroid) WHERE ((address_rank >= 2) AND (address_rank <= 25)); DROP INDEX idx_${table}_centroid_street; CREATE INDEX idx_${table}_centroid_street ON ${table} USING gist (centroid) WHERE ((address_rank >= 26) AND (address_rank <= 27))";
  76 done
  77 ```
  78
  79 ### Removal of html output
  80
  81 The debugging UI is no longer directly provided with Nominatim. Instead we
  82 now provide a simple Javascript application. Please refer to
  83 [Setting up the Nominatim UI](../Setup-Nominatim-UI) for details on how to
  84 set up the UI.
  85
  86 The icons served together with the API responses have been moved to the
  87 nominatim-ui project as well. If you want to keep the `icon` field in the
  88 response, you need to set `CONST_MapIcon_URL` to the URL of the `/mapicon`
  89 directory of nominatim-ui.
  90
  91 ### Change order during indexing
  92
  93 When reindexing places during updates, there is now a different order used
  94 which needs a different database index. Create it with the following SQL command:
  95
  96 ```sql
  97 CREATE INDEX idx_placex_pendingsector_rank_address
  98   ON placex
  99   USING BTREE (rank_address, geometry_sector)
 100   WHERE indexed_status > 0;
 101 ```
 102
 103 You can then drop the old index with:
 104
 105 ```sql
 106 DROP INDEX idx_placex_pendingsector;
 107 ```
 108
 109 ### Unused index
 110
 111 This index has been unused ever since the query using it was changed two years ago. Saves about 12GB on a planet installation.
 112
 113 ```sql
 114 DROP INDEX idx_placex_geometry_reverse_lookupPoint;
 115 ```
 116
 117 ### Switching to dotenv
 118
 119 As part of the work changing the configuration format, the configuration for
 120 the website is now using a separate configuration file. To create the
 121 configuration file, run the following command after updating:
 122
 123 ```sh
 124 ./utils/setup.php --setup-website
 125 ```
 126
 127 ## 3.4.0 -> 3.5.0
 128
 129 ### New Wikipedia/Wikidata importance tables
 130
 131 The `wikipedia_*` tables have a new format that also includes references to
 132 Wikidata. You need to update the computation functions and the tables as
 133 follows:
 134
 135   * download the new Wikipedia tables as described in the import section
 136   * reimport the tables: `./utils/setup.php --import-wikipedia-articles`
 137   * update the functions: `./utils/setup.php --create-functions --enable-diff-updates`
 138   * create a new lookup index:
 139 ```sql
 140 CREATE INDEX idx_placex_wikidata
 141   ON placex
 142   USING BTREE ((extratags -> 'wikidata'))
 143   WHERE extratags ? 'wikidata'
 144     AND class = 'place'
 145     AND osm_type = 'N'
 146     AND rank_search < 26;
 147 ```
 148   * compute importance: `./utils/update.php --recompute-importance`
 149
 150 The last step takes about 10 hours on the full planet.
 151
 152 Remove one function (it will be recreated in the next step):
 153
 154 ```sql
 155 DROP FUNCTION create_country(hstore,character varying);
 156 ```
 157
 158 Finally, update all SQL functions:
 159
 160 ```sh
 161 ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
 162 ```
 163
 164 ## 3.3.0 -> 3.4.0
 165
 166 ### Reorganisation of location_area_country table
 167
 168 The table `location_area_country` has been optimized. You need to switch to the
 169 new format when you run updates. While updates are disabled, run the following
 170 SQL commands:
 171
 172 ```sql
 173 CREATE TABLE location_area_country_new AS
 174   SELECT place_id, country_code, geometry FROM location_area_country;
 175 DROP TABLE location_area_country;
 176 ALTER TABLE location_area_country_new RENAME TO location_area_country;
 177 CREATE INDEX idx_location_area_country_geometry ON location_area_country USING GIST (geometry);
 178 CREATE INDEX idx_location_area_country_place_id ON location_area_country USING BTREE (place_id);
 179 ```
 180
 181 Finally, update all SQL functions:
 182
 183 ```sh
 184 ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
 185 ```
 186
 187 ## 3.2.0 -> 3.3.0
 188
 189 ### New database connection string (DSN) format
 190
 191 Previously database connection setting (`CONST_Database_DSN` in `settings/*.php`) had the format
 192
 193    * (simple) `pgsql://@/nominatim`
 194    * (complex) `pgsql://johndoe:secret@machine1.domain.com:1234/db1`
 195
 196 The new format is
 197
 198    * (simple) `pgsql:dbname=nominatim`
 199    * (complex) `pgsql:dbname=db1;host=machine1.domain.com;port=1234;user=johndoe;password=secret`
 200
 201 ### Natural Earth country boundaries no longer needed as fallback
 202
 203 ```sql
 204 DROP TABLE country_naturalearthdata;
 205 ```
 206
 207 Finally, update all SQL functions:
 208
 209 ```sh
 210 ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
 211 ```
 212
 213 ### Configurable Address Levels
 214
 215 The new configurable address levels require a new table. Create it with the
 216 following command:
 217
 218 ```sh
 219 ./utils/update.php --update-address-levels
 220 ```
 221
 222 ## 3.1.0 -> 3.2.0
 223
 224 ### New reverse algorithm
 225
 226 The reverse algorithm has changed and requires new indexes. Run the following
 227 SQL statements to create the indexes:
 228
 229 ```sql
 230 CREATE INDEX idx_placex_geometry_reverse_lookupPoint
 231   ON placex
 232   USING gist (geometry)
 233   WHERE (name IS NOT null or housenumber IS NOT null or rank_address BETWEEN 26 AND 27)
 234     AND class NOT IN ('railway','tunnel','bridge','man_made')
 235     AND rank_address >= 26
 236     AND indexed_status = 0
 237     AND linked_place_id IS null;
 238 CREATE INDEX idx_placex_geometry_reverse_lookupPolygon
 239   ON placex USING gist (geometry)
 240   WHERE St_GeometryType(geometry) in ('ST_Polygon', 'ST_MultiPolygon')
 241     AND rank_address between 4 and 25
 242     AND type != 'postcode'
 243     AND name is not null
 244     AND indexed_status = 0
 245     AND linked_place_id is null;
 246 CREATE INDEX idx_placex_geometry_reverse_placeNode
 247   ON placex USING gist (geometry)
 248   WHERE osm_type = 'N'
 249     AND rank_search between 5 and 25
 250     AND class = 'place'
 251     AND type != 'postcode'
 252     AND name is not null
 253     AND indexed_status = 0
 254     AND linked_place_id is null;
 255 ```
 256
 257 You also need to grant the website user access to the `country_osm_grid` table:
 258
 259 ```sql
 260 GRANT SELECT ON table country_osm_grid to "www-user";
 261 ```
 262
 263 Replace the `www-user` with the user name of your website server if necessary.
 264
 265 You can now drop the unused indexes:
 266
 267 ```sql
 268 DROP INDEX idx_placex_reverse_geometry;
 269 ```
 270
 271 Finally, update all SQL functions:
 272
 273 ```sh
 274 ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
 275 ```
 276
 277 ## 3.0.0 -> 3.1.0
 278
 279 ### Postcode Table
 280
 281 A new separate table for artificially computed postcode centroids was introduced.
 282 Migration to the new format is possible but **not recommended**.
 283
 284 Create postcode table and indexes, running the following SQL statements:
 285
 286 ```sql
 287 CREATE TABLE location_postcode
 288   (place_id BIGINT, parent_place_id BIGINT, rank_search SMALLINT,
 289    rank_address SMALLINT, indexed_status SMALLINT, indexed_date TIMESTAMP,
 290    country_code varchar(2), postcode TEXT,
 291    geometry GEOMETRY(Geometry, 4326));
 292 CREATE INDEX idx_postcode_geometry ON location_postcode USING GIST (geometry);
 293 CREATE UNIQUE INDEX idx_postcode_id ON location_postcode USING BTREE (place_id);
 294 CREATE INDEX idx_postcode_postcode ON location_postcode USING BTREE (postcode);
 295 GRANT SELECT ON location_postcode TO "www-data";
 296 DROP TYPE IF EXISTS nearfeaturecentr CASCADE;
 297 CREATE TYPE nearfeaturecentr AS (
 298   place_id BIGINT,
 299   keywords int[],
 300   rank_address smallint,
 301   rank_search smallint,
 302   distance float,
 303   isguess boolean,
 304   postcode TEXT,
 305   centroid GEOMETRY
 306 );
 307 ```
 308
 309 Add postcode column to `location_area` tables with SQL statement:
 310
 311 ```sql
 312 ALTER TABLE location_area ADD COLUMN postcode TEXT;
 313 ```
 314
 315 Then reimport the functions:
 316
 317 ```sh
 318 ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
 319 ```
 320
 321 Create appropriate triggers with SQL:
 322
 323 ```sql
 324 CREATE TRIGGER location_postcode_before_update BEFORE UPDATE ON location_postcode
 325     FOR EACH ROW EXECUTE PROCEDURE postcode_update();
 326 ```
 327
 328 Finally populate the postcode table (will take a while):
 329
 330 ```sh
 331 ./utils/setup.php --calculate-postcodes --index --index-noanalyse
 332 ```
 333
 334 This will create a working database. You may also delete the old artificial
 335 postcodes now. Note that this may be expensive and is not absolutely necessary.
 336 The following SQL statement will remove them:
 337
 338 ```sql
 339 DELETE FROM place_addressline a USING placex p
 340  WHERE a.address_place_id = p.place_id and p.osm_type = 'P';
 341 ALTER TABLE placex DISABLE TRIGGER USER;
 342 DELETE FROM placex WHERE osm_type = 'P';
 343 ALTER TABLE placex ENABLE TRIGGER USER;
 344 ```