Go to file

Sandro Santilli 5fea8ed459 Add small recipe about making new releases		2013-10-01 17:06:14 +02:00
app	Add note about why we want to skip querying geometry_columns	2013-09-30 10:43:32 +02:00
client	Add arraybuffer format	2013-05-28 10:37:39 +02:00
config	Add note about tmpDir needing to be writable by server user	2013-08-21 10:03:12 +02:00
doc	Report boolean values as of boolean type, not string. Closes #106	2013-08-22 13:45:20 +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	Honour skipfields in JSON schema response. Closes #109	2013-09-26 13:26:45 +02: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	Install GDAL too	2013-09-30 18:28:19 +02:00
app.js	Allow 'staging' as an env name for non-clustered run	2013-05-29 17:09:20 +02:00
cluster.js	Use an env config parameter for socket timeout	2012-12-05 14:02:40 +01:00
configure	Rename env files to .example, add a ./configure script	2012-10-04 12:04:49 +02:00
HOWTO_RELEASE	Add small recipe about making new releases	2013-10-01 17:06:14 +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	Honour skipfields in JSON schema response. Closes #109	2013-09-26 13:26:45 +02:00
npm-shrinkwrap.json	Fix version in shrinkwrap file	2013-09-04 15:10:42 +02:00
package.json	Target v1.6.0	2013-09-06 11:26:08 +02:00
README.md	Add PostGIS dependency	2013-09-30 18:44:33 +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+
postgis 2.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