各製品の資料を入手。
詳細はこちら →
製品をチェック
Apache Airflow でSalesforce のデータに連携したワークフローを作る
CData JDBC Driver を使ってApache Airflow からSalesforce のデータにアクセスして操作します。
最終更新日：2022-09-07
この記事で実現できるSalesforce 連携のシナリオ
こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。
Apache Airflow を使うと、データエンジニアリングワークフローの作成、スケジューリング、および監視を行うことができます。CData JDBC Driver for Salesforce と組み合わせることで、Airflow からリアルタイムSalesforce のデータに連携できます。 この記事では、Apache Airflow インスタンスからSalesforce のデータに接続してクエリを実行し、結果をCSV ファイルに保存する方法を紹介します。
最適化されたデータ処理が組み込まれたCData JDBC Driver は、リアルタイムSalesforce のデータを扱う上で高いパフォーマンスを提供します。 Salesforce にSQL クエリを発行すると、CData ドライバーはフィルタや集計などのSalesforce 側でサポートしているSQL 操作をSalesforce に直接渡し、サポートされていない操作（主にSQL 関数とJOIN 操作）は組み込みSQL エンジンを利用してクライアント側で処理します。 組み込みの動的メタデータクエリを使用すると、ネイティブのデータ型を使ってSalesforce のデータを操作および分析できます。
Salesforce への接続を構成する
組み込みの接続文字列デザイナー
JDBC URL の作成の補助として、Salesforce JDBC Driver に組み込まれている接続文字列デザイナーが使用できます。JAR ファイルをダブルクリックするか、コマンドラインからjar ファイルを実行します。
java -jar cdata.jdbc.salesforce.jar
接続プロパティを入力し、接続文字列をクリップボードにコピーします。
Salesforce 接続プロパティの設定方法
標準認証の設定
Salesforce への接続には、以下の3つの認証方式が利用可能です。標準的な認証方式では、以下の情報が必要となります。
- ユーザー名
- パスワード
- セキュリティトークン
セキュリティトークンの取得方法については、セキュリティトークン取得手順をご参照ください。
OAuth 認証の設定
ユーザー名とパスワードによる認証が利用できない（避けたい）場合は、OAuth 認証を使用することができます。
SSO（シングルサインオン）の設定
IDプロバイダー経由でのシングルサインオンを利用する場合は、以下のプロパティを設定してください。
- SSOProperties
- SSOLoginUrl
- TokenUrl
詳細な設定手順については、ヘルプドキュメントの「はじめに」セクションをご確認ください。
クラスタ環境またはクラウドでJDBC ドライバーをホストするには、ライセンス（フルまたはトライアル）およびランタイムキー（RTK）が必要です。本ライセンス（またはトライアル）の取得については、こちらからお問い合わせください。
以下は、JDBC 接続で要求される必須プロパティです。
| プロパティ | 値 |
|---|---|
| Database Connection URL |
jdbc:salesforce:RTK=5246...;User=username;Password=password;SecurityToken=Your_Security_Token;
|
| Database Driver Class Name | cdata.jdbc.salesforce.SalesforceDriver |
Airflow でJDBC 接続を確立する
- Apache Airflow インスタンスにログインします。
- Airflow インスタンスのナビゲーションバーで、「Admin」にカーソルを合わせ、「Connections」をクリックします。
- 次の画面で「+」マークをクリックして新しい接続を作成します。
- Add Connection フォームで、必要な接続プロパティを入力します。
- Connection Id：接続の名前：salesforce_jdbc
- Connection Type：JDBC Connection
- Connection URL：上記のJDBC 接続URL：
jdbc:salesforce:RTK=5246...;User=username;Password=password;SecurityToken=Your_Security_Token; - Driver Class：cdata.jdbc.salesforce.SalesforceDriver
- Driver Path：PATH/TO/cdata.jdbc.salesforce.jar
- フォームの下にある「Test」ボタンをクリックし、新規の接続をテストします。
- 新規接続を保存すると、新しく表示される画面に、接続リストに新しい行が追加されたことを示す緑のバナーが表示されます。
DAG を作成する
Airflow におけるDAG は、ワークフローのプロセスを格納するエンティティであり、DAG にトリガーを設定することでワークフローを実行することができます。 今回のワークフローでは、シンプルにSalesforce のデータに対してSQL クエリを実行し、結果をCSV ファイルに格納します。
- はじめに、Home ディレクトリにある「airflow」フォルダに移動します。その中に新しいディレクトリを作成し、タイトルを「dags」とします。 ここに、UI に表示されるAirflow のDAG を構築するPython ファイルを格納します。
- 次に新しいPython ファイルを作成し、タイトルをsalesforce_hook.py にします。この新規ファイル内に、次のコードを挿入します。
import time from datetime import datetime from airflow.decorators import dag, task from airflow.providers.jdbc.hooks.jdbc import JdbcHook import pandas as pd # Dag の宣言 @dag(dag_id="salesforce_hook", schedule_interval="0 10 * * *", start_date=datetime(2022,2,15), catchup=False, tags=['load_csv']) # Dag となる関数を定義（取得するテーブルは必要に応じて変更してください） def extract_and_load(): # Define tasks @task() def jdbc_extract(): try: hook = JdbcHook(jdbc_conn_id="jdbc") sql = """ select * from Account """ df = hook.get_pandas_df(sql) df.to_csv("/{some_file_path}/{name_of_csv}.csv",header=False, index=False, quoting=1) # print(df.head()) print(df) tbl_dict = df.to_dict('dict') return tbl_dict except Exception as e: print("Data extract error: " + str(e)) jdbc_extract() sf_extract_and_load = extract_and_load() - このファイルを保存し、Airflow インスタンスをリフレッシュします。DAG リストの中に、「salesforce_hook」というタイトルの新しいDAG が表示されるはずです。
- このDAG をクリックし、新しく表示される画面で一時停止解除スイッチをクリックして青色にし、トリガー（＝play）ボタンをクリックしてDAG を実行します。この操作で、salesforce_hook.py ファイルのSQL クエリを実行し、結果をCSV としてコード内で指定したファイルパスにエクスポートします。
- 新規のDAG を実行後、Downloads フォルダ（またはPython スクリプト内で選択したフォルダ）を確認し、CSV ファイルが作成されていることを確認します（本ワークフローの場合はaccount.csv です）。
- CSV ファイルを開くと、Apache Airflow によってSalesforce のデータがCSV 形式で利用できるようになったことが確認できます。
詳細と無償トライアル
CData JDBC Driver for Salesforce の 30日間無償トライアル をダウンロードして、Apache Airflow でリアルタイムSalesforce のデータの操作をはじめましょう！ご不明な点があれば、サポートチームにお問い合わせください。関連コンテンツ
