Struct ExplainPlan 

pub struct ExplainPlan { /* private fields */ }

ExplainPlan

Stable, deterministic representation of a planned query for observability.

Implementations

impl ExplainPlan

pub const fn mode(&self) -> QueryMode

Return query mode projected by this explain plan.

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

Borrow projected access-path shape.

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

Borrow the structured planner access-decision projection.

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

Borrow projected semantic scalar filter expression when present.

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

Borrow projected predicate shape.

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

Borrow projected ORDER BY shape.

pub const fn distinct(&self) -> bool

Return whether DISTINCT is enabled.

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

Borrow projected grouped-shape metadata.

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

Borrow projected ORDER pushdown status.

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

Borrow projected pagination status.

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

Borrow projected delete-limit status.

pub const fn consistency(&self) -> MissingRowPolicy

Return missing-row consistency policy.

impl ExplainPlan

pub fn render_text_canonical(&self) -> Result<String, QueryError>

Render this logical explain plan as deterministic canonical text.

Output is limited to 1 MiB of UTF-8 bytes per call. Limit or formatter failure returns an error, never partial text. This detached operation does not charge a session, bound prior planning, or redact values. Access operands and predicate/HAVING trees are summarized, not dumped. Existing clause labels can still contain literal values.

pub fn render_json_canonical(&self) -> Result<String, QueryError>

Render this logical explain plan as canonical JSON.

Output is limited to 1 MiB of UTF-8 bytes, including JSON escaping. Failure returns no partial JSON. This detached operation does not charge a session, bound prior planning, or redact values. Access operands and predicate/HAVING trees are summarized, not dumped. Existing clause labels can still contain literal values.

Trait Implementations

impl Clone for ExplainPlan

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ExplainPlan

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

Formats the value using the given formatter.

impl Eq for ExplainPlan

impl PartialEq for ExplainPlan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ExplainPlan