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.

Documentation Grafana documentation API Reference @grafana/data DataSourceApi

DataSourceApi class

The main data source abstraction interface, represents an instance of a data source

Although this is a class, datasource implementations do not *yet* need to extend it. As such, we can not yet add functions with default implementations.

Signature

typescript Copy

declare abstract class DataSourceApi<TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData, TQueryImportConfiguration extends Record<string, object> = {}> 

Import

typescript Copy

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

Constructors

Properties

Methods

constructor(instanceSettings)

Constructs a new instance of the DataSourceApi class

Signature

typescript Copy

constructor(instanceSettings: DataSourceInstanceSettings<TOptions>);

Parameters

annotations property

An annotation processor allows explicit control for how annotations are managed.

It is only necessary to configure an annotation processor if the default behavior is not desirable

Signature

typescript Copy

annotations?: AnnotationSupport<TQuery>;

components property

Set after constructor call, as the data source instance is the most common thing to pass around we attach the components to this instance for easy access

Signature

typescript Copy

components?: DataSourcePluginComponents<DataSourceApi<TQuery, TOptions>, TQuery, TOptions>;

getLogRowContext property

Retrieve context for a given log row

Signature

typescript Copy

getLogRowContext?: <TContextQueryOptions extends {}>(row: LogRowModel, options?: TContextQueryOptions) => Promise<DataQueryResponse>;

id property

Set in constructor

Signature

typescript Copy

readonly id: number;

init property

Initializes a datasource after instantiation

Signature

typescript Copy

init?: () => void;

interval property

min interval range

Signature

typescript Copy

interval?: string;

languageProvider property

Used in explore

Signature

typescript Copy

languageProvider?: any;

meta property

static information about the datasource

Signature

typescript Copy

meta: DataSourcePluginMeta;

name property

Set in constructor

Signature

typescript Copy

readonly name: string;

type property

Set in constructor

Signature

typescript Copy

readonly type: string;

uid property

Set in constructor

Signature

typescript Copy

readonly uid: string;

annotationQuery method

Can be optionally implemented to allow datasource to be a source of annotations for dashboard. This function will only be called if an angular is configured and the is undefined

Signature

typescript Copy

annotationQuery?(options: AnnotationQueryRequest<TQuery>): Promise<AnnotationEvent[]>;

Parameters

Returns:

Promise<AnnotationEvent[]>

getHighlighterExpression method

Used in explore

Signature

typescript Copy

getHighlighterExpression?(query: TQuery): string[];

Parameters

Returns:

string[]

getImportQueryConfiguration method

Returns configuration for importing queries from other data sources

Signature

typescript Copy

getImportQueryConfiguration?(): TQueryImportConfiguration;

Returns:

TQueryImportConfiguration

getQueryDisplayText method

Convert a query to a simple text string

Signature

typescript Copy

getQueryDisplayText?(query: TQuery): string;

Parameters

Returns:

string

getQueryHints method

Get hints for query improvements

Signature

typescript Copy

getQueryHints?(query: TQuery, results: any[], ...rest: any): QueryHint[];

Parameters

Returns:

QueryHint[]

getTagKeys method

Get tag keys for adhoc filters

Signature

typescript Copy

getTagKeys?(options?: any): Promise<MetricFindValue[]>;

Parameters

Returns:

Promise<MetricFindValue[]>

getTagValues method

Get tag values for adhoc filters

Signature

typescript Copy

getTagValues?(options: any): Promise<MetricFindValue[]>;

Parameters

Returns:

Promise<MetricFindValue[]>

getVersion method

Signature

typescript Copy

getVersion?(optionalOptions?: any): Promise<string>;

Parameters

Returns:

Promise<string>

importQueries method

Imports queries from a different datasource

Signature

typescript Copy

importQueries?(queries: DataQuery[], originDataSource: DataSourceApi<DataQuery>): Promise<TQuery[]>;

Parameters

Returns:

Promise<TQuery[]>

interpolateVariablesInQueries method

Signature

typescript Copy

interpolateVariablesInQueries?(queries: TQuery[], scopedVars: ScopedVars | {}): TQuery[];

Parameters

Returns:

TQuery[]

metricFindQuery method

Variable query action.

Signature

typescript Copy

metricFindQuery?(query: any, options?: any): Promise<MetricFindValue[]>;

Parameters

Returns:

Promise<MetricFindValue[]>

modifyQuery method

Used in explore

Signature

typescript Copy

modifyQuery?(query: TQuery, action: QueryFixAction): TQuery;

Parameters

Returns:

TQuery

query method

Query for data, and optionally stream results

Signature

typescript Copy

abstract query(request: DataQueryRequest<TQuery>): Promise<DataQueryResponse> | Observable<DataQueryResponse>;

Parameters

Returns:

Promise<DataQueryResponse> | Observable<DataQueryResponse>

showContextToggle method

Signature

typescript Copy

showContextToggle?(row?: LogRowModel): boolean;

Parameters

Returns:

boolean

targetContainsTemplate method

Used by alerting to check if query contains template variables

Signature

typescript Copy

targetContainsTemplate?(query: TQuery): boolean;

Parameters

Returns:

boolean

testDatasource method

Test & verify datasource settings & connection details (returning TestingStatus)

When verification fails - errors specific to the data source should be handled here and converted to a TestingStatus object. Unknown errors and HTTP errors can be re-thrown and will be handled here: public/app/features/datasources/state/actions.ts

Signature

typescript Copy

abstract testDatasource(): Promise<any>;

Returns:

Promise<any>