CHANGELOG.md

Release History

4.3.0b4 (Unreleased)

Features Added

• Added support for AAD authentication for the async client
• Added support for AAD authentication for the sync client

4.3.0b3 (2022-03-10)

[WARNING] The default Session consistency bugfix will impact customers whose database accounts have a Bounded Staleness or Strong consistency level, and were previously not sending Session as a consistency_level parameter when initializing their clients. Default consistency level for the sync and async clients is no longer "Session" and will instead be set to the consistency level of the user's cosmos account setting on initialization if not passed during client initialization. Please see Consistency Levels in Azure Cosmos DB for more details on consistency levels, or the README section on this change here.

Features Added

• Added new provisional max_integrated_cache_staleness_in_ms parameter to read item and query items APIs in order to make use of the preview CosmosDB integrated cache functionality. Please see Azure Cosmos DB integrated cache for more details.
• Added support for split-proof queries for the async client

Bugs fixed

• Default consistency level for the sync and async clients is no longer Session and will instead be set to the consistency level of the user's cosmos account setting on initialization if not passed during client initialization. This change will impact client application in terms of RUs and latency. Users relying on default Session consistency will need to pass it explicitly if their account consistency is different than Session. Please see Consistency Levels in Azure Cosmos DB for more details.
• Fixed invalid request body being sent when passing in serverScript body parameter to replace operations for trigger, sproc and udf resources.
• Moved is_system_key logic in async client.
• Fixed TypeErrors not being thrown when passing in invalid connection retry policies to the client.

4.3.0b2 (2022-01-25)

This version and all future versions will require Python 3.6+. Python 2.7 is no longer supported. We will also be removing support for Python 3.6 and will only support Python 3.7+ starting December 2022.

Features Added

• Added support for split-proof queries for the sync client.

Other Changes

• Added async user agent for async client.

4.3.0b1 (2021-12-14)

Features Added

• Added language native async i/o client.

4.2.0 (2020-10-08)

Bug fixes

• Fixed bug where continuation token is not honored when query_iterable is used to get results by page. Issue #13265.
• Fixed bug where resource tokens not being honored for document reads and deletes. Issue #13634.

New features

• Added support for passing partitionKey while querying changefeed. Issue #11689.

4.1.0 (2020-08-10)

• Added deprecation warning for "lazy" indexing mode. The backend no longer allows creating containers with this mode and will set them to consistent instead.

New features

• Added the ability to set the analytical storage TTL when creating a new container.

Bug fixes

• Fixed support for dicts as inputs for get_client APIs.
• Fixed Python 2/3 compatibility in query iterators.
• Fixed type hint error. Issue #12570 - thanks @sl-sandy.
• Fixed bug where options headers were not added to upsert_item function. Issue #11791 - thank you @aalapatirvbd.
• Fixed error raised when a non string ID is used in an item. It now raises TypeError rather than AttributeError. Issue #11793 - thank you @Rabbit994.

4.0.0 (2020-05-20)

• Stable release.
• Added HttpLoggingPolicy to pipeline to enable passing in a custom logger for request and response headers.

4.0.0b6

• Fixed bug in synchronized_request for media APIs.
• Removed MediaReadMode and MediaRequestTimeout from ConnectionPolicy as media requests are not supported.

4.0.0b5

• azure.cosmos.errors module deprecated and replaced by azure.cosmos.exceptions
• The access condition parameters (access_condition, if_match, if_none_match) have been deprecated in favor of separate match_condition and etag parameters.
• Fixed bug in routing map provider.
• Added query Distinct, Offset and Limit support.
• Default document query execution context now used for
  • ChangeFeed queries
  • single partition queries (partitionkey, partitionKeyRangeId is present in options)
  • Non document queries
• Errors out for aggregates on multiple partitions, with enable cross partition query set to true, but no "value" keyword present
• Hits query plan endpoint for other scenarios to fetch query plan
• Added __repr__ support for Cosmos entity objects.
• Updated documentation.

4.0.0b4

• Added support for a timeout keyword argument to all operations to specify an absolute timeout in seconds within which the operation must be completed. If the timeout value is exceeded, a azure.cosmos.errors.CosmosClientTimeoutError will be raised.
• Added a new ConnectionRetryPolicy to manage retry behaviour during HTTP connection errors.
• Added new constructor and per-operation configuration keyword arguments:
  • retry_total - Maximum retry attempts.
  • retry_backoff_max - Maximum retry wait time in seconds.
  • retry_fixed_interval - Fixed retry interval in milliseconds.
  • retry_read - Maximum number of socket read retry attempts.
  • retry_connect - Maximum number of connection error retry attempts.
  • retry_status - Maximum number of retry attempts on error status codes.
  • retry_on_status_codes - A list of specific status codes to retry on.
  • retry_backoff_factor - Factor to calculate wait time between retry attempts.

4.0.0b3

• Added create_database_if_not_exists() and create_container_if_not_exists functionalities to CosmosClient and Database respectively.

4.0.0b2

Version 4.0.0b2 is the second iteration in our efforts to build a more Pythonic client library.

Breaking changes

• The client connection has been adapted to consume the HTTP pipeline defined in azure.core.pipeline.
• Interactive objects have now been renamed as proxies. This includes:
  • Database -> DatabaseProxy
  • User -> UserProxy
  • Container -> ContainerProxy
  • Scripts -> ScriptsProxy
• The constructor of CosmosClient has been updated:
  • The auth parameter has been renamed to credential and will now take an authentication type directly. This means the master key value, a dictionary of resource tokens, or a list of permissions can be passed in. However the old dictionary format is still supported.
  • The connection_policy parameter has been made a keyword only parameter, and while it is still supported, each of the individual attributes of the policy can now be passed in as explicit keyword arguments:
    • request_timeout
    • media_request_timeout
    • connection_mode
    • media_read_mode
    • proxy_config
    • enable_endpoint_discovery
    • preferred_locations
    • multiple_write_locations
• A new classmethod constructor has been added to CosmosClient to enable creation via a connection string retrieved from the Azure portal.
• Some read_all operations have been renamed to list operations:
  • CosmosClient.read_all_databases -> CosmosClient.list_databases
  • Container.read_all_conflicts -> ContainerProxy.list_conflicts
  • Database.read_all_containers -> DatabaseProxy.list_containers
  • Database.read_all_users -> DatabaseProxy.list_users
  • User.read_all_permissions -> UserProxy.list_permissions
• All operations that take request_options or feed_options parameters, these have been moved to keyword only parameters. In addition, while these options dictionaries are still supported, each of the individual options within the dictionary are now supported as explicit keyword arguments.
• The error heirarchy is now inherited from azure.core.AzureError instead of CosmosError which has been removed.
  • HTTPFailure has been renamed to CosmosHttpResponseError
  • JSONParseFailure has been removed and replaced by azure.core.DecodeError
  • Added additional errors for specific response codes:
    • CosmosResourceNotFoundError for status 404
    • CosmosResourceExistsError for status 409
    • CosmosAccessConditionFailedError for status 412
• CosmosClient can now be run in a context manager to handle closing the client connection.
• Iterable responses (e.g. query responses and list responses) are now of type azure.core.paging.ItemPaged. The method fetch_next_block has been replaced by a secondary iterator, accessed by the by_page method.

4.0.0b1

Version 4.0.0b1 is the first preview of our efforts to create a user-friendly and Pythonic client library for Azure Cosmos. For more information about this, and preview releases of other Azure SDK libraries, please visit https://aka.ms/azure-sdk-preview1-python.

Breaking changes: New API design

• Operations are now scoped to a particular client:

  • CosmosClient: This client handles account-level operations. This includes managing service properties and listing the databases within an account.
  • Database: This client handles database-level operations. This includes creating and deleting containers, users and stored procedurs. It can be accessed from a CosmosClient instance by name.
  • Container: This client handles operations for a particular container. This includes querying and inserting items and managing properties.
  • User: This client handles operations for a particular user. This includes adding and deleting permissions and managing user properties.

  These clients can be accessed by navigating down the client hierarchy using the get_<child>_client method. For full details on the new API, please see the reference documentation.

• Clients are accessed by name rather than by Id. No need to concatenate strings to create links.

• No more need to import types and methods from individual modules. The public API surface area is available directly in the azure.cosmos package.

• Individual request properties can be provided as keyword arguments rather than constructing a separate RequestOptions instance.

3.0.2

• Added Support for MultiPolygon Datatype
• Bug Fix in Session Read Retry Policy
• Bug Fix for Incorrect padding issues while decoding base 64 strings

3.0.1

• Bug fix in LocationCache
• Bug fix endpoint retry logic
• Fixed documentation

3.0.0

• Multi-region write support added
• Naming changes
  • DocumentClient to CosmosClient
  • Collection to Container
  • Document to Item
  • Package name updated to "azure-cosmos"
  • Namespace updated to "azure.cosmos"

2.3.3

• Added support for proxy
• Added support for reading change feed
• Added support for collection quota headers
• Bugfix for large session tokens issue
• Bugfix for ReadMedia API
• Bugfix in partition key range cache

2.3.2

• Added support for default retries on connection issues.

2.3.1

• Updated documentation to reference Azure Cosmos DB instead of Azure DocumentDB.

2.3.0

• This SDK version requires the latest version of Azure Cosmos DB Emulator available for download from https://aka.ms/cosmosdb-emulator.

2.2.1

• bugfix for aggregate dict
• bugfix for trimming slashes in the resource link
• tests for unicode encoding

2.2.0

• Added support for Request Unit per Minute (RU/m) feature.
• Added support for a new consistency level called ConsistentPrefix.

2.1.0

• Added support for aggregation queries (COUNT, MIN, MAX, SUM, and AVG).
• Added an option for disabling SSL verification when running against DocumentDB Emulator.
• Removed the restriction of dependent requests module to be exactly 2.10.0.
• Lowered minimum throughput on partitioned collections from 10,100 RU/s to 2500 RU/s.
• Added support for enabling script logging during stored procedure execution.
• REST API version bumped to '2017-01-19' with this release.

2.0.1

• Made editorial changes to documentation comments.

2.0.0

• Added support for Python 3.5.
• Added support for connection pooling using the requests module.
• Added support for session consistency.
• Added support for TOP/ORDERBY 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.

• Removed the RetryPolicy class and the corresponding property (retry_policy) exposed on the document_client class and instead introduced a RetryOptions class exposing the RetryOptions property on ConnectionPolicy class that can be used to override some of the default retry options.

1.8.0

• Added the support for geo-replicated database accounts.
• Test fixes to move the global host and masterKey into the individual test classes.

1.7.0

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

1.6.1

• Bug fixes related to server side partitioning to allow special characters in partitionkey path.

1.6.0

• Added the support for server side partitioned collections feature.

1.5.0

• Added Client-side sharding framework to the SDK. Implemented HashPartionResolver and RangePartitionResolver classes.

1.4.2

• Implement Upsert. New UpsertXXX methods added to support Upsert feature.
• Implement ID Based Routing. No public API changes, all changes internal.

1.3.0

• Release skipped to bring version number in alignment with other SDKs

1.2.0

• Supports 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.1

• Supports proxy connection