Struct Index 

pub struct Index {

    pub name: String,
    pub columns: Vec<String>,
    pub unique: bool,
    pub kind: IndexKind,
    pub ann_quantization: AnnQuantization,
    pub ann_algorithm: AnnAlgorithm,
    pub predicate: Option<String>,
    pub ann_m: Option<usize>,
    pub ann_ef_construction: Option<usize>,
    pub ann_ef_search: Option<usize>,
    pub ann_diskann_r: Option<usize>,
    pub ann_diskann_l: Option<usize>,
    pub ann_diskann_beam_width: Option<usize>,
    pub ann_diskann_alpha: Option<u32>,
    pub ann_ivf_nlist: Option<usize>,
    pub ann_ivf_nprobe: Option<usize>,
    pub ann_pq_training_samples: Option<usize>,
    pub ann_pq_seed: Option<u64>,
    pub ann_pq_rerank_factor: Option<usize>,
    pub minhash_permutations: Option<usize>,
    pub minhash_bands: Option<usize>,
    pub learned_range_epsilon: Option<usize>,
}

An index on one or more columns.

Fields

name: String

columns: Vec<String>

unique: bool

kind: IndexKind

Index kind; defaults to Bitmap so pre-existing schemas deserialize unchanged.

ann_quantization: AnnQuantization

ANN representation. Ignored for non-ANN indexes.

ann_algorithm: AnnAlgorithm

ANN graph/structure algorithm (Phase 2). Defaults to HNSW. Ignored for non-ANN indexes. Orthogonal to ann_quantization.

predicate: Option<String>

Optional SQL predicate for a partial index.

ann_m: Option<usize>

HNSW graph degree. Engine default when omitted.

ann_ef_construction: Option<usize>

HNSW construction search width. Engine default when omitted.

ann_ef_search: Option<usize>

HNSW query search width. Engine default when omitted.

ann_diskann_r: Option<usize>

DiskANN max graph degree R. Engine default when omitted.

ann_diskann_l: Option<usize>

DiskANN build search-list size L. Engine default when omitted.

ann_diskann_beam_width: Option<usize>

DiskANN query beam width. Engine default when omitted.

ann_diskann_alpha: Option<u32>

DiskANN robust-prune alpha × 100 (120 = 1.2). Engine default when omitted.

ann_ivf_nlist: Option<usize>

IVF inverted-list (centroid) count. Engine default when omitted.

ann_ivf_nprobe: Option<usize>

IVF probe count at query time. Engine default when omitted.

ann_pq_training_samples: Option<usize>

Product-quantizer training sample cap. Engine default when omitted.

ann_pq_seed: Option<u64>

Product-quantizer deterministic training seed. Engine default when omitted.

ann_pq_rerank_factor: Option<usize>

Product-quantizer exact-rerank factor (0 disables). Engine default when omitted.

minhash_permutations: Option<usize>

MinHash permutation count. Engine default when omitted.

minhash_bands: Option<usize>

MinHash LSH band count. Engine default when omitted.

learned_range_epsilon: Option<usize>

Learned-range error bound. Engine default when omitted.

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 Default for Index

fn default() -> Index

Returns the “default value” for a type.

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 Eq for Index

impl PartialEq for Index

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

Equality operator ==.

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

Inequality operator !=.

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