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

Use parâmetros com view de métricas

Os parâmetros permitem passar valores para uma view de métricas ao query-la. Use parâmetros para reutilizar uma única definição de métrica view em diferentes entradas, como uma taxa de desconto ou um período de datas. Referencie um parâmetro onde uma expressão SQL constante for válida, como em filtros, expressões de campo e de medida, a fonte e junções. Passe um valor como um argumento ao consultar a visualização.

Parâmetros reduzem a duplicação. Em vez de manter uma view de métricas separada para cada variante, você define a lógica uma vez e permite 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 é atualmente suportada para views de métricas que definem parâmetros.

Requisitos​

A consulta a 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 do recurso de view de métricas para requisitos mínimos de versão do compute.

Definir parâmetros​

Você pode definir parâmetros no editor de baixo código do Catalog Explorer ou diretamente em YAML. Depois de criar um parâmetro, referencie-o pelo nome em qualquer lugar onde uma expressão SQL constante seja válida, como em filtros, expressões de campo e medida, na fonte e em joins.

Para adicionar um parâmetro no editor de baixo código:

  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 valor default e tipo de dados.
  4. Clique em Salvar .

O parâmetro aparece no cabeçalho do editor após a sua criação.

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 completa de campos e um exemplo de YAML, consulte Parâmetros.

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

Para fazer uma query em 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 os 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;

Passe 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;

Usar 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;

Exiba os parâmetros que uma view de métricas define​

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

Mais recursos​

Nesta página