cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
6a2e0a338a
CartoDB-SQL-API/README.md
Sandro Santilli 6a2e0a338a Add versions for postgresql and cartodb requirements 
This is because the CDB_QueryTables is used by the core: is provided
by CartoDB and only works with PostgreSQL 9.0+
2012-07-12 22:05:09 +02:00

879 B
Raw Blame History

SQL API for cartodb.com

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+
  • cartodb 0.9.5+ (for CDB_QueryTables)
  • redis
  • node >v0.4.8 && < 0.7.0>
  • npm

usage

Edit config/environments/.js Make sure redis is running and knows about active cartodb user.

node [cluster.js|app.js] <environment>

Supported values are developement, test, production

for examples of use, see /tests

Install dependencies

npm install

tests

see test/README.md

note on 0.4.x

output of large result sets is slow under node 0.4. Recommend running under 0.6 where possible.