Signature

    Import

    Constructors

    Properties

    PropertyModifiersTypeDescription
    streamOptionsProviderStreamOptionsProvider<TQuery>Optionally override the streaming behavior

    Methods

    MethodModifiersDescription
    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
    callHealthCheck()Run the datasource healthcheck
    Override to skip executing a query
    getResource(path, params)Make a GET request to the datasource resource path
    Send a POST request to the datasource resource path
    query(request)Ideally final – any other implementation may not work as expected
    Checks the plugin health see public/app/features/datasources/state/actions.ts for what needs to be returned here

    Constructs a new instance of the DataSourceWithBackend class

    Signature

    1. constructor(instanceSettings: DataSourceInstanceSettings<TOptions>);

    Parameters

    streamOptionsProvider property

    Optionally override the streaming behavior

    Signature

    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

    Signature

    Parameters

    ParameterTypeDescription
    queryTQuery
    scopedVarsScopedVars

    Record<string, any>

    Run the datasource healthcheck

    Signature

    1. callHealthCheck(): Promise<HealthCheckResult>;

    Returns:

    Promise<HealthCheckResult>

    filterQuery method

    Override to skip executing a query

    Signature

    Parameters

    ParameterTypeDescription
    queryTQuery

    Returns:

    boolean

    false if the query should be skipped

    getResource method

    Make a GET request to the datasource resource path

    Signature

    1. getResource(path: string, params?: any): Promise<any>;

    Parameters

    Promise<any>

    Send a POST request to the datasource resource path

    Signature

    1. postResource(path: string, body?: any): Promise<any>;

    Parameters

    ParameterTypeDescription
    pathstring
    bodyany

    Returns:

    Promise<any>

    query method

    Ideally final – any other implementation may not work as expected

    Signature

    Parameters

    ParameterTypeDescription
    requestDataQueryRequest<TQuery>

    Returns:

    Observable<DataQueryResponse>

    testDatasource method

    Checks the plugin health see public/app/features/datasources/state/actions.ts for what needs to be returned here

    Signature

    Returns: