Struct VectorIndex 

pub struct VectorIndex {
    pub name: String,
    pub table: String,
    pub column: String,
    pub metric: DistanceMetric,
    pub index_type: IndexType,
    pub concurrent: bool,
    pub if_not_exists: bool,
}

A vector index definition.

Examples

use prax_pgvector::index::{VectorIndex, HnswConfig};
use prax_pgvector::DistanceMetric;

// Create an HNSW index
let index = VectorIndex::hnsw("idx_embedding", "documents", "embedding")
    .metric(DistanceMetric::Cosine)
    .config(HnswConfig::high_recall())
    .build()
    .unwrap();

let sql = index.to_create_sql();
assert!(sql.contains("USING hnsw"));
assert!(sql.contains("vector_cosine_ops"));

Fields

name: String

Index name.

table: String

Table name.

column: String

Column name.

metric: DistanceMetric

Distance metric.

index_type: IndexType

Index type and configuration.

concurrent: bool

Whether to create concurrently (non-blocking).

if_not_exists: bool

Whether to add IF NOT EXISTS clause.

Implementations

impl VectorIndex

pub fn hnsw( name: impl Into<String>, table: impl Into<String>, column: impl Into<String>, ) -> VectorIndexBuilder

Start building an HNSW index.

pub fn ivfflat( name: impl Into<String>, table: impl Into<String>, column: impl Into<String>, ) -> VectorIndexBuilder

Start building an IVFFlat index.

pub fn to_create_sql(&self) -> String

Generate the CREATE INDEX SQL statement.

pub fn to_drop_sql(&self) -> String

Generate the DROP INDEX SQL statement.

pub fn to_exists_sql(&self) -> String

Generate SQL to check if this index exists.

pub fn to_size_sql(&self) -> String

Generate SQL to get the index size.

Trait Implementations

impl Clone for VectorIndex

fn clone(&self) -> VectorIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VectorIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VectorIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VectorIndex

fn eq(&self, other: &VectorIndex) -> 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 VectorIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for VectorIndex

impl StructuralPartialEq for VectorIndex