Macros e funções macro

As macros são marcadores de posição nas configurações da propriedade do plug-in do Cloud Data Fusion. Elas são representadas por variáveis dentro de ${ }, como ${input_file_path}. Para ativar a configuração dinâmica para elementos, como caminhos de arquivos e nomes de tabelas, os marcadores são substituídos por valores reais no tempo de execução.

Ao visualizar as propriedades de um plug-in, você pode adicionar uma macro a qualquer campo de propriedade que tenha um M ao lado. Para adicionar a macro, clique no M.

Para mais informações, consulte Gerenciar macros, preferências e argumentos do ambiente de execução.

Funções macro

Além das macros, você pode usar as seguintes funções de macro predefinidas:

  • logicalStartTime()
  • secure()

Função lógica de horário de início

A função de macro logicalStartTime() retorna o horário de início lógico de uma execução do pipeline como um valor de string.

Se nenhum parâmetro for fornecido, o horário de início será retornado em milissegundos. Todos os parâmetros são opcionais. A função usa um formato de hora, um deslocamento e um fuso horário como argumentos, além do horário de início lógico de um pipeline para realizar a substituição:

${logicalStartTime([timeFormat[,offset [,timezone])}

A lista a seguir mostra os parâmetros opcionais para logicalStartTime():

Parâmetro Descrição
timeFormat O padrão de formato de hora, no formato de um SimpleDateFormat Java.
offset
Ajuste de horário antes do horário de início lógico.
timezone
Fuso horário a ser usado para o horário de início lógico.

Exemplo

Neste exemplo, o horário de início lógico de uma execução de pipeline é 2020-01-01T00:00:00 e você fornece a seguinte macro:

${logicalStartTime(yyyy-MM-dd'T'HH-mm-ss,1d-4h+30m)}

O formato é yyyy-MM-dd'T'HH-mm-ss, e o deslocamento é 1d-4h+30m antes do horário de início lógico. No ambiente de execução, o valor da macro é substituído por 2019-12-31T03:30:00 porque a diferença é convertida em 20,5 horas. A macro inteira é avaliada como 20, 5 horas antes da meia-noite de 1o de janeiro de 2020.

Como usar logicalStartTime() em plug-ins baseados em arquivos

A maneira mais comum de usar essa função é no campo Caminho dos plug-ins baseados em arquivos.

Incluir o horário de início do pipeline em milissegundos em um nome de arquivo

Para capturar o horário de início real em milissegundos em um nome de arquivo, omita os parâmetros na função da macro.

Exemplo

Neste exemplo, você inclui o horário de início do pipeline, em milissegundos, em um nome de arquivo do Amazon S3:

sales_012345671011.csv

Nas propriedades do coletor do Amazon S3, insira o seguinte valor no campo Caminho:

s3a://sales-data/sales_${logicalStartTime()}.csv

Incluir a data de hoje em um nome de arquivo

É possível usar a função da macro logicalStartTime() em um nome de arquivo para capturar a data atual.

Exemplo

Neste exemplo, você captura a data de hoje com o seguinte nome de arquivo do S3:

s3a://sales-data/sales_20210204.csv

Nas propriedades do coletor do Amazon S3, insira o seguinte valor no campo Caminho:

s3a://sales-data/sales_${logicalStartTime(yyyyMMdd)}.csv

Como usar logicalStartTime para adicionar um campo de carimbo de data/hora a registros estruturados

É possível adicionar o carimbo de data/hora a um registro estruturado usando a transformação Adicionar campo e logicalStartTime().

  1. Faça o download do plug-in Transformação do Adicionar campo no Hub do Cloud Data Fusion. Depois de implantar o plug-in, ele aparece na lista Transform como Adicionar campo.
  2. Ao configurar as propriedades do plug-in, adicione o carimbo de data/hora a um registro estruturado. Por exemplo, para o nome do campo, insira o nome do novo campo e, para o valor do campo, insira a função de macro logicalStartTime().

Função segura

A função da macro secure() usa uma única chave como argumento e procura o valor de string associada da chave no Secure Store. Para fazer a substituição, a chave fornecida como argumento já precisa existir no armazenamento seguro. Isso é útil para substituir dados confidenciais.

Exemplo

Neste exemplo, para um plug-in que se conecta a um banco de dados MySQL, configure o campo de propriedade de senha com o seguinte valor:

${secure(password)}

Essa macro extrai a senha do Secure Store no momento da execução.

Macros recursivas

As macros podem se referir recursivamente a outras macros até dez níveis. Os argumentos da macro são avaliados do mais interno para o mais externo.

Exemplo

Neste exemplo, você tem um servidor que faz referência a um nome do host e uma porta. Forneça os seguintes argumentos do ambiente de execução. O último deles é uma macro que se refere a outras macros:

  • nome do host: examplepetstore.com
  • porta: 9991
  • server-address: ${hostname}:${port}

Em uma configuração de pipeline, use a seguinte expressão:

server-address: ${server-address}

No ambiente de execução, ele é substituído pelo seguinte valor:

examplepetstore.com:9991

A seguir