cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
220 Commits 1 Branch 118 Tags 9.7 MiB
JavaScript 99.9%
e8401e5c46
Go to file
Sandro Santilli e8401e5c46 Cleanup links to docs
2012-10-04 12:04:49 +02:00
app More embedded comments 2012-10-04 12:04:49 +02:00
config Rename env files to .example, add a ./configure script 2012-10-04 12:04:49 +02:00
doc Cleanup 2012-10-04 12:04:49 +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 Don't hide errors during db preparation 2012-10-04 12:04:49 +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 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 Prepare for 1.1.0 2012-10-04 12:04:49 +02:00
package.json Prepare for 1.1.0 2012-10-04 12:04:49 +02:00
README.md Cleanup links to docs 2012-10-04 12:04:49 +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

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.

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

note on 0.4.x

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