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

• 適用対象:

  ✅ Table

• .NET
• Python
• Node.js
• Java
• Go

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

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

前提条件

• Azure Developer CLI
• Docker Desktop
• Python 3.12

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-python-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 アプリケーションに移動します。 実行中のアプリの出力を確認します。

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

クライアント ライブラリは、azure-data-tables パッケージとして PyPi 経由で使用できます。

1. ターミナルを開き、/src フォルダーに移動します。

   cd ./src
   

2. azure-data-tables パッケージがまだインストールされていない場合は、pip install を使ってインストールします。

   pip install azure-data-tables
   

3. src/requirements.txt ファイルを開いて確認し、azure-data-tables エントリが存在することを確認します。

オブジェクト モデル

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

コード例

• クライアントを認証する
• テーブルを取得する
• エンティティの作成
• エンティティを取得する
• エンティティを照会する

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

クライアントを認証する

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

credential = DefaultAzureCredential()

client = TableServiceClient(endpoint="<azure-cosmos-db-table-account-endpoint>", credential=credential)

テーブルを取得

このサンプルでは、TableServiceClient 型の GetTableClient 関数を使用して TableClient 型のインスタンスを作成します。

table = client.get_table_client("<azure-cosmos-db-table-name>")

エンティティの作成

テーブルに新しいエンティティを作成する最も簡単な方法は、必須の RowKey プロパティと PartitionKey プロパティを必ず指定して新しいオブジェクトを作成することです。

new_entity = {
    "RowKey": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "PartitionKey": "gear-surf-surfboards",
    "Name": "Yamba Surfboard",
    "Quantity": 12,
    "Sale": False,
}

upsert_entity を使ってテーブル内にエンティティを作成します。

created_entity = table.upsert_entity(new_entity)

エンティティを取得する

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

existing_entity = table.get_entity(
    row_key="aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    partition_key="gear-surf-surfboards",
)

エンティティを照会する

エンティティを挿入した後、query_entities と文字列 OData フィルターを使用して、特定のフィルターに一致するすべてのエンティティを取得するクエリを実行することもできます。

category = "gear-surf-surfboards"
filter = f"PartitionKey eq '{category}'"
entities = table.query_entities(query_filter=filter)

for ループを使って、クエリのページ分割された結果を解析します。

for entity in entities:
    # Do something

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

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

azd down

関連するコンテンツ

• .NET のクイックスタート
• Node.js クイック スタート
• Java クイックスタート
• Go クイックスタート