Jsonotron-cosmosdb NPM

A wrapper that allows Cosmos DB to be used as a document store for Jsonotron

A wrapper for Azure Cosmos DB that implements the Jsonotron document store interface.

This package is part of the Jsonotron system.
Jsonotron is...
a small set of components for building a NodeJS microservice
for storing, patching and querying JSON documents
stored in a schemaless/NoSQL database
that have known, enforceable, and evolving schemas.
Visit https://karlhulme.github.io/jsonotron/ for details on how to get started.

Installation

npm install jsonotron-cosmosdb --save

Usage

To instantiate a CosmosDbDocStore you have to provide 3 parameters:

cosmosUrl - A url that identifies your Cosmos DB instance.
cosmosKey - A master key with read and write access to your Cosmos DB instance.
config - A configuration object
- getDatabaseName - A function (docTypeName, docTypePluralName, options) that returns the name of the database to connect to.
- getContainerName - A function getContainerName (databaseName, docTypeName, docTypePluralName, options) that returns the name of the container to edit.
- getPartitionKey - A function (databaseName, containerName, docTypeName, docTypePluralName, id, options) that returns the value of the containers partition key. Typically this will return the id or something from the options object that has been populated by the Jsonotron interface. For example, the Jsonotron-Express library will place the additional path components (for example the tenant ID) into the options for use here.

const { createCosmosDbDocStore } = require('jsonotron-cosmosdb')

const cosmosDbDocStore = createCosmosDbDocStore({
  cosmosUrl: 'https://documents.azure...',
  cosmosKey: 'ABCD_KEY_FROM_AZURE_PORTAL',
  config: {
    getDatabaseName: (docTypeName, docTypePluralName, options) => 'myDatabase',
    getContainerName: (databaseName, docTypeName, docTypePluralName, options) => 'myContainer',
    getPartitionKey: (databaseName, containerName, docTypeName, docTypePluralName, id, options) => id
  }
)

cosmosDbDocStore.upsert('test', 'tests', {
  id: '0001',
  docType: 'test',
  docOps: [],
  hello: 'world'
})