你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CosmosAsyncClient 类

包:

com.azure.cosmos

Maven 项目:

com.azure:azure-cosmos:4.63.4

• java.lang.Object
• • com.azure.cosmos.CosmosAsyncClient

实现

Closeable

public final class CosmosAsyncClient
implements Closeable

提供 Azure Cosmos DB 服务的客户端逻辑表示形式。 此异步客户端用于配置和执行针对服务的请求。

CosmosAsyncClient 是线程安全的。 建议在应用程序的生存期内维护 CosmosAsyncClient 的单个实例，从而实现高效的连接管理和性能。 CosmosAsyncClient 初始化是一项繁重的操作 - 不要使用初始化 CosmosAsyncClient 实例作为凭据或网络连接验证。

方法摘要

修饰符和类型	方法和描述
void	close() 关闭此 CosmosAsyncClient 实例并清理资源。
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties) 创建数据库。
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options) 创建数据库。
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties) 创建数据库。
Mono<CosmosDatabaseResponse>	createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options) 创建数据库。
Mono<CosmosDatabaseResponse>	createDatabase(String id) 创建数据库。
Mono<CosmosDatabaseResponse>	createDatabase(String id, ThroughputProperties throughputProperties) 创建数据库。
Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties) 如果服务上尚不存在数据库，请创建数据库。
Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(String id) 如果服务上尚不存在数据库，请创建该数据库。
Mono<CosmosDatabaseResponse>	createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties) 如果服务上尚不存在数据库，请创建该数据库。
GlobalThroughputControlConfigBuilder	createGlobalThroughputControlConfigBuilder(String databaseId, String containerId) 创建将用于生成 GlobalThroughputControlConfig的全局吞吐量控制配置生成器。
CosmosAsyncDatabase	getDatabase(String id) 在不进行服务调用的情况下获取数据库对象。
CosmosPagedFlux<CosmosDatabaseProperties>	queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options) 查询数据库。
CosmosPagedFlux<CosmosDatabaseProperties>	queryDatabases(String query, CosmosQueryRequestOptions options) 查询数据库。
CosmosPagedFlux<CosmosDatabaseProperties>	readAllDatabases() 读取所有数据库。

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

方法详细信息

close

public void close()

关闭此 CosmosAsyncClient 实例并清理资源。

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties)

创建数据库。 订阅后将执行该操作。 成功完成时， Mono 将包含具有所创建数据库的单个资源响应。 如果失败， Mono 将出错。

参数:

databaseProperties - CosmosDatabaseProperties.

返回:

一个 ， Mono 其中包含单个 cosmos 数据库响应，其中包含已创建的数据库或错误。

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)

创建数据库。 订阅后将执行该操作。 成功完成时， Mono 将包含具有所创建数据库的单个资源响应。 如果失败， Mono 将出错。

参数:

databaseProperties - CosmosDatabaseProperties.

options - CosmosDatabaseRequestOptions.

返回:

一个 ， Mono 其中包含单个 cosmos 数据库响应，其中包含已创建的数据库或错误。

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)

创建数据库。 订阅后将执行该操作。 成功完成时， Mono 将包含具有所创建数据库的单个资源响应。 如果失败， Mono 将出错。

参数:

databaseProperties - CosmosDatabaseProperties.

throughputProperties - 数据库的吞吐量属性。

返回:

一个 ， Mono 其中包含单个 cosmos 数据库响应，其中包含已创建的数据库或错误。

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties, CosmosDatabaseRequestOptions options)

创建数据库。 订阅后将执行该操作。 成功完成时， Mono 将包含具有所创建数据库的单个资源响应。 如果失败， Mono 将出错。

参数:

databaseProperties - CosmosDatabaseProperties.

throughputProperties - 数据库的吞吐量属性。

options - CosmosDatabaseRequestOptions.

返回:

一个 ， Mono 其中包含单个 cosmos 数据库响应，其中包含已创建的数据库或错误。

createDatabase

public Mono createDatabase(String id)

创建数据库。 订阅后将执行该操作。 成功完成时， Mono 将包含具有所创建数据库的单个资源响应。 如果失败， Mono 将出错。

参数:

id - 数据库的 id。

返回:

一个 ， Mono 其中包含单个 cosmos 数据库响应，其中包含已创建的数据库或错误。

createDatabase

public Mono createDatabase(String id, ThroughputProperties throughputProperties)

创建数据库。

参数:

id - ID。

throughputProperties - throughputProperties。

返回:

单声道。

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties)

如果服务上尚不存在数据库，请创建数据库。 成功完成后， Mono 将包含单个 cosmos 数据库响应，其中包含已创建或现有的数据库。

参数:

databaseProperties - CosmosDatabaseProperties。

返回:

一个 ， Mono 其中包含具有已创建或现有数据库或错误的 cosmos 数据库响应。

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(String id)

如果服务上尚不存在数据库，请创建该数据库。 成功完成后， Mono 将包含单个 cosmos 数据库响应，其中包含已创建或现有的数据库。

参数:

id - 数据库的 ID。

返回:

一个 ， Mono 其中包含具有已创建或现有数据库或错误的 cosmos 数据库响应。

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)

如果服务上尚不存在数据库，请创建该数据库。 仅当指定的数据库不存在时，才会使用 throughputProperties，并且将创建具有 throughputProperties 的新数据库。 成功完成后， Mono 将包含单个 cosmos 数据库响应，其中包含已创建或现有的数据库。

参数:

id - ID。

throughputProperties - throughputProperties。

返回:

单声道。

createGlobalThroughputControlConfigBuilder

public GlobalThroughputControlConfigBuilder createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)

创建将用于生成 GlobalThroughputControlConfig的全局吞吐量控制配置生成器。

参数:

databaseId - 控制容器的数据库 ID。

containerId - 控件容器的容器 ID。

返回:

一个 GlobalThroughputControlConfigBuilder。

getDatabase

public CosmosAsyncDatabase getDatabase(String id)

在不进行服务调用的情况下获取数据库对象。

参数:

id - 数据库的名称。

返回:

CosmosAsyncDatabase.

queryDatabases

public CosmosPagedFlux queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

查询数据库。 订阅后，将执行该操作。 将 CosmosPagedFlux<T> 包含读取数据库的一个或多个源响应。 如果失败，将 CosmosPagedFlux<T> 出错。

参数:

querySpec - SQL 查询规范。

options - 源选项。

返回:

， CosmosPagedFlux<T> 包含一个或多个读取数据库的源响应页或错误。

queryDatabases

public CosmosPagedFlux queryDatabases(String query, CosmosQueryRequestOptions options)

查询数据库。 订阅后，将执行该操作。 将 CosmosPagedFlux<T> 包含读取数据库的一个或多个源响应。 如果失败，将 CosmosPagedFlux<T> 出错。

参数:

query - 查询。

options - 源选项。

返回:

， CosmosPagedFlux<T> 包含一个或多个读取数据库的源响应页或错误。

readAllDatabases

public CosmosPagedFlux readAllDatabases()

读取所有数据库。 订阅后，将执行该操作。 将 CosmosPagedFlux<T> 包含读取数据库的一个或多个源响应。 如果失败，将 CosmosPagedFlux<T> 出错。

返回:

， CosmosPagedFlux<T> 包含一个或多个读取数据库的源响应页或错误。