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

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

Import

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

Constructors

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

Properties

PropertyModifiersTypeDescription
annotationsAnnotationSupport<TQuery>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
componentsDataSourcePluginComponents<DataSourceApi<TQuery, TOptions>, TQuery, TOptions>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
getLogRowContext<TContextQueryOptions extends {}>(row: LogRowModel, options?: TContextQueryOptions) => Promise<DataQueryResponse>Retrieve context for a given log row
idnumberSet in constructor
init() => voidInitializes a datasource after instantiation
intervalstringmin interval range
languageProvideranyUsed in explore
metaDataSourcePluginMetastatic information about the datasource
namestringSet in constructor
typestringSet in constructor
uidstringSet in constructor

Methods

MethodModifiersDescription
annotationQuery(options)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
getHighlighterExpression(query)Used in explore
getImportQueryConfiguration()Returns configuration for importing queries from other data sources
getQueryDisplayText(query)Convert a query to a simple text string
getQueryHints(query, results, rest)Get hints for query improvements
getTagKeys(options)Get tag keys for adhoc filters
getTagValues(options)Get tag values for adhoc filters
getVersion(optionalOptions)
importQueries(queries, originDataSource)Imports queries from a different datasource
interpolateVariablesInQueries(queries, scopedVars)
metricFindQuery(query, options)Variable query action.
modifyQuery(query, action)Used in explore
query(request)Query for data, and optionally stream results
showContextToggle(row)
targetContainsTemplate(query)Used by alerting to check if query contains template variables
testDatasource()Test & verify datasource settings & connection details

constructor(instanceSettings)

Constructs a new instance of the DataSourceApi class

Signature

  1. constructor(instanceSettings: DataSourceInstanceSettings<TOptions>);

Parameters

ParameterTypeDescription
instanceSettingsDataSourceInstanceSettings<TOptions>

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

  1. 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

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

getLogRowContext property

Retrieve context for a given log row

Signature

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

id property

Set in constructor

Signature

  1. readonly id: number;

init property

Initializes a datasource after instantiation

Signature

  1. init?: () => void;

interval property

min interval range

Signature

  1. interval?: string;

languageProvider property

Used in explore

Signature

  1. languageProvider?: any;

meta property

static information about the datasource

Signature

  1. meta: DataSourcePluginMeta;

name property

Set in constructor

Signature

  1. readonly name: string;

type property

Set in constructor

Signature

  1. readonly type: string;

uid property

Set in constructor

Signature

  1. 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

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

Parameters

ParameterTypeDescription
optionsAnnotationQueryRequest<TQuery>

Returns:

Promise<AnnotationEvent[]>

getHighlighterExpression method

Used in explore

Signature

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

Parameters

ParameterTypeDescription
queryTQuery

Returns:

string[]

getImportQueryConfiguration method

Returns configuration for importing queries from other data sources

Signature

  1. getImportQueryConfiguration?(): TQueryImportConfiguration;

Returns:

TQueryImportConfiguration

getQueryDisplayText method

Convert a query to a simple text string

Signature

  1. getQueryDisplayText?(query: TQuery): string;

Parameters

ParameterTypeDescription
queryTQuery

Returns:

string

getQueryHints method

Get hints for query improvements

Signature

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

Parameters

ParameterTypeDescription
queryTQuery
resultsany[]
restany

Returns:

QueryHint[]

getTagKeys method

Get tag keys for adhoc filters

Signature

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

Parameters

ParameterTypeDescription
optionsany

Returns:

Promise<MetricFindValue[]>

getTagValues method

Get tag values for adhoc filters

Signature

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

Parameters

ParameterTypeDescription
optionsany

Returns:

Promise<MetricFindValue[]>

getVersion method

Signature

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

Parameters

ParameterTypeDescription
optionalOptionsany

Returns:

Promise<string>

importQueries method

Imports queries from a different datasource

Signature

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

Parameters

ParameterTypeDescription
queriesDataQuery[]
originDataSourceDataSourceApi

Returns:

Promise<TQuery[]>

interpolateVariablesInQueries method

Signature

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

Parameters

ParameterTypeDescription
queriesTQuery[]
scopedVarsScopedVars | {}

Returns:

TQuery[]

metricFindQuery method

Variable query action.

Signature

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

Parameters

ParameterTypeDescription
queryany
optionsany

Returns:

Promise<MetricFindValue[]>

modifyQuery method

Used in explore

Signature

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

Parameters

ParameterTypeDescription
queryTQuery
actionQueryFixAction

Returns:

TQuery

query method

Query for data, and optionally stream results

Signature

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

Parameters

ParameterTypeDescription
requestDataQueryRequest<TQuery>

Returns:

Promise<DataQueryResponse> | Observable<DataQueryResponse>

showContextToggle method

Signature

  1. showContextToggle?(row?: LogRowModel): boolean;

Parameters

ParameterTypeDescription
rowLogRowModel

Returns:

boolean

targetContainsTemplate method

Used by alerting to check if query contains template variables

Signature

  1. targetContainsTemplate?(query: TQuery): boolean;

Parameters

ParameterTypeDescription
queryTQuery

Returns:

boolean

testDatasource method

Test & verify datasource settings & connection details

Signature

  1. abstract testDatasource(): Promise<any>;

Returns:

Promise<any>