Struct CollectionVectorStore 

pub struct CollectionVectorStore<E: StorageEngine> { /* private fields */ }

Vector storage for collections.

Provides CRUD operations for vectors stored separately from entities. This enables efficient vector access without loading entity data, and supports multiple named vectors per entity.

Implementations

impl<E: StorageEngine> CollectionVectorStore<E>

pub const fn new(engine: E) -> Self

Create a new collection vector store.

pub fn put_vector( &self, collection_id: CollectionId, entity_id: EntityId, vector_name: &str, data: &VectorData, ) -> Result<(), VectorError>

Store a vector for an entity.

Errors

Returns an error if the storage operation fails.

pub fn put_vector_tx<T: Transaction>( &self, tx: &mut T, collection_id: CollectionId, entity_id: EntityId, vector_name: &str, data: &VectorData, ) -> Result<(), VectorError>

Store a vector within a transaction.

Use this method when you need to store vectors as part of a larger atomic operation (e.g., upserting an entity with vectors).

Errors

Returns an error if the storage operation fails.

pub fn get_vector( &self, collection_id: CollectionId, entity_id: EntityId, vector_name: &str, ) -> Result<Option<VectorData>, VectorError>

Get a vector for an entity.

Errors

Returns an error if the storage operation fails.

pub fn get_all_vectors( &self, collection_id: CollectionId, entity_id: EntityId, ) -> Result<HashMap<String, VectorData>, VectorError>

Get all vectors for an entity.

Returns a map of vector names to their data.

Errors

Returns an error if the storage operation fails.

pub fn delete_vector( &self, collection_id: CollectionId, entity_id: EntityId, vector_name: &str, ) -> Result<bool, VectorError>

Delete a specific vector.

Returns

Returns Ok(true) if the vector was deleted, Ok(false) if it didn’t exist.

Errors

Returns an error if the storage operation fails.

pub fn delete_all_vectors( &self, collection_id: CollectionId, entity_id: EntityId, ) -> Result<usize, VectorError>

Delete all vectors for an entity.

This is called when an entity is deleted to cascade-delete its vectors.

Returns

Returns the number of vectors deleted.

Errors

Returns an error if the storage operation fails.

pub fn delete_all_vectors_tx<T: Transaction>( &self, tx: &mut T, collection_id: CollectionId, entity_id: EntityId, ) -> Result<usize, VectorError>

Delete all vectors for an entity within a transaction.

Use this method when you need to delete vectors as part of a larger atomic operation (e.g., deleting an entity with its vectors).

Returns

Returns the number of vectors deleted.

Errors

Returns an error if the storage operation fails.

pub fn put_vectors_batch( &self, collection_id: CollectionId, vectors: &[(EntityId, &str, &VectorData)], ) -> Result<(), VectorError>

Store multiple vectors at once.

This is more efficient than calling put_vector multiple times as it uses a single transaction.

Errors

Returns an error if the storage operation fails.

pub fn exists( &self, collection_id: CollectionId, entity_id: EntityId, vector_name: &str, ) -> Result<bool, VectorError>

Check if a vector exists for an entity.

Errors

Returns an error if the storage operation fails.

pub fn count_entity_vectors( &self, collection_id: CollectionId, entity_id: EntityId, ) -> Result<usize, VectorError>

Count the number of vectors for an entity.

Errors

Returns an error if the storage operation fails.

pub fn list_entities_with_vector( &self, collection_id: CollectionId, vector_name: &str, ) -> Result<Vec<EntityId>, VectorError>

List all entity IDs that have vectors with a specific name in a collection.

Note: This is an expensive operation as it requires scanning all vectors in the collection. Use with caution on large collections.

Errors

Returns an error if the storage operation fails.