Skip to content

Read database account properties using CosmosClient and CosmosAsyncClient #45789

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

Read database account properties using CosmosClient and CosmosAsyncClient #45789

wants to merge 20 commits into from

Conversation

jeet1995
Copy link
Member

@jeet1995 jeet1995 commented Jun 23, 2025 •
edited
Loading

Description

Add public API to read database account properties such as readable / writeable regions, account-level consistency. The readDatabaseAccount method takes a boolean flag which determines whether an I/O call to the service is made or the CosmosClient instance's local cache is used.

Usage

CosmosDatabaseAccountResponse latestDatabaseAccountResponse = asyncClient.readDatabaseAccount(true).block();
latestDatabaseAccountResponse.getReadRegions().forEach(region -> {
    System.out.println(region);
});
CosmosDatabaseAccountResponse latestDatabaseAccountResponse = syncClient.readDatabaseAccount(true);
latestDatabaseAccountResponse.getReadRegions().forEach(region -> {
    System.out.println(region);
});

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@Copilot Copilot AI review requested due to automatic review settings June 23, 2025 02:17
@jeet1995 jeet1995 requested review from kirankumarkolli and a team as code owners June 23, 2025 02:17
Copilot
Copilot AI reviewed Jun 23, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces a new model class, CosmosDatabaseAccount, to expose database account properties and updates various components to support reading database account information.

  • Added CosmosDatabaseAccount class exposing key account properties.
  • Extended client and internal components (RxDocumentClientImpl, AsyncDocumentClient, CosmosClient, and CosmosAsyncClient) with methods to read the database account using asynchronous APIs.
  • Updated ImplementationBridgeHelpers and GlobalEndpointManager to support the new database account functionality.

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosDatabaseAccount.java Introduces a new model class for database account properties.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/Utils.java Adds a utility method to convert an Iterable to a List.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/RxDocumentClientImpl.java Adds an asynchronous method to read a CosmosDatabaseAccount and maps service regions.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/ImplementationBridgeHelpers.java Introduces a helper for CosmosDatabaseAccount construction with a slight naming mismatch in region parameters.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/GlobalEndpointManager.java Exposes a getter for the internal DatabaseAccount.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/AsyncDocumentClient.java Adds the readDatabaseAccount() method to the asynchronous client.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/CosmosClient.java Adds a blocking method to obtain the CosmosDatabaseAccount from the async client.
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/CosmosAsyncClient.java Adds an asynchronous method to read the CosmosDatabaseAccount.
Comments suppressed due to low confidence (2)

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/RxDocumentClientImpl.java:6244

  • Collectors.toUnmodifiableList() is not available in Java 8, which is our baseline. Please replace it with a Java 8 compatible alternative (e.g., using Collectors.collectingAndThen to wrap the List with Collections.unmodifiableList) to maintain compatibility.
                    = Utils.iterableToList(databaseAccount.getReadableLocations()).stream().map(databaseAccountLocation -> databaseAccountLocation.getName()).collect(Collectors.toUnmodifiableList());

sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/implementation/ImplementationBridgeHelpers.java:1926

  • [nitpick] There is a naming inconsistency: the parameter is named 'writeableRegions' here, while the corresponding field in CosmosDatabaseAccount is 'writeRegions'. Consider aligning the naming (e.g., using 'writeRegions' consistently) to improve clarity.
                List<String> writeableRegions,

@jeet1995 jeet1995 changed the title [Do Not Merge]: Expose database account properties [Do Not Merge]: Read database account properties Jun 23, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 23, 2025 •
edited
Loading

API Change Check

APIView identified API level changes in this PR and created the following API reviews

com.azure:azure-cosmos

@jeet1995
Copy link
Member Author

/azp run java - cosmos - tests

@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@jeet1995
Copy link
Member Author

/azp run java - cosmos - tests

@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@jeet1995
Copy link
Member Author

/azp run java - cosmos - tests

@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@jeet1995
Copy link
Member Author

/azp run java - cosmos - kafka

@jeet1995
Copy link
Member Author

/azp run java - cosmos - spark

@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

1 similar comment
@azure-pipelines Azure Pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@jeet1995 jeet1995 changed the title [Do Not Merge]: Read database account properties Read database account properties using CosmosClient and CosmosAsyncClient Jun 30, 2025
FabianMeiswinkel
FabianMeiswinkel reviewed Jun 30, 2025
View reviewed changes
...cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosDatabaseAccountResponse.java
/**
* Represents the Cosmos DB account. A Cosmos DB account is a container for databases.
* */
public class CosmosDatabaseAccountResponse {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly a question at thsi point. From consistency perspective I would have expected a CosmosDatabaseAccountProperties class as well as CosmosDatabaseAccountResponse class (implementing CosmosResponse) - any reason why you diverged form this pattern?

FabianMeiswinkel
FabianMeiswinkel reviewed Jun 30, 2025
View reviewed changes
...cosmos/azure-cosmos/src/main/java/com/azure/cosmos/models/CosmosDatabaseAccountResponse.java
}

static void initialize() {
ImplementationBridgeHelpers.CosmosDatabaseAccountResponseHelper.setCosmosDatabaseAccountResponseAccessor(CosmosDatabaseAccountResponse::new);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please follow the same clone-pattern used elsewhere - otherwise the already high risk that new properties get forgotten in the clone-method gets even higher.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also pelase use the same comment to separate the accessor form the core logic like used in other classes for conisstency reasons.

FabianMeiswinkel
FabianMeiswinkel reviewed Jun 30, 2025
View reviewed changes
sdk/cosmos/azure-cosmos/src/main/java/com/azure/cosmos/CosmosAsyncClient.java
* @param shouldUseCache a boolean flag to determine whether to use the CosmosAsyncClient's-internal cache for reading the database account (setting shouldUseFlag to true can return stale data).
* @return the {@link CosmosDatabaseAccountResponse} with the read database account.
*/
public Mono<CosmosDatabaseAccountResponse> readDatabaseAccount(boolean shouldUseCache) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NIT: I would probably prefer the name to ensure false is the default behavior - so shouldSkipCache or somethig like that

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FabianMeiswinkel FabianMeiswinkel FabianMeiswinkel left review comments

Copilot code review Copilot Copilot left review comments

@kirankumarkolli kirankumarkolli Awaiting requested review from kirankumarkolli kirankumarkolli is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
Cosmos
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@jeet1995 @FabianMeiswinkel