From f18feb4bc078f94227738364cda8e551fad5caa1 Mon Sep 17 00:00:00 2001 From: Carla Date: Fri, 13 Nov 2015 15:00:39 +0100 Subject: [PATCH] Update API.md --- doc/API.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/doc/API.md b/doc/API.md index 495f278..d2bee9c 100644 --- a/doc/API.md +++ b/doc/API.md @@ -32,74 +32,74 @@ possible side-effects This function receives a country name and returns a polygon geometry (SRID 4326) for the corresponding input. * Functions: - * `geocode_admin0_polygons(countryname text)` + * `geocode_admin0_polygon(countryname text)` * **Return type:** `polygon` * **Usage example:** ````` - SELECT geocode_admin0_polygons('France') + SELECT geocode_admin0_polygon('France') ````` ### Level-1 Administrative regions geocoder * Functions: - * `geocode_admin1_polygons(adminname text)` + * `geocode_admin1_polygon(adminname text)` * **Return type:** `polygon` * **Usage example:** ````` - SELECT geocode_admin1_polygons('Alicante') + SELECT geocode_admin1_polygon('Alicante') ````` - * `geocode_admin1_polygons(adminname text, countryname text)` + * `geocode_admin1_polygon(adminname text, countryname text)` * **Return type:** `polygon` * **Usage example:** ````` - SELECT geocode_admin1_polygons('Alicante', 'Spain') + SELECT geocode_admin1_polygon('Alicante', 'Spain') ````` ### Cities geocoder * Functions: - * `geocode_namedplace(city text)` + * `geocode_namedplace_point(city text)` * **Return type:** `point` * **Usage example:** ````` - SELECT geocode_namedplace('Barcelona') + SELECT geocode_namedplace_point('Barcelona') ````` - * `geocode_namedplace(city text, country text)` + * `geocode_namedplace_point(city text, country text)` * **Return type:** `point` * **Usage example:** ````` - SELECT geocode_namedplace('Barcelona', 'Spain') + SELECT geocode_namedplace_point('Barcelona', 'Spain') ````` - * `geocode_namedplace(city text, admin1 text, country text)` + * `geocode_namedplace_point(city text, admin1 text, country text)` * **Return type:** `point` * **Usage example:** ````` - SELECT geocode_namedplace('New York', 'New York', 'USA') + SELECT geocode_namedplace_point('New York', 'New York', 'USA') ````` ### Postal codes geocoder * Functions: - * `geocode_postalcode_polygons(code text, country text)` + * `geocode_postalcode_polygon(code text, country text)` * **Return type:** `polygon` * **Usage example:** ````` - SELECT geocode_postalcode_polygons('11211', 'USA') + SELECT geocode_postalcode_polygon('11211', 'USA') ````` - * `geocode_postalcode_points(code text, country text)` + * `geocode_postalcode_point(code text, country text)` * **Return type:** `point` * **Usage example:** ````` - SELECT geocode_postalcode_points('11211', 'USA') + SELECT geocode_postalcode_point('11211', 'USA') ````` ### IP addresses Geocoder * Functions: - * `geocode_ip(ipaddress text)` + * `geocode_ip_point(ipaddress text)` * **Return type:** `point` * **Usage example:** ````` - SELECT geocode_ip('102.23.34.1') + SELECT geocode_ip_point('102.23.34.1') `````