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.
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
export interface DataSourceSrv Import
import { DataSourceSrv } from '@grafana/runtime';Methods
| Method | Description |
|---|---|
| get(ref, scopedVars) | Returns the requested dataSource. If it cannot be found it rejects the promise. |
| getInstanceSettings(ref, scopedVars) | Get settings and plugin metadata by name or uid |
| getList(filters) | Get a list of data sources |
get method
Returns the requested dataSource. If it cannot be found it rejects the promise.
Signature
get(ref?: DataSourceRef | string | null, scopedVars?: ScopedVars): Promise<DataSourceApi>;Parameters
| Parameter | Type | Description |
|---|---|---|
| ref | DataSourceRef | string | null | The datasource identifier, typically an object with UID and type, |
| scopedVars | ScopedVars | variables used to interpolate a templated passed as name. |
Returns:
Promise<DataSourceApi>
getInstanceSettings method
Get settings and plugin metadata by name or uid
Signature
getInstanceSettings(ref?: DataSourceRef | string | null, scopedVars?: ScopedVars): DataSourceInstanceSettings | undefined;Parameters
| Parameter | Type | Description |
|---|---|---|
| ref | DataSourceRef | string | null | |
| scopedVars | ScopedVars |
Returns:
DataSourceInstanceSettings | undefined
getList method
Get a list of data sources
Signature
getList(filters?: GetDataSourceListFilters): DataSourceInstanceSettings[];Parameters
| Parameter | Type | Description |
|---|---|---|
| filters | GetDataSourceListFilters |
Returns:
DataSourceInstanceSettings[]
Was this page helpful?
Related resources from Grafana Labs
