lib-sql/functions/partition-functions.sql

   1 -- SPDX-License-Identifier: GPL-2.0-only
   2 --
   3 -- This file is part of Nominatim. (https://nominatim.org)
   4 --
   5 -- Copyright (C) 2022 by the Nominatim developer community.
   6 -- For a full list of authors see the git log.
   7
   8 DROP TYPE IF EXISTS nearfeaturecentr CASCADE;
   9 CREATE TYPE nearfeaturecentr AS (
  10   place_id BIGINT,
  11   keywords int[],
  12   rank_address smallint,
  13   rank_search smallint,
  14   distance float,
  15   isguess boolean,
  16   postcode TEXT,
  17   centroid GEOMETRY
  18 );
  19
  20 -- feature intersects geoemtry
  21 -- for areas and linestrings they must touch at least along a line
  22 CREATE OR REPLACE FUNCTION is_relevant_geometry(de9im TEXT, geom_type TEXT)
  23 RETURNS BOOLEAN
  24 AS $$
  25 BEGIN
  26   IF substring(de9im from 1 for 2) != 'FF' THEN
  27     RETURN TRUE;
  28   END IF;
  29
  30   IF geom_type = 'ST_Point' THEN
  31     RETURN substring(de9im from 4 for 1) = '0';
  32   END IF;
  33
  34   IF geom_type in ('ST_LineString', 'ST_MultiLineString') THEN
  35     RETURN substring(de9im from 4 for 1) = '1';
  36   END IF;
  37
  38   RETURN substring(de9im from 4 for 1) = '2';
  39 END
  40 $$ LANGUAGE plpgsql IMMUTABLE;
  41
  42 CREATE OR REPLACE function getNearFeatures(in_partition INTEGER, feature GEOMETRY,
  43                                            feature_centroid GEOMETRY,
  44                                            maxrank INTEGER)
  45 RETURNS setof nearfeaturecentr AS $$
  46 DECLARE
  47   r nearfeaturecentr%rowtype;
  48 BEGIN
  49
  50 {% for partition in db.partitions %}
  51   IF in_partition = {{ partition }} THEN
  52     FOR r IN
  53       SELECT place_id, keywords, rank_address, rank_search,
  54              CASE WHEN isguess THEN ST_Distance(feature, centroid)
  55                   ELSE min(ST_Distance(feature_centroid, geometry))
  56                        -- tie breaker when distance is the same (i.e. way is on boundary)
  57                        + 0.00001 * ST_Distance(feature, centroid)
  58              END as distance,
  59              isguess, postcode, centroid
  60       FROM location_area_large_{{ partition }}
  61       WHERE geometry && feature
  62         AND is_relevant_geometry(ST_Relate(geometry, feature), ST_GeometryType(feature))
  63         AND rank_address < maxrank
  64             -- Postcodes currently still use rank_search to define for which
  65             -- features they are relevant.
  66         AND not (rank_address in (5, 11) and rank_search > maxrank)
  67       GROUP BY place_id, keywords, rank_address, rank_search, isguess, postcode, centroid
  68     LOOP
  69       RETURN NEXT r;
  70     END LOOP;
  71     RETURN;
  72   END IF;
  73 {% endfor %}
  74
  75   RAISE EXCEPTION 'Unknown partition %', in_partition;
  76 END
  77 $$
  78 LANGUAGE plpgsql STABLE;
  79
  80
  81 CREATE OR REPLACE FUNCTION get_address_place(in_partition SMALLINT, feature GEOMETRY,
  82                                              from_rank SMALLINT, to_rank SMALLINT,
  83                                              extent FLOAT, token_info JSONB, key TEXT)
  84   RETURNS nearfeaturecentr
  85   AS $$
  86 DECLARE
  87   r nearfeaturecentr%rowtype;
  88 BEGIN
  89 {% for partition in db.partitions %}
  90   IF in_partition = {{ partition }} THEN
  91       SELECT place_id, keywords, rank_address, rank_search,
  92              min(ST_Distance(feature, centroid)) as distance,
  93              isguess, postcode, centroid INTO r
  94         FROM location_area_large_{{ partition }}
  95         WHERE geometry && ST_Expand(feature, extent)
  96               AND rank_address between from_rank and to_rank
  97               AND token_matches_address(token_info, key, keywords)
  98         GROUP BY place_id, keywords, rank_address, rank_search, isguess, postcode, centroid
  99         ORDER BY bool_or(ST_Intersects(geometry, feature)), distance LIMIT 1;
 100       RETURN r;
 101   END IF;
 102 {% endfor %}
 103
 104   RAISE EXCEPTION 'Unknown partition %', in_partition;
 105 END;
 106 $$
 107 LANGUAGE plpgsql STABLE;
 108
 109
 110 create or replace function deleteLocationArea(in_partition INTEGER, in_place_id BIGINT, in_rank_search INTEGER) RETURNS BOOLEAN AS $$
 111 DECLARE
 112 BEGIN
 113
 114   IF in_rank_search <= 4 THEN
 115     DELETE from location_area_country WHERE place_id = in_place_id;
 116     RETURN TRUE;
 117   END IF;
 118
 119 {% for partition in db.partitions %}
 120   IF in_partition = {{ partition }} THEN
 121     DELETE from location_area_large_{{ partition }} WHERE place_id = in_place_id;
 122     RETURN TRUE;
 123   END IF;
 124 {% endfor %}
 125
 126   RAISE EXCEPTION 'Unknown partition %', in_partition;
 127
 128   RETURN FALSE;
 129 END
 130 $$
 131 LANGUAGE plpgsql;
 132
 133 create or replace function insertLocationAreaLarge(
 134   in_partition INTEGER, in_place_id BIGINT, in_country_code VARCHAR(2), in_keywords INTEGER[],
 135   in_rank_search INTEGER, in_rank_address INTEGER, in_estimate BOOLEAN, postcode TEXT,
 136   in_centroid GEOMETRY, in_geometry GEOMETRY) RETURNS BOOLEAN AS $$
 137 DECLARE
 138 BEGIN
 139   IF in_rank_address = 0 THEN
 140     RETURN TRUE;
 141   END IF;
 142
 143   IF in_rank_search <= 4 and not in_estimate THEN
 144     INSERT INTO location_area_country (place_id, country_code, geometry)
 145       values (in_place_id, in_country_code, in_geometry);
 146     RETURN TRUE;
 147   END IF;
 148
 149 {% for partition in db.partitions %}
 150   IF in_partition = {{ partition }} THEN
 151     INSERT INTO location_area_large_{{ partition }} (partition, place_id, country_code, keywords, rank_search, rank_address, isguess, postcode, centroid, geometry)
 152       values (in_partition, in_place_id, in_country_code, in_keywords, in_rank_search, in_rank_address, in_estimate, postcode, in_centroid, in_geometry);
 153     RETURN TRUE;
 154   END IF;
 155 {% endfor %}
 156
 157   RAISE EXCEPTION 'Unknown partition %', in_partition;
 158   RETURN FALSE;
 159 END
 160 $$
 161 LANGUAGE plpgsql;
 162
 163 CREATE OR REPLACE FUNCTION getNearestNamedRoadPlaceId(in_partition INTEGER,
 164                                                       point GEOMETRY,
 165                                                       token_info JSONB)
 166   RETURNS BIGINT
 167   AS $$
 168 DECLARE
 169   parent BIGINT;
 170 BEGIN
 171   IF not token_has_addr_street(token_info) THEN
 172     RETURN NULL;
 173   END IF;
 174
 175 {% for partition in db.partitions %}
 176   IF in_partition = {{ partition }} THEN
 177     SELECT place_id FROM search_name_{{ partition }}
 178       INTO parent
 179       WHERE token_matches_street(token_info, name_vector)
 180             AND centroid && ST_Expand(point, 0.015)
 181             AND address_rank between 26 and 27
 182       ORDER BY ST_Distance(centroid, point) ASC limit 1;
 183     RETURN parent;
 184   END IF;
 185 {% endfor %}
 186
 187   RAISE EXCEPTION 'Unknown partition %', in_partition;
 188 END
 189 $$
 190 LANGUAGE plpgsql STABLE;
 191
 192 CREATE OR REPLACE FUNCTION getNearestNamedPlacePlaceId(in_partition INTEGER,
 193                                                        point GEOMETRY,
 194                                                        token_info JSONB)
 195   RETURNS BIGINT
 196   AS $$
 197 DECLARE
 198   parent BIGINT;
 199 BEGIN
 200   IF not token_has_addr_place(token_info) THEN
 201     RETURN NULL;
 202   END IF;
 203
 204 {% for partition in db.partitions %}
 205   IF in_partition = {{ partition }} THEN
 206     SELECT place_id
 207       INTO parent
 208       FROM search_name_{{ partition }}
 209       WHERE token_matches_place(token_info, name_vector)
 210             AND centroid && ST_Expand(point, 0.04)
 211             AND address_rank between 16 and 25
 212       ORDER BY ST_Distance(centroid, point) ASC limit 1;
 213     RETURN parent;
 214   END IF;
 215 {% endfor %}
 216
 217   RAISE EXCEPTION 'Unknown partition %', in_partition;
 218 END
 219 $$
 220 LANGUAGE plpgsql STABLE;
 221
 222 create or replace function insertSearchName(
 223   in_partition INTEGER, in_place_id BIGINT, in_name_vector INTEGER[],
 224   in_rank_search INTEGER, in_rank_address INTEGER, in_geometry GEOMETRY)
 225 RETURNS BOOLEAN AS $$
 226 DECLARE
 227 BEGIN
 228 {% for partition in db.partitions %}
 229   IF in_partition = {{ partition }} THEN
 230     DELETE FROM search_name_{{ partition }} values WHERE place_id = in_place_id;
 231     IF in_rank_address > 0 THEN
 232       INSERT INTO search_name_{{ partition }} (place_id, address_rank, name_vector, centroid)
 233         values (in_place_id, in_rank_address, in_name_vector, in_geometry);
 234     END IF;
 235     RETURN TRUE;
 236   END IF;
 237 {% endfor %}
 238
 239   RAISE EXCEPTION 'Unknown partition %', in_partition;
 240   RETURN FALSE;
 241 END
 242 $$
 243 LANGUAGE plpgsql;
 244
 245 create or replace function deleteSearchName(in_partition INTEGER, in_place_id BIGINT) RETURNS BOOLEAN AS $$
 246 DECLARE
 247 BEGIN
 248 {% for partition in db.partitions %}
 249   IF in_partition = {{ partition }} THEN
 250     DELETE from search_name_{{ partition }} WHERE place_id = in_place_id;
 251     RETURN TRUE;
 252   END IF;
 253 {% endfor %}
 254
 255   RAISE EXCEPTION 'Unknown partition %', in_partition;
 256
 257   RETURN FALSE;
 258 END
 259 $$
 260 LANGUAGE plpgsql;
 261
 262 create or replace function insertLocationRoad(
 263   in_partition INTEGER, in_place_id BIGINT, in_country_code VARCHAR(2), in_geometry GEOMETRY) RETURNS BOOLEAN AS $$
 264 DECLARE
 265 BEGIN
 266
 267 {% for partition in db.partitions %}
 268   IF in_partition = {{ partition }} THEN
 269     DELETE FROM location_road_{{ partition }} where place_id = in_place_id;
 270     INSERT INTO location_road_{{ partition }} (partition, place_id, country_code, geometry)
 271       values (in_partition, in_place_id, in_country_code, in_geometry);
 272     RETURN TRUE;
 273   END IF;
 274 {% endfor %}
 275
 276   RAISE EXCEPTION 'Unknown partition %', in_partition;
 277   RETURN FALSE;
 278 END
 279 $$
 280 LANGUAGE plpgsql;
 281
 282 create or replace function deleteRoad(in_partition INTEGER, in_place_id BIGINT) RETURNS BOOLEAN AS $$
 283 DECLARE
 284 BEGIN
 285
 286 {% for partition in db.partitions %}
 287   IF in_partition = {{ partition }} THEN
 288     DELETE FROM location_road_{{ partition }} where place_id = in_place_id;
 289     RETURN TRUE;
 290   END IF;
 291 {% endfor %}
 292
 293   RAISE EXCEPTION 'Unknown partition %', in_partition;
 294
 295   RETURN FALSE;
 296 END
 297 $$
 298 LANGUAGE plpgsql;
 299
 300 CREATE OR REPLACE FUNCTION getNearestRoadPlaceId(in_partition INTEGER, point GEOMETRY)
 301   RETURNS BIGINT
 302   AS $$
 303 DECLARE
 304   r RECORD;
 305   search_diameter FLOAT;
 306 BEGIN
 307
 308 {% for partition in db.partitions %}
 309   IF in_partition = {{ partition }} THEN
 310     search_diameter := 0.00005;
 311     WHILE search_diameter < 0.1 LOOP
 312       FOR r IN
 313         SELECT place_id FROM location_road_{{ partition }}
 314           WHERE ST_DWithin(geometry, point, search_diameter)
 315           ORDER BY ST_Distance(geometry, point) ASC limit 1
 316       LOOP
 317         RETURN r.place_id;
 318       END LOOP;
 319       search_diameter := search_diameter * 2;
 320     END LOOP;
 321     RETURN NULL;
 322   END IF;
 323 {% endfor %}
 324
 325   RAISE EXCEPTION 'Unknown partition %', in_partition;
 326 END
 327 $$
 328 LANGUAGE plpgsql STABLE;
 329
 330 CREATE OR REPLACE FUNCTION getNearestParallelRoadFeature(in_partition INTEGER,
 331                                                          line GEOMETRY)
 332   RETURNS BIGINT
 333   AS $$
 334 DECLARE
 335   r RECORD;
 336   search_diameter FLOAT;
 337   p1 GEOMETRY;
 338   p2 GEOMETRY;
 339   p3 GEOMETRY;
 340 BEGIN
 341
 342   IF ST_GeometryType(line) not in ('ST_LineString') THEN
 343     RETURN NULL;
 344   END IF;
 345
 346   p1 := ST_LineInterpolatePoint(line,0);
 347   p2 := ST_LineInterpolatePoint(line,0.5);
 348   p3 := ST_LineInterpolatePoint(line,1);
 349
 350 {% for partition in db.partitions %}
 351   IF in_partition = {{ partition }} THEN
 352     search_diameter := 0.0005;
 353     WHILE search_diameter < 0.01 LOOP
 354       FOR r IN
 355         SELECT place_id FROM location_road_{{ partition }}
 356           WHERE ST_DWithin(line, geometry, search_diameter)
 357           ORDER BY (ST_distance(geometry, p1)+
 358                     ST_distance(geometry, p2)+
 359                     ST_distance(geometry, p3)) ASC limit 1
 360       LOOP
 361         RETURN r.place_id;
 362       END LOOP;
 363       search_diameter := search_diameter * 2;
 364     END LOOP;
 365     RETURN NULL;
 366   END IF;
 367 {% endfor %}
 368
 369   RAISE EXCEPTION 'Unknown partition %', in_partition;
 370 END
 371 $$
 372 LANGUAGE plpgsql STABLE;