Skip to main content

VectorIndexTable

Struct VectorIndexTable 

Source
pub struct VectorIndexTable {
    pub index_id: u64,
    pub name: String,
    pub table_name: String,
    pub column_name: String,
    pub dimensions: u32,
    pub hnsw: HnswIndex,
    /* private fields */
}
Expand description

A persisted vector index that wraps HnswIndex with BufferManager-backed storage.

§Persistence

  • save() serializes the in-memory HNSW index to disk pages
  • load() reads disk pages back into memory
  • flush() writes dirty pages back to the BufferManager

Fields§

§index_id: u64§name: String§table_name: String§column_name: String§dimensions: u32§hnsw: HnswIndex

Implementations§

Source§

impl VectorIndexTable

Source

pub fn new( index_id: u64, name: String, table_name: String, column_name: String, metric: DistanceMetric, dimensions: u32, ) -> Self

Create a new vector index table with the given parameters.

Source

pub fn hnsw(&self) -> &HnswIndex

Get a reference to the underlying HNSW index.

Source

pub fn hnsw_mut(&mut self) -> &mut HnswIndex

Get a mutable reference to the underlying HNSW index.

Source

pub fn metric(&self) -> DistanceMetric

Get the distance metric.

Source

pub fn save(&mut self, bm: &mut BufferManager) -> Result<(), StorageError>

Save the in-memory HNSW index to BufferManager-backed pages.

Writes the header page (page 0) and all data pages. Every vector is stored whole on a single page; a vector that does not fit in one page is an error rather than a silent drop (P52.17).

Source

pub fn load(&mut self, bm: &mut BufferManager) -> Result<(), StorageError>

Load the HNSW index from BufferManager-backed pages.

Reads the header page and exactly num_vectors entries from the data pages, rebuilding the in-memory index. Zeroed page tails (which the page padding leaves behind) are ignored instead of being reconstructed as phantom empty vectors (P52.17). After loading, the index is fully searchable.

Source

pub fn flush(&mut self, bm: &mut BufferManager) -> Result<(), StorageError>

Flush dirty pages to disk via the BufferManager.

Source

pub fn register_file(&self, bm: &mut BufferManager, db_path: &Path)

Register the vector index file with the BufferManager.

Source

pub fn is_dirty(&self) -> bool

Check whether the in-memory state differs from disk.

Trait Implementations§

Source§

impl Clone for VectorIndexTable

Source§

fn clone(&self) -> VectorIndexTable

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 VectorIndexTable

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<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