Skip to content
dbx tools

Variable: searchIndexInfoSchema

const searchIndexInfoSchema: ZodObject<{ alias: ZodOptional<ZodString>; columns: ZodOptional<ZodArray<ZodString>>; isDefault: ZodOptional<ZodBoolean>; name: ZodString; primaryKey: ZodOptional<ZodString>; }, $strip>

Schema for the boot-time index catalogue a UI reads to populate a search box (the payload of the plugin’s client config / GET /api/search/indexes). An entry names an index, an optional short alias, and the columns worth showing, so a search box needs no server round-trip to render.

searchIndexInfo fields

Section titled “searchIndexInfo fields”
  • name: Unity Catalog name of the index (catalog.schema.index).
  • alias (optional): Short alias the plugin accepts in place of name.
  • primaryKey (optional): The index’s primary-key column, when known.
  • columns (optional): Columns returned by default, in display order.
  • isDefault (optional): True for the plugin’s default index.