Go to file
Daniel García Aubert 3e1916c003 Fix vuls in debug
2019-01-16 17:42:03 +01:00
app Lint 2019-01-16 15:58:11 +01:00
batch reopenFileStreams to parent class 2018-06-18 18:47:12 +02:00
client Use strict mode 2018-10-24 15:42:33 +02:00
config/environments remove query_format rate limit 2018-12-10 18:20:10 +01:00
doc Doc: Document errors in streaming responses 2019-01-02 16:21:33 +01: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 adding Authorization to Access-Control-Allow-Headers 2019-01-10 15:55:08 +01:00
tools Allow specifying api key via CDBSQL_APIKEY env variable 2013-07-17 10:29:19 +02:00
.gitignore Ignore log and yarn.lock 2018-06-04 19:07:03 +02:00
.jshintignore Format files split into pg and ogr directories 2015-05-13 15:15:53 +02:00
.jshintrc Allow es6 syntax 2017-08-04 17:11:45 +02:00
.travis.yml Be able run CI test agaisnt Node.js 6 and 10 2018-11-07 18:37:05 +01:00
app.js Bad variable name 2019-01-03 19:26:44 +01:00
carto-package.json Fix carto-package.json 2018-12-26 17:20:04 +01:00
configure Have ./configure tolerate unknown options 2014-10-08 10:12:52 +02:00
CONTRIBUTING.md Fixed wrong contributing url 2017-01-25 10:49:29 +01:00
docker-bash.sh Be able run CI test agaisnt Node.js 6 and 10 2018-11-07 18:37:05 +01:00
docker-test.sh Fix arguments in docker command 2018-11-07 19:22:13 +01:00
HOWTO_RELEASE Update docs: Node.js and npm version 2019-01-02 11:16:00 +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 2019-01-16 14:43:50 +01:00
npm-shrinkwrap.json Fix vuls in debug 2019-01-16 17:42:03 +01:00
package-lock.json Fix vuls in debug 2019-01-16 17:42:03 +01:00
package.json Fix vuls in debug 2019-01-16 17:42:03 +01:00
README.md Update docs: Node.js and npm version 2019-01-02 11:16:00 +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

  • Node >= 10.14.2 or 6.9.2
  • npm >= 6.4.1 || 3.10.9 || 3.10.10
  • Postgres 9.3+.
  • Postgis 2.2.
  • CartoDB Postgres Extension 0.19+.
  • GDAL 1.11.0 (bin utils). See installing GDAL
  • zip commandline tool.
  • Redis 3, recommended reversion 3.0.2.

Install dependencies

  • Node.js >= 10.14.2:
$ mv npm-shrinkwrap.json npm-shrinkwrap.json.backup
$ npm ci
$ mv npm-shrinkwrap.json.backup npm-shrinkwrap.json
  • Node.js 6.9.2:
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.