Type alias EnsureZkdIndexOptions

EnsureZkdIndexOptions: { fieldValueTypes: "double"; fields: string[]; inBackground?: boolean; name?: string; type: "zkd"; unique?: boolean }

Options for creating a ZKD index.

fieldValueTypes: "double"

Data type of the dimension attributes.
fields: string[]

An array containing attribute paths for the dimensions.
Optional inBackground?: boolean

If set to true, the index will be created in the background to reduce the write-lock duration for the collection during index creation.

Default: false
Optional name?: string

A unique name for this index.
type: "zkd"

Type of this index.
Optional unique?: boolean

If set to true, a unique index will be created.

Default: false