add macros for referencing time window

Author: Scott Lepper

README.md

@@ -31,6 +31,18 @@ From the dashboard, add a panel and select SQL Proxy from the Query dropdown.  Y
 
 Enter your SQL and click away to run the SQL command and get results into the panel.
 
+## Time macros
+
+To reference the dashboard time frame, you can supply macros (variables) within your sql:
+
+* $__timeFrom - the start time in milliseconds
+* $__timeTo - the end time in milliseconds
+* $__timeFrom(format) - the start time converted to a date string with the supplied format
+* $__timeTo(format) - the end time converted to a date string with the supplied format
+
+"format" example: 
+* SELECT NAME FROM FOO where "TIME" > '$__timeFrom(yyyy-MM-dd hh:mm:ss)' and "TIME" < '$__timeTo(yyyy-MM-dd)'
+
 ## How to contribute
 
 This plugin is using Typescript.  

package.json

@@ -19,10 +19,10 @@
     "@types/react": "16.8.16 ",
     "@types/request-promise-native": "^1.0.17"
   },
-  "screenshots": [
-  ],
+  "screenshots": [],
   "dependencies": {
     "codemirror": "^5.51.0",
+    "date-fns": "^2.16.1",
     "react-codemirror2": "^6.0.0"
   }
 }

src/SqlProxyDatasource.ts

@@ -12,6 +12,7 @@ import {
 
 import { SqlQuery } from './types';
 import { getBackendSrv } from '@grafana/runtime';
+import { format } from 'date-fns';
 
 export class DataSource extends DataSourceApi<SqlQuery, DataSourceJsonData> {
   /** @ngInject */
@@ -70,13 +71,49 @@ export class DataSource extends DataSourceApi<SqlQuery, DataSourceJsonData> {
       targets: visibleTargets.map(target => {
         const query: SqlQuery = {
           ...target,
-          sql: this.templateSrv.replace(target.sql),
+          sql: this.applyMacros(this.templateSrv.replace(target.sql), options),
         };
         return query;
       }),
     };
   }
 
+  applyMacros(sql: string, options: DataQueryRequest<SqlQuery>) {
+    if (sql.includes('$__timeFrom(')) {
+      sql = this.applyMacroFunction('$__timeFrom(', sql, options);
+    }
+    if (sql.includes('$__timeTo(')) {
+      sql = this.applyMacroFunction('$__timeTo(', sql, options);
+    }
+    if (sql.includes('$__timeFrom')) {
+      sql = sql.replace(/\$__timeFrom/g, options.startTime.toString());
+    }
+    if (sql.includes('$__timeTo')) {
+      sql = sql.replace(/\$__timeTo/g, options.endTime?.toString() ?? '');
+    }
+    return sql;
+  }
+
+  applyMacroFunction(macro: string, sql: string, options: DataQueryRequest<SqlQuery>) {
+    if (sql.includes(macro)) {
+      let time;
+      if (macro === '$__timeFrom(') {
+        time = new Date(options.startTime);
+      } else {
+        time = new Date(options.endTime!);
+      }
+
+      const start = sql.indexOf(macro) + macro.length;
+      const end = sql.indexOf(')', start);
+      const fmt = sql.substring(start, end);
+      const dateStr = format(time, fmt);
+      const toReplace = sql.substring(start - macro.length, end + 1);
+      sql = sql.replace(toReplace, dateStr);
+      return this.applyMacroFunction(macro, sql, options);
+    }
+    return sql;
+  }
+
   metricFindQuery(query: any) {
     console.log('query', query);
     return Promise.resolve([]);

yarn.lock

@@ -4253,6 +4253,11 @@ date-fns@^1.23.0:
   resolved "https://registry.yarnpkg.com/date-fns/-/date-fns-1.30.1.tgz#2e71bf0b119153dbb4cc4e88d9ea5acfb50dc05c"
   integrity sha512-hBSVCvSmWC+QypYObzwGOd9wqdDpOt+0wl0KbU+R+uuZBS1jN8VsD1ss3irQDknRj5NvxiTF6oj/nDRnN/UQNw==
 
+date-fns@^2.16.1:
+  version "2.16.1"
+  resolved "https://registry.yarnpkg.com/date-fns/-/date-fns-2.16.1.tgz#05775792c3f3331da812af253e1a935851d3834b"
+  integrity sha512-sAJVKx/FqrLYHAQeN7VpJrPhagZc9R4ImZIWYRFZaaohR3KzmuK88touwsSwSVT8Qcbd4zoDsnGfX4GFB4imyQ==
+
 debug@=3.1.0:
   version "3.1.0"
   resolved "https://registry.yarnpkg.com/debug/-/debug-3.1.0.tgz#5bb5a0672628b64149566ba16819e61518c67261"