Docs: adding first version of the auto-generated packages API docs. (#22107)
* trying out api-extractor. * works with our setup of build. * wip. * changed the packages so it works better with the api-extractor. * Changes to make the api-extractor to work. * cleaned up the api-extractor config files. * added some more documentation. * added tsdoc-metadata to gitignore. * removed the generated docs (will do that in another PR). * added execute permission to script for generating dosc. * added so we will push generated docs to branch. * will clean packages_api on abort. * Fixed failing tests. * fixed formatting issue with typedoc comment. * temporarily disabled tslint rules about namespace until https://github.com/microsoft/rushstack/issues/1029 is resolved * temporary enabled bable namespaces. * updated build script. * updated script. * updated script with some colors. * changed to camelCase. * removed spacing. * Starting to add documentation guidelines. * added examples headline. * added menu options. * added parameters and return values. * Fixed merge error. * Added first version of auto-generated docs. * changed so we use the eslint ignore syntax. * changed to correct eslint ingnore comment. * fixed some spelling errors reported by codespell. * added script to generate docs in current folder. * updated api docs. * lerna bootstrap. * added eror to the ingore words list. * removed file that should be ignored. * updated locKFILE. * referenced the code comments guidelines. * updated packages. * updated deps. * updated the autogenerated dosc. * adding missing new line.
This commit is contained in:
Marcus Andersson
GitHub
@@ -0,0 +1,421 @@
|
||||
+++
|
||||
# -----------------------------------------------------------------------
|
||||
# Do not edit this file. It is automatically generated by API Documenter.
|
||||
# -----------------------------------------------------------------------
|
||||
title = "DataSourceApi"
|
||||
keywords = ["grafana","documentation","sdk","@grafana/data"]
|
||||
type = "docs"
|
||||
draft = true
|
||||
+++
|
||||
|
||||
## 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.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
export declare abstract class DataSourceApi<TQuery extends DataQuery = DataQuery, TOptions extends DataSourceJsonData = DataSourceJsonData>
|
||||
```
|
||||
<b>Import</b>
|
||||
|
||||
```typescript
|
||||
import { DataSourceApi } from '@grafana/data';
|
||||
```
|
||||
<b>Constructors</b>
|
||||
|
||||
| Constructor | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [constructor(instanceSettings)](#constructor-instancesettings) | | Constructs a new instance of the <code>DataSourceApi</code> class |
|
||||
|
||||
<b>Properties</b>
|
||||
|
||||
| Property | Modifiers | Type | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| [components](#components-property) | | <code>DataSourcePluginComponents<DataSourceApi<TQuery, TOptions>, TQuery, TOptions></code> | 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](#getlogrowcontext-property) | | <code><TContextQueryOptions extends {}>(row: LogRowModel, options?: TContextQueryOptions) => Promise<DataQueryResponse></code> | Retrieve context for a given log row |
|
||||
| [id](#id-property) | | <code>number</code> | Set in constructor |
|
||||
| [init](#init-property) | | <code>() => void</code> | Initializes a datasource after instantiation |
|
||||
| [interval](#interval-property) | | <code>string</code> | min interval range |
|
||||
| [languageProvider](#languageprovider-property) | | <code>any</code> | Used in explore |
|
||||
| [meta](#meta-property) | | <code>DataSourcePluginMeta</code> | static information about the datasource |
|
||||
| [name](#name-property) | | <code>string</code> | Set in constructor |
|
||||
|
||||
<b>Methods</b>
|
||||
|
||||
| Method | Modifiers | Description |
|
||||
| --- | --- | --- |
|
||||
| [annotationQuery(options)](#annotationquery-method) | | Can be optionally implemented to allow datasource to be a source of annotations for dashboard. To be visible in the annotation editor <code>annotations</code> capability also needs to be enabled in plugin.json. |
|
||||
| [getHighlighterExpression(query)](#gethighlighterexpression-method) | | Used in explore |
|
||||
| [getQueryDisplayText(query)](#getquerydisplaytext-method) | | Convert a query to a simple text string |
|
||||
| [getQueryHints(query, results, rest)](#getqueryhints-method) | | Get hints for query improvements |
|
||||
| [getTagKeys(options)](#gettagkeys-method) | | Get tag keys for adhoc filters |
|
||||
| [getTagValues(options)](#gettagvalues-method) | | Get tag values for adhoc filters |
|
||||
| [getVersion(optionalOptions)](#getversion-method) | | |
|
||||
| [importQueries(queries, originMeta)](#importqueries-method) | | Imports queries from a different datasource |
|
||||
| [interpolateVariablesInQueries(queries, scopedVars)](#interpolatevariablesinqueries-method) | | |
|
||||
| [metricFindQuery(query, options)](#metricfindquery-method) | | Variable query action. |
|
||||
| [modifyQuery(query, action)](#modifyquery-method) | | Used in explore |
|
||||
| [query(request)](#query-method) | | Query for data, and optionally stream results |
|
||||
| [targetContainsTemplate(query)](#targetcontainstemplate-method) | | Used by alerting to check if query contains template variables |
|
||||
| [testDatasource()](#testdatasource-method) | | Test & verify datasource settings & connection details |
|
||||
|
||||
### constructor(instanceSettings)
|
||||
|
||||
Constructs a new instance of the `DataSourceApi` class
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
constructor(instanceSettings: DataSourceInstanceSettings<TOptions>);
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| instanceSettings | <code>DataSourceInstanceSettings<TOptions></code> | |
|
||||
|
||||
### 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
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
components?: DataSourcePluginComponents<DataSourceApi<TQuery, TOptions>, TQuery, TOptions>;
|
||||
```
|
||||
|
||||
### getLogRowContext property
|
||||
|
||||
Retrieve context for a given log row
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getLogRowContext?: <TContextQueryOptions extends {}>(row: LogRowModel, options?: TContextQueryOptions) => Promise<DataQueryResponse>;
|
||||
```
|
||||
|
||||
### id property
|
||||
|
||||
Set in constructor
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
readonly id: number;
|
||||
```
|
||||
|
||||
### init property
|
||||
|
||||
Initializes a datasource after instantiation
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
init?: () => void;
|
||||
```
|
||||
|
||||
### interval property
|
||||
|
||||
min interval range
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
interval?: string;
|
||||
```
|
||||
|
||||
### languageProvider property
|
||||
|
||||
Used in explore
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
languageProvider?: any;
|
||||
```
|
||||
|
||||
### meta property
|
||||
|
||||
static information about the datasource
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
meta?: DataSourcePluginMeta;
|
||||
```
|
||||
|
||||
### name property
|
||||
|
||||
Set in constructor
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
readonly name: string;
|
||||
```
|
||||
|
||||
### annotationQuery method
|
||||
|
||||
Can be optionally implemented to allow datasource to be a source of annotations for dashboard. To be visible in the annotation editor `annotations` capability also needs to be enabled in plugin.json.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
annotationQuery?(options: AnnotationQueryRequest<TQuery>): Promise<AnnotationEvent[]>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>AnnotationQueryRequest<TQuery></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<AnnotationEvent[]>`
|
||||
|
||||
### getHighlighterExpression method
|
||||
|
||||
Used in explore
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getHighlighterExpression?(query: TQuery): string[];
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>TQuery</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`string[]`
|
||||
|
||||
### getQueryDisplayText method
|
||||
|
||||
Convert a query to a simple text string
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getQueryDisplayText?(query: TQuery): string;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>TQuery</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`string`
|
||||
|
||||
### getQueryHints method
|
||||
|
||||
Get hints for query improvements
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getQueryHints?(query: TQuery, results: any[], ...rest: any): QueryHint[];
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>TQuery</code> | |
|
||||
| results | <code>any[]</code> | |
|
||||
| rest | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`QueryHint[]`
|
||||
|
||||
### getTagKeys method
|
||||
|
||||
Get tag keys for adhoc filters
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getTagKeys?(options?: any): Promise<MetricFindValue[]>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<MetricFindValue[]>`
|
||||
|
||||
### getTagValues method
|
||||
|
||||
Get tag values for adhoc filters
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getTagValues?(options: any): Promise<MetricFindValue[]>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| options | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<MetricFindValue[]>`
|
||||
|
||||
### getVersion method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
getVersion?(optionalOptions?: any): Promise<string>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| optionalOptions | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<string>`
|
||||
|
||||
### importQueries method
|
||||
|
||||
Imports queries from a different datasource
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
importQueries?(queries: TQuery[], originMeta: PluginMeta): Promise<TQuery[]>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| queries | <code>TQuery[]</code> | |
|
||||
| originMeta | <code>PluginMeta</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<TQuery[]>`
|
||||
|
||||
### interpolateVariablesInQueries method
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
interpolateVariablesInQueries?(queries: TQuery[], scopedVars: ScopedVars | {}): TQuery[];
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| queries | <code>TQuery[]</code> | |
|
||||
| scopedVars | <code>ScopedVars | {}</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`TQuery[]`
|
||||
|
||||
### metricFindQuery method
|
||||
|
||||
Variable query action.
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
metricFindQuery?(query: any, options?: any): Promise<MetricFindValue[]>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>any</code> | |
|
||||
| options | <code>any</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<MetricFindValue[]>`
|
||||
|
||||
### modifyQuery method
|
||||
|
||||
Used in explore
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
modifyQuery?(query: TQuery, action: QueryFixAction): TQuery;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>TQuery</code> | |
|
||||
| action | <code>QueryFixAction</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`TQuery`
|
||||
|
||||
### query method
|
||||
|
||||
Query for data, and optionally stream results
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
abstract query(request: DataQueryRequest<TQuery>): Promise<DataQueryResponse> | Observable<DataQueryResponse>;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| request | <code>DataQueryRequest<TQuery></code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<DataQueryResponse> | Observable<DataQueryResponse>`
|
||||
|
||||
### targetContainsTemplate method
|
||||
|
||||
Used by alerting to check if query contains template variables
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
targetContainsTemplate?(query: TQuery): boolean;
|
||||
```
|
||||
<b>Parameters</b>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| query | <code>TQuery</code> | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
`boolean`
|
||||
|
||||
### testDatasource method
|
||||
|
||||
Test & verify datasource settings & connection details
|
||||
|
||||
<b>Signature</b>
|
||||
|
||||
```typescript
|
||||
abstract testDatasource(): Promise<any>;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
`Promise<any>`
|
||||
|
||||
Reference in New Issue
Block a user