Parâmetros de campo

Esta página tem links para todos os parâmetros da LookML que definem campos.

Há vários tipos de campos:

  • As dimensões representam uma coluna em uma tabela ou um valor calculado com base em algum tipo de manipulação ou combinação de colunas.
  • Os grupos de dimensões são usados apenas com dados baseados em tempo e permitem criar várias dimensões baseadas em tempo de uma só vez.
  • As medidas são semelhantes às funções de agregação em SQL (por exemplo, COUNT, SUM, AVG) e representam informações sobre várias linhas.
  • Os filtros criam um campo somente para filtros que os usuários podem usar para fornecer entrada a um filtro com modelo ou uma junção condicional.
  • Os parâmetros criam um campo somente para filtros que os usuários podem usar para fornecer entradas a uma tag {% parameter %} do Liquid.

Exemplo de uso

Passe o cursor sobre o nome de um parâmetro para ver uma descrição rápida. Clique no nome de um parâmetro para acessar a página de referência.

Quando um parâmetro pode ser definido como uma de várias opções específicas, o valor padrão é listado primeiro.

## STRUCTURAL PARAMETERS
view: view_name {
  (dimension |dimension_group |measure |filter | parameter):field_name{
    intervals: [interval, interval, …]
    timeframes: [timeframe, timeframe, …]

    # ACTION AND LINKING PARAMETERS
    action: {
      label: "Label to Appear in Action Menu"
      url: "url"
      icon_url: "url"
      form_url: "url"
      param: {
        name:  "name string"
        value:  "value string"
      }
      # Possibly more param definitions
      form_param: {
        name:  "title"
        type: select | string | textarea
        label:  "desired label name"
        required:  yes | no
        default:  "value string"
        option: {
          name:  "name string"
          value:  "value string"
        }
        # Possibly more option definitions
      }
      # Possibly more form_param definitions
    }
    drill_fields: [field_or_set, field_or_set, ...]
    tags: ["string1", "string2", ...]
    link: {
      label: "desired label name;"
      url: "desired_url"
      icon_url: "url_of_an_image_file"
    }
    # Possibly more link definitions
    # DISPLAY PARAMETERS
    alias: [old_field_name, old_field_name, ...]
    alpha_sort: yes | no
    description: "description string"
    group_label:  "desired group label name"
    group_item_label:  "label to use under the group label in the field picker"
    hidden: yes | no
    label: "desired label name"
    label_from_parameter: parameter_name
    order_by_field: dimension_name | dimension_group_name | measure_name 
    style: classic | interval | integer | relational
    view_label: "desired label name"

    # FILTER PARAMETERS
    can_filter: yes | no
    case_sensitive: yes | no
    filters: [dimension: "filter expression", dimension: "filter expression", ...]
    skip_drill_filter: yes | no

    # FILTER SUGGESTION PARAMETERS
    allowed_value: {
      label: "desired label name"
      value: "looker filter expression"
    }
    # Possibly more allowed_value definitions
    bypass_suggest_restrictions: yes | no
    full_suggestions: yes | no
    suggest_dimension: dimension_name
    suggest_explore: explore_name
    suggest_persist_for: "N (seconds | minutes | hours)"
    suggestable: yes | no
    suggestions: ["suggestion string", "suggestion string", "…"]<

    # QUERY PARAMETERS
    allow_approximate_optimization: yes | no
    approximate: yes | no
    approximate_threshold: N
    convert_tz: yes | no
    datatype: epoch | timestamp | datetime | date | yyyymmdd
    fanout_on: repeated_record_name
    precision: N
    primary_key: yes | no
    required_access_grants: [access_grant_name, access_grant_name, ...]
    required_fields: [field_name, field_name, ...]
    sql_distinct_key: SQL expression to define repeated entities ;;

    # VALUE AND FORMATTING PARAMETERS
    case: {
      when: {
        sql: SQL condition ;;
        label: "value"
      }
      # Possibly more when statements
    }
    default_value: "desired default value"
    direction: "row | column"
    end_location_field: dimension_name
    html: HTML expression using Liquid template elements ;;
    list_field: dimension_name

    percentile: Nth percentile
    sql: SQL expression to generate the field value ;;
    sql_end: SQL expression indicating the end time of a duration ;;
    sql_latitude: SQL expression to generate a latitude ;;
    sql_longitude: SQL expression to generate a longitude ;;
    sql_start: SQL expression indicating the start time of a duration ;;
    start_location_field: dimension_name
    synonyms: [synonym1, synonym2, ...]
    tiers: [N, N, ...]
    type: dimension_field_type # For a dimension field
    type: dimension_group_type
# For a dimension_group field
    type: measure_field_type   # For a measure field
    type: filter_field_type    # For a filter field
    type: parameter_field_type # For a parameter field
    string_datatype: unicode # For a dimension field
    units: feet | kilometers | meters | miles | nautical_miles | yards
    value_format: "excel-style formatting string"
    value_format_name: format_name

    # VISUALIZATION PARAMETERS
    allow_fill: yes | no
    map_layer_name: name_of_map_layer
  }
}

Definições de parâmetro

  • D = Dimensão
  • DG = Grupo de dimensão
  • M = Measure
  • F = Filter
  • P = Parameter
Nome do parâmetro Tipos de campo válidos Descrição
Parâmetros estruturais
dimension D Cria um campo de dimensão.
dimension_group DG Cria várias dimensões com base no tempo ao mesmo tempo.
filter F Cria um campo somente de filtro para uso em um filtro com modelo ou junção condicional.
measure M Cria um campo de métrica
parameter P Cria um campo somente para filtros que os usuários podem usar para fornecer entrada a uma tag {% parameter %} do Liquid.
intervals DG Define o conjunto de dimensões de duração que você quer em um dimension_group de type: duration.
timeframes DG Define o conjunto de dimensões de período que você quer em um dimension_group de type: time.
Parâmetros de ação e vinculação
action D M Cria uma ação de dados em um campo que permite aos usuários realizar tarefas em outras ferramentas diretamente do Looker.
drill_fields D DG M Declara a lista de campos que serão mostrados quando a métrica ou dimensão for detalhada.
link D M Cria links para outros conteúdos do Looker e externos
tags D DG M F P Adiciona texto que pode ser transmitido a outros aplicativos para fornecer dados sobre um campo.
Parâmetros de exibição
alias D DG M F P Permite que URLs salvos com nomes de campo antigos continuem funcionando depois que um campo é renomeado.
alpha_sort D Faz com que um parâmetro case classifique as condições em ordem alfabética.
description D DG M F P Adiciona uma descrição ao campo que os usuários podem ver ao passar o cursor sobre ele.
group_label D DG M F Agrupa campos em uma visualização no seletor de campos.
group_item_label D DG M F Especifica um rótulo a ser usado para o campo no rótulo do grupo no seletor de campos.
hidden D DG M F P Oculta um campo da interface da Análise.
label D DG M F P Muda a forma como um nome de campo aparece no seletor de campos
label_from_parameter D M Muda a forma como um nome de campo aparece em uma visualização com base na entrada de um parameter.
order_by_field D DG M

Classifica um campo pelos valores de outro campo.

Compatível com dimensões e grupos de dimensões

Compatível com medidas

style D Muda a forma como os níveis aparecem na interface do Looker para uma dimensão de type: tier.
view_label D DG M F P Muda os campos que aparecem em uma visualização no seletor de campos.
Parâmetros de filtro
can_filter D DG M Determina se uma dimensão ou medida pode ser usada como filtro
case_sensitive D F Determina se os filtros diferenciam maiúsculas de minúsculas para uma dimensão.
filter F Cria um campo somente para filtros para uso em um filtro com modelo.
filters M Restringe o cálculo de uma métrica com base em limitações de dimensão.
skip_drill_filter D Impede que uma dimensão seja adicionada aos filtros quando uma métrica é detalhada.
Parâmetros de sugestão de filtro
allowed_value P Especifica as opções para um parameter.
bypass_suggest_restrictions D DG F P Mostra sugestões aos usuários quando sql_always_where está em uso, mas não aplica esses limites às sugestões
full_suggestions D DG F P Controla como o Looker consulta seu banco de dados para fornecer sugestões de valores de um campo no filtro de uma Análise. O Looker pode usar uma consulta SELECT DISTINCT básica ou toda a lógica da Análise detalhada, incluindo junções e parâmetros sql_always_where e access_filter.
suggest_dimension D DG M F P Baseia as sugestões de um campo nos valores de outra dimensão.
suggest_explore D DG M F P Baseia as sugestões de um campo nos valores de outra análise detalhada.
suggest_persist_for D F P Muda as configurações de cache para sugestões de filtro do Looker.
suggestable D DG M F P Ativa ou desativa as sugestões para um campo
suggestions D F P Declara uma lista de valores que serão usados para as sugestões de um campo.
Query Parameters
allow_approximate_optimization M Permite aproximações de contagem distintas para medidas de type: count ou type: count_distinct, para que a medida possa ser usada para conscientização agregada.
approximate M Realiza uma contagem aproximada de uma medida de type: count_distinct. Consulte a página de documentação approximate para ver uma lista de dialetos que aceitam esse parâmetro.
approximate_threshold M Define a contagem em que o BigQuery muda de uma contagem exata para uma aproximada.
convert_tz D DG M F P Desativa a conversão automática de fuso horário para um campo.
datatype D DG F M Especifica o tipo de dados de tempo que você está fornecendo a um campo.
fanout_on D DG M Permite o acesso a campos repetidos do Google BigQuery.
precision M Especifica o número de casas decimais a serem usadas ao fazer cálculos para agregações simétricas do Looker.
primary_key D Declara uma dimensão como a chave primária de uma visualização.
required_access_grants D DG F M P Limita o acesso ao campo apenas aos usuários cujos valores de atributo de usuário correspondem às concessões de acesso.
required_fields D M Exige que outros campos sejam adicionados a uma consulta quando um campo é escolhido
sql_distinct_key M Define as entidades exclusivas em que uma medida de type: sum_distinct ou type: average_distinct será calculada.
Parâmetros de valor e formatação
case D Cria um conjunto discreto de valores que uma dimensão pode ter, determinado por condições SQL.
default_value F P Especifica um valor padrão para campos de filtro
direction M Determina a direção em que uma medida de type: percent_of_total ou type: running_total é calculada quando os pivôs são usados.
end_location_field D Define o campo que contém o local de término para um campo de type: distance
html D DG M Modifica a saída HTML de um campo usando modelos do Liquid.
list_field M Declara a dimensão de que uma medida de type: list será calculada.
percentile M Especifica o valor fracionário (o percentil N) para uma métrica de type: percentile ou type: percentile_distinct.
sql D DG M F Determina como um campo será calculado
sql_end D DG Define o horário de término de uma duração para um grupo de dimensões do tipo duração ou uma dimensão do tipo duração.
sql_latitude D Define a latitude de uma dimensão de type: location.
sql_longitude D Define a longitude de uma dimensão de type: location.
sql_start D DG Define o horário de início de uma duração para um grupo de dimensões do tipo duração ou uma dimensão do tipo duração.
start_location_field D Define o campo que contém o local de início de um campo de type: distance.
synonyms D DG F M P Especifica uma lista de sinônimos de string (palavras ou frases) que podem ser usados para ajudar modelos de linguagem grandes e desenvolvedores de apps a entender outras maneiras de os usuários se referirem a um campo.
tiers D Define os níveis para uma dimensão de type: tier.
type (para dimensão, filtro ou parâmetro) D F P Especifica o tipo de dimensão, filtro ou parâmetro.
type (para grupo de dimensões) DG Especifica o tipo de grupo de dimensões.
type (para métrica) M Especifica o tipo de métrica
string_datatype D Especifica o tipo de dados Unicode para um campo de type: string para SQL Server ou MySQL.
units D Especifica as unidades a serem usadas para um campo de type: distance
value_format D M Formata a saída de um campo usando opções de estilo do Excel.
value_format_name D M Formata a saída de um campo usando um formato integrado ou personalizado.
Parâmetros de visualização
allow_fill D DG Determina se o preenchimento de dimensão é permitido para uma dimensão
map_layer_name D Especifica um mapeamento de um valor de dados para uma região geográfica definida em um mapa integrado ou personalizado.
Parâmetros a serem evitados
decimals D M Removido 5.4 Substituído por value_format
format D M Removido 3.16 Substituído por value_format