Struct OmenFile 

pub struct OmenFile { /* private fields */ }

OmenFile - single-file vector database

Storage layer for vectors, metadata, and serialized HNSW index. Graph traversal is handled by HNSWIndex in the vector layer.

Implementations

impl OmenFile

pub fn compute_omen_path(path: &Path) -> PathBuf

Compute .omen path by appending extension (preserves full filename)

Handles filenames with multiple dots (e.g., test.db_64 → test.db_64.omen) by appending .omen rather than replacing the extension.

pub fn create(path: impl AsRef<Path>, dimensions: u32) -> Result<Self>

Create a new .omen database

pub fn open(path: impl AsRef<Path>) -> Result<Self>

Open an existing .omen database

pub fn insert( &mut self, id: &str, vector: &[f32], metadata: Option<&[u8]>, ) -> Result<()>

Insert a vector

Note: Graph management (HNSW) is handled by HNSWIndex in the vector layer. This method only handles storage: WAL, vectors, metadata.

pub fn search(&self, query: &[f32], k: usize) -> Vec<(String, f32)>

Search for k nearest neighbors

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

Delete a vector by ID

pub fn len(&self) -> u64

Get vector count

pub fn is_empty(&self) -> bool

Check if empty

pub fn dimensions(&self) -> u32

Get dimensions

pub fn checkpoint(&mut self) -> Result<()>

Checkpoint - compact WAL into main file

impl OmenFile

pub fn put_vector(&mut self, id: usize, vector: &[f32]) -> Result<()>

Store a vector by internal index

pub fn get_vector(&self, id: usize) -> Result<Option<Vec<f32>>>

Get a vector by internal index

pub fn put_metadata(&mut self, id: usize, metadata: &JsonValue) -> Result<()>

Store metadata for a vector (as JSON)

pub fn get_metadata(&self, id: usize) -> Result<Option<JsonValue>>

Get metadata for a vector (as JSON)

pub fn put_id_mapping(&mut self, string_id: &str, index: usize) -> Result<()>

Store string ID to internal index mapping

pub fn get_id_mapping(&self, string_id: &str) -> Result<Option<usize>>

Get internal index for a string ID

pub fn get_string_id(&self, index: usize) -> Result<Option<String>>

Get string ID for an internal index (reverse lookup)

pub fn delete_id_mapping(&mut self, string_id: &str) -> Result<()>

Delete string ID mapping

pub fn put_config(&mut self, key: &str, value: u64) -> Result<()>

Store configuration value

pub fn get_config(&self, key: &str) -> Result<Option<u64>>

Get configuration value

pub fn load_all_vectors(&self) -> Result<Vec<(usize, Vec<f32>)>>

Load all vectors from storage

pub fn increment_count(&mut self) -> Result<usize>

Increment vector count in storage

pub fn get_count(&self) -> Result<usize>

Get current vector count

pub fn put_quantization_mode(&mut self, mode: u64) -> Result<()>

Store quantization mode

Mode values: 0=none, 1=sq8, 2=rabitq-4, 3=rabitq-2, 4=rabitq-8

pub fn get_quantization_mode(&self) -> Result<Option<u64>>

Get quantization mode

Returns: 0=none, 1=sq8, 2=rabitq-4, 3=rabitq-2, 4=rabitq-8

pub fn is_quantized(&self) -> Result<bool>

Check if store was created with quantization

pub fn load_all_metadata(&self) -> Result<HashMap<usize, JsonValue>>

Load all metadata from storage

pub fn load_all_id_mappings(&self) -> Result<HashMap<String, usize>>

Load all ID mappings from storage

pub fn put_deleted(&mut self, id: usize) -> Result<()>

Mark a vector as deleted (tombstone)

pub fn is_deleted(&self, id: usize) -> Result<bool>

Check if a vector is deleted

pub fn remove_deleted(&mut self, id: usize) -> Result<()>

Remove deleted marker (for re-insertion)

pub fn load_all_deleted(&self) -> Result<HashMap<usize, bool>>

Load all deleted IDs from storage

pub fn put_hnsw_index(&mut self, bytes: Vec<u8>)

Store serialized HNSW index bytes

The bytes are persisted on the next checkpoint/flush. VectorStore serializes HNSWIndex and stores it here.

pub fn get_hnsw_index(&self) -> Option<&[u8]>

Get serialized HNSW index bytes (if present)

Returns the bytes previously stored by put_hnsw_index(), or loaded from disk on open.

pub fn has_hnsw_index(&self) -> bool

Check if HNSW index is stored

pub fn set_hnsw_params(&mut self, m: u16, ef_construction: u16, ef_search: u16)

Update HNSW parameters in the header

These values are persisted to disk on the next checkpoint/flush.

pub fn path(&self) -> &Path

Get storage path

pub fn header(&self) -> &OmenHeader

Get reference to the header

pub fn flush(&mut self) -> Result<()>

Flush all pending writes to disk

pub fn put_batch( &mut self, items: Vec<(usize, String, Vec<f32>, JsonValue)>, ) -> Result<()>

Batch set vectors with metadata and ID mappings