cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
759 Commits 1 Branch 118 Tags 9.7 MiB
JavaScript 99.9%
2e3eeefd0f
Go to file
Raul Ochoa 2e3eeefd0f Removes tables=fake wadus param in ogr2ogr command so it can go to 
geometry_colums view to retrieve the column data type. This requires
to grant permissions on geometry_columns and geography_columns to the
public user.
2014-09-22 13:23:30 +02:00
app Removes tables=fake wadus param in ogr2ogr command so it can go to 2014-09-22 13:23:30 +02: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 Update API.md 2014-09-08 10:32:04 +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 Removes tables=fake wadus param in ogr2ogr command so it can go to 2014-09-22 13:23:30 +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 Stubs next version 2014-09-17 00:04:10 +02:00
npm-shrinkwrap.json Stubs next version 2014-09-17 00:04:10 +02:00
package.json Stubs next version 2014-09-17 00:04:10 +02:00
README.md Upgrades QueryTables and QueryStatements to match with current 2014-09-22 13:16:11 +02: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+ (with plpythonu extension for CDB_QueryTables)
  • postgis 2.0+
  • 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