cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
795 Commits 1 Branch 118 Tags 9.7 MiB
JavaScript 99.9%
d50ddbb10f
Go to file
Raul Ochoa d50ddbb10f Add more fields to error responses with hint, detail and context for SQL errors.
2014-11-21 12:59:48 +01:00
app Add more fields to error responses with hint, detail and context for SQL errors. 2014-11-21 12:59:48 +01:00
client Add arraybuffer format 2013-05-28 10:37:39 +02:00
config Health check endpoint 2014-08-26 18:40:58 +02:00
doc Replace highlighting with ``` 2014-11-14 17:33:26 +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 Add more fields to error responses with hint, detail and context for SQL errors. 2014-11-21 12:59:48 +01:00
tools Allow specifying api key via CDBSQL_APIKEY env variable 2013-07-17 10:29:19 +02:00
.gitignore New authentication mechanism: checks in advance if credentials are provided 2014-08-05 16:20:06 +02:00
.travis.yml Adds postgresql python support: plpythonu 2014-09-22 15:04:45 +02:00
app.js [CDB-3678] Add X-Served-By-Host header 2014-07-30 12:39:03 +02:00
configure Rename env files to .example, add a ./configure script 2012-10-04 12:04:49 +02:00
HOWTO_RELEASE Update release document 2014-04-09 09:21:16 +02:00
LICENSE Switch to 3-clause BSD license 2014-03-20 11:23:17 +01:00
Makefile Run tests on "make check", using custom port for redis 2012-07-12 18:10:56 +02:00
NEWS.md Add more fields to error responses with hint, detail and context for SQL errors. 2014-11-21 12:59:48 +01:00
npm-shrinkwrap.json Add more fields to error responses with hint, detail and context for SQL errors. 2014-11-21 12:59:48 +01:00
package.json Add more fields to error responses with hint, detail and context for SQL errors. 2014-11-21 12:59:48 +01:00
README.md Some minor improvements in readme 2014-09-24 10:32:54 +02:00

README.md

SQL API for cartodb.com

[Build Status] (http://travis-ci.org/CartoDB/CartoDB-SQL-API)

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.0+ (with plpythonu extension for CDB_QueryTables)
  • postgis 2.0+
  • GDAL 1.9.2+ (bin utils)
  • zip commandline tool
  • redis
  • node >=0.8.18
  • npm >=1.2.1

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).