Struct LocalIndex 

pub struct LocalIndex { /* private fields */ }

Main LocalIndex implementation with full Node.js API compatibility

Implementations

impl LocalIndex

pub fn with_storage( folder_path: impl AsRef<Path>, index_name: Option<String>, storage: Box<dyn StorageBackend>, ) -> Result<Self>

Creates a new LocalIndex instance with a provided storage backend

pub fn new<P: AsRef<Path>>( folder_path: P, index_name: Option<String>, ) -> Result<Self>

Creates a new LocalIndex instance (legacy API, requires storage dependency) This will be deprecated - use with_storage instead

pub async fn create_index( &self, config: Option<CreateIndexConfig>, ) -> Result<()>

Creates an index with optional configuration

pub async fn is_index_created(&self) -> bool

Checks if index exists

pub async fn insert_item( &self, item: impl Into<VectorItem>, ) -> Result<VectorItem>

Inserts a new item

pub async fn update_item(&self, update: UpdateRequest) -> Result<UpdateResult>

Updates an existing item (partial update)

pub async fn upsert_item( &self, item: impl Into<VectorItem>, ) -> Result<VectorItem>

Upserts an item (insert or update)

pub async fn get_item(&self, id: &Uuid) -> Result<Option<VectorItem>>

Gets an item by ID

pub async fn delete_item(&self, id: &Uuid) -> Result<()>

Deletes an item

pub async fn list_items( &self, options: Option<ListOptions>, ) -> Result<Vec<VectorItem>>

Lists all items with optional pagination

pub async fn query_items( &self, vector: Vec<f32>, top_k: Option<u32>, filter: Option<Value>, ) -> Result<Vec<QueryResult>>

Query items - maintains Node.js signature compatibility

pub async fn query_items_extended( &self, vector: Vec<f32>, text_query: Option<String>, top_k: Option<u32>, filter: Option<Value>, ) -> Result<Vec<QueryResult>>

Extended query with text search

pub async fn begin_update(&self) -> Result<()>

Begins an update transaction

pub async fn end_update(&self) -> Result<()>

Ends an update transaction

pub async fn cancel_update(&self) -> Result<()>

Cancels an update transaction (now async for safety)

pub async fn delete_index(&self) -> Result<()>

Deletes the entire index

pub async fn get_stats(&self) -> Result<IndexStats>

Gets index statistics