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.
 
Go to file
Sandro Santilli 67cc05085f
Always use INFO severity for express logging
11 years ago
app Always use INFO severity for express logging 11 years ago
client Add arraybuffer format 11 years ago
config Add optional support for rollbar 11 years ago
doc Document and test "page" and "rows_per_page" parameters. 11 years ago
logs updated gitignore and added required directories for node cluster to work out of the box 13 years ago
test Add '/version' endpoint 11 years ago
tools Allow specifying api key via CDBSQL_APIKEY env variable 11 years ago
.gitignore Ignore more generated files 11 years ago
.travis.yml Workaround postgis package bugs in ubuntu repos (for travis) 11 years ago
HOWTO_RELEASE Add release date step 11 years ago
LICENSE update licence 13 years ago
Makefile Run tests on "make check", using custom port for redis 12 years ago
NEWS.md Allow passing environment configuration name via NODE_ENV to app.js 11 years ago
README.md Use http for build status icon 11 years ago
app.js Allow passing environment configuration name via NODE_ENV to app.js 11 years ago
configure Rename env files to .example, add a ./configure script 12 years ago
npm-shrinkwrap.json Add optional support for rollbar 11 years ago
package.json Add optional support for rollbar 11 years ago

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