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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でExcel Online データをモデル化

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

engine = create_engine("excelonline///?InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")

ワークブックに接続するには、Excel Online への認証を提供し、 次のプロパティを設定します。

• Workbook: ワークブックの名前かId に設定。利用可能なワークブックに関する情報のリストを表示する場合は、認証後にWorkbooks ビューに対してクエリを実行します。

• UseSandbox: Sandbox アカウントのワークブックに接続している場合はtrue に設定。それ以外の場合は、これを空のままにしてプロダクションアカウントに接続します。

OAuth 認証を使うこともできます。ユーザー資格情報の接続プロパティを設定せずに接続できます。接続すると、CData 製品はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、CData 製品にアクセス許可を与えます。CData 製品がOAuth プロセスを完了します。 他のOAuth 認証フローについては、ヘルプドキュメントの「OAuth 認証の使用」を参照してください。

Excel Online データのマッピングクラスの宣言

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

base = declarative_base()
class Test_xlsx_Sheet1(base):
	__tablename__ = "Test_xlsx_Sheet1"
	Id = Column(String,primary_key=True)
	Column1 = Column(String)
	...

Excel Online データをクエリ

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

query メソッドを使う

engine = create_engine("excelonline///?InitiateOAuth=GETANDREFRESH&OAuthSettingsLocation=/PATH/TO/OAuthSettings.txt")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Test_xlsx_Sheet1).filter_by(Column2="Bob"):
	print("Id: ", instance.Id)
	print("Column1: ", instance.Column1)
	print("---------")

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

execute メソッドを使う

Test_xlsx_Sheet1_table = Test_xlsx_Sheet1.metadata.tables["Test_xlsx_Sheet1"]
for instance in session.execute(Test_xlsx_Sheet1_table.select().where(Test_xlsx_Sheet1_table.c.Column2 == "Bob")):
	print("Id: ", instance.Id)
	print("Column1: ", instance.Column1)
	print("---------")

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

Excel Online データの挿入（INSERT）

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

new_rec = Test_xlsx_Sheet1(Id="placeholder", Column2="Bob")
session.add(new_rec)
session.commit()

Excel Online データを更新（UPDATE）

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

updated_rec = session.query(Test_xlsx_Sheet1).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Column2 = "Bob"
session.commit()

Excel Online データを削除（DELETE）

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

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

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

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

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