QueryResultMeta interface

Signature

  1. export interface QueryResultMeta

Import

  1. 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
typeDataFrameType

alignmentPeriod property

Legacy data source specific, should be moved to custom

Signature

  1. alignmentPeriod?: number;

channel property

The path for live stream updates for this frame

Signature

  1. channel?: string;

custom property

DatasSource Specific Values

Signature

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

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

  1. executedQueryString?: string;

instant property

Signature

  1. instant?: boolean;

json property

Signature

  1. json?: boolean;

limit property

Signature

  1. limit?: number;

notices property

Meta Notices

Signature

  1. notices?: QueryResultMetaNotice[];

path property

A browsable path on the datasource

Signature

  1. path?: string;

pathSeparator property

defaults to ‘/’

Signature

  1. pathSeparator?: string;

preferredVisualisationType property

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

Signature

  1. preferredVisualisationType?: PreferredVisualisationType;

searchWords property

Signature

  1. searchWords?: string[];

stats property

Stats

Signature

  1. stats?: QueryResultMetaStat[];

transformations property

Used to track transformation ids that where part of the processing

Signature

  1. transformations?: string[];

type property

Signature

  1. type?: DataFrameType;