Struct Database 

pub struct Database { /* private fields */ }

Database instance managing collections and storage.

Implementations

impl Database

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

Opens or creates a database at the specified path.

Arguments

• path - Path to the data directory

Errors

Returns an error if the directory cannot be created or accessed.

pub fn create_collection( &self, name: &str, dimension: usize, metric: DistanceMetric, ) -> Result<()>

Creates a new collection with the specified parameters.

Arguments

• name - Unique name for the collection
• dimension - Vector dimension (e.g., 768 for many embedding models)
• metric - Distance metric to use for similarity calculations

Errors

Returns an error if a collection with the same name already exists.

pub fn create_collection_with_options( &self, name: &str, dimension: usize, metric: DistanceMetric, storage_mode: StorageMode, ) -> Result<()>

Creates a new collection with custom storage options.

Arguments

• name - Unique name for the collection
• dimension - Vector dimension
• metric - Distance metric
• storage_mode - Vector storage mode (Full, SQ8, Binary)

Errors

Returns an error if a collection with the same name already exists.

pub fn get_collection(&self, name: &str) -> Option<Collection>

Gets a reference to a collection by name.

Arguments

• name - Name of the collection

Returns

Returns None if the collection does not exist.

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

Lists all collection names in the database.

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

Deletes a collection by name.

Arguments

• name - Name of the collection to delete

Errors

Returns an error if the collection does not exist.

pub fn create_collection_typed( &self, name: &str, collection_type: &CollectionType, ) -> Result<()>

Creates a new collection with a specific type (Vector or MetadataOnly).

Arguments

• name - Unique name for the collection
• collection_type - Type of collection to create

Errors

Returns an error if a collection with the same name already exists.

Examples

use velesdb_core::{Database, CollectionType, DistanceMetric, StorageMode};

let db = Database::open("./data")?;

// Create a metadata-only collection
db.create_collection_typed("products", CollectionType::MetadataOnly)?;

// Create a vector collection
db.create_collection_typed("embeddings", CollectionType::Vector {
    dimension: 768,
    metric: DistanceMetric::Cosine,
    storage_mode: StorageMode::Full,
})?;

pub fn load_collections(&self) -> Result<()>

Loads existing collections from disk.

Call this after opening a database to load previously created collections.

Errors

Returns an error if collection directories cannot be read.