Dashboard: Support additional variable format options (singlequote, doublequote, sqlstring) #21622

xiaobeiyang · 2020-01-20T15:40:54Z

What this PR does / why we need it:
This PR adds 3 formatting options of variables, mainly for SQL.
New formatting list:
singlequote: Quote variable value(s) with single quote, escape single quotes in original value with backslashes.
doublequote: Quote variable value(s) with double quote, escape double quotes in original value with backslashes.
sqlstring: Quote variable value(s) with single quote, escape ' in original value by ''.

When writing SQL statements, we usually need this kind of statement “select * from table1 where name in (${var})”, but Grafana doesn’t provides formatting option to quote string of SQL.

Which issue(s) this PR fixes:

Fixes #

Special notes for your reviewer:

aknuds1 · 2020-01-20T15:44:21Z

Could you please fill in the section 'What this PR does / why we need it' in the PR template?

xiaobeiyang · 2020-01-20T23:28:45Z

@aknuds1 Thanks for your quick response, PR template has been update.

torkelo · 2020-01-21T06:13:53Z

There should be custom format functions in the Postgres and MySQL datasources I’m that does this I think

xiaobeiyang · 2020-01-21T07:36:41Z

Thanks @torkelo . It is not easy to decide which variable should be quoted/escaped in datasources plugins. For example: select $var1, $var2 from $tableVar where col1=$colVar1 AND col2 in $colVar2 .
I'm writing plugin for other database service instead of Postgres and MySQL. It will be great if Grafana platform provides these formats out of the box, then datasource plugins could have more common behaviors both in developing & using.

docs/sources/reference/templating.md

ryantxu

It is nice to have examples in the docs... but I would be waaaay happier with examples in tests :)

xiaobeiyang · 2020-02-01T01:20:38Z

@ryantxu Please help review. Thanks.

xiaobeiyang

updated

docs/sources/reference/templating.md

xiaobeiyang · 2020-02-17T08:17:03Z

Hi @torkelo , is there any other problem in the PR or some process? We expect this RP will be merged and start use it in my dashboards. Please help review, I will fix if there is any problem.
Thanks.

torkelo

Really sorry for slow feedback, this looks great now. Just a small detail missing in the docs

docs/sources/reference/templating.md

xiaobeiyang · 2020-02-17T14:43:24Z

@torkelo @ryantxu @oddlittlebird Please help review, many thanks.

oddlittlebird · 2020-02-18T20:37:54Z

LGTM!

xiaobeiyang

please help review

aknuds1

Please see my suggestions.

public/app/features/templating/specs/template_srv.test.ts

public/app/features/templating/template_srv.ts

aknuds1 · 2020-02-26T16:33:57Z

Hang on, going to adjust my suggestions as I hear that double quotes are allowed (I'm used to them not being allowed).

aknuds1 · 2020-02-26T16:52:17Z

OK, edited my suggestions :)

xiaobeiyang · 2020-03-03T15:11:28Z

Thanks @aknuds1 . Please help review again.
The CI grafana-docker-ubuntu-pr step failed due to Ubuntu repository issue. I don't have rerun privilege. It looks like grafana-docker-ubuntu-pr fail didn't cause by the new commits.

CLAassistant · 2020-03-03T15:50:51Z

All committers have signed the CLA.

aknuds1

Thanks for applying my suggestions, I just saw a remaining typo.

public/app/features/templating/template_srv.ts

aknuds1 · 2020-03-09T14:33:11Z

Can you please merge this branch with Grafana master, in order to fix a CI failure?

Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Update Singlequote and Doublequote descriptions in templating.md

aknuds1

LGTM

Stale AFAICT

aknuds1 · 2020-03-14T11:51:10Z

@torkelo @marefr This is good to merge right? Shall we add a milestone?

…tting

aknuds1 · 2020-03-24T14:57:21Z

I'm just pushing a merge with latest Grafana master to your branch, in order to fix CI. Hope you don't mind :)

aknuds1 · 2020-03-24T15:27:16Z

Thanks very much for contributing to Grafana!

xiaobeiyang requested a review from oddlittlebird as a code owner January 20, 2020 15:40

aknuds1 added area/frontend needs more info Issue needs more information, like query results, dashboard or panel json, grafana version etc labels Jan 20, 2020

marefr added the pr/external This PR is from external contributor label Jan 20, 2020

oddlittlebird suggested changes Jan 21, 2020

View reviewed changes

docs/sources/reference/templating.md Outdated Show resolved Hide resolved

docs/sources/reference/templating.md Outdated Show resolved Hide resolved

docs/sources/reference/templating.md Outdated Show resolved Hide resolved

xiaobeiyang requested a review from oddlittlebird January 22, 2020 03:30

torkelo reviewed Jan 22, 2020

View reviewed changes

docs/sources/reference/templating.md Outdated Show resolved Hide resolved

torkelo reviewed Jan 22, 2020

View reviewed changes

docs/sources/reference/templating.md Show resolved Hide resolved

xiaobeiyang requested a review from torkelo January 22, 2020 13:28

ryantxu previously requested changes Jan 22, 2020

View reviewed changes

xiaobeiyang requested a review from ryantxu January 25, 2020 07:10

xiaobeiyang commented Feb 2, 2020

View reviewed changes

torkelo reviewed Feb 2, 2020

View reviewed changes

docs/sources/reference/templating.md Outdated Show resolved Hide resolved

xiaobeiyang requested a review from torkelo February 3, 2020 01:13

torkelo approved these changes Feb 17, 2020

View reviewed changes

docs/sources/reference/templating.md Outdated Show resolved Hide resolved

docs/sources/reference/templating.md Outdated Show resolved Hide resolved

xiaobeiyang requested a review from torkelo February 17, 2020 14:36

oddlittlebird approved these changes Feb 18, 2020

View reviewed changes

xiaobeiyang commented Feb 26, 2020

View reviewed changes

aknuds1 requested changes Feb 26, 2020

View reviewed changes

xiaobeiyang requested a review from aknuds1 March 3, 2020 07:27

aknuds1 requested changes Mar 9, 2020

View reviewed changes

public/app/features/templating/template_srv.ts Outdated Show resolved Hide resolved

xiaobeiyang and others added 11 commits March 14, 2020 12:27

Support more variable formatting.

37d3e34

Remove extra trailing whitespace

bf6cd99

Update docs/sources/reference/templating.md

5155f27

Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Update docs/sources/reference/templating.md

c4acd8c

Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Update docs/sources/reference/templating.md

e284c72

Co-Authored-By: Diana Payton <52059945+oddlittlebird@users.noreply.github.com>

Update templating.md

4323dc9

escape the values

fe8ebe3

Update templating.md

c028416

Update Singlequote and Doublequote descriptions in templating.md

Update template_srv.test.ts

f760ec1

Update template_srv.ts

03d63b2

fix typo

2f75db1

xiaobeiyang requested a review from aknuds1 March 14, 2020 05:17

aknuds1 approved these changes Mar 14, 2020

View reviewed changes

aknuds1 added add to changelog and removed needs more info Issue needs more information, like query results, dashboard or panel json, grafana version etc labels Mar 14, 2020

Merge remote-tracking branch 'origin/master' into more-variable-forma…

ff65718

…tting

torkelo approved these changes Mar 24, 2020

View reviewed changes

aknuds1 merged commit 803f553 into grafana:master Mar 24, 2020

aknuds1 added this to the 7.0 milestone Mar 24, 2020

cfconrad mentioned this pull request Apr 9, 2020

Introduce Variable Formatting Options to enforce quotes on each value #20011

Closed

marefr changed the title ~~Variable: Support more variable formatting.~~ Dashboard: Support more variable format options Apr 28, 2020

marefr changed the title ~~Dashboard: Support more variable format options~~ Dashboard: Support additional variable format options (singlequote, doublequote, sqlstring) Apr 28, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dashboard: Support additional variable format options (singlequote, doublequote, sqlstring) #21622

Dashboard: Support additional variable format options (singlequote, doublequote, sqlstring) #21622

xiaobeiyang commented Jan 20, 2020 •

edited by aknuds1

Loading

aknuds1 commented Jan 20, 2020

xiaobeiyang commented Jan 20, 2020

torkelo commented Jan 21, 2020

xiaobeiyang commented Jan 21, 2020

ryantxu left a comment

xiaobeiyang commented Feb 1, 2020

xiaobeiyang left a comment

xiaobeiyang commented Feb 17, 2020

torkelo left a comment

xiaobeiyang commented Feb 17, 2020

oddlittlebird commented Feb 18, 2020

xiaobeiyang left a comment

aknuds1 left a comment

aknuds1 commented Feb 26, 2020

aknuds1 commented Feb 26, 2020

xiaobeiyang commented Mar 3, 2020

CLAassistant commented Mar 3, 2020

aknuds1 left a comment

aknuds1 commented Mar 9, 2020

aknuds1 left a comment

aknuds1 commented Mar 14, 2020

aknuds1 commented Mar 24, 2020 •

edited

Loading

aknuds1 commented Mar 24, 2020

Dashboard: Support additional variable format options (singlequote, doublequote, sqlstring) #21622

Dashboard: Support additional variable format options (singlequote, doublequote, sqlstring) #21622

Conversation

xiaobeiyang commented Jan 20, 2020 • edited by aknuds1 Loading

aknuds1 commented Jan 20, 2020

xiaobeiyang commented Jan 20, 2020

torkelo commented Jan 21, 2020

xiaobeiyang commented Jan 21, 2020

ryantxu left a comment

Choose a reason for hiding this comment

xiaobeiyang commented Feb 1, 2020

xiaobeiyang left a comment

Choose a reason for hiding this comment

xiaobeiyang commented Feb 17, 2020

torkelo left a comment

Choose a reason for hiding this comment

xiaobeiyang commented Feb 17, 2020

oddlittlebird commented Feb 18, 2020

xiaobeiyang left a comment

Choose a reason for hiding this comment

aknuds1 left a comment

Choose a reason for hiding this comment

aknuds1 commented Feb 26, 2020

aknuds1 commented Feb 26, 2020

xiaobeiyang commented Mar 3, 2020

CLAassistant commented Mar 3, 2020

aknuds1 left a comment

Choose a reason for hiding this comment

aknuds1 commented Mar 9, 2020

aknuds1 left a comment

Choose a reason for hiding this comment

aknuds1 commented Mar 14, 2020

aknuds1 commented Mar 24, 2020 • edited Loading

aknuds1 commented Mar 24, 2020

xiaobeiyang commented Jan 20, 2020 •

edited by aknuds1

Loading

aknuds1 commented Mar 24, 2020 •

edited

Loading