クイックスタート: Azure SDK for Python で Azure Cosmos DB for NoSQL を使用する
このクイックスタートでは、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 アカウントを作成し、コンテナー化されたサンプル アプリケーションをデプロイします。 サンプル アプリケーションでは、クライアント ライブラリを使って、サンプル データの管理、作成、読み取り、クエリを実行します。
空のディレクトリでターミナルを開きます。
まだ認証されていない場合は、
azd auth loginを使用して Azure Developer CLI に対して認証します。 ツールによって指示された手順に従って、任意の Azure 資格情報を使って CLI に対して認証します。azd auth loginazd initを使ってプロジェクトを初期化します。azd init --template cosmos-db-nosql-python-quickstart初期化中に、一意の環境名を構成します。
azd upを使って、Azure Cosmos DB アカウントをデプロイします。 Bicep テンプレートは、サンプル Web アプリケーションもデプロイします。azd upこのプロビジョニング プロセス中に、サブスクリプション、目的の場所、ターゲット リソース グループを選択します。 プロビジョニング プロセスが完了するまで待ちます。 このプロセスには 5 分ほどかかる可能性があります。
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.コンソールで URL を使って、ブラウザーで Web アプリケーションに移動します。 実行中のアプリの出力を確認します。
クライアント ライブラリをインストールする
クライアント ライブラリは、Python Package Index から azure-cosmos ライブラリとして入手できます。
ターミナルを開き、
/srcフォルダーに移動します。cd ./srcazure-cosmosパッケージがまだインストールされていない場合は、pip installを使ってインストールします。pip install azure-cosmosまた、
azure-identityパッケージがまだインストールされていない場合はインストールします。pip install azure-identitysrc/requirements.txt ファイルを開いて確認し、
azure-cosmosとazure-identityのエントリが両方とも存在することを確認します。
オブジェクト モデル
| 名前 | 説明 |
|---|---|
CosmosClient |
このクラスは主要なクライアント クラスであり、アカウント全体のメタデータやデータベースを管理するために使われます。 |
DatabaseProxy |
このクラスはアカウント内のデータベースを表します。 |
ContainerProxy |
このクラスは主に、コンテナーまたはコンテナー内に格納されている項目の読み取り、更新、削除操作を実行するために使われます。 |
PartitionKey |
このクラスは論理パーティション キーを表します。 このクラスは、多くの一般的な操作とクエリに必要です。 |
コード例
テンプレートのサンプル コードでは、cosmicworks というデータベースと products というコンテナーを使います。 products コンテナーには、各製品の名前、カテゴリ、数量、一意識別子、販売フラグなどの詳細が含まれています。 コンテナーでは、論理パーティション キーとして /category プロパティを使います。
クライアントを認証する
このサンプルでは、CosmosClient 型の新しいインスタンスを作成し、DefaultAzureCredential インスタンスを使って認証します。
credential = DefaultAzureCredential()
client = CosmosClient(url="<azure-cosmos-db-nosql-account-endpoint>", credential=credential)
データベースの取得
client.get_database_client を使って、cosmicworks という既存のデータベースを取得します。
database = client.get_database_client("cosmicworks")
コンテナーの取得
database.get_container_client を使って既存の products コンテナーを取得します。
container = database.get_container_client("products")
項目を作成する
JSON にシリアル化するすべてのメンバーを含む新しいオブジェクトを構築します。 この例では、型には一意識別子と、カテゴリ、名前、数量、価格、セールのフィールドがあります。 container.upsert_item を使ってコンテナー内に項目を作成します。 このメソッドは "アップサート" を行い、項目が既に存在する場合は、それを効果的に置き換えます。
new_item = {
"id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
"category": "gear-surf-surfboards",
"name": "Yamba Surfboard",
"quantity": 12,
"sale": False,
}
created_item = container.upsert_item(new_item)
項目を読み取る
一意識別子 (id) フィールドとパーティション キー フィールドの両方を使って、ポイント読み取り操作を実行できます。 container.read_item を使って、特定の項目を効率的に取得できます。
existing_item = container.read_item(
item="aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
partition_key="gear-surf-surfboards",
)
クエリ項目
container.GetItemQueryIterator を使って、コンテナー内の複数の項目に対してクエリを実行します。 次のパラメーター化されたクエリを使って、指定されたカテゴリ内のすべての項目を検索します。
SELECT * FROM products p WHERE p.category = @category
queryText = "SELECT * FROM products p WHERE p.category = @category"
results = container.query_items(
query=queryText,
parameters=[
dict(
name="@category",
value="gear-surf-surfboards",
)
],
enable_cross_partition_query=False,
)
クエリの結果をループ処理します。
items = [item for item in results]
output = json.dumps(items, indent=True)
リソースをクリーンアップする
サンプル アプリケーションやリソースが不要になったら、対応するデプロイとすべてのリソースを削除します。
azd down