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 use the global IVF-PQ ANN implementation. The dimension determines both the stored vector shape and PQ 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 add_binary_dense_vector_field( &mut self, name: &str, dim: usize, indexed: bool, stored: bool, ) -> Field

Add a binary dense vector field

Binary dense vectors use packed-bit storage (1 bit per dimension), exact Hamming scoring inside globally routed IVF leaves, and a flat SIMD fallback while the index is accumulating.

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

Add a binary 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_fast(&mut self, field: Field, fast: bool)

Set fast-field columnar storage for O(1) doc→value access. Valid for u64, i64, f64, and text fields.

pub fn set_primary_key(&mut self, field: Field)

Mark a field as the primary key (unique constraint).

Primary key implies fast + indexed (dedup looks committed keys up in the fast-field text dictionary) — kept in sync with the SDL path, which forces the same attributes.

pub fn set_content_hash(&mut self, field: Field)

Mark a stored scalar field as the caller-supplied content fingerprint. Invalid configurations are rejected when creating an index.

pub fn set_reorder(&mut self, field: Field, reorder: bool)

Enable BP reordering for an indexed text or BMP field. Invalid field types are rejected at schema admission.

pub fn set_bm25_params(&mut self, field: Field, k1: Option<f32>, b: Option<f32>)

Set the BM25 parameters of a text field (None keeps the default).

pub fn set_chunked(&mut self, field: Field, chunked: bool)

Mark a text field as chunked: each value is indexed as its own BM25 unit and results carry per-chunk ordinals. Implies multi.

pub fn set_reorder_on_merge(&mut self, on: bool)

Enable BP reordering of reorder-attributed text or BMP fields inside merges (index-level; SDL reorder_on_merge: true). Default: disabled.

pub fn set_max_l1_phrase_terms(&mut self, limit: NonZeroU32)

Set the persisted L1 phrase-term cap at index creation (default: 64). Higher limits allow more per-phrase cursors and posting/position reads; the shared candidate probe budgets and server token limit still apply.

pub fn set_index_name(&mut self, name: impl Into<String>)

Set the index name used as the metrics index label.

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() -> Self

Returns the “default value” for a type.