This commit is contained in:
Carla 2016-07-11 10:46:03 +02:00 committed by GitHub
parent 93d705021b
commit 1caa98bd1e

View File

@ -1,23 +1,23 @@
# CartoDB geocoder extension
Postgres extension for the CartoDB geocoder. It is meant to contain the functions and related objects needed to provide a geocoding service for administrative areas of level 0, administrative areas of level 1, postal codes, IP addresses and city names. It is not meant to contain the actual data used to geocode them.
# CARTO geocoder extension
Postgres extension for the CARTO geocoder. It is meant to contain the functions and related objects needed to provide a geocoding service for administrative areas of level 0, administrative areas of level 1, postal codes, IP addresses and city names. It is not meant to contain the actual data used to geocode them.
## Dependencies
This extension is thought to be used on top of CartoDB platform. Therefore **a cartodb user is required** to install the extension onto it.
This extension is thought to be used on top of CARTO platform. Therefore **a CARTO user is required** to install the extension onto it.
The following is a non-comprehensive list of dependencies:
- Postgres 9.3+
- Postgis extension
- Schema triggers extension
- CartoDB extension
- cartodb-postgresql CARTO extension
## Installation into the db cluster
This requires root privileges
## Installation into the DB cluster
This step requires root privileges
```
sudo make all install
```
## Execute tests
## Execute the tests
```
PGUSER=postgres make installcheck
```
@ -28,9 +28,9 @@ One-liner:
sudo PGUSER=postgres make all install installcheck
```
## Install onto a cartodb user's database
## Install onto a CARTO user's database
Remember that **is mandatory to install into a cartodb user's database**
Remember that **it is mandatory to install it into a CARTO user's database**
```
psql -U development_cartodb_user_fe3b850a-01c0-48f9-8a26-a82f09e9b53f cartodb_dev_user_fe3b850a-01c0-48f9-8a26-a82f09e9b53f_db
@ -42,4 +42,4 @@ and then:
CREATE EXTENSION cdb_geocoder;
```
The extension creation in the user's db does not require special privileges. It can be even created from the sql api.
The extension creation in the user's DB does not require special privileges. It can be even created from the SQL API.