Salesforce Data クラウドでフェデレーションクエリを実行する

プレビュー

この記事では、 Databricksによって管理されていない Salesforce Data Cloud データに対してフェデレーションクエリを実行するためにレイクハウスフェデレーションを設定する方法について説明します。レイクハウスフェデレーションの詳細については、「レイクハウスフェデレーションとは何ですか?」を参照してください。。

レイクハウスフェデレーションを使用して Salesforce Data cloud データベースに接続するには、 Databricks Unity Catalogメタストアに以下を作成する必要があります。

Salesforce Data クラウドデータベースへの接続。
Salesforce Data cloudUnity Catalog Unity Catalogデータベースをにミラーリングするフォーリンカタログ。Databricks これにより、クエリ構文とデータガバナンスツールを使用して、ユーザーのデータベースへのアクセスを管理できます。

始める前に

ワークスペースの要件:

Unity Catalog でワークスペースが有効になりました。

コンピュートの要件:

Databricks RuntimeクラスターまたはSQLウェアハウスからターゲットデータベースシステムへのネットワーク接続。レイクハウスフェデレーションのネットワーク推奨事項を参照してください。
Databricks クラスターでは、Databricks Runtime 15.2 以上と共有またはシングルユーザーアクセスモードを使用する必要があります。
SQLウェアハウスはProまたはサーバーレスであり、2024.30以上を使用する必要があります。

必要な権限：

接続を作成するには、メタストア管理者であるか、ワークスペースにアタッチされた Unity Catalog メタストアに対するCREATE CONNECTION権限を持つユーザーである必要があります。
フォーリンカタログを作成するには、メタストアに対する CREATE CATALOG 権限を持ち、接続の所有者であるか、接続に対する CREATE FOREIGN CATALOG 権限を持っている必要があります。

追加の権限要件は、後続の各タスクベースのセクションで指定されます。

Salesforce 接続アプリケーションの作成

Salesforce 接続アプリケーションを使用すると、 APIsと標準プロトコルを使用して外部アプリケーションを Salesforce と統合できます。このセクションでは、SSO を使用して接続アプリを作成し、Databricks が Salesforce で認証できるようにする方法について説明します。

注：

詳細な手順については、Salesforce Data クラウドドキュメントの「接続アプリケーションの作成」を参照してください。

Salesforce 接続アプリケーションを作成するには、次の手順を実行します。

Data クラウドの右上にある[セットアップ]をクリックします。
[ プラットフォームツール] で、[ アプリケーション] > [アプリケーションマネージャ] をクリックします。
[新しい接続アプリケーション] をクリックします。
名前と連絡先の電子メールアドレスを入力します。
OAuth設定を有効にする:
1. コールバック URL を次の形式で入力します: https://<databricks_instance_url>/login/oauth/salesforce.html。たとえば、 https://cust-success.cloud.databricks.com/login/oauth/salesforce.htmlです。
2. (オプション) 次のステップでSQLを使用してDatabricks接続とフォーリンカタログを作成する予定の場合は、Salesforce 接続アプリケーションでもリダイレクト URI https://login.salesforce.com/services/oauth2/success をサポートする必要があります。 Catalog Explorer を使用してDatabricks接続とフォーリンカタログを作成する場合、これは必要ありません。 Databricks 、他の方法よりも手動のステップが少なくて済むため、カタログエクスプローラーの使用を推奨しています。
3. 次の スコープを追加します。
  - すべてのデータにアクセスするクラウドAPIリソース ( cdp_api )
  - APIs ( api ) 経由でユーザーデータを管理する
  - データクラウドデータに対して ANSI SQLクエリを実行する ( cdp_query_api )
  - いつでもリクエストを実行 (更新、オフラインアクセス)
4. [保存]をクリックします。
5. 「続行」をクリックします。
[接続アプリケーションの概要] ページで、[コンシューマの詳細の管理] をクリックします。認証を求められます。
認証が成功すると、 コンシューマキー と コンシューマシークレット が表示されます。これらの値を保存します。これらは、Databricks 接続を作成するときに必要になります。

Databricks接続を作成する

接続は、外部データベースシステムにアクセスするためのパスと資格情報を指定します。接続を作成するには、カタログエクスプローラー、または Databricks ノートブックまたは Databricks SQL クエリエディターのCREATE CONNECTION SQL コマンドを使用できます。

注：

Databricks REST API または Databricks CLI を使用して接続を作成することもできます。 POST /api/2.1/unity-catalog/connections を参照してください。および Unity Catalog コマンド。

必要な権限: メタストア管理者または CREATE CONNECTION 権限を持つユーザー。

Databricksワークスペースで、カタログ。
左側のペインで、[ 外部データ ] メニューを展開し、[ 接続] を選択します。
[ 接続の作成] をクリックします。
わかりやすい 接続名を入力します。
Salesforce データクラウドの接続タイプを選択します。
Salesforce データクラウドの次の接続プロパティを入力します。
- 認証タイプ: OAuth
- サンドボックスです false
- (OAuth) クライアントの秘密: Salesforce 接続アプリケーションのコンシューマの秘密
- (OAuth) クライアント ID: Salesforce 接続アプリケーションコンシューマ鍵
- (OAuth) クライアントスコープ: cdp_api api cdp_query_api refresh_token offline_access
[ Salesforce でログイン] をクリックします。
(OAuth) SSO資格情報を使用して Salesforce Data クラウドにサインインするように求められます。
ログインに成功すると、Databricks の接続作成ページに戻ります。 [ Salesforce でログイン ] ボタンが Successfully authorized メッセージに置き換わりました。
(オプション)コメントを追加します。
[作成]をクリックします。

Databricks 、他の方法よりも手動のステップが少なくて済むため、接続とフォーリンカタログの作成に Catalog Explorer を使用することをお勧めします。

SQLを使用してDatabricks接続とフォーリンカタログを作成する予定の場合は、Salesforce 接続アプリケーションでリダイレクト URI https://login.salesforce.com/services/oauth2/success をサポートする必要があります。カタログエクスプローラーを使用する場合、これは必要ありません。

PKCE コード検証コードとコードチャレンジコードを生成します。これは、次のようなオンラインツールを使用して行うことができます https://tonyxu-io.github.io/pkce-generator/ または、次の Python スクリプトを実行します。

%python

import base64
import re
import os
import hashlib


code_verifier = base64.urlsafe_b64encode(os.urandom(40)).decode('utf-8')
code_verifier = re.sub('[^a-zA-Z0-9]+', '', code_verifier)

code_challenge = hashlib.sha256(code_verifier.encode('utf-8')).digest()
code_challenge = base64.urlsafe_b64encode(code_challenge).decode('utf-8')
code_challenge = code_challenge.replace('=', '')
print(f"pkce_verifier  = \"{code_verifier}\"")
print(f"code_challenge = \"{code_challenge}\"")

次の URL にアクセスし、Salesforce の認証情報を使用して認証し、 authorization_codeを取得します ( <client_id>と<code_challenge>を実際の文字列に置き換えます)。
```
https://login.salesforce.com/services/oauth2/authorize
?client_id=<client_id>
&redirect_uri=https://login.salesforce.com/services/oauth2/success
&response_type=code
&code_challenge=<code_challenge>
```
URL エンコードされた認証コードは、リダイレクトされた URL に表示されます。

ノートブックまたは Databricks SQL クエリエディターで以下を実行します。

CREATE CONNECTION '<Connection name>' TYPE salesforce_data_cloud
OPTIONS (
  client_id '<Consumer key from Salesforce Connected App>',
  client_secret '<Consumer secret from Salesforce Connected App>',
  pkce_verifier '<pkce_verifier from the last step>',
  authorization_code '<URL decoded `authorization_code`, should end with == instead of %3D%3D>',
  oauth_redirect_uri "https://login.salesforce.com/services/oauth2/success",
  oauth_scope "cdp_api api cdp_query_api refresh_token offline access",
  is_sandbox "false"
  );

Databricks では、資格情報などの機密値にはプレーンテキスト文字列ではなく Databricksシークレットを使用することをお勧めします。例えば：

CREATE CONNECTION '<Connection name>' TYPE salesforce_data_cloud
OPTIONS (
  client_id secret ('<Secret scope>','<Secret key client id>'),
  client_secret secret ('<Secret scope>','<Secret key client secret>'),
  pkce_verifier '<pkce_verifier from the last step>',
  authorization_code '<URL decoded `authorization_code`, should end with == instead of %3D%3D>',
  oauth_redirect_uri "https://login.salesforce.com/services/oauth2/success",
  oauth_scope "cdp_api api cdp_query_api refresh_token offline access",
  is_sandbox "false"
  );

シークレットの設定の詳細については、「シークレットの管理」を参照してください。

フォーリンカタログの作成

フォーリンカタログは、外部データシステム内のデータベースをミラーリングするため、Databricks と Unity Catalogを使用して、そのデータベース内のデータへのアクセスを管理できます。フォーリンカタログを作成するには、すでに定義されている DATA への接続を使用します。

フォーリンカタログを作成するには、カタログエクスプローラー、または Databricks ノートブックまたは SQL クエリエディターのCREATE FOREIGN CATALOG SQL コマンドを使用できます。

注：

Databricks REST API または Databricks CLI を使用してカタログを作成することもできます。 POST /api/2.1/unity-catalog/catalogs を参照してください。および Unity Catalog コマンド。

必要なアクセス許可: メタストアに対する CREATE CATALOG アクセス許可と、接続の所有権または接続に対する CREATE FOREIGN CATALOG 特権のいずれか。

Databricks ワークスペースで、[カタログ]をクリックしてカタログ・エクスプローラーを開きます。
右上の [ カタログの作成] をクリックします。
Salesforce Data クラウドカタログの次のプロパティを入力します。
- カタログ名: カタログのわかりやすい名前。
- タイプ: Foreign。
- 接続名: カタログが作成される接続の名前。
- データスペース: Salesforce データスペース。
[作成]をクリックします。

ノートブックまたは SQL クエリエディターで次の SQL コマンドを実行します。括弧内の項目はオプションです。

CREATE FOREIGN CATALOG [IF NOT EXISTS] '<catalog-name>' USING CONNECTION '<connection-name>'
OPTIONS (dataspace '<dataspace>');

次の値を置き換えます。

<catalog-name>：
<connection-name>：
<dataspace>: Salesforce データスペース。たとえば、 defaultです。

サポートされているプッシュダウン

次のプッシュダウンがサポートされています。

フィルター
予測
制限
集計
offset
キャスト
含む、開始、終了

データ型のマッピング

Salesforce Data クラウドからSparkに読み取る場合、データ型は次のようにマップされます。

Salesforce データクラウドタイプ	Sparkタイプ
ブール値	BooleanType
Date	DateType
日時型	TimestampType
Eメール、電話、テキスト、URL	StringType
数値、パーセント	DecimalType(38, 18)

制限事項

Databricks カタログごとに 1 つの Salesforce データスペースのみがサポートされます。