SQLAlchemy ORM を使用して Python で Azure Table のデータ にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData Python Connector for Azure と SQLAlchemy ツールキットを使用して、Azure Table に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して Azure Table のデータ に接続し、クエリ、更新、削除、挿入を実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの Azure Table のデータ を操作する際に比類のないパフォーマンスを提供します。Azure Table に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 Azure Table にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

Azure Table のデータ への接続

Azure Table のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

Account プロパティをストレージアカウント名に設定し、ストレージアカウントのAccessKey を設定して接続します。これらの値を取得する方法は次のとおりです。

ストレージをBackend として使用している場合（デフォルト）

• Azure ポータルにログインし、左側の「サービス」メニューで「ストレージアカウント」を選択します。
• ストレージアカウントがない場合は、「追加」ボタンをクリックしてアカウントを作成します。
• 使用するストレージアカウントのリンクをクリックし、「設定」の「アクセスキー」を選択します。 「アクセスキー」ウィンドウには、ストレージアカウント名とCData 製品で使用するキー（接続にはkey1またはkey2のどちらかを使用できます）が含まれています。これらのプロパティは、それぞれAccount とAccessKey 接続プロパティにマッピングされます。

Azure SQL への接続

• Azure ポータルにログインし、左側の「サービス」メニューで「Azure Cosmos DB」を選択します。
• 使用するCosmos DB アカウントのリンクをクリックし、「設定」の「接続文字列」を選択します。 「接続文字列」ウィンドウには、Cosmos DB アカウント名とCData 製品で使用する主キーが含まれています。これらのプロパティは、それぞれAccount とAccessKey 接続プロパティにマッピングされます。

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて Azure Table にアクセスしてみましょう。

必要なモジュールのインストール

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での Azure Table のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、Azure Table のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

engine = create_engine("azuretables:///?AccessKey=myAccessKey&Account=myAccountName")

Azure Table のデータ のマッピングクラスの宣言

接続を確立したら、ORM でモデル化するテーブルのマッピングクラスを宣言します（この記事では、NorthwindProducts テーブルをモデル化します）。sqlalchemy.ext.declarative.declarative_base 関数を使用して、一部またはすべてのフィールド（カラム）を定義した新しいクラスを作成します。

base = declarative_base()
class NorthwindProducts(base):
	__tablename__ = "NorthwindProducts"
	Name = Column(String,primary_key=True)
	Price = Column(String)
	...

Azure Table のデータ のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。Engine をセッションにバインドした後、セッションの query メソッドにマッピングクラスを渡します。

query メソッドの使用

engine = create_engine("azuretables:///?AccessKey=myAccessKey&Account=myAccountName")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(NorthwindProducts).filter_by(ShipCity="New York"):
	print("Name: ", instance.Name)
	print("Price: ", instance.Price)
	print("---------")

別の方法として、適切なテーブルオブジェクトと execute メソッドを使用することもできます。以下のコードはアクティブな session で動作します。

execute メソッドの使用

NorthwindProducts_table = NorthwindProducts.metadata.tables["NorthwindProducts"]
for instance in session.execute(NorthwindProducts_table.select().where(NorthwindProducts_table.c.ShipCity == "New York")):
	print("Name: ", instance.Name)
	print("Price: ", instance.Price)
	print("---------")

JOIN、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

Azure Table のデータ の挿入

Azure Table のデータ を挿入するには、マッピングクラスのインスタンスを定義し、アクティブな session に追加します。セッションの commit 関数を呼び出して、追加されたすべてのインスタンスを Azure Table にプッシュします。

new_rec = NorthwindProducts(Name="placeholder", ShipCity="New York")
session.add(new_rec)
session.commit()

Azure Table のデータ の更新

Azure Table のデータ を更新するには、フィルタクエリで目的のレコードを取得します。次に、フィールドの値を変更し、セッションの commit 関数を呼び出して、変更されたレコードを Azure Table にプッシュします。

updated_rec = session.query(NorthwindProducts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.ShipCity = "New York"
session.commit()

Azure Table のデータ の削除

Azure Table のデータ を削除するには、フィルタクエリで目的のレコードを取得します。次に、アクティブな session でレコードを削除し、セッションの commit 関数を呼び出して、指定されたレコード（行）に対して削除操作を実行します。

deleted_rec = session.query(NorthwindProducts).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
session.delete(deleted_rec)
session.commit()

無料トライアルと詳細情報

CData Python Connector for Azure の30日間の無料トライアルをダウンロードして、Azure Table のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。