Databricks SDK for JavaScript
    Preparing search index...

    Interface ListTablesRequest

    interface ListTablesRequest {
        catalogName?: string;
        includeBrowse?: boolean;
        includeManifestCapabilities?: boolean;
        maxResults?: number;
        omitColumns?: boolean;
        omitProperties?: boolean;
        omitUsername?: boolean;
        pageToken?: string;
        schemaName?: string;
    }
    Index

    Properties

    catalogName? includeBrowse? includeManifestCapabilities? maxResults? omitColumns? omitProperties? omitUsername? pageToken? schemaName?

    Properties

    catalogName?: string

    Name of parent catalog for tables of interest.

    includeBrowse?: boolean

    Whether to include tables in the response for which the principal can only access selective metadata for.

    includeManifestCapabilities?: boolean

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

    maxResults?: number

    Maximum number of tables to return. If not set, all the tables are returned (not recommended).

    • when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
    • when set to 0, the page length is set to a server configured value (recommended);
    • when set to a value less than 0, an invalid parameter error is returned;
    omitColumns?: boolean

    Whether to omit the columns of the table from the response or not.

    omitProperties?: boolean

    Whether to omit the properties of the table from the response or not.

    omitUsername?: boolean

    Whether to omit the username of the table (e.g. owner, updated_by, created_by) from the response or not.

    pageToken?: string

    Opaque token to send for the next page of results (pagination).

    schemaName?: string

    Parent schema of tables.

    Settings

    Member Visibility

    On This Page

    Properties