mirror of
https://github.com/grafana/grafana.git
synced 2025-07-29 20:52:21 +08:00
cc3fc18076
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
83 lines
2.0 KiB
Markdown
83 lines
2.0 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "DataQuery"
|
|
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
|
type = "docs"
|
|
+++
|
|
|
|
## 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
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export interface DataQuery
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { DataQuery } from '@grafana/data';
|
|
```
|
|
<b>Properties</b>
|
|
|
|
| Property | Type | Description |
|
|
| --- | --- | --- |
|
|
| [datasource](#datasource-property) | <code>string | null</code> | For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined. |
|
|
| [hide](#hide-property) | <code>boolean</code> | true if query is disabled (ie should not be returned to the dashboard) |
|
|
| [key](#key-property) | <code>string</code> | Unique, guid like, string used in explore mode |
|
|
| [queryType](#querytype-property) | <code>string</code> | Specify the query flavor |
|
|
| [refId](#refid-property) | <code>string</code> | A - Z |
|
|
|
|
### datasource property
|
|
|
|
For mixed data sources the selected datasource is on the query level. For non mixed scenarios this is undefined.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
datasource?: string | null;
|
|
```
|
|
|
|
### hide property
|
|
|
|
true if query is disabled (ie should not be returned to the dashboard)
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
hide?: boolean;
|
|
```
|
|
|
|
### key property
|
|
|
|
Unique, guid like, string used in explore mode
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
key?: string;
|
|
```
|
|
|
|
### queryType property
|
|
|
|
Specify the query flavor
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
queryType?: string;
|
|
```
|
|
|
|
### refId property
|
|
|
|
A - Z
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
refId: string;
|
|
```
|