各製品の資料を入手。
詳細はこちら →SQLAlchemy ORM を使って、Python でOffice 365 のデータに連携する方法
CData Python Connector を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でOffice 365 にOR マッピング可能に。
最終更新日:2023-09-23
この記事で実現できるOffice 365 連携のシナリオ
こんにちは!ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。
Pythonエコシステムには、多くのモジュールがあり、システム構築を素早く効率的に行うことができます。CData Python Connector for Office365 は、pandas、Matplotlib モジュール、SQLAlchemy ツールキットから使用することで Office 365 にデータ連携するPython アプリケーションを構築し、Office 365 のデータを可視化できます。 本記事では、SQLAlchemy でOffice 365 に連携して、データを取得、、更新、挿入、削除 する方法を説明します。
CData Python Connectors の特徴
CData Python Connectors は、以下のような特徴を持った製品です。
- Office 365 をはじめとする、CRM、MA、会計ツールなど多様なカテゴリの270種類以上のSaaS / オンプレデータソースに対応
- Python をはじめとする多様なデータ分析・BI ツールにOffice 365 のデータを連携
- ノーコードでの手軽な接続設定
CData Python Connectors では、1.データソースとしてOffice 365 の接続を設定、2.Python からPython Connectors との接続を設定、という2つのステップだけでデータソースに接続できます。以下に具体的な設定手順を説明します。
必要なモジュールのインストール
pip でSQLAlchemy ツールキットをインストールします:
pip install sqlalchemy
モジュールのインポートを忘れずに行います:
import sqlalchemy
Python でOffice 365 のデータをモデル化
次は、接続文字列で接続を確立します。create_engine 関数を使って、Office 365 のデータに連携するEngne を作成します。
engine = create_engine("office365///?OAuthClientId=MyApplicationId&OAuthClientSecret=MyAppKey&OAuthCallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
Office 365 はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。認証方法については、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。
Office 365 のデータのマッピングクラスの宣言
接続を確立したら、OR マッパーでモデル化するテーブルのマッピングクラスを宣言します。本記事では、Files テーブルを使います。sqlalchemy.ext.declarative.declarative_base 関数を使って、新しいクラスにフィールド(カラム)を定義します。
base = declarative_base() class Files(base): __tablename__ = "Files" Name = Column(String,primary_key=True) Size = Column(String) ...
Office 365 のデータをクエリ
マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションにEngine をバインドして、セッションのquery メソッドにマッピングクラスを提供します。
query メソッドを使う
engine = create_engine("office365///?OAuthClientId=MyApplicationId&OAuthClientSecret=MyAppKey&OAuthCallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt") factory = sessionmaker(bind=engine) session = factory() for instance in session.query(Files).filter_by(UserId="54f34750-0d34-47c9-9949-9fac4791cddb"): print("Name: ", instance.Name) print("Size: ", instance.Size) print("---------")
ほかの方法としては、execute メソッドを適切なテーブルオブジェクトに使うことが可能です。以下のコードはアクティブなsession に対して有効です。
execute メソッドを使う
Files_table = Files.metadata.tables["Files"] for instance in session.execute(Files_table.select().where(Files_table.c.UserId == "54f34750-0d34-47c9-9949-9fac4791cddb")): print("Name: ", instance.Name) print("Size: ", instance.Size) print("---------")
より複雑なクエリとして、JOIN、集計、Limit などが利用可能です。詳細はヘルプドキュメントをご覧ください。
Office 365 のデータの挿入(INSERT)
Office 365 のデータへの挿入には、マップされたクラスのインスタンスを定義し、アクティブな session に追加します。commit 関数を呼び出して、Office 365 にすべての追加インスタンスを送ります。
new_rec = Files(Name="placeholder", UserId="54f34750-0d34-47c9-9949-9fac4791cddb") session.add(new_rec) session.commit()
Office 365 のデータを更新(UPDATE)
Office 365 のデータの更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションでcommit 関数を呼んで、Office 365 にレコードを追加します。
updated_rec = session.query(Files).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() updated_rec.UserId = "54f34750-0d34-47c9-9949-9fac4791cddb" session.commit()
Office 365 のデータを削除(DELETE)
Office 365 のデータの削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブsession でレコードを削除し、セッションでcommit 関数を呼び出して、該当するレコードの削除を実行します。
deleted_rec = session.query(Files).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first() session.delete(deleted_rec) session.commit()
Office 365 からPython へのデータ連携には、ぜひCData Python Connector をご利用ください
このようにCData Python Connector と併用することで、270を超えるSaaS、NoSQL データをPython からコーディングなしで扱うことができます。30日の無償評価版が利用できますので、ぜひ自社で使っているクラウドサービスやNoSQL と合わせて活用してみてください。
日本のユーザー向けにCData Python Connector は、UI の日本語化、ドキュメントの日本語化、日本語でのテクニカルサポートを提供しています。