SurveyMonkeyからデータを取り込む
ベータ版
この機能はベータ版です。使用するには、ワークスペース管理者は、 プレビューページ から Lakeflow Connect for SurveyMonkey を有効にする必要があります。Databricksのプレビューを管理するを参照してください。
SurveyMonkeyデータをUnity Catalogテーブルに取り込む管理されたLakeflow Connectパイプラインを作成します。Databricks UI、宣言型自動化バンドル、または Databricks ノートブックを使用します。
要件
-
取り込みパイプラインを作成するには、まず次の要件を満たす必要があります。
-
ワークスペースでUnity Catalogが有効になっている必要があります。
-
ワークスペースでServerless コンピュートを有効にする必要があります。Serverless コンピュートの要件を参照してください。
-
新しい接続を作成するには、メタストアに対する
CREATE CONNECTION特権が必要です。Unity Catalog での権限の管理を参照してください。コネクタが UI ベースのパイプライン オーサリングをサポートしている場合、管理者はこのページのステップを完了することで、接続とパイプラインを同時に作成できます。 ただし、パイプラインを作成するユーザーが API ベースのパイプライン オーサリングを使用している場合、または管理者以外のユーザーである場合、管理者はまずカタログ エクスプローラーで接続を作成する必要があります。 「管理対象取り込みソースへの接続」を参照してください。
-
既存の接続を使用するには、接続オブジェクトに対する
USE CONNECTION権限またはALL PRIVILEGES権限を持っている必要があります。 -
ターゲットカタログに対する
USE CATALOG権限が必要です。 -
既存のスキーマに対して
USE SCHEMAおよびCREATE TABLE特権、またはターゲットカタログに対してCREATE SCHEMA特権が必要です。
-
-
SurveyMonkey から取り込むには、まず Databricks で認証を構成し、接続を作成します。SurveyMonkey への認証を構成するおよびSurveyMonkey 接続を作成するを参照してください。
コネクタのオプション
SurveyMonkeyコネクタが受け付けるオプション、その適用範囲、および適用対象のテーブルについては、コネクタ オプションを参照してください。パイプライン スコープのオプションを source_configurationsで設定します。使用方法については 例を参照してください。
取り込みパイプラインを作成
サポートされているソーステーブルの一覧については、サポートされているソーステーブルをご覧ください。
- Databricks UI
- Declarative Automation Bundles
- Databricks notebook
- Databricksワークスペースのサイドバーで、 データ取り込み をクリックします。
- データの追加 ページの Databricks コネクタ で、 SurveyMonkey をクリックします。
- 取り込みウィザードの 接続 ページで、SurveyMonkey 認証情報を保存する接続を選択します。メタストアに対する
CREATE CONNECTION特権がある場合は、接続の作成 をクリックし、SurveyMonkey への認証の構成の認証情報を使用して接続を作成します。
- 次へ をクリックします。
- インジェスト設定 ページで、パイプラインの名前を入力します。
- イベントLogsを書き込むカタログとスキーマを選択します。カタログに対する
USE CATALOG権限とCREATE SCHEMA権限がある場合は、ドロップダウンメニューのスキーマの作成 をクリックしてスキーマを作成します。
- パイプラインの作成および続行 をクリックします。
- ソース ページで、取り込むテーブルを選択します。
- 保存して続行 をクリックします。
- 宛先 ページで、データをロードするカタログとスキーマを選択します。カタログに対する
USE CATALOG権限とCREATE SCHEMA権限がある場合は、ドロップダウンメニューのスキーマの作成 をクリックしてスキーマを作成します。
- 保存して続行 をクリックします。
- (オプション) スケジュールと通知 ページで、
スケジュールの作成 をクリックします。宛先テーブルを更新する頻度を設定します。
- (オプション)
通知の追加 をクリックして、パイプライン操作の成功または失敗に関するEメール通知を設定してから、 保存してパイプラインをラン をクリックします。
宣言型オートメーションバンドルを使用して、SurveyMonkey パイプラインをコードとして管理します。バンドルには、ジョブとタスクの YAML 定義を含めることができ、Databricks CLI を使用して管理され、異なるターゲット ワークスペース(開発、ステージング、本番運用など)で共有およびランを実行できます。情報については、「宣言型オートメーションバンドルとは?」をご覧ください。
-
Databricks CLIを使用してバンドルを作成するには:
Bashdatabricks bundle init -
バンドルに2つの新しいリソースファイルを追加します:
- パイプライン定義ファイル(例:
resources/surveymonkey_pipeline.yml)。「パイプライン.ingestion_definition」を参照してください。および 例。 - データ取り込みの頻度を制御するジョブ定義ファイル(例:
resources/surveymonkey_job.yml)。
- パイプライン定義ファイル(例:
-
Databricks CLIを使用してパイプラインをデプロイします。
Bashdatabricks bundle deploy
- 次のノートブックをDatabricksワークスペースにインポートします。
-
セル1とセル2はそのままにしておきます。
-
セルの3つ目をパイプライン構成の詳細で変更します。パイプライン.ingestion_definitionを参照してください。および 例。
-
オプションで、詳細なパイプライン設定を構成します。管理された取り込みパイプラインの一般的なパターンを参照してください。
-
「 すべて実行 」をクリックします。
例
SurveyMonkey コネクタは、 default ソース スキーマで 11 のソース テーブルを利用可能にします。個々のテーブルまたはスキーマ全体を取り込みます。
特定のテーブルの取り込み
テーブルの特定のサブセットを取り込む場合、またはテーブルごとに宛先の命名をカスタマイズする場合は、このオプションを使用します。
- Declarative Automation Bundles
- Databricks notebook
次のパイプライン定義ファイルは、個々の SurveyMonkey テーブルを取り込みます。
resources:
pipelines:
surveymonkey_pipeline:
name: surveymonkey_pipeline
catalog: 'main'
target: 'surveymonkey_data'
ingestion_definition:
connection_name: surveymonkey_connection
objects:
- table:
source_schema: 'default'
source_table: 'surveys'
destination_catalog: 'main'
destination_schema: 'surveymonkey_data'
destination_table: 'surveys'
- table:
source_schema: 'default'
source_table: 'survey_responses'
destination_catalog: 'main'
destination_schema: 'surveymonkey_data'
destination_table: 'survey_responses'
- table:
source_schema: 'default'
source_table: 'contacts'
destination_catalog: 'main'
destination_schema: 'surveymonkey_data'
destination_table: 'contacts'
次のパイプライン仕様は、個々の SurveyMonkey テーブルを取り込みます。
pipeline_name = "surveymonkey_pipeline"
connection_name = "<surveymonkey-connection>"
pipeline_spec = {
"name": pipeline_name,
"ingestion_definition": {
"connection_name": connection_name,
"objects": [
{
"table": {
"source_schema": "default",
"source_table": "surveys",
"destination_catalog": "main",
"destination_schema": "surveymonkey_data",
"destination_table": "surveys"
}
},
{
"table": {
"source_schema": "default",
"source_table": "survey_responses",
"destination_catalog": "main",
"destination_schema": "surveymonkey_data",
"destination_table": "survey_responses"
}
},
{
"table": {
"source_schema": "default",
"source_table": "contacts",
"destination_catalog": "main",
"destination_schema": "surveymonkey_data",
"destination_table": "contacts"
}
}
]
}
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)
特定開始日から取り込む
start_datetimeオプションを使用して、増分テーブルが最初の同期でどの程度まで遡って読み取るかを制御します。
- Declarative Automation Bundles
- Databricks notebook
次のパイプライン定義ファイルは、特定の起動日からSurveyMonkeyテーブルを取り込みます:
resources:
pipelines:
surveymonkey_pipeline:
name: surveymonkey_pipeline
catalog: 'main'
target: 'surveymonkey_data'
ingestion_definition:
connection_name: surveymonkey_connection
source_configurations:
- api_source_connector_config:
configs:
start_datetime: '<start-datetime>'
objects:
- table:
source_schema: 'default'
source_table: 'surveys'
destination_catalog: 'main'
destination_schema: 'surveymonkey_data'
destination_table: 'surveys'
- table:
source_schema: 'default'
source_table: 'survey_responses'
destination_catalog: 'main'
destination_schema: 'surveymonkey_data'
destination_table: 'survey_responses'
次のパイプライン仕様は、特定の開始日以降の SurveyMonkey テーブルを取り込みます。
pipeline_name = "surveymonkey_pipeline"
connection_name = "<surveymonkey-connection>"
pipeline_spec = {
"name": pipeline_name,
"ingestion_definition": {
"connection_name": connection_name,
"source_configurations": [
{
"api_source_connector_config": {
"configs": {
"start_datetime": "<start-datetime>"
}
}
}
],
"objects": [
{
"table": {
"source_schema": "default",
"source_table": "surveys",
"destination_catalog": "main",
"destination_schema": "surveymonkey_data",
"destination_table": "surveys"
}
},
{
"table": {
"source_schema": "default",
"source_table": "survey_responses",
"destination_catalog": "main",
"destination_schema": "surveymonkey_data",
"destination_table": "survey_responses"
}
}
]
}
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)
スキーマ全体を取り込む
SurveyMonkey のすべてのソーステーブルを 1 つの宛先スキーマに単一の宣言で取り込む場合にこのオプションを使用します。
- Declarative Automation Bundles
- Databricks notebook
次のパイプライン定義ファイルは、サポートされているすべてのSurveyMonkeyテーブルを宛先スキーマに取り込みます。
resources:
pipelines:
surveymonkey_pipeline:
name: surveymonkey_pipeline
catalog: 'main'
target: 'surveymonkey_data'
ingestion_definition:
connection_name: surveymonkey_connection
objects:
- schema:
source_schema: 'default'
destination_catalog: 'main'
destination_schema: 'surveymonkey_data'
以下のパイプライン仕様は、サポートされているすべての SurveyMonkey テーブルを送信先スキーマに取り込みます。
pipeline_name = "surveymonkey_pipeline"
connection_name = "<surveymonkey-connection>"
pipeline_spec = {
"name": pipeline_name,
"ingestion_definition": {
"connection_name": connection_name,
"objects": [
{
"schema": {
"source_schema": "default",
"destination_catalog": "main",
"destination_schema": "surveymonkey_data"
}
}
]
}
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)
宣言型オートメーションバンドルのジョブ定義ファイル
以下は、宣言型オートメーションバンドルで使用するジョブ定義ファイルの例です。ジョブは毎日ランされます。
- Declarative Automation Bundles
resources:
jobs:
surveymonkey_job:
name: surveymonkey_job
schedule:
quartz_cron_expression: '0 0 0 * * ?'
timezone_id: 'UTC'
tasks:
- task_key: surveymonkey_ingestion
pipeline_task:
pipeline_id: ${resources.pipelines.surveymonkey_pipeline.id}
一般的なパターン
高度なパイプライン構成については、「管理された取り込みパイプラインの一般的なパターン」を参照してください。
次のステップ
パイプラインの起動、スケジュール、アラートを設定します。一般的なパイプラインのメンテナンス タスクを参照してください。