Type Alias DataSourceNew

Complete datasource metadata including connector information, capabilities, and optional UI details.

type DataSourceNew = {
    capabilities?: string[];
    dataLoadUrlOverride?: string;
    dataSourceId: string;
    dataSourceName?: string;
    dataSourcePropertyName?: string;
    dataSourceType?: string;
    disabled?: boolean;
    featureFlag?: string | null;
    frontendFlags?: string | null;
    name: string;
    provider: string;
    providerName: string;
    qriDefinition?: dataSources.QriDefinition;
    settings?: { name: string; value: string }[];
    uiInfo?: dataSources.UiInfo;
}
Index
capabilities? dataLoadUrlOverride? dataSourceId dataSourceName? dataSourcePropertyName? dataSourceType? disabled? featureFlag? frontendFlags? name provider providerName qriDefinition? settings? uiInfo?
capabilities?: string[]

List of capabilities supported by the datasource.

dataLoadUrlOverride?: string

Override URL for data loading. Empty if the default URL is used.

dataSourceId: string

Unique identifier of the datasource.

dataSourceName?: string

Display name of the datasource.

dataSourcePropertyName?: string

Name of the property used to identify the datasource type in a connection string. Empty if not applicable.

dataSourceType?: string

Category type of the datasource.

disabled?: boolean

When true, the datasource is disabled and excluded from results unless includeDisabled is set.

featureFlag?: string | null

Name of the feature flag that controls the availability of the datasource. Null if the datasource is not behind a feature flag.

frontendFlags?: string | null

Base64 encoded flags (4 bytes) used by the client to control how the datasource is presented. Null if not defined by the connector.

name: string

Display name of the datasource.

provider: string

Connector provider executable name.

providerName: string

Display name of the connector provider.

qriDefinition?: dataSources.QriDefinition

QRI definition template for a datasource, specifying connection, path, and item parts.

settings?: { name: string; value: string }[]

Connector-defined settings of the datasource. Empty if there are none.

Type Declaration

  • name: string

    Name of the setting.

  • value: string

    Value of the setting.

uiInfo?: dataSources.UiInfo

UI metadata for the datasource. Present only when includeui is true in the request.

Settings
Member Visibility

On This Page
Properties