Skip to main content

VectorDB

Struct VectorDB 

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

Main VectorDB class for browser usage

Implementations§

Source§

impl VectorDB

Source

pub fn new( dimensions: usize, metric: Option<String>, use_hnsw: Option<bool>, ) -> Result<VectorDB, JsValue>

Create a new VectorDB instance

§Arguments
  • dimensions - Vector dimensions
  • metric - Distance metric (“euclidean”, “cosine”, “dotproduct”, “manhattan”)
  • use_hnsw - Whether to use HNSW index for faster search
Source

pub fn insert( &self, vector: Float32Array, id: Option<String>, metadata: Option<JsValue>, ) -> Result<String, JsValue>

Insert a single vector

§Arguments
  • vector - Float32Array of vector data
  • id - Optional ID (auto-generated if not provided)
  • metadata - Optional metadata object
§Returns

The vector ID

Source

pub fn insert_batch(&self, entries: JsValue) -> Result<Vec<String>, JsValue>

Insert multiple vectors in a batch (more efficient)

§Arguments
  • entries - Array of VectorEntry objects
§Returns

Array of vector IDs

Source

pub fn search( &self, query: Float32Array, k: usize, filter: Option<JsValue>, ) -> Result<Vec<JsSearchResult>, JsValue>

Search for similar vectors

§Arguments
  • query - Query vector as Float32Array
  • k - Number of results to return
  • filter - Optional metadata filter object
§Returns

Array of search results

Source

pub fn delete(&self, id: &str) -> Result<bool, JsValue>

Delete a vector by ID

§Arguments
  • id - Vector ID to delete
§Returns

True if deleted, false if not found

Source

pub fn get(&self, id: &str) -> Result<Option<JsVectorEntry>, JsValue>

Get a vector by ID

§Arguments
  • id - Vector ID
§Returns

VectorEntry or null if not found

Source

pub fn len(&self) -> Result<usize, JsValue>

Get the number of vectors in the database

Source

pub fn is_empty(&self) -> Result<bool, JsValue>

Check if the database is empty

Source

pub fn dimensions(&self) -> usize

Get database dimensions

Source

pub fn save_to_indexed_db(&self) -> Result<Promise, JsValue>

Save database to IndexedDB Returns a Promise that resolves when save is complete

Source

pub fn load_from_indexed_db(db_name: String) -> Result<Promise, JsValue>

Load database from IndexedDB Returns a Promise that resolves with the VectorDB instance

Trait Implementations§

Source§

impl From<VectorDB> for JsValue

Source§

fn from(value: VectorDB) -> Self

Converts to this type from the input type.
Source§

impl FromWasmAbi for VectorDB

Source§

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.
Source§

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi. Read more
Source§

impl IntoWasmAbi for VectorDB

Source§

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.
Source§

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.
Source§

impl LongRefFromWasmAbi for VectorDB

Source§

type Abi = u32

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRef<VectorDB>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl OptionFromWasmAbi for VectorDB

Source§

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.
Source§

impl OptionIntoWasmAbi for VectorDB

Source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
Source§

impl RefFromWasmAbi for VectorDB

Source§

type Abi = u32

The Wasm ABI type references to Self are recovered from.
Source§

type Anchor = RcRef<VectorDB>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.
Source§

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi. Read more
Source§

impl RefMutFromWasmAbi for VectorDB

Source§

type Abi = u32

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRefMut<VectorDB>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl SupportsConstructor for VectorDB

Source§

impl SupportsInstanceProperty for VectorDB

Source§

impl SupportsStaticProperty for VectorDB

Source§

impl TryFromJsValue for VectorDB

Source§

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.
Source§

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.
Source§

impl VectorFromWasmAbi for VectorDB

Source§

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

Source§

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[VectorDB]>

Source§

impl VectorIntoWasmAbi for VectorDB

Source§

impl WasmDescribe for VectorDB

Source§

impl WasmDescribeVector for VectorDB

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> ReturnWasmAbi for T
where T: IntoWasmAbi,

Source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
Source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
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