Struct IndexSchemaBuilder

pub struct IndexSchemaBuilder { /* private fields */ }

Builder for IndexSchema.

Implementations

impl IndexSchemaBuilder

pub fn index_name<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

pub fn index_type<VALUE: Into<IndexType>>(&mut self, value: VALUE) -> &mut Self

The currently supported types are as follows: scalar index: SECONDARY, vector index: HNSW, FLAT

pub fn metric_type<VALUE: Into<MetricType>>( &mut self, value: VALUE, ) -> &mut Self

Distance measurement type of vector index, L2: Euclidean distance, IP: Inner product distance, COSINE: Cosine distance.

pub fn params(&mut self, value: VectorIndexParams) -> &mut Self

Parameter details of vector index

pub fn field<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

The target field name that the index acts on

pub fn auto_build<VALUE: Into<bool>>(&mut self, value: VALUE) -> &mut Self

is auto build index

pub fn auto_build_policy(&mut self, value: AutoBuildPolicy) -> &mut Self

pub fn build(&self) -> Result<IndexSchema, IndexSchemaBuilderError>

Builds a new IndexSchema.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for IndexSchemaBuilder

fn clone(&self) -> IndexSchemaBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for IndexSchemaBuilder

fn default() -> Self

Returns the “default value” for a type.