DataqueryBuilder🔗
Constructor🔗
Methods🔗
build🔗
Builds the object.
alias🔗
channel🔗
Used for live query
csvContent🔗
csvFileName🔗
csvWave🔗
datasource🔗
The datasource
dropPercent🔗
Drop percentage (the chance we will lose a point 0-100)
errorSource🔗
Possible enum values:
"plugin"
"downstream"
errorType🔗
Possible enum values:
"frontend_exception"
"frontend_observable"
"server_panic"
flamegraphDiff🔗
hide🔗
true if query is disabled (ie should not be returned to the dashboard)
NOTE: this does not always imply that the query should not be executed since
the results from a hidden query may be used as the input to other queries (SSE etc)
intervalMs🔗
Interval is the suggested duration between time points in a time series query.
NOTE: the values for intervalMs is not saved in the query model. It is typically calculated
from the interval required to fill a pixels in the visualization
labels🔗
levelColumn🔗
lines🔗
max🔗
maxDataPoints🔗
MaxDataPoints is the maximum number of data points that should be returned from a time series query.
NOTE: the values for maxDataPoints is not saved in the query model. It is typically calculated
from the number of pixels visible in a visualization
min🔗
nodes🔗
noise🔗
points🔗
pulseWave🔗
queryType🔗
QueryType is an optional identifier for the type of query.
It can be used to distinguish different types of queries.
rawFrameContent🔗
refId🔗
RefID is the unique identifier of the query, set by the frontend call.
resultAssertions🔗
Optionally define expected query result behavior
scenarioId🔗
Possible enum values:
"annotations"
"arrow"
"csv_content"
"csv_file"
"csv_metric_values"
"datapoints_outside_range"
"error_with_source"
"exponential_heatmap_bucket_data"
"flame_graph"
"grafana_api"
"linear_heatmap_bucket_data"
"live"
"logs"
"manual_entry"
"no_data_points"
"node_graph"
"predictable_csv_wave"
"predictable_pulse"
"random_walk"
"random_walk_table"
"random_walk_with_error"
"raw_frame"
"server_error_500"
"simulation"
"slow_query"
"streaming_client"
"table_static"
"trace"
"usa"
"variables-query"
scenarioId(scenarioId: "annotations" | "arrow" | "csv_content" | "csv_file" | "csv_metric_values" | "datapoints_outside_range" | "error_with_source" | "exponential_heatmap_bucket_data" | "flame_graph" | "grafana_api" | "linear_heatmap_bucket_data" | "live" | "logs" | "manual_entry" | "no_data_points" | "node_graph" | "predictable_csv_wave" | "predictable_pulse" | "random_walk" | "random_walk_table" | "random_walk_with_error" | "raw_frame" | "server_error_500" | "simulation" | "slow_query" | "streaming_client" | "table_static" | "trace" | "usa" | "variables-query")
seriesCount🔗
sim🔗
spanCount🔗
spread🔗
startValue🔗
stream🔗
stringInput🔗
common parameter used by many query types
timeRange🔗
TimeRange represents the query range
NOTE: unlike generic /ds/query, we can now send explicit time values in each query
NOTE: the values for timeRange are not saved in a dashboard, they are constructed on the fly