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