探索参数

此页面链接到 explore 参数的所有子级 LookML 参数。

在 Looker 应用中,探索是查询的起点。探索会引用 视图,并且每个探索都可以包含与其他视图的 联接。探索通常应在模型文件中声明。

用法示例

将鼠标悬停在参数名称上可查看简要说明;点击该名称可跳转到相应页面。 当参数可以设置为多个特定选项之一时,默认值会列在最前面。

## STRUCTURAL PARAMETERS

explore: explore_name {
  extension: required
  extends: [explore_name,  explore_name, ...]
  fields: [field_or_set, field_or_set, ...]
  tags: ["string1", "string2", ...]

  # DISPLAY PARAMETERS
  description: "Description I want"
  group_label: "Label to use as a heading in the Explore menu"
  hidden: yes | no
  label: "desired label"
  query:  {
      # Desired query parameters (described on the query page)      }
  view_label: "Field picker heading I want for the Explore's fields"

  # FILTER PARAMETERS

  access_filter: {
    field: fully_scoped_field
    user_attribute: user_attribute_name
  }

  # Possibly more access_filter declarations

  always_filter: {
    filters: [field_name: "filter expression", field_name: "filter expression", ...]
  }
  case_sensitive: yes | no
  conditionally_filter: {
    filters: [field_name: "filter expression", field_name: "filter expression", ...]
    unless: [field_name, field_name, ...]
  }
  sql_always_having: SQL HAVING condition ;;
  sql_always_where: SQL WHERE condition ;;

  # JOIN PARAMETERS

  always_join: [view_name, view_name, ...]
  join: view_name {
    # Desired join parameters (described on Join Parameters page)
  }
  # Possibly more join declarations

  # QUERY PARAMETERS

  autogenerate_primary_keys: yes | no
  cancel_grouping_fields: [fully_scoped_field, fully_scoped_field, ...]
  from: view_name
  persist_for: "N (seconds | minutes | hours)"
  persist_with: datagroup_name
  required_access_grants: [access_grant_name, access_grant_name, ...]
  sql_table_name: table_name ;;
  sql_preamble: SQL STATEMENT  ;;
  symmetric_aggregates: yes | no
  view_name: view_name

  # AGGREGATE TABLE PARAMETERS

  aggregate_table: table_name {
    query:  {
      # Desired query parameters (described on the aggregate_table page)
    }
    materialization:  {
      # Desired materialization parameters (described on the aggregate_table page)
    }
  }
  # Possibly more aggregate_table declarations
}

## REFINEMENT PARAMETERS

explore: +explore_name {
  final: yes
}

参数定义

参数名称 说明
结构参数
extends (适用于探索) 指定将由此探索扩展的探索
extension (适用于探索) 指定探索需要扩展,并且本身无法向用户公开
explore (适用于模型) 在“探索”菜单中公开视图
fields (适用于探索) 限制探索中可用的字段,这些字段来自探索的基础视图,并通过探索的联接提供
tags (适用于探索) 指定可以传递给其他应用的文本
显示参数
description (适用于探索) 为探索添加说明,该说明会在界面中向用户显示
group_label (适用于探索) 创建组标签以用作“探索”菜单中的标题
hidden (适用于探索) 在“探索”菜单中隐藏探索
label (适用于探索) 更改探索在“探索”菜单中的显示方式
query (适用于探索) 创建预定义的查询,供用户在探索的“快速应用”菜单中选择。
view_label (适用于探索) 指定探索的基础视图中的一组字段在字段选择器中的标签方式
过滤条件参数
access_filter 向探索添加用户专用过滤条件
always_filter 向探索添加用户可以更改但不能移除的过滤条件
case_sensitive (适用于探索) 指定过滤条件是否区分大小写
conditionally_filter 如果用户未从特定列表中添加自己的过滤条件,则向探索添加过滤条件
sql_always_having 将条件插入查询的 HAVING 子句中,用户无法更改或移除此探索的条件
sql_always_where 将条件插入查询的 WHERE 子句中,用户无法更改或移除此探索的条件
联接参数
always_join 指定必须始终应用于探索的联接
join 将其他视图与探索联接。如需详细了解联接及其参数,请参阅联接参数参考页面。
查询参数
autogenerate_primary_keys (适用于探索) 启用或停用自动主键生成
cancel_grouping_fields 在探索中选择某些字段时取消 GROUP BY 子句
from (适用于探索) 指定探索所基于的视图,并通过探索的名称引用该视图的字段
persist_for (适用于探索) 更改探索的缓存设置
persist_with (适用于探索) 指定用于探索的缓存策略的数据组
required_access_grants (适用于探索) 将对探索的访问权限限制为仅限用户属性值与访问权限匹配的用户
sql_table_name (适用于探索) 指定探索所基于的数据库表
symmetric_aggregates 指定是否为探索启用了对称聚合
view_name (适用于探索) 指定探索所基于的视图,并通过视图的名称引用该视图的字段
汇总表参数
aggregate_table 创建汇总表格,以便对探索中的查询使用汇总感知功能。如需了解 aggregate_table 参数,请参阅 aggregate_table 参数页面。如需了解汇总感知功能的概览,请参阅汇总感知功能文档页面。
query 定义汇总表格的查询。如需了解 query 及其子参数,请参阅 aggregate_table 参数页面。
materialization 定义汇总表格的持久性策略。如需了解 materialization 及其子参数,请参阅 aggregate_table 参数页面。
优化参数
explore: +explore_name 在现有探索名称前添加加号 (+),以便向现有探索添加优化。如需了解详情和用例,请参阅 LookML 优化文档页面。
final 表示当前优化是允许对探索进行的最终优化。如需了解详情和用例,请参阅 LookML 优化文档页面。
应避免使用的参数
access_filter_fields 已在 6.0 中移除 替换为 access_filter