Struct ShardedSparseHandle 

pub struct ShardedSparseHandle { /* private fields */ }

Implementations

impl ShardedSparseHandle

pub fn create( base_path: &str, config: &ShardedSparseConfig, ) -> Result<Self, String>

Create a new sharded index on a filesystem directory.

pub fn open(base_path: &str) -> Result<Self, String>

Open an existing sharded index from a filesystem directory.

pub fn create_with_store<S: BlobStore>( store: Arc<S>, name: &str, cache_base: &Path, config: &ShardedSparseConfig, ) -> Result<Self, String>

Create a new sharded index whose truth is a blob store; cache_base holds the disposable local mmap cache.

pub fn open_with_store<S: BlobStore>( store: Arc<S>, name: &str, cache_base: &Path, ) -> Result<Self, String>

Open an existing sharded index from a blob store.

pub fn create_with_storage( storage: Box<dyn SparseShardStorage>, config: &ShardedSparseConfig, ) -> Result<Self, String>

pub fn open_with_storage( storage: Box<dyn SparseShardStorage>, ) -> Result<Self, String>

pub fn num_shards(&self) -> usize

pub fn config(&self) -> &ShardedSparseConfig

pub fn len(&self) -> usize

Number of vectors across shards, as of the last commit of each.

pub fn is_empty(&self) -> bool

pub fn shard_for_node_id(&self, node_id: u64) -> Option<usize>

Shard holding node_id, if the router saw it inserted.

pub fn insert(&self, node_id: u64, vector: &SparseVector) -> Result<(), String>

Route the vector to a shard by its dimensions and queue the insert. Failures inside the shard surface at the next commit().

pub fn remove(&self, node_id: u64) -> Result<bool, String>

Remove a vector. Returns whether it existed.

pub fn commit(&self) -> Result<(), String>

Persist every shard and the router. Reports the first insert error of each shard since its last commit.

pub fn search( &self, query: &SparseVector, limit: usize, ) -> Result<Vec<(u64, f32)>, String>

Top-limit by dot product across all shards.

pub fn search_filtered( &self, query: &SparseVector, limit: usize, allowed_ids: &[u64], ) -> Result<Vec<(u64, f32)>, String>

search restricted to allowed_ids.

pub fn close(&self) -> Result<(), String>

Commit, stop the shard actors, make the handle inert.

pub fn drop_index(self) -> Result<(), String>

Close, then destroy the storage (shards and root files).