Struct SchemaBuilder 

pub struct SchemaBuilder { /* private fields */ }

Builder for Schema

Implementations

impl SchemaBuilder

pub fn add_text_field( &mut self, name: &str, indexed: bool, stored: bool, ) -> Field

pub fn add_text_field_with_tokenizer( &mut self, name: &str, indexed: bool, stored: bool, tokenizer: &str, ) -> Field

pub fn add_u64_field( &mut self, name: &str, indexed: bool, stored: bool, ) -> Field

pub fn add_i64_field( &mut self, name: &str, indexed: bool, stored: bool, ) -> Field

pub fn add_f64_field( &mut self, name: &str, indexed: bool, stored: bool, ) -> Field

pub fn add_bytes_field(&mut self, name: &str, stored: bool) -> Field

pub fn add_json_field(&mut self, name: &str, stored: bool) -> Field

Add a JSON field for storing arbitrary JSON data

JSON fields are never indexed, only stored. They can hold any valid JSON value (objects, arrays, strings, numbers, booleans, null).

pub fn add_sparse_vector_field( &mut self, name: &str, indexed: bool, stored: bool, ) -> Field

Add a sparse vector field with default configuration

Sparse vectors are indexed as inverted posting lists where each dimension becomes a “term” and documents have quantized weights for each dimension.

pub fn add_sparse_vector_field_with_config( &mut self, name: &str, indexed: bool, stored: bool, config: SparseVectorConfig, ) -> Field

Add a sparse vector field with custom configuration

Use SparseVectorConfig::splade() for SPLADE models (u16 indices, uint8 weights). Use SparseVectorConfig::compact() for maximum compression (u16 indices, uint4 weights).

pub fn set_sparse_vector_config( &mut self, field: Field, config: SparseVectorConfig, )

Set sparse vector configuration for an existing field

pub fn add_dense_vector_field( &mut self, name: &str, dim: usize, indexed: bool, stored: bool, ) -> Field

Add a dense vector field with default configuration

Dense vectors are indexed using RaBitQ binary quantization for fast ANN search. The dimension must be specified as it determines the quantization structure.

pub fn add_dense_vector_field_with_config( &mut self, name: &str, indexed: bool, stored: bool, config: DenseVectorConfig, ) -> Field

Add a dense vector field with custom configuration

pub fn set_multi(&mut self, field: Field, multi: bool)

Set the multi attribute on the last added field

pub fn set_positions(&mut self, field: Field, mode: PositionMode)

Set position tracking mode for phrase queries and multi-field element tracking

pub fn set_default_fields(&mut self, field_names: Vec<String>)

Set default fields by name

pub fn set_query_routers(&mut self, rules: Vec<QueryRouterRule>)

Set query router rules

pub fn build(self) -> Schema

Trait Implementations

impl Debug for SchemaBuilder

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

Formats the value using the given formatter.

impl Default for SchemaBuilder

fn default() -> SchemaBuilder

Returns the “default value” for a type.