socrata / Soda Js

h1. soda-js "!https://secure.travis-ci.org/socrata/soda-js.png!":http://travis-ci.org/socrata/soda-js

A client implementation of the Socrata Open Data API in Coffeescript and Javascript.

h2. Important Note

In order to access the SODA API via HTTPS, clients must now "support the Server Name Indication (SNI)":https://dev.socrata.com/changelog/2016/08/24/sni-now-required-for-https-connections.html extension to the TLS protocol. What does this mean? It means that if you're using @soda-js@, you must use a JavaScript VM that supports SNI:

• "Internet Explorer 7+":https://en.wikipedia.org/wiki/Server_Name_Indication#Support
• "Mozilla Firefox 2+":https://en.wikipedia.org/wiki/Server_Name_Indication#Support
• "Apple Safari (all versions)":https://en.wikipedia.org/wiki/Server_Name_Indication#Support
• "Google Chrome 6.0+":https://en.wikipedia.org/wiki/Server_Name_Indication#Support
• "node.js 0.5.3+":https://github.com/nodejs/node/blob/e1643ccc5a5ecf7cb779472d244459469c9971a1/doc/changelogs/CHANGELOG_ARCHIVE.md#20110801-version-053-unstable

h2. Supported Operations

Supports both consumer and producer API, but does not currently support creating datasets or the import workflow.

h2. Usage

See the @sample/@ directory for sample code, but here's the general idea:

bc.. var soda = require('soda-js');

h3. Consumer API

You can query a dataset by SODA2 clauses, or supply a custom SoQL query to be run.

bc.. var consumer = new soda.Consumer('explore.data.gov');

consumer.query() .withDataset('644b-gaut') .limit(5) .where({ namelast: 'SMITH' }) .order('namelast') .getRows() .on('success', function(rows) { console.log(rows); }) .on('error', function(error) { console.error(error); });

p. Using 'like' in a where clause:

bc.. .where("namelast like '%MITH'")

h3. Producer API

You can add, update, replace, delete, and upsert rows, as well as truncate a dataset.

bc.. var producer = new soda.Producer('sandbox.demo.socrata.com', sodaConnectionOptions);

var data = { mynum : 42, mytext: "hello world" }

producer.operation() .withDataset('rphc-ayt9') .add(data) .on('success', function(row) { console.log(row); }) .on('error', function(error) { console.error(error); })

h2. License

Provided under the MIT license.