append_flow

@dp.append_flowデコレーターは、パイプラインテーブルの追加フローまたはバックフィルを作成します。この関数は、Apache SparkストリーミングDataFrameを返す必要があります。LakeFlowパイプラインフローを使用してデータを段階的にロードおよび処理するを参照してください。

追加フローは、ストリーミングテーブル、マネージドテーブル、またはシンクをターゲットにすることができます。

構文

Python
from pyspark import pipelines as dp

dp.create_streaming_table("<target-table-name>") # Required only if the target table doesn't exist.

@dp.append_flow(
  target = "<target-table-name>",
  name = "<flow-name>", # optional, defaults to function name
  once = False, # optional
  depends_on = "<flow-name>", # optional, Public Preview
  spark_conf = {"<key>" : "<value", "<key" : "<value>"}, # optional
  comment = "<comment>", # optional
  import_checkpoint = "<checkpoint-path>") # optional
def <function-name>():
  return (<streaming-query>) #

パラメーター

パラメーター	Type	説明
function	`function`	必須。ユーザー定義のクエリから Apache Sparkストリーミングデータフレームを返す関数。
`target`	`str`	必須。追加フローのターゲットとなるテーブルまたはシンクの名前。
`name`	`str`	フロー名。指定されていない場合は、デフォルトで関数名になります。
`once`	`bool`	必要に応じて、フローをバックフィルなどの 1 回限りのフローとして定義します。`once=True`を使用すると、フローは次の 2 つの方法で変化します。戻り値。`streaming-query` 。この場合、ストリーミング DataFrame ではなく、バッチ DataFrame である必要があります。デフォルトでは、フローは 1 回実行されます。パイプラインが完全リフレッシュで更新されると、 `ONCE`フローが再度実行され、データが再作成されます。
`depends_on`	`str` または `list`	パブリックプレビュー。このフローが起動する前に正常に完了する必要がある1つ以上のフロー名。単一のフロー名または名前のリストを受け入れます。これによりフローの実行順序のみが指定され、フローのランの方法は変更されません。詳細については、depends_on を使用したパイプラインのフロー実行順序の指定を参照してください。
`comment`	`str`	フローの説明。
`spark_conf`	`dict`	このクエリを実行するためのSpark構成のリスト
`import_checkpoint`	`str`	フローにインポートする既存の Structured Streaming チェックポイントへのパス。これにより、移行されたストリームはソースの再処理を行う代わりに、最後にコミットされたオフセットから再開されます。チェックポイントのインポートはベータ版です。Structured Streaming チェックポイントの移行を参照してください。

パラメーター	Type	説明
function	`function`	必須。ユーザー定義のクエリから Apache Sparkストリーミングデータフレームを返す関数。
`target`	`str`	必須。追加フローのターゲットとなるテーブルまたはシンクの名前。
`name`	`str`	フロー名。指定されていない場合は、デフォルトで関数名になります。
`once`	`bool`	必要に応じて、フローをバックフィルなどの 1 回限りのフローとして定義します。`once=True`を使用すると、フローは次の 2 つの方法で変化します。戻り値。`streaming-query` 。この場合、ストリーミング DataFrame ではなく、バッチ DataFrame である必要があります。デフォルトでは、フローは 1 回実行されます。パイプラインが完全リフレッシュで更新されると、 `ONCE`フローが再度実行され、データが再作成されます。
`depends_on`	`str` または `list`	パブリックプレビュー。このフローが起動する前に正常に完了する必要がある1つ以上のフロー名。単一のフロー名または名前のリストを受け入れます。これによりフローの実行順序のみが指定され、フローのランの方法は変更されません。詳細については、depends_on を使用したパイプラインのフロー実行順序の指定を参照してください。
`comment`	`str`	フローの説明。
`spark_conf`	`dict`	このクエリを実行するためのSpark構成のリスト
`import_checkpoint`	`str`	フローにインポートする既存の Structured Streaming チェックポイントへのパス。これにより、移行されたストリームはソースの再処理を行う代わりに、最後にコミットされたオフセットから再開されます。チェックポイントのインポートはベータ版です。Structured Streaming チェックポイントの移行を参照してください。

例

Python
from pyspark import pipelines as dp

# Create a sink for an external Delta table
dp.create_sink("my_sink", "delta", {"path": "/tmp/delta_sink"})

# Add an append flow to an external Delta table
@dp.append_flow(name = "flow", target = "my_sink")
def flowFunc():
  return <streaming-query>

# Add a backfill
@dp.append_flow(name = "backfill", target = "my_sink", once = True)
def backfillFlowFunc():
    return (
      spark.read
      .format("json")
      .load("/path/to/backfill/")
    )

# Create a Kafka sink
dp.create_sink(
  "my_kafka_sink",
  "kafka",
  {
    "kafka.bootstrap.servers": "host:port",
    "topic": "my_topic"
  }
)

# Add an append flow to a Kafka sink
@dp.append_flow(name = "flow", target = "my_kafka_sink")
def myFlow():
  return read_stream("xxx").select(F.to_json(F.struct("*")).alias("value"))

Structured Streaming チェックポイントの移行

備考

ベータ版

チェックポイントのインポートはベータ版です。

ソースを再処理せずに、既存のStructured Streamingワークロードをパイプラインに移行するには、import_checkpointを使用します。Structured Streamingクエリーで使用したcheckpointLocationに設定します。には、クラウドストレージ、Unity Catalogボリューム、またはDBFSパスを指定できます。パイプラインの初回更新時に、フローはそのチェックポイントをパイプラインの管理対象ストレージに複製します。その後、フローは集計、重複排除キー、ウォーターマークなどの状態を保持したまま、最後にコミットされたオフセットから再開します。後続のパイプライン更新では、フローは複製されたチェックポイントを使用します。元のチェックポイントは変更されません。

フローのターゲットは、create_table またはシンクで作成されたマネージドテーブルである必要があります。

パイプラインを実行する前に、元の Structured Streaming クエリーを停止してください。 インポート後も元の Structured Streaming クエリーを再利用できますが、チェックポイントの状態を管理し、パイプラインとクエリーが同時に同じテーブルに書き込みを行わないようにする必要があります。これにより、重複データの生成を防ぐことができます。

Structured Streaming クエリーを、新しいテーブルに書き込んでチェックポイントをインポートするパイプラインフローとして再作成します。

Python
from pyspark import pipelines as dp

# Create a new managed table for the pipeline
dp.create_table("target_table")

# Continue from the imported checkpoint instead of reprocessing the source.
@dp.append_flow(
  target = "target_table",
  import_checkpoint = "/Volumes/my_catalog/my_schema/checkpoints/my_stream",
)
def migrate():
  # The same source your original query read from.
  return spark.readStream.table("source_table")

チェックポイントは初回のパイプラインの更新時に一度だけインポートされ、それ以降の更新では import_checkpoint は無視されます。A フル更新ではチェックポイントが再インポートされません。新しく空のチェックポイントから起動され、ソースが再処理されます。別のチェックポイントをインポートするには、ターゲットテーブルでこれまで使用されていないフロー名を使用してください。既存のフロー名を再利用すると、インポートがスキップされます。

制限事項

既に存在するテーブル（元の Structured Streaming クエリーのターゲットなど）へのチェックポイントのインポートはサポートされていません。パイプラインが作成する新しいテーブル、またはシンクをターゲットにします。
import_checkpoint は append_flow でのみサポートされています。

構文​

パラメーター​

例​

Structured Streaming チェックポイントの移行​

制限事項​

構文

パラメーター

例

Structured Streaming チェックポイントの移行

制限事項