Databricks SDK for JavaScript
    Preparing search index...

    Interface IngestionPipelineDefinition_SchemaSpec

    interface IngestionPipelineDefinition_SchemaSpec {
        connectorOptions?: ConnectorOptions;
        destinationCatalog?: string;
        destinationSchema?: string;
        fanoutOptions?: IngestionPipelineDefinition_FanoutOptions;
        sourceCatalog?: string;
        sourceSchema?: string;
        tableConfiguration?: IngestionPipelineDefinition_TableSpecificConfig;
    }
    Index

    Properties

    connectorOptions? destinationCatalog? destinationSchema? fanoutOptions? sourceCatalog? sourceSchema? tableConfiguration?

    Properties

    connectorOptions?: ConnectorOptions

    (Optional) Source Specific Connector Options

    destinationCatalog?: string

    Required. Destination catalog to store tables.

    destinationSchema?: string

    Required. Destination schema to store tables in. Tables with the same name as the source tables are created in this destination schema. The pipeline fails If a table with the same name already exists.

    fanoutOptions?: IngestionPipelineDefinition_FanoutOptions

    Fanout options for multi-table routing from streaming sources. When set, records are routed to destination tables based on a per-record routing key. The key value becomes the table name: {destination_catalog}.{destination_schema}.{key_value}.

    sourceCatalog?: string

    The source catalog name. Might be optional depending on the type of source.

    sourceSchema?: string

    Schema name in the source database. Currently required; this field will become optional in an upcoming release, since some source types (for example streaming / message-bus connectors) do not use it. When that change ships, this field's type in the generated SDKs and CLI will change from required to optional (nullable); clients that assume it is always present should handle its absence.

    tableConfiguration?: IngestionPipelineDefinition_TableSpecificConfig

    Configuration settings to control the ingestion of tables. These settings are applied to all tables in this schema and override the table_configuration defined in the IngestionPipelineDefinition object.

    Settings

    Member Visibility

    On This Page

    Properties