Skip to content

Latest commit

 

History

History
1372 lines (1032 loc) · 132 KB

changelog.md

File metadata and controls

1372 lines (1032 loc) · 132 KB
Raw

Recommended version

The minimum recommended version is 3.35.4.

Make sure that your applications, when using the .NET V3 SDK, are using at least the version described here to have all the critical fixes.

Any known issues detected on that version are listed in the known issues section.

Release notes

Preview features are treated as a separate branch and will not be included in the official release until the feature is ready. Each preview release lists all the additional features that are enabled.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

3.40.0-preview.0 - 2024-04-05

Fixed

  • 4334 ChangeFeedProcessor: Fixes when ChangeFeedMode is switched, an exception is thrown

Added

  • 4370 ChangeFeedProcessor: Adds AllVersionsAndDeletes support to ChangeFeedProcessor
  • 4380 ChangeFeedProcessor: Refactors AllVersionsAndDeletes Metadata Contract for ChangeFeed and ChangeFeedProcessor

    Note: A Rename refactoring was performed in the effort to reduce redundancy and achieve clarity from a user perspective. The previous type ChangeFeedItemChange<T> was strategically renamed to ChangeFeedItem<T>. The refactoring affects both ChangeFeed (pull), and the new ChangeFeedProcessor (push), when in AllVersionsAndDeletes ChangeFeedMode. LatestVersion ChangeFeedMode is not affected and will continue to function as expected.

3.39.0 - 2024-04-05

Fixed

  • 4357 Distributed Tracing Documentation : Fixes the default value mentioned in code doc

Added

  • 4377 Integrated cache: Adds BypassIntegratedCache for public release
  • 4265 CosmosClientOptions: Adds Private Custom Account Endpoints
  • 4316 Distributed Tracing: Refactors code to rename net.peer.name attribute to server.address. Warning: This is a breaking change, only server.address will be emitted starting with this version.
  • 4339 Diagnostics: Adds Client Configuration for Synchronization context cases
  • 4333 Distributed Tracing: Adds configuration to disable network level tracing in sdk permanently
  • 4323 Query: Adds Support for LINQ Custom Serializer in Public Release
  • 4362 Query: Adds support for non streaming ORDER BY
  • 4074 Query: Adds translation support for single key single value select GROUP BY LINQ queries
  • 4361 Performance: Refactors query prefetch mechanism
  • 4386 Regions: Adds new Regions

    Note: There is added support for the following regions: Taiwan North and Taiwan Northwest. This also includes a Direct Package version update to 3.33.0 in PR #4353

3.39.0-preview.1 - 2024-02-02

3.38.1 - 2024-02-02

Fixed

  • 4294 DisableServerCertificateValidation: Fixes Default HttpClient to honor DisableServerCertificateValidation (#4294)

Added

  • 4299 Query: Adds environment variable for overriding EnableOptimisticDirectExecution default (#4299)

    Note: This change provides another way to manage the upgrade to 3.38. It provides an option to avoid potential disruption due to the breaking change (see the note below) if only config deployment is preferred, instead of any explicit code modification. With this change, users can set the environment variable AZURE_COSMOS_OPTIMISTIC_DIRECT_EXECUTION_ENABLED to false in their production environments while upgrading from previous minor version (3.37 or below) to 3.38.1 (or above). This will signal the SDK to disable Optimistic Direct Execution by default. Once the environment is fully upgraded to the target version, the environment variable can be removed (or set to true) to enable ODE. It is recommended that the environment variable is used only to manage the upgrade and removed once the deployment is complete. Please note that environment variable acts as the override only for choosing the default value. If the code explicitly modifies the setting, that value will be honored during actual operations.

3.39.0-preview.0 - 2024-01-31

Added

  • 4138 Query: Adds support for LINQ Custom Serializer (#4138)

3.38.0 - 2024-01-31

⚠️ Note: Starting with version 3.38.0, the .NET SDK enables the ODE feature by default. This can potentially cause a new type of continuation token to be generated. Such a token is not recognized by the older SDKs by design and this could result in a Malformed Continuation Token Exception. If you have a scenario where tokens generated from the newer SDKs are used by an older SDK, we recommend a 2 step approach to upgrade:

  • Upgrade to the new SDK and disable ODE, both together as part of a single deployment. Wait for all nodes to upgrade.
    • In order to disable ODE, set EnableOptimisticDirectExecution to false in the QueryRequestOptions.
  • Enable ODE as part of second deployment for all nodes.

Fixed

  • 4205 ClientRetryPolicy: Fixes Metadata Requests Retry Policy (#4205)
  • 4220 Change Feed Processor: Fixes disposal of unused CancellationTokenSource (#4220)
  • 4229 GatewayClientStore: Fixes an issue with dealing with invalid JSON HTTP responses (#4229)
  • 4260 Query: Fixes LINQ Translation of SqlNullLiteral Values (#4260)
  • 4276 Change Feed Processor: Fixes LeaseLostException on Notifications API for Renewer (#4276)
  • 4241 GlobalEndpointManager: Fixes Unobserved and Unhandled Exception from Getting Thrown (#4241)

Added

  • 4122 Query: Adds Optimistic Direct Execution configuration override support on the Client (#4122)
  • 4240 BulkMode: Adds PartitionKeyRangeId in Bulk Mode and TransactionalBatch Response Headers (#4240)
  • 4252 Query: Adds Request Charge to Query Metrics (#4252)
  • 4225 Query: Refactors Optimistic Direct Execution to be turned on by default on .NET SDK (#4225). WARNING: This is breaking change for GA. For more details, please take a look at the 3.38.0 Note section.
  • 4251 Emulator : Adds support for flag in connection string to ignore SSL check (#4251)
  • 4279 Region Availability: Adds Spain Central and Mexico Central Regions For Public Usage (#4279)
  • 4286 Query: Adds LINQ Support for FirstOrDefault (#4286)
  • 4262 PriorityBasedExecution: Adds PriorityLevel in CosmosClientOptions (#4262)

3.37.1-preview - 2024-1-2

3.37.1 - 2024-1-2

Fixed

  • 4226 GlobalEndpointManager: Fixes Memory Leak (#4226)

3.37.0-preview - 2023-11-17

3.37.0 - 2023-11-17

Fixed

  • 4100 Query : Fixes querying conflicts (#4100)
  • 4125 Item Operations: Fixes JsonSerialization exception when MissingMemberHandling = Error on Json default settings when NotFound on Item operations (#4125)

Added

  • 4180 Upgrade Resiliency: Adds Code to Enable Advanced Replica Selection Feature for Preview and GA (#4180)
  • 4128 Routing: Adds ExcludeRegions Feature to RequestOptions (#4128)

3.36.0 - 2023-10-24

Fixed

  • 4039 GatewayAddressCache: Fixes Unobserved Exception During Background Address Refresh (#4039)
  • 4098 Distributed Tracing: Fixes dependency failure on appinsights (#4098)
  • 4097 Distributed Tracing: Fixes SDK responses compatibility with opentelemetry response (#4097)
  • 4111 Distributed Tracing: Fixes traceid null exception issue (#4111)

Added

  • 4009 Query: Adds ODE continuation token support for non-ODE pipelines (#4009)
  • 4078 Query: Adds LINQ RegexMatch Extension method (#4078)
  • 4001 Query: Adds public backend metrics property to Diagnostics (#4001)
  • 4016 CosmosClientOptions: Adds support for multiple formats of Azure region names (#4016)
  • 4056 Client Telemetry: Adds new public APIs (#4056)

Note: Refer this 3983 for API signature and default values.

  • 4119 TriggerOperation: Adds Upsert Operation Support(#4119)

3.36.0-preview - 2023-10-24

Added

  • 4056 Client Telemetry: Adds new public APIs (#4056). WARNING: This is breaking change for preview SDK

Note: isDistributedTracingEnabled is removed from CosmosClientOptions and withDistributedTracing() is removed from CosmosClientBuilder. Refer this 3983 for new API signature and default values

3.35.4-preview - 2023-09-15

3.35.4 - 2023-09-15

Fixed

  • 3934 Subpartitioning: Fixes bug for queries on subpartitioned containers with split physical partitions

3.35.3-preview - 2023-08-10

3.35.3 - 2023-08-10

Fixed

  • 4030 Upgrade Resiliency: Fixes Race Condition by Calling Dispose Too Early

Added

  • 4019 Upgrade Resiliency: Disables Replica Validation Feature By Default in Preview (The feature was previously enabled by default in the 3.35.2-preview release)

3.35.2-preview - 2023-07-17

Fixed

  • 3973 Application Insights Integration: Fixes event generation for failed requests

Added

  • 3951 Upgrade Resiliency: Adds Code to Enable Replica Validation Feature By Default for Preview

3.35.2 - 2023-07-17

Fixed

  • 3917 Query: Fixes malformed continuation token exception type and message
  • 3969 Diagnostics: Fixes verbose levels for "Operation will NOT be retried"

Added

  • 3668 Query : Adds string comparison alternative when converting LINQ to SQL (Thanks @ernesto1596)
  • 3834 Query : Adds support for newtonsoft member access via ExtensionData (Thanks @onionhammer)
  • 3939 CreateAndInitializeAsync: Adds Code to Optimize Rntbd Open Connection Logic to Open Connections in Parallel

3.35.1-preview - 2023-06-27

3.35.1 - 2023-06-27

Fixed

  • 3944 Availability: Fixes HttpTimeoutPolicies to not accidentally suppress retries

3.35.0-preview - 2023-06-19

Added

  • 3836 Integrated cache: Adds BypassIntegratedCache to DedicatedGatewayRequestOptions
  • 3909 Query: Adds EnableOptimisticDirectExecution in QueryRequestOptions enabled by default

Recommendation for customers regarding Optimistic Direct Execution:

Starting Version 3.35.0, the Preview SDK enables the ODE feature by default. This can potentially cause a new type of continuation token to be generated. Such a token is not recognized by the older SDKs by design and this could result in a Malformed Continuation Token Exception. If you have a scenario where tokens generated from the newer SDKs are used by an older SDK, we recommend a 2 step approach to upgrade:

  • Upgrade to the new SDK and disable ODE, both together as part of a single deployment. Wait for all nodes to upgrade.
    • In order to disable ODE, set EnableOptimisticDirectExecution to false in the QueryRequestOptions.
  • Enable ODE as part of second deployment for all nodes.

3.35.0 - 2023-06-19

Fixed

  • 3864 NugetPackage: Removes ThirdPartyNotice.txt from content and contentFiles folders
  • 3866 CosmosClient: Fixes missing Trace when converting HTTP Timeout to 503
  • 3879 Subpartitioning: Fixes handling of split physical partitions
  • 3907 Query: Fixes empty property name parsing exception

Added

  • 3860 Documentation: Adds see also link to Container.CreateTransactionalBatch
  • 3852 Query: Adds type-markers with count and length for large arrays
  • 3838 Benchmarking: Adds use of ARM Templates for benchmarking
  • 3877 Regions: Adds Malaysia South, Isreal Central, and Italy North
  • 3887 Distributed Tracing: Setting DisplayName for an operation level activity as <operationname><space><containername>
  • 3874 Client Encryption: Adds Microsoft.Azure.Cosmos compatibility to version 3.34.0
  • 3891 Documentation: Adds additional remarks to CosmosClient
  • 3902 ConnectionPolicy: Refactors Code to Reduce Default Request Timeout to 6 Seconds
  • 3910 Documentations: Adds links to PatchItems docs
  • 3918 Regions: Adds Israel Central
  • 3918 CosmosClient: Fixes SynchronizationLockException when disposing client with requests in-flight.

3.34.0-preview - 2023-05-17

Added

  • 3761 Query: Adds Computed Property SDK Support

Fixed

  • 3845 AI Integration: Fixes Operation Name in the activity and end to end Tests.

3.34.0 - 2023-05-17

Fixed

  • 3847 PackageLicense: Replaces PackageLicenseUrl with PackageLicenseFile since PackageLicenseUrl is deprecated
  • 3832 Query: Fixes format exception when using culture and partitionKey, difference between Windows and Linux

Added

  • 3854 Change Feed: Adds LatestVersion to ChangeFeedMode
  • 3833 Query: Adds TRIM string system function support in LINQ
  • 3826 Query: Adds support for Lambda expression reuse in LINQ
  • 3724 Query: Added remaining Cosmos Type checking functions to CosmosLinqExtensions. Thanks @onionhammer.

3.33.0-preview - 2023-04-21

Added

  • 3672 PriorityBasedExecution: Added PriorityLevel as a RequestOption

3.33.0 - 2023-04-21

Fixed

  • 3762 HttpClient: Adds detection of DNS changes through use of SocketsHttpHandler for .NET 6 and above
  • 3707 Diagnostics: Adds startDate in Summary
  • 3457 Documentation: Update Database.ReadAsync description
  • 3730 Query: Fixes System.ArgumentException when using PartitionKey.None on x86, Linux or in Optimistic Direct Execution
  • 3775 Change Feed Processor: Fixes LeaseLostException leaks on notification APIs for Renew scenarios
  • 3792 Diagnostics: Refactors Code to Remove Dependency of HttpResponseHeadersWrapper to fetch Sub Status Codes
  • 3793 Documentation: Refactors SQL API reference to NoSQL API
  • 3814 Serialization: Fixes call to CosmosSerializer.FromStream on Gateway mode when EnableContentResponseOnWrite is false. (Thanks @Baltima)

Added

  • 3109, 3763 Subpartitioning: Adds support for Prefix Partition Key searches for sub partitioned containers, and APIs for public release and increase REST API version
  • 3803 HttpClient: Adds Properties to the Http messages if available
  • 3389 Patch: Adds Move Operation

3.32.3 - 2023-03-30

3.32.3-preview - 2023-03-30

Fixed

  • #3787 Connectivity: Fixes ConnectionBroken and adds support for Burst Capacity

3.32.2 - 2023-03-10

3.32.2-preview - 2023-03-10

Fixed

  • #3713 CosmosNullReferenceException: Refactors CosmosNullReferenceException to pass along InnerException property on parent NullReferenceException.
  • #3749 Query: Fixes regression from LINQ custom serializer fix. Introduced in 3.32.0 PR 3749

3.32.1 - 2023-03-01

3.32.1-preview - 2023-03-01

Fixed

  • #3732 ReadMany: Fixes BadRequest when using Ids with single quotes

3.32.0 - 2023-02-03

Fixed

  • #3466 ClientRetryPolicy: Fixes behavior to Meta-data write operations in multimaster accounts
  • #3498 PartitionKey: Fixes NullRef in toString handling for None for PartitionKey.ToString()
  • #3385 Query: Fixes LINQ ToString got absorbed during translation
  • #3406 Query: Fixes LINQ to use custom serializer to serialize constant values in Query
  • #3496 Documentation: Adds XML comment to Database.ReadThroughputAsync definition
  • #3508, #3640 CosmosClient Initialization: Refactors implementation for opening Rntbd connections to backend replica nodes in Direct mode
  • #3519 Diagnostics: Removes unused properties and reduces size
  • #3495 Query: Fixes partition range evaluation for spatial queries
  • #3399 Query: Fixes default to BadRequestException in case of internal errors in ServiceInterop
  • #3574 Query: Fixes incorrect FeedResponse.Count when result contains undefined elements
  • #3577 Trace: Fixes Tracing/diagnostics hour-times to 24Hours
  • #3632 Query: Fixes handling of CosmosUndefined, CosmosGuid and CosmosBinary in unordered DISTINCT
  • #3640 Token expiration: Fixes token expired errors happening on some environments
  • #3645 Change Feed Processor: Fixes behavior with StartTime on Local
  • #3643 Documentation: Fixed CosmosClientBuilder.WithConnectionModeGateway documentation
  • #3579 Documentation: Fixes EUAP in Comments

Added

  • #3566 Change Feed Processor: Adds support for Resource Tokens
  • #3555 Availability: Adds HTTP timeouts with request-level cross-region retry
  • #3509 Query: Adds ALL Scalar Expression
  • #3656 Region Availability: Adds Poland Central Region For Public Usage.
  • #3636 CosmosClientOptions: Adds ServerCertificateCustomValidationCallback for Http and TCP

3.32.0-preview - 2023-02-03

Added

  • #3596 Full Fidelity Change Feed: Adds new LatestVersion to ChangeFeedMode. FullFidelity is now renamed to AllVersionsAndDeletes.
  • #3598 AI integration: Adds Distributed Tracing support. Enabled by default, which can be disabled through CosmosClientOptions.IsDistributedTracingEnabled

3.31.2 - 2022-11-03

3.31.2-preview - 2022-11-03

Fixed

  • #3525 Query: Fixes performance regression on target partition on some ORDER BY queries with continuation

3.31.1 - 2022-10-29

3.31.1-preview - 2022-10-29

Fixed

  • Connection: Fixes health check to identify broken connections earlier.

3.31.0 - 2022-10-03

3.31.0-preview - 2022-10-03

Fixed

  • #3480 FeedRange: Fixes a NullRef in FeedRangePartitionKey.ToString()
  • #3479 ClientRetryPolicy: Fixes behavior to handling of 503 HTTP errors. Introduced in 3.24.0 PR #3008
  • #3431 Documentation: Fixes ApplicationRegion and ApplicationPreferredRegions remarks
  • #3405 CosmosClient Initialization: Fixes TokenCredentialCache to respect cancellation token
  • #3401 Change Feed Processor: Fixes LeaseLostException leaks on notification APIs
  • #3377 Documentation: Fixes ItemRequestOptions Example

Added

  • #3455 CosmosClientOptions: Adds validation for ApplicationName
  • #3449 Documentation: Adds link to supported operations doc for PatchOperationType Enum
  • #3433 CosmosOperationCanceledException: Adds serializable functionality
  • #3419 Documentation: Removes mention of obsolete disableAutomaticIdGeneration
  • #3404 Patch: Adds public to PatchOperation<T> class for testing
  • #3380 Query: Adds aggressive prefetching for GROUP BY and COUNT(DISTINCT)

3.30.1 - 2022-09-01

3.30.1-preview - 2022-09-01

Fixed

  • #3430 PartitionKeyRangeCache: Fixes duplicate trace key generation which is the root cause of System.ThrowHelper.ThrowArgumentException during GetFeedRangesAsync API invocation.

3.30.0-preview - 2022-08-19

Added

  • #3394 Change Feed: Refactors Change Feed Contract to rename TimeToLiveExpired
  • #3331 Open Telemetry: Adds Client and other information in attributes
  • #3197 Change Feed: Adds SDK changes required for Full-Fidelity Change Feed

3.30.0 - 2022-08-19

Added

  • #3376 Client Telemetry : Refactors code to compute hash of VM ID and Process Name information
  • #3364 Integrated cache: Adds DedicatedGatewayRequestOptions for public release
  • #3273 Linq: Adds support constant evaluation of Nullable<T>.HasValue. (Thanks @ccurrens)
  • #3268 Diagnostics: Adds GetStartTimeUtc and GetFailedRequestCount

Fixed

  • #3350 Diagnostics: Fixes Diagnostics for Query with FeedRanges
  • #3348 Documentation: Fixes DeleteItemAsync Example
  • #3338 Documentation: Fixes retry time to timespan
  • #3391 Diagnostics: Fixes Ordering of ClientConfiguration Initialization

3.29.0-preview - 2022-07-11

Added

  • #3277, #3261 Open Telemetry: Adds Open Telemetry support

3.29.0 - 2022-07-11

Added

  • #3265, #3285 Change Feed Processor: Adds Task.Delay check to prevent stalling
  • #3308 Dependencies: System.ConfigurationManager is upgraded to 6.0.0 tied to the .NET 6.0 release, which still supports .NET Standard 2.0, so it is not a breaking change.
  • #3308 Performance: Replaces DateTime.UtcNow with Rfc1123DateTimeCache.UtcNow()
  • #3320 Performance: Adds use of ValueStopwatch instead of Stopwatch
  • #3276 KeyRefresh: Adds AzureKeyCredential support to enable key refresh scenarios
  • #3322 Query: Adds new DLL dependencies for ServiceInterop.dll

Fixed

  • #3278, #3310 CosmosClient: Fixes ObjectDisposedException during Background Refresh by adding Cancellation Token
  • #3309 Documentation: Fixes Container.PatchItemAsync example
  • #3313 Serialization: Fixes default JsonSerializerSettings for GHSA-5crp-9r3c-p9vr
  • #3319 OperationCanceledException: Adds Exception Trace as Child to reduce noise on the top level of Diagnostics
  • #3308 ObjectDisposedException: Fixes ObjectDisposedException during Bounded Staleness/Strong barrier requests

3.28.0 - 2022-06-14

3.28.0-preview - 2022-06-14

Added

  • #3257 CosmosClientBuilder: Adds BuildAndInitializeAsync to match CosmosClient.CreateAndInitializeAsync
  • #3211 Client Encryption: Adds change to allow partition key path and id to be part of client encryption policy
  • #3236 MalformedContinuationTokenException: Adds the use of a new substatus code when throwing to programmatically determine the cause of the BadRequest
  • #3236 CosmosException: Adds custom messages for Service Unavailable scenarios to guide customer investigation

Fixed

  • #3253 CosmosOperationCanceledException: Fixes Closure on Cancellation Token status
  • #3252 Telemetry: Fixes Inconsistent behavior of VM Metadata Async Initialization
  • #3224 LINQ: Fixes preserve DateTime.Kind when passing value to custom JsonConverter (Thanks @ccurrens)
  • #3236 Diagnostics: Fixes Exception caused when checking OS version of some Android Devices
  • #3236 Diagnostics: Fixes CPU NaN value causing broken json formatting on some devices

3.27.2 - 2022-06-02

3.27.2-preview - 2022-06-02

Added

  • #3231 Diagnostics: Adds Connection Mode to Client Configuration
  • #3234 CosmosOperationCanceledException: Adds short link and cancellation token status into message

Fixed

  • #3226 Query: Fixes DllNotFoundException when running on Windows/x64
  • #3227 Traces: Fixes message on SDK initialization when not running on Azure VM
  • #3242 CosmosClient Constructor: Fixes NullReferenceException when AzMetadata.Compute is null. Introduced in 3.27.0 PR #3100

3.27.1 - 2022-05-25

3.27.1-preview - 2022-05-25

Added

  • #3177 Performance: Adds optimized request headers
  • #3202 Diagnostics: Adds Application region into Client Configuration
  • #3194 Diagnostics: Adds Processor count
  • #3180 Diagnostics: Adds Continuation Token from partition key range cache
  • #3176 Diagnostics: Adds request session token

Fixed

  • #3190 LINQ: Fixes NullReferenceException when using a static field or property. Introduced in 3.27.0 PR #2924

3.27.0 - 2022-05-06

3.27.0-preview - 2022-05-06

Added

  • #3123 Availability: Adds optimization to reduce reduce metadata calls for addresses
  • #3127 Availability: Adds logic to reduce impact of replica failovers and upgrades
  • #3093 Patch: Adds Null support for Set operation
  • #3111 & #3015 Merge support: Minimum SDK version that includes partition merge support.
  • #2924 Performance: Adds a LINQ optimization for member access in LINQ-to-SQL (Thanks @notheotherben)
  • #3165 Diagnostics: Adds response serialization time
  • #3168 Performance: Adds aggressive prefetching for scalar aggregates for Query

Fixed

  • #3102 Upsert item: Fixes a bug causing session tokens for partition 0 to be overridden by session token for another partition when users don't pass the token as input
  • #3119 Session: Fixes NotFound/ReadSessionNotAvailable (404/1002) on collection-recreate scenario for query-only workloads
  • #3124 Change Feed Processor: Fixes noisy error notification when lease is stolen by other host
  • #3141 Diagnostics: Fixes contacted replica count
  • #3173 UserAgent: Optimized size by removing irrelevant information

3.26.2 - 2022-05-05

  • #3155 Query: Fixes "System.ArgumentException: Stream was not readable." when using WithParameterStream
  • #3154 Query: Fixes possible missing query results on Windows x64 when using a custom serializer
  • #3137 Query: Fixes exception message readability for invalid query text. Introduced in 3.14.0 PR #1812

3.26.1 - 2022-03-16

Added

  • #3080 & #3081 Availability: Adds optimization to partition key ranges cache to reduce number of gateway calls in exception scenarios
  • #3079 Availability: Adds a memory optimization to remove cached values when a not found is returned on a refresh
  • #3089 Availability: Adds retries to gateway calls for metadata operations on 408 responses

3.26.0 - 2022-03-10

Added

  • #3037 Diagnostics: Adds total number of active clients information
  • #3068 Query: Adds FeedRange API for Query to GA
  • #3035 Client Encryption: Adds Client Encryption APIs to GA SDK

3.26.0-preview - 2022-02-28

Added

  • #3037 Diagnostics: Adds total number of active clients information
  • #3049 ClientEncryption: Adds algorithm to EncryptionKeyWrapMetadata

3.25.0-preview - 2022-02-18

Added

  • #2948 Partition Key Delete: Adds DeleteAllItemsByPartitionKeyStreamAsync to container

3.25.0 - 2022-02-18

Added

  • #3029 Dependencies: Upgrades to Azure.Core 1.19.0.

Fixed

  • #3034, #3024, #3018, #3000 Documentation: Improvements in code samples within xml documentation.
  • #3027 Initialization: Fixes the SDK to retry if the initialization fails due to transient errors.

3.24.0-preview - 2022-01-31

Added

  • #2960 UserAgent: Adds flag to user agent string to differentiate SDK version.

3.24.0 - 2022-01-31

⚠️ 3.24.0 removes the DefaultTraceListener from the SDK TraceSource for performance reasons by default when not running in Debug mode.

Added

  • #2926 Performance: Removes DefaultTraceListener by default.
  • #3008 Performance: Adds buffer optimizations to Direct mode.
  • #2875 Query: Adds Index Metrics to Stream API.
  • #2401 Query: Adds Correlated ActivityId wiring through query.
  • #2917 LINQ: Adds support for Nullable<T>.Value or Nullable<T>.HasValue when using camelCase serialization.
  • #2893 Diagnostics: Adds address info to diagnostics on force cache refresh.
  • #3008 Diagnostics: Adds diagnostics for splits and timeouts.
  • #2907 Diagnostics: Adds performance improvement to GetContactedRegions().
  • #2988 Diagnostics: Adds performance improvement by reducing size and removing irrelevant information (caller info).
  • #3008 Diagnostics: Adds ServiceEndpoint and Connection Stats to the diagnostics.
  • #3008 Availability: Direct mode removes blocking call on broken connection exception.
  • #3008 Supportability: Adds SDK generated substatus codes for 503's to separate from server side 503.

Fixed

  • #3008 Availability: Fixes the SDK to ensure it does not retry on replica that previously failed with 410, 408 and >= 500 status codes.
  • #2869 Performance: Fixes query improvement to load values lazily. Introduced in 3.14.0 PR #1812
  • #2883 Change Feed Processor: Fixes diagnostics on Estimator and ChangeFeedProcessorContext. Introduced in 3.15.0 PR #1933
  • #2900, #2899, #2915, #2912, #2925, #3000 Documentation: Improvements in code samples within xml documentation.
  • #2937, #2975 Session: Improvements on session token handling for Gateway mode across splits and merges.
  • #2965 Session: Fixes operations sending the session token on Gateway mode when the operation reduced consistency to lower than Session.
  • #2975 Session: Fixes session token too large exception in Gateway mode if the client had no previous cache entry.

3.23.0 - 2021-11-12

3.23.0-preview - 2021-11-12

Added

  • #2868 Patch: Adds support for patch operations
  • #2822 Availability: Adds non-blocking async lazy cache to improve upgrade and scaling scenarios
  • #2807 ChangeFeedProcessor: Adds ChangeFeedProcessorUserException for detailed error notification
  • #2818 Diagnostics: Adds retry after time to diagnostics
  • #2818 Availability: Adds retry context to ensure requests on retries do not go to replicas that previously hit transport exceptions

Fixed

  • #2851 Query: Fixes stack overflow in SkipEmptyPageQueryPipelineStage. Introduced in 3.14.0 PR #1812
  • #2844 CosmosClientBuilder: Fixes accountEndpoint not being set when using TokenCredential. (Thanks @levimatheri) Introduced in 3.22.0 PR #2753
  • #2793 Query: Fixes missing diagnostic from query pipeline. Introduced in 3.17.0 PR #2097
  • #2818 Diagnostics: Fixes memory calculations in diagnostics
  • #2818 Availability: Fixes blocking call on broken connection exception
  • #2861 Performance: Fixes query performance by avoiding ImmutableDictionary. Introduced in 3.17.0 PR #2144

3.22.1-preview - 2021-10-28

3.22.1 - 2021-10-28

Fixed

  • #2827 Query: Fixes a memory leak when on Windows x64 using ServiceInterop. Introduced in 3.22.0 2777
  • #2827 Availability: Adds keep alive to Linux systems for Direct mode connections to match the Windows keep alive interval

3.22.0 - 2021-10-18

Added

  • #2753 CosmosClientBuilder: Adds overload for passing TokenCredential (Thanks @levimatheri)
  • #2732 Diagnostics: Adds request status code summary
  • #2777 RetryWith(449): Adds improved 449 retry logic with randomized seed and faster retries.
  • #2787 ChangeFeedProcessor: Adds Notification APIs

Fixed

  • #2776 Query: Fixes a bug where max page size is not being honored after the first 2 pages. Introduced in 3.17.0 2144
  • #2746 Bulk: Fixes validation to throw if ItemRequestOptions.Properties is set with bulk enabled.
  • #2712 Serialized types: Fixes public types(Database Properties, ContainerProperties, etc..) to be forward compatible/future proof with service evolving. We ourselves might struggle interpret in future after a while.
  • #2739 Bulk: Fixes item response to include SessionToken and ActivityId
  • #2764 ChangeFeedProcessor: Fixes log to remove expected 404 scenarios during lease release
  • #2777 InvalidOperationException: Fixes a race condition multiple threads try to modify exception header causing a InvalidOperationException
  • #2777 Diagnostics: Fix issue causing CPU usage to be NaN intermittently. Introduced in 3.21.0 PR 2687
  • #2786 GlobalEndpointManager: Fixes noisy TraceCritical on GlobalEndpointManager dispose
  • #2793 Query Diagnostics: Fixes missing diagnostics from query pipeline
  • #2792 CosmosClient.ReadAccountAsync: Fixes it to throw CosmosException instead of DocumentClientException

3.22.0-preview - 2021-10-07

Added

  • #2753 CosmosClientBuilder: Adds overload for passing TokenCredential (Thanks @levimatheri)
  • #2732 Diagnostics: Adds request summary
  • #2746 Bulk: Adds validation to throw if ItemRequestOptions.Properties is set with bulk enabled.
  • #2777 RetryWith(449): Adds improved 449 retry logic with randomized seed and faster retries.

Fixed

  • #2776 Query: Fixes a bug where max page size is not being honored after the first 2 pages. Introduced in 3.17.0 2144
  • #2712 Serialized types: Fixes public types(Database Properties, ContainerProperties, etc..) to be upgrade safe so new content is not lost on deserialize and serialize paths
  • #2739 Bulk: Fixes item response to include SessionToken and ActivityId
  • #2764 ChangeFeedProcessor: Fixes log to remove expected 404 scenarios during lease release
  • #2777 InvalidOperationException: Fixes a race condition multiple threads try to modify exception header causing a InvalidOperationException
  • #2777 Diagnostics: Fix issue causing CPU usage to be NaN intermittently. Introduced in 3.21.0 PR 2687

3.21.0-preview - 2021-09-10

Added

  • #2577 ResponseMessage : Adds setter for Diagnostics
  • #2613 Change Feed Processor: Adds notification APIs

Fixed

  • #2599 Diagnostics : Fixes CosmosResponseFactory.CreateItemResponse to use ResponseMessage.Diagnostics instead of creating a new instance

3.21.0 - 2021-09-10

Added

  • #2612 Query: Adds PopulateIndexMetrics request options
  • #2650 Change Feed Processor: Adds detailed delegate context, stream, and manual check pointing support
  • #2687 Diagnostics: Adds memory usage, thread starvation detection, optimizations to collection logic
  • #2719 CosmosException: Adds diagnostics to CosmosException.Message for status codes: 408, 500, 503, 404/1002
  • #2724 Availability: Adds EnableTcpConnectionEndpointRediscovery to true by default

Fixed

  • #2599 Diagnostics: Fixes duration for HttpResponseStatistics
  • #2646 OperationCanceledException: Fixes lost CancellationToken on CosmosOperationCanceledException (Thanks to askazakov)
  • #2509 GlobalEndpointManager: Fixes exception handling to have the inner exception stacktrace
  • #2611 Query: Fixes c# query parser to handle Alias in from clause
  • #2661 ReadMany: Fixes ReadMany API for PartitionKey.None value
  • #2675 Change Feed: Fixes migration path from preview continuation
  • #2676 Performance: Fixes query performance regression. Introduced in 3.17.0 PR 2144
  • #2687 Diagnostics: Fixes StoreResult start and end time to be accurate and removes duplicate CPU collector
  • #2697 Azure Active Directory(AAD): Fixes stuck requests when background refresh fails to refresh token
  • #2708 Query: Fixes order by logic to throw original exception instead of AggregateException (Thanks to askazakov)
  • #2710 Security: Fixes ServiceInterop.dll to be BinSkim compliant by adding /guard /Qspectre flags

3.20.1 - 2021-06-29

3.20.1-preview - 2021-06-29

Fixed

  • #2450 Query: Fixes c# parser grammar for recognizing string literal which will avoid falling back to gateway to get the query plan.
  • #2574 UserAgent: Fixes race condition in user agent string creation and limits client id to 10. Introduced in 3.20.0 PR 2552
  • #2580 LINQ : Fixes ArgumentNullException while calling ToQueryDefinition() when no filters are applied.

3.20.0 - 2021-06-21

Added

  • #2509 Change Feed: Adds change feed iterator APIs on containers
  • #2558 Diagnostics: Adds Duration field to HttpResponseStatistics in Diagnostics
  • #2502 Diagnostics: Adds Direct TransportRequestStats for tracking transport request timeline
  • #2491 Change Feed Processor: Adds support for Graph API accounts. Graph API accounts can now create lease containers with /partitionKey instead of /id.

Fixed

  • #2567 ReadMany: Fixes AddRequestHeaders request option and missing headers and message on failure scenarios
  • #2510 Query: Fixes InvalidOperationException when partitions are merged. Introduced in 3.17.0 PR #2084.
  • #2510 Query: Fixes handling of pipeline execution on partition merge. Introduced in 3.17.0 PR #2084.
  • #2547 Query: Fixes incorrect order by query when the field is an object or array
  • #2511 Availability: Fixes get account info retry logic to not go to secondary regions on 403(Forbidden)
  • #2512 Caches: Fixes the cache to remove values if generator throws an exception. Thanks @johngallardo.
  • #2516 Diagnostics: Fixes a race condition causing InvalidOperationException. Introduced in 3.17.0 PR #2097
  • #2530 Gateway: Fixes container recreate scenarios for Gateway Mode in session consistency. Introduced in 3.18.0 PR #2165
  • #2552 UserAgent: Fixes UserAgent to have the correct number of clients
  • #2562 Diagnostics: Fixes NullReferenceException in service unavailable scenarios. Introduced in 3.18.0 PR #2312
  • #2502 Tracing: Removes noisy trace in direct mode

3.20.0-preview - 2021-06-21

Added

  • #2509 Change Feed: Adds change feed iterator APIs on containers
  • #2558 Diagnostics: Adds Duration field to HttpResponseStatistics in Diagnostics
  • #2502 Diagnostics: Adds Direct TransportRequestStats for tracking transport request timeline
  • #2491 Change Feed Processor: Adds support for Graph API accounts. Graph API accounts can now create lease containers with /partitionKey instead of /id.
  • #2488 Change Feed Processor: Refactors checkpoint API to throw exception. Introduced in #2331. This is considered a breaking change on the preview API as it evolves into GA.

Fixed

  • #2567 ReadMany: Fixes AddRequestHeaders request option and missing headers and message on failure scenarios
  • #2510 Query: Fixes InvalidOperationException when partitions are merged. Introduced in 3.17.0 PR #2084.
  • #2510 Query: Fixes handling of pipeline execution on partition merge. Introduced in 3.17.0 PR #2084.
  • #2547 Query: Fixes incorrect order by query when the field is an object or array
  • #2511 Availability: Fixes get account info retry logic to not go to secondary regions on 403(Forbidden)
  • #2512 Caches: Fixes the cache to remove values if generator throws an exception. Thanks @johngallardo.
  • #2516 Diagnostics: Fixes a race condition causing InvalidOperationException. Introduced in 3.17.0 PR #2097
  • #2530 Gateway: Fixes container recreate scenarios for Gateway Mode in session consistency. Introduced in 3.18.0 PR #2165
  • #2552 UserAgent: Fixes UserAgent to have the correct number of clients
  • #2562 Diagnostics: Fixes NullReferenceException in service unavailable scenarios. Introduced in 3.18.0 PR #2312
  • #2502 Tracing: Removes noisy trace in direct mode

3.19.0 - 2021-05-25

Added

  • #2482 Azure Active Directory: Adds CosmosClient TokenCredential APIs
  • #2440 Performance: Adds Bulk optimizations to reduce allocations and improves async task handling
  • #2447 Availability: Adds account refresh logic on gateway outage instead of waiting on 5min background refresh
  • #2493 NullReferenceException: Adds logic to append the CosmosDiagnostics to NullReferenceExceptions
  • #2465 ObjectDisposedException: Adds logic to append the CosmosDiagnostics to ObjectDisposedException
  • #2390 Bulk: Adds retry for patch operations when request is to large
  • #2487 UserAgent: Adds flag to user agent to show if region failover is configured

Fixed

  • #2451 Query: Fixes native c# parser not recognizing query with multiple IN statements. Introduced in 3.13.0 PR #1743
  • #2451 Bulk: Fixes diagnostic traces by removing redundant info and adding correct retry context. Introduced in 3.17.0 PR #2097
  • #2460 Permission: Fixes documentation on resource token range limit. (Thanks to arorainms)
  • #2490 Change Feed: Fixes CancellationToken to be honored. Introduced in 3.15.0 PR #1933
  • #2483 Availability: Fixes the get account information to stop the background refresh after CosmosClient is disposed. Introduced in 3.18.0 PR #2355
  • #2481 Azure Active Directory: Fixes token refresh interval, exception handling, and retry logic
  • #2474 Change Feed: Fixes exceptions generating "Change Feed should always have a next page". Introduced in 3.15.0 PR #1933
  • #2498 Diagnostics: Fixes default setting in Consistency Config Serialization. Introduced in 3.18.0 PR #2250

3.19.0-preview1 - 2021-05-17

Added

  • #2398 Patch : Adds TrySerializeValueParameter method for PatchOperation
  • #2440 Performance: Adds Bulk optimizations to reduce allocations and improves async task handling
  • #2447 Availability: Adds account refresh logic on gateway outage instead of waiting on 5min background refresh
  • #2449 Client encryption: Adds PolicyFormatVersion and validation that partition key paths are not encrypted

Fixed

  • #2451 Query: Fixes native c# parser not recognizing query with multiple IN statements. Introduced in 3.13.0 PR #1743
  • #2451 Bulk: Fixes diagnostic traces by removing redundant info and adding correct retry context. Introduced in 3.17.0 PR #2097
  • #2460 Permission: Fixes documentation on resource token range limit. (Thanks to arorainms)

3.19.0-preview - 2021-04-27

Added

  • #2308 & #2425 Dedicated Gateway: Adds MaxIntegratedCacheStaleness to Item and Query Request Options
  • #2371 Request Options : Adds delegate on request options to access and add headers
  • #2398 Patch : Adds TrySerializeValueParameter and makes PatchOperation<T> internal since it is not used in any public API
  • #2331 ChangeFeedProcessor: Adds support for manual checkpoint, context, and stream

3.18.1-preview - 2021-06-14

Fixed

  • #2510 Query: Fixes InvalidOperationException on merge to a single partition
  • #2531 Query: Fixes invalid query results on partition merge

3.18.0 - 2021-04-26

Added

  • #2324 Diagnostics: Adds all http requests to diagnostics
  • #2400 Performance: Adds optimizations to reduce allocations for Direct + TCP operations
  • #2353 Query: Adds support to c# query parser for LIKE statement and INT system functions to avoid gateway query plan call when service interop is not available
  • #2397 Diagnostics: Adds optimizations and BELatency which is the Cosmos DB Backend Request Latency In Milliseconds
  • #2355 Availability: Adds concurrent requests to secondary region if the initial get account information takes longer than 5 seconds which reduces SDK startup time if primary region is down.
  • #2352 ReadManyApi: Adds new API designed to efficiently read a list of items using the item id and partition key value
  • #2250 Diagnostics: Adds client configuration information needed to root cause issues
  • #2241 ContainerBuilder: Adds public constructor to create ContainerBuilder instance
  • #2222 Query: Adds WithParameterStream to QueryDefinition to pass in serialized values
  • #2165 & #2408 Performance: Adds optimization to reduce header size for gateway mode with session consistency. It now only send specific partition session token like direct mode.

Fixed

  • #2282 Query: Fixes COUNT(DISTINCT) to always compute correct value. Any query with more than 1 page of results could produce incorrect values.
  • #2405 Change Feed: Fixes pull model to avoid additional NotModified call
  • #2368 Query: Fixes BadRequest with "Failed to parse ... as ResourceId" for gateway mode on splits. Introduced in 3.14.0 PR #1812
  • #2357 Query: Fixes incorrect RequestCharge and missing headers in FeedResponse for ordered cross-partition queries. Introduced in 3.14.0 PR #1812 (Thanks to ccurrens)
  • #2409 Query: Fixes race condition in diagnostics causes missing information and Index out of bound exceptions. Introduced in 3.17.0 PR #2097
  • #2400 Availability: Fixes race condition in direct + tcp mode causing SDK generated internal server errors and invalid operation exceptions
  • #2400 Availability: Fixes race condition in direct + tcp mode causing unnecessary connections to be created by concurrent requests
  • #2392 Change Feed Estimator: Fixes exception propagation to throw on StartAsync for container/lease not found scenarios. Introduced in 3.17.0 PR #1830
  • #2383 Availability: Fixes CancellationToken evaluation during failover which could prevent necessary SDK refreshes to occur
  • #2376 Diagnostics: Fixes invalid nesting and handler names in ITrace. Introduced in 3.17.0 PR #2097
  • #2286 Diagnostics: Fixes regression in ITrace where direct operation diagnostics were not included in exception scenarios. Introduced in 3.17.0 PR #2097
  • #2424 Query: Fixes TaskCanceledException being converted to InternalServerError and not including diagnostics on most exceptions. Introduced in 3.14.0 PR #1812

3.18.0-preview - 2021-03-18

Added

  • #2308 Patch: Adds preview support for Patch API
  • #2312 Diagnostics: Adds Api for getting all regions contacted by a request

Fixed

  • #2314 Diagnostics: Fixes InvalidOperationException caused by concurrently modifing a dictionary in TraceWriter. Introduced in 3.17.0 PR #2242
  • #2303 CosmosException : Fixes exception messages to remove JSON formatting
  • #2311 Spatial: Fixes deserialization when Json does not represent a Spatial type
  • #2284 Diagnostics: Adds traces for cache operations. Introduced in 3.17.0 PR #2097
  • #2278 Documentation: Fixes typos in comment examples (Thanks to paulomorgado)
  • #2279 Availability: Fixes region failover logic on control plane hot path when gateway hangs. Introduced in 3.16.0 PR #1954
  • #2286 Diagnostics: Fixes regression which caused ActivityId to not get included. Introduced in 3.17.0 PR #2097

3.17.1 - 2021-03-19

Fixed

  • #2314 Diagnostics: Fixes InvalidOperationException caused by concurrently modifying a dictionary in TraceWriter. Introduced in 3.17.0 PR #2242
  • #2303 CosmosException : Fixes exception messages to remove JSON formatting
  • #2311 Spatial: Fixes deserialization when Json does not represent a Spatial type
  • #2284 Diagnostics: Adds traces for cache operations. Introduced in 3.17.0 PR #2097
  • #2278 Documentation: Fixes typos in comment examples (Thanks to paulomorgado)
  • #2279 Availability: Fixes region failover logic on control plane hot path when gateway hangs. Introduced in 3.16.0 PR #1954
  • #2286 Diagnostics: Fixes regression which caused ActivityId to not get included. Introduced in 3.17.0 PR #2097

3.17.0 - 2021-03-02

Added

  • #1870 Batch API: Adds Session token support
  • #2145 EnableContentResponseOnWrite: Adds client level support via CosmosClientOptions and CosmosClientBuilder
  • #2166 QueryRequestOption: Adds optimization to avoid duplicating QueryRequestOption
  • #1830 & #2170 Change Feed Estimator: Adds support for detailed estimation per lease
  • #2097 & #2204 & #2213 & #2235 & #2236 & #2242 & #2246 CosmosDiagnostics: Refactored to use ITrace as the default implementation
  • #2206 LINQ : Adds User Defined Function Translation Support (Thanks to dpiessens)
  • #2210 QueryDefinition: Adds API to get query parameters (Thanks to thomaslevesque)
  • #2197 CosmosClient: Adds CreateAndInitializeAsync method which can be used to avoid latency of warming caches on first operation.
  • #2220 LINQ: Adds camelCase support to GetItemLinqQueryable() as optional parameter
  • #2249 Performance: Adds HTTP optimization to disable Nagle Algorithm for .NET Framework applications

Fixed

  • #2168 Query: Fixes a regression in Take operator where it drains the entire query instead of stopping a the take count. Introduced in 3.14.0 PR #1812 and reported in issue #1979
  • #2129 CosmosDiagnostics: Fixes memory leak caused by pagination library holding on to all diagnostics. Introduced in 3.14.0 PR #1812 and reported in issue #2087
  • #2103 Query: Fixes ORDER BY undefined (and mixed type primitives) continuation token support. Introduced in 3.14.0 PR #1812
  • #2124 Bulk: Fixes retry logic to handle RequestEntityTooLarge exceptions caused by the underlying batch request being to large. Introduced in #741
  • #2198 CosmosClientOptions: Fixes a bug causing ConsistentPrefix to be convert to BoundedStaleness. Introduced in 3.1.0 PR #541 and reported in issue #2196
  • #2262 CosmosException: Fixes the headers not matching CosmosException property values and incorrect SubStatusCode values on client initialization failures
  • #2269 PermissionProperties: Fixes PermissionProperties to not take dependency on internal type to fix mocking
  • #2097 Diagnostics: Fixes regression in query, change feed, and read feed that causes diagnostics to be empty after first page. Introduced in 3.14.0 PR #1812

3.17.0-preview1 - 2021-03-02

Added

  • #2197 CosmosClient: Adds CreateAndInitializeAsync Method

Fixed

  • #2235 CosmosDiagnostics: Fixes ITrace JsonTraceWriter to include address resolution and store response stats. Introduced in 3.17.0-preview in PR #2097
  • #2236 CosmosDiagnostics: Fixes missing POCO deserialization for query operations.
  • #2218 (Preview) ChangeFeed pull model: Fixes missing headers on failure path. Introduced in 3.15.0 in PR #1933

3.17.0-preview - 2021-02-15

Added

  • #1870 Batch API: Adds Session token support
  • #1952 & #1648 (Preview) Subpartitioning: Adds support for subpartitioning
  • #2122 (Preview) Change Feed: Adds Full Fidelity support
  • #2145 EnableContentResponseOnWrite: Adds client level support via CosmosClientOptions and CosmosClientBuilder
  • #2166 QueryRequestOption: Adds optimization to avoid duplicating QueryRequestOption
  • #2097 & #2204 & #2213 CosmosDiagnostics: Refactored to use ITrace as the default implementation
  • #2206 LINQ : Adds User Defined Function Translation Support (Thanks to dpiessens)
  • #2210 QueryDefinition: Adds API to get query parameters (Thanks to thomaslevesque)

Fixed

  • #2168 Query: Fixes a regression in Take operator where it drains the entire query instead of stopping a the take count. Introduced in 3.14.0 PR #1812 and reported in issue #1979
  • #2129 CosmosDiagnostics: Fixes memory leak caused by pagination library holding on to all diagnostics. Introduced in 3.14.0 PR #1812 and reported in issue #2087
  • #2103 Query: Fixes ORDER BY undefined (and mixed type primitives) continuation token support. Introduced in 3.14.0 PR #1812
  • #2124 Bulk: Fixes retry logic to handle RequestEntityTooLarge exceptions caused by the underlying batch request being to large. Introduced in #741
  • #2198 CosmosClientOptions: Fixes a bug causing ConsistentPrefix to be convert to BoundedStaleness. Introduced in 3.1.0 PR #541 and reported in issue #2196

3.16.0 - 2021-01-12

Added

  • #2098 Performance: Adds gateway header optimization
  • #1954 & #2094 Control Plane Hot Path: Adds more aggressive timeout and retry logic for getting caches and query plan from gateway
  • #2013 Change Feed Processor: Adds support for EPK leases
  • #2016 Performance: Fixes lock contentions and reduce allocations on TCP requests
  • #2000 Performance: Adds Authorization Helper improvements

Fixed

  • #2110 CosmosException: Fixes substatuscode to get the correct value instead of 0 when it is not in the enum
  • #2092 Query: Fixes cancellation token support for the lazy + buffering path
  • #2099 & #2116 CosmosDiagnostics: Fixes IndexOutOfRangeException by adding concurrent operation support
  • #2096 AggregateException: Fixes some cache calls to throw original exception instead of AggregateException
  • #2044 Query: Fixes Equals method on SqlParameter class
  • #2077 Availability: Fixes retry behavior on HttpException where SDK will retry on same region instead of secondary region
  • #2056 Performance: Fixes encoded strings performance for query operations
  • #2060 Query: Fixes high CPU usage caused by FeedRange comparison used in LINQ order by operation. Introduced in 3.14.0 PR #1812
  • #2041 Request Charge: Fixes request charges for offers and CreateIfNotExists APIs

3.15.1 - 2020-12-16

Fixed

  • #2069 Bulk: Fixes incorrect routing on split
  • #2047 Diagnostics: Adds operation name to summary
  • #2042 Change Feed Processor: Fixes StartTime not being correctly applied. Introduced in 3.13.0-preview PR #1725
  • #2071 Diagnostics: Fixes substatuscode when recording internal DocumentClientException

3.15.0 - 2020-11-17

Added

  • #1926 Query: Adds multiple arguments in IN clause support to c# query parser when service interop is not available.
  • #1933 ChangeFeed: Adds adoption of pagination library
  • #1943 Performance: Adds query optimization by LazyCosmosElement Cache Improvements
  • #1944 Performance: Adds direct version to get response header improvement
  • #1947 ReadFeed: Adds pagination library adoption
  • #1949 Performance: Adds optimized request headers
  • #1974 Performance: Adds Bulk optimization by reducing lock contention in TimerWheel
  • #1977 Performance diagnostics: Adds static timer and caches handler name

Fixed

  • #1930 Change Feed: Fixes estimator diagnostics
  • #1939 LINQ: Fixes ArgumentNullException with StringComparison sensitive case (Thanks to ylabade)
  • #1940 LINQ: Fixes CancellationToken bug in CosmosLinqQuery.AggregateResultAsync (Thanks to ylabade)
  • #1960 CosmosClientOptions and ClientBuilder: Fixes ArgumentException when setting null value on HttpClientFactory or WebProxy
  • #1961 RequestOption.Properties: Fixes RequestOption.Properties for CreateContainerIfNotExistsAsync
  • #1967 Query: Fixes CancellationToken logic in pagination library
  • #1988 Query: Fixes split proofing logic for queries with logical partition key
  • #1999 Performance: Fixes exception serialization when tracing is not enabled
  • #2004 Query: Fixes SplitHandling bug caused by caches not getting refreshed. Introduced in 3.14.0 PR #1812

3.15.2-preview - 2020-11-17

Fixed

  • #2004 Query: Fixes SplitHandling bug caused by caches not getting refreshed. Introduced in 3.14.0 PR #1812

Unlisted see #2004 - 3.15.1-preview - 2020-11-05

Fixed

  • #1972 Private preview Azure Active Directory: Fixes TokenCredentialCache timeout logic and ports tests from master
  • #1984 Private preview Azure Active Directory: Fixes issue with using wrong scope value

Unlisted see #2004 - 3.15.0-preview - 2020-10-21

Added

  • #1944 Performance: Adds direct version to get response header improvement
  • #1933 Change Feed: Adds new continuation token format which can be migrated via new EmitOldContinuationToken.
  • #1933 Change Feed: Adds the ability to retry on 304s and no longer modifies HasMoreResults
  • #1926 Query: Adds multiple arguments in IN clause support to c# query parser when service interop is not available.
  • #1798 Private Preview Azure Active Directory: Adds Azure Active Directory support to the SDK

Fixed

  • #1933 Change Feed: Fixes StartFrom bug where the value was not honored

Unlisted see #2004 - 3.14.0-preview - 2020-10-09

Added

  • #1830 Change Feed Estimator: Adds support for detailed estimation per lease

Unlisted see #2004 - 3.14.0 - 2020-10-09

Added

  • #1876 Performance: Adds session token optimization
  • #1879 Performance: Adds AuthorizationHelper improvements
  • #1882 Performance: Adds SessionContainer optimizations and style fixes
  • #1812 Query: Adds adoption of pagination library
  • #1920 Query: Adds RegexMatch system function support

Fixed

  • #1875 HttpClient: Fixes HttpResponseMessage.RequestMessage is null in WASM
  • #1886 Change Feed Processor: Fixes failures during initialization
  • #1892 GatewayAddressCache: Fixes high CPU from HashSet usage on Address refresh path
  • #1909 Authorization: Fixes DocumentClientException being thrown on write operations
  • #1812 Query: Fixes MalformedContinuationTokenException. Introduced in 3.7.0 PR #1260 and reported in issue #1364

3.13.0 - 2020-09-21

Added

  • #1743 Query Performance: Adds skipping getting query plan for non-aggregate single partition queries on non-Windows x64 systems when FeedOptions.PartitionKey is set
  • #1768 Performance: Adds SessionToken optimization to reduce header size by removing session token for CRUD on stored procedure, triggers, and UDFs
  • #1781 Performance: Adds headers optimization which can reduce response allocation by 10 KB per a request.
  • #1825 RequestOptions.Properties: Adds the ability for applications to specify request context
  • #1835 Performance: Add HttpClient optimization to avoid double buffering gateway responses
  • #1837 Query SystemFunctions : Adds DateTime System Functions
  • #1842 Query Performance: Adds Singleton QueryPartitionProvider. Helps when Container is getting recreated.
  • #1857 Performance: Adds finalizer optimizations in a few places (Thanks to pentp)
  • #1843 Performance: Adds Transport serialization, SessionTokenMismatchRetryPolicy, and store response dictionary optimizations

Fixed

  • #1757 Batch API: Fixes the size limit to reduce timeouts
  • #1758 Connectivity: Fixes address resolution calls when using EnableTcpConnectionEndpointRediscovery
  • #1788 Transient HTTP exceptions: Adds retry logic to all http requests
  • #1863 HttpClientHandler: Fixes HttpClientHandler PlatformNotSupportedException

3.13.0-preview - 2020-08-12

Added

  • #1725 ChangeFeed : Adds ChangeFeedStartFrom to support StartTimes x FeedRanges. WARNING: This is breaking change for preview SDK
  • #1764 Performance: Adds compiler optimize flag
  • #1768 SessionToken: Adds optimization to reduce header size by removing session token for CRUD on stored procedure, triggers, and UDFs

Fixed

  • #1757 Batch API: Fixes the size limit to reduce timeouts
  • #1758 Connectivity: Fixes address resolution calls when using EnableTcpConnectionEndpointRediscovery

3.12.0 - 2020-08-06

Added

  • #1548 Transport: Adds an optimization to unify HttpClient usage across Gateway classes
  • #1569 Batch API: Adds support of request options for transactional batch
  • #1693 Performance: Reduces lock contention on GlobalAddress Resolver
  • #1712 Performance: Adds optimization to reduce AuthorizationHelper memory allocations
  • #1715 Availability: Adds cross-region retry mechanism on transient connectivity issues
  • #1721 LINQ : Adds support for case-insensitive searches (Thanks to jeffpardy)
  • #1733 Change Feed Processor: Adds backward compatibility of lease store

Fixed

  • #1548 Availability: Fixes SDK failover logic. An HttpClient used the user configured request timeout on metadata request causing an ambiguous OperationCanceledException instead of the HttpRequestException which is used to trigger failovers.
  • #1720 Gateway Trace: Fixes a bug where the ActivityId is being set to Guid.Empty
  • #1728 Diagnostics: Fixes ActivityScope by moving it to operation level
  • #1740 Connection limits: Fixes .NET core to honor gateway connection limit
  • #1744 Transport: Fixes use of PortReuseMode and other Direct configuration settings

3.11.1-preview - 2020-10-01

  • #1892 Performance: Fixes High CPU caused by EnableTcpConnectionEndpointRediscovery by reducing HashSet lock contention

3.11.0 - 2020-07-07

3.11.0-preview - 2020-07-07

Added

  • #1587 & 1643 & 1667 Diagnostics: Adds synchronization context tracing to all request
  • #1617 Performance: Fixes Object Model hierarchy to use strings for relative paths instead of URI
  • #1639 CosmosClient: Adds argument check for empty key to prevent ambiguous 401 not authorized exception
  • #1640 Bulk: Adds TimerWheel to Bulk to improve latency
  • #1678 Autoscale: Adds to container builder

Fixed

  • #1638 Documentation : Fixes all examples to add using statement to FeedIterator
  • #1666 CosmosOperationCanceledException: Fixes handler to catch all operation cancelled exceptions
  • #1682 Performance: Fixes high CPU consumption caused by EnableTcpConnectionEndpointRediscovery

3.10.1 - 2020-06-18

  • #1637 TransportHandler : Removes stack trace print. Introduced in 3.10.0 PR 1587

3.10.0 - 2020-06-18

Added

  • #1613 Query FeedIterator: Adds IDisposable to fix memory leak. WARNING: This will require changes to fix static anlysis tools checking for dispose.
  • #1550 CosmosOperationCanceledException: This enables users to access the diagnsotics when an operation is canceled via the cancellation token. The new type extends OperationCanceledException so it does not break current exception handling and includes the CosmosDiagnostic in the ToString().
  • #1578 Query: Adds memory optimization to prevent coping the buffer
  • #1578 Query: Adds support for ignore case for Contains and StartsWith functions.
  • #1602 Diagnostics: Adds CPU usage to all operations
  • #1603 Documentation: Adds new exception handling documentation

Fixed

  • #1530 ContainerDefinition : Fixes WithDefaultTimeToLive argument spelling (Thanks to tony-xia)
  • #1547 & #1582 Query and Readfeed: Fix exceptions caused by not properly handling splits
  • #1578 ApplicationRegion: Fixes ApplicationRegion to ensure the correct order is being used for failover scenarios
  • #1585 Query : Fixes Multi- ORDER BY continuation token support with QueryExecutionInfo response headers

3.9.1 - 2020-05-19

3.9.1-preview - 2020-05-19

Fixed

  • #1539 CosmosException and Diagnostics: Fixes ToString() to not grow exponentially with retries. Introduced in 3.7.0 in PR #1189.

3.9.0 - 2020-05-18

Added

  • #1356 & #1407 & #1428 & #1407 Adds autoscale support.
  • #1398 Diagnostics: Adds CPU monitoring for .NET Core.
  • #1441 Transport: Adds HttpClientFactory support on CosmosClientOptions.
  • #1457 Container: Adds database reference to the container.
  • #1455 Serializer: Adds SDK serializer to Client.ClientOptions.Serializer.
  • #1397 CosmosClientBuilder: Adds preferred regions and WithConnectionModeDirect().
  • #1439 No content on Response: Adds the ability to have operations return no content from Azure Cosmos DB.
  • #1398 & #1516 Read feed and change feed: Adds serialization optimization to reduce memory and CPU utilization up to 90%. Objects are now passed as an array to the serializer.
  • #1516 Query: Adds serialization optimization to reduce memory up to %50 and CPU utilization up to 25%. Objects are now passed as an array to the serializer.

Fixed

  • #1401 & #1437: Response type: Fix deadlock on scenarios with SynchronizationContext when using Response.Container.
  • #1445 Transport: Fix ServicePoint for WebAssembly.
  • #1462 UserAgent: Fix feature usage tracking.
  • #1469 Diagnostics: Fix InvalidOperationException and converts elapsed time to millisecond.
  • #1512 PartitionRoutingHelper: Fix ReadFeed ArgumentNullException due to container cache miss.
  • #1530 CosmosClientBuilder: Fix WithDefaultTimeToLive parameter spelling.

3.9.0-preview3 - 2020-05-11

Added

  • #1356 & #1407 & #1428 Autoscale preview release.
  • #1407 Autoscale: Adds CreateDatabaseIfNotExistsAsync and CreateContainerIfNotExistsAsync methods.
  • #1410 FeedRange: Adds Json serialization support.
  • #1398 Diagnostics: Adds CPU monitoring for .NET Core.
  • #1441 Transport: Adds HttpClientFactory support on CosmosClientOptions.
  • #1457 Container: Adds database reference to the container.
  • #1453 Response factory: Adds a response factory to the public API.
  • #1455 Serializer: Adds SDK serializer to Client.ClientOptions.Serializer.
  • #1397 CosmosClientBuilder: Adds preferred regions and public internal func WithConnectionModeDirect().
  • #1439 No content on response: Adds the ability to have operation return no content from Azure Cosmos DB.
  • #1469 Diagnostics: Fixes the InvalidOperationException and converts elapsed time to millisecond.

Fixed

  • #1398 Reduced memory allocations on query deserialization.
  • #1401 & #1437: Response type: Fixes deadlock on scenarios with SynchronizationContext when using Response.Container.
  • #1445 Transport: Fixes ServicePoint for WebAssembly.
  • #1462 UserAgent: Fixes feature usage tracking.

3.9.0-preview - 2020-04-17

Added

  • #1356 Autoscale: Adds to public preview release

3.8.0-preview - 2020-04-16

Added

  • #1331 Enabled client encryption / decryption for transactional batch requests

Fixed

  • #1369 Fixes decryption for 'order by' query results

3.8.0 - 2020-04-07

Added

  • #1314 Adds configuration for proactive TCP end-of-connection detection.
  • #1305 Adds support for preferred region customization.

Fixed

  • #1312 Fixes null reference when using default(PartitionKey).
  • #1296 Decrypts the encrypted properties before returning query result.
  • #1345 Fixes get query plan diagnostics.

3.7.1-preview - 2020-03-30

  • #1210 Adds change feed pull model.
  • #1242 Client encryption - fixes bug in read path without encrypted properties.
  • #1314 Adds configuration for proactive TCP end-of-connection detection.
  • #1312 Fixes null reference when using default(PartitionKey).
  • #1296 Decrypts the encrypted properties before returning query result.

3.7.0 - 2020-03-26

Added

  • #1268 Adds GetElapsedClientLatency to CosmosDiagnostics.
  • #1239 Made MultiPolygon and PolygonCoordinates classes public.
  • #1233 Partition key now supports operators ==, != for equality comparison.
  • #1285 Add query plan retrieval to diagnostics.
  • #1289 Query ORDER BY resume optimization.
  • #1074 Bulk API congestion control.

Fixed

  • #1213 CosmosException now returns the original stack trace.
  • #1213 ResponseMessage.ErrorMessage is now always correctly populated. There was bug in some scenarios where the error message was left in the content stream.
  • #1298 CosmosException.Message contains the same information as CosmosException.ToString() to ensure all the information is being tracked.
  • #1242 Client encryption - Fixes bug in read path without encrypted properties.
  • #1189 Query diagnostics shows correct overall time.
  • #1189 Fixes a bug that caused duplicate information in diagnostic context.
  • #1263 Fixes a bug where retry after interval did not get set on query stream responses.
  • #1198 Fixes null reference exception when calling a disposed CosmosClient.
  • #1274 ObjectDisposedException is thrown when calling all SDK objects like Database and Container that reference a disposed client.
  • #1268 Fixes bug where Request Options was getting lost for Database.ReadStreamAsync and Database.DeleteStreamAsync methods.
  • #1304 Fixes XML documentation so it now is visible in Visual Studio.

3.7.0-preview2 - 2020-03-09

  • #1210 Change feed pull model.
  • #1242 Client encryption - fixes bug in read path without encrypted properties.

3.7.0-preview - 2020-02-25

  • #1074 Bulk API congestion control.
  • #1210 Change feed pull model.

3.6.0 - 2020-01-23

  • #1105 CosmosClient Immutability + Disposable Fixes

Added

  • #1097 GeospatialConfig to ContainerProperties, BoundingBoxProperties to SpatialPath.
  • #1061 Stream payload to ExecuteStoredProcedureStreamAsync.
  • #1062 Additional diagnostic information including the ability to track time through the different SDK layers.
  • #1107 Source Link support.
  • #1121 StandByFeedIterator breath-first read strategy.

Fixed

  • #1105 Custom serializer no longer calls SDK owned types that would cause serialization exceptions.
  • #1112 Fixes SDK properties like DatabaseProperties to have the same JSON attributes.
  • #1116 Fixes a deadlock on scenarios with SynchronizationContext while executing async query operations.
  • #1143 Fixes permission resource link and authorization issue when doing a query with resource token for a specific partition key.
  • #1150 Fixes NullReferenceException when using a non-existent Lease Container.

3.5.1 - 2019-12-11

Fixed

  • #1060 Fixes unicode encoding bug in DISTINCT queries.
  • #1070 CreateItem will only retry for auto-extracted partition key in-case of collection re-creation.
  • #1075 Including header size details for bad request with large headers.
  • #1078 Fixes a deadlock on scenarios with SynchronizationContext while executing async SDK API.
  • #1081 Fixes race condition in serializer caused by null reference exception.
  • #1086 Fix possible NullReferenceException on a TransactionalBatch code path.
  • #1091 Fixes a bug in query when a partition split occurs that causes a NotImplementedException to be thrown.
  • #1089 Fixes a NullReferenceException when using Bulk with items without partition key.

3.5.0 - 2019-12-03

Added

  • #979 Make SessionToken on QueryRequestOptions public.
  • #995 Included session token in diagnostics.
  • #1000 Adds PortReuseMode to CosmosClientOptions.
  • #1017 Adds ClientSideRequestStatistics to gateway calls and making end time nullable.
  • #1038 Adds self-link to resource properties.

Fixed

  • #921 Fixes error handling to preserve stack trace in certain scenarios.
  • #944 Change feed processor won't use user serializer for internal operations.
  • #988 Fixes query mutating due to retry of gone / name cache is stale.
  • #954 Support start from beginning for change feed processor in multi master accounts.
  • #999 Fixes grabbing extra page, updated continuation token on exception path, and non-Ascii character in order by continuation token.
  • #1013 Gateway OperationCanceledExceptions are now returned as request timeouts.
  • #1020 Direct package update removes debug statements.
  • #1023 Fixes ThroughputResponse.IsReplacePending header mapping.
  • #1036 Fixes query responses to return null Content if it is a failure.
  • #1045 Adds stack trace and inner exception to CosmosException.
  • #1050 Adds mocking constructors to TransactionalBatchOperationResult.

3.4.1 - 2019-11-06

Fixed

  • #978 Fixes mocking for FeedIterator and response classes.

3.4.0 - 2019-11-04

Added

  • #853 ORDER BY arrays and object support.
  • #877 Query diagnostics now contains client-side request diagnostics information.
  • #923 Bulk support is now public.
  • #922 Included information of bulk support usage in user agent.
  • #934 Preserved the ordering of projections in a GROUP BY query.
  • #952 ORDER BY undefined and mixed type ORDER BY support.
  • #965 Batch API is now public.

Fixed

  • #901 Fixes a bug causing query response to create a new stream for each content call.
  • #918 Fixes serializer being used for scripts, permissions, and conflict-related iterators.
  • #936 Fixes bulk requests with large resources to have natural exception.

3.3.3 - 2019-10-30

  • #837 Fixes group by bug for non-Windows platforms.
  • #927 Fixes query returning partial results instead of error.

3.3.2 - 2019-10-16

Fixed

  • #905 Fixes lINQ camel case bug.

3.3.1 - 2019-10-11

Fixed

  • #895 Fixes user agent bug that caused format exceptions on non-Windows platforms.

3.3.0 - 2019-10-09

Added

  • #801 Enabled LINQ ThenBy operator after OrderBy.
  • #814 Ability to limit to configured endpoint only.
  • #822 GROUP BY query support.
  • #844 Adds PartitionKeyDefinitionVersion to container builder.

Fixed

  • #835 Fixes a bug that caused sorted ranges exceptions.
  • #846 Statistics not getting populated correctly on CosmosException.
  • #857 Fixes reusability of the bulk support across container instances.
  • #860 Fixes base user agent string.
  • #876 Default connection time out reduced from 60 s to 10 s.

3.2.0 - 2019-09-17

Added

  • #100 Configurable Tcp settings to CosmosClientOptions.
  • #615, #775 Adds request diagnostics to response.
  • #622 Adds CRUD and query operations for users and permissions, which enables ResourceToken support.
  • #716 Added camel case serialization on LINQ query generation.
  • #729, #776 Adds aggregate (CountAsync/SumAsync etc.) extensions for LINQ query.
  • #743 Adds WebProxy to CosmosClientOptions.

Fixed

  • #726 Query iterator HasMoreResults now returns false if an exception is hit.
  • #705 User agent suffix gets truncated.
  • #753 Reason was not being propagated for conflict exceptions.
  • #756 Change feed processor with WithStartTime would execute the delegate the first time with no items.
  • #761 CosmosClient deadlocks when using a custom task scheduler like Orleans.
  • #769 Session consistency and gateway mode session-token bug fix- under few rare non-success cases session token might be in-correct.
  • #772 Fixes throughput throwing when custom serializer used or offer doesn't exists.
  • #785 Incorrect key to throw CosmosExceptions with HttpStatusCode.Unauthorized status code.

3.2.0-preview2 - 2019-09-10

  • #585, #741 Bulk execution support.
  • #427 Transactional batch support (Item CRUD).

3.2.0-preview - 2019-08-09

  • #427 Transactional batch support (Item CRUD).

3.1.1 - 2019-08-12

Added

  • #650 CosmosSerializerOptions to customize serialization.

Fixed

  • #612 Bug fix for ReadFeed with partition key.
  • #614 Fixes spatial path serialization and compatibility with older index versions.
  • #619 Fixes PInvokeStackImbalance exception for .NET framework.
  • #626 FeedResponse<T> status codes now return OK for success instead of the invalid status code 0 or Accepted.
  • #629 Fixes CreateContainerIfNotExistsAsync validation to limited to partition key path only.
  • #630 Fixes user agent to contain environment and package information.

3.1.0 - 2019-07-29 - Unlisted

Added

  • #541 Adds consistency level to client and query options.
  • #544 Adds continuation token support for LINQ.
  • #557 Adds trigger options to item request options.
  • #572 Adds partition key validation on CreateContainerIfNotExistsAsync.
  • #581 Adds LINQ to QueryDefinition API.
  • #592 Adds CreateIfNotExistsAsync to container builder.
  • #597 Adds continuation token property to ResponseMessage.
  • #604 Adds LINQ ToStreamIterator extension method.

Fixed

  • #548 Fixes mis-typed message in CosmosException.ToString().
  • #558 Location cache ConcurrentDict lock contentions fix.
  • #561 GetItemLinqQueryable now works with null query.
  • #567 Query correctly handles different language cultures.
  • #574 Fixes empty error message if query parsing fails from unexpected exception.
  • #576 Query correctly serializes the input into a stream.

3.0.0 - 2019-07-15

  • General availability of Version 3.0.0 of the .NET SDK.
  • Targets .NET Standard 2.0, which supports .NET framework 4.6.1+ and .NET Core 2.0+.
  • New object model, with top level CosmosClient and methods split across relevant database and container classes.
  • New stream APIs that have high performance.
  • Built-in support for change feed processor APIs.
  • Fluent builder APIs for CosmosClient, container, and change feed processor.
  • Idiomatic throughput management APIs.
  • Granular RequestOptions and ResponseTypes for database, container, item, query, and throughput requests.
  • Ability to scale non-partitioned containers.
  • Extensible and customizable serializer.
  • Extensible request pipeline with support for custom handlers.

Known issues

Below is a list of any know issues affecting the recommended minimum version:

Issue Impact Mitigation Tracking link
FeedIterator enters an infinite loop after a physical partition split occurs in a container using hierarchical partition keys. Queries using prefix partition keys. Rather than having the PK included in the query request options, filtering on top level hierarchical Pks should be done through where clauses. #4326

Release & Retirement dates

Microsoft provides 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 recommended that you always upgrade to the latest SDK version as early as possible.

After 31 August 2022, Azure Cosmos DB will no longer make bug fixes, add new features, and provide support for versions 1.x of the Azure Cosmos DB for NoSQL .NET or .NET Core SDK. If you prefer not to upgrade, requests sent from version 1.x of the SDK will continue to be served by the Azure Cosmos DB service.

Version Release Date Retirement Date
3.6.0 January 23, 2020 ---
3.5.1 December 11, 2019 ---
3.5.0 December 03, 2019 ---
3.4.1 November 06, 2019 ---
3.4.0 November 04, 2019 ---
3.3.3 October 30, 2019 ---
3.3.2 October 16, 2019 ---
3.3.1 October 11, 2019 ---
3.3.0 October 8, 2019 ---
3.2.0 September 18, 2019 ---
3.1.1 August 12, 2019 ---
3.1.0 July 29, 2019 ---
3.0.0 July 15, 2019 ---