SQLAlchemy ORM を使用して Python で Salesforce Data Cloud のデータ にアクセスする方法

Python の豊富なモジュールエコシステムを活用することで、迅速に作業を開始し、システムを効果的に統合できます。CData Python Connector for Salesforce Data Cloud と SQLAlchemy ツールキットを使用して、Salesforce Data Cloud に接続された Python アプリケーションやスクリプトを構築できます。この記事では、SQLAlchemy を使用して Salesforce Data Cloud のデータ に接続し、クエリを実行する方法を説明します。

CData Python Connector は最適化されたデータ処理機能を内蔵しており、Python からリアルタイムの Salesforce Data Cloud のデータ を操作する際に比類のないパフォーマンスを提供します。Salesforce Data Cloud に対して複雑な SQL クエリを発行すると、CData Connector はフィルタや集計などのサポートされている SQL 操作を直接 Salesforce Data Cloud にプッシュし、サポートされていない操作（多くの場合 SQL 関数や JOIN 操作）は組み込みの SQL エンジンを使用してクライアント側で処理します。

Salesforce Data Cloud のデータ への接続

Salesforce Data Cloud のデータ への接続は、他のリレーショナルデータソースへの接続と同様です。必要な接続プロパティを使用して接続文字列を作成します。この記事では、接続文字列を create_engine 関数のパラメータとして渡します。

それでは、Salesforce Data Cloud への認証方法を設定していきましょう。Salesforce Data Cloud では、OAuth 標準による認証をサポートしています。

OAuth 認証

AuthScheme をOAuth に設定してください。

デスクトップアプリケーション

CData 製品では、デスクトップでの認証を簡略化する埋め込みOAuth アプリケーションを提供しています。

また、Salesforce Data Cloud コンソールで設定および登録するカスタムOAuth アプリケーションを介してデスクトップから認証することも可能です。詳しくは、ヘルプドキュメントのカスタムOAuth アプリの作成をご確認ください。

接続する前に、以下のプロパティを設定してください。

• InitiateOAuth：GETANDREFRESH。InitiateOAuth を使用すれば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要がなくなります
• OAuthClientId（カスタムアプリケーションのみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID
• OAuthClientSecret（カスタムアプリケーションのみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット

接続すると、CData 製品がデフォルトブラウザでSalesforce Data Cloud のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えてください。

以下のようにドライバーがOAuth プロセスを完了します。

• コールバックURL からアクセストークンを取得します
• 古いトークンの期限が切れた際は、新しいアクセストークンを取得します
• OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化します

Web アプリケーションやヘッドレスマシンを含むその他のOAuth 認証方法については、ヘルプドキュメントをご確認ください。

以下の手順に従って SQLAlchemy をインストールし、Python オブジェクトを通じて Salesforce Data Cloud にアクセスしてみましょう。

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

pip ユーティリティを使用して、SQLAlchemy ツールキットと SQLAlchemy ORM パッケージをインストールします。

pip install sqlalchemy
pip install sqlalchemy.orm

適切なモジュールをインポートします。

from sqlalchemy import create_engine, String, Column
from sqlalchemy.ext.declarative import declarative_base
from sqlalchemy.orm import sessionmaker

Python での Salesforce Data Cloud のデータ のモデリング

これで接続文字列を使用して接続できます。create_engine 関数を使用して、Salesforce Data Cloud のデータ を操作するための Engine を作成します。

注意: 接続文字列のプロパティに特殊文字が含まれている場合は、URL エンコードする必要があります。詳細については、SQL Alchemy ドキュメントを参照してください。

engine = create_engine("salesforcedatacloud:///?")

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

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

base = declarative_base()
class Account(base):
	__tablename__ = "Account"
	[Account ID] = Column(String,primary_key=True)
	[Account Name] = Column(String)
	...

Salesforce Data Cloud のデータ のクエリ

マッピングクラスを準備したら、セッションオブジェクトを使用してデータソースにクエリを実行できます。Engine をセッションにバインドした後、セッションの query メソッドにマッピングクラスを渡します。

query メソッドの使用

engine = create_engine("salesforcedatacloud:///?")
factory = sessionmaker(bind=engine)
session = factory()
for instance in session.query(Account).filter_by(EmployeeCount="250"):
	print("[Account ID]: ", instance.[Account ID])
	print("[Account Name]: ", instance.[Account Name])
	print("---------")

別の方法として、適切なテーブルオブジェクトと execute メソッドを使用することもできます。以下のコードはアクティブな session で動作します。

execute メソッドの使用

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

JOIN、集計、制限などのより複雑なクエリの例については、拡張機能のヘルプドキュメントを参照してください。

無料トライアルと詳細情報

CData Python Connector for Salesforce Data Cloud の30日間の無料トライアルをダウンロードして、Salesforce Data Cloud のデータ に接続する Python アプリとスクリプトの構築を始めましょう。ご質問がありましたら、サポートチームまでお問い合わせください。