Skip to content
CartoDB SQL API
Branch: master
Clone or download
dgaubert Merge pull request #584 from CartoDB/remove-old-jobs
Implemented script to remove old batch-api jobs
Latest commit 9f20ef2 Apr 11, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
app
batch Ignore jshint Apr 9, 2019
client Use strict mode Oct 24, 2018
config/environments
docs honor CR Mar 21, 2019
logs updated gitignore and added required directories for node cluster to … Sep 5, 2011
test Remove workaround for PARALLEL tags Apr 10, 2019
tools
.gitignore
.jshintignore Format files split into pg and ogr directories May 13, 2015
.jshintrc
.travis.yml
CONTRIBUTING.md Fixed wrong contributing url Jan 25, 2017
HOWTO_RELEASE
LICENSE
Makefile Priority for tests instead of lint Dec 19, 2016
NEWS.md
README.md
app.js
carto-package.json Drop support for Node.js 6, npm 3, Postgres 9.5, PostGIS 2.2, and Red… Feb 21, 2019
configure
docker-bash.sh bash with new docker image Feb 12, 2019
docker-test.sh
package-lock.json
package.json

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.