]> git.openstreetmap.org Git - nominatim.git/blob - lib-sql/functions/address_lookup.sql
Merge remote-tracking branch 'upstream/master'
[nominatim.git] / lib-sql / functions / address_lookup.sql
1 -- Functions for returning address information for a place.
2
3 DROP TYPE IF EXISTS addressline CASCADE;
4 CREATE TYPE addressline as (
5   place_id BIGINT,
6   osm_type CHAR(1),
7   osm_id BIGINT,
8   name HSTORE,
9   class TEXT,
10   type TEXT,
11   place_type TEXT,
12   admin_level INTEGER,
13   fromarea BOOLEAN,
14   isaddress BOOLEAN,
15   rank_address INTEGER,
16   distance FLOAT
17 );
18
19
20 CREATE OR REPLACE FUNCTION get_name_by_language(name hstore, languagepref TEXT[])
21   RETURNS TEXT
22   AS $$
23 DECLARE
24   result TEXT;
25 BEGIN
26   IF name is null THEN
27     RETURN null;
28   END IF;
29
30   FOR j IN 1..array_upper(languagepref,1) LOOP
31     IF name ? languagepref[j] THEN
32       result := trim(name->languagepref[j]);
33       IF result != '' THEN
34         return result;
35       END IF;
36     END IF;
37   END LOOP;
38
39   -- anything will do as a fallback - just take the first name type thing there is
40   RETURN trim((avals(name))[1]);
41 END;
42 $$
43 LANGUAGE plpgsql IMMUTABLE;
44
45
46 --housenumber only needed for tiger data
47 CREATE OR REPLACE FUNCTION get_address_by_language(for_place_id BIGINT,
48                                                    housenumber INTEGER,
49                                                    languagepref TEXT[])
50   RETURNS TEXT
51   AS $$
52 DECLARE
53   result TEXT[];
54   currresult TEXT;
55   prevresult TEXT;
56   location RECORD;
57 BEGIN
58
59   result := '{}';
60   prevresult := '';
61
62   FOR location IN
63     SELECT name,
64        CASE WHEN place_id = for_place_id THEN 99 ELSE rank_address END as rank_address
65     FROM get_addressdata(for_place_id, housenumber)
66     WHERE isaddress order by rank_address desc
67   LOOP
68     currresult := trim(get_name_by_language(location.name, languagepref));
69     IF currresult != prevresult AND currresult IS NOT NULL
70        AND result[(100 - location.rank_address)] IS NULL
71     THEN
72       result[(100 - location.rank_address)] := currresult;
73       prevresult := currresult;
74     END IF;
75   END LOOP;
76
77   RETURN array_to_string(result,', ');
78 END;
79 $$
80 LANGUAGE plpgsql STABLE;
81
82 DROP TYPE IF EXISTS addressdata_place;
83 CREATE TYPE addressdata_place AS (
84   place_id BIGINT,
85   country_code VARCHAR(2),
86   housenumber TEXT,
87   postcode TEXT,
88   class TEXT,
89   type TEXT,
90   name HSTORE,
91   address HSTORE,
92   centroid GEOMETRY
93 );
94
95 -- Compute the list of address parts for the given place.
96 --
97 -- If in_housenumber is greator or equal 0, look for an interpolation.
98 CREATE OR REPLACE FUNCTION get_addressdata(in_place_id BIGINT, in_housenumber INTEGER)
99   RETURNS setof addressline
100   AS $$
101 DECLARE
102   place addressdata_place;
103   location RECORD;
104   current_rank_address INTEGER;
105   location_isaddress BOOLEAN;
106 BEGIN
107   -- The place in question might not have a direct entry in place_addressline.
108   -- Look for the parent of such places then and save it in place.
109
110   -- first query osmline (interpolation lines)
111   IF in_housenumber >= 0 THEN
112     SELECT parent_place_id as place_id, country_code,
113            in_housenumber as housenumber, postcode,
114            'place' as class, 'house' as type,
115            null as name, null as address,
116            ST_Centroid(linegeo) as centroid
117       INTO place
118       FROM location_property_osmline
119       WHERE place_id = in_place_id
120             AND in_housenumber between startnumber and endnumber;
121   END IF;
122
123   --then query tiger data
124   {% if config.get_bool('USE_US_TIGER_DATA') %}
125   IF place IS NULL AND in_housenumber >= 0 THEN
126     SELECT parent_place_id as place_id, 'us' as country_code,
127            in_housenumber as housenumber, postcode,
128            'place' as class, 'house' as type,
129            null as name, null as address,
130            ST_Centroid(linegeo) as centroid
131       INTO place
132       FROM location_property_tiger
133       WHERE place_id = in_place_id
134             AND in_housenumber between startnumber and endnumber;
135   END IF;
136   {% endif %}
137
138   -- postcode table
139   IF place IS NULL THEN
140     SELECT parent_place_id as place_id, country_code,
141            null::text as housenumber, postcode,
142            'place' as class, 'postcode' as type,
143            null as name, null as address,
144            null as centroid
145       INTO place
146       FROM location_postcode
147       WHERE place_id = in_place_id;
148   END IF;
149
150   -- POI objects in the placex table
151   IF place IS NULL THEN
152     SELECT parent_place_id as place_id, country_code,
153            coalesce(address->'housenumber',
154                     address->'streetnumber',
155                     address->'conscriptionnumber')::text as housenumber,
156            postcode,
157            class, type,
158            name, address,
159            centroid
160       INTO place
161       FROM placex
162       WHERE place_id = in_place_id and rank_search > 27;
163   END IF;
164
165   -- If place is still NULL at this point then the object has its own
166   -- entry in place_address line. However, still check if there is not linked
167   -- place we should be using instead.
168   IF place IS NULL THEN
169     select coalesce(linked_place_id, place_id) as place_id,  country_code,
170            null::text as housenumber, postcode,
171            class, type,
172            null as name, address,
173            null as centroid
174       INTO place
175       FROM placex where place_id = in_place_id;
176   END IF;
177
178 --RAISE WARNING '% % % %',searchcountrycode, searchhousenumber, searchpostcode;
179
180   -- --- Return the record for the base entry.
181
182   FOR location IN
183     SELECT placex.place_id, osm_type, osm_id, name,
184            coalesce(extratags->'linked_place', extratags->'place') as place_type,
185            class, type, admin_level,
186            CASE WHEN rank_address = 0 THEN 100
187                 WHEN rank_address = 11 THEN 5
188                 ELSE rank_address END as rank_address,
189            country_code
190       FROM placex
191       WHERE place_id = place.place_id
192   LOOP
193 --RAISE WARNING '%',location;
194     IF location.rank_address < 4 THEN
195       -- no country locations for ranks higher than country
196       place.country_code := NULL::varchar(2);
197     ELSEIF place.country_code IS NULL AND location.country_code IS NOT NULL THEN
198       place.country_code := location.country_code;
199     END IF;
200
201     RETURN NEXT ROW(location.place_id, location.osm_type, location.osm_id,
202                     location.name, location.class, location.type,
203                     location.place_type,
204                     location.admin_level, true,
205                     location.type not in ('postcode', 'postal_code'),
206                     location.rank_address, 0)::addressline;
207
208     current_rank_address := location.rank_address;
209   END LOOP;
210
211   -- --- Return records for address parts.
212
213   FOR location IN
214     SELECT placex.place_id, osm_type, osm_id, name, class, type,
215            coalesce(extratags->'linked_place', extratags->'place') as place_type,
216            admin_level, fromarea, isaddress and linked_place_id is NULL as isaddress,
217            CASE WHEN rank_address = 11 THEN 5 ELSE rank_address END as rank_address,
218            distance, country_code, postcode
219       FROM place_addressline join placex on (address_place_id = placex.place_id)
220       WHERE place_addressline.place_id IN (place.place_id, in_place_id)
221             AND linked_place_id is null
222             AND (placex.country_code IS NULL OR place.country_code IS NULL
223                  OR placex.country_code = place.country_code)
224       ORDER BY rank_address desc,
225                (place_addressline.place_id = in_place_id) desc,
226                (CASE WHEN coalesce((avals(name) && avals(place.address)), False) THEN 2
227                      WHEN isaddress THEN 0
228                      WHEN fromarea
229                           and place.centroid is not null
230                           and ST_Contains(geometry, place.centroid) THEN 1
231                      ELSE -1 END) desc,
232                fromarea desc, distance asc, rank_search desc
233   LOOP
234     -- RAISE WARNING '%',location;
235     location_isaddress := location.rank_address != current_rank_address;
236
237     IF place.country_code IS NULL AND location.country_code IS NOT NULL THEN
238       place.country_code := location.country_code;
239     END IF;
240     IF location.type in ('postcode', 'postal_code')
241        AND place.postcode is not null
242     THEN
243       -- If the place had a postcode assigned, take this one only
244       -- into consideration when it is an area and the place does not have
245       -- a postcode itself.
246       IF location.fromarea AND location.isaddress
247          AND (place.address is null or not place.address ? 'postcode')
248       THEN
249         place.postcode := null; -- remove the less exact postcode
250       ELSE
251         location_isaddress := false;
252       END IF;
253     END IF;
254     RETURN NEXT ROW(location.place_id, location.osm_type, location.osm_id,
255                     location.name, location.class, location.type,
256                     location.place_type,
257                     location.admin_level, location.fromarea,
258                     location_isaddress,
259                     location.rank_address,
260                     location.distance)::addressline;
261
262     current_rank_address := location.rank_address;
263   END LOOP;
264
265   -- If no country was included yet, add the name information from country_name.
266   IF current_rank_address > 4 THEN
267     FOR location IN
268       SELECT name FROM country_name WHERE country_code = place.country_code LIMIT 1
269     LOOP
270 --RAISE WARNING '% % %',current_rank_address,searchcountrycode,countryname;
271       RETURN NEXT ROW(null, null, null, location.name, 'place', 'country', NULL,
272                       null, true, true, 4, 0)::addressline;
273     END LOOP;
274   END IF;
275
276   -- Finally add some artificial rows.
277   IF place.country_code IS NOT NULL THEN
278     location := ROW(null, null, null, hstore('ref', place.country_code),
279                     'place', 'country_code', null, null, true, false, 4, 0)::addressline;
280     RETURN NEXT location;
281   END IF;
282
283   IF place.name IS NOT NULL THEN
284     location := ROW(in_place_id, null, null, place.name, place.class,
285                     place.type, null, null, true, true, 29, 0)::addressline;
286     RETURN NEXT location;
287   END IF;
288
289   IF place.housenumber IS NOT NULL THEN
290     location := ROW(null, null, null, hstore('ref', place.housenumber),
291                     'place', 'house_number', null, null, true, true, 28, 0)::addressline;
292     RETURN NEXT location;
293   END IF;
294
295   IF place.address is not null and place.address ? '_unlisted_place' THEN
296     RETURN NEXT ROW(null, null, null, hstore('name', place.address->'_unlisted_place'),
297                     'place', 'locality', null, null, true, true, 25, 0)::addressline;
298   END IF;
299
300   IF place.postcode is not null THEN
301     location := ROW(null, null, null, hstore('ref', place.postcode), 'place',
302                     'postcode', null, null, false, true, 5, 0)::addressline;
303     RETURN NEXT location;
304   END IF;
305
306   RETURN;
307 END;
308 $$
309 LANGUAGE plpgsql STABLE;