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

  1. export interface DataQuery

Import

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

Properties

PropertyTypeDescription
datasourceDataSourceRef | nullFor mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined.
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

  1. datasource?: DataSourceRef | null;

hide property

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

  1. hide?: boolean;

key property

Unique, guid like, string used in explore mode

Signature

  1. key?: string;

queryType property

Specify the query flavor

Signature

  1. queryType?: string;

refId property

A - Z

Signature

  1. refId: string;