在Superset中使用Jinja模板处理列的语法及参数用法咨询

Superset的Jinja模板通过内置上下文变量动态生成列相关SQL逻辑，核心是结合Jinja控制语句（如循环、条件判断）调用官方文档提到的列参数，以下是具体用法：

基础语法规则 #

所有模板逻辑直接嵌入SQL语句中，通过{{ 变量/表达式 }}调用上下文变量，用{% 控制语句 %}实现循环、条件判断等逻辑。

各列参数的具体用法 #

1. columns（当前查询的分组列集合） #

存储用户在图表配置中选择的分组列，是包含列元数据的列表，每个列对象包含column_name（列名）、expression（SQL表达式）等属性，最常用的是column_name。

典型场景：动态生成GROUP BY与SELECT子句

SELECT
  {{ columns|map(attribute='column_name')|join(', ') }},
  COUNT(*) AS record_count
FROM your_dataset
GROUP BY {{ columns|map(attribute='column_name')|join(', ') }}

用Jinja的map+join过滤器简化循环，避免冗余代码；也可以用循环实现更复杂的逻辑：

SELECT
  {% for col in columns %}
    {{ col.column_name }} AS {{ col.column_name|lower }}{% if not loop.last %}, {% endif %}
  {% endfor %},
  COUNT(*) AS record_count
FROM your_dataset
GROUP BY
  {% for col in columns %}
    {{ col.column_name }}{% if not loop.last %}, {% endif %}
  {% endfor %}

2. groupby（已弃用） #

官方明确标记为弃用参数，功能完全被columns替代，新模板中不要使用。

3. table_columns（数据集的所有可用列） #

存储当前数据集（表/视图）的全部列元数据，适合做列存在性判断、动态遍历所有列。

典型场景1：条件性包含列

SELECT
  id,
  username,
  {% if 'user_level' in [col.column_name for col in table_columns] %}
    user_level,
  {% endif %}
  create_time
FROM your_dataset

典型场景2：遍历所有列

SELECT
  {% for col in table_columns %}
    {{ col.column_name }}{% if not loop.last %}, {% endif %}
  {% endfor %}
FROM your_dataset

4. time_column（当前查询的时间列） #

存储用户在图表配置中指定的时间列名（字符串格式），未指定则为None，常配合Superset内置的start_dttm/end_dttm（时间范围参数）使用。

典型场景：动态时间维度聚合与过滤

SELECT
  {% if time_column %}
    DATE_TRUNC('week', {{ time_column }}) AS week_period,
  {% endif %}
  COUNT(*) AS record_count
FROM your_dataset
{% if time_column %}
WHERE {{ time_column }} >= '{{ start_dttm }}' AND {{ time_column }} <= '{{ end_dttm }}'
{% endif %}
{% if time_column %}
GROUP BY DATE_TRUNC('week', {{ time_column }})
{% endif %}

实用技巧 #

• 处理空值情况：比如columns为空（无分组）时，避免GROUP BY子句报错：

SELECT
  {% if columns %}
    {{ columns|map(attribute='column_name')|join(', ') }},
  {% endif %}
  COUNT(*) AS record_count
FROM your_dataset
{% if columns %}
GROUP BY {{ columns|map(attribute='column_name')|join(', ') }}
{% endif %}

• 用column.expression替代column_name：如果列是经过计算的表达式（如CONCAT(first_name, last_name)），直接调用{{ col.expression }}可复用原表达式。

内容的提问来源于stack exchange，提问作者Viktor Demin