cartodb
/
CartoDB-SQL-API
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
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.
1445 Commits
1 Branch
118 Tags
9.7 MiB
 
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '4dfdb2eaea'
${ noResults }
Go to file
Raul Ochoa 4dfdb2eaea
Fix example 		8 years ago
app Rename from app to server 8 years ago
batch Remove user indexer 8 years ago
client Add arraybuffer format 11 years ago
config/environments Remove settings' app_root 8 years ago
doc applied edits 8 years ago
logs updated gitignore and added required directories for node cluster to work out of the box 13 years ago
test Remove setMaxListeners from tests 8 years ago
tools Allow specifying api key via CDBSQL_APIKEY env variable 11 years ago
.gitignore Adds coverage tool 9 years ago
.jshintignore Format files split into pg and ogr directories 9 years ago
.jshintrc jshint: add makefile target and ignore file 9 years ago
.travis.yml Use before_install hook for travis 8 years ago
CONTRIBUTING.md Adds notes about contributing 9 years ago
HOWTO_RELEASE Fixed unit test for job queue and moved isJobFound function as private method in job backend 9 years ago
LICENSE Adds notes about contributing 9 years ago
Makefile Batch test suite to include integration and unit tests also 8 years ago
NEWS.md Allow to use `--config /path/to/config.js` to specify configuration file 8 years ago
README.md Adds notes about contributing 9 years ago
app.js Fix example 8 years ago
configure Rename env files to .example, add a ./configure script 12 years ago
npm-shrinkwrap.json Allow to use `--config /path/to/config.js` to specify configuration file 8 years ago
package.json Allow to use `--config /path/to/config.js` to specify configuration file 8 years ago

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.