SQLAlchemy ORM を使って、Python でAzure Table のデータに連携する方法

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for AzureTables は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Azure Table にデータ連携するPython アプリケーションを構築し、Azure Table のデータを可視化できます。 本記事では、SQLAlchemy でAzure Table に連携して、データを取得、、更新、挿入、削除 する方法を説明します。

CData Python Connectors の特徴

CData Python Connectors は、以下のような特徴を持った製品です。

1. Azure Table をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
2. Python をはじめとする多様なデータ分析・BI ツールにAzure Table のデータを連携
3. ノーコードでの手軽な接続設定

CData Python Connectors では、1.データソースとしてAzure Table の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。

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

pip でSQLAlchemy ツールキットをインストールします：

pip install sqlalchemy

モジュールのインポートを忘れずに行います：

import sqlalchemy

Python でAzure Table のデータをモデル化

次は、接続文字列で接続を確立します。create_engine 関数を使って、Azure Table のデータに連携するEngne を作成します。

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

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

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

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

Azure SQL への接続

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

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

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、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、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

Azure Table のデータの挿入（INSERT）

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

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

Azure Table のデータを更新（UPDATE）

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 のデータを削除（DELETE）

Azure Table のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。

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

Azure Table からPython へのデータ連携には、ぜひCData Python Connector をご利用ください

このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。

日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。