Usar parâmetros com pipelines do Delta Live Tables

Este artigo explica como você pode usar as configurações de pipeline do Delta Live Tables para parametrizar o código do pipeline.

Parâmetros de referência

Durante as atualizações, o código-fonte do pipeline pode acessar parâmetros de pipeline usando a sintaxe para obter valores para configurações do Spark.

Você faz referência aos parâmetros do pipeline usando a chave. O valor é injetado em seu código-fonte como uma cadeia de caracteres antes que sua lógica de código-fonte seja avaliada.

A sintaxe de exemplo a seguir usa um parâmetro com chave source_catalog e valor dev_catalog para especificar a fonte de dados para uma exibição materializada:

SQL

CREATE OR REFRESH MATERIALIZED VIEW transation_summary AS
SELECT account_id,
  COUNT(txn_id) txn_count,
  SUM(txn_amount) account_revenue
FROM ${source_catalog}.sales.transactions_table
GROUP BY account_id

Python

import dlt
from pyspark.sql.functions import col, sum, count

@dlt.table
def transaction_summary():

  source_catalog = spark.conf.get("source_catalog")

  return (spark.read
      .table(f"{source_catalog}.sales.transactions_table")
      .groupBy("account_id")
      .agg(
        count(col("txn_id").alias("txn_count")),
        sum(col("txn_amount").alias("account_revenue"))
      )
    )

Definir Parâmetros

Passe parâmetros para pipelines passando pares arbitrários de chave-valor como configurações para o pipeline. Você pode definir parâmetros ao definir ou editar uma configuração de pipeline usando a interface do usuário do workspace ou JSON. Consulte Configurar um pipeline do Delta Live Tables.

As chaves de parâmetro de pipeline só podem conter _ - . caracteres alfanuméricos. Os valores de parâmetro são definidos como cadeias de caracteres.

Os parâmetros de pipeline não dão suporte a valores dinâmicos. Você deve atualizar o valor associado a uma chave na configuração do pipeline.

Importante

Não use palavras-chave que entrem em conflito com o pipeline reservado ou os valores de configuração do Apache Spark.

Parametrizar declarações de conjunto de dados em Python ou SQL

O código Python e SQL que define seus conjuntos de dados pode ser parametrizado pelas configurações do pipeline. A parametrização permite os seguintes casos de uso:

• Separação de caminhos longos e outras variáveis do código.
• Redução do volume de dados processados em ambientes de desenvolvimento ou de preparo para acelerar os testes.
• Reutilização da mesma lógica de transformação para processamento em várias fontes de dados.

O seguinte exemplo usa o valor de configuração startDate para limitar o pipeline de desenvolvimento a um subconjunto dos dados de entrada:

CREATE OR REFRESH MATERIALIZED VIEW customer_events
AS SELECT * FROM sourceTable WHERE date > '${mypipeline.startDate}';

@dlt.table
def customer_events():
  start_date = spark.conf.get("mypipeline.startDate")
  return read("sourceTable").where(col("date") > start_date)

{
  "name": "Data Ingest - DEV",
  "configuration": {
    "mypipeline.startDate": "2021-01-02"
  }
}

{
  "name": "Data Ingest - PROD",
  "configuration": {
    "mypipeline.startDate": "2010-01-02"
  }
}

Controle das fontes de dados com parâmetros

Você pode usar parâmetros de pipeline para especificar diferentes fontes de dados em diferentes configurações do mesmo pipeline.

Por exemplo, você pode especificar caminhos diferentes nas configurações de desenvolvimento, teste e produção para um pipeline usando a variável data_source_path e, em seguida, fazer referência a ela utilizando o código a seguir:

SQL

CREATE STREAMING TABLE bronze
AS (
    SELECT
    *,
    _metadata.file_path AS source_file_path
    FROM read_files( '${data_source_path}', 'csv',
            map("header", "true"))
)

Python

import dlt
from pyspark.sql.functions import col

data_source_path = spark.conf.get("data_source_path")

@dlt.table
def bronze():
    return (spark.readStream
        .format("cloudFiles")
        .option("cloudFiles.format", "csv")
        .option("header", True)
        .load(data_source_path )
        .select("*", col("_metadata.file_path").alias("source_file_name"))
    )

Esse padrão é benéfico para testar como a lógica de ingestão pode lidar com dados de esquema ou malformados durante a ingestão inicial. Você pode utilizar o código idêntico em todo o pipeline em todos os ambientes, alternando os conjuntos de dados.