cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2,644 Commits 1 Branch 118 Tags 9.7 MiB
JavaScript 99.9%
8d7ecf61ef
Go to file
Simon Martín 8d7ecf61ef
Merge pull request #531 from CartoDB/create-carto-package-json 
create carto-package.json file
2018-08-16 15:04:22 +02:00
app better message 2018-08-14 15:30:51 +02:00
batch reopenFileStreams to parent class 2018-06-18 18:47:12 +02:00
client Add arraybuffer format 2013-05-28 10:37:39 +02:00
config/environments Set the default copy_from_max_post_size to 2 GB 2018-07-26 12:52:20 +02:00
doc Modify python code example to really stream data 2018-08-02 17:43:07 +02: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 remove only 2018-08-10 14:40:23 +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 back previous commit 2018-08-16 12:59:54 +02:00
app.js data ingestion logger reopenFileStreams 2018-06-18 18:48:38 +02:00
carto-package.json gdal and carto_postgresql_ext 2018-08-16 13:01:56 +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 Update NEWS.md #528 2018-08-10 12:41:29 +02:00
npm-shrinkwrap.json Release version 2.2.0 2018-07-25 09:55:56 +02:00
package.json Stub next version 2018-07-25 10:00:13 +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.