cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
704 Commits 1 Branch 118 Tags 9.7 MiB
JavaScript 99.9%
81e191bcf3
Go to file
Raul Ochoa 81e191bcf3 Fixes redis-mpool dependency
2014-08-06 11:32:12 +02:00
app Fixes redis-mpool dependency 2014-08-06 11:32:12 +02:00
client Add arraybuffer format 2013-05-28 10:37:39 +02:00
config Adds support to append logs to file with log4js. It listens to HUP signal to re-open the log file. In case the specified log filename is not writeable the server will not start. 2014-05-27 11:51:44 +02:00
doc removed "experimental" from python api 2014-07-18 11:57:39 +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 New authentication mechanism: checks in advance if credentials are provided 2014-08-05 16:20:06 +02: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 CDB-3079 yet another try to use cartodb flavour of postgres/postgis 2014-06-03 18:11:32 +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 New authentication mechanism: checks in advance if credentials are provided 2014-08-05 16:20:06 +02:00
npm-shrinkwrap.json Fixes redis-mpool dependency 2014-08-06 11:32:12 +02:00
package.json Fixes redis-mpool dependency 2014-08-06 11:32:12 +02:00
README.md Use http for build status icon 2014-01-09 18:02:33 +01:00

README.md

SQL API for cartodb.com

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

Provides a nodejs 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+
  • postgis 2.0+
  • cartodb 0.9.5+ (for CDB_QueryTables)
  • GDAL 1.9.2+ (bin utils)
  • zip commandline tool
  • redis
  • node 0.8+
  • npm

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 developement, test, production

See doc/API.md for API documentation. For examples of use, see under test/.

tests

Run make check or see test/README.md