append_flow

O @dp.append_flow decorador cria fluxos de acréscimo ou backfills para suas tabelas de pipeline. A função deve retornar um DataFrame de streaming do Apache Spark. Consulte Carregar e processar dados incrementalmente com fluxos de pipelines declarativos Lakeflow Spark.

Os fluxos de acréscimo podem direcionar tabelas ou coletores de streaming.

Sintaxe

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 = <bool>, # optional, defaults to false
  spark_conf = {"<key>" : "<value", "<key" : "<value>"}, # optional
  comment = "<comment>") # optional
def <function-name>():
  return (<streaming-query>) #

Parâmetros

Parâmetro	Tipo	Description
função	function	Required. Uma função que retorna um DataFrame de streaming Apache Spark de uma consulta definida pelo usuário.
target	str	Required. O nome da tabela ou coletor que é o destino do fluxo de acréscimo.
name	str	O nome do fluxo. Se não for fornecido, o padrão será o nome da função.
once	bool	Opcionalmente, defina o fluxo como um fluxo único, como um backfill. O uso once=True altera o fluxo de duas maneiras: O valor de retorno. streaming-query. deve ser um DataFrame em lote neste caso, não um DataFrame de streaming. O fluxo é executado uma vez por padrão. Se o pipeline receber uma atualização completa, o fluxo ONCE será executado novamente para recriar os dados.
comment	str	Uma descrição para o fluxo.
spark_conf	dict	Uma lista de configurações do Spark para a execução desta consulta

Examples

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"))