Struct Collection 

pub struct Collection { /* private fields */ }

A collection of vectors with metadata

Implementations

impl Collection

pub fn new(config: CollectionConfig) -> Self

pub fn next_operation_id(&self) -> u64

Get next operation ID (atomically increments counter)

pub fn name(&self) -> &str

pub fn vector_dim(&self) -> usize

pub fn distance(&self) -> Distance

pub fn use_hnsw(&self) -> bool

pub fn enable_bm25(&self) -> bool

pub fn count(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn get_all_points(&self) -> Vec<Point>

Get all points in the collection

pub fn upsert(&self, point: Point) -> Result<()>

Insert or update a point

pub fn start_batch(&self)

Start batch insert mode

pub fn end_batch(&self) -> Result<()>

End batch insert mode

pub fn batch_upsert(&self, points: Vec<Point>) -> Result<()>

Batch insert multiple points

pub fn batch_upsert_with_prewarm( &self, points: Vec<Point>, prewarm: bool, ) -> Result<()>

Batch insert with optional pre-warming

pub fn get(&self, id: &str) -> Option<Point>

Get a point by ID

pub fn delete(&self, id: &str) -> Result<bool>

Delete a point by ID

pub fn set_payload(&self, id: &str, payload: Value) -> Result<bool>

Set payload values for a point (merge with existing)

pub fn overwrite_payload(&self, id: &str, payload: Value) -> Result<bool>

Overwrite entire payload for a point

pub fn delete_payload_keys(&self, id: &str, keys: &[String]) -> Result<bool>

Delete specific payload keys from a point

pub fn clear_payload(&self, id: &str) -> Result<bool>

Clear all payload from a point

pub fn update_vector(&self, id: &str, vector: Vector) -> Result<bool>

Update vector for a point

pub fn update_multivector( &self, id: &str, multivector: Option<MultiVector>, ) -> Result<bool>

Update multivector for a point

pub fn delete_vector(&self, id: &str) -> Result<bool>

Delete vector (set to empty) - for named vectors this would delete specific vector

pub fn create_payload_index( &self, field_name: &str, index_type: PayloadIndexType, ) -> Result<bool>

Create a payload field index

pub fn delete_payload_index(&self, field_name: &str) -> Result<bool>

Delete a payload field index

pub fn get_payload_indexes(&self) -> HashMap<String, PayloadIndexType>

Get all payload indexes

pub fn is_field_indexed(&self, field_name: &str) -> bool

Check if a field is indexed

pub fn prewarm_index(&self) -> Result<()>

Pre-warm HNSW index

pub fn search( &self, query: &Vector, limit: usize, filter: Option<&dyn Filter>, ) -> Vec<(Point, f32)>

Search for similar vectors Uses brute-force for small datasets (<1000), HNSW for larger ones

pub fn search_text(&self, query: &str, limit: usize) -> Vec<(String, f32)>

BM25 text search

pub fn search_multivector( &self, query: &MultiVector, limit: usize, filter: Option<&dyn Filter>, ) -> Vec<(Point, f32)>

Search using multivector MaxSim scoring (ColBERT-style)

For each sub-vector in the query, finds the maximum similarity with any sub-vector in each document, then sums all maximums.

pub fn iter(&self) -> Vec<Point>

Get all points

pub fn search_sparse( &self, query: &SparseVector, vector_name: &str, limit: usize, filter: Option<&dyn Filter>, ) -> Vec<(Point, f32)>

Search using sparse vectors (dot product on matching indices)