Zendesk Supportからデータを取り込む

備考

ベータ版

この機能はベータ版です。ワークスペース管理者は、 プレビュー ページからこの機能へのアクセスを制御できます。「Databricks プレビューの管理」を参照してください。

このページでは、 LakeFlow Connectを使用してマネージド Zendesk Support 取り込みパイプラインを作成する方法を説明します。

要件

取り込みパイプラインを作成するには、まず次の要件を満たす必要があります。
- ワークスペースでUnity Catalogが有効になっている必要があります。
- ワークスペースでサーバレスコンピュートを有効にする必要があります。「サーバレスコンピュート要件」を参照してください。
- 新しい接続を作成する場合: メタストアに対するCREATE CONNECTION権限が必要です。
  
  コネクタが UI ベースのパイプラインオーサリングをサポートしている場合、管理者はこのページのステップを完了することで、接続とパイプラインを同時に作成できます。ただし、パイプラインを作成するユーザーが API ベースのパイプラインオーサリングを使用している場合、または管理者以外のユーザーである場合、管理者はまずカタログエクスプローラーで接続を作成する必要があります。「管理対象取り込みソースへの接続」を参照してください。
- 既存の接続を使用する場合: 接続オブジェクトに対するUSE CONNECTION権限またはALL PRIVILEGESが必要です。
- ターゲットカタログに対するUSE CATALOG権限が必要です。
- 既存のスキーマに対するUSE SCHEMAおよびCREATE TABLE権限、またはターゲットカタログに対するCREATE SCHEMA権限が必要です。
Zendesk Support から取り込むには、まずOAuth用に Zendesk Support を構成する」のステップを完了する必要があります。

取り込みパイプラインを作成する

各ソーステーブルはストリーミングテーブルに取り込まれます。

Databricks UI
Databricks Asset Bundles
Databricks notebook

Databricksワークスペースのサイドバーで、 データ取り込み をクリックします。
「データの追加」 ページの 「Databricks コネクタ」 で、 「Zendesk Support」 をクリックします。
取り込みウィザードの 「接続」 ページで、Zendesk Support のアクセス資格情報を保存する接続を選択します。メタストアにCREATE CONNECTION権限がある場合は、クリックして 「接続を作成」をクリックして 、「Zendesk Support の OAuth 設定」の認証詳細を使用して新しい接続を作成します。
次へをクリックします。
インジェスチョン設定 ページで、パイプラインの一意の名前を入力します。
イベントログを書き込むカタログとスキーマを選択します。カタログに対してUSE CATALOGとCREATE SCHEMA権限を持っている場合は、クリックできます。新しいスキーマを作成するには、ドロップダウンメニューでスキーマを作成します。
パイプラインの作成および続行 をクリックします。
[ソース] ページで、取り込むテーブルを選択します。
保存して続行 をクリックします。
[宛先] ページで、データをロードするカタログとスキーマを選択します。カタログに対してUSE CATALOGとCREATE SCHEMA権限を持っている場合は、クリックできます。新しいスキーマを作成するには、ドロップダウンメニューでスキーマを作成します。
保存して続行 をクリックします。
（オプション） スケジュールと通知 ページで、 スケジュールを作成します 。宛先テーブルを更新する頻度を設定します。
（オプション）クリック 通知を追加して パイプライン操作の成功または失敗に関する電子メール通知を設定し、 [保存してパイプラインを実行] をクリックします。

宣言型自動化バンドルを使用して、Zendesk Supportのパイプラインをコードとして管理します。バンドルにはジョブとタスクの YAML 定義を含めることができ、 Databricks CLIを使用して管理でき、さまざまなターゲットワークスペース (開発、ステージング、本番運用など) で共有して実行できます。詳細については、「宣言的オートメーションバンドルとは何ですか?」を参照してください。。

Databricks CLI を使用して新しいバンドルを作成します。
Bash
```
databricks bundle init
```
バンドルに 2 つの新しいリソースファイルを追加します。
- パイプライン定義ファイル (例: resources/zendesk_pipeline.yml )。パイプライン.ingestion_定義を参照してください。および例。
- データ取り込みの頻度を制御するジョブ定義ファイル (例: resources/zendesk_job.yml )。
Databricks CLI を使用してパイプラインをデプロイします。
Bash
```
databricks bundle deploy
```

例

これらの例を使用してパイプラインを構成します。

単一のソーステーブルを取り込む

Databricks Asset Bundles
Databricks notebook

次のパイプライン定義ファイルは、単一のソーステーブルを取り込みます。

YAML
variables:
  dest_catalog:
    default: main
  dest_schema:
    default: ingest_destination_schema

# The main pipeline for zendesk_dab
resources:
  pipelines:
    pipeline_zendesk:
      name: zendesk_pipeline
      catalog: ${var.dest_catalog}
      schema: ${var.dest_schema}
      ingestion_definition:
        connection_name: <zendesk-connection>
        objects:
          # An array of objects to ingest from Zendesk Support. This example ingests the tickets table.
          - table:
              source_schema: default
              source_table: tickets
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}

次のパイプライン仕様は、単一のソーステーブルを取り込みます。

Python
pipeline_name = "zendesk_pipeline"
connection_name = "<zendesk-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "tickets",
          "destination_catalog": "main",
          "destination_schema": "ingest_destination_schema"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

複数のソーステーブルを取り込む

Databricks Asset Bundles
Databricks notebook

次のパイプライン定義ファイルは、複数のソーステーブルを取り込みます。

YAML
variables:
  dest_catalog:
    default: main
  dest_schema:
    default: ingest_destination_schema

# The main pipeline for zendesk_dab
resources:
  pipelines:
    pipeline_zendesk:
      name: zendesk_pipeline
      catalog: ${var.dest_catalog}
      schema: ${var.dest_schema}
      ingestion_definition:
        connection_name: <zendesk-connection>
        objects:
          # An array of objects to ingest from Zendesk Support. This example ingests the tickets and users tables.
          - table:
              source_schema: default
              source_table: tickets
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}
          - table:
              source_schema: default
              source_table: users
              destination_catalog: ${var.dest_catalog}
              destination_schema: ${var.dest_schema}

次のパイプライン仕様は、複数のソーステーブルを取り込みます。

Python
pipeline_name = "zendesk_pipeline"
connection_name = "<zendesk-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "tickets",
          "destination_catalog": "main",
          "destination_schema": "ingest_destination_schema"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "users",
          "destination_catalog": "main",
          "destination_schema": "ingest_destination_schema"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

バンドルジョブ定義ファイル

以下は、宣言型自動化バンドルで使用するジョブ定義ファイルの例です。ジョブは毎日、最後の実行からちょうど 1 日後に実行されます。

YAML
resources:
  jobs:
    zendesk_dab_job:
      name: zendesk_dab_job

      trigger:
        periodic:
          interval: 1
          unit: DAYS

      email_notifications:
        on_failure:
          - <email-address>

      tasks:
        - task_key: refresh_pipeline
          pipeline_task:
            pipeline_id: ${resources.pipelines.pipeline_zendesk.id}

一般的なパターン

高度なパイプライン構成については、「管理された取り込みパイプラインの一般的なパターン」を参照してください。

次のステップ

パイプラインを開始、スケジュールし、アラートを設定します。一般的なパイプラインメンテナンスタスクを参照してください。

要件​

取り込みパイプラインを作成する​

例​

単一のソーステーブルを取り込む​

複数のソーステーブルを取り込む​

バンドルジョブ定義ファイル​

一般的なパターン​

次のステップ​

その他のリソース​

要件