Struct Schema 

pub struct Schema { /* private fields */ }

Schema defining document structure

Implementations

impl Schema

pub fn builder() -> SchemaBuilder

pub fn get_field(&self, name: &str) -> Option<Field>

pub fn get_field_entry(&self, field: Field) -> Option<&FieldEntry>

pub fn tokenizer_hint_field(&self, field: Field) -> Option<Field>

Field whose values hint the dynamic tokenizer of field (text<lex(by: <hint field>, ...)>), if any.

pub fn with_vector_index_alter( &self, field: Field, alter: VectorIndexAlter, ) -> Result<Self, String>

Clone this schema with one vector field’s ANN parameters replaced. Field type, dimension, and storage quantization are immutable.

pub fn get_field_name(&self, field: Field) -> Option<&str>

pub fn fields(&self) -> impl Iterator<Item = (Field, &FieldEntry)>

pub fn num_fields(&self) -> usize

pub fn has_reorder_fields(&self) -> bool

Whether any field has the reorder attribute set. Used by the background optimizer to determine which indexes need BP reordering.

pub fn reorder_on_merge(&self) -> bool

Whether merges BP-reorder reorder-attributed BMP fields while writing the merged segment (index-level SDL option reorder_on_merge: true).

pub fn index_label(&self) -> &str

Index name for metric labels (“unknown” when not set — pre-existing metadata or programmatic schemas without a name).

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

Set the index name used as the metrics index label.

pub fn default_fields(&self) -> &[Field]

Get the default fields for query parsing

pub fn set_default_fields(&mut self, fields: Vec<Field>)

Set default fields (used by builder)

pub fn query_routers(&self) -> &[QueryRouterRule]

Get the query router rules

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

Set query router rules

pub fn primary_field(&self) -> Option<Field>

Get the primary key field, if one is defined

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl Default for Schema

fn default() -> Schema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Schema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Schema

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.