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.

Documentation Grafana documentation API Reference @grafana/data DataQuery

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 Copy

export interface DataQuery 

Import

typescript Copy

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

Properties

datasource property

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

Signature

typescript Copy

datasource?: string | null;

dataTopic property

The data topic resuls should be attached to

Signature

typescript Copy

dataTopic?: DataTopic;

hide property

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

Signature

typescript Copy

hide?: boolean;

key property

Unique, guid like, string used in explore mode

Signature

typescript Copy

key?: string;

queryType property

Specify the query flavor

Signature

typescript Copy

queryType?: string;

refId property

A - Z

Signature

typescript Copy

refId: string;