aio Package

Classes

ContainerProxy

An interface to interact with a specific DB Container.

This class should not be instantiated directly. Instead, use the <xref:azure.cosmos.aio.database.DatabaseProxy.get_container_client> method to get an existing container, or the <xref:azure.cosmos.aio.database.DatabaseProxy.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.

CosmosClient

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.

It's recommended to maintain a single instance of CosmosClient per lifetime of the application which enables efficient connection management and performance.

CosmosClient initialization is a heavy operation - don't use initialization CosmosClient instances as credentials or network connectivity validations.

Instantiate a new CosmosClient.

DatabaseProxy

An interface to interact with a specific database.

This class should not be instantiated directly. Instead use the get_database_client method to get an existing database, or the create_database method to create a new database.

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.

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.

ScriptsProxy

An interface to interact with stored procedures.

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

UserProxy

An interface to interact with a specific user.

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