Databricks SDK for JavaScript
    Preparing search index...

    Interface DeltaSyncIndexSpec

    Specification for a Delta Sync index — the index is kept in sync with a source Delta table.

    interface DeltaSyncIndexSpec {
        columnsToSync?: string[];
        embeddingSourceColumns?: EmbeddingSourceColumn[];
        embeddingVectorColumns?: EmbeddingVectorColumn[];
        embeddingWritebackTable?: string;
        pipelineId?: string;
        pipelineType?: PipelineType;
        sourceTable?: string;
    }
    Index

    Properties

    columnsToSync? embeddingSourceColumns? embeddingVectorColumns? embeddingWritebackTable? pipelineId? pipelineType? sourceTable?

    Properties

    columnsToSync?: string[]

    [Optional] Select the columns to sync with the index. If left blank, all columns from the source table are synced. The primary key column and embedding source or vector column are always synced.

    embeddingSourceColumns?: EmbeddingSourceColumn[]

    The columns that contain the embedding source.

    embeddingVectorColumns?: EmbeddingVectorColumn[]

    The columns that contain the embedding vectors.

    embeddingWritebackTable?: string

    [Optional] Name of the Delta table to sync the index contents and computed embeddings to.

    pipelineId?: string

    The ID of the pipeline that is used to sync the index.

    pipelineType?: PipelineType

    Pipeline execution mode. Required on create — the backend rejects an unset value. Storage Optimized endpoints accept only TRIGGERED; Standard endpoints accept both. No explicit stage — a REQUIRED field staged below its service would be dropped from combined specs while remaining in required, tripping the OpenAPI required-vs-properties consistency check. The field inherits the service's launch stage.

    sourceTable?: string

    The full name of the source Delta table.

    Settings

    Member Visibility

    On This Page

    Properties