Struct OptimizeOptions 

#[non_exhaustive]
pub struct OptimizeOptions {
    pub num_indices_to_merge: Option<usize>,
    pub index_names: Option<Vec<String>>,
    pub retrain: bool,
}

Options for optimizing all indices.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

num_indices_to_merge: Option<usize>

Number of delta indices to merge for one column. Default: 1.

If num_indices_to_merge is None, lance will create a new delta index if no partition is split, otherwise it will merge all delta indices. If num_indices_to_merge is Some(N), the delta updates and latest N indices will be merged into one single index.

It is up to the caller to decide how many indices to merge / keep. Callers can find out how many indices are there by calling [Dataset::index_statistics].

A common usage pattern will be that, the caller can keep a large snapshot of the index of the base version, and accumulate a few delta indices, then merge them into the snapshot.

index_names: Option<Vec<String>>

the index names to optimize. If None, all indices will be optimized.

retrain: bool

whether to retrain the whole index. Default: false.

If true, the index will be retrained based on the current data, num_indices_to_merge will be ignored, and all indices will be merged into one. If false, the index will be optimized by merging num_indices_to_merge indices.

This is useful when the data distribution has changed significantly, and we want to retrain the index to improve the search quality. This would be faster than re-create the index from scratch.

NOTE: this option is only supported for v3 vector indices.

Implementations

impl OptimizeOptions

pub fn new() -> Self

pub fn merge(num: usize) -> Self

pub fn append() -> Self

pub fn retrain() -> Self

pub fn num_indices_to_merge(self, num: Option<usize>) -> Self

pub fn index_names(self, names: Vec<String>) -> Self

Trait Implementations

impl Clone for OptimizeOptions

fn clone(&self) -> OptimizeOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OptimizeOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OptimizeOptions

fn default() -> OptimizeOptions

Returns the “default value” for a type.