mirror of
https://github.com/grafana/grafana.git
synced 2025-07-29 06:32:21 +08:00
205 lines
8.8 KiB
Markdown
205 lines
8.8 KiB
Markdown
+++
|
|
# -----------------------------------------------------------------------
|
|
# Do not edit this file. It is automatically generated by API Documenter.
|
|
# -----------------------------------------------------------------------
|
|
title = "DataSourceWithBackend"
|
|
keywords = ["grafana","documentation","sdk","@grafana/runtime"]
|
|
type = "docs"
|
|
+++
|
|
|
|
## DataSourceWithBackend class
|
|
|
|
Extend this class to implement a data source plugin that is depending on the Grafana backend API.
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
export declare class DataSourceWithBackend<TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData> extends DataSourceApi<TQuery, TOptions>
|
|
```
|
|
<b>Import</b>
|
|
|
|
```typescript
|
|
import { DataSourceWithBackend } from '@grafana/runtime';
|
|
```
|
|
<b>Constructors</b>
|
|
|
|
| Constructor | Modifiers | Description |
|
|
| -------------------------------------------------------------- | --------- | ------------------------------------------------------------------------- |
|
|
| [constructor(instanceSettings)](#constructor-instancesettings) | | Constructs a new instance of the <code>DataSourceWithBackend</code> class |
|
|
|
|
<b>Methods</b>
|
|
|
|
| Method | Modifiers | Description |
|
|
| --------------------------------------------------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| [applyTemplateVariables(query, scopedVars)](#applytemplatevariables-method) | | Override to apply template variables. The result is usually also <code>TQuery</code>, but sometimes this can be used to modify the query structure before sending to the backend.<!-- -->NOTE: if you do modify the structure or use template variables, alerting queries may not work as expected |
|
|
| [callHealthCheck()](#callhealthcheck-method) | | Run the datasource healthcheck |
|
|
| [filterQuery(query)](#filterquery-method) | | Override to skip executing a query |
|
|
| [getResource(path, params)](#getresource-method) | | Make a GET request to the datasource resource path |
|
|
| [postResource(path, body)](#postresource-method) | | Send a POST request to the datasource resource path |
|
|
| [processResponse(res)](#processresponse-method) | | Optionally augment the response before returning the results to the |
|
|
| [query(request)](#query-method) | | Ideally final -- any other implementation may not work as expected |
|
|
| [testDatasource()](#testdatasource-method) | | Checks the plugin health |
|
|
|
|
### constructor(instanceSettings)
|
|
|
|
Constructs a new instance of the `DataSourceWithBackend` class
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
constructor(instanceSettings: DataSourceInstanceSettings<TOptions>);
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| ---------------- | ------------------------------------------------------- | ----------- |
|
|
| instanceSettings | <code>DataSourceInstanceSettings<TOptions></code> | |
|
|
|
|
### applyTemplateVariables method
|
|
|
|
Override to apply template variables. The result is usually also `TQuery`<!-- -->, but sometimes this can be used to modify the query structure before sending to the backend.
|
|
|
|
> **Note:** if you do modify the structure or use template variables, alerting queries may not work as expected
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
/** @virtual */
|
|
applyTemplateVariables(query: TQuery, scopedVars: ScopedVars): Record<string, any>;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| ---------- | ----------------------- | ----------- |
|
|
| query | <code>TQuery</code> | |
|
|
| scopedVars | <code>ScopedVars</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`Record<string, any>`
|
|
|
|
### callHealthCheck method
|
|
|
|
Run the datasource healthcheck
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
callHealthCheck(): Promise<HealthCheckResult>;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`Promise<HealthCheckResult>`
|
|
|
|
### filterQuery method
|
|
|
|
Override to skip executing a query
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
/** @virtual */
|
|
filterQuery?(query: TQuery): boolean;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ------------------- | ----------- |
|
|
| query | <code>TQuery</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`boolean`
|
|
|
|
### getResource method
|
|
|
|
Make a GET request to the datasource resource path
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
getResource(path: string, params?: any): Promise<any>;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ------------------- | ----------- |
|
|
| path | <code>string</code> | |
|
|
| params | <code>any</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`Promise<any>`
|
|
|
|
### postResource method
|
|
|
|
Send a POST request to the datasource resource path
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
postResource(path: string, body?: any): Promise<any>;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ------------------- | ----------- |
|
|
| path | <code>string</code> | |
|
|
| body | <code>any</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`Promise<any>`
|
|
|
|
### processResponse method
|
|
|
|
Optionally augment the response before returning the results to the
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
processResponse?(res: DataQueryResponse): Promise<DataQueryResponse>;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ------------------------------ | ----------- |
|
|
| res | <code>DataQueryResponse</code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`Promise<DataQueryResponse>`
|
|
|
|
### query method
|
|
|
|
Ideally final -- any other implementation may not work as expected
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
query(request: DataQueryRequest<TQuery>): Observable<DataQueryResponse>;
|
|
```
|
|
<b>Parameters</b>
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ------------------------------------------- | ----------- |
|
|
| request | <code>DataQueryRequest<TQuery></code> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
`Observable<DataQueryResponse>`
|
|
|
|
### testDatasource method
|
|
|
|
Checks the plugin health
|
|
|
|
<b>Signature</b>
|
|
|
|
```typescript
|
|
testDatasource(): Promise<any>;
|
|
```
|
|
<b>Returns:</b>
|
|
|
|
`Promise<any>`
|
|
|