pub struct NearestNeighborQueryPlanner {
pub config: PlannerConfig,
}Expand description
Plans k-NN queries over a heterogeneous set of HNSW shards.
Fields§
§config: PlannerConfigPlanner configuration.
Implementations§
Source§impl NearestNeighborQueryPlanner
impl NearestNeighborQueryPlanner
Sourcepub fn new(config: PlannerConfig) -> Self
pub fn new(config: PlannerConfig) -> Self
Create a new planner with the given configuration.
Sourcepub fn plan(
&self,
query_vec: &[f32],
k: usize,
shards: &[ShardInfo],
) -> QueryPlan
pub fn plan( &self, query_vec: &[f32], k: usize, shards: &[ShardInfo], ) -> QueryPlan
Produce an optimised QueryPlan for the given query vector and k.
§Algorithm
- Compute a stable
query_idvia FNV-1a over the query bytes. - Filter shards by latency budget and minimum vector count.
- Optionally sort local shards to the front.
- Limit to
max_fanoutshards. - Choose the execution strategy based on the mix of local/remote shards.
Sourcepub fn explain(&self, plan: &QueryPlan) -> String
pub fn explain(&self, plan: &QueryPlan) -> String
Return a human-readable description of the plan.
Sourcepub fn replan_on_failure(
&self,
plan: &QueryPlan,
failed_peer: &str,
) -> QueryPlan
pub fn replan_on_failure( &self, plan: &QueryPlan, failed_peer: &str, ) -> QueryPlan
Produce a revised plan after failed_peer could not be reached.
All shards owned by failed_peer are removed from the original plan’s
shard list, and the strategy is recomputed from the survivors.
Auto Trait Implementations§
impl Freeze for NearestNeighborQueryPlanner
impl RefUnwindSafe for NearestNeighborQueryPlanner
impl Send for NearestNeighborQueryPlanner
impl Sync for NearestNeighborQueryPlanner
impl Unpin for NearestNeighborQueryPlanner
impl UnsafeUnpin for NearestNeighborQueryPlanner
impl UnwindSafe for NearestNeighborQueryPlanner
Blanket Implementations§
impl<T> Allocation for T
Source§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
Source§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.