Skip to main content

Db

Struct Db 

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

A vecdb database: a handle to a directory that holds one or more collections. Cheap to clone-by-reopen; owns no file handles itself — each Collection it hands out owns its own storage.

Implementations§

Source§

impl Db

Source

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

Open (creating if absent) a database rooted at path.

path is a directory. A .vecdb suffix is conventional but not required — the directory holds the per-collection files.

Source

pub fn path(&self) -> &Path

Root directory of this database.

Source

pub fn create_collection( &self, name: impl Into<String>, dimension: usize, ) -> Result<Collection>

Create a new collection with default HNSW config. Errors if a collection of that name already exists.

Source

pub fn create_collection_with( &self, config: CollectionConfig, ) -> Result<Collection>

Create a new collection from a full CollectionConfig.

Source

pub fn create_collection_quantized( &self, name: impl Into<String>, dimension: usize, ) -> Result<Collection>

Create a new collection whose in-memory index uses int8 scalar quantization (~4× smaller index; on-disk vectors stay float32).

Source

pub fn create_collection_binary( &self, name: impl Into<String>, dimension: usize, ) -> Result<Collection>

Create a new collection whose in-memory index uses 1-bit binary quantization (~32× smaller; coarse Hamming distance — best paired with a full-precision rerank of top candidates).

Source

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

Open an existing collection. Errors with CollectionNotFound if absent.

Source

pub fn open_or_create(&self, name: &str, dimension: usize) -> Result<Collection>

Open the collection if it exists, otherwise create it with default HNSW config at dimension.

Source

pub fn collection_exists(&self, name: &str) -> bool

Whether a collection with this name exists on disk (by its .db file).

Source

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

Sorted names of all collections in this database (scans *.db files).

Source

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

Delete a collection and all its files from disk.

Trait Implementations§

Source§

impl Clone for Db

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Db

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Db

§

impl RefUnwindSafe for Db

§

impl Send for Db

§

impl Sync for Db

§

impl Unpin for Db

§

impl UnsafeUnpin for Db

§

impl UnwindSafe for Db

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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