Pular para o conteúdo principal
Última atualização em

Usar parâmetros com view de métricas

Parâmetros permitem que você passe valores para uma view de métricas ao consultá-la. Use parâmetros para reutilizar uma única definição de view de métricas em diferentes entradas, como uma taxa de desconto ou um período de datas. Faça referência a um parâmetro onde uma expressão SQL constante for válida, como em filtros, expressões de campo e medida, na fonte e em join. Transmita um valor como um argumento ao consultar a view.

Parâmetros reduzem a duplicação. Em vez de manter uma view de métricas separada para cada variante, define-se a lógica uma única vez e permite-se que cada chamador forneça seus próprios valores. Um parâmetro pode incluir um valor default, de modo que os chamadores que não passam um argumento recorrem ao default.

nota

A materialização não é compatível atualmente com views de métricas que definem parâmetros.

Requisitos​

Consultar uma view de métricas que define parâmetros requer um recurso de compute que atenda aos requisitos mínimos de versão. Consulte Disponibilidade de recursos da view de métricas para os requisitos mínimos de versão do compute.

Definir parâmetros​

É possível definir parâmetros no editor low-code do Explorador de Catálogos ou diretamente no YAML. Após criar um parâmetro, referencie-o pelo nome onde quer que uma expressão SQL constante seja válida, como em filtros, expressões de campo e de medida, na origem e em joins.

Para adicionar um parâmetro no editor low-code:

  1. No cabeçalho do editor, clique em **Adicionar parâmetro**.
  2. Insira um nome de parâmetro, por exemplo, start_date ou offset_int.
  3. Insira um default value e tipo de dados.
  4. Clique em Salvar .

O parâmetro aparece no cabeçalho do editor depois de criá-lo.

Para definir parâmetros em YAML, adicione um bloco parameters de nível superior à definição da view de métricas. Para a referência de campo completa e um exemplo YAML, consulte Parâmetros.

Consulte uma view de métricas com parâmetros​

Para consultar uma view de métricas que define parâmetros, chame a view de métricas como uma função com valor de tabela e passe parâmetros como argumentos. É possível passar argumentos por nome ou por posição, ou omiti-los para usar os valores default.

Passar argumentos por nome​

Para passar um argumento por nome, use o operador =>. O exemplo a seguir passa um valor discount de 0.15:

SQL
SELECT product, MEASURE(discountedSales)
FROM catalog.schema.metric_view(discount => 0.15)
GROUP BY product;

Passar argumentos por posição​

Para passar argumentos por posição, liste os valores na ordem em que os parâmetros são definidos. O exemplo a seguir passa o mesmo valor discount de 0.15:

SQL
SELECT product, MEASURE(discountedSales)
FROM catalog.schema.metric_view(0.15)
GROUP BY product;

Use valores de parâmetro default​

Para usar os valores de parâmetro default ao chamar a view de métricas, omita os argumentos. As seguintes queries são equivalentes e usam todos os valores default:

SQL
SELECT product, MEASURE(discountedSales) FROM catalog.schema.metric_view() GROUP BY product;
SELECT product, MEASURE(discountedSales) FROM catalog.schema.metric_view GROUP BY product;

Visualizar os parâmetros que uma view de métrica define​

Para ver os parâmetros que uma view de métricas define, veja sua definição YAML, que inclui o bloco parameters. Consulte a definição e os metadados da view de métrica.

Recursos adicionais​

Nesta página