Add container client options by analogrelay · Pull Request #4992 · Azure/azure-sdk-for-rust

Ashley Stanton-Nurse (analogrelay) · 2026-08-05T20:35:07Z

DatabaseClient::container_client needs an options argument so future client construction settings can be added without another signature change.

This adds OperationOptions to the public ContainerClientOptions type and carries those settings through container metadata resolution into the driver. Existing callers pass None, preserving behavior, and the README example documents the required argument.

The driver API now accepts operation options for container resolution while retaining default options for its existing direct callers.

Fixes: #4617

Add the required optional options argument to DatabaseClient::container_client and update all call sites so the API can evolve without another signature change. Document the breaking migration and preserve existing behavior by passing None. Fixes Azure#4617 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

azure-pipelines · 2026-08-05T20:35:29Z

Azure Pipelines: Successfully started running 1 pipeline(s). 2 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run.

Copilot

Pull request overview

Adds a future-proof options parameter to container client construction and migrates existing callers.

Changes:

Public API: adds and exports ContainerClientOptions.
Requires DatabaseClient::container_client callers to pass optional options.
Updates call sites and documents the breaking change.

Show a summary per file

File	Description
`sdk/cosmos/azure_data_cosmos/src/clients/database_client.rs`	Adds the options parameter.
`sdk/cosmos/azure_data_cosmos/src/options/container.rs`	Defines the options type.
`sdk/cosmos/azure_data_cosmos/src/options/mod.rs`	Exports the options type.
`sdk/cosmos/azure_data_cosmos/CHANGELOG.md`	Documents migration.
`sdk/cosmos/azure_data_cosmos/examples/cosmos/batch.rs`	Migrates example.
`sdk/cosmos/azure_data_cosmos/examples/cosmos/create.rs`	Migrates example.
`sdk/cosmos/azure_data_cosmos/examples/cosmos/delete.rs`	Migrates example.
`sdk/cosmos/azure_data_cosmos/examples/cosmos/metadata.rs`	Migrates example.
`sdk/cosmos/azure_data_cosmos/examples/cosmos/query.rs`	Migrates example.
`sdk/cosmos/azure_data_cosmos/examples/cosmos/read.rs`	Migrates example.
`sdk/cosmos/azure_data_cosmos/examples/cosmos/replace.rs`	Migrates example.
`sdk/cosmos/azure_data_cosmos/examples/cosmos/upsert.rs`	Migrates example.
`sdk/cosmos/azure_data_cosmos/tests/emulator_tests/cosmos_aad.rs`	Migrates tests.
`sdk/cosmos/azure_data_cosmos/tests/emulator_tests/cosmos_batch.rs`	Migrates tests.
`sdk/cosmos/azure_data_cosmos/tests/emulator_tests/cosmos_containers.rs`	Migrates tests.
`sdk/cosmos/azure_data_cosmos/tests/emulator_tests/cosmos_fault_injection.rs`	Migrates tests.
`sdk/cosmos/azure_data_cosmos/tests/emulator_tests/cosmos_items.rs`	Migrates tests.
`sdk/cosmos/azure_data_cosmos/tests/emulator_tests/cosmos_patch.rs`	Migrates tests.
`sdk/cosmos/azure_data_cosmos/tests/emulator_tests/cosmos_query_features.rs`	Migrates tests.
`sdk/cosmos/azure_data_cosmos/tests/emulator_tests/cosmos_response_metadata.rs`	Migrates tests.
`sdk/cosmos/azure_data_cosmos/tests/framework/test_client.rs`	Migrates test helpers.
`sdk/cosmos/azure_data_cosmos/tests/framework/test_data.rs`	Migrates test data helper.
`sdk/cosmos/azure_data_cosmos/tests/gateway_v2_tests/gateway_v2_e2e.rs`	Migrates gateway tests.
`sdk/cosmos/azure_data_cosmos/tests/in_memory_emulator_tests/binary_round_trip.rs`	Migrates emulator tests.
`sdk/cosmos/azure_data_cosmos/tests/in_memory_emulator_tests/change_feed.rs`	Migrates emulator tests.
`sdk/cosmos/azure_data_cosmos/tests/in_memory_emulator_tests/cosmos_hpk_split.rs`	Migrates emulator tests.
`sdk/cosmos/azure_data_cosmos/tests/in_memory_emulator_tests/dtx_sdk_validation.rs`	Migrates validation tests.
`sdk/cosmos/azure_data_cosmos/tests/in_memory_emulator_tests/end_to_end.rs`	Migrates end-to-end tests.
`sdk/cosmos/azure_data_cosmos/tests/in_memory_emulator_tests/handler_propagation.rs`	Migrates handler tests.
`sdk/cosmos/azure_data_cosmos/tests/in_memory_emulator_tests/hpk.rs`	Migrates HPK tests.
`sdk/cosmos/azure_data_cosmos/tests/in_memory_emulator_tests/partition_key_equality.rs`	Migrates partition tests.
`sdk/cosmos/azure_data_cosmos/tests/in_memory_emulator_tests/partition_range_drain.rs`	Migrates drain test.
`sdk/cosmos/azure_data_cosmos/tests/in_memory_emulator_tests/query_comparison.rs`	Migrates query tests.
`sdk/cosmos/azure_data_cosmos/tests/in_memory_emulator_tests/user_agent.rs`	Migrates user-agent tests.
`sdk/cosmos/azure_data_cosmos/tests/multi_write_tests/cosmos_multi_write_fault_injection.rs`	Migrates fault tests.
`sdk/cosmos/azure_data_cosmos/tests/multi_write_tests/cosmos_multi_write_retry_policies.rs`	Migrates retry tests.
`sdk/cosmos/azure_data_cosmos_perf/src/setup.rs`	Migrates performance setup.
`sdk/cosmos/azure_data_cosmos_perf/tests/binary_sampled_testdata.rs`	Migrates performance test.
`sdk/cosmos/azure_data_cosmos_observability_harness/src/workload.rs`	Migrates observability workload.
`samples/cosmos_read_item_native_tls/src/main.rs`	Migrates native TLS sample.

Review details

Suppressed comments (2)

sdk/cosmos/azure_data_cosmos/tests/emulator_tests/cosmos_fault_injection.rs:1590

This added argument pushes the line past rustfmt's default width, so the repository's required cargo fmt --check will rewrite it. Wrap the method chain as shown.

            let fault_container_client = fault_db_client.container_client(&container_id, None).await?;

sdk/cosmos/azure_data_cosmos/tests/emulator_tests/cosmos_fault_injection.rs:1477

This added argument pushes the line past rustfmt's default width, so the repository's required cargo fmt --check will rewrite it. Wrap the method chain as shown.

            let fault_container_client = fault_db_client.container_client(&container_id, None).await?;

Files reviewed: 40/40 changed files
Comments generated: 3
Review effort level: Balanced

Carry ContainerClientOptions operation settings through container metadata resolution and document the updated API example. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Add the required optional options argument to DatabaseClient::container_client and update all call sites so the API can evolve without another signature change. Document the breaking migration and preserve existing behavior by passing None. Fixes Azure#4617 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Carry ContainerClientOptions operation settings through container metadata resolution and document the updated API example. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

…lay-cosmos-container-client-options

Resolve conflicts while preserving container client options and upstream Cosmos API updates. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Resolve Cosmos API conflicts while preserving container client options. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Kevin Pilch (Pilchie) · 2026-08-11T21:23:32Z

-                            resolved.database_rid(),
-                            db_rid.as_str()
-                        ))
+                        .with_status(azure_data_cosmos_driver::error::CosmosStatus::CLIENT_INVALID_RESOURCE_ID)


Nit: I seem to see a bunch of reformatting from one line to multiple and back, is there something we can do to reduce noise here (like configuring a longer max line length) or something?

Kevin Pilch (Pilchie) · 2026-08-11T21:24:40Z

-    /// This method eagerly resolves immutable container metadata (resource ID and partition key
-    /// definition) from the service, so the returned client is ready for immediate use without
-    /// per-operation cache lookups.
-    ///
-    /// The container's addressing mode must match this database's: a name-addressed
-    /// database accepts only name-addressed containers, and a RID-addressed database
-    /// accepts only [`ResourceId`](crate::ResourceId)-addressed containers.
+    /// This method eagerly resolves immutable container metadata before returning the client.
    ///
    /// # Arguments
    /// * `container` - The name or RID of the container.
-    ///
-    /// # Errors
-    ///
-    /// Returns an error if the container does not exist, the metadata cannot be
-    /// resolved, or the addressing mode does not match this database's.
+    /// * `options` - Optional parameters for creating the client.


Is this a mis-merge, or did you remove the other content on purpose?

Kevin Pilch (Pilchie) · 2026-08-11T21:26:43Z

            {
                Ok(response) => {
                    let created = response.into_model()?;
+                    return db_client.container_client(&created.id, None).await;


A bunch of these don't seem to remove the old call?

Simon Moreno (simorenoh)

some small comments, seems like some merge issue might have missed some bits here and there - locally copilot also called out some tests went through un-updated in tests/in_memory_emulator_tests/order_by.rs, maybe other files are also missing the options propagation.

Simon Moreno (simorenoh) · 2026-08-12T17:29:09Z

            }
            assert_eq!(vec![properties.id.clone()], ids);

+            let container_client = db_client.container_client(&properties.id, None).await?;


is this just a duplicate line from the one below?

Simon Moreno (simorenoh) · 2026-08-12T17:35:45Z

            (ResourceIdentity::Rid(db_rid), ResourceIdentity::Rid(container_rid)) => {
                let resolved = context
                    .driver
                    .resolve_container_by_rid(container_rid.as_str())


does the rid method also need the options.operation passed in?

Tomas Varon (tvaron3) · 2026-08-11T22:18:14Z


 ### Breaking Changes

+- `DatabaseClient::container_client` now requires a second argument of type `Option<ContainerClientOptions>`; pass `None` to retain the previous behavior.


nit: could you link the pr

Tomas Varon (tvaron3) · 2026-08-12T18:46:32Z

            (ResourceIdentity::Rid(db_rid), ResourceIdentity::Rid(container_rid)) => {
                let resolved = context
                    .driver
                    .resolve_container_by_rid(container_rid.as_str())


we should add the options in the rid path as well

Ashley Stanton-Nurse (analogrelay) · 2026-08-12T18:49:01Z

Definitely looks like some merge issues. I'll just pick this up when I'm back, it's a fairly minor change. Alternatively, anyone else is welcome to grab it and finish it off.

Copilot AI balanced review requested due to automatic review settings August 5, 2026 20:35

Ashley Stanton-Nurse (analogrelay) requested review from a team, Larry Osterman (LarryOsterman), Rick Winter (RickWinter), Heath Stewart (heaths) and Jeff Fisher (xirzec) as code owners August 5, 2026 20:35

github-actions Bot added the Cosmos The azure_cosmos crate label Aug 5, 2026

Copilot started reviewing on behalf of Ashley Stanton-Nurse (analogrelay) August 5, 2026 20:36 View session

Copilot AI reviewed Aug 5, 2026

View reviewed changes

Comment thread sdk/cosmos/azure_data_cosmos/src/clients/database_client.rs Outdated

Comment thread sdk/cosmos/azure_data_cosmos/src/clients/database_client.rs

Comment thread sdk/cosmos/azure_data_cosmos/tests/emulator_tests/cosmos_fault_injection.rs

Ashley Stanton-Nurse (analogrelay) and others added 4 commits August 5, 2026 13:47

Flow container options to driver

1fbce67

Carry ContainerClientOptions operation settings through container metadata resolution and document the updated API example. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Flow container options to driver

5bc87aa

Carry ContainerClientOptions operation settings through container metadata resolution and document the updated API example. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Merge commit '1fbce67b04a368fff39f441f0409294a1b390809' into analogre…

2dbe142

…lay-cosmos-container-client-options

Ashley Stanton-Nurse (analogrelay) force-pushed the analogrelay-cosmos-container-client-options branch from 1fbce67 to 5bc87aa Compare August 6, 2026 18:07

Ashley Stanton-Nurse (analogrelay) added this to CosmosDB Rust SDK and Driver Aug 6, 2026

Ashley Stanton-Nurse (analogrelay) moved this to Triage in CosmosDB Rust SDK and Driver Aug 6, 2026

Ashley Stanton-Nurse (analogrelay) moved this from Triage to Needs Attention in CosmosDB Rust SDK and Driver Aug 6, 2026

Ashley Stanton-Nurse (analogrelay) and others added 3 commits August 6, 2026 14:10

Merge latest main

737fe5d

Resolve conflicts while preserving container client options and upstream Cosmos API updates. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Merge latest main

d48781d

Resolve Cosmos API conflicts while preserving container client options. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

fix some build issues

b9df6fb

Kevin Pilch (Pilchie) reviewed Aug 11, 2026

View reviewed changes

Simon Moreno (simorenoh) requested changes Aug 12, 2026

View reviewed changes

Tomas Varon (tvaron3) reviewed Aug 12, 2026

View reviewed changes

Navigation Menu

Uh oh!

Add container client options - #4992

Add container client options#4992
Ashley Stanton-Nurse (analogrelay) wants to merge 8 commits into
Azure:mainfrom
analogrelay:analogrelay-cosmos-container-client-options

Ashley Stanton-Nurse (analogrelay) commented Aug 5, 2026 •

edited

Loading

Uh oh!

azure-pipelines Bot commented Aug 5, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Kevin Pilch (Pilchie) Aug 11, 2026

Uh oh!

Kevin Pilch (Pilchie) Aug 11, 2026

Uh oh!

Kevin Pilch (Pilchie) Aug 11, 2026

Uh oh!

Simon Moreno (simorenoh) left a comment

Uh oh!

Simon Moreno (simorenoh) Aug 12, 2026

Uh oh!

Simon Moreno (simorenoh) Aug 12, 2026

Uh oh!

Tomas Varon (tvaron3) Aug 11, 2026

Uh oh!

Tomas Varon (tvaron3) Aug 12, 2026

Uh oh!

Ashley Stanton-Nurse (analogrelay) commented Aug 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants


		### Breaking Changes

		- `DatabaseClient::container_client` now requires a second argument of type `Option<ContainerClientOptions>`; pass `None` to retain the previous behavior.

Uh oh!

Conversation

Ashley Stanton-Nurse (analogrelay) commented Aug 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-pipelines Bot commented Aug 5, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Review details

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Kevin Pilch (Pilchie) Aug 11, 2026

Choose a reason for hiding this comment

Uh oh!

Kevin Pilch (Pilchie) Aug 11, 2026

Choose a reason for hiding this comment

Uh oh!

Kevin Pilch (Pilchie) Aug 11, 2026

Choose a reason for hiding this comment

Uh oh!

Simon Moreno (simorenoh) left a comment

Choose a reason for hiding this comment

Uh oh!

Simon Moreno (simorenoh) Aug 12, 2026

Choose a reason for hiding this comment

Uh oh!

Simon Moreno (simorenoh) Aug 12, 2026

Choose a reason for hiding this comment

Uh oh!

Tomas Varon (tvaron3) Aug 11, 2026

Choose a reason for hiding this comment

Uh oh!

Tomas Varon (tvaron3) Aug 12, 2026

Choose a reason for hiding this comment

Uh oh!

Ashley Stanton-Nurse (analogrelay) commented Aug 12, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Ashley Stanton-Nurse (analogrelay) commented Aug 5, 2026 •

edited

Loading