Skip to content
CartoDB SQL API
TSQL JavaScript Shell HTML Makefile Python
Branch: master
Clone or download
Latest commit da919fc Aug 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app Comment improvement Jul 31, 2019
batch Ignore jshint Apr 9, 2019
client Use strict mode Oct 24, 2018
config/environments Remove table cache Jul 24, 2019
docs Fix cURL docs for Windows users by using @filename Aug 22, 2019
logs updated gitignore and added required directories for node cluster to … Sep 5, 2011
test Add tests for x-sqlapi-log length Jul 31, 2019
tools Allow specifying api key via CDBSQL_APIKEY env variable Jul 17, 2013
.gitignore Ignore log and yarn.lock Jun 4, 2018
.jshintignore Format files split into pg and ogr directories May 13, 2015
.jshintrc Allow es6 syntax Aug 4, 2017
.travis.yml Allow to test against different docker images Apr 10, 2019
CONTRIBUTING.md Fixed wrong contributing url Jan 25, 2017
HOWTO_RELEASE Typo Feb 22, 2019
LICENSE Adds notes about contributing Sep 8, 2015
Makefile Priority for tests instead of lint Dec 19, 2016
NEWS.md Update NEWS Jul 31, 2019
README.md Imporve doc Feb 22, 2019
app.js Be more consistent while defining arguments Apr 5, 2019
carto-package.json Drop support for Node.js 6, npm 3, Postgres 9.5, PostGIS 2.2, and Red… Feb 21, 2019
configure Have ./configure tolerate unknown options Oct 8, 2014
docker-bash.sh bash with new docker image Feb 12, 2019
docker-test.sh Allow to test against different docker images Apr 10, 2019
package-lock.json Update cartodb-query-tables to version 0.5.0 Jul 9, 2019
package.json Update cartodb-query-tables to version 0.5.0 Jul 9, 2019

README.md

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.

Requirements

  • Node 10.x
  • npm 6.x
  • PostgreSQL >= 10.0
  • PostGIS >= 2.4
  • CARTO Postgres Extension >= 0.24.1
  • Redis >= 4
  • GDAL 1.11.0 (bin utils). See installing GDAL
  • zip commandline tool.
  • C++11 (to build internal dependencies if needed)

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.

You can’t perform that action at this time.