API Reference@grafana/dataQueryResultMeta

QueryResultMeta interface

Signature

export interface QueryResultMeta 

Import

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

Properties

Property Type Description
alignmentPeriod number Legacy data source specific, should be moved to custom
channel string The path for live stream updates for this frame
custom Record<string, any> DatasSource Specific Values
dataTopic DataTopic Optionally identify which topic the frame should be assigned to. A value specified in the response will override what the request asked for.
executedQueryString string 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
instant boolean
json boolean
limit number
notices QueryResultMetaNotice[] Meta Notices
path string A browsable path on the datasource
pathSeparator string defaults to ‘/’
preferredVisualisationType PreferredVisualisationType Currently used to show results in Explore only in preferred visualisation option
searchWords string[]
stats QueryResultMetaStat[] Stats
transformations string[] Used to track transformation ids that where part of the processing

alignmentPeriod property

Legacy data source specific, should be moved to custom

Signature

alignmentPeriod?: number;

channel property

The path for live stream updates for this frame

Signature

channel?: string;

custom property

DatasSource Specific Values

Signature

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

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

executedQueryString?: string;

instant property

Signature

instant?: boolean;

json property

Signature

json?: boolean;

limit property

Signature

limit?: number;

notices property

Meta Notices

Signature

notices?: QueryResultMetaNotice[];

path property

A browsable path on the datasource

Signature

path?: string;

pathSeparator property

defaults to ‘/’

Signature

pathSeparator?: string;

preferredVisualisationType property

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

Signature

preferredVisualisationType?: PreferredVisualisationType;

searchWords property

Signature

searchWords?: string[];

stats property

Stats

Signature

stats?: QueryResultMetaStat[];

transformations property

Used to track transformation ids that where part of the processing

Signature

transformations?: string[];