【Superset】Jinja模板功能及设置动态参数

1、Jinja模板功能介绍

1.1 开启Jinja模板

代码开关：在/superset/config.py文件中，将 ENABLE_TEMPLATE_PROCESSING ，设置为True（默认为False）。

1.2 常用默认变量

columns: 查询中分组的列维度
filter: 查询中用到的筛选字段
from_dttm: 时间列筛选范围的起始时间
to_dttm: 时间列筛选范围的结束时间
groupby: 同columns但已经不推荐使用
metrics: 查询中的聚合字段
row_limit: 查询的行数限制
row_offset: 查询跳过的行数
table_columns: 数据集中可用的列
time_column: 查询的时间字段，没有则是undefined
time_grain: 所选的time grain ,没有则是undefined

示例：
设置开始时间、结束时间参数

SELECT *
FROM tbl
WHERE dttm_col > '{
   { from_dttm }}' and dttm_col < '{
   { to_dttm }}'

设置如果时间筛选栏没有值，则跳过：

SELECT *
FROM tbl
WHERE (
    {
   % if from_dttm is not none %}
        dttm_col > '{
   { from_dttm }}' AND
    {
   % endif %}
    {
   % if to_dttm is not none %}
        dttm_col < '{
   { to_dttm }}' AND
    {
   % endif %}
    true
)

1.3 自定义Jinja上下文

在superset_config.py文件设置，示例：

JINJA_CONTEXT_ADDONS = {
   
    'my_crazy_macro': lambda x: x*2,
}

1.4 Jina模板默认值

通过JSON的格式设置参数默认值，示例：

{
   
  "my_table": "foo"
}

1.5 特殊过滤参数

可用于测试jinja模板中使用的过滤器

{
   
  "_filters": [
    {
   
      "col": "action_type",
      "op": "IN",
      "val": ["sell", "buy"]
    }
  ]
}

SELECT action, count(*) as times
FROM logs
WHERE action in {
   {
    filter_values('action_type'))|where_in }}
GROUP BY action

1.6 自定义模板

通过使用CUSTOM_TEMPLATE_PROCESSSORS进行配置

def DATE(
    ts: datetime, day_offset: SupportsInt = 0, hour_offset: SupportsInt = 0
) -> str:
    """Current day as a string."""
    day_offset, hour_offset = int(day_offset), int(hour_offset)