Databricks SDK for JavaScript
    Preparing search index...

    Interface ListDatasourcesRequest

    interface ListDatasourcesRequest {
        catalogName?: string;
        filter?: string;
        pageSize?: number;
        pageToken?: string;
        schemaName?: string;
        view?: DatasourceView;
    }
    Index

    Properties

    catalogName? filter? pageSize? pageToken? schemaName? view?

    Properties

    catalogName?: string

    Name of the Unity Catalog catalog to list datasources from. Required; each request lists the datasources of a single catalog.

    filter?: string

    Filter expression that restricts the results to datasources with a given name, for example datasource_name = "my_source". Only a single exact-match comparison on datasource_name is supported, and it matches the datasource's current Unity Catalog name, which reads report in effective_datasource_name. Filtered results are returned in a single page.

    pageSize?: number

    Maximum number of results to return in one page. This is a best-effort upper bound, not a guarantee: the server may return fewer items than requested (even zero) while more results still exist. If unset or 0, the server picks a default.

    pageToken?: string
    schemaName?: string

    Name of a Unity Catalog schema in catalog_name. Optional; if set, only the datasources in this schema are returned, and if omitted, the datasources in all schemas of the catalog are returned.

    view?: DatasourceView

    Which fields to return for each datasource. Defaults to DATASOURCE_VIEW_FULL. DATASOURCE_VIEW_BASIC returns only the identity and Unity Catalog location fields.

    Settings

    Member Visibility

    On This Page

    Properties