mirror of
https://github.com/grafana/grafana.git
synced 2025-02-11 08:05:43 -06:00
067e169b93
* Correcting one of the usage in documentation * Correcting usage of a word * Correcting usage of a word in docs * Correcting same word in 2 more occurrences * Correcting a word in docs * Correcting a word in docs * Update docs/sources/variables/advanced-variable-format-options.md Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com> * Incorporated reviewer's suggestion in other occurrences Co-authored-by: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>
146 lines
3.8 KiB
Markdown
146 lines
3.8 KiB
Markdown
+++
|
|
title = "Advanced variable format options"
|
|
keywords = ["grafana", "templating", "documentation", "guide", "template", "variable"]
|
|
type = "docs"
|
|
[menu.docs]
|
|
name = "advanced-variable-format-options"
|
|
parent = "variables"
|
|
weight = 300
|
|
+++
|
|
|
|
# Advanced variable format options
|
|
|
|
The formatting of the variable interpolation depends on the data source, but there are some situations where you might want to change the default formatting.
|
|
|
|
For example, the default for the MySql data source is to join multiple values as comma-separated with quotes: `'server01','server02'`. In some cases, you might want to have a comma-separated string without quotes: `server01,server02`. You can make that happen with advanced variable formatting options listed below.
|
|
|
|
## General syntax
|
|
|
|
Syntax: `${var_name:option}`
|
|
|
|
Test the formatting options on the [Grafana Play site](https://play.grafana.org/d/cJtIfcWiz/template-variable-formatting-options?orgId=1).
|
|
|
|
If any invalid formatting option is specified, then `glob` is the default/fallback option.
|
|
|
|
An alternative syntax (that might be deprecated in the future) is `[[var_name:option]]`.
|
|
|
|
## CSV
|
|
|
|
Formats variables with multiple values as a comma-separated string.
|
|
|
|
```bash
|
|
servers = ['test1', 'test2']
|
|
String to interpolate: '${servers:csv}'
|
|
Interpolation result: 'test1,test2'
|
|
```
|
|
|
|
## Distributed - OpenTSDB
|
|
|
|
Formats variables with multiple values in custom format for OpenTSDB.
|
|
|
|
```bash
|
|
servers = ['test1', 'test2']
|
|
String to interpolate: '${servers:distributed}'
|
|
Interpolation result: 'test1,servers=test2'
|
|
```
|
|
|
|
## Doublequote
|
|
|
|
Formats single- and multi-valued variables into a comma-separated string, escapes `"` in each value by `\"` and quotes each value with `"`.
|
|
|
|
```bash
|
|
servers = ['test1', 'test2']
|
|
String to interpolate: '${servers:doublequote}'
|
|
Interpolation result: '"test1","test2"'
|
|
```
|
|
|
|
## Glob - Graphite
|
|
|
|
Formats variables with multiple values into a glob (for Graphite queries).
|
|
|
|
```bash
|
|
servers = ['test1', 'test2']
|
|
String to interpolate: '${servers:glob}'
|
|
Interpolation result: '{test1,test2}'
|
|
```
|
|
|
|
## JSON
|
|
|
|
Formats variables with multiple values as a comma-separated string.
|
|
|
|
```bash
|
|
servers = ['test1', 'test2']
|
|
String to interpolate: '${servers:json}'
|
|
Interpolation result: '["test1", "test2"]'
|
|
```
|
|
|
|
## Lucene - Elasticsearch
|
|
|
|
Formats variables with multiple values in Lucene format for Elasticsearch.
|
|
|
|
```bash
|
|
servers = ['test1', 'test2']
|
|
String to interpolate: '${servers:lucene}'
|
|
Interpolation result: '("test1" OR "test2")'
|
|
```
|
|
|
|
## Percentencode
|
|
|
|
Formats single and multi valued variables for use in URL parameters.
|
|
|
|
```bash
|
|
servers = ['foo()bar BAZ', 'test2']
|
|
String to interpolate: '${servers:percentencode}'
|
|
Interpolation result: 'foo%28%29bar%20BAZ%2Ctest2'
|
|
```
|
|
|
|
## Pipe
|
|
|
|
Formats variables with multiple values into a pipe-separated string.
|
|
|
|
```bash
|
|
servers = ['test1.', 'test2']
|
|
String to interpolate: '${servers:pipe}'
|
|
Interpolation result: 'test1.|test2'
|
|
```
|
|
|
|
## Raw
|
|
|
|
Turns off data source-specific formatting, such as single quotes in an SQL query.
|
|
|
|
```bash
|
|
servers = ['test1.', 'test2']
|
|
String to interpolate: '${var_name:raw}'
|
|
Interpolation result: '{test.1,test2}'
|
|
```
|
|
|
|
## Regex
|
|
|
|
Formats variables with multiple values into a regex string.
|
|
|
|
```bash
|
|
servers = ['test1.', 'test2']
|
|
String to interpolate: '${servers:regex}'
|
|
Interpolation result: '(test1\.|test2)'
|
|
```
|
|
|
|
## Singlequote
|
|
|
|
Formats single- and multi-valued variables into a comma-separated string, escapes `'` in each value by `\'` and quotes each value with `'`.
|
|
|
|
```bash
|
|
servers = ['test1', 'test2']
|
|
String to interpolate: '${servers:singlequote}'
|
|
Interpolation result: "'test1','test2'"
|
|
```
|
|
|
|
## Sqlstring
|
|
|
|
Formats single- and multi-valued variables into a comma-separated string, escapes `'` in each value by `''` and quotes each value with `'`.
|
|
|
|
```bash
|
|
servers = ["test'1", "test2"]
|
|
String to interpolate: '${servers:sqlstring}'
|
|
Interpolation result: "'test''1','test2'"
|
|
```
|