Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.
DataQuery interface
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
Signature
export interface DataQuery
Import
import { DataQuery } from '@grafana/data';
Properties
Property | Type | Description |
---|---|---|
datasource | string | null | For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. |
dataTopic | DataTopic | The data topic results should be attached to |
hide | boolean | true if query is disabled (ie should not be returned to the dashboard) |
key | string | Unique, guid like, string used in explore mode |
queryType | string | Specify the query flavor |
refId | string | A - Z |
datasource property
For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined.
Signature
datasource?: string | null;
dataTopic property
The data topic results should be attached to
Signature
dataTopic?: DataTopic;
hide property
true if query is disabled (ie should not be returned to the dashboard)
Signature
hide?: boolean;
key property
Unique, guid like, string used in explore mode
Signature
key?: string;
queryType property
Specify the query flavor
Signature
queryType?: string;
refId property
A - Z
Signature
refId: string;