Documentation Plugins Amazon Redshift Template variables

Amazon Redshift template variables

Template variables let you create dynamic, reusable dashboards. Instead of hard-coding values like schema names, table names, or filter criteria, you can use variables that change based on user selections or query results.

For an introduction to variables in Grafana, refer to Templates and variables.

Before you begin

• Configure the Amazon Redshift data source.
• Familiarize yourself with Grafana template variables.

Supported variable types

Create a query variable

Query variables populate their options by running an SQL query against your Redshift data source. Any value returned from a Redshift table can be used as a variable. The variable query editor provides the same SQL editor, resource selectors, and macro support as the regular query editor.

To create a query variable:

1. Navigate to Dashboard settings > Variables.
2. Click Add variable.
3. Select Query as the variable type.
4. Select the Amazon Redshift data source.
5. Enter an SQL query in the query editor.
6. Click Run query to preview the variable options.
7. Click Apply.

Query examples

Return a list of schemas:

SQL Copy

SELECT schema_name FROM information_schema.schemata;

Return a list of tables from a specific schema:

SQL Copy

SELECT table_name FROM information_schema.tables WHERE table_schema = 'public';

Return distinct values from a column:

SQL Copy

SELECT DISTINCT region FROM sales_data;

Return event categories from the Redshift sample database:

SQL Copy

SELECT catname FROM public.category ORDER BY catname;

Custom display names

To display a user-friendly label while using a different value in queries, alias the columns as text and value:

SQL Copy

SELECT hostname AS text, id AS value FROM servers;

In this example, the variable drop-down shows hostnames, but the underlying value used in queries is the id.

Use variables in queries

After you create a variable, reference it in your Redshift queries using variable syntax. Grafana replaces the variable with the selected value before sending the query to Redshift.

For example, if you create a variable named schema:

SQL Copy

SELECT * FROM ${schema}.my_table WHERE $__timeFilter(created_at);

Multi-value variables

When a variable allows multiple selections, use the variable inside an IN clause:

SQL Copy

SELECT * FROM sales WHERE region IN (${region});

Grafana automatically formats the selected values as a comma-separated list.

Combine variables with macros

You can use template variables alongside Grafana macros in the same query:

SQL Copy

SELECT
  $__timeGroup(saletime, '1h'),
  sum(pricepaid) AS total_sales
FROM
  ${schema}.sales
WHERE
  $__timeFilter(saletime) AND catname IN (${category})
GROUP BY
  1
ORDER BY
  1 ASC;

Create cascading variables

You can create cascading (dependent) variables where one variable’s options depend on another variable’s selection. For example, create a schema variable first, then create a table variable that queries tables in the selected schema:

SQL Copy

SELECT table_name FROM information_schema.tables WHERE table_schema = '${schema}';

When the user changes the schema selection, the table options automatically refresh.