Struct DatabaseClient

pub struct DatabaseClient { /* private fields */ }

A client for working with a specific database in a Cosmos DB account.

You can get a DatabaseClient by calling CosmosClient::database_client().

Implementations

impl DatabaseClient

pub fn container_client(&self, name: &str) -> ContainerClient

Gets a ContainerClient that can be used to access the collection with the specified name.

Arguments

• name - The name of the container.

pub fn id(&self) -> &str

Returns the identifier of the Cosmos database.

pub async fn read( &self, options: Option<ReadDatabaseOptions<'_>>, ) -> Result<Response<DatabaseProperties>>

Reads the properties of the database.

Arguments

• options - Optional parameters for the request.

Examples

let response = database_client.read(None)
    .await?
    .into_body()
    .await?;

pub fn query_containers( &self, query: impl Into<Query>, options: Option<QueryContainersOptions<'_>>, ) -> Result<FeedPager<ContainerProperties>>

Executes a query against containers in the database.

Arguments

• query - The query to execute.
• options - Optional parameters for the request.

Examples

The query parameter accepts anything that can be transformed Into a Query. This allows simple queries without parameters to be expressed easily:

let containers = db_client.query_containers(
    "SELECT * FROM dbs",
    None)?;

See Query for more information on how to specify a query.

pub async fn create_container( &self, properties: ContainerProperties, options: Option<CreateContainerOptions<'_>>, ) -> Result<Response<ContainerProperties>>

Creates a new container.

This is a control-plane API and requires that you authenticate using a key. To use Entra ID to perform this operation, you must use the Azure Resource Manager APIs.

Arguments

• properties - A ContainerProperties describing the new container.
• options - Optional parameters for the request.

pub async fn delete( &self, options: Option<DeleteDatabaseOptions<'_>>, ) -> Result<Response<()>>

Deletes this database.

This is a control-plane API and requires that you authenticate using a key. To use Entra ID to perform this operation, you must use the Azure Resource Manager APIs.

Arguments

• options - Optional parameters for the request.

pub async fn read_throughput( &self, options: Option<ThroughputOptions<'_>>, ) -> Result<Option<Response<ThroughputProperties>>>

Reads database throughput properties, if any.

This will return None if the database does not have a throughput offer configured.

Arguments

• options - Optional parameters for the request.

pub async fn replace_throughput( &self, throughput: ThroughputProperties, options: Option<ThroughputOptions<'_>>, ) -> Result<Response<ThroughputProperties>>

Replaces the database throughput properties.

Arguments

• throughput - The new throughput properties to set.
• options - Optional parameters for the request.