Salesforce のデータをPythonのpetlでETL処理する方法｜CData Connect AI

CData Connect AI の Python SDK と petl フレームワークを使うと、Salesforce のデータをローカルにドライバーをインストールすることなく、Pythonで直接抽出・変換・ロードするETLパイプラインを構築できます。パーソナルアクセストークンで接続し、数行のコードで設定完了です。

Python は豊富なモジュールのエコシステムを備えているため、素早く作業に取りかかり、システムをより効果的に連携できます。CData Connect AI Python SDK と petl フレームワークを使えば、Salesforce のデータを抽出・変換して CSV などに出力する Salesforce 連携のアプリケーションやパイプラインを構築できます。この記事では、Connect AI に接続し、petl を使ってSalesforce のデータを抽出・変換し、CSV ファイルに書き出す方法をご紹介します。

Connect AI Python SDK（cdata-connect-ai）は DB-API 2.0（PEP 249）に準拠したクライアントなので、petl は etl.fromdb を使って SDK の接続から直接読み取れます。ソースごとにドライバーをインストールする必要はありません。パーソナルアクセストークンで接続して、パイプラインを構築しましょう。

Python + petl でできること

Salesforce データの定期抽出パイプライン構築

SQL クエリで取得した Salesforce のレコードを petl の etl.fromdb で抽出し、etl.sort などの変換処理をはさんでから CSV に書き出す、軽量な ETL パイプラインを構築できます。

複数データソースとの統合分析

DB-API 2.0 準拠のクライアントなので、同じコードパターンで Salesforce 以外のデータソースにも接続でき、petl 上で結合・整形してから任意の出力先にロードできます。

Salesforce への書き戻し処理の自動化

書き込みに対応した権限を持つ PAT で接続していれば、cursor.executemany を使ったバッチ INSERT により、変換済みデータを Salesforce に自動で書き戻す処理を組み込めます。

はじめに

---

Connect AI で Salesforce に接続する方法は？

CData Connect AI では、直感的なクリック操作ベースのインターフェースでデータソースに接続できます。

1. Connect AI にログインし、Sources をクリックして、 Add Connection をクリックします

2. 「Add Connection」パネルから「Salesforce」を選択します

3. Salesforce に接続するために必要な認証プロパティを入力します。

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

   埋め込みOAuth（UI でのログイン）による接続設定

   それでは、Salesforce への接続について説明していきましょう。最も簡単な方法として、Salesforce にログインする際と同様にUI 上からログインするだけで接続設定が完了します（埋め込みOAuth）。この方法をご利用になる場合は、「Salesforce への接続」をクリックしてください。

   標準認証の設定

   埋め込みOAuth 以外の方法を利用する場合、以下の3つの認証方式をご利用いただけます。標準的な認証方式では、以下の情報が必要となります。

   • ユーザー名
   • パスワード
   • セキュリティトークン

   セキュリティトークンの取得方法については、セキュリティトークン取得手順をご確認ください。

   OAuth 認証の設定

   ユーザー名とパスワードによる認証がご利用いただけない（避けたい）場合は、OAuth 認証をお使いいただけます。

   SSO（シングルサインオン）の設定

   IDプロバイダー経由でのシングルサインオンをご利用になる場合は、以下のプロパティを設定してください。

   • SSOProperties
   • SSOLoginUrl
   • TokenUrl

   多要素認証（MFA）

   Salesforce 組織で MFA の強制が有効になっている場合は、MFACode に認証アプリ（Salesforce Authenticator や Google Authenticator など）で生成されたワンタイムパスコード（TOTP）を設定してください。MFACode は OAuth 認証・ログイン認証の両方に対応しています。

   より詳細な設定手順については、ヘルプドキュメントの「はじめに」セクションをご確認ください。

   
4. 「Save & Test」をクリックします
5. 「Permissions」タブに移動し、ユーザーベースの権限を更新します。

パーソナルアクセストークン（PAT）を生成する

Python SDK は、アカウントのメールアドレスとパーソナルアクセストークン（PAT）を使って Connect AI に認証します。アクセスの粒度を保つために、アプリケーションごとに個別の PAT を作成することをおすすめします。

1. Connect AI アプリの右上にある歯車アイコン（）をクリックして、設定ページを開きます。
2. 設定ページの Access Tokens セクションに移動し、 Create PAT をクリックします。
3. PAT に名前を付けて Create をクリックします。
4. パーソナルアクセストークンは作成時にのみ表示されます。必ずコピーして安全な場所に保管してください。

必要なモジュールをインストールする方法は？

pip ユーティリティを使って、SDK と petl フレームワークをインストールします。

pip install cdata-connect-ai
pip install petl

Python で Salesforce のデータの ETL アプリを構築する方法は？

必要なモジュールをインストールしたら、ETL アプリを構築する準備は完了です。以下にコードスニペットを紹介しますが、完全なソースコードは記事の末尾に掲載しています。

まずモジュールをインポートし、アカウントのメールアドレスと PAT で Connect AI に接続します。

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

Salesforce をクエリする SQL ステートメントを作成する方法は？

SQL を使って、Salesforce をクエリするステートメントを作成します。この記事では、Account エンティティからデータを読み取ります。識別子は <Connection>.<Schema>.<Table> という3つの部分で構成されており、接続名はデフォルトでソース名（例：Salesforce1）になります。

sql = (
    "SELECT Industry, AnnualRevenue "
    "FROM [Salesforce1].[Salesforce].[Account] "
    "WHERE Name = 'GenePoint'"
)

Salesforce のデータの抽出・変換・ロードを実装する方法は？

接続とクエリが準備できたら、petl を使ってSalesforce のデータを抽出・変換・ロードします。この例では、Salesforce のデータを抽出し、AnnualRevenue カラムでデータを並べ替えて、CSV ファイルにロードします。

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'AnnualRevenue')

etl.tocsv(table2, 'account_data.csv')

新しい行を Salesforce に書き戻す方法は？

Salesforce が書き込みに対応している場合は、バッチ INSERT で行を書き戻せます。SDK の executemany は、@name のプレースホルダーと、1行につき1つのパラメータ辞書のリストを受け取ります。

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [Salesforce1].[Salesforce].[Account] (Industry, AnnualRevenue) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")

conn.close()

注意：書き込み可能なソースであっても、読み取り専用の PAT や接続権限では書き込み操作は拒否されます。

CData Connect AI Python SDK を使えば、petl のような ETL パッケージでのデータへの直接アクセスも含め、通常のデータベースと同じようにSalesforce のデータを扱えます。

関連情報と無料トライアル

これで、CData Connect AI Python SDK を使って、petl でリアルタイムのSalesforce のデータをパイプライン処理できるようになりました。Salesforce（および数百種類のその他のデータソース）への接続について詳しくは、Connect AI のページをご覧ください。

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル お問い合わせ

完全なソースコード

import petl as etl
import cdata_connect_ai

conn = cdata_connect_ai.connect(
    username="[email protected]",
    password="<your_pat>",
)

sql = (
    "SELECT Industry, AnnualRevenue "
    "FROM [Salesforce1].[Salesforce].[Account] "
    "WHERE Name = 'GenePoint'"
)

table1 = etl.fromdb(conn, sql)

table2 = etl.sort(table1, 'AnnualRevenue')

etl.tocsv(table2, 'account_data.csv')

cur = conn.cursor()
cur.executemany(
    "INSERT INTO [Salesforce1].[Salesforce].[Account] (Industry, AnnualRevenue) "
    "VALUES (@val1, @val2)",
    [
        {"@val1": "New value 1", "@val2": "New value 1"},
        {"@val1": "New value 2", "@val2": "New value 2"},
    ],
)
print(f"Rows inserted: {cur.rowcount}")
conn.close()