次の方法で共有


クイックスタート: Azure SDK for Java で Azure Cosmos DB for Table を使用する

このクイックスタートでは、Azure SDK for Java を使用して、基本的な Azure Cosmos DB for Table アプリケーションをデプロイします。 Azure Cosmos DB for Table はスキーマレス データ ストアであり、これによりアプリケーションは構造化されたテーブル データをクラウドに保存できます。 Azure SDK for Java を使用して、Azure Cosmos DB リソース内でテーブルや行を作成し、基本的なタスクを実行する方法について説明します。

API のリファレンス ドキュメント | ライブラリのソース コード | パッケージ (Maven) | Azure Developer CLI

前提条件

  • Azure Developer CLI
  • Docker Desktop
  • Java 21

Azure アカウントをお持ちでない場合は、開始する前に無料アカウントを作成してください。

プロジェクトを初期化する

Azure Developer CLI (azd) を使用して、Azure Cosmos DB for Table アカウントを作成し、コンテナー化されたサンプル アプリケーションをデプロイします。 サンプル アプリケーションでは、クライアント ライブラリを使って、サンプル データの管理、作成、読み取り、クエリを実行します。

  1. 空のディレクトリでターミナルを開きます。

  2. まだ認証されていない場合は、azd auth login を使用して Azure Developer CLI に対して認証します。 ツールによって指示された手順に従って、任意の Azure 資格情報を使って CLI に対して認証します。

    azd auth login
    
  3. azd init を使ってプロジェクトを初期化します。

    azd init --template cosmos-db-table-java-quickstart
    
  4. 初期化中に、一意の環境名を構成します。

  5. azd up を使って、Azure Cosmos DB アカウントをデプロイします。 Bicep テンプレートは、サンプル Web アプリケーションもデプロイします。

    azd up
    
  6. このプロビジョニング プロセス中に、サブスクリプション、目的の場所、ターゲット リソース グループを選択します。 プロビジョニング プロセスが完了するまで待ちます。 このプロセスには 5 分ほどかかる可能性があります。

  7. Azure リソースのプロビジョニングが完了すると、実行中の Web アプリケーションへの URL が出力に含まれます。

    Deploying services (azd deploy)
    
      (✓) Done: Deploying service web
    - Endpoint: <https://[container-app-sub-___domain].azurecontainerapps.io>
    
    SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.
    
  8. コンソールで URL を使って、ブラウザーで Web アプリケーションに移動します。 実行中のアプリの出力を確認します。

実行中の Web アプリケーションのスクリーンショット。

クライアント ライブラリをインストールする

クライアント ライブラリは、Maven を介して azure-data-tables パッケージとして入手できます。

  1. /src/web フォルダーに移動し、pom.xml ファイルを開きます。

    cd ./src
    
  2. まだ存在しない場合は、azure-data-tables パッケージのエントリを追加します。

    <dependency>
        <groupId>com.azure</groupId>
        <artifactId>azure-data-tables</artifactId>
    </dependency>
    

ライブラリをインポートする

必要なすべての名前空間をアプリケーション コードにインポートします。

import com.azure.core.http.rest.PagedFlux;
import com.azure.data.tables.TableAsyncClient;
import com.azure.data.tables.TableClientBuilder;
import com.azure.data.tables.models.ListEntitiesOptions;
import com.azure.data.tables.models.TableEntity;
import com.azure.identity.DefaultAzureCredential;
import com.azure.identity.DefaultAzureCredentialBuilder;

オブジェクト モデル

名前 説明
TableServiceAsyncClient この種類は主要なクライアントの種類であり、アカウント全体のメタデータやデータベースを管理するために使われます。
TableAsyncClient この種類は、アカウント内のテーブルのクライアントを表します。

コード例

テンプレート内のサンプル コードでは、cosmicworks-products という名前のテーブルを使用します。 cosmicworks-products テーブルには、各製品の名前、カテゴリ、数量、価格、一意識別子、販売フラグなどの詳細が含まれています。 コンテナーでは、行キーとして "一意識別子"* を使用し、パーティション キーとして "カテゴリ" を使用します。

クライアントを認証する

このサンプルでは、TableServiceAsyncClient クラスの新しいインスタンスを作成します。

DefaultAzureCredential azureTokenCredential = new DefaultAzureCredentialBuilder()
    .build();

TableServiceAsyncClient client = new TableServiceClientBuilder()
    .endpoint("<azure-cosmos-db-table-account-endpoint>")
    .credential(credential)
    .buildAsyncClient();

テーブルを取得

このサンプルでは、TableAsyncClient クラスの GetTableClient メソッドを使用して TableServiceClient クラスのインスタンスを作成します。

TableAsyncClient table = client
    .getTableClient("<azure-cosmos-db-table-name>");

エンティティの作成

テーブルに新しいエンティティを作成する最も簡単な方法は、createEntity を使用することです。

String rowKey = "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb";
String partitionKey = "gear-surf-surfboards";

TableEntity entity = new TableEntity(partitionKey, rowKey)
        .addProperty("Name", "Yamba Surfboard")
        .addProperty("Quantity", 12)
        .addProperty("Price", 850.00)
        .addProperty("Sale", false);

upsertEntity を使ってコレクション内にエンティティを作成します。

Mono<Void> response = table.upsertEntity(entity);

エンティティを取得する

getEntity を使って、テーブルから特定のエンティティを取得できます。

String rowKey = "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb";
String partitionKey = "gear-surf-surfboards";

TableEntity entity = table.getEntity(partitionKey, rowKey);

エンティティを問い合わせる

エンティティを挿入した後、listEntities および ListEntitiesOptions クラスを使用して、特定のフィルターに一致するすべてのエンティティを取得するクエリを実行することもできます。 setFilter メソッドを使って、文字列 OData フィルターを指定します。

ListEntitiesOptions options = new ListEntitiesOptions()
    .setFilter("PartitionKey eq 'gear-surf-surfboards'");

PagedFlux<TableEntity> tableEntities = table.listEntities(options, null, null);

サブスクリプションを使って、クエリのページ分割された結果を解析します。

tableEntities
    .DoOnNext(entity -> {
        // Do something
    });

リソースをクリーンアップする

サンプル アプリケーションやリソースが不要になったら、対応するデプロイとすべてのリソースを削除します。

azd down