2.1.0-beta.2,update readme

Author: jovezhong

CHANGELOG.md

@@ -4,7 +4,8 @@
 
 Key changes:
 
-* Able to define dashboard variables with this data source
+* Able to define dashboard variables with this data source. Please make sure turning off the streaming query mode in the SQL to populate the variable values, and only return 1 or 2 columns. You can also refer to `__from` and `__to` variables in the SQL to get the time range of the dashboard.
+* Able to define annotations with this data source
 * Use default values for HTTP/TCP ports and username if they are not set in the data source configuration
 
 ## 2.0.0

Makefile

@@ -1,5 +1,5 @@
 ID = timeplus-proton-datasource
-Version = 2.1.0-beta.1
+Version = 2.1.0-beta.2
 
 init:
 	npm install

README.md

@@ -7,7 +7,7 @@ As the core engine of [Timeplus Enterprise](https://timeplus.com), [Proton](http
 
 ## Requirements
 
-Grafana v10.0.3 or above
+Grafana v11.3 or above (older versions may work but not verified)
 
 A running Timeplus Proton or Timeplus Enterprise instance with TCP port 8463 (for database connection) and HTTP port 3218 (for query analazyer REST API).
 
@@ -24,14 +24,19 @@ A data source for Timeplus is created automatically.
 
 In the navigation menu, choose Connections -> Add new connection.
 
-Search for Timeplus and accept the default settings (localhost,port 8463 and 3218 as proton connection). This plugin is expected to run in localhost or trusted network. Username and password for Timeplus will be added later. This tool supports self-hosted Timeplus Enterprise, but not for Timeplus Cloud.
+Search for Timeplus and accept the default settings (localhost,port 8463 and 3218 as proton connection). This tool supports self-hosted Timeplus Enterprise, but not for Timeplus Cloud.
 
 Create a new dashboard or explore data with this Timeplus data source.
 
-There are unbounded streaming query and bounded historical query in proton, all queries like `select count(*) from stream_name` are streaming queries, and adding `table` function to the stream name will turn the query into bounded query, e.g. `select count(*) from table(stream_name)`.
+There are unbounded streaming query and bounded historical query in Timeplus, all queries like `select count(*) from stream_name` are streaming queries, and adding `table` function to the stream name will turn the query into bounded query, e.g. `select count(*) from table(stream_name)`.
 
 ![query editor](src/img/query.png)
 
+### Query Variables
+You can define dashboard variables with this data source. Please make sure turning off the streaming query mode in the SQL to populate the variable values, and only return 1 or 2 columns. When there is 1 column returned, it will be set as both value and label. If there are 2 columns, the first column will be set as value and the second column as the label.  You can also refer to `__from` and `__to` variables in the SQL to get the time range of the dashboard, e.g.:
+```sql
+SELECT distinct product_id FROM table(coinbase)  where _tp_time < to_datetime($__to/1000) and _tp_time > to_datetime($__from/1000)
+```
 
 ## Development
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "timeplus-proton-datasource",
-  "version": "2.1.0-beta.1",
+  "version": "2.1.0-beta.2",
   "description": "Grafana data source plugin to connect to Timeplus and visualize streaming or batch queries.",
   "scripts": {
     "build": "webpack -c ./.config/webpack/webpack.config.ts --env production",

src/plugin.json

@@ -24,8 +24,8 @@
       { "name": "Query Editor", "path": "img/query.png" },
       { "name": "Dashboard", "path": "img/dashboard.png" }
     ],
-    "version": "2.1.0-beta.1",
-    "updated": "2024-11-05"
+    "version": "2.1.0-beta.2",
+    "updated": "2025-01-09"
   },
   "dependencies": {
     "grafanaDependency": ">=10.4.0",