Microsoft Azure Cosmos JavaScript SDK

This project provides JavaScript & Node.js SDK library for SQL API of Azure Cosmos Database Service. This project also includes samples, tools, and utilities.

Useful links:

• Welcome to Azure Cosmos DB
• Quick start
• Tutorial
• Samples
• Introduction to Resource Model of Azure Cosmos DB Service
• Introduction to SQL API of Azure Cosmos DB Service
• Partitioning
• API Documentation

Installation

Prerequisites

Install Node.js and npm https://docs.npmjs.com/getting-started/installing-node

Node SDK can be consumed in two ways.

Install Core Module Published to NPM

The core module uses the callbacks model for responses, exposed through the DocumentClient

npm install @azure/cosmos

Prerequisites

To use the SDK, first create an account and follow tutorial.

Note:

When connecting to the emulator from the SDK, SSL verification is disabled.

Follow these instructions to run the tests locally.

Tests

Prerequisites

1. Clone Azure/azure-cosmos-js repository

   git clone https://github.com/azure/azure-cosmos-js.git
   

2. Install Node.js and npm https://docs.npmjs.com/getting-started/installing-node

3. Cosmos DB emulator

   • Note: requires a windows machine or ability to run Windows container

4. Install dependencies

   npm i     # alias for npm install
   

5. Build the source

   npm run build   # compiles the typescript source, runs linting, creates webpack, creates docs
   

Running the tests

npm run test    # runs all tests

Examples

Hello World

import { CosmosClient } from "@azure/cosmos"

const host = "[hostendpoint]";                     // Add your endpoint
const masterKey = "[database account masterkey]";  // Add the masterkey of the endpoint
const client = new CosmosClient(host, { masterKey });

var databaseDefinition = { id: "sample database" };
var collectionDefinition = { id: "sample collection" };
var documentDefinition = { id: "hello world doc", content: "Hello World!" };

async function helloCosmos() {
    await client.createDatabase(databaseDefinition);
    console.log('created db');

    await client.createCollection(database._self, collectionDefinition);
    console.log('created collection');

    await client.createDocument(collection._self, documentDefinition);
    console.log('Created Document with content: ', document.content);

    await client.deleteDatabase(database._self);
    console.log("Deleted database");
});

helloCosmos().finally(()=>{});

Youtube Videos

Getting started with Node.js SDK:

Need Help?

Be sure to check out the Microsoft Azure Developer Forums on MSDN or the Developer Forums on Stack Overflow if you have trouble with the provided code.

Contribute Code or Provide Feedback

If you would like to become an active contributor to this project please follow the instructions provided in Azure Projects Contribution Guidelines.

If you encounter any bugs with the library please file an issue in the Issues section of the project.