cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2,457 Commits 1 Branch 118 Tags 9.7 MiB
JavaScript 99.9%
ad79717069
Go to file
Simon Martín ad79717069 NEWS 2.1.0 date
2018-06-13 10:39:44 +02:00
app adding metadataBackend to user middleware in copycontroller 2018-06-11 14:55:37 +02:00
batch Merge branch 'master' into pgcopy-stream 2018-06-11 14:38:52 +02:00
client Add arraybuffer format 2013-05-28 10:37:39 +02:00
config/environments changing name of dataIngestionLogPath 2018-05-23 17:32:44 +02:00
doc Change parameter lists to table, per @andye request 2018-06-04 11:34:38 -07: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 Please jshint 2018-06-11 19:26:40 +02: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 using the correct docker account 2018-05-03 17:41:37 +02:00
app.js Use external module to get full qualified domain name properly 2018-06-08 13:30:54 +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 NEWS 2.1.0 date 2018-06-13 10:39:44 +02:00
npm-shrinkwrap.json Update npm shrinkwrap (just version of cartodb_sql_api) 2018-06-12 12:29:22 +02:00
package.json Update NEWS.md and version w/ COPY 2018-06-12 12:23:32 +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.