Go to file
2012-10-04 12:43:12 +02:00
app Initial support for SVG output (#49) 2012-10-04 12:04:50 +02:00
config Rename env files to .example, add a ./configure script 2012-10-04 12:04:49 +02:00
doc Drop documentation for unexistent 'gn' parameter 2012-10-04 12:04:50 +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 Initial support for SVG output (#49) 2012-10-04 12:04:50 +02:00
tools Use POST method to send queries (may be very long) 2012-10-04 12:04:50 +02:00
websocket_test updated readme to reflect api key: 2012-06-01 21:19:02 +01:00
.gitignore Rename env files to .example, add a ./configure script 2012-10-04 12:04:49 +02:00
app.js quick tidy 2011-10-07 17:28:07 +01:00
cluster.js staging env in cluster.js 2012-10-03 17:14:17 +02:00
configure Rename env files to .example, add a ./configure script 2012-10-04 12:04:49 +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 Add info about what's changed so far 2012-10-04 12:06:04 +02:00
package.json Prepare for 1.1.0 2012-10-04 12:04:49 +02:00
README.md Document node-0.8 requirement 2012-10-04 12:43:12 +02:00

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 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 and trusts user authentication from localhost connections.

node [cluster.js|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