always_filter

Uso

explore: explore_name {
  always_filter:  {
    filters:  [field_name: "filter expression", field_name: "filter expression", ...]
  }
}
Hierarquia
always_filter
Valor padrão
Nenhum

Aceita
Um nome de campo e uma expressão de filtro do Looker

Definição

O parâmetro always_filter permite exigir que os usuários incluam um conjunto de filtros para uma análise. Depois de definir os filtros e os valores padrão usando o parâmetro always_filter, a análise mostra automaticamente as configurações de filtro configuradas.

Os filtros especificados no parâmetro always_filter não podem ser removidos da análise. No entanto, os usuários podem modificar o filtro mudando os valores ou a condição no menu suspenso de condição. Os usuários também podem remover todos os valores do filtro, o que tem o mesmo efeito de remover o filtro.

Se você quiser que uma análise tenha filtros que não possam ser modificados ou removidos, use um dos seguintes parâmetros:

  • Para configurar filtros iguais para todos e que não podem ser vistos ou alterados de forma alguma, use sql_always_where.
  • Para configurar filtros específicos para cada usuário e que não podem ser vistos ou alterados de forma alguma, use access_filter.

No parâmetro always_filter, o campo referenciado no subparâmetro filters pode ser uma dimensão, medida, filtro ou parâmetro. Se você precisar referenciar uma dimensão ou medida que faz parte de uma visualização unida em vez de fazer parte dessa análise, use view_name.field_name. Exemplo:

explore: order {
  always_filter: {
    filters: [id: "123", customer.id: "789"]
  }
  join: customer {
    sql_on: ${order.customer_id} = ${customer.id} ;;
  }
}

Aqui, o filtro id se refere ao campo id de order. O filtro customer.id se refere ao campo id de customer. Este exemplo também demonstra que é possível adicionar vários filtros.

Para cada par field_name: "filter expression", a expressão de filtro pode ser um valor absoluto ou você pode usar expressões de filtro do Looker, dependendo do tipo de campo que está sendo filtrado.

Exemplos

Configure um filtro padrão para a Análise no campo código do pedido (com um valor padrão de "123"):

explore: order {
  always_filter: {
    filters: [id: "123"]
  }
}

Configure um filtro padrão para a análise no campo Data de criação do pedido (com um valor padrão dos últimos sete dias):

explore: order {
  always_filter: {
    filters: [created_date: "7 days"]
  }
}

Configure um filtro padrão para a Análise no campo código do pedido (valor padrão de "123"), no campo Cidade do pedido (valor padrão de "Chicago") e no campo Idade do cliente (valor padrão maior ou igual a 18):

explore: order {
  always_filter: {
    filters: [id: "123", city: "Chicago", customer.age: ">=18"]
  }
  join: customer {
    sql_on: ${order.customer_id} = ${customer.id} ;;
  }
}

Informações importantes

Os usuários não podem remover um filtro especificado por always_filter

Embora os usuários possam mudar a condição ou o valor padrão da consulta, eles não podem remover um filtro que foi adicionado por always_filter. Se você quiser pré-carregar filtros para uma análise de forma que os usuários possam remover os filtros completamente, crie uma consulta que inclua filtros sugeridos e, em seguida, compartilhe a consulta com os usuários para que eles possam usar a consulta e os filtros como ponto de partida.

Definir um valor padrão em branco

Se você quiser criar um filtro padrão com um valor padrão em branco, especifique "-EMPTY" nos valores do filtro:

always_filter: {
  filters: [products.category: "-EMPTY"]
}

O parâmetro always_filter substitui uma configuração de filtro default_value

O parâmetro always_filter substitui a configuração default_value do campo. Se você declarar um valor com always_filter, esse valor será o padrão na análise. Se você não declarar um valor com always_filter, "é qualquer valor" será o padrão de filtro na análise.

always_filter afeta Looks e blocos de dashboards atuais

A adição do parâmetro always_filter a uma definição explore atual adiciona o conjunto de filtros com os valores padrão a Looks, análises ou blocos de dashboards baseados nessa explore, incluindo Looks e blocos de dashboards salvos anteriormente que são baseados na explore.