SQLAlchemy ORM を使って、Python でCosmos DB データに連携する方法

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でCosmos DB データをモデル化

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

engine = create_engine("cosmosdb///?AccountEndpoint=myAccountEndpoint&AccountKey=myAccountKey")

CosmosDB 接続プロパティの取得・設定方法

SQL API を使ってCosmos DB アカウントに接続するために必要な接続文字列を取得するには、Azure Portal にログインして「Azure Cosmos DB」を選択し、自分のアカウントを選択します。「Settings」セクションで、「Connection String」をクリックして次の値を設定します。

• AccountEndpoint：この値は、Cosmos DB アカウントの「Keys」ブレードからのCosmos DB アカウントURL に設定してください。
• AccountKey：Azure ポータルで、Cosmos DB サービスに移動してAzure Cosmos DB アカウントを選択します。リソースメニューから、 「Keys」ページに移動します。「PRIMARY KEY」値を見つけ、Token をこの値に設定します。

Cosmos DB データのマッピングクラスの宣言

接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Customers テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。

base = declarative_base()
class Customers(base):
	__tablename__ = "Customers"
	City = Column(String,primary_key=True)
	CompanyName = Column(String)
	...

Cosmos DB データをクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。

query メソッドを使う

engine = create_engine("cosmosdb///?AccountEndpoint=myAccountEndpoint&AccountKey=myAccountKey")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Customers).filter_by(Name="Morris Park Bake Shop"):
	print("City: ", instance.City)
	print("CompanyName: ", instance.CompanyName)
	print("---------")

ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。

execute メソッドを使う

Customers_table = Customers.metadata.tables["Customers"]
for instance in session.execute(Customers_table.select().where(Customers_table.c.Name == "Morris Park Bake Shop")):
	print("City: ", instance.City)
	print("CompanyName: ", instance.CompanyName)
	print("---------")

より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。

Cosmos DB データの挿入（INSERT）

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

new_rec = Customers(City="placeholder", Name="Morris Park Bake Shop")
session.add(new_rec)
session.commit()

Cosmos DB データを更新（UPDATE）

Cosmos DB データの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Cosmos DB にレコードを追加します。

updated_rec = session.query(Customers).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Name = "Morris Park Bake Shop"
session.commit()

Cosmos DB データを削除（DELETE）

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

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

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

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

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