mirror of
https://github.com/grafana/grafana.git
synced 2024-11-30 20:54:22 -06:00
cc3fc18076
* added packages reference menu item. * removed the draft flag. * Updated docs by running script.
1.8 KiB
1.8 KiB
+++
-----------------------------------------------------------------------
Do not edit this file. It is automatically generated by API Documenter.
-----------------------------------------------------------------------
title = "DataSourceSrv" keywords = ["grafana","documentation","sdk","@grafana/runtime"] type = "docs" +++
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(name, scopedVars) | |
| getDataSourceSettingsByUid(uid) | Returns metadata based on UID. |
get method
Signature
get(name?: string, scopedVars?: ScopedVars): Promise<DataSourceApi>;
Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string |
name of the datasource plugin you want to use. |
| scopedVars | ScopedVars |
variables used to interpolate a templated passed as name. |
Returns:
Promise<DataSourceApi>
getDataSourceSettingsByUid method
Returns metadata based on UID.
Signature
getDataSourceSettingsByUid(uid: string): DataSourceInstanceSettings | undefined;
Parameters
| Parameter | Type | Description |
|---|---|---|
| uid | string |
Returns:
DataSourceInstanceSettings | undefined