delta_sync_index_spec: Delta Sync Vector Search Index Specification

In brickster: R Toolkit for 'Databricks'

Delta Sync Vector Search Index Specification

Description

Delta Sync Vector Search Index Specification

Usage

delta_sync_index_spec(
  source_table,
  embedding_writeback_table = NULL,
  embedding_source_columns = NULL,
  embedding_vector_columns = NULL,
  pipeline_type = c("TRIGGERED", "CONTINUOUS")
)

Arguments

source_table	The name of the source table.
embedding_writeback_table	Name of table to sync index contents and computed embeddings back to delta table, see details.
embedding_source_columns	The columns that contain the embedding source, must be one or list of embedding_source_column()
embedding_vector_columns	The columns that contain the embedding, must be one or list of embedding_vector_column()
pipeline_type	Pipeline execution mode, see details.

Details

pipeline_type is either:

• "TRIGGERED": If the pipeline uses the triggered execution mode, the system stops processing after successfully refreshing the source table in the pipeline once, ensuring the table is updated based on the data available when the update started.

• "CONTINUOUS" If the pipeline uses continuous execution, the pipeline processes new data as it arrives in the source table to keep vector index fresh.

The only supported naming convention for embedding_writeback_table is "<index_name>_writeback_table".

See Also

db_vs_indexes_create()

Other Vector Search API: db_vs_endpoints_create(), db_vs_endpoints_delete(), db_vs_endpoints_get(), db_vs_endpoints_list(), db_vs_indexes_create(), db_vs_indexes_delete(), db_vs_indexes_delete_data(), db_vs_indexes_get(), db_vs_indexes_list(), db_vs_indexes_query(), db_vs_indexes_query_next_page(), db_vs_indexes_scan(), db_vs_indexes_sync(), db_vs_indexes_upsert_data(), direct_access_index_spec(), embedding_source_column(), embedding_vector_column()

brickster documentation built on April 12, 2025, 1:21 a.m.