orc-csv v0.2.0

orc-csv

Upload CSVs to Orchestrate. Comes with a simple web server for exploring datasets.

Install

npm install -g orc-csv

Usage

Upload CSVs

You can use pipes to feed orc-csv data...

cat path/to/file.csv | orc-csv -u YOUR_API_KEY -d DATACENTER_HOST -c COLLECTION_NAME

... or pass files as an argument:

orc-csv -u YOUR_API_KEY -d DATACENTER_HOST -f path/to/file.csv -c COLLECTION_NAME

Either will transform the CSV's contents into JSON objects, and upload them to Orchestrate. For example, this...

name,role,aptitude,aptitude as a cold-blooded killer
Catherine,technical writer,9,3
Diana,programmer,6,10

... would insert two documents that look like this:

{
    "name":"Catherine",
    "role":"technical writer",
    "aptitude":9,
    "aptitude as a cold-blooded killer":3
}
{
    "name":"Diana",
    "role":"programmer",
    "aptitude":6,
    "aptitude as a cold-blooded killer":10
}

Explore Data

To explore your data locally, start orc-csv's web server:

orc-csv server -u YOUR_API_KEY -d DATACENTER_HOST -c COLLECTION_NAME
# now listening on port 3000

The server proxies all requests to Orchestrate using your API key, so you can explore your data right from your browser.

Use Programmatically

You can require and use orc-csv from other packages. Install like this:

npm install orc-csv

Use like this:

var orc_csv = require('orc-csv');

// upload a file
orc_csv({
    collection: 'razzamatazz'
}).upload({
    auto_parse: true
}).file(PATH_TO_FILE)
.fin(function () {
    console.log('Upload complete');
});

// upload a stream
var stream = fs.createReadStream(PATH_TO_FILE);
orc_csv({
    collection: 'razzamatazz'
}).upload({
    delimiter: ';'
}).stream(stream)
.fin(function () {
    console.log('Upload complete');
});

// start the web server
orc_csv({
    collection: 'razzamatazz'
}).server({
    port: 5000
})
.then(function (server) {
    console.log('Listening on port 5000');
});

Both of orc_csv's upload methods return kew promises.

Options

-u, --api-key

The API key used to authenticate requests with Orchestrate. Defaults to the environment variable ORCHESTRATE_API_KEY.

-d, --datacenter

The datacenter endpoint to communicate with (i.e. api.ctl-uc1-a.orchestrate.io). Defaults to the environment variable ORCHESTRATE_API_HOST.

-f, --file

The path to the file to upload to Orchestrate.

-c, --collection

The name of the collection to upload objects to, or to read objects from if starting the web server.

-p, --port

The port to start the server on. Only used by orc-csv server.

CSV options

orc-csv supports all configuration options that node-csv-parser accepts. See them all.

For example, this sets the CSV delimiter to be ";":

orc-csv -u $API_KEY -d $DATACENTER_HOST -f $CSV_PATH --delimiter ";"

Tests

npm test

License

ASLv2