cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4d8a22afd6
CartoDB-SQL-API/README.md
Sandro Santilli af47b1ebcb Use http for build status icon
2014-01-09 18:02:33 +01:00

1.4 KiB
Raw Blame History

SQL API for cartodb.com

[Build Status] (http://travis-ci.org/CartoDB/CartoDB-SQL-API)

Provides a nodejs based API for running SQL queries against CartoDB.

  • Users are authenticated over OAuth or via an API KEY.
  • Authenticated requests to this API should always be made over SSL.

core requirements

  • postgres 9.0+
  • postgis 2.0+
  • cartodb 0.9.5+ (for CDB_QueryTables)
  • GDAL 1.9.2+ (bin utils)
  • zip commandline tool
  • redis
  • node 0.8+
  • npm

Install dependencies

npm install

usage

Create and edit config/environments/.js from .js.example files. You may find the ./configure script useful to make an edited copy for you, see ./configure --help for a list of supported switches.

Make sure redis is running and knows about active cartodb user.

Make sure your PostgreSQL server is running, is accessible on the host and port specified in the file, has a 'publicuser' role (or whatever you set db_pubuser configuration directive to) and trusts user authentication from localhost connections.

node app.js <environment>

Supported values are developement, test, production

See doc/API.md for API documentation. For examples of use, see under test/.

tests

Run make check or see test/README.md