DataSourceWithBackend

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/runtimebreadcrumb arrow DataSourceWithBackend
Enterprise Open source

DataSourceWithBackend class

Extend this class to implement a data source plugin that is depending on the Grafana backend API.

Signature

typescript 
export declare class DataSourceWithBackend<TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData> extends DataSourceApi<TQuery, TOptions>

Import

typescript 
import { DataSourceWithBackend } from '@grafana/runtime';

Constructors

ConstructorModifiersDescription
constructor(instanceSettings)Constructs a new instance of the DataSourceWithBackend class

Methods

MethodModifiersDescription
applyTemplateVariables(query, scopedVars)Override to apply template variables. The result is usually also TQuery, but sometimes this can be used to modify the query structure before sending to the backend.NOTE: if you do modify the structure or use template variables, alerting queries may not work as expected
callHealthCheck()Run the datasource healthcheck
filterQuery(query)Override to skip executing a query
getResource(path, params)Make a GET request to the datasource resource path
postResource(path, body)Send a POST request to the datasource resource path
query(request)Ideally final – any other implementation may not work as expected
testDatasource()Checks the plugin health see public/app/features/datasources/state/actions.ts for what needs to be returned here

constructor(instanceSettings)

Constructs a new instance of the DataSourceWithBackend class

Signature

typescript 
constructor(instanceSettings: DataSourceInstanceSettings<TOptions>);

Parameters

ParameterTypeDescription
instanceSettingsDataSourceInstanceSettings<TOptions>

applyTemplateVariables method

Override to apply template variables. The result is usually also TQuery, but sometimes this can be used to modify the query structure before sending to the backend.

NOTE: if you do modify the structure or use template variables, alerting queries may not work as expected

Signature

typescript 
/** @virtual */
applyTemplateVariables(query: TQuery, scopedVars: ScopedVars): Record<string, any>;

Parameters

ParameterTypeDescription
queryTQuery
scopedVarsScopedVars

Returns:

Record<string, any>

callHealthCheck method

Run the datasource healthcheck

Signature

typescript 
callHealthCheck(): Promise<HealthCheckResult>;

Returns:

Promise<HealthCheckResult>

filterQuery method

Override to skip executing a query

Signature

typescript 
/** @virtual */
filterQuery?(query: TQuery): boolean;

Parameters

ParameterTypeDescription
queryTQuery

Returns:

boolean

false if the query should be skipped

getResource method

Make a GET request to the datasource resource path

Signature

typescript 
getResource(path: string, params?: any): Promise<any>;

Parameters

ParameterTypeDescription
pathstring
paramsany

Returns:

Promise<any>

postResource method

Send a POST request to the datasource resource path

Signature

typescript 
postResource(path: string, body?: any): Promise<any>;

Parameters

ParameterTypeDescription
pathstring
bodyany

Returns:

Promise<any>

query method

Ideally final – any other implementation may not work as expected

Signature

typescript 
query(request: DataQueryRequest<TQuery>): Observable<DataQueryResponse>;

Parameters

ParameterTypeDescription
requestDataQueryRequest<TQuery>

Returns:

Observable<DataQueryResponse>

testDatasource method

Checks the plugin health see public/app/features/datasources/state/actions.ts for what needs to be returned here

Signature

typescript 
testDatasource(): Promise<any>;

Returns:

Promise<any>