.NET SDK for Azure Cosmos DB for the core SQL API
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 toChangeFeedItem<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.
server.address
will be emitted starting with this version.Note: There is added support for the following regions:
Taiwan North
andTaiwan Northwest
. This also includes a Direct Package version update to 3.33.0 in PR #4353
:warning: 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) to3.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.
:warning: 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) to3.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.
:warning: 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.
3.38.0
Note section.