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.

Documentationbreadcrumb arrow Grafana documentationbreadcrumb arrow API Referencebreadcrumb arrow @grafana/databreadcrumb arrow QueryResultMeta
Enterprise Open source

QueryResultMeta interface

Signature

typescript 
export interface QueryResultMeta

Import

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

Properties

PropertyTypeDescription
alignmentPeriodnumberLegacy data source specific, should be moved to custom
channelstringThe path for live stream updates for this frame
customRecord<string, any>DatasSource Specific Values
dataTopicDataTopicOptionally identify which topic the frame should be assigned to. A value specified in the response will override what the request asked for.
executedQueryStringstringThis is the raw query sent to the underlying system. All macros and templating as been applied. When metadata contains this value, it will be shown in the query inspector
instantboolean
jsonboolean
limitnumber
noticesQueryResultMetaNotice[]Meta Notices
pathstringA browsable path on the datasource
pathSeparatorstringdefaults to ‘/’
preferredVisualisationTypePreferredVisualisationTypeCurrently used to show results in Explore only in preferred visualisation option
searchWordsstring[]
statsQueryResultMetaStat[]Stats
transformationsstring[]Used to track transformation ids that where part of the processing

alignmentPeriod property

Legacy data source specific, should be moved to custom

Signature

typescript 
alignmentPeriod?: number;

channel property

The path for live stream updates for this frame

Signature

typescript 
channel?: string;

custom property

DatasSource Specific Values

Signature

typescript 
custom?: Record<string, any>;

dataTopic property

Optionally identify which topic the frame should be assigned to. A value specified in the response will override what the request asked for.

Signature

typescript 
dataTopic?: DataTopic;

executedQueryString property

This is the raw query sent to the underlying system. All macros and templating as been applied. When metadata contains this value, it will be shown in the query inspector

Signature

typescript 
executedQueryString?: string;

instant property

Signature

typescript 
instant?: boolean;

json property

Signature

typescript 
json?: boolean;

limit property

Signature

typescript 
limit?: number;

notices property

Meta Notices

Signature

typescript 
notices?: QueryResultMetaNotice[];

path property

A browsable path on the datasource

Signature

typescript 
path?: string;

pathSeparator property

defaults to ‘/’

Signature

typescript 
pathSeparator?: string;

preferredVisualisationType property

Currently used to show results in Explore only in preferred visualisation option

Signature

typescript 
preferredVisualisationType?: PreferredVisualisationType;

searchWords property

Signature

typescript 
searchWords?: string[];

stats property

Stats

Signature

typescript 
stats?: QueryResultMetaStat[];

transformations property

Used to track transformation ids that where part of the processing

Signature

typescript 
transformations?: string[];