cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
208 Commits 1 Branch 118 Tags 9.7 MiB
JavaScript 99.9%
686ff617b8
Go to file
Luis Bosque 686ff617b8 updated version to 1.0.0
2012-10-03 16:53:17 +02:00
app Fix INSERT and UPDATE with RETURNING clause. Closes #50 2012-09-17 11:50:19 +02:00
config Fix db_base_name and db_user setting for staging environment 2012-09-04 11:16:11 +02:00
logs updated gitignore and added required directories for node cluster to work out of the box 2011-09-05 17:01:23 +01:00
test Add tests for INSERT/UPDATE/DELETE and _no_ RETURNING (#13) 2012-09-17 16:56:25 +02:00
tools Fix --domain command line switch for cdbsql 2012-08-08 11:58:03 +02:00
websocket_test updated readme to reflect api key: 2012-06-01 21:19:02 +01:00
.gitignore updated gitignore and added required directories for node cluster to work out of the box 2011-09-05 17:01:23 +01:00
app.js quick tidy 2011-10-07 17:28:07 +01:00
cluster.js Switch to cluster2 for node-0.8 support 2012-09-28 13:19:28 +02:00
LICENSE update licence 2011-10-07 17:19:37 +01:00
Makefile Run tests on "make check", using custom port for redis 2012-07-12 18:10:56 +02:00
NEWS.md updated version to 1.0.0 2012-10-03 16:53:17 +02:00
package.json updated version to 1.0.0 2012-10-03 16:53:17 +02:00
README.md Merge branch 'develop' 2012-07-16 19:14:37 +02:00

README.md

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 && < v0.9.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.