cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2,246 Commits 1 Branch 118 Tags 9.7 MiB
JavaScript 99.9%
e437a0a642
Go to file
Simon Martín e437a0a642 adding docker npm scripts
2018-04-27 17:37:46 +02:00
app fix validatePGEntitiesAccess access 2018-04-26 10:13:03 +02:00
batch Fix property names to not expose user's credential info 2018-02-15 13:12:40 +01:00
client Add arraybuffer format 2013-05-28 10:37:39 +02:00
config/environments adding parameter in config files 2018-04-24 15:54:48 +02:00
doc applied edits based on Nacho's feedback 2017-12-19 08:03:38 -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 configure environment file in travis 2018-04-27 16:38:36 +02:00
tools Allow specifying api key via CDBSQL_APIKEY env variable 2013-07-17 10:29:19 +02:00
.gitignore adding rediscell files for linux and mac 2018-03-27 12:14:28 +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 new path of run_tests_docker in travis 2018-04-27 16:17:34 +02:00
app.js Avoid global stats client 2017-03-30 17:32:22 +02: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
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 2018-03-22 16:34:20 +01:00
npm-shrinkwrap.json updating shrinkwrap 2018-03-22 12:02:16 +01:00
package.json adding docker npm scripts 2018-04-27 17:37:46 +02:00
README.md Update core requirements 2017-08-11 14:48:01 +02:00

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.

core requirements

  • 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.
  • Node.js 6, recommended reversion 6.9.2.
  • npm 3, recommended version 3.10.9.

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.