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