Databricks SDK for JavaScript
    Preparing search index...

    Interface ExistingTable

    Uses an existing Unity Catalog Delta table or view as the datasource's source. Mutually exclusive with autoloader and unity_catalog_connection.

    interface ExistingTable {
        catalog?: string;
        effectiveCatalog?: string;
        effectiveName?: string;
        effectiveSchema?: string;
        includeExistingRows?: boolean;
        name?: string;
        schema?: string;
    }
    Index

    Properties

    catalog? effectiveCatalog? effectiveName? effectiveSchema? includeExistingRows? name? schema?

    Properties

    catalog?: string

    Name of the catalog the existing table lives in. Optional on create and defaults to the datasource's own catalog. Cannot be changed. Reads return the value as supplied; the catalog in use is reported in effective_catalog.

    effectiveCatalog?: string

    Current Unity Catalog catalog name of the source table, resolved from its stable table ID, so a rename of the source table is reported here without changing catalog.

    effectiveName?: string

    Current Unity Catalog name of the source table, resolved from its stable table ID.

    effectiveSchema?: string

    Current Unity Catalog schema name of the source table, resolved from its stable table ID.

    includeExistingRows?: boolean

    Whether to ingest the rows already present in the source table when ingestion first starts. Set true to ingest the existing rows and then every new commit. Set false, or leave unset, to ingest only rows written after the datasource starts. Defaults to false, and must be true for a Delta Sharing source table. Takes effect only at first start and cannot be changed. Reads return the value as supplied.

    name?: string

    Name of the source table or view. Required on create and cannot be changed. Reads return the value as supplied; the table's current name is reported in effective_name.

    schema?: string

    Name of the schema the existing table lives in. Optional, but required when catalog is set; supplying catalog without schema is rejected. Defaults to the datasource's own schema. Cannot be changed. Reads return the value as supplied; the schema in use is reported in effective_schema.

    Settings

    Member Visibility

    On This Page

    Properties