create_auto_cdc_from_snapshot_flow

create_auto_cdc_from_snapshot_flow関数は、Lakeflow パイプライン変更データ キャプチャ (CDC) 機能を使用してデータベース スナップショットからのソース データを処理するフローを作成します。 スナップショットからの自動 CDC のしくみを参照してください。

注

この関数は、前の関数の apply_changes_from_snapshot()を置き換えます。 2 つの関数のシグネチャは同じです。 Databricks では、新しい名前を使用するように更新することをお勧めします。

Important

この操作にはターゲット ストリーミング テーブルが必要です。 必要なターゲット テーブルを作成するには、 create_streaming_table() 関数を使用します。

構文

from pyspark import pipelines as dp

dp.create_auto_cdc_from_snapshot_flow(
  target = "<target-table>",
  source = Any,
  keys = ["key1", "key2", "keyN"],
  stored_as_scd_type = "1",
  track_history_column_list = None,
  track_history_except_column_list = None,
  once = False
)

注

AUTO CDC FROM SNAPSHOT処理の場合、既定の動作は、同じキーを持つ一致するレコードがターゲットに存在しない場合に新しい行を挿入することです。 一致するレコードが存在する場合は、行の値のいずれかが変更された場合にのみ更新されます。 ターゲットに存在するが、ソースにはもう存在しないキーを持つ行は削除されます。

スナップショットを使用した CDC 処理の詳細については、「 AUTO CDC API: パイプラインを使用して変更データ キャプチャを簡略化する」を参照してください。 create_auto_cdc_from_snapshot_flow()関数の使用例については、定期スナップショットインジェスション、履歴スナップショットインジェスション、SCDタイプ1バックフィルの例を参照してください。

パラメーター

パラメーター タイプ Description
target str 必須。 更新するテーブルの名前。 関数を実行する前にcreate_auto_cdc_from_snapshot_flow() 関数を使用してターゲット テーブルを作成できます。
source str または lambda function 必須。 定期的にスナップショットを作成するテーブルまたはビューの名前、または処理するスナップショット DataFrame とスナップショット バージョンを返す Python ラムダ関数。 source引数の実装を参照してください。
keys list 必須。 ソース データ内の行を一意に識別する列または列の組み合わせ。 これは、ターゲット テーブル内の特定のレコードに適用される CDC イベントを識別するために使用されます。 次のいずれかを指定できます。
  • 文字列の一覧: ["userId", "orderId"]
  • Spark SQL col() 関数の一覧: [col("userId"), col("orderId"]。 col()関数の引数に修飾子を含めることはできません。 たとえば、 col(userId)を使用することはできますが、 col(source.userId)は使用できません。
stored_as_scd_type str または int レコードを SCD タイプ 1 または SCD タイプ 2 として格納するかどうか。 SCD タイプ 1 の場合は 1 、SCD タイプ 2 の場合は 2 に設定されます。 既定値は SCD タイプ 1 です。
track_history_column_list または track_history_except_column_list list ターゲット テーブル内の履歴の追跡対象となる出力列のサブセット。 track_history_column_listを使用して、追跡する列の完全な一覧を指定します。 track_history_except_column_listを使用して、追跡から除外する列を指定します。 値は、文字列の一覧として宣言することも、Spark SQL col() 関数として宣言することもできます。
  • track_history_column_list = ["userId", "name", "city"]
  • track_history_column_list = [col("userId"), col("name"), col("city")]
  • track_history_except_column_list = ["operation", "sequenceNum"]
  • track_history_except_column_list = [col("operation"), col("sequenceNum")

col()関数の引数に修飾子を含めることはできません。 たとえば、 col(userId)を使用することはできますが、 col(source.userId)は使用できません。 既定では、 track_history_column_list または track_history_except_column_list 引数が関数に渡されない場合に、ターゲット テーブル内のすべての列が含まれます。
once bool スナップショットフローを一度だけ実行するかどうか。 Trueした場合、コミット成功後の増分更新ではフローはスキップされます。 ターゲットの完全なリフレッシュでフローが再実行されます。 このオプションは一度だけスナップショットロードまたはバックフィルを行うために使います。 既定値は False です。

Notes

トリガーパイプライン内のSCDタイプ1ターゲットの場合、1つのcreate_auto_cdc_from_snapshot_flow()フローがPythonやSQLで定義された1つ以上のAUTO CDCフローとターゲットを共有することができます。 これには次の要件があります。

  • 各 AUTO CDC フローに独自の名前を付けましょう。
  • すべてのフローで同じキーの数を同じ順序で使いましょう。 スナップショットフローキーネームは AUTO CDC キーネームと大文字に区別されない比較を行います。 複数の AUTO CDC フローは同一のキー名とケーシングを使用しなければなりません。
  • スナップショットバージョンと各 AUTO CDC フローのシーケンスカラムには全く同じデータ型を使いましょう。
  • AUTO CDC FROM SNAPSHOTフローに期待を定めないでください。
  • IGNORE NULL UPDATESは使用しないでください。 Pythonでは、create_auto_cdc_flow()フローにignore_null_updates、ignore_null_updates_column_list、ignore_null_updates_except_column_listを設定しないでください。
  • 既存のAUTO CDC FROM SNAPSHOTターゲットにAUTO CDCフローを追加する場合、そのターゲットには予約済みAUTO CDCシステムの列と名前が競合するユーザーカラムが含まれてはなりません。
  • このパターンはSCDタイプ2や両側頭ターゲットには使用しないでください。

例としては、「 AUTO CDC SCD Type 1テーブルへのバックフィル追加」を参照してください。

source引数を実装する

create_auto_cdc_from_snapshot_flow()関数には、source引数が含まれています。 履歴スナップショットを処理する場合、 source 引数は、処理するスナップショット データとスナップショット バージョンを含む Python DataFrame という 2 つの値を create_auto_cdc_from_snapshot_flow() 関数に返す Python ラムダ関数であることが期待されます。

関数の最初の呼び出しは、スナップショットのデータフレームとバージョンを返す必要があります。 最初の呼び出しが None返された場合、パイプラインの更新は失敗します。 少なくとも1つのスナップショットが処理された後、 None を返して追加のスナップショットが利用できないことを示します。

ラムダ関数のシグネチャを次に示します。

lambda Any => Optional[(DataFrame, Any)]
  • ラムダ関数の引数は、最後に処理されたスナップショット バージョンです。
  • ラムダ関数の戻り値は、 None または 2 つの値のタプルです。タプルの最初の値は、処理されるスナップショットを含む DataFrame です。 タプルの 2 番目の値は、スナップショットの論理順序を表すスナップショット バージョンです。

ラムダ関数を実装して呼び出す例:

def next_snapshot_and_version(latest_snapshot_version: Optional[int]) -> Tuple[DataFrame, Optional[int]]:
 if latest_snapshot_version is None:
   return (spark.read.load("filename.csv"), 1)
 else:
   return None

create_auto_cdc_from_snapshot_flow(
  # ...
  source = next_snapshot_and_version,
  # ...
)

Lakeflow パイプライン ランタイムは、 create_auto_cdc_from_snapshot_flow() 関数を含むパイプラインがトリガーされるたびに、次の手順を実行します。

  1. next_snapshot_and_version関数を実行して、次のスナップショット DataFrame と対応するスナップショット バージョンを読み込みます。
  2. 最初の呼び出しでDataFrameが返ってこなければ、更新は失敗します。 後の呼び出しでDataFrameが返ってこなければ、実行は終了し、パイプライン更新は完了とマークされます。
  3. 新しいスナップショットの変更を検出し、ターゲット テーブルに増分的に適用します。
  4. 手順 1 に戻り、次のスナップショットとそのバージョンを読み込みます。
  • 最終更新: