cartodb/CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,466 Commits 1 Branch 118 Tags 9.7 MiB
JavaScript 99.9%
20573a7f67
Go to file
Raul Ochoa 20573a7f67 Always log queries from fallback jobs 
- Add query id if exists
- Only log analyses for expected format
- Log with query start and end times
2016-09-30 16:54:10 +02:00
app Set batch queries log path 2016-09-29 15:37:14 +02:00
batch Always log queries from fallback jobs 2016-09-30 16:54:10 +02:00
client Add arraybuffer format 2013-05-28 10:37:39 +02:00
config/environments Set batch queries log path 2016-09-29 15:37:14 +02:00
doc Remove best practice about updating a job as it's no longer possible 2016-09-16 15:43:06 +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 Delete table so suite ends clear 2016-09-26 18:26:00 +02:00
tools Allow specifying api key via CDBSQL_APIKEY env variable 2013-07-17 10:29:19 +02:00
.gitignore Adds coverage tool 2016-01-22 12:18:20 +01:00
.jshintignore Format files split into pg and ogr directories 2015-05-13 15:15:53 +02:00
.jshintrc jshint: add makefile target and ignore file 2015-05-13 13:01:01 +02:00
.travis.yml Use before_install hook for travis 2016-09-14 21:18:54 +02:00
app.js Implement batch logger to log query times when queries are defined with id 2016-09-29 15:09:36 +02:00
configure Rename env files to .example, add a ./configure script 2012-10-04 12:04:49 +02:00
CONTRIBUTING.md Adds notes about contributing 2015-09-08 16:40:33 +02:00
HOWTO_RELEASE Fixed unit test for job queue and moved isJobFound function as private method in job backend 2016-01-22 12:43:41 +01:00
LICENSE Adds notes about contributing 2015-09-08 16:40:33 +02:00
Makefile Batch test suite to include integration and unit tests also 2016-08-30 18:51:28 +02:00
NEWS.md Stubs next version 2016-09-15 11:57:07 +02:00
npm-shrinkwrap.json Regenerated npm shrinkwrap 2016-09-29 15:23:39 +02:00
package.json Implement batch logger to log query times when queries are defined with id 2016-09-29 15:09:36 +02:00
README.md Adds notes about contributing 2015-09-08 16:40:33 +02:00

README.md

SQL API for cartodb.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.

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

Contributing

See CONTRIBUTING.md.