Skip to content

Latest commit

 

History

History
174 lines (131 loc) · 8.23 KB

documentdb-sdk-node.md

File metadata and controls

174 lines (131 loc) · 8.23 KB
title description services documentationcenter author manager editor ms.assetid ms.service ms.workload ms.tgt_pltfrm ms.devlang ms.topic ms.date ms.author
DocumentDB Node.js API & SDK | Microsoft Docs
Learn all about the Node.js API and SDK including release dates, retirement dates, and changes made between each version of the DocumentDB Node.js SDK.
documentdb
nodejs
rnagpal
jhubbard
cgronlun
9d5621fa-0e11-4619-a28b-a19d872bcf37
documentdb
data-services
na
nodejs
article
12/22/2016
rnagpal

DocumentDB APIs and SDKs

[!div class="op_single_selector"]

DocumentDB Node.js API and SDK

**Download SDK**[NPM](https://www.npmjs.com/package/documentdb)
**API documentation**[Node.js API reference documentation](http://azure.github.io/azure-documentdb-node/DocumentClient.html)
**SDK installation instructions**[Installation instructions](http://azure.github.io/azure-documentdb-node/)
**Contribute to SDK**[GitHub](https://github.com/Azure/azure-documentdb-node/tree/master/source)
**Samples**[Node.js code samples](documentdb-nodejs-samples.md)
**Get started tutorial**[Get started with the Node.js SDK](documentdb-nodejs-get-started.md)
**Web app tutorial**[Build a Node.js web application using DocumentDB](documentdb-nodejs-application.md)
**Current supported platform**[Node.js v0.10](https://nodejs.org/en/blog/release/v0.10.0/)
[Node.js v0.12](https://nodejs.org/en/blog/release/v0.12.0/)
[Node.js v4.2.0](https://nodejs.org/en/blog/release/v4.2.0/)

Release notes

1.10.1

  • Disabling SSL verification when using the SDK to target the emulator(hostname=localhost).
  • Added support for enabling script logging during stored procedure execution.

1.10.0

  • Added support for cross partition parallel queries.
  • Added support for TOP/ORDER BY queries for partitioned collections.

1.9.0

  • Added retry policy support for throttled requests. (Throttled requests receive a request rate too large exception, error code 429.) By default, DocumentDB retries nine times for each request when error code 429 is encountered, honoring the retryAfter time in the response header. A fixed retry interval time can now be set as part of the RetryOptions property on the ConnectionPolicy object if you want to ignore the retryAfter time returned by server between the retries. DocumentDB now waits for a maximum of 30 seconds for each request that is being throttled (irrespective of retry count) and returns the response with error code 429. This time can also be overriden in the RetryOptions property on ConnectionPolicy object.
  • DocumentDB now returns x-ms-throttle-retry-count and x-ms-throttle-retry-wait-time-ms as the response headers in every request to denote the throttle retry count and the cummulative time the request waited between the retries.
  • The RetryOptions class was added, exposing the RetryOptions property on the ConnectionPolicy class that can be used to override some of the default retry options.

1.8.0

  • Added the support for multi-region database accounts.

1.7.0

  • Added the support for Time To Live(TTL) feature for documents.

1.6.0

1.5.6

  • Fixed RangePartitionResolver.resolveForRead bug where it was not returning links due to a bad concat of results.

1.5.5

  • Fixed hashParitionResolver resolveForRead(): When no partition key supplied was throwing exception, instead of returning a list of all registered links.

1.5.4

  • Fixes issue #100 - Dedicated HTTPS Agent: Avoid modifying the global agent for DocumentDB purposes. Use a dedicated agent for all of the lib’s requests.

1.5.3

  • Fixes issue #81 - Properly handle dashes in media ids.

1.5.2

  • Fixes issue #95 - EventEmitter listener leak warning.

1.5.1

  • Fixes issue #92 - rename folder Hash to hash for case sensitive systems.

1.5.0

  • Implement sharding support by adding hash & range partition resolvers.

1.4.0

  • Implement Upsert. New upsertXXX methods on documentClient.

1.3.0

  • Skipped to bring version numbers in alignment with other SDKs.

1.2.2

  • Split Q promises wrapper to new repository.
  • Update to package file for npm registry.

1.2.1

  • Implements ID Based Routing.
  • Fixes Issue #49 - current property conflicts with method current().

1.2.0

  • Added support for GeoSpatial index.
  • Validates id property for all resources. Ids for resources cannot contain ?, /, #, //, characters or end with a space.
  • Adds new header "index transformation progress" to ResourceResponse.

1.1.0

  • Implements V2 indexing policy.

1.0.3

  • Issue #40 - Implemented eslint and grunt configurations in the core and promise SDK.

1.0.2

  • Issue #45 - Promises wrapper does not include header with error.

1.0.1

  • Implemented ability to query for conflicts by adding readConflicts, readConflictAsync, and queryConflicts.
  • Updated API documentation.
  • Issue #41 - client.createDocumentAsync error.

1.0.0

  • GA SDK.

Release & Retirement Dates

Microsoft will provide notification at least 12 months in advance of retiring an SDK in order to smooth the transition to a newer/supported version.

New features and functionality and optimizations are only added to the current SDK, as such it is recommend that you always upgrade to the latest SDK version as early as possible.

Any request to DocumentDB using a retired SDK will be rejected by the service.


Version Release Date Retirement Date
1.10.1 December 22, 2016 ---
1.10.0 October 03, 2016 ---
1.9.0 July 07, 2016 ---
1.8.0 June 14, 2016 ---
1.7.0 April 26, 2016 ---
1.6.0 March 29, 2016 ---
1.5.6 March 08, 2016 ---
1.5.5 February 02, 2016 ---
1.5.4 February 01, 2016 ---
1.5.2 January 26, 2016 ---
1.5.2 January 22, 2016 ---
1.5.1 January 4, 2016 ---
1.5.0 December 31, 2015 ---
1.4.0 October 06, 2015 ---
1.3.0 October 06, 2015 ---
1.2.2 September 10, 2015 ---
1.2.1 August 15, 2015 ---
1.2.0 August 05, 2015 ---
1.1.0 July 09, 2015 ---
1.0.3 June 04, 2015 ---
1.0.2 May 23, 2015 ---
1.0.1 May 15, 2015 ---
1.0.0 April 08, 2015 ---

FAQ

[!INCLUDE documentdb-sdk-faq]

See also

To learn more about DocumentDB, see Microsoft Azure DocumentDB service page.