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

CosmosClient 类

包:

com.azure.cosmos

Maven 项目:

com.azure:azure-cosmos:4.63.3

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

实现

Closeable

public final class CosmosClient
implements Closeable

提供 Azure Cosmos DB 服务的客户端逻辑表示形式。 对 CosmosClient API 的调用将被阻止以完成。

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

方法摘要

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

方法继承自 java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

方法详细信息

close

public void close()

关闭此 CosmosClient 实例。

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties)

创建 Cosmos 数据库。

CosmosDatabaseProperties databaseProperties = new CosmosDatabaseProperties(databaseName);
 cosmosClient.createDatabase(databaseProperties);

参数:

databaseProperties - CosmosDatabaseProperties 数据库属性。

返回:

包含 CosmosDatabaseResponse 所创建数据库的 。

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)

创建数据库。

CosmosDatabaseProperties databaseProperties = new CosmosDatabaseProperties(databaseName);
 cosmosClient.createDatabase(databaseProperties);

参数:

databaseProperties - CosmosDatabaseProperties 数据库属性。

options - 请求选项。

返回:

包含 CosmosDatabaseResponse 所创建数据库的 。

createDatabase

public CosmosDatabaseResponse createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)

创建 Cosmos 数据库。

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);
 cosmosClient.createDatabase(databaseName, throughputProperties);

参数:

databaseProperties - CosmosDatabaseProperties 数据库属性。

throughputProperties - 吞吐量属性。

返回:

包含 CosmosDatabaseResponse 所创建数据库的 。

createDatabase

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

创建 Cosmos 数据库。

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);
 cosmosClient.createDatabase(databaseName, throughputProperties);

参数:

databaseProperties - CosmosDatabaseProperties 数据库属性。

throughputProperties - 吞吐量属性。

options - CosmosDatabaseRequestOptions 请求选项。

返回:

包含 CosmosDatabaseResponse 所创建数据库的 。

createDatabase

public CosmosDatabaseResponse createDatabase(String id)

创建 Cosmos 数据库。

CosmosDatabaseProperties databaseProperties = new CosmosDatabaseProperties(databaseName);
 cosmosClient.createDatabase(databaseProperties);

参数:

id - 数据库的 ID。

返回:

包含 CosmosDatabaseResponse 所创建数据库的 。

createDatabase

public CosmosDatabaseResponse createDatabase(String id, ThroughputProperties throughputProperties)

创建 Cosmos 数据库。

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);
 cosmosClient.createDatabase(databaseName, throughputProperties);

参数:

id - 数据库的 ID。

throughputProperties - 吞吐量属性。

返回:

包含 CosmosDatabaseResponse 所创建数据库的 。

createDatabaseIfNotExists

public CosmosDatabaseResponse createDatabaseIfNotExists(String id)

如果服务中尚不存在 Cosmos 数据库，请创建该数据库。

CosmosDatabaseProperties databaseProperties = new CosmosDatabaseProperties(databaseName);
 cosmosClient.createDatabaseIfNotExists(databaseProperties);

参数:

id - 数据库的 ID。

返回:

包含 CosmosDatabaseResponse 所创建数据库的 。

createDatabaseIfNotExists

public CosmosDatabaseResponse createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)

如果服务中尚不存在 Cosmos 数据库，请创建该数据库。

ThroughputProperties throughputProperties = ThroughputProperties
     .createAutoscaledThroughput(autoScaleMaxThroughput);
 cosmosClient.createDatabaseIfNotExists(databaseName, throughputProperties);

仅当指定的数据库不存在时，才会使用 throughputProperties，并且将创建具有 throughputProperties 的新数据库。

参数:

id - 数据库的 ID。

throughputProperties - throughputProperties。

返回:

包含 CosmosDatabaseResponse 所创建数据库的 。

createGlobalThroughputControlConfigBuilder

public GlobalThroughputControlConfigBuilder createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)

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

参数:

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

containerId - 控件容器的容器 ID。

返回:

一个 GlobalThroughputControlConfigBuilder。

getDatabase

public CosmosDatabase getDatabase(String id)

在不进行服务调用的情况下获取 Cosmos 数据库实例。

参数:

id - 数据库的 ID。

返回:

CosmosDatabase cosmos 同步数据库。

queryDatabases

public CosmosPagedIterable queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

查询 Cosmos 数据库。

CosmosQueryRequestOptions options = new CosmosQueryRequestOptions();
 CosmosPagedIterable<CosmosDatabaseProperties> databaseProperties =
     cosmosClient.queryDatabases("select * from d", options);
 databaseProperties.forEach(properties -> {
     System.out.println(properties.getId());
 });

参数:

querySpec - SqlQuerySpec 查询规范。

options - 查询请求选项。

返回:

用于 CosmosPagedIterable<T> 源响应和获取的数据库的 。

queryDatabases

public CosmosPagedIterable queryDatabases(String query, CosmosQueryRequestOptions options)

查询 Cosmos 数据库。

CosmosQueryRequestOptions options = new CosmosQueryRequestOptions();
 CosmosPagedIterable<CosmosDatabaseProperties> databaseProperties =
     cosmosClient.queryDatabases("select * from d", options);
 databaseProperties.forEach(properties -> {
     System.out.println(properties.getId());
 });

参数:

query - 查询。

options - CosmosQueryRequestOptions源选项。

返回:

用于 CosmosPagedIterable<T> 源响应和获取的数据库的 。

readAllDatabases

public CosmosPagedIterable readAllDatabases()

读取所有 Cosmos 数据库。

CosmosPagedIterable<CosmosDatabaseProperties> cosmosDatabaseProperties =
     cosmosClient.readAllDatabases();
 cosmosDatabaseProperties.forEach(databaseProperties -> {
     System.out.println(databaseProperties);
 });

返回:

使用 CosmosPagedIterable<T> 读取数据库进行源响应的 。