Struct VelesDatabase 

pub struct VelesDatabase { /* private fields */ }

VelesDB database instance.

Thread-safe handle to a VelesDB database. Can be shared across threads.

Implementations

impl VelesDatabase

pub fn open(path: String) -> Result<Arc<Self>, VelesError>

Opens or creates a database at the specified path.

Arguments

• path - Path to the database directory (will be created if needed)

Errors

Returns an error if the path is invalid or cannot be accessed.

pub fn create_collection( &self, name: String, dimension: u32, metric: DistanceMetric, ) -> Result<(), VelesError>

Creates a new collection with the specified parameters.

Arguments

• name - Unique name for the collection
• dimension - Vector dimension (e.g., 384, 768, 1536)
• metric - Distance metric for similarity calculations

pub fn create_collection_with_storage( &self, name: String, dimension: u32, metric: DistanceMetric, storage_mode: StorageMode, ) -> Result<(), VelesError>

Creates a new collection with custom storage mode for IoT/Edge devices.

Arguments

• name - Unique name for the collection
• dimension - Vector dimension
• metric - Distance metric
• storage_mode - Storage optimization (Full, Sq8, Binary)

Storage Modes

• Full: Best recall, 4 bytes/dimension
• Sq8: 4x compression, ~1% recall loss (recommended for mobile)
• Binary: 32x compression, ~5-10% recall loss (for extreme constraints)

pub fn create_metadata_collection(&self, name: String) -> Result<(), VelesError>

Creates a metadata-only collection (no vectors).

Useful for storing reference data, lookups, or auxiliary information that doesn’t require vector similarity search.

Arguments

• name - Unique name for the collection

pub fn get_collection( &self, name: String, ) -> Result<Option<Arc<VelesCollection>>, VelesError>

Gets a collection by name.

Returns None if the collection does not exist. Checks vector, metadata, and graph registries in order.

pub fn list_collections(&self) -> Vec<String>

Lists all collection names.

pub fn delete_collection(&self, name: String) -> Result<(), VelesError>

Deletes a collection by name.

pub fn train_pq( &self, collection_name: String, config: PqTrainConfig, ) -> Result<String, VelesError>

Trains a Product Quantizer on a collection.

PQ training is a database-level operation that requires access to the VelesQL TRAIN executor.

Arguments

• collection_name - Name of the collection to train PQ on
• config - PQ training configuration

Returns

Status message from the training process.

Trait Implementations

impl<UT> LiftRef<UT> for VelesDatabase

type LiftType = Arc<VelesDatabase>

impl<UT> LowerError<UT> for VelesDatabase

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for VelesDatabase

type ReturnType = <Arc<VelesDatabase> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for VelesDatabase

const TYPE_ID_META: MetadataBuffer