documentdb-nodejs-samples.md

DocumentDB Node.js examples

[AZURE.SELECTOR]

• .NET Examples
• Node.js Examples
• Azure Code Sample Gallery

Sample solutions that perform CRUD operations and other common operations on DocumentDB resources are included in the azure-documentdb-nodejs GitHub repository. This article provides:

• Links to the tasks in each of the Node.js example project files.
• Links to the related API reference content.

Prerequisites

1. You need an Azure account to use these Node.js examples:

   • You can open an Azure account for free: You get credits you can use to try out paid Azure services, and even after they're used up you can keep the account and use free Azure services, such as Websites. Your credit card will never be charged, unless you explicitly change your settings and ask to be charged.
   • You can activate Visual Studio subscriber benefits: Your Visual Studio subscription gives you credits every month that you can use for paid Azure services.

2. You also need the Node.js SDK.

   [AZURE.NOTE] Each sample is self-contained, it sets itself up and cleans up after itself. As such, the samples issue multiple calls to DocumentClient.createCollection. Each time this is done your subscription will be billed for 1 hour of usage per the performance tier of the collection being created.

Database examples

The app.js file of the DatabaseManagement project shows how to perform the following tasks.

Task	API reference
Create a database	DocumentClient.createDatabase
Query an account for a database	DocumentClient.queryDatabases
Read a database by Id	DocumentClient.readDatabase
List databases for an account	DocumentClient.readDatabases
Delete a database	DocumentClient.deleteDatabase

Collection examples

The app.js file of the CollectionManagement project shows how to perform the following tasks.

Task	API reference
Create a collection	DocumentClient.createCollection
Read a list of all collections in a database	DocumentClient.listCollections
Get a collection by _self	DocumentClient.readCollection
Get a collection by Id	DocumentClient.readCollection
Get performance tier of a collection	DocumentQueryable.queryOffers
Change performance tier of a collection	DocumentClient.replaceOffer
Delete a collection	DocumentClient.deleteCollection

Document examples

The app.js file of the DocumentManagement project shows how to perform the following tasks.

Task	API reference
Create documents	DocumentClient.createDocument
Read the document feed for a collection	DocumentClient.readDocument
Read a document by ID	DocumentClient.readDocument
Read document only if document has changed	DocumentClient.readDocument RequestOptions.accessCondition
Query for documents	DocumentClient.queryDocuments
Replace a document	DocumentClient.replaceDocument
Replace document with conditional ETag check	DocumentClient.replaceDocument RequestOptions.accessCondition
Delete a document	DocumentClient.deleteDocument

Indexing examples

The app.js file of the IndexManagement project shows how to perform the following tasks.

Task	API reference
Create a collection with default indexing	DocumentClient.createDocument
Manually index a specific document	indexingDirective: 'include'
Manually exclude a specific document from the index	RequestOptions.indexingDirective
Use lazy indexing for bulk import or read heavy collections	IndexingMode.Lazy
Include specific paths of a document in indexing	IndexingPolicy.IncludedPaths
Exclude certain paths from indexing	ExcludedPath
Allow a scan on a string path during a range operation	ExcludedPath.EnableScanInQuery
Create a range index on a string path	DocumentClient.queryDocument
Create a collection with default indexPolicy, then update this online	DocumentClient.createCollection DocumentClient.replaceCollection#replaceCollection

For more information about indexing, see DocumentDB indexing policies.

Server-side programming examples

The app.js file of the ServerSideScripts project shows how to perform the following tasks.

Task	API reference
Create a stored procedure	DocumentClient.createStoredProcedure
Execute a stored procedure	DocumentClient.executeStoredProcedure

For more information about server-side programming, see DocumentDB server-side programming: Stored procedures, database triggers, and UDFs.

Partitioning examples

The app.js file of the Partitioning project shows how to perform the following tasks.

Task	API reference
Use a HashPartitionResolver	HashPartitionResolver

For more information about partitioning data in DocumentDB, see Partition and scale data in DocumentDB.