Go to file

Sandro Santilli af47b1ebcb Use http for build status icon		2014-01-09 18:02:33 +01:00
app	Fix use of "SELECT .. INTO" with windowing params	2014-01-09 17:56:09 +01:00
client	Add arraybuffer format	2013-05-28 10:37:39 +02:00
config	Generalize CartoDB username extraction, allowing for multiuser setups	2013-12-18 11:59:00 +01:00
doc	Document and test "page" and "rows_per_page" parameters.	2013-12-03 10:52:55 -05: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	Fix use of "SELECT .. INTO" with windowing params	2014-01-09 17:56:09 +01:00
tools	Allow specifying api key via CDBSQL_APIKEY env variable	2013-07-17 10:29:19 +02:00
.gitignore	Ignore more generated files	2013-05-27 10:05:31 +02:00
.travis.yml	Workaround postgis package bugs in ubuntu repos (for travis)	2013-11-27 16:18:44 +01:00
app.js	Allow 'staging' as an env name for non-clustered run	2013-05-29 17:09:20 +02:00
configure	Rename env files to .example, add a ./configure script	2012-10-04 12:04:49 +02:00
HOWTO_RELEASE	Add release date step	2013-10-02 13:07:01 +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	Fix use of "SELECT .. INTO" with windowing params	2014-01-09 17:56:09 +01:00
npm-shrinkwrap.json	Generalize CartoDB username extraction, allowing for multiuser setups	2013-12-18 11:59:00 +01:00
package.json	Prepare for 1.8.1	2013-12-18 12:38:10 +01:00
README.md	Use http for build status icon	2014-01-09 18:02:33 +01:00

README.md

SQL API for cartodb.com

[] (http://travis-ci.org/CartoDB/CartoDB-SQL-API)

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+
postgis 2.0+
cartodb 0.9.5+ (for CDB_QueryTables)
GDAL 1.9.2+ (bin utils)
zip commandline tool
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 (or whatever you set db_pubuser configuration directive to) and trusts user authentication from localhost connections.

node 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