cartodb
/
CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
3113 Commits
1 Branch
118 Tags
9.7 MiB
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '24572f63a2'
${ noResults }
Go to file
Daniel García Aubert 24572f63a2
Stop using makefile and bash scripts to prepare redis and postgres 		5 years ago
config/environments Default to stdout logging on dev environment 5 years ago
docker/scripts Stop using makefile and bash scripts to prepare redis and postgres 5 years ago
docs Professional -> Individual 5 years ago
lib Eslint errors 5 years ago
test Stop using makefile and bash scripts to prepare redis and postgres 5 years ago
.eslintrc.js Replace jshint by eslint as default linter tool 5 years ago
.gitignore Merge branch 'master' of github.com:CartoDB/CartoDB-SQL-API 5 years ago
.travis.yml Stop using makefile and bash scripts to prepare redis and postgres 5 years ago
CONTRIBUTING.md Fixed wrong contributing url 8 years ago
HOWTO_RELEASE Typo 6 years ago
LICENSE Adds notes about contributing 9 years ago
Makefile Stop using jshint 5 years ago
NEWS.md Stubs next version 5 years ago
README.md Imporve doc 6 years ago
app.js Run eslint --fix 5 years ago
carto-package.json Drop support for Node.js 6, npm 3, Postgres 9.5, PostGIS 2.2, and Redis 3 6 years ago
configure Have ./configure tolerate unknown options 10 years ago
docker-bash.sh bash with new docker image 6 years ago
docker-test.sh Allow to test against different docker images 6 years ago
package-lock.json Replace jshint by eslint as default linter tool 5 years ago
package.json Stop using makefile and bash scripts to prepare redis and postgres 5 years ago

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.