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

DataQueryResponse interface

Signature

typescript
export interface DataQueryResponse 

Import

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

Properties

PropertyTypeDescription
dataDataQueryResponseData[]The response data. When streaming, this may be empty or a partial result set
errorDataQueryErrorOptionally include error info along with the response data
keystringWhen returning multiple partial responses or streams Use this key to inform Grafana how to combine the partial responses Multiple responses with same key are replaced (latest used)
stateLoadingStateUse this to control which state the response should have Defaults to LoadingState.Done if state is not defined

data property

The response data. When streaming, this may be empty or a partial result set

Signature

typescript
data: DataQueryResponseData[];

error property

Optionally include error info along with the response data

Signature

typescript
error?: DataQueryError;

key property

When returning multiple partial responses or streams Use this key to inform Grafana how to combine the partial responses Multiple responses with same key are replaced (latest used)

Signature

typescript
key?: string;

state property

Use this to control which state the response should have Defaults to LoadingState.Done if state is not defined

Signature

typescript
state?: LoadingState;