TypeScript JavaScript

README.md

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.

latest npm badge

// JavaScript
const cosmos = require('@azure/cosmos');
const CosmosClient = cosmos.CosmosClient;

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

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

async function helloCosmos() {
  const { database: db } = await client.databases.create(databaseDefinition);
  console.log('created db');

  const { container } = await db.containers.create(collectionDefinition);
  console.log('created collection');

  const { body } = await container.items.create(documentDefinition);
  console.log('Created item with content: ', body.content);

  await db.delete();
  console.log('Deleted database');
}

helloCosmos().catch(err => {
  console.error(err);
});

Useful links

Installation

Prerequisites

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

The SDK is not supported in Node v4 or below. Those Node.js versions are out of support and not recommended for production. Our support will only cover maintained versions of Node.js.

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.

Install

npm install @azure/cosmos

Tests

Prerequisites

  1. Clone Azure/azure-cosmos-js repository

    git clone https://github.com/azure/azure-cosmos-js.git
  2. Install Node.js 6 or above 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

Need Help?

Tweet us with #CosmosDB and we'll respond on Twitter. 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.