cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
162 Commits 1 Branch 118 Tags 9.7 MiB
JavaScript 99.9%
374583e655
Go to file
Simon Tokumine 374583e655 add tests and refactor validations for input parameters. closes #29
2012-06-06 19:47:21 +01:00
app add tests and refactor validations for input parameters. closes #29 2012-06-06 19:47:21 +01:00
config by default cluster.js binds to 127.0.0.1 instead of 0.0.0.0 2012-02-09 16:53:21 +01: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
pids 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 and refactor validations for input parameters. closes #29 2012-06-06 19:47:21 +01: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 notes on cluster 2012-06-01 18:19:13 +01:00
LICENSE update licence 2011-10-07 17:19:37 +01:00
package.json bump version 2012-04-13 16:59:41 +01:00
README.md updated readme to reflect api key: 2012-06-01 21:19:02 +01: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
  • 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.