CosmosAsyncClient クラス

パッケージ:

com.azure.cosmos

Maven 成果物:

com.azure:azure-cosmos:4.61.1

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

実装

Closeable

public final class CosmosAsyncClient
implements Closeable

Azure Cosmos DB サービスのクライアント側の論理表現を提供します。 この非同期クライアントは、サービスに対する要求の構成と実行に使用されます。

CosmosAsyncClient はスレッド セーフです。 アプリケーションの有効期間ごとに CosmosAsyncClient の 1 つのインスタンスを維持することをお勧めします。これにより、効率的な接続管理とパフォーマンスが可能になります。 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 がエラーになります。

Parameters:

databaseProperties - CosmosDatabaseProperties.

Returns:

作成 Mono されたデータベースまたはエラーを含む単一の Cosmos データベース応答を含む 。

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties, CosmosDatabaseRequestOptions options)

データベースを作成します。 サブスクリプションが完了すると、操作が実行されます。 Mono正常に完了すると、作成されたデータベースに対する単一のリソース応答が含まれます。 エラーが発生した場合は、 Mono がエラーになります。

Parameters:

databaseProperties - CosmosDatabaseProperties.

options - CosmosDatabaseRequestOptions.

Returns:

作成 Mono されたデータベースまたはエラーを含む単一の Cosmos データベース応答を含む 。

createDatabase

public Mono createDatabase(CosmosDatabaseProperties databaseProperties, ThroughputProperties throughputProperties)

データベースを作成します。 サブスクリプションが完了すると、操作が実行されます。 Mono正常に完了すると、作成されたデータベースに対する単一のリソース応答が含まれます。 エラーが発生した場合は、 Mono がエラーになります。

Parameters:

databaseProperties - CosmosDatabaseProperties.

throughputProperties - データベースのスループット プロパティ。

Returns:

作成 Mono されたデータベースまたはエラーを含む単一の Cosmos データベース応答を含む 。

createDatabase

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

データベースを作成します。 サブスクリプションが完了すると、操作が実行されます。 Mono正常に完了すると、作成されたデータベースに対する単一のリソース応答が含まれます。 エラーが発生した場合は、 Mono がエラーになります。

Parameters:

databaseProperties - CosmosDatabaseProperties.

throughputProperties - データベースのスループット プロパティ。

options - CosmosDatabaseRequestOptions.

Returns:

作成 Mono されたデータベースまたはエラーを含む単一の Cosmos データベース応答を含む 。

createDatabase

public Mono createDatabase(String id)

データベースを作成します。 サブスクリプションが完了すると、操作が実行されます。 Mono正常に完了すると、作成されたデータベースに対する単一のリソース応答が含まれます。 エラーが発生した場合は、 Mono がエラーになります。

Parameters:

id - データベースの ID。

Returns:

作成 Mono されたデータベースまたはエラーを含む単一の Cosmos データベース応答を含む 。

createDatabase

public Mono createDatabase(String id, ThroughputProperties throughputProperties)

データベースを作成します。

Parameters:

id - ID。

throughputProperties - throughputProperties。

Returns:

モノ。

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(CosmosDatabaseProperties databaseProperties)

サービスにデータベースがまだ存在しない場合は、データベースを作成します。 Mono正常に完了すると、作成されたデータベースまたは既存のデータベースを含む単一の Cosmos データベース応答が含まれます。

Parameters:

databaseProperties - CosmosDatabaseProperties。

Returns:

作成 Mono されたデータベースまたは既存のデータベースまたはエラーを含む cosmos データベースの応答を格納している 。

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(String id)

サービスにデータベースがまだ存在しない場合は、データベースを作成します。 Mono正常に完了すると、作成されたデータベースまたは既存のデータベースを含む単一の Cosmos データベース応答が含まれます。

Parameters:

id - データベースの ID。

Returns:

作成 Mono されたデータベースまたは既存のデータベースまたはエラーを含む cosmos データベースの応答を格納している 。

createDatabaseIfNotExists

public Mono createDatabaseIfNotExists(String id, ThroughputProperties throughputProperties)

サービスにデータベースがまだ存在しない場合は、データベースを作成します。 throughputProperties は、指定したデータベースが存在せず、その後、throughputProperties を使用して新しいデータベースが作成される場合にのみ使用されます。 Mono正常に完了すると、作成されたデータベースまたは既存のデータベースを含む単一の Cosmos データベース応答が含まれます。

Parameters:

id - ID。

throughputProperties - throughputProperties。

Returns:

モノ。

createGlobalThroughputControlConfigBuilder

public GlobalThroughputControlConfigBuilder createGlobalThroughputControlConfigBuilder(String databaseId, String containerId)

をビルド GlobalThroughputControlConfigするために使用するグローバル スループット制御構成ビルダーを作成します。

Parameters:

databaseId - コントロール コンテナーのデータベース ID。

containerId - コントロール コンテナーのコンテナー ID。

Returns:

GlobalThroughputControlConfigBuilder。

getDatabase

public CosmosAsyncDatabase getDatabase(String id)

サービス呼び出しを行わずにデータベース オブジェクトを取得します。

Parameters:

id - データベースの名前。

Returns:

CosmosAsyncDatabase.

queryDatabases

public CosmosPagedFlux queryDatabases(SqlQuerySpec querySpec, CosmosQueryRequestOptions options)

データベースのクエリ。 サブスクリプションが完了すると、操作が実行されます。 には CosmosPagedFlux<T> 、読み取りデータベースの 1 つまたは複数のフィード応答が含まれます。 エラーが発生した場合、 は CosmosPagedFlux<T> エラーになります。

Parameters:

querySpec - SQL クエリの仕様。

options - フィード オプション。

Returns:

CosmosPagedFlux<T>読み取りデータベースの 1 つまたは複数のフィード応答ページまたはエラーを含む 。

queryDatabases

public CosmosPagedFlux queryDatabases(String query, CosmosQueryRequestOptions options)

データベースのクエリ。 サブスクリプションが完了すると、操作が実行されます。 には CosmosPagedFlux<T> 、読み取りデータベースの 1 つまたは複数のフィード応答が含まれます。 エラーが発生した場合、 は CosmosPagedFlux<T> エラーになります。

Parameters:

query - クエリ。

options - フィード オプション。

Returns:

CosmosPagedFlux<T>読み取りデータベースの 1 つまたは複数のフィード応答ページまたはエラーを含む 。

readAllDatabases

public CosmosPagedFlux readAllDatabases()

すべてのデータベースを読み取ります。 サブスクリプションが完了すると、操作が実行されます。 には CosmosPagedFlux<T> 、読み取りデータベースの 1 つまたは複数のフィード応答が含まれます。 エラーが発生した場合、 は CosmosPagedFlux<T> エラーになります。

Returns:

CosmosPagedFlux<T>読み取りデータベースの 1 つまたは複数のフィード応答ページまたはエラーを含む 。