各製品の資料を入手。
詳細はこちら →
製品をチェック
SQLAlchemy ORM を使って、Python でOData のデータに連携する方法
CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でOData にOR マッピング可能に。
最終更新日：2023-09-23
この記事で実現できるOData 連携のシナリオ
こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for OData は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで OData にデータ連携するPython アプリケーションを構築し、OData のデータを可視化できます。 本記事では、SQLAlchemy でOData に連携して、データを取得、、更新、挿入、削除 する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- OData をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Python をはじめとする多様なデータ分析・BI ツールにOData のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてOData の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
必要なモジュールのインストール
pip でSQLAlchemy ツールキットをインストールします：
pip install sqlalchemy
モジュールのインポートを忘れずに行います：
import sqlalchemy
Python でOData のデータをモデル化
次は、接続文字列で接続を確立します。create_engine 関数を使って、OData のデータに連携するEngne を作成します。
engine = create_engine("odata///?URL=http://services.odata.org/V4/Northwind/Northwind.svc&UseIdUrl=True&OData Version=4.0&Data Format=ATOM")
OData への接続
OData に接続するには、Url を有効なOData サービスルートURI に設定する必要があります。 OData サービスにルートドキュメントがない場合、テーブルとして公開したい特定のエンティティをFeedURL に指定してください。
OData への認証
OData は、以下を経由する認証をサポートします。
- HTTP
- Kerberos
- SharePoint Online
- OAuth
- Azure AD
HTTP 認証スキーム
HTTP で認証する場合は、次の表に従ってAuthScheme を設定します。
| Scheme | AuthScheme | その他の設定 |
| None | None | 認証を必要としない場合に使用。 |
| Basic | Basic | User、Password |
| NTLM | NTLM | User、Password |
| Digest（サポートされている場合） | Digest | User、Password |
その他の認証方法の詳細は、ヘルプドキュメントの「接続の確立」セクションを参照してください。
OData のデータのマッピングクラスの宣言
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Orders テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド（カラム）を定義します。
base = declarative_base() class Orders(base): __tablename__ = "Orders" OrderName = Column(String,primary_key=True) Freight = Column(String) ...
OData のデータをクエリ
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
query メソッドを使う
engine = create_engine("odata///?URL=http://services.odata.org/V4/Northwind/Northwind.svc&UseIdUrl=True&OData Version=4.0&Data Format=ATOM")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Orders).filter_by(ShipCity="New York"):
print("OrderName: ", instance.OrderName)
print("Freight: ", instance.Freight)
print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
execute メソッドを使う
Orders_table = Orders.metadata.tables["Orders"]
for instance in session.execute(Orders_table.select().where(Orders_table.c.ShipCity == "New York")):
print("OrderName: ", instance.OrderName)
print("Freight: ", instance.Freight)
print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
OData のデータの挿入（INSERT）
OData のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、OData にすべての追加インスタンスを送ります。
new_rec = Orders(OrderName="placeholder", ShipCity="New York") session.add(new_rec) session.commit()
OData のデータを更新（UPDATE）
OData のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、OData にレコードを追加します。
updated_rec = session.query(Orders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.ShipCity = "New York" session.commit()
OData のデータを削除（DELETE）
OData のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。
deleted_rec = session.query(Orders).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()
OData からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。
関連コンテンツ
