Skip to main content

StorageQueryPlanner

Struct StorageQueryPlanner 

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

Production-grade query planner that optimizes storage access patterns.

§Examples

use ipfrs_storage::storage_query_planner::{
    StorageQueryPlanner, SqpPlannerConfig, SqpQuery, SqpPredicate, SqpOp, SqpValue,
};

let planner = StorageQueryPlanner::new(SqpPlannerConfig::default());
let mut query = SqpQuery::new(1);
query.predicates.push(SqpPredicate::new("age", SqpOp::Gt, SqpValue::Int(18)));
let plan = planner.plan(&query);
assert!(plan.estimated_rows > 0);

Implementations§

Source§

impl StorageQueryPlanner

Source

pub fn new(config: SqpPlannerConfig) -> Self

Create a new planner with the given configuration.

Source

pub fn register_index( &self, name: impl Into<String>, cardinality: u64, selectivity: f64, ) -> SqpIndexId

Register a new index and return its assigned SqpIndexId.

If an index with the same name already exists its statistics are updated in place and the existing ID is returned.

Source

pub fn index_stat(&self, id: SqpIndexId) -> Option<SqpIndexStat>

Look up the stat record for a registered index.

Source

pub fn plan(&self, query: &SqpQuery) -> SqpQueryPlan

Generate an optimised plan for query (no caching).

Source

pub fn plan_cached(&self, query: &SqpQuery) -> SqpQueryPlan

Generate or retrieve a cached plan for query.

Source

pub fn invalidate_cache(&self)

Invalidate the entire plan cache.

Source

pub fn invalidate_for_index(&self, id: SqpIndexId)

Remove all cached plans that reference the given index.

Source

pub fn estimate_cost(&self, plan: &SqpQueryPlan) -> f64

Re-estimate the cost of an already-built plan.

This applies the configured cost model independently of plan generation, making it useful for comparing alternative plans.

Source

pub fn explain(&self, plan: &SqpQueryPlan) -> String

Produce a human-readable description of a plan.

Source

pub fn planner_stats(&self) -> SqpPlannerStats

Return aggregate planner statistics.

Source

pub fn recent_history(&self, n: usize) -> Vec<SqpQueryRecord>

Return the most recent N planning records from history.

Trait Implementations§

Source§

impl Default for StorageQueryPlanner

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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<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> 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, 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