Go to file

Daniel García Aubert 43f759e96a Refactored Batch API using streams instead a interval to consume the job queue. Limited one job running at the same time per queue instead of using a job's counter to limit it.		2015-12-16 15:57:58 +01:00
app	Refactored Batch API using streams instead a interval to consume the job queue. Limited one job running at the same time per queue instead of using a job's counter to limit it.	2015-12-16 15:57:58 +01:00
batch	Refactored Batch API using streams instead a interval to consume the job queue. Limited one job running at the same time per queue instead of using a job's counter to limit it.	2015-12-16 15:57:58 +01:00
client	Add arraybuffer format	2013-05-28 10:37:39 +02:00
config	Keep using ogr2ogr in test example config	2015-06-16 16:45:21 +02:00
doc	worked out some editing with Carla-ready to merge	2015-11-11 11:45:12 -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	Refactored Batch API using streams instead a interval to consume the job queue. Limited one job running at the same time per queue instead of using a job's counter to limit it.	2015-12-16 15:57:58 +01:00
tools	Allow specifying api key via CDBSQL_APIKEY env variable	2013-07-17 10:29:19 +02:00
.gitignore	New authentication mechanism: checks in advance if credentials are provided	2014-08-05 16:20:06 +02:00
.jshintignore	Format files split into pg and ogr directories	2015-05-13 15:15:53 +02:00
.jshintrc	jshint: add makefile target and ignore file	2015-05-13 13:01:01 +02:00
.travis.yml	Try to use ogr2ogr2 from ppa:cartodb/gis	2015-06-16 15:58:33 +02:00
app.js	app module moved to right place	2015-12-03 18:33:17 +01:00
configure	Rename env files to .example, add a ./configure script	2012-10-04 12:04:49 +02:00
CONTRIBUTING.md	Adds notes about contributing	2015-09-08 16:40:33 +02:00
HOWTO_RELEASE	Update release document	2014-04-09 09:21:16 +02:00
LICENSE	Adds notes about contributing	2015-09-08 16:40:33 +02:00
Makefile	Make jshint part of `npm test`	2015-05-13 13:13:16 +02:00
NEWS.md	Set `Last-Modified` header based on affected tables	2015-09-02 16:25:56 +02:00
npm-shrinkwrap.json	Set `Last-Modified` header based on affected tables	2015-09-02 16:25:56 +02:00
package.json	Refactored Batch API using streams instead a interval to consume the job queue. Limited one job running at the same time per queue instead of using a job's counter to limit it.	2015-12-16 15:57:58 +01:00
README.md	Adds notes about contributing	2015-09-08 16:40:33 +02:00

README.md

SQL API for cartodb.com

Provides a node.js 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+ (with plpythonu extension for CDB_QueryTables)
postgis 2.0+
GDAL 1.9.2+ (bin utils)
zip commandline tool
redis
node >=0.8.18
npm >=1.2.1

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 development, test, production

See doc/API.md for API documentation. For examples of use, see under test/.

tests

Run with:

npm test

If any issue arise see test/README.md

Note that the environment should be set to ensure the default PostgreSQL user is superuser (PGUSER=postgres make check).

Contributing

See CONTRIBUTING.md.