Go to file
2016-12-19 16:25:59 +01:00
app Raise job query size to 16kb 2016-11-07 16:50:44 +01:00
batch Include query status in log entries 2016-11-30 16:07:14 +01:00
client Add arraybuffer format 2013-05-28 10:37:39 +02:00
config/environments Increase to 4 the default value for fixed capacity 2016-10-20 20:16:34 +02:00
doc added note and applied branding 2016-12-08 13:55:21 -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 Dont debug that much 2016-12-19 15:30:03 +01:00
tools Allow specifying api key via CDBSQL_APIKEY env variable 2013-07-17 10:29:19 +02:00
.gitignore Ignore vscode settigns dir 2016-11-30 15:21:00 +01: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 Revert to use a specific minor version in travis config 2016-11-07 15:14:54 +01:00
app.js Merge branch 'master' into express-4.x 2016-09-30 17:37:30 +02:00
configure Have ./configure tolerate unknown options 2014-10-08 10:12:52 +02:00
CONTRIBUTING.md Adds notes about contributing 2015-09-08 16:40:33 +02:00
HOWTO_RELEASE Fixed unit test for job queue and moved isJobFound function as private method in job backend 2016-01-22 12:43:41 +01:00
LICENSE Adds notes about contributing 2015-09-08 16:40:33 +02:00
Makefile Priority for tests instead of lint 2016-12-19 15:29:29 +01:00
NEWS.md Stubs next version 2016-12-19 16:12:32 +01:00
npm-shrinkwrap.json Stubs next version 2016-12-19 16:12:32 +01:00
package.json Upgrade dev dependencies 2016-12-19 16:25:59 +01:00
README.md Change to carto.com 2016-12-13 16:32:41 +01:00

SQL API for carto.com

Build Status

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.