docs/admin/Migration.md

   1 # Database Migrations
   2
   3 This page describes database migrations necessary to update existing databases
   4 to newer versions of Nominatim.
   5
   6 SQL statements should be executed from the postgres commandline. Execute
   7 `psql nominiatim` to enter command line mode.
   8
   9 ## 3.0.0 -> 3.1.0
  10
  11 ### Postcode Table
  12
  13 A new separate table for artificially computed postcode centroids was introduced.
  14 Migration to the new format is possible but **not recommended**.
  15
  16 Create postcode table and indexes, running the following SQL statements:
  17
  18 ```sql
  19 CREATE TABLE location_postcode
  20   (place_id BIGINT, parent_place_id BIGINT, rank_search SMALLINT,
  21    rank_address SMALLINT, indexed_status SMALLINT, indexed_date TIMESTAMP,
  22    country_code varchar(2), postcode TEXT,
  23    geometry GEOMETRY(Geometry, 4326));
  24 CREATE INDEX idx_postcode_geometry ON location_postcode USING GIST (geometry);
  25 CREATE UNIQUE INDEX idx_postcode_id ON location_postcode USING BTREE (place_id);
  26 CREATE INDEX idx_postcode_postcode ON location_postcode USING BTREE (postcode);
  27 GRANT SELECT ON location_postcode TO "www-data";
  28 drop type if exists nearfeaturecentr cascade;
  29 create type nearfeaturecentr as (
  30   place_id BIGINT,
  31   keywords int[],
  32   rank_address smallint,
  33   rank_search smallint,
  34   distance float,
  35   isguess boolean,
  36   postcode TEXT,
  37   centroid GEOMETRY
  38 );
  39 ```
  40
  41 Add postcode column to `location_area` tables with SQL statement:
  42
  43 ```sql
  44 ALTER TABLE location_area ADD COLUMN postcode TEXT;
  45 ```
  46
  47 Then reimport the functions:
  48
  49 ```sh
  50 ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
  51 ```
  52
  53 Create appropriate triggers with SQL:
  54
  55 ```sql
  56 CREATE TRIGGER location_postcode_before_update BEFORE UPDATE ON location_postcode
  57     FOR EACH ROW EXECUTE PROCEDURE postcode_update();
  58 ```
  59
  60 Finally populate the postcode table (will take a while):
  61
  62 ```sh
  63 ./utils/setup.php --calculate-postcodes --index --index-noanalyse
  64 ```
  65
  66 This will create a working database. You may also delete the old artificial
  67 postcodes now. Note that this may be expensive and is not absolutely necessary.
  68 The following SQL statement will remove them:
  69
  70 ```sql
  71 DELETE FROM place_addressline a USING placex p
  72  WHERE a.address_place_id = p.place_id and p.osm_type = 'P';
  73 ALTER TABLE placex DISABLE TRIGGER USER;
  74 DELETE FROM placex WHERE osm_type = 'P';
  75 ALTER TABLE placex ENABLE TRIGGER USER;
  76 ```