模板化过滤器和液体参数

这是一个高级主题,假定您已经熟练掌握了 SQL 和 LookML。

Looker 通过创建基于维度和测量结果的过滤器,自动为用户提供操控查询的功能。尽管这种简单的方法可以满足很多用例的需求,但它并不能满足所有分析需求。模板化过滤器和 Liquid 参数大大扩大了您可以支持的可能用例。

从 SQL 的角度来看,维度和指标只能更改查询中最外层的 WHEREHAVING 子句。不过,您可能会发现,允许用户操控 SQL 的其他部分。使用模板化过滤条件和 Liquid 参数可以启用某些功能,例如调整派生表、调整查询的数据库表,或者创建多用途维度和过滤条件等。

模板化过滤器和 Liquid 参数利用 Liquid 模板语言将用户输入插入 SQL 查询。首先,您要使用 LookML 参数创建一个字段,供用户与之互动。接下来,您使用 Liquid 变量将用户输入注入 SQL 查询。

示例

下面我们来看几个示例,以展示模板化过滤器和 Liquid 参数的值。

使用模板化过滤条件创建动态派生表

派生表为例,该计算公式会计算东北区域内的客户生命周期支出:

view: customer_facts {
  derived_table: {
    sql:
      SELECT
        customer_id,                        -- Can be made a dimension
        SUM(sale_price) AS lifetime_spend   -- Can be made a dimension
      FROM
        order
      WHERE
        region = 'northeast'                -- Can NOT be made a dimension
      GROUP BY 1
    ;;
  }
}

在此查询中,您可以根据 customer_idlifetime_spend 创建维度。不过,假设您希望用户能够指定 region,而不是将其硬编码为“northeast”。region 不能作为维度公开,因此用户无法照常对其进行过滤。

您可以使用模板化过滤条件,如下所示:

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
  }
}

请阅读下文的分步说明。

如果派生表使用模板化过滤条件,则无法使表持久化

使用 Liquid 参数进行动态测量

考虑一个经过过滤的措施,将售出裤子的数量相加:

measure: pants_count {
  filters: [category: "pants"]
}

这很简单,但如果有数十个类别,为每个类别创建一个衡量会比较繁琐。此外,这可能会给用户的探索体验带来不利影响。

另一种方法是创建如下所示的动态衡量指标:

measure: category_count {
  type: sum
  sql:
    CASE
      WHEN ${category} = '{% parameter category_to_count %}'
      THEN 1
      ELSE 0
    END
  ;;
}

parameter: category_to_count {
  type: string
}

请阅读下文的分步说明。

基本用法

第一步:创建可供用户互动的内容

  • 对于模板化过滤条件,请添加 filter
  • 对于 Liquid 参数,请添加 parameter

无论是哪种情况,这些字段都会显示在字段选择器的仅限过滤的字段部分下。

filterparameter 字段都可以接受一系列子参数,允许您自定义它们的运行方式。如需查看完整列表,请参阅字段参数文档页面。对于 parameter 字段,有以下两个选项需要特别注意。

首先,parameter 字段可以包含一个名为不带引号的特殊类型:

parameter: table_name {
  type: unquoted
}

此类型允许将值插入 SQL 而不用引号括起来,就像字符串一样。如果您需要插入表名称等 SQL 值,这种做法会非常有用。

其次,parameter 字段中有一个名为允许的值的选项,您可以使用这些选项将易于理解的名称与要插入的值相关联。例如:

  parameter: sale_price_metric_picker {

    type: unquoted
    allowed_value: {
      label: "Total Sale Price"
      value: "SUM"
    }
    allowed_value: {
      label: "Average Sale Price"
      value: "AVG"
    }
    allowed_value: {
      label: "Maximum Sale Price"
      value: "MAX"
    }
    allowed_value: {
      label: "Minimum Sale Price"
      value: "MIN"
    }
  }

第 2 步:应用用户输入

第二步是根据需要,使用 Liquid 添加模板化过滤条件或 Liquid 参数。

模板化过滤条件

模板化过滤条件的语法如下所示:

{% condition filter_name %} sql_or_lookml_reference {% endcondition %}
  • conditionendcondition 这两个字词从不改变。
  • filter_name 替换为您在第 1 步中创建的过滤条件的名称。如果您没有创建仅用于过滤的字段,也可以使用维度。
  • sql_or_lookml_reference 替换为应设置为等于用户输入的 SQL 或 LookML。如需了解详情,请参阅下文。如果使用 LookML,请使用 ${view_name.field_name} LookML 语法。

上面的示例中,我们使用了如下代码:

{% condition order_region %} order.region {% endcondition %}

Liquid 标记与您在其中编写的 SQL 之间的互动很重要。模板化过滤条件标记始终会转换为逻辑表达式。例如,如果用户在 order_region 过滤器中输入了“Northeast”,Looker 会将这些代码转换为:order.region = 'Northeast'。换句话说,Looker 了解用户输入并生成适当的逻辑表达式。

这通常会让 Looker 开发者感到困惑。模板化过滤条件生成的始终是某种逻辑表达式,而不是用户输入的各个值。

由于模板化过滤条件会返回逻辑表达式,因此您可以将其与 SQL WHERE 语句中有效的其他逻辑运算符和逻辑表达式一起使用。在上面的示例中,如果您想返回用户选择的区域以外的所有值,可以在 WHERE 语句中使用以下代码:

NOT ({% condition order_region %} order.region {% endcondition %})

使用 LookML 字段作为过滤条件也是有效的。直接应用于 LookML 字段的任何过滤器都将确定 WHERE 语句的值:

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

  dimension: region {
    type: string
    sql: ${TABLE}.region ;;
}

Liquid 参数

Liquid 参数的语法如下所示:

{% parameter parameter_name %}
  • parameter”一词永远不会改变。
  • parameter_name 替换为您在第 1 步中创建的 parameter 名称。

例如,如需应用第 1 步parameter 字段的输入,您可以创建如下测量值:

  measure: sale_price_metric {

    type: number
    label_from_parameter: sale_price_metric_picker
    sql: {% parameter sale_price_metric_picker %}(${sale_price}) ;;
    value_format_name: usd
  }

在模板化过滤条件和 Liquid 参数之间进行选择

虽然模板化过滤条件和 Liquid 参数类似,但它们之间存在一项重要的区别:

  • 液体参数直接插入用户输入(或使用您通过允许的值定义的值)。
  • 模板化过滤条件会将值作为逻辑语句插入,如上文所述。

如果您希望为用户提供更灵活的输入(例如使用各种日期范围或字符串搜索),请尝试尽可能使用模板化过滤条件。Looker 可以解读用户输入,并在后台编写适当的 SQL。这样一来,您就不必将每种可能的用户输入都考虑在内。

如果无法插入逻辑语句,或者您知道用户可以输入的有限选项,请使用 Liquid 参数。