filtro

Uso

view: view_name {
  filter: filter_name { ... }
}
Hierarquia
filter
Valor padrão
Nenhum

Aceita
Um identificador do Looker para nomear o filtro

Regras especiais
Os nomes de filtros não podem ser compartilhados com nenhum outro filtro, dimension ou measure no mesmo view.

Definição

O parâmetro filter declara um campo somente para filtros e um nome para esse filtro. Um usuário pode adicionar campos somente para filtros como filtros ao fazer uma análise detalhada, mas não pode adicioná-los ao conjunto de resultados. Esses campos somente para filtro são úteis com filtros com modelos, que são um tópico avançado da LookML. Consulte também o exemplo Usar filter para filtrar por um campo oculto.

O nome do filtro precisa:

  • Ser único em qualquer visualização
  • Consistir em caracteres de a a z (sem letras maiúsculas), de 0 a 9 ou _
  • Começar com uma letra

Existem muitos tipos de campos de filtro, conforme discutido na página de documentação Tipos de dimensões, filtros e parâmetros.

Subparâmetros de filter

Consulte a página de referência Parâmetros de campo para ver uma lista de subparâmetros disponíveis para campos da LookML.

Exemplos

Confira alguns exemplos de como usar o parâmetro filter.

Como criar um filtro especificado pelo usuário

Crie um filtro que permita ao usuário especificar o order_region:

filter: order_region {
  type: string
}

Como definir uma tabela derivada dinâmica com um filtro com modelo

Conforme mostrado na página de documentação Filtros com modelo e parâmetros do Liquid, defina uma tabela derivada para calcular o gasto vitalício dos clientes em uma região especificada pelo usuário. Este exemplo usa o filter criado no exemplo anterior como parte de um filtro com modelo. A entrada filter é usada na cláusula WHERE com variáveis do Liquid:

view: customer_facts {
  derived_table: {
    sql:
      SELECT
        customer_id,
        SUM(sale_price) AS lifetime_spend
      FROM
        order
      WHERE
        {% condition order_region %} order.region {% endcondition %}
      GROUP BY 1
    ;;
  }

  filter: order_region {
    type: string
  }
}

Como usar o parâmetro sql com filter

Também é possível usar o parâmetro sql com filter, que se aplica à cláusula WHERE do SQL sempre que o filtro tem um valor. Isso permite uma cláusula WHERE dinâmica com base na entrada do filtro de usuário.

O exemplo a seguir cria um filtro que permite apenas nomes de usuários que existem no conjunto de dados:

filter: user_enabled {
  type: string
  suggest_dimension: user_name
  sql: EXISTS (SELECT user_id FROM users WHERE {% condition %} user_name {% endcondition %} and state = 'enabled') ;;
}

No exemplo anterior, se a lista completa de nomes de usuários no conjunto de dados for "Zach", "Erin" e "Brett", o filtro vai resultar na seguinte cláusula WHERE:

WHERE EXISTS (SELECT user_id FROM users WHERE user_name in ('Zach', 'Erin', 'Brett') and state = 'enabled')

Consulte a seção Usar filter para filtrar por um campo oculto nesta página para ver um exemplo de como usar o parâmetro sql com filter.

Usar filter para definir uma tabela derivada dinâmica e um filtro definido pelo usuário

Usando o exemplo anterior que define uma tabela derivada com um valor de região dinâmica, é possível usar o parâmetro sql com um filtro com modelo para criar dinamicamente uma cláusula WHERE que se aplica à tabela derivada e à consulta principal gerada pelo Looker:

view: customer_facts {
  derived_table: {
    sql:
      SELECT
        customer_id,
        SUM(sale_price) AS lifetime_spend
      FROM
        order
      WHERE
        {% condition order_region %} order.region {% endcondition %}
      GROUP BY 1
    ;;
  }
  filter: order_region {
    type: string
    sql: {% condition order_region %} ${region} {% endcondition %} ;;
  }
  dimension: region {
    type: string
    sql: ${TABLE}.region ;;
  }

No exemplo anterior, o usuário fornece entrada para o filtro order_region, que, por sua vez, fornece o valor para a dimensão region. A dimensão region fornece o valor da cláusula WHERE no SQL da tabela derivada e, devido ao parâmetro sql na definição filter, o valor da cláusula WHERE em uma consulta gerada pelo Looker.

Usar filter para filtrar por um campo oculto

Você pode usar filter para criar uma dimensão que os usuários podem filtrar, além de impedir que eles a selecionem em uma consulta.

  1. Primeiro, oculte a dimensão em questão usando hidden: yes. Isso significa que a dimensão não estará disponível para os usuários selecionarem em um seletor de campos da Análise.

      dimension: field_to_hide {
        type: string
        hidden: yes
        sql: ${TABLE}.field_to_hide ;;
      }
    
  2. Agora, crie um campo filter para vincular à dimensão field_to_hide.

    filter: filter_on_field_to_hide {
      type: string
      sql: {% condition filter_on_field_to_hide %} ${field_to_hide} {% endcondition %} ;;
    }
    

Como discutido no exemplo Como usar o parâmetro sql com filter, o parâmetro sql do campo filter aplica o SQL diretamente à cláusula WHERE da consulta. Nesse caso, o sql usa a condição de filtro especificada no filtro filter_on_field_to_hide e a aplica à dimensão ${field_to_hide}.

Assim, os usuários podem filtrar uma consulta por field_to_hide com o filtro filter_on_field_to_hide, enquanto a dimensão field_to_hide permanece oculta.