VecDatabase

Struct VecDatabase 

Source
pub struct VecDatabase { /* private fields */ }
Expand description

Database managing multiple collections

VecDatabase provides a high-level API for managing multiple isolated vector collections. Each collection is backed by a namespace in the underlying NamespaceManager.

§Simple by Default

For simple use cases, just use VecStore::open() directly:

use vecstore::VecStore;
let mut store = VecStore::open("./data")?;

§Powerful When Needed

For multi-collection use cases, use VecDatabase:

use vecstore::VecDatabase;
let mut db = VecDatabase::open("./data")?;
let docs = db.create_collection("documents")?;
let users = db.create_collection("users")?;

Implementations§

Source§

impl VecDatabase

Source

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

Open or create a database at the specified path

§Example
use vecstore::VecDatabase;
let db = VecDatabase::open("./my_database")?;
Source

pub fn create_collection(&mut self, name: &str) -> Result<Collection>

Create a new collection with default configuration

§Arguments
  • name - Collection name (must be unique)
§Example
use vecstore::VecDatabase;
let mut db = VecDatabase::open("./db")?;
let collection = db.create_collection("documents")?;
Source

pub fn create_collection_with_config( &mut self, name: &str, config: CollectionConfig, ) -> Result<Collection>

Create a new collection with custom configuration

§Arguments
  • name - Collection name (must be unique)
  • config - Collection configuration (quotas, distance metric, etc.)
§Example
use vecstore::{VecDatabase, CollectionConfig, Distance};
let mut db = VecDatabase::open("./db")?;
let config = CollectionConfig::default()
    .with_distance(Distance::Manhattan)
    .with_max_vectors(100_000);
let collection = db.create_collection_with_config("documents", config)?;
Source

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

Get an existing collection

Returns None if the collection doesn’t exist.

§Example
use vecstore::VecDatabase;
let db = VecDatabase::open("./db")?;
if let Some(collection) = db.get_collection("documents")? {
    // Use collection
}
Source

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

List all collections in the database

§Example
use vecstore::VecDatabase;
let db = VecDatabase::open("./db")?;
let collections = db.list_collections()?;
for name in collections {
    println!("Collection: {}", name);
}
Source

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

Delete a collection

This permanently deletes the collection and all its data.

§Example
use vecstore::VecDatabase;
let mut db = VecDatabase::open("./db")?;
db.delete_collection("old_documents")?;
Source

pub fn collection_names(&self) -> Result<Vec<String>>

Get statistics for all collections

§Example
use vecstore::VecDatabase;
let db = VecDatabase::open("./db")?;
let collection_names = db.list_collections()?;
for name in collection_names {
    if let Some(coll) = db.get_collection(&name)? {
        let stats = coll.stats()?;
        println!("{}: {} vectors", name, stats.vector_count);
    }
}

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more