Menu

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.

Enterprise Open source

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

typescript
export interface DataQuery 

Import

typescript
import { DataQuery } from '@grafana/data';

Properties

PropertyTypeDescription
datasourcestring | nullFor mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined.
dataTopicDataTopicThe data topic results should be attached to
hidebooleantrue if query is disabled (ie should not be returned to the dashboard)
keystringUnique, guid like, string used in explore mode
queryTypestringSpecify the query flavor
refIdstringA - Z

datasource property

For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined.

Signature

typescript
datasource?: string | null;

dataTopic property

The data topic results should be attached to

Signature

typescript
dataTopic?: DataTopic;

hide property

true if query is disabled (ie should not be returned to the dashboard)

Signature

typescript
hide?: boolean;

key property

Unique, guid like, string used in explore mode

Signature

typescript
key?: string;

queryType property

Specify the query flavor

Signature

typescript
queryType?: string;

refId property

A - Z

Signature

typescript
refId: string;