Databricks SDK for JavaScript
    Preparing search index...

    Interface ListTableSummariesRequest

    interface ListTableSummariesRequest {
        catalogName?: string;
        includeManifestCapabilities?: boolean;
        maxResults?: number;
        pageToken?: string;
        schemaNamePattern?: string;
        tableNamePattern?: string;
    }
    Index

    Properties

    catalogName? includeManifestCapabilities? maxResults? pageToken? schemaNamePattern? tableNamePattern?

    Properties

    catalogName?: string

    Name of parent catalog for tables of interest.

    includeManifestCapabilities?: boolean

    Whether to include a manifest containing table capabilities in the response.

    maxResults?: number

    Maximum number of summaries for tables to return. If not set, the page length is set to a server configured value (10000, as of 1/5/2024).

    • when set to a value greater than 0, the page length is the minimum of this value and a server configured value (10000, as of 1/5/2024);
    • when set to 0, the page length is set to a server configured value (10000, as of 1/5/2024) (recommended);
    • when set to a value less than 0, an invalid parameter error is returned;
    pageToken?: string

    Opaque pagination token to go to next page based on previous query.

    schemaNamePattern?: string

    A sql LIKE pattern (% and _) for schema names. All schemas will be returned if not set or empty.

    tableNamePattern?: string

    A sql LIKE pattern (% and _) for table names. All tables will be returned if not set or empty.

    Settings

    Member Visibility

    On This Page

    Properties