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

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

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

CData Python Connectors の特徴

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

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

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

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

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

pip install sqlalchemy

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

import sqlalchemy

Python でSalesforce データをモデル化

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

engine = create_engine("salesforce///?User=username&Password=password&SecurityToken=Your_Security_Token")

Salesforce 接続プロパティの取得・設定方法

Salesforce への接続には通常のログインの他、OAuth やSSO を利用できます。ログイン方式では、ユーザー名、パスワード、セキュリティトークンを使って接続します。Salesforce セキュリティトークンの取得についてはこちらの記事をご確認ください。

ユーザー名、パスワードを使用しない、またはできない場合、OAuth 認証を利用できます。

SSO (シングルサインオン) は、SSOProperties、SSOLoginUrl、TokenUrl プロパティを設定することでID プロバイダー経由で利用できます。詳細はヘルプドキュメントの「はじめに」を参照してください。

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

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

base = declarative_base()
class Account(base):
	__tablename__ = "Account"
	Industry = Column(String,primary_key=True)
	AnnualRevenue = Column(String)
	...

Salesforce データをクエリ

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

query メソッドを使う

engine = create_engine("salesforce///?User=username&Password=password&SecurityToken=Your_Security_Token")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Account).filter_by(Name="GenePoint"):
	print("Industry: ", instance.Industry)
	print("AnnualRevenue: ", instance.AnnualRevenue)
	print("---------")

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

execute メソッドを使う

Account_table = Account.metadata.tables["Account"]
for instance in session.execute(Account_table.select().where(Account_table.c.Name == "GenePoint")):
	print("Industry: ", instance.Industry)
	print("AnnualRevenue: ", instance.AnnualRevenue)
	print("---------")

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

Salesforce データの挿入（INSERT）

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

new_rec = Account(Industry="placeholder", Name="GenePoint")
session.add(new_rec)
session.commit()

Salesforce データを更新（UPDATE）

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

updated_rec = session.query(Account).filter_by(SOME_ID_COLUMN="SOME_ID_VALUE").first()
updated_rec.Name = "GenePoint"
session.commit()

Salesforce データを削除（DELETE）

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

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

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

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

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