Struct flechasdb::db::stored::Database

pub struct Database<T, FS> { /* private fields */ }

Stored database.

Implementations

impl<T, FS> Database<T, FS>where FS: FileSystem,

pub fn vector_size(&self) -> usize

Returns the vector size.

pub fn num_partitions(&self) -> usize

Returns the number of partitions.

pub fn num_divisions(&self) -> usize

Returns the number of subvector divisions.

pub fn num_codes(&self) -> usize

Returns the number of codes in each codebook.

pub fn subvector_size(&self) -> usize

Returns the subvector size.

pub fn get_partition_id(&self, index: usize) -> Option<&String>

Returns the ID of a partition.

None if index ≥ num_partitions.

pub fn get_codebook_id(&self, index: usize) -> Option<&String>

Returns a code vector in a specified division.

None if index ≥ num_divisons.

impl<T, FS> Database<T, FS>where FS: FileSystem, Self: LoadPartition<T>,

pub fn get_attribute<K>( &self, vector_id: &Uuid, key: &K ) -> Result<Option<AttributeValueRef<'_>>, Error>where String: Borrow<K>, K: Hash + Eq + ?Sized,

Returns an attribute value of a given vector.

The first call to this function will take longer because it loads all the attributes. If you want to get attributes of your query results, please use QueryResult::get_attribute instead.

None if the vector exists but no value is associated with key.

Fails if no vector is associated with vector_id.

impl<T, FS> Database<T, FS>where T: Scalar, FS: FileSystem, Self: LoadPartition<T> + LoadCodebook<T> + LoadPartitionCentroids<T>,

pub fn query<'a, V>( &'a self, v: &V, k: NonZeroUsize, nprobe: NonZeroUsize ) -> Result<Vec<QueryResult<'a, T, FS>>, Error>where V: AsSlice<T> + ?Sized,

Queries k-nearest neighbors (k-NN) of a given vector.

The first call to this function will take longer because it lazily loads partition centroids, and codebooks.

pub fn query_with_events<'a, V, EventHandler>( &'a self, v: &V, k: NonZeroUsize, nprobe: NonZeroUsize, event: EventHandler ) -> Result<Vec<QueryResult<'a, T, FS>>, Error>where V: AsSlice<T> + ?Sized, EventHandler: FnMut(QueryEvent),

Queries k-nearest neighbors (k-NN) of a given vector.

The first call to this function will take longer because it lazily loads partition centroids, and codebooks.

Trait Implementations

impl<FS> LoadCodebook<f32> for Database<f32, FS>where FS: FileSystem,

fn load_codebook(&self, index: usize) -> Result<BlockVectorSet<f32>, Error>where FS: FileSystem,

Loads a codebook.

Fails if:

• index exceeds the number of codebooks.
• codebook file cannot be loaded.
• vector size does not match the subvector size of the database.
• number of vectors does not match that of the database.

impl<FS> LoadDatabase<f32, FS> for Database<f32, FS>where FS: FileSystem,

fn load_database<P>(fs: FS, path: P) -> Result<Database<f32, FS>, Error>where P: AsRef<str>,

Loads a database.

Fails if:

• vector_size is zero
• num_divisions is zero
• num_partitions is zero
• num_codes is zero
• vector_size is not a multiple of num_divisions
• num_partitions and partitions_refs.len() do not match
• vector_size and centroid size do not match
• num_divisions and codebook_refs.len() do not match

impl<FS> LoadPartition<f32> for Database<f32, FS>where FS: FileSystem,

fn load_partition(&self, index: usize) -> Result<Partition<f32>, Error>

Loads a partition.

Loads a Protocol Buffers message (p) from the file system.

Fails if:

• index exceeds the number of partitions.
• self.vector_size and p.vector_size do not match
• self.num_divisions and p.num_divisions do not match
• p.num_vectors and p.encoded_vectors.len() do not match
• p.num_vectors and p.vector_ids.len() do not match
• p.num_divisions and encoded vector length do not match

impl<FS> LoadPartitionCentroids<f32> for Database<f32, FS>where FS: FileSystem,

fn load_partition_centroids(&self) -> Result<BlockVectorSet<f32>, Error>

Loads partition centroids.