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/runtime DataSourceSrv

DataSourceSrv interface

This is the entry point for communicating with a datasource that is added as a plugin (both external and internal). Via this service you will get access to the DataSourceApi that have a rich API for communicating with the datasource.

Signature

typescript Copy

export interface DataSourceSrv 

Import

typescript Copy

import { DataSourceSrv } from '@grafana/runtime';

Methods

get method

Returns the requested dataSource. If it cannot be found it rejects the promise.

Signature

typescript Copy

get(ref?: DataSourceRef | string | null, scopedVars?: ScopedVars): Promise<DataSourceApi>;

Parameters

Returns:

Promise<DataSourceApi>

getInstanceSettings method

Get settings and plugin metadata by name or uid

Signature

typescript Copy

getInstanceSettings(ref?: DataSourceRef | string | null, scopedVars?: ScopedVars): DataSourceInstanceSettings | undefined;

Parameters

Returns:

DataSourceInstanceSettings | undefined

getList method

Get a list of data sources

Signature

typescript Copy

getList(filters?: GetDataSourceListFilters): DataSourceInstanceSettings[];

Parameters

Returns:

DataSourceInstanceSettings[]

reload method

Reloads the DataSourceSrv

Signature

typescript Copy

reload(): void;

Returns:

void