dataservices-api/server/extension/README.md

46 lines
975 B
Markdown
Raw Normal View History

2016-07-11 16:51:16 +08:00
# CARTO Data Services API server extension
Postgres extension for the CARTO Data Services API, server side.
2015-11-10 18:04:48 +08:00
## Dependencies
2016-07-11 16:51:16 +08:00
This extension is thought to be used on top of CARTO geocoder extension, for the internal geocoder.
2015-11-10 18:04:48 +08:00
The following is a non-comprehensive list of dependencies:
- Postgres 9.3+
- Postgis extension
- Schema triggers extension
2016-07-11 16:51:16 +08:00
- cartodb-postgresql CARTO extension
2015-11-10 18:04:48 +08:00
## Installation into the db cluster
This requires root privileges
```
sudo make all install
```
## Execute tests
```
PGUSER=postgres make installcheck
```
## Build, install & test
One-liner:
```
sudo PGUSER=postgres make all install installcheck
```
2016-07-11 16:51:16 +08:00
## Install onto a CARTO user's database
2015-11-10 18:04:48 +08:00
Remember that **is mandatory to install it on top of cdb_geocoder**
```
psql -U postgres cartodb_dev_user_fe3b850a-01c0-48f9-8a26-a82f09e9b53f_db
```
and then:
```sql
CREATE EXTENSION cdb_dataservices_server;
2015-11-10 18:04:48 +08:00
```
The extension creation in the user's db requires **superuser** privileges.