grafana/docs/sources/packages_api/data/dataquery.md

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "DataQuery" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" draft = true +++

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.
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;

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;