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