Struct grafana_plugin_sdk::backend::DataQuery

#[non_exhaustive]
pub struct DataQuery<Q>
where
    Q: DeserializeOwned,
{
    pub ref_id: String,
    pub query_type: String,
    pub max_data_points: i64,
    pub interval: Duration,
    pub time_range: TimeRange,
    pub query: Q,
}

A query made by Grafana to the plugin as part of a QueryDataRequest.

The query field contains any fields set by the plugin’s UI.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

ref_id: String

The unique identifier of the query, set by the frontend call.

This should be included in the corresponding DataResponse.

query_type: String

An identifier for the type of query.

This can be used to distinguish different types of queries.

max_data_points: i64

The maximum number of datapoints that should be returned from a time series query.

interval: Duration

The suggested duration between time points in a time series query.

time_range: TimeRange

The start and end of the query requested by the frontend.

query: Q

The inner query.

This contains all of the other properties, as well as custom properties.

Trait Implementations

impl<Q> Debug for DataQuery<Q>

where Q: DeserializeOwned + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Q> TryFrom<DataQuery> for DataQuery<Q>

where Q: DeserializeOwned,

type Error = ConvertFromError

The type returned in the event of a conversion error.

fn try_from(other: DataQuery) -> Result<Self, Self::Error>

Performs the conversion.