Struct Index 

pub struct Index {
    pub name: Option<SmolStr>,
    pub fields: Vec<IndexField>,
    pub is_unique: bool,
    pub index_type: Option<IndexType>,
    pub vector_ops: Option<VectorOps>,
    pub hnsw_m: Option<u32>,
    pub hnsw_ef_construction: Option<u32>,
    pub ivfflat_lists: Option<u32>,
}

Index definition for a model.

Fields

name: Option<SmolStr>

Index name (auto-generated if not specified).

fields: Vec<IndexField>

Fields included in the index.

is_unique: bool

Whether this is a unique index.

index_type: Option<IndexType>

Index type (btree, hash, etc.).

vector_ops: Option<VectorOps>

Vector distance operation (for HNSW/IVFFlat indexes).

hnsw_m: Option<u32>

HNSW m parameter (max connections per layer, default 16).

hnsw_ef_construction: Option<u32>

HNSW ef_construction parameter (size of candidate list during build, default 64).

ivfflat_lists: Option<u32>

IVFFlat lists parameter (number of inverted lists, default 100).

Implementations

impl Index

pub fn new(fields: Vec<IndexField>) -> Index

Create a new index.

pub fn unique(fields: Vec<IndexField>) -> Index

Create a unique index.

pub fn with_name(self, name: impl Into<SmolStr>) -> Index

Set the index name.

pub fn with_type(self, index_type: IndexType) -> Index

Set the index type.

pub fn with_vector_ops(self, ops: VectorOps) -> Index

Set the vector distance operation.

pub fn with_hnsw_m(self, m: u32) -> Index

Set HNSW m parameter.

pub fn with_hnsw_ef_construction(self, ef: u32) -> Index

Set HNSW ef_construction parameter.

pub fn with_ivfflat_lists(self, lists: u32) -> Index

Set IVFFlat lists parameter.

pub fn is_vector_index(&self) -> bool

Check if this is a vector index.

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Index

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Index

fn deserialize<__D>( __deserializer: __D, ) -> Result<Index, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Index

fn eq(&self, other: &Index) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Index

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Index