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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でExcel データをモデル化

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

engine = create_engine("excel///?Excel File='C:/MyExcelWorkbooks/SampleWorkbook.xlsx'")

Authentication セクションのExcelFile には有効なExcel ファイルを設定する必要があります。

Amazon S3 内のExcel への接続

URI をバケット内のExcel ファイルに設定します。さらに、次のプロパティを設定して認証します。

• AWSAccessKey：AWS アクセスキー（username）に設定。
• AWSSecretKey：AWS シークレットキーに設定。

Box 内のExcel への接続

URI をExcel ファイルへのパスに設定します。Box へ認証するには、OAuth 認証標準を使います。 認証方法については、Box への接続 を参照してください。

Dropbox 内のExcel への接続

URI をExcel ファイルへのパスに設定します。Dropbox へ認証するには、OAuth 認証標準を使います。 認証方法については、Dropbox への接続 を参照してください。ユーザーアカウントまたはサービスアカウントで認証できます。ユーザーアカウントフローでは、以下の接続文字列で示すように、ユーザー資格情報の接続プロパティを設定する必要はありません。

SharePoint Online SOAP 内のExcel への接続

URI をExcel ファイルを含むドキュメントライブラリに設定します。認証するには、User、Password、およびStorageBaseURL を設定します。

SharePoint Online REST 内のExcel への接続

URI をExcel ファイルを含むドキュメントライブラリに設定します。StorageBaseURL は任意です。指定しない場合、ドライバーはルートドライブで動作します。 認証するには、OAuth 認証標準を使用します。

FTP 内のExcel への接続

URI をExcel ファイルへのパスが付いたサーバーのアドレスに設定します。認証するには、User およびPassword を設定します。

Google Drive 内のExcel への接続

デスクトップアプリケーションからのGoogle への認証には、InitiateOAuth をGETANDREFRESH に設定して、接続してください。詳細はドキュメントの「Google Drive への接続」を参照してください。

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

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

base = declarative_base()
class Sheet(base):
	__tablename__ = "Sheet"
	Name = Column(String,primary_key=True)
	Revenue = Column(String)
	...

Excel データをクエリ

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

query メソッドを使う

engine = create_engine("excel///?Excel File='C:/MyExcelWorkbooks/SampleWorkbook.xlsx'")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Sheet).filter_by(Name="Bob"):
	print("Name: ", instance.Name)
	print("Revenue: ", instance.Revenue)
	print("---------")

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

execute メソッドを使う

Sheet_table = Sheet.metadata.tables["Sheet"]
for instance in session.execute(Sheet_table.select().where(Sheet_table.c.Name == "Bob")):
	print("Name: ", instance.Name)
	print("Revenue: ", instance.Revenue)
	print("---------")

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

Excel データの挿入（INSERT）

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

new_rec = Sheet(Name="placeholder", Name="Bob")
session.add(new_rec)
session.commit()

Excel データを更新（UPDATE）

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

updated_rec = session.query(Sheet).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Name = "Bob"
session.commit()

Excel データを削除（DELETE）

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

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

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

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

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