Skip to main content

ExplainPlan

Struct ExplainPlan 

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

ExplainPlan

Stable, deterministic representation of a planned query for observability.

Implementations§

Source§

impl ExplainPlan

Source

pub const fn mode(&self) -> QueryMode

Return query mode projected by this explain plan.

Source

pub const fn access(&self) -> &ExplainAccessPath

Borrow projected access-path shape.

Source

pub const fn access_decision(&self) -> &ExplainAccessDecisionV1

Borrow the structured planner access-decision projection.

Source

pub fn filter_expr(&self) -> Option<&str>

Borrow projected semantic scalar filter expression when present.

Source

pub const fn predicate(&self) -> &ExplainPredicate

Borrow projected predicate shape.

Source

pub const fn order_by(&self) -> &ExplainOrderBy

Borrow projected ORDER BY shape.

Source

pub const fn distinct(&self) -> bool

Return whether DISTINCT is enabled.

Source

pub const fn grouping(&self) -> &ExplainGrouping

Borrow projected grouped-shape metadata.

Source

pub const fn order_pushdown(&self) -> &ExplainOrderPushdown

Borrow projected ORDER pushdown status.

Source

pub const fn page(&self) -> &ExplainPagination

Borrow projected pagination status.

Source

pub const fn delete_limit(&self) -> &ExplainDeleteLimit

Borrow projected delete-limit status.

Source

pub const fn consistency(&self) -> MissingRowPolicy

Return missing-row consistency policy.

Source§

impl ExplainPlan

Source

pub fn render_text_canonical(&self) -> String

Render this logical explain plan as deterministic canonical text.

This surface is frontend-facing and intentionally stable for SQL/CLI explain output and snapshot-style diagnostics.

Source

pub fn render_json_canonical(&self) -> String

Render this logical explain plan as canonical JSON.

Source§

impl ExplainPlan

Source

pub fn fingerprint(&self) -> PlanFingerprint

Compute a stable fingerprint for this explain plan.

Source§

impl ExplainPlan

Source

pub fn continuation_signature( &self, entity_path: &'static str, ) -> ContinuationSignature

Compute the continuation signature for this explain plan.

Included fields:

  • entity path
  • mode (load/delete)
  • access path
  • canonical scalar semantic filter (filter_expr when present, otherwise predicate)
  • canonical order-by (including implicit PK tie-break)
  • distinct flag
  • grouped shape (group keys, aggregate terminals, grouped limits)
  • projection identity section (semantic projection hash when available)

Excluded fields:

  • pagination window (limit, offset)
  • delete limits
  • cursor boundary/token state

Trait Implementations§

Source§

impl Clone for ExplainPlan

Source§

fn clone(&self) -> ExplainPlan

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 ExplainPlan

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ExplainPlan

Source§

impl PartialEq for ExplainPlan

Source§

fn eq(&self, other: &ExplainPlan) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for ExplainPlan

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