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 tocredential
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
- The
- 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 tolist
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
orfeed_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 ofCosmosError
which has been removed.HTTPFailure
has been renamed toCosmosHttpResponseError
JSONParseFailure
has been removed and replaced byazure.core.DecodeError
- Added additional errors for specific response codes:
CosmosResourceNotFoundError
for status 404CosmosResourceExistsError
for status 409CosmosAccessConditionFailedError
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 methodfetch_next_block
has been replaced by a secondary iterator, accessed by theby_page
method.
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 aCosmosClient
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.
- Added Support for MultiPolygon Datatype
- Bug Fix in Session Read Retry Policy
- Bug Fix for Incorrect padding issues while decoding base 64 strings
- Bug fix in LocationCache
- Bug fix endpoint retry logic
- Fixed documentation
- 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"
- 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
- Added support for default retries on connection issues.
- Updated documentation to reference Azure Cosmos DB instead of Azure DocumentDB.
- This SDK version requires the latest version of Azure Cosmos DB Emulator available for download from https://aka.ms/cosmosdb-emulator.
- bugfix for aggregate dict
- bugfix for trimming slashes in the resource link
- tests for unicode encoding
- Added support for Request Unit per Minute (RU/m) feature.
- Added support for a new consistency level called ConsistentPrefix.
- 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.
- Made editorial changes to documentation comments.
- 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.
-
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.
- Added the support for geo-replicated database accounts.
- Test fixes to move the global host and masterKey into the individual test classes.
- Added the support for Time To Live(TTL) feature for documents.
- Bug fixes related to server side partitioning to allow special characters in partitionkey path.
- Added the support for server side partitioned collections feature.
- Added Client-side sharding framework to the SDK. Implemented HashPartionResolver and RangePartitionResolver classes.
- Implement Upsert. New UpsertXXX methods added to support Upsert feature.
- Implement ID Based Routing. No public API changes, all changes internal.
- Release skipped to bring version number in alignment with other SDKs
- 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.
- Implements V2 indexing policy
- Supports proxy connection