Quickstart: Use Azure Cosmos DB for NoSQL with Azure SDK for Node.js

In this quickstart, you deploy a basic Azure Cosmos DB for Table application using the Azure SDK for Node.js. Azure Cosmos DB for Table is a schemaless data store allowing applications to store structured table data in the cloud. You learn how to create tables, rows, and perform basic tasks within your Azure Cosmos DB resource using the Azure SDK for Node.js.

API reference documentation | Library source code | Package (npm) | Azure Developer CLI

Prerequisites

• Azure Developer CLI
• Docker Desktop
• Node.js 22 or newer

If you don't have an Azure account, create a Trial before you begin.

Initialize the project

Use the Azure Developer CLI (azd) to create an Azure Cosmos DB for Table account and deploy a containerized sample application. The sample application uses the client library to manage, create, read, and query sample data.

1. Open a terminal in an empty directory.

2. If you're not already authenticated, authenticate to the Azure Developer CLI using azd auth login. Follow the steps specified by the tool to authenticate to the CLI using your preferred Azure credentials.

   azd auth login
   

3. Use azd init to initialize the project.

   azd init --template cosmos-db-nosql-nodejs-quickstart
   

4. During initialization, configure a unique environment name.

5. Deploy the Azure Cosmos DB account using azd up. The Bicep templates also deploy a sample web application.

   azd up
   

6. During the provisioning process, select your subscription, desired location, and target resource group. Wait for the provisioning process to complete. The process can take approximately five minutes.

7. Once the provisioning of your Azure resources is done, a URL to the running web application is included in the output.

   Deploying services (azd deploy)
   
     (✓) Done: Deploying service web
   - Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>
   
   SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.
   

8. Use the URL in the console to navigate to your web application in the browser. Observe the output of the running app.

Install the client library

The client library is available through the Node Package Manager, as the @azure/cosmos package.

1. Open a terminal and navigate to the /src folder.

   cd ./src
   

2. If not already installed, install the @azure/cosmos package using npm install.

   npm install --save @azure/cosmos
   

3. Also, install the @azure/identity package if not already installed.

   npm install --save @azure/identity
   

4. Open and review the src/package.json file to validate that the azure-cosmos and azure-identity entries both exist.

Object model

Code examples

• Authenticate the client
• Get a database
• Get a container
• Create an item
• Get an item
• Query items

The sample code in the template uses a database named cosmicworks and container named products. The products container contains details such as name, category, quantity, a unique identifier, and a sale flag for each product. The container uses the /category property as a logical partition key.

Authenticate the client

This sample creates a new instance of the CosmosClient type and authenticates using a DefaultAzureCredential instance.

const credential = new DefaultAzureCredential();

const client = new CosmosClient({
    '<azure-cosmos-db-nosql-account-endpoint>',
    aadCredentials: credential
});

const credential: TokenCredential = new DefaultAzureCredential();

const client = new CosmosClient({
    '<azure-cosmos-db-nosql-account-endpoint>',
    aadCredentials: credential
});

Get a database

Use client.database to retrieve the existing database named cosmicworks.

const database = client.database('cosmicworks');

const database: Database = client.database('cosmicworks');

Get a container

Retrieve the existing products container using database.container.

const container = database.container('products');

const container: Container = database.container('products');

Create an item

Build a new object with all of the members you want to serialize into JSON. In this example, the type has a unique identifier, and fields for category, name, quantity, price, and sale. Create an item in the container using container.items.upsert. This method "upserts" the item effectively replacing the item if it already exists.

const item = {
    'id': 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    'category': 'gear-surf-surfboards',
    'name': 'Yamba Surfboard',
    'quantity': 12,
    'price': 850.00,
    'clearance': false
};

let response = await container.items.upsert(item);

const item: Product = {
    'id': 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    'category': 'gear-surf-surfboards',
    'name': 'Yamba Surfboard',
    'quantity': 12,
    'price': 850.00,
    'clearance': false
};

let response: ItemResponse<Product> = await container.items.upsert<Product>(item);

Read an item

Perform a point read operation by using both the unique identifier (id) and partition key fields. Use container.item to get a pointer to an item and item.read to efficiently retrieve the specific item.

const id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb';
const partitionKey = 'gear-surf-surfboards';

let response = await container.item(id, partitionKey).read();
let read_item = response.resource;

const id = 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb';
const partitionKey = 'gear-surf-surfboards';

let response: ItemResponse<Product> = await container.item(id, partitionKey).read<Product>();
let read_item: Product = response.resource!;

Query items

Perform a query over multiple items in a container using container.items.query. Find all items within a specified category using this parameterized query:

SELECT * FROM products p WHERE p.category = @category

Fetch all of the results of the query using query.fetchAll. Loop through the results of the query.

const querySpec = {
    query: 'SELECT * FROM products p WHERE p.category = @category',
    parameters: [
        {
            name: '@category',
            value: 'gear-surf-surfboards'
        }
    ]
};

let response = await container.items.query(querySpec).fetchAll();
for (let item of response.resources) {
    // Do something
}

const querySpec: SqlQuerySpec = {
    query: 'SELECT * FROM products p WHERE p.category = @category',
    parameters: [
        {
            name: '@category',
            value: 'gear-surf-surfboards'
        }
    ]
};

let response: FeedResponse<Product> = await container.items.query<Product>(querySpec).fetchAll();
for (let item of response.resources) {
    // Do something
}

Clean up resources

When you no longer need the sample application or resources, remove the corresponding deployment and all resources.

azd down

Related content

• .NET Quickstart
• Java Quickstart
• Python Quickstart
• Go Quickstart