This is an automated email from the ASF dual-hosted git repository.
sfirke pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/superset.git
The following commit(s) were added to refs/heads/master by this push:
new 3db613dab5 chore(docs): switch to markdown headlines for available
macros (#35685)
3db613dab5 is described below
commit 3db613dab5cb34c142439df882093f8661370118
Author: Fabian Halkivaha <[email protected]>
AuthorDate: Fri Oct 17 16:16:49 2025 +0200
chore(docs): switch to markdown headlines for available macros (#35685)
---
docs/docs/configuration/sql-templating.mdx | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/docs/docs/configuration/sql-templating.mdx
b/docs/docs/configuration/sql-templating.mdx
index 827d70522c..a2c305a161 100644
--- a/docs/docs/configuration/sql-templating.mdx
+++ b/docs/docs/configuration/sql-templating.mdx
@@ -182,7 +182,7 @@ The available validators and names can be found in
In this section, we'll walkthrough the pre-defined Jinja macros in Superset.
-**Current Username**
+### Current Username
The `{{ current_username() }}` macro returns the `username` of the currently
logged in user.
@@ -197,7 +197,7 @@ cache key by adding the following parameter to your Jinja
code:
{{ current_username(add_to_cache_keys=False) }}
```
-**Current User ID**
+### Current User ID
The `{{ current_user_id() }}` macro returns the account ID of the currently
logged in user.
@@ -212,7 +212,7 @@ cache key by adding the following parameter to your Jinja
code:
{{ current_user_id(add_to_cache_keys=False) }}
```
-**Current User Email**
+### Current User Email
The `{{ current_user_email() }}` macro returns the email address of the
currently logged in user.
@@ -227,7 +227,7 @@ cache key by adding the following parameter to your Jinja
code:
{{ current_user_email(add_to_cache_keys=False) }}
```
-**Current User Roles**
+### Current User Roles
The `{{ current_user_roles() }}` macro returns an array of roles for the
logged in user.
@@ -257,7 +257,7 @@ Will be rendered as:
SELECT * FROM users WHERE role IN ('admin', 'viewer')
```
-**Current User RLS Rules**
+### Current User RLS Rules
The `{{ current_user_rls_rules() }}` macro returns an array of RLS rules
applied to the current dataset for the logged in user.
@@ -265,7 +265,7 @@ If you have caching enabled in your Superset configuration,
then the list of RLS
by Superset when calculating the cache key. A cache key is a unique identifier
that determines if there's a
cache hit in the future and Superset can retrieve cached data.
-**Custom URL Parameters**
+### Custom URL Parameters
The `{{ url_param('custom_variable') }}` macro lets you define arbitrary URL
parameters and reference them in your SQL code.
@@ -299,7 +299,7 @@ Here's a concrete example:
WHERE country_code = 'US'
```
-**Explicitly Including Values in Cache Key**
+### Explicitly Including Values in Cache Key
The `{{ cache_key_wrapper() }}` function explicitly instructs Superset to add
a value to the
accumulated list of values used in the calculation of the cache key.
@@ -311,7 +311,7 @@ in the cache key. You can gain more context
Note that this function powers the caching of the `user_id` and `username`
values
in the `current_user_id()` and `current_username()` function calls (if you
have caching enabled).
-**Filter Values**
+### Filter Values
You can retrieve the value for a specific filter as a list using `{{
filter_values() }}`.
@@ -332,7 +332,7 @@ GROUP BY action
There `where_in` filter converts the list of values from
`filter_values('action_type')` into a string suitable for an `IN` expression.
-**Filters for a Specific Column**
+### Filters for a Specific Column
The `{{ get_filters() }}` macro returns the filters applied to a given column.
In addition to
returning the values (similar to how `filter_values()` does), the
`get_filters()` macro
@@ -394,7 +394,7 @@ Here's a concrete example:
order by lineage, level
```
-**Time Filter**
+### Time Filter
The `{{ get_time_filter() }}` macro returns the time filter applied to a
specific column. This is useful if you want
to handle time filters inside the virtual dataset, as by default the time
filter is placed on the outer query. This can
@@ -469,7 +469,7 @@ WHERE
AND dttm < {{ time_filter.to_expr }}
```
-**Datasets**
+### Datasets
It's possible to query physical and virtual datasets using the `dataset`
macro. This is useful if you've defined computed columns and metrics on your
datasets, and want to reuse the definition in adhoc SQL Lab queries.
@@ -493,7 +493,7 @@ Since metrics are aggregations, the resulting SQL
expression will be grouped by
SELECT * FROM {{ dataset(42, include_metrics=True, columns=["ds", "category"])
}} LIMIT 10
```
-**Metrics**
+### Metrics
The `{{ metric('metric_key', dataset_id) }}` macro can be used to retrieve the
metric SQL syntax from a dataset. This can be useful for different purposes:
@@ -511,7 +511,7 @@ The parameter can be used in SQL Lab, or when fetching a
metric from another dat
Superset supports [builtin filters from the Jinja2 templating
package](https://jinja.palletsprojects.com/en/stable/templates/#builtin-filters).
Custom filters have also been implemented:
-**Where In**
+### Where In
Parses a list into a SQL-compatible statement. This is useful with macros that
return an array (for example the `filter_values` macro):
```
@@ -528,7 +528,7 @@ Dashboard filter without any value applied
{{ filter_values('column')|where_in(default_to_none=True) }} => None
```
-**To Datetime**
+### To Datetime
Loads a string as a `datetime` object. This is useful when performing date
operations. For example:
```
