SQLAlchemy ORM を使って、Python でOffice 365 データに連携

詳細情報をご希望ですか?

無償トライアル:

ダウンロードへ

製品の詳細情報へ:

Office 365 Python Connector

Office 365 データ連携用Python コネクタライブラリ。Office 365 データをPandas、SQLAlchemy、Dash、petl などの人気のPython ツールにシームレスに統合。



CData Python Connector for Office 365 を使って、Python アプリケーションおよびスクリプトからSQLAlchemy 経由でOffice 365 にOR マッピング可能に。

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

CData Python Connector は、ビルトインされた効率的なデータプロセスにより、リアルタイムOffice 365 data データにPython からアクセスし、高いパフォーマンスと接続性を発揮します。Office 365 に複雑なクエリを投げる際に、ドライバーはフィルタリング、集計などがサポートされている場合、SQL 処理を直接Office 365 側に行わせ、サポートされていないSQL 処理については、組み込まれたSQL エンジンによりクライアント側で処理を行います(特にJOIN やSQL 関数など)。

Office 365 Data への接続

Office 365 data への連携は、RDB ソースへのアクセスと同感覚で行うことができます。必要な接続プロパティを使って接続文字列を作成します。本記事では、接続文字列をcreate_engine 関数のパラメータとして送ります。

Office 365 はOAuth 認証標準を利用しています。OAuth を使って認証するには、アプリケーションを作成してOAuthClientId、OAuthClientSecret、およびCallbackURL 接続プロパティを取得しなければなりません。認証方法については、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

以下の手順でSQLAlchemy をインストールして、Python オブジェクトからOffice 365 に接続します。

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でOffice 365 Data をモデル化します

次は、接続文字列で接続を確立します。create_engine 関数を使って、Office 365 data に連携するEngne を作成します。

engine = create_engine("office365///?OAuthClientId=MyApplicationId&OAuthClientSecret=MyAppKey&OAuthCallbackURL=http://localhost:33333&InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

Office 365 Data のマッピングクラスの宣言

接続を確立したら、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 Data をクエリ

マッピングクラスができたので、セッションオブジェクトを使ってデータソースをクエリすることができます。セッションに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 Data の挿入(INSERT)

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

new_rec = Files(Name="placeholder", UserId="54f34750-0d34-47c9-9949-9fac4791cddb")
session.add(new_rec)
session.commit()

Office 365 Data を更新(UPDATE)

Office 365 data の更新には、更新するレコードをフィルタクエリとともにフェッチします。そして、フィールドの値を変更し、セッションで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 Data を削除(DELETE)

Office 365 data の削除には、フィルタクエリと一緒に対象となるレコードをフェッチします。そして、アクティブ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 Connector の30日の無償トライアル をぜひダウンロードして、Office 365 data への接続をPython アプリやスクリプトから簡単に作成しましょう。