spatney/documentdb-util

A simple wrapper utility around documentdb to perform common docdb operations

Document DB Utility

Here are some examples on how to use this Utility. Note, await is only avaliable as an experimental feature in Node. Each function returns a promise, so you can simple chain promises instead of using await.

Initialize the library

var DocumentDbUtility = require('documentdb-util');
var dbUtil = new DocumentDbUtility({authKey:'KEY', host:'URL TO DOCDB'}));

Get or Create Database

await dbUtil.database('test');

Get or Create Collection

let collection = await dbUtil.collection(database, 'people');

List Collections

let collections = await dbUtil.listCollections(database);

Insert Document

await dbUtil.insert(collection, {
        name:'penguin',
        profession: 'good guy'
    });

Query for Documents

let spec = {
        query: 'Select * from c where c.name = @name',
        parameters:[
            {
                name:'@name',
                value: 'penguin'
            }
        ]
    }

let docs = await dbUtil.query(collection, spec);

Update Document

let doc = (await dbUtil.query(collection, spec))[0];
doc.profession = "bad guy";

let docLink = dbUtil.createDocumentLink(database.id, collection.id, doc.id);

await dbUtil.update(docLink, doc);

Create & execute Stored Procedure

let proc = {
    id:"summer",
    serverScript: function(a,b){
        var context = getContext();
        var response = context.getResponse();
        let sum = a + b;
        response.setBody(sum);
    }
}

let procInstance = await dbUtil.createStoredProcedure(collection, proc);
let result = await dbUtil.executeStoredProcedure(procInstance,[1,2]);

Create & execute Triggers

let database = await dbUtil.database('test');
let collection = await dbUtil.collection(database, 'people');

let superTimeTrigger = {
    id: "validateDocumentContents",
    serverScript: function validate() {
        var context = getContext();
        var request = context.getRequest();
        var documentToCreate = request.getBody();
        var ts = new Date();
        documentToCreate["supertime"] = ts.getTime();
        request.setBody(documentToCreate);
    },
    triggerType: 'Pre',
    triggerOperation: 'Create'
}

let triggerInstance = await dbUtil.trigger(collection, superTimeTrigger);

await dbUtil.insert(collection, {
    name: 'penguin',
    profession: 'better guy',
    income: 200
}, { preTriggerInclude: [superTimeTrigger.id] });

Create & execute User Defined Functions

var taxUdf = {
    id: "tax",
    serverScript: function tax(income) {

        if (income == undefined)
            throw 'no input';

        if (income < 1000)
            return income * 0.1;
        else if (income < 10000)
            return income * 0.2;
        else
            return income * 0.4;
    }
}

let udf = await dbUtil.userDefinedFunction(collection, taxUdf);
await dbUtil.insert(collection, {
    name: 'boomer',
    profession: 'rich guy',
    income: 10000
});

let spec2 = {
    query: 'Select * from c WHERE udf.tax(c.income) > @taxAmount',
    parameters: [
        {
            name: '@taxAmount',
            value: 3000
        }
    ]
}

let doc2 = await dbUtil.query(collection, spec2);

Delete Document

let docLink = dbUtil.createDocumentLink(database.id, collection.id, doc.id);

await dbUtil.delete(docLink);

Delete Database

await dbUtil.deleteDatabase('name');

Delete Collection

await dbUtil.deleteCollection('dbName','collectionName');

documentdb-util's Issues

createStoredProcedure() in your example doesn't exist in DocumentDbUtility

createStoredProcedure() in your example doesn't exist in DocumentDbUtility and storedProcedure returns a bad request when you call it like you're trying in your documentation. Could this be updated?

Thanks,

Brian

Unexpected identifier on "await dbUtil.database('mydatabase');"

Hi, just wondering if anyone knows what's wrong here?

With simply the following it's failing with 'Unexpected identifier' on the dbUtil object. I tested on node version 8.9 and 8.9.1 with documentdb and documentdb-util installed.

var DocumentDbUtility = require("documentdb-util");
var dbUtil = new DocumentDbUtility({authKey: 'xxx' host: 'xxx'});
let database = await dbUtil.database('newzible-test');
                     ^^^^^

SyntaxError: Unexpected identifier
at createScript (vm.js:80:10)
at Object.runInThisContext (vm.js:139:10)
at Module._compile (module.js:599:28)
at Object.Module._extensions..js (module.js:646:10)