Databricks SDK for JavaScript
    Preparing search index...

    Interface TableInfo

    interface TableInfo {
        accessPoint?: string;
        browseOnly?: boolean;
        catalogName?: string;
        columns?: ColumnInfo[];
        comment?: string;
        createdAt?: bigint;
        createdBy?: string;
        dataAccessConfigurationId?: string;
        dataSourceFormat?: DataSourceFormat;
        deletedAt?: bigint;
        deltaRuntimePropertiesKvpairs?: DeltaRuntimePropertiesKvPairs;
        effectivePredictiveOptimizationFlag?: EffectivePredictiveOptimizationFlag;
        enablePredictiveOptimization?: string;
        encryptionDetails?: EncryptionDetails;
        fullName?: string;
        metastoreId?: string;
        name?: string;
        owner?: string;
        pipelineId?: string;
        properties?: Record<string, string>;
        rowFilter?: RowFilter;
        schemaName?: string;
        securableKindManifest?: SecurableKindManifest;
        sqlPath?: string;
        storageCredentialName?: string;
        storageLocation?: string;
        tableConstraints?: TableConstraint[];
        tableId?: string;
        tableType?: TableType;
        updatedAt?: bigint;
        updatedBy?: string;
        viewDefinition?: string;
        viewDependencies?: DependencyList;
    }
    Index

    Properties

    accessPoint? browseOnly? catalogName? columns? comment? createdAt? createdBy? dataAccessConfigurationId? dataSourceFormat? deletedAt? deltaRuntimePropertiesKvpairs? effectivePredictiveOptimizationFlag? enablePredictiveOptimization? encryptionDetails? fullName? metastoreId? name? owner? pipelineId? properties? rowFilter? schemaName? securableKindManifest? sqlPath? storageCredentialName? storageLocation? tableConstraints? tableId? tableType? updatedAt? updatedBy? viewDefinition? viewDependencies?

    Properties

    accessPoint?: string

    The AWS access point to use when accesing s3 for this external location.

    browseOnly?: boolean

    Indicates whether the principal is limited to retrieving metadata for the associated object through the BROWSE privilege when include_browse is enabled in the request.

    catalogName?: string

    Name of parent catalog.

    columns?: ColumnInfo[]

    The array of ColumnInfo definitions of the table's columns.

    comment?: string

    User-provided free-form text description.

    createdAt?: bigint

    Time at which this table was created, in epoch milliseconds.

    createdBy?: string

    Username of table creator.

    dataAccessConfigurationId?: string

    Unique ID of the Data Access Configuration to use with the table data.

    dataSourceFormat?: DataSourceFormat
    deletedAt?: bigint

    Time at which this table was deleted, in epoch milliseconds. Field is omitted if table is not deleted.

    deltaRuntimePropertiesKvpairs?: DeltaRuntimePropertiesKvPairs

    Information pertaining to current state of the delta table.

    effectivePredictiveOptimizationFlag?: EffectivePredictiveOptimizationFlag
    enablePredictiveOptimization?: string
    encryptionDetails?: EncryptionDetails
    fullName?: string

    Full name of table, in form of catalog_name.schema_name.table_name

    metastoreId?: string

    Unique identifier of parent metastore.

    name?: string

    Name of table, relative to parent schema.

    owner?: string

    Username of current owner of table.

    pipelineId?: string

    The pipeline ID of the table. Applicable for tables created by pipelines (Materialized View, Streaming Table, etc.).

    properties?: Record<string, string>

    A map of key-value properties attached to the securable.

    rowFilter?: RowFilter
    schemaName?: string

    Name of parent schema relative to its parent catalog.

    securableKindManifest?: SecurableKindManifest

    SecurableKindManifest of table, including capabilities the table has.

    sqlPath?: string

    List of schemes whose objects can be referenced without qualification.

    storageCredentialName?: string

    Name of the storage credential, when a storage credential is configured for use with this table.

    storageLocation?: string

    Storage root URL for table (for MANAGED, EXTERNAL tables).

    tableConstraints?: TableConstraint[]

    List of table constraints. Note: this field is not set in the output of the listTables API.

    tableId?: string

    The unique identifier of the table.

    tableType?: TableType
    updatedAt?: bigint

    Time at which this table was last modified, in epoch milliseconds.

    updatedBy?: string

    Username of user who last modified the table.

    viewDefinition?: string

    View definition SQL (when table_type is VIEW, MATERIALIZED_VIEW, or STREAMING_TABLE)

    viewDependencies?: DependencyList

    View dependencies (when table_type == VIEW or MATERIALIZED_VIEW, STREAMING_TABLE)

    • when DependencyList is None, the dependency is not provided;
    • when DependencyList is an empty list, the dependency is provided but is empty;
    • when DependencyList is not an empty list, dependencies are provided and recorded. Note: this field is not set in the output of the listTables API.

    Settings

    Member Visibility

    On This Page

    Properties