cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
187 Commits 1 Branch 118 Tags 9.7 MiB
JavaScript 99.9%
2ae5119bae
Go to file
Sandro Santilli 2ae5119bae Raise express dependency to 2.5.11 where it also work with node-0.8 
This version passed "make check" with:
 - node 0.4.10
 - node 0.6.19
 - node 0.8.2
2012-07-16 19:10:50 +02:00
app Support case insensitive in format parameter. Closes #30 2012-07-13 10:24:12 +02:00
config Run tests on "make check", using custom port for redis 2012-07-12 18:10:56 +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
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 Expect correct JSON, never mind formatting of it 2012-07-16 17:16:28 +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 notes on cluster 2012-06-01 18:19:13 +01: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
npm-shrinkwrap.json Raise express dependency to 2.5.11 where it also work with node-0.8 2012-07-16 19:10:50 +02:00
package.json Raise express dependency to 2.5.11 where it also work with node-0.8 2012-07-16 19:10:50 +02:00
README.md Add versions for postgresql and cartodb requirements 2012-07-12 22:05:09 +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 && < 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.