grafana/docs/sources/developers/kinds/composable/testdatadataquery/schema-reference.md

keywords	title
grafana schema	TestDataDataQuery kind

Both documentation generation and kinds schemas are in active development and subject to change without prior notice.

TestDataDataQuery

Maturity: experimental

Version: 0.0

It extends DataQuery.

Property	Type	Required	Default	Description
refId	string	Yes		(Inherited from DataQuery) A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. By default, the UI will assign A->Z; however setting meaningful names may be useful.
alias	string	No
channel	string	No
csvContent	string	No
csvFileName	string	No
csvWave	CSVWave[]	No
datasource		No		(Inherited from DataQuery) For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. TODO find a better way to do this ^ that's friendly to schema TODO this shouldn't be unknown but DataSourceRef | null
errorType	string	No		Possible values are: server_panic, frontend_exception, frontend_observable.
hide	boolean	No		(Inherited from DataQuery) 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)
labels	string	No
levelColumn	boolean	No
lines	integer	No
nodes	NodesQuery	No
points	array[]	No
pulseWave	PulseWaveQuery	No
queryType	string	No		(Inherited from DataQuery) Specify the query flavor TODO make this required and give it a default
rawFrameContent	string	No
scenarioId	string	No		Possible values are: random_walk, slow_query, random_walk_with_error, random_walk_table, exponential_heatmap_bucket_data, linear_heatmap_bucket_data, no_data_points, datapoints_outside_range, csv_metric_values, predictable_pulse, predictable_csv_wave, streaming_client, simulation, usa, live, grafana_api, arrow, annotations, table_static, server_error_500, logs, node_graph, flame_graph, raw_frame, csv_file, csv_content, trace, manual_entry, variables-query.
seriesCount	integer	No
sim	SimulationQuery	No
spanCount	integer	No
stream	StreamingQuery	No
stringInput	string	No
usa	USAQuery	No

CSVWave

Property	Type	Required	Default	Description
labels	string	No
name	string	No
timeStep	integer	No
valuesCSV	string	No

DataQuery

These are the common properties available to all queries in all datasources. Specific implementations will extend this interface, adding the required properties for the given context.

Property	Type	Required	Default	Description
refId	string	Yes		A unique identifier for the query within the list of targets. In server side expressions, the refId is used as a variable name to identify results. By default, the UI will assign A->Z; however setting meaningful names may be useful.
datasource		No		For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. TODO find a better way to do this ^ that's friendly to schema TODO this shouldn't be unknown but DataSourceRef | null
hide	boolean	No		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)
queryType	string	No		Specify the query flavor TODO make this required and give it a default

NodesQuery

Property	Type	Required	Default	Description
count	integer	No
type	string	No		Possible values are: random, response, random edges.

PulseWaveQuery

Property	Type	Required	Default	Description
offCount	integer	No
offValue	number	No
onCount	integer	No
onValue	number	No
timeStep	integer	No

SimulationQuery

Property	Type	Required	Default	Description
key	object	Yes
config	object	No
last	boolean	No
stream	boolean	No

Config

Property	Type	Required	Default	Description

Key

Property	Type	Required	Default	Description
tick	number	Yes
type	string	Yes
uid	string	No

StreamingQuery

Property	Type	Required	Default	Description
noise	integer	Yes
speed	integer	Yes
spread	integer	Yes
type	string	Yes		Possible values are: signal, logs, fetch.
bands	integer	No
url	string	No

USAQuery

Property	Type	Required	Default	Description
fields	string[]	No
mode	string	No
period	string	No
states	string[]	No