EchoVib

A client-side logical representation of an Azure Cosmos DB account.

Use this client to configure and execute requests to the Azure Cosmos DB service.

• url (str) – The URL of the Cosmos DB account.

• credential (str or dict[str, str]) – Can be the account key, or a dictionary of resource tokens.

• consistency_level (str) – Consistency level to use for the session. The default value is “Session”.

• timeout (int) – An absolute timeout in seconds, for the combined HTTP request and response processing.

• request_timeout (int) – The HTTP request timeout in seconds.

• connection_mode (str) – The connection mode for the client - currently only supports ‘Gateway’.

• proxy_config (ProxyConfiguration) – Connection proxy configuration.

• ssl_config (SSLConfiguration) – Connection SSL configuration.

• connection_verify (bool) – Whether to verify the connection, default value is True.

• connection_cert (str) – An alternative certificate to verify the connection.

• retry_total (int) – Maximum retry attempts.

• retry_backoff_max (int) – Maximum retry wait time in seconds.

• retry_fixed_interval (int) – Fixed retry interval in milliseconds.

• retry_read (int) – Maximum number of socket read retry attempts.

• retry_connect (int) – Maximum number of connection error retry attempts.

• retry_status (int) – Maximum number of retry attempts on error status codes.

• retry_on_status_codes (list[int]) – A list of specific status codes to retry on.

• retry_backoff_factor (float) – Factor to calculate wait time between retry attempts.

• enable_endpoint_discovery (bool) – Enable endpoint discovery for geo-replicated database accounts. (Default: True)

• preferred_locations (list[str]) – The preferred locations for geo-replicated database accounts.

Example:

from azure.cosmos import exceptions, CosmosClient, PartitionKey import os url = os.environ["ACCOUNT_URI"] key = os.environ["ACCOUNT_KEY"] client = CosmosClient(url, key) 

Instantiate a new CosmosClient.

Create a new database with the given ID (name).

• id – ID (name) of the database to create.

• populate_query_metrics (bool) – Enable returning query metrics in response headers.

• offer_throughput (int) – The provisioned throughput for this offer.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A DatabaseProxy instance representing the new database.

DatabaseProxy

CosmosResourceExistsError – Database with the given ID already exists.

Example:

database_name = "testDatabase" try: database = client.create_database(id=database_name) except exceptions.CosmosResourceExistsError: database = client.get_database_client(database=database_name) 

Create the database if it does not exist already.

If the database already exists, the existing settings are returned.

This function does not check or update existing database settings or offer throughput if they differ from what is passed in.

• id – ID (name) of the database to read or create.

• populate_query_metrics (bool) – Enable returning query metrics in response headers.

• offer_throughput (int) – The provisioned throughput for this offer.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A DatabaseProxy instance representing the database.

DatabaseProxy

CosmosHttpResponseError – The database read or creation failed.

Delete the database with the given ID (name).

• database (str or dict(str, str) or DatabaseProxy) – The ID (name), dict representing the properties or DatabaseProxy instance of the database to delete.

• populate_query_metrics (bool) – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

CosmosHttpResponseError – If the database couldn’t be deleted.

None

Create a CosmosClient instance from a connection string.

This can be retrieved from the Azure portal.For full list of optional keyword arguments, see the CosmosClient constructor.

• conn_str (str) – The connection string.

• credential (str or dict(str, str)) – Alternative credentials to use instead of the key provided in the connection string.

• consistency_level (str) – Consistency level to use for the session. The default value is “Session”.

Retrieve the database account information.

response_hook (Callable) – A callable invoked with the response metadata.

A DatabaseAccount instance representing the Cosmos DB Database Account.

DatabaseAccount

Retrieve an existing database with the ID (name) id.

database (str or dict(str, str) or DatabaseProxy) – The ID (name), dict representing the properties or DatabaseProxy instance of the database to read.

A DatabaseProxy instance representing the retrieved database.

DatabaseProxy

List the databases in a Cosmos DB SQL database account.

• max_item_count (int) – Max number of items to be returned in the enumeration operation.

• populate_query_metrics (bool) – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of database properties (dicts).

Iterable[dict[str, str]]

Query the databases in a Cosmos DB SQL database account.

• query (str) – The Azure Cosmos DB SQL query to execute.

• parameters (list[str]) – Optional array of parameters to the query. Ignored if no query is provided.

• enable_cross_partition_query (bool) – Allow scan on the queries which couldn’t be served as indexing was opted out on the requested paths.

• max_item_count (int) – Max number of items to be returned in the enumeration operation.

• populate_query_metrics (bool) – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of database properties (dicts).

Iterable[dict[str, str]]

An interface to interact with a specific database.

This class should not be instantiated directly. Instead use the CosmosClient.get_database_client() method.

A database contains one or more containers, each of which can contain items, stored procedures, triggers, and user-defined functions.

A database can also have associated users, each of which is configured with a set of permissions for accessing certain containers, stored procedures, triggers, user-defined functions, or items.

id – The ID (name) of the database.

An Azure Cosmos DB SQL API database has the following system-generated properties. These properties are read-only:

• _rid: The resource ID.

• _ts: When the resource was last updated. The value is a timestamp.

• _self: The unique addressable URI for the resource.

• _etag: The resource etag required for optimistic concurrency control.

• _colls: The addressable path of the collections resource.

• _users: The addressable path of the users resource.

• client_connection (ClientSession) – Client from which this database was retrieved.

• id (str) – ID (name) of the database.

Create a new container with the given ID (name).

If a container with the given ID already exists, a CosmosResourceExistsError is raised.

• id – ID (name) of container to create.

• partition_key – The partition key to use for the container.

• indexing_policy – The indexing policy to apply to the container.

• default_ttl – Default time to live (TTL) for items in the container. If unspecified, items do not expire.

• populate_query_metrics – Enable returning query metrics in response headers.

• offer_throughput – The provisioned throughput for this offer.

• unique_key_policy – The unique key policy to apply to the container.

• conflict_resolution_policy – The conflict resolution policy to apply to the container.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A ContainerProxy instance representing the new container.

CosmosHttpResponseError – The container creation failed.

ContainerProxy

Example:

container_name = "products" try: container = database.create_container( id=container_name, partition_key=PartitionKey(path="/productName") ) except exceptions.CosmosResourceExistsError: container = database.get_container_client(container_name) 

customer_container_name = "customers" try: customer_container = database.create_container( id=customer_container_name, partition_key=PartitionKey(path="/city"), default_ttl=200, ) except exceptions.CosmosResourceExistsError: customer_container = database.get_container_client(customer_container_name) 

Create a container if it does not exist already.

If the container already exists, the existing settings are returned. Note: it does not check or update the existing container settings or offer throughput if they differ from what was passed into the method.

• id – ID (name) of container to read or create.

• partition_key – The partition key to use for the container.

• indexing_policy – The indexing policy to apply to the container.

• default_ttl – Default time to live (TTL) for items in the container. If unspecified, items do not expire.

• populate_query_metrics – Enable returning query metrics in response headers.

• offer_throughput – The provisioned throughput for this offer.

• unique_key_policy – The unique key policy to apply to the container.

• conflict_resolution_policy – The conflict resolution policy to apply to the container.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A ContainerProxy instance representing the container.

CosmosHttpResponseError – The container read or creation failed.

ContainerProxy

Create a new user in the container.

To update or replace an existing user, use the ContainerProxy.upsert_user() method.

body – A dict-like object with an id key and value representing the user to be created. The user ID must be unique within the database, and consist of no more than 255 characters.

response_hook (Callable) – A callable invoked with the response metadata.

A UserProxy instance representing the new user.

CosmosHttpResponseError – If the given user couldn’t be created.

UserProxy

Example:

try: database.create_user(dict(id="Walter Harp")) except exceptions.CosmosResourceExistsError: print("A user with that ID already exists.") except exceptions.CosmosHttpResponseError as failure: print("Failed to create user. Status code:{}".format(failure.status_code)) 

Delete a container.

• container – The ID (name) of the container to delete. You can either pass in the ID of the container to delete, a ContainerProxy instance or a dict representing the properties of the container.

• populate_query_metrics – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

CosmosHttpResponseError – If the container couldn’t be deleted.

None

Delete the specified user from the container.

user – The ID (name), dict representing the properties or UserProxy instance of the user to be deleted.

response_hook (Callable) – A callable invoked with the response metadata.

None

Get a ContainerProxy for a container with specified ID (name).

container – The ID (name) of the container, a ContainerProxy instance, or a dict representing the properties of the container to be retrieved.

ContainerProxy

Example:

database = client.get_database_client(database_name) container = database.get_container_client(container_name) 

Get a UserProxy for a user with specified ID.

user – The ID (name), dict representing the properties or UserProxy instance of the user to be retrieved.

A UserProxy instance representing the retrieved user.

CosmosHttpResponseError – If the given user couldn’t be retrieved.

UserProxy

List the containers in the database.

• max_item_count – Max number of items to be returned in the enumeration operation.

• populate_query_metrics – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of container properties (dicts).

Iterable[dict[str, Any]]

Example:

database = client.get_database_client(database_name) for container in database.list_containers(): print("Container ID: {}".format(container.id)) 

List all the users in the container.

max_item_count – Max number of users to be returned in the enumeration operation.

response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of user properties (dicts).

Iterable[dict[str, Any]]

List the properties for containers in the current database.

• query – The Azure Cosmos DB SQL query to execute.

• parameters – Optional array of parameters to the query. Ignored if no query is provided.

• max_item_count – Max number of items to be returned in the enumeration operation.

• populate_query_metrics – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of container properties (dicts).

Iterable[dict[str, Any]]

Return all users matching the given query.

• query – The Azure Cosmos DB SQL query to execute.

• parameters – Optional array of parameters to the query. Ignored if no query is provided.

• max_item_count – Max number of users to be returned in the enumeration operation.

response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of user properties (dicts).

Iterable[str, Any]

Read the database properties.

populate_query_metrics (bool) – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

Dict[Str, Any]

CosmosHttpResponseError – If the given database couldn’t be retrieved.

Read the Offer object for this database.

response_hook (Callable) – A callable invoked with the response metadata.

Offer for the database.

CosmosHttpResponseError – If no offer exists for the database or if the offer could not be retrieved.

Offer

Reset the properties of the container.

Property changes are persisted immediately. Any properties not specified will be reset to their default values.

• container – The ID (name), dict representing the properties or ContainerProxy instance of the container to be replaced.

• partition_key – The partition key to use for the container.

• indexing_policy – The indexing policy to apply to the container.

• default_ttl – Default time to live (TTL) for items in the container. If unspecified, items do not expire.

• conflict_resolution_policy – The conflict resolution policy to apply to the container.

• populate_query_metrics – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

CosmosHttpResponseError – Raised if the container couldn’t be replaced. This includes if the container with given id does not exist.

A ContainerProxy instance representing the container after replace completed.

ContainerProxy

Example:

# Set the TTL on the container to 3600 seconds (one hour) database.replace_container(container, partition_key=PartitionKey(path='/productName'), default_ttl=3600) # Display the new TTL setting for the container container_props = database.get_container_client(container_name).read() print("New container TTL: {}".format(json.dumps(container_props['defaultTtl']))) 

Replace the database-level throughput.

throughput – The throughput to be set (an integer).

response_hook (Callable) – A callable invoked with the response metadata.

Offer for the database, updated with new throughput.

CosmosHttpResponseError – If no offer exists for the database or if the offer could not be updated.

Offer

Replaces the specified user if it exists in the container.

• user – The ID (name), dict representing the properties or UserProxy instance of the user to be replaced.

• body – A dict-like object representing the user to replace.

response_hook (Callable) – A callable invoked with the response metadata.

A UserProxy instance representing the user after replace went through.

CosmosHttpResponseError – If the replace failed or the user with given ID does not exist.

UserProxy

Insert or update the specified user.

If the user already exists in the container, it is replaced. If the user does not already exist, it is inserted.

body – A dict-like object representing the user to update or insert.

response_hook (Callable) – A callable invoked with the response metadata.

A UserProxy instance representing the upserted user.

CosmosHttpResponseError – If the given user could not be upserted.

UserProxy

An interface to interact with a specific DB Container.

This class should not be instantiated directly. Instead, use the DatabaseProxy.get_container_client() method to get an existing container, or the Database.create_container() method to create a new container.

A container in an Azure Cosmos DB SQL API database is a collection of documents, each of which is represented as an Item.

• id (str) – ID (name) of the container

• session_token (str) – The session token for the container.

Create an item in the container.

To update or replace an existing item, use the ContainerProxy.upsert_item() method.

• body – A dict-like object representing the item to create.

• populate_query_metrics – Enable returning query metrics in response headers.

• pre_trigger_include – trigger id to be used as pre operation trigger.

• post_trigger_include – trigger id to be used as post operation trigger.

• indexing_directive – Indicate whether the document should be omitted from indexing.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A dict representing the new item.

CosmosHttpResponseError – Item with the given ID already exists.

dict[str, Any]

Delete a specified conflict from the container.

If the conflict does not already exist in the container, an exception is raised.

• conflict – The ID (name) or dict representing the conflict to be deleted.

• partition_key – Partition key for the conflict to delete.

response_hook (Callable) – A callable invoked with the response metadata.

None

Delete the specified item from the container.

If the item does not already exist in the container, an exception is raised.

• item – The ID (name) or dict representing item to be deleted.

• partition_key – Specifies the partition key value for the item.

• populate_query_metrics – Enable returning query metrics in response headers.

• pre_trigger_include – trigger id to be used as pre operation trigger.

• post_trigger_include – trigger id to be used as post operation trigger.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

None

Get the conflict identified by conflict.

• conflict – The ID (name) or dict representing the conflict to retrieve.

• partition_key – Partition key for the conflict to retrieve.

response_hook (Callable) – A callable invoked with the response metadata.

A dict representing the retrieved conflict.

CosmosHttpResponseError – The given conflict couldn’t be retrieved.

dict[str, Any]

List all the conflicts in the container.

max_item_count – Max number of items to be returned in the enumeration operation.

response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of conflicts (dicts).

Iterable[dict[str, Any]]

Return all conflicts matching a given query.

• query – The Azure Cosmos DB SQL query to execute.

• parameters – Optional array of parameters to the query. Ignored if no query is provided.

• enable_cross_partition_query – Allows sending of more than one request to execute the query in the Azure Cosmos DB service. More than one request is necessary if the query is not scoped to single partition key value.

• partition_key – Specifies the partition key value for the item.

• max_item_count – Max number of items to be returned in the enumeration operation.

response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of conflicts (dicts).

Iterable[dict[str, Any]]

Return all results matching the given query.

You can use any value for the container name in the FROM clause, but often the container name is used. In the examples below, the container name is “products,” and is aliased as “p” for easier referencing in the WHERE clause.

• query – The Azure Cosmos DB SQL query to execute.

• parameters – Optional array of parameters to the query. Ignored if no query is provided.

• partition_key – Specifies the partition key value for the item.

• enable_cross_partition_query – Allows sending of more than one request to execute the query in the Azure Cosmos DB service. More than one request is necessary if the query is not scoped to single partition key value.

• max_item_count – Max number of items to be returned in the enumeration operation.

• enable_scan_in_query – Allow scan on the queries which couldn’t be served as indexing was opted out on the requested paths.

• populate_query_metrics – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of items (dicts).

Iterable[dict[str, Any]]

Example:

import json for item in container.query_items( query='SELECT * FROM products p WHERE p.productModel <> "DISCONTINUED"', enable_cross_partition_query=True, ): print(json.dumps(item, indent=True)) 

discontinued_items = container.query_items( query='SELECT * FROM products p WHERE p.productModel = @model AND p.productName="Widget"', parameters=[dict(name="@model", value="DISCONTINUED")], ) for item in discontinued_items: print(json.dumps(item, indent=True)) 

Get a sorted list of items that were changed, in the order in which they were modified.

• partition_key_range_id – ChangeFeed requests can be executed against specific partition key ranges. This is used to process the change feed in parallel across multiple consumers.

• is_start_from_beginning – Get whether change feed should start from beginning (true) or from current (false). By default it’s start from current (false).

• continuation – e_tag value to be used as continuation for reading change feed.

• max_item_count – Max number of items to be returned in the enumeration operation.

response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of items (dicts).

Iterable[dict[str, Any]]

Read the container properties.

• populate_query_metrics – Enable returning query metrics in response headers.

• populate_partition_key_range_statistics – Enable returning partition key range statistics in response headers.

• populate_quota_info – Enable returning collection storage quota information in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

CosmosHttpResponseError – Raised if the container couldn’t be retrieved. This includes if the container does not exist.

Dict representing the retrieved container.

dict[str, Any]

List all the items in the container.

• max_item_count – Max number of items to be returned in the enumeration operation.

• populate_query_metrics – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of items (dicts).

Iterable[dict[str, Any]]

Get the item identified by item.

• item – The ID (name) or dict representing item to retrieve.

• partition_key – Partition key for the item to retrieve.

• populate_query_metrics – Enable returning query metrics in response headers.

• post_trigger_include – trigger id to be used as post operation trigger.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

Dict representing the item to be retrieved.

CosmosHttpResponseError – The given item couldn’t be retrieved.

dict[str, Any]

Example:

item = container.read_item("item2", partition_key="Widget") item["productModel"] = "DISCONTINUED" updated_item = container.upsert_item(item) 

Read the Offer object for this container.

If no Offer already exists for the container, an exception is raised.

response_hook (Callable) – A callable invoked with the response metadata.

Offer for the container.

CosmosHttpResponseError – No offer exists for the container or the offer could not be retrieved.

Offer

Replaces the specified item if it exists in the container.

If the item does not already exist in the container, an exception is raised.

• item – The ID (name) or dict representing item to be replaced.

• body – A dict-like object representing the item to replace.

• populate_query_metrics – Enable returning query metrics in response headers.

• pre_trigger_include – trigger id to be used as pre operation trigger.

• post_trigger_include – trigger id to be used as post operation trigger.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A dict representing the item after replace went through.

CosmosHttpResponseError – The replace failed or the item with given id does not exist.

dict[str, Any]

Replace the container’s throughput.

If no Offer already exists for the container, an exception is raised.

throughput – The throughput to be set (an integer).

response_hook (Callable) – A callable invoked with the response metadata.

Offer for the container, updated with new throughput.

CosmosHttpResponseError – No offer exists for the container or the offer could not be updated.

Offer

Insert or update the specified item.

If the item already exists in the container, it is replaced. If the item does not already exist, it is inserted.

• body – A dict-like object representing the item to update or insert.

• populate_query_metrics – Enable returning query metrics in response headers.

• pre_trigger_include – trigger id to be used as pre operation trigger.

• post_trigger_include – trigger id to be used as post operation trigger.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A dict representing the upserted item.

CosmosHttpResponseError – The given item could not be upserted.

dict[str, Any]

Key used to partition a container into logical partitions.

See https://docs.microsoft.com/azure/cosmos-db/partitioning-overview#choose-partitionkey for information on how to choose partition keys.

• path – The path of the partition key

• kind – What kind of partition key is being defined (default: “Hash”)

• version – The version of the partition key (default: 2)

Returns a new dict with keys from iterable and values equal to value.

If key is not found, d is returned if given, otherwise KeyError is raised

2-tuple; but raise KeyError if D is empty.

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

Represents a Permission object in the Azure Cosmos DB SQL API service.

An interface to interact with stored procedures.

This class should not be instantiated directly. Instead, use the ContainerProxy.scripts() attribute.

Create a new stored procedure in the container.

To replace an existing sproc, use the Container.scripts.replace_stored_procedure() method.

body – A dict-like object representing the sproc to create.

A dict representing the new stored procedure.

CosmosHttpResponseError – If the given stored procedure couldn’t be created.

dict[str, Any]

Create a trigger in the container.

To replace an existing trigger, use the ContainerProxy.scripts.replace_trigger() method.

body – A dict-like object representing the trigger to create.

A dict representing the new trigger.

CosmosHttpResponseError – If the given trigger couldn’t be created.

dict[str, Any]

Create a user-defined function in the container.

To replace an existing UDF, use the ContainerProxy.scripts.replace_user_defined_function() method.

body – A dict-like object representing the udf to create.

A dict representing the new user-defined function.

CosmosHttpResponseError – If the user-defined function couldn’t be created.

dict[str, Any]

Delete a specified stored procedure from the container.

If the stored procedure does not already exist in the container, an exception is raised.

sproc – The ID (name) or dict representing stored procedure to be deleted.

None

Delete a specified trigger from the container.

If the trigger does not already exist in the container, an exception is raised.

trigger – The ID (name) or dict representing trigger to be deleted.

None

Delete a specified user-defined function from the container.

If the UDF does not already exist in the container, an exception is raised.

udf – The ID (name) or dict representing udf to be deleted.

None

Execute a specified stored procedure.

If the stored procedure does not already exist in the container, an exception is raised.

• sproc – The ID (name) or dict representing stored procedure to be executed.

• partition_key – Specifies the partition key to indicate which partition the sproc should execute on.

• params – List of parameters to be passed to the stored procedure to be executed.

• enable_script_logging (bool) – Enables or disables script logging for the current request.

Result of the executed stored procedure for the given parameters.

CosmosHttpResponseError – If the stored procedure execution failed or if the stored procedure with given id does not exists in the container.

dict[str, Any]

Get the stored procedure identified by id.

sproc – The ID (name) or dict representing stored procedure to retrieve.

A dict representing the retrieved stored procedure.

CosmosHttpResponseError – If the given stored procedure couldn’t be retrieved.

dict[str, Any]

Get a trigger identified by id.

trigger – The ID (name) or dict representing trigger to retrieve.

A dict representing the retrieved trigger.

CosmosHttpResponseError – If the given trigger couldn’t be retrieved.

dict[str, Any]

Get a user-defined functions identified by id.

udf – The ID (name) or dict representing udf to retrieve.

A dict representing the retrieved user-defined function.

CosmosHttpResponseError – If the user-defined function couldn’t be retrieved.

Iterable[dict[str, Any]]

List all stored procedures in the container.

max_item_count (int) – Max number of items to be returned in the enumeration operation.

An Iterable of stored procedures (dicts).

Iterable[dict[str, Any]]

List all triggers in the container.

max_item_count – Max number of items to be returned in the enumeration operation.

An Iterable of triggers (dicts).

Iterable[dict[str, Any]]

List all the user-defined functions in the container.

max_item_count – Max number of items to be returned in the enumeration operation.

An Iterable of user-defined functions (dicts).

Iterable[dict[str, Any]]

Return all stored procedures matching the given query.

• query – The Azure Cosmos DB SQL query to execute.

• parameters – Optional array of parameters to the query. Ignored if no query is provided.

• max_item_count – Max number of items to be returned in the enumeration operation.

An Iterable of stored procedures (dicts).

Iterable[dict[str, Any]]

Return all triggers matching the given query.

• query – The Azure Cosmos DB SQL query to execute.

• parameters – Optional array of parameters to the query. Ignored if no query is provided.

• max_item_count – Max number of items to be returned in the enumeration operation.

An Iterable of triggers (dicts).

Iterable[dict[str, Any]]

Return user-defined functions matching a given query.

• query – The Azure Cosmos DB SQL query to execute.

• parameters – Optional array of parameters to the query. Ignored if no query is provided.

• max_item_count – Max number of items to be returned in the enumeration operation.

An Iterable of user-defined functions (dicts).

Iterable[dict[str, Any]]

Replace a specified stored procedure in the container.

If the stored procedure does not already exist in the container, an exception is raised.

• sproc – The ID (name) or dict representing stored procedure to be replaced.

• body – A dict-like object representing the sproc to replace.

A dict representing the stored procedure after replace went through.

CosmosHttpResponseError – If the replace failed or the stored procedure with given id does not exist.

dict[str, Any]

Replace a specified tigger in the container.

If the trigger does not already exist in the container, an exception is raised.

• trigger – The ID (name) or dict representing trigger to be replaced.

• body – A dict-like object representing the trigger to replace.

A dict representing the trigger after replace went through.

CosmosHttpResponseError – If the replace failed or the trigger with given id does not exist.

dict[str, Any]

Replace a specified user-defined function in the container.

If the UDF does not already exist in the container, an exception is raised.

• udf – The ID (name) or dict representing udf to be replaced.

• body – A dict-like object representing the udf to replace.

A dict representing the user-defined function after replace went through.

CosmosHttpResponseError – If the replace failed or the user-defined function with the given id does not exist.

dict[str, Any]

An interface to interact with a specific user.

This class should not be instantiated directly. Instead, use the DatabaseProxy.get_user_client() method.

Create a permission for the user.

To update or replace an existing permision, use the UserProxy.upsert_permission() method.

body – A dict-like object representing the permission to create.

response_hook (Callable) – A callable invoked with the response metadata.

A dict representing the new permission.

CosmosHttpResponseError – If the given permission couldn’t be created.

dict[str, Any]

Delete the specified permission from the user.

If the permission does not already exist, an exception is raised.

permission – The ID (name), dict representing the properties or Permission instance of the permission to be replaced.

response_hook (Callable) – A callable invoked with the response metadata.

None

Get the permission identified by id.

permission – The ID (name), dict representing the properties or Permission instance of the permission to be retrieved.

response_hook (Callable) – A callable invoked with the response metadata.

A dict representing the retrieved permission.

CosmosHttpResponseError – If the given permission couldn’t be retrieved.

dict[str, Any]

List all permission for the user.

max_item_count – Max number of permissions to be returned in the enumeration operation.

response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of permissions (dicts).

Iterable[dict[str, Any]]

Return all permissions matching the given query.

• query – The Azure Cosmos DB SQL query to execute.

• parameters – Optional array of parameters to the query. Ignored if no query is provided.

• max_item_count – Max number of permissions to be returned in the enumeration operation.

response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of permissions (dicts).

Iterable[dict[str, Any]]

Read user propertes.

response_hook (Callable) – A callable invoked with the response metadata.

A dictionary of the retrieved user properties.

CosmosHttpResponseError – If the given user couldn’t be retrieved.

dict[str, Any]

Replaces the specified permission if it exists for the user.

If the permission does not already exist, an exception is raised.

• permission – The ID (name), dict representing the properties or Permission instance of the permission to be replaced.

• body – A dict-like object representing the permission to replace.

response_hook (Callable) – A callable invoked with the response metadata.

A dict representing the permission after replace went through.

CosmosHttpResponseError – If the replace failed or the permission with given id does not exist.

dict[str, Any]

Insert or update the specified permission.

If the permission already exists in the container, it is replaced. If the permission does not exist, it is inserted.

• body – A dict-like object representing the permission to update or insert.

• response_hook (Callable) – A callable invoked with the response metadata.

A dict representing the upserted permission.

CosmosHttpResponseError – If the given permission could not be upserted.

dict[str, Any]

Represents a offer in an Azure Cosmos DB SQL API container.

To read and update offers use the associated methods on the Container.

Database account.

A DatabaseAccount is the container for databases.

• DatabaseLink (str) – The self-link for Databases in the databaseAccount.

• MediaLink (str) – The self-link for Media in the databaseAccount.

• MaxMediaStorageUsageInMB (int) – Attachment content (media) storage quota in MBs (Retrieved from gateway).

• CurrentMediaStorageUsageInMB (int) – Current attachment content (media) usage in MBs (Retrieved from gateway). Value is returned from cached information updated periodically and is not guaranteed to be real time.

• ConsistencyPolicy (dict) – UserConsistencyPolicy settings.

• ConsistencyPolicy['defaultConsistencyLevel'] (dict) – The default consistency level.

• ConsistencyPolicy['maxStalenessPrefix'] (int) – In bounded staleness consistency, the maximum allowed staleness in terms difference in sequence numbers (aka version).

• ConsistencyPolicy['maxStalenessIntervalInSeconds'] (int) – In bounded staleness consistency, the maximum allowed staleness in terms time interval.

• EnableMultipleWritableLocations (boolean) – Flag on the azure Cosmos account that indicates if writes can take place in multiple locations.

The list of readable locations for a geo-replicated database account.

The list of writable locations for a geo-replicated database account.

Represents the consistency levels supported for Azure Cosmos client operations.

The requested ConsistencyLevel must match or be weaker than that provisioned for the database account. Consistency levels.

Consistency levels by order of strength are Strong, BoundedStaleness, Session, ConsistentPrefix and Eventual.

• ConsistencyLevel.Strong (str) – Strong Consistency guarantees that read operations always return the value that was last written.

• ConsistencyLevel.BoundedStaleness (str) – Bounded Staleness guarantees that reads are not too out-of-date. This can be configured based on number of operations (MaxStalenessPrefix) or time (MaxStalenessIntervalInSeconds).

• ConsistencyLevel.Session (str) – Session Consistency guarantees monotonic reads (you never read old data, then new, then old again), monotonic writes (writes are ordered) and read your writes (your writes are immediately visible to your reads) within any single session.

• ConsistencyLevel.Eventual (str) – Eventual Consistency guarantees that reads will return a subset of writes. All writes will be eventually be available for reads.

• ConsistencyLevel.ConsistentPrefix (str) – ConsistentPrefix Consistency guarantees that reads will return some prefix of all writes with no gaps. All writes will be eventually be available for reads.

Specifies the data type of index specs.

Specifies the index kind of index specs.

• IndexKind.Hash (str) – The index entries are hashed to serve point look up queries. Can be used to serve queries like: SELECT * FROM docs d WHERE d.prop = 5

• IndexKind.Range (str) – The index entries are ordered. Range indexes are optimized for inequality predicate queries with efficient range scans. Can be used to serve queries like: SELECT * FROM docs d WHERE d.prop > 5

Specifies the supported indexing modes.

• Consistent (str) –

  Index is updated synchronously with a create or update operation. With consistent indexing, query behavior is the same as the default consistency level for the collection.

  The index is always kept up to date with the data.

• Lazy (str) –

  Index is updated asynchronously with respect to a create or update operation.

  With lazy indexing, queries are eventually consistent. The index is updated when the collection is idle.

• NoIndex (str) –

  No index is provided.

  Setting IndexingMode to “None” drops the index. Use this if you don’t want to maintain the index for a document collection, to save the storage cost or improve the write throughput. Your queries will degenerate to scans of the entire collection.

Enumeration specifying applicability of a permission.

Configuration for a proxy.

• Host (str) – The host address of the proxy.

• Port (int) – The port number of the proxy.

Configuration for SSL connections.

See https://requests.readthedocs.io/en/master/user/advanced/#ssl-cert-verification for more information.

• SSLKeyFIle (str) – The path of the key file for ssl connection.

• SSLCertFile (str) – The path of the cert file for ssl connection.

• SSLCaCerts (str) – The path of the CA_BUNDLE file with certificates of trusted CAs.

Specifies the operations on which a trigger should be executed.

Specifies the type of a trigger.

Configures the retry settings.

options – keyword arguments from context.

A dict containing settings and history for retries.

dict

Returns the current backoff time.

settings (dict) – The retry settings.

The current backoff value.

float

Get the value of Retry-After in seconds.

response (PipelineResponse) – The PipelineResponse object

Value of Retry-After in seconds.

float or None

Increment the retry counters.

• settings – The retry settings.

• response (PipelineResponse) – A pipeline response object.

• error – An error encountered during the request, or None if the response was received successfully.

Whether any retry attempt is available True if more retry attempts available, False otherwise

bool

Checks if any retries left.

settings (dict) – the retry settings

False if have more retries. True if retries exhausted.

bool

Checks if method/status code is retryable.

Based on whitelists and control variables such as the number of total retries to allow, whether to respect the Retry-After header, whether this header is present, and whether the returned status code is on the list of status codes to be retried upon on the presence of the aforementioned header.

The behavior is: - If status_code < 400: don’t retry - Else if Retry-After present: retry - Else: retry based on the safe status code list ([408, 429, 500, 502, 503, 504])

True if method/status code is retryable. False if not retryable.

bool

Disable retries.

Helper to parse Retry-After and get value in seconds.

retry_after (str) – Retry-After header

float

Sends the PipelineRequest object to the next policy. Uses retry settings if necessary. Also enforces an absolute client-side timeout that spans multiple retry attempts.

request (PipelineRequest) – The PipelineRequest object

Returns the PipelineResponse or raises error if maximum retries exceeded.

PipelineResponse

Sleep between retry attempts.

This method will respect a server’s Retry-After response header and sleep the duration of the time requested. If that is not present, it will use an exponential backoff. By default, the backoff factor is 0 and this method will return immediately.

• settings (dict) – The retry settings.

• transport – The HTTP transport type.

• response (PipelineResponse) – The PipelineResponse object.

Updates retry history in pipeline context.

• context (PipelineContext) – The pipeline context.

• retry_settings (dict) – The retry settings.

Submodules¶

azure.cosmos.auth module¶

Authorization helper functions in the Azure Cosmos database service.

Gets the authorization header.

• cosmos_client (cosmos_client_connection.CosmosClient) –

• verb (str) –

• path (str) –

• resource_id_or_fullname (str) –

• resource_type (str) –

• headers (dict) –

The authorization headers.

dict

azure.cosmos.container module¶

Create, read, update and delete items in the Azure Cosmos DB SQL API service.

An interface to interact with a specific DB Container.

This class should not be instantiated directly. Instead, use the DatabaseProxy.get_container_client() method to get an existing container, or the Database.create_container() method to create a new container.

A container in an Azure Cosmos DB SQL API database is a collection of documents, each of which is represented as an Item.

• id (str) – ID (name) of the container

• session_token (str) – The session token for the container.

Create an item in the container.

To update or replace an existing item, use the ContainerProxy.upsert_item() method.

• body – A dict-like object representing the item to create.

• populate_query_metrics – Enable returning query metrics in response headers.

• pre_trigger_include – trigger id to be used as pre operation trigger.

• post_trigger_include – trigger id to be used as post operation trigger.

• indexing_directive – Indicate whether the document should be omitted from indexing.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A dict representing the new item.

CosmosHttpResponseError – Item with the given ID already exists.

dict[str, Any]

Delete a specified conflict from the container.

If the conflict does not already exist in the container, an exception is raised.

• conflict – The ID (name) or dict representing the conflict to be deleted.

• partition_key – Partition key for the conflict to delete.

response_hook (Callable) – A callable invoked with the response metadata.

None

Delete the specified item from the container.

If the item does not already exist in the container, an exception is raised.

• item – The ID (name) or dict representing item to be deleted.

• partition_key – Specifies the partition key value for the item.

• populate_query_metrics – Enable returning query metrics in response headers.

• pre_trigger_include – trigger id to be used as pre operation trigger.

• post_trigger_include – trigger id to be used as post operation trigger.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

None

Get the conflict identified by conflict.

• conflict – The ID (name) or dict representing the conflict to retrieve.

• partition_key – Partition key for the conflict to retrieve.

response_hook (Callable) – A callable invoked with the response metadata.

A dict representing the retrieved conflict.

CosmosHttpResponseError – The given conflict couldn’t be retrieved.

dict[str, Any]

List all the conflicts in the container.

max_item_count – Max number of items to be returned in the enumeration operation.

response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of conflicts (dicts).

Iterable[dict[str, Any]]

Return all conflicts matching a given query.

• query – The Azure Cosmos DB SQL query to execute.

• parameters – Optional array of parameters to the query. Ignored if no query is provided.

• enable_cross_partition_query – Allows sending of more than one request to execute the query in the Azure Cosmos DB service. More than one request is necessary if the query is not scoped to single partition key value.

• partition_key – Specifies the partition key value for the item.

• max_item_count – Max number of items to be returned in the enumeration operation.

response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of conflicts (dicts).

Iterable[dict[str, Any]]

Return all results matching the given query.

You can use any value for the container name in the FROM clause, but often the container name is used. In the examples below, the container name is “products,” and is aliased as “p” for easier referencing in the WHERE clause.

• query – The Azure Cosmos DB SQL query to execute.

• parameters – Optional array of parameters to the query. Ignored if no query is provided.

• partition_key – Specifies the partition key value for the item.

• enable_cross_partition_query – Allows sending of more than one request to execute the query in the Azure Cosmos DB service. More than one request is necessary if the query is not scoped to single partition key value.

• max_item_count – Max number of items to be returned in the enumeration operation.

• enable_scan_in_query – Allow scan on the queries which couldn’t be served as indexing was opted out on the requested paths.

• populate_query_metrics – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of items (dicts).

Iterable[dict[str, Any]]

Example:

import json for item in container.query_items( query='SELECT * FROM products p WHERE p.productModel <> "DISCONTINUED"', enable_cross_partition_query=True, ): print(json.dumps(item, indent=True)) 

discontinued_items = container.query_items( query='SELECT * FROM products p WHERE p.productModel = @model AND p.productName="Widget"', parameters=[dict(name="@model", value="DISCONTINUED")], ) for item in discontinued_items: print(json.dumps(item, indent=True)) 

Get a sorted list of items that were changed, in the order in which they were modified.

• partition_key_range_id – ChangeFeed requests can be executed against specific partition key ranges. This is used to process the change feed in parallel across multiple consumers.

• is_start_from_beginning – Get whether change feed should start from beginning (true) or from current (false). By default it’s start from current (false).

• continuation – e_tag value to be used as continuation for reading change feed.

• max_item_count – Max number of items to be returned in the enumeration operation.

response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of items (dicts).

Iterable[dict[str, Any]]

Read the container properties.

• populate_query_metrics – Enable returning query metrics in response headers.

• populate_partition_key_range_statistics – Enable returning partition key range statistics in response headers.

• populate_quota_info – Enable returning collection storage quota information in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

CosmosHttpResponseError – Raised if the container couldn’t be retrieved. This includes if the container does not exist.

Dict representing the retrieved container.

dict[str, Any]

List all the items in the container.

• max_item_count – Max number of items to be returned in the enumeration operation.

• populate_query_metrics – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of items (dicts).

Iterable[dict[str, Any]]

Get the item identified by item.

• item – The ID (name) or dict representing item to retrieve.

• partition_key – Partition key for the item to retrieve.

• populate_query_metrics – Enable returning query metrics in response headers.

• post_trigger_include – trigger id to be used as post operation trigger.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

Dict representing the item to be retrieved.

CosmosHttpResponseError – The given item couldn’t be retrieved.

dict[str, Any]

Example:

item = container.read_item("item2", partition_key="Widget") item["productModel"] = "DISCONTINUED" updated_item = container.upsert_item(item) 

Read the Offer object for this container.

If no Offer already exists for the container, an exception is raised.

response_hook (Callable) – A callable invoked with the response metadata.

Offer for the container.

CosmosHttpResponseError – No offer exists for the container or the offer could not be retrieved.

Offer

Replaces the specified item if it exists in the container.

If the item does not already exist in the container, an exception is raised.

• item – The ID (name) or dict representing item to be replaced.

• body – A dict-like object representing the item to replace.

• populate_query_metrics – Enable returning query metrics in response headers.

• pre_trigger_include – trigger id to be used as pre operation trigger.

• post_trigger_include – trigger id to be used as post operation trigger.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A dict representing the item after replace went through.

CosmosHttpResponseError – The replace failed or the item with given id does not exist.

dict[str, Any]

Replace the container’s throughput.

If no Offer already exists for the container, an exception is raised.

throughput – The throughput to be set (an integer).

response_hook (Callable) – A callable invoked with the response metadata.

Offer for the container, updated with new throughput.

CosmosHttpResponseError – No offer exists for the container or the offer could not be updated.

Offer

Insert or update the specified item.

If the item already exists in the container, it is replaced. If the item does not already exist, it is inserted.

• body – A dict-like object representing the item to update or insert.

• populate_query_metrics – Enable returning query metrics in response headers.

• pre_trigger_include – trigger id to be used as pre operation trigger.

• post_trigger_include – trigger id to be used as post operation trigger.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A dict representing the upserted item.

CosmosHttpResponseError – The given item could not be upserted.

dict[str, Any]

azure.cosmos.cosmos_client module¶

Create, read, and delete databases in the Azure Cosmos DB SQL API service.

A client-side logical representation of an Azure Cosmos DB account.

Use this client to configure and execute requests to the Azure Cosmos DB service.

• url (str) – The URL of the Cosmos DB account.

• credential (str or dict[str, str]) – Can be the account key, or a dictionary of resource tokens.

• consistency_level (str) – Consistency level to use for the session. The default value is “Session”.

• timeout (int) – An absolute timeout in seconds, for the combined HTTP request and response processing.

• request_timeout (int) – The HTTP request timeout in seconds.

• connection_mode (str) – The connection mode for the client - currently only supports ‘Gateway’.

• proxy_config (ProxyConfiguration) – Connection proxy configuration.

• ssl_config (SSLConfiguration) – Connection SSL configuration.

• connection_verify (bool) – Whether to verify the connection, default value is True.

• connection_cert (str) – An alternative certificate to verify the connection.

• retry_total (int) – Maximum retry attempts.

• retry_backoff_max (int) – Maximum retry wait time in seconds.

• retry_fixed_interval (int) – Fixed retry interval in milliseconds.

• retry_read (int) – Maximum number of socket read retry attempts.

• retry_connect (int) – Maximum number of connection error retry attempts.

• retry_status (int) – Maximum number of retry attempts on error status codes.

• retry_on_status_codes (list[int]) – A list of specific status codes to retry on.

• retry_backoff_factor (float) – Factor to calculate wait time between retry attempts.

• enable_endpoint_discovery (bool) – Enable endpoint discovery for geo-replicated database accounts. (Default: True)

• preferred_locations (list[str]) – The preferred locations for geo-replicated database accounts.

Example:

from azure.cosmos import exceptions, CosmosClient, PartitionKey import os url = os.environ["ACCOUNT_URI"] key = os.environ["ACCOUNT_KEY"] client = CosmosClient(url, key) 

Instantiate a new CosmosClient.

Create a new database with the given ID (name).

• id – ID (name) of the database to create.

• populate_query_metrics (bool) – Enable returning query metrics in response headers.

• offer_throughput (int) – The provisioned throughput for this offer.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A DatabaseProxy instance representing the new database.

DatabaseProxy

CosmosResourceExistsError – Database with the given ID already exists.

Example:

database_name = "testDatabase" try: database = client.create_database(id=database_name) except exceptions.CosmosResourceExistsError: database = client.get_database_client(database=database_name) 

Create the database if it does not exist already.

If the database already exists, the existing settings are returned.

This function does not check or update existing database settings or offer throughput if they differ from what is passed in.

• id – ID (name) of the database to read or create.

• populate_query_metrics (bool) – Enable returning query metrics in response headers.

• offer_throughput (int) – The provisioned throughput for this offer.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A DatabaseProxy instance representing the database.

DatabaseProxy

CosmosHttpResponseError – The database read or creation failed.

Delete the database with the given ID (name).

• database (str or dict(str, str) or DatabaseProxy) – The ID (name), dict representing the properties or DatabaseProxy instance of the database to delete.

• populate_query_metrics (bool) – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

CosmosHttpResponseError – If the database couldn’t be deleted.

None

Create a CosmosClient instance from a connection string.

This can be retrieved from the Azure portal.For full list of optional keyword arguments, see the CosmosClient constructor.

• conn_str (str) – The connection string.

• credential (str or dict(str, str)) – Alternative credentials to use instead of the key provided in the connection string.

• consistency_level (str) – Consistency level to use for the session. The default value is “Session”.

Retrieve the database account information.

response_hook (Callable) – A callable invoked with the response metadata.

A DatabaseAccount instance representing the Cosmos DB Database Account.

DatabaseAccount

Retrieve an existing database with the ID (name) id.

database (str or dict(str, str) or DatabaseProxy) – The ID (name), dict representing the properties or DatabaseProxy instance of the database to read.

A DatabaseProxy instance representing the retrieved database.

DatabaseProxy

List the databases in a Cosmos DB SQL database account.

• max_item_count (int) – Max number of items to be returned in the enumeration operation.

• populate_query_metrics (bool) – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of database properties (dicts).

Iterable[dict[str, str]]

Query the databases in a Cosmos DB SQL database account.

• query (str) – The Azure Cosmos DB SQL query to execute.

• parameters (list[str]) – Optional array of parameters to the query. Ignored if no query is provided.

• enable_cross_partition_query (bool) – Allow scan on the queries which couldn’t be served as indexing was opted out on the requested paths.

• max_item_count (int) – Max number of items to be returned in the enumeration operation.

• populate_query_metrics (bool) – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of database properties (dicts).

Iterable[dict[str, str]]

azure.cosmos.database module¶

Interact with databases in the Azure Cosmos DB SQL API service.

An interface to interact with a specific database.

This class should not be instantiated directly. Instead use the CosmosClient.get_database_client() method.

A database contains one or more containers, each of which can contain items, stored procedures, triggers, and user-defined functions.

A database can also have associated users, each of which is configured with a set of permissions for accessing certain containers, stored procedures, triggers, user-defined functions, or items.

id – The ID (name) of the database.

An Azure Cosmos DB SQL API database has the following system-generated properties. These properties are read-only:

• _rid: The resource ID.

• _ts: When the resource was last updated. The value is a timestamp.

• _self: The unique addressable URI for the resource.

• _etag: The resource etag required for optimistic concurrency control.

• _colls: The addressable path of the collections resource.

• _users: The addressable path of the users resource.

• client_connection (ClientSession) – Client from which this database was retrieved.

• id (str) – ID (name) of the database.

Create a new container with the given ID (name).

If a container with the given ID already exists, a CosmosResourceExistsError is raised.

• id – ID (name) of container to create.

• partition_key – The partition key to use for the container.

• indexing_policy – The indexing policy to apply to the container.

• default_ttl – Default time to live (TTL) for items in the container. If unspecified, items do not expire.

• populate_query_metrics – Enable returning query metrics in response headers.

• offer_throughput – The provisioned throughput for this offer.

• unique_key_policy – The unique key policy to apply to the container.

• conflict_resolution_policy – The conflict resolution policy to apply to the container.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A ContainerProxy instance representing the new container.

CosmosHttpResponseError – The container creation failed.

ContainerProxy

Example:

container_name = "products" try: container = database.create_container( id=container_name, partition_key=PartitionKey(path="/productName") ) except exceptions.CosmosResourceExistsError: container = database.get_container_client(container_name) 

customer_container_name = "customers" try: customer_container = database.create_container( id=customer_container_name, partition_key=PartitionKey(path="/city"), default_ttl=200, ) except exceptions.CosmosResourceExistsError: customer_container = database.get_container_client(customer_container_name) 

Create a container if it does not exist already.

If the container already exists, the existing settings are returned. Note: it does not check or update the existing container settings or offer throughput if they differ from what was passed into the method.

• id – ID (name) of container to read or create.

• partition_key – The partition key to use for the container.

• indexing_policy – The indexing policy to apply to the container.

• default_ttl – Default time to live (TTL) for items in the container. If unspecified, items do not expire.

• populate_query_metrics – Enable returning query metrics in response headers.

• offer_throughput – The provisioned throughput for this offer.

• unique_key_policy – The unique key policy to apply to the container.

• conflict_resolution_policy – The conflict resolution policy to apply to the container.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

A ContainerProxy instance representing the container.

CosmosHttpResponseError – The container read or creation failed.

ContainerProxy

Create a new user in the container.

To update or replace an existing user, use the ContainerProxy.upsert_user() method.

body – A dict-like object with an id key and value representing the user to be created. The user ID must be unique within the database, and consist of no more than 255 characters.

response_hook (Callable) – A callable invoked with the response metadata.

A UserProxy instance representing the new user.

CosmosHttpResponseError – If the given user couldn’t be created.

UserProxy

Example:

try: database.create_user(dict(id="Walter Harp")) except exceptions.CosmosResourceExistsError: print("A user with that ID already exists.") except exceptions.CosmosHttpResponseError as failure: print("Failed to create user. Status code:{}".format(failure.status_code)) 

Delete a container.

• container – The ID (name) of the container to delete. You can either pass in the ID of the container to delete, a ContainerProxy instance or a dict representing the properties of the container.

• populate_query_metrics – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• response_hook (Callable) – A callable invoked with the response metadata.

CosmosHttpResponseError – If the container couldn’t be deleted.

None

Delete the specified user from the container.

user – The ID (name), dict representing the properties or UserProxy instance of the user to be deleted.

response_hook (Callable) – A callable invoked with the response metadata.

None

Get a ContainerProxy for a container with specified ID (name).

container – The ID (name) of the container, a ContainerProxy instance, or a dict representing the properties of the container to be retrieved.

ContainerProxy

Example:

database = client.get_database_client(database_name) container = database.get_container_client(container_name) 

Get a UserProxy for a user with specified ID.

user – The ID (name), dict representing the properties or UserProxy instance of the user to be retrieved.

A UserProxy instance representing the retrieved user.

CosmosHttpResponseError – If the given user couldn’t be retrieved.

UserProxy

List the containers in the database.

• max_item_count – Max number of items to be returned in the enumeration operation.

• populate_query_metrics – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of container properties (dicts).

Iterable[dict[str, Any]]

Example:

database = client.get_database_client(database_name) for container in database.list_containers(): print("Container ID: {}".format(container.id)) 

List all the users in the container.

max_item_count – Max number of users to be returned in the enumeration operation.

response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of user properties (dicts).

Iterable[dict[str, Any]]

List the properties for containers in the current database.

• query – The Azure Cosmos DB SQL query to execute.

• parameters – Optional array of parameters to the query. Ignored if no query is provided.

• max_item_count – Max number of items to be returned in the enumeration operation.

• populate_query_metrics – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of container properties (dicts).

Iterable[dict[str, Any]]

Return all users matching the given query.

• query – The Azure Cosmos DB SQL query to execute.

• parameters – Optional array of parameters to the query. Ignored if no query is provided.

• max_item_count – Max number of users to be returned in the enumeration operation.

response_hook (Callable) – A callable invoked with the response metadata.

An Iterable of user properties (dicts).

Iterable[str, Any]

Read the database properties.

populate_query_metrics (bool) – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

Dict[Str, Any]

CosmosHttpResponseError – If the given database couldn’t be retrieved.

Read the Offer object for this database.

response_hook (Callable) – A callable invoked with the response metadata.

Offer for the database.

CosmosHttpResponseError – If no offer exists for the database or if the offer could not be retrieved.

Offer

Reset the properties of the container.

Property changes are persisted immediately. Any properties not specified will be reset to their default values.

• container – The ID (name), dict representing the properties or ContainerProxy instance of the container to be replaced.

• partition_key – The partition key to use for the container.

• indexing_policy – The indexing policy to apply to the container.

• default_ttl – Default time to live (TTL) for items in the container. If unspecified, items do not expire.

• conflict_resolution_policy – The conflict resolution policy to apply to the container.

• populate_query_metrics – Enable returning query metrics in response headers.

• session_token (str) – Token for use with Session consistency.

• etag (str) – An ETag value, or the wildcard character (*). Used to check if the resource has changed, and act according to the condition specified by the match_condition parameter.

• match_condition (MatchConditions) – The match condition to use upon the etag.

• initial_headers (dict[str,str]) – Initial headers to be sent as part of the request.

• response_hook (Callable) – A callable invoked with the response metadata.

CosmosHttpResponseError – Raised if the container couldn’t be replaced. This includes if the container with given id does not exist.

A ContainerProxy instance representing the container after replace completed.

ContainerProxy

Example:

# Set the TTL on the container to 3600 seconds (one hour) database.replace_container(container, partition_key=PartitionKey(path='/productName'), default_ttl=3600) # Display the new TTL setting for the container container_props = database.get_container_client(container_name).read() print("New container TTL: {}".format(json.dumps(container_props['defaultTtl']))) 

Replace the database-level throughput.

throughput – The throughput to be set (an integer).

response_hook (Callable) – A callable invoked with the response metadata.

Offer for the database, updated with new throughput.

CosmosHttpResponseError – If no offer exists for the database or if the offer could not be updated.

Offer

Replaces the specified user if it exists in the container.

• user – The ID (name), dict representing the properties or UserProxy instance of the user to be replaced.

• body – A dict-like object representing the user to replace.

response_hook (Callable) – A callable invoked with the response metadata.

A UserProxy instance representing the user after replace went through.

CosmosHttpResponseError – If the replace failed or the user with given ID does not exist.

UserProxy

Insert or update the specified user.

If the user already exists in the container, it is replaced. If the user does not already exist, it is inserted.

body – A dict-like object representing the user to update or insert.

response_hook (Callable) – A callable invoked with the response metadata.

A UserProxy instance representing the upserted user.

CosmosHttpResponseError – If the given user could not be upserted.

UserProxy

azure.cosmos.diagnostics module¶

Diagnostic tools for Azure Cosmos database service operations.

Record Response headers from Cosmos read operations.

The full response headers are stored in the headers property.