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.1.0 -> 3.2.0
  10
  11 ### New reverse algorithm
  12
  13 The reverse algorithm has changed and requires new indexes. Run the following
  14 SQL statements to create the indexes:
  15
  16 ```
  17 CREATE INDEX idx_placex_geometry_reverse_lookupPoint
  18   ON placex USING gist (geometry) {ts:search-index}
  19   WHERE (name is not null or housenumber is not null or rank_address between 26 and 27)
  20     AND class not in ('railway','tunnel','bridge','man_made')
  21     AND rank_address >= 26 AND indexed_status = 0 AND linked_place_id is null;
  22 CREATE INDEX idx_placex_geometry_reverse_lookupPolygon
  23   ON placex USING gist (geometry) {ts:search-index}
  24   WHERE St_GeometryType(geometry) in ('ST_Polygon', 'ST_MultiPolygon')
  25     AND rank_address between 4 and 25 AND type != 'postcode'
  26     AND name is not null AND indexed_status = 0 AND linked_place_id is null;
  27 CREATE INDEX idx_placex_geometry_reverse_placeNode
  28   ON placex USING gist (geometry) {ts:search-index}
  29   WHERE osm_type = 'N' AND rank_search between 5 and 25
  30     AND class = 'place' AND type != 'postcode'
  31     AND name is not null AND indexed_status = 0 AND linked_place_id is null;
  32 ```
  33
  34 You also need to grant the website user access to the `country_osm_grid` table:
  35
  36 ```
  37 GRANT SELECT ON table country_osm_grid to "www-user";
  38 ```
  39
  40 Replace the `www-user` with the user name of your website server if necessary.
  41
  42 Finally, you can drop the now unused indexes:
  43
  44 ```
  45 DROP INDEX idx_placex_reverse_geometry;
  46 ```
  47
  48 ## 3.0.0 -> 3.1.0
  49
  50 ### Postcode Table
  51
  52 A new separate table for artificially computed postcode centroids was introduced.
  53 Migration to the new format is possible but **not recommended**.
  54
  55 Create postcode table and indexes, running the following SQL statements:
  56
  57 ```sql
  58 CREATE TABLE location_postcode
  59   (place_id BIGINT, parent_place_id BIGINT, rank_search SMALLINT,
  60    rank_address SMALLINT, indexed_status SMALLINT, indexed_date TIMESTAMP,
  61    country_code varchar(2), postcode TEXT,
  62    geometry GEOMETRY(Geometry, 4326));
  63 CREATE INDEX idx_postcode_geometry ON location_postcode USING GIST (geometry);
  64 CREATE UNIQUE INDEX idx_postcode_id ON location_postcode USING BTREE (place_id);
  65 CREATE INDEX idx_postcode_postcode ON location_postcode USING BTREE (postcode);
  66 GRANT SELECT ON location_postcode TO "www-data";
  67 drop type if exists nearfeaturecentr cascade;
  68 create type nearfeaturecentr as (
  69   place_id BIGINT,
  70   keywords int[],
  71   rank_address smallint,
  72   rank_search smallint,
  73   distance float,
  74   isguess boolean,
  75   postcode TEXT,
  76   centroid GEOMETRY
  77 );
  78 ```
  79
  80 Add postcode column to `location_area` tables with SQL statement:
  81
  82 ```sql
  83 ALTER TABLE location_area ADD COLUMN postcode TEXT;
  84 ```
  85
  86 Then reimport the functions:
  87
  88 ```sh
  89 ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
  90 ```
  91
  92 Create appropriate triggers with SQL:
  93
  94 ```sql
  95 CREATE TRIGGER location_postcode_before_update BEFORE UPDATE ON location_postcode
  96     FOR EACH ROW EXECUTE PROCEDURE postcode_update();
  97 ```
  98
  99 Finally populate the postcode table (will take a while):
 100
 101 ```sh
 102 ./utils/setup.php --calculate-postcodes --index --index-noanalyse
 103 ```
 104
 105 This will create a working database. You may also delete the old artificial
 106 postcodes now. Note that this may be expensive and is not absolutely necessary.
 107 The following SQL statement will remove them:
 108
 109 ```sql
 110 DELETE FROM place_addressline a USING placex p
 111  WHERE a.address_place_id = p.place_id and p.osm_type = 'P';
 112 ALTER TABLE placex DISABLE TRIGGER USER;
 113 DELETE FROM placex WHERE osm_type = 'P';
 114 ALTER TABLE placex ENABLE TRIGGER USER;
 115 ```