grafana/docs/sources/packages_api/data/queryresultmeta.md

3.3 KiB

+++

-----------------------------------------------------------------------

Do not edit this file. It is automatically generated by API Documenter.

-----------------------------------------------------------------------

title = "QueryResultMeta" keywords = ["grafana","documentation","sdk","@grafana/data"] type = "docs" +++

QueryResultMeta interface

Signature

export interface QueryResultMeta 

Import

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

Properties

Property Type Description
alignmentPeriod string
custom Record<string, any> DatasSource Specific Values
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
gmdMeta any[] Legacy data source specific, should be moved to custom
json boolean
limit number
notices QueryResultMetaNotice[] Meta Notices
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

Signature

alignmentPeriod?: string;

custom property

DatasSource Specific Values

Signature

custom?: Record<string, any>;

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;

gmdMeta property

Legacy data source specific, should be moved to custom

Signature

gmdMeta?: any[];

json property

Signature

json?: boolean;

limit property

Signature

limit?: number;

notices property

Meta Notices

Signature

notices?: QueryResultMetaNotice[];

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[];