CartoDB-SQL-API/README.md

SQL API for cartodb.com
========================

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+
* cartodb 0.9.5+ (for CDB_QueryTables)
* redis
* node >v0.4.8 && < 0.7.0>
* npm

usage
-----

Edit config/environments/<environment>.js
Make sure redis is running and knows about active cartodb user.

``` bash
node [cluster.js|app.js] <environment>
```

Supported <environment> values are developement, test, production

for examples of use, see /tests


Install dependencies
---------------------

```bash
npm install
```


tests
------
see test/README.md


note on 0.4.x
--------------
output of large result sets is slow under node 0.4. Recommend running under 0.6 where possible.
first draft, tidied, unit tests, modules, refactor, environments, see TODO for next steps" 2011-06-13 11:23:02 +08:00			`SQL API for cartodb.com`
			`========================`
updated readme to reflect api key: 2012-06-02 04:19:02 +08:00
update readme 2011-10-08 00:19:02 +08:00			`Provides a nodejs based API for running SQL queries against CartoDB.`
first draft, tidied, unit tests, modules, refactor, environments, see TODO for next steps" 2011-06-13 11:23:02 +08:00
updated readme to reflect api key: 2012-06-02 04:19:02 +08:00			`* Users are authenticated over OAuth or via an API KEY.`
			`* Authenticated requests to this API should always be made over SSL.`
first draft, tidied, unit tests, modules, refactor, environments, see TODO for next steps" 2011-06-13 11:23:02 +08:00
update readme 2011-10-08 00:19:02 +08:00
update gitignore 2011-06-30 19:13:13 +08:00			`core requirements`
			`-------------`
Add versions for postgresql and cartodb requirements This is because the CDB_QueryTables is used by the core: is provided by CartoDB and only works with PostgreSQL 9.0+ 2012-07-13 04:05:09 +08:00			`* postgres 9.0+`
			`* cartodb 0.9.5+ (for CDB_QueryTables)`
update gitignore 2011-06-30 19:13:13 +08:00			`* redis`
node v0.6 compatibility 2012-03-16 20:50:07 +08:00			`* node >v0.4.8 && < 0.7.0>`
update gitignore 2011-06-30 19:13:13 +08:00			`* npm`

wrap to 80 cols 2012-03-14 02:32:01 +08:00			`usage`
			`-----`

Add configuration step 2012-03-16 17:31:03 +08:00			`Edit config/environments/<environment>.js`
wrap to 80 cols 2012-03-14 02:32:01 +08:00			`Make sure redis is running and knows about active cartodb user.`

			``` bash
Add configuration step 2012-03-16 17:31:03 +08:00			`node [cluster.js\|app.js] <environment>`
wrap to 80 cols 2012-03-14 02:32:01 +08:00			```

Add configuration step 2012-03-16 17:31:03 +08:00			`Supported <environment> values are developement, test, production`

wrap to 80 cols 2012-03-14 02:32:01 +08:00			`for examples of use, see /tests`

added initial capistrano files, and gem file 2011-06-30 20:06:23 +08:00
update readme and bump node deps to allow 0.6 2012-03-16 18:46:34 +08:00			`Install dependencies`
update readme 2011-10-08 00:19:02 +08:00			`---------------------`
update gitignore 2011-06-30 19:13:13 +08:00
update readme 2011-10-08 00:19:02 +08:00			```bash
			`npm install`
			```
update gitignore 2011-06-30 19:13:13 +08:00
Remove debug statement 2011-07-01 00:10:10 +08:00
update readme 2011-10-08 00:19:02 +08:00			`tests`
			`------`
merge conflicts 2012-03-16 18:47:10 +08:00			`see test/README.md`
notes on node 0.4 2012-03-16 21:18:43 +08:00

			`note on 0.4.x`
			`--------------`
Add versions for postgresql and cartodb requirements This is because the CDB_QueryTables is used by the core: is provided by CartoDB and only works with PostgreSQL 9.0+ 2012-07-13 04:05:09 +08:00			`output of large result sets is slow under node 0.4. Recommend running under 0.6 where possible.`