Struct OptimizersConfigDiffBuilder

pub struct OptimizersConfigDiffBuilder { /* private fields */ }

Builder for OptimizersConfigDiff.

Implementations

impl OptimizersConfigDiffBuilder

pub fn deleted_threshold(self, value: f64) -> Self

The minimal fraction of deleted vectors in a segment, required to perform segment optimization

pub fn vacuum_min_vector_number(self, value: u64) -> Self

The minimal number of vectors in a segment, required to perform segment optimization

pub fn default_segment_number(self, value: u64) -> Self

Target amount of segments the optimizer will try to keep. Real amount of segments may vary depending on multiple parameters:

• Amount of stored points.
• Current write RPS.

It is recommended to select the default number of segments as a factor of the number of search threads, so that each segment would be handled evenly by one of the threads.

pub fn max_segment_size(self, value: u64) -> Self

Do not create segments larger this size (in kilobytes). Large segments might require disproportionately long indexation times, therefore it makes sense to limit the size of segments.

If indexing speed is more important - make this parameter lower. If search speed is more important - make this parameter higher. Note: 1Kb = 1 vector of size 256 If not set, will be automatically selected considering the number of available CPUs.

pub fn memmap_threshold(self, value: u64) -> Self

Maximum size (in kilobytes) of vectors to store in-memory per segment. Segments larger than this threshold will be stored as read-only memmaped file.

Memmap storage is disabled by default, to enable it, set this threshold to a reasonable value.

To disable memmap storage, set this to 0.

Note: 1Kb = 1 vector of size 256

pub fn indexing_threshold(self, value: u64) -> Self

Maximum size (in kilobytes) of vectors allowed for plain index, exceeding this threshold will enable vector indexing

Default value is 20,000, based on <https://github.com/google-research/google-research/blob/master/scann/docs/algorithms.md.>

To disable vector indexing, set to 0.

Note: 1kB = 1 vector of size 256.

pub fn flush_interval_sec(self, value: u64) -> Self

Interval between forced flushes.

pub fn max_optimization_threads(self, value: u64) -> Self

Max number of threads (jobs) for running optimizations per shard. Note: each optimization job will also use max_indexing_threads threads by itself for index building. If null - have no limit and choose dynamically to saturate CPU. If 0 - no optimization threads, optimizations will be disabled.

impl OptimizersConfigDiffBuilder

pub fn build(self) -> OptimizersConfigDiff

Builds the desired type. Can often be omitted.

Trait Implementations

impl Default for OptimizersConfigDiffBuilder

fn default() -> Self

Returns the “default value” for a type.

impl From<OptimizersConfigDiffBuilder> for OptimizersConfigDiff

fn from(value: OptimizersConfigDiffBuilder) -> Self

Converts to this type from the input type.