Struct ExplainResult 

pub struct ExplainResult {
    pub plan: PlanNode,
    pub format: ExplainFormat,
}

Result of EXPLAIN operation

Fields

plan: PlanNode

Root node of the execution plan

format: ExplainFormat

Output format

Implementations

impl ExplainResult

pub fn to_text(&self) -> String

Format the plan as text output (PostgreSQL-style)

pub fn to_json(&self) -> String

Format the plan as JSON output

pub fn to_sqlite_eqp(&self) -> String

Format the plan as SQLite-compatible EXPLAIN QUERY PLAN output

Produces output like:

QUERY PLAN
|--SCAN t1 USING INDEX i1
`--USE TEMP B-TREE FOR LAST TERM OF ORDER BY

For compound queries:

QUERY PLAN
`--COMPOUND QUERY
   |--LEFT-MOST SUBQUERY
   |  `--SCAN t1
   `--UNION ALL
      `--SCAN t2

The “QUERY PLAN” header is included to match SQLite’s EQP format used in TCL tests with full format comparison (do_eqp_test with QUERY PLAN prefix).

pub fn to_sqlite_vm(&self) -> SqliteVmOutput

Format the plan as SQLite-compatible EXPLAIN output (VM bytecode style)

This produces output mimicking SQLite’s VDBE bytecode format:

addr  opcode         p1    p2    p3    p4             p5  comment
----  -------------  ----  ----  ----  -------------  --  -------------
0     Init           0     8     0                    0   Start at 8
1     OpenRead       0     2     0     2              0   root=2 iDb=0; t1
...

Note: This is a synthetic representation since VibeSQL doesn’t use SQLite’s VM. The opcodes are generated to approximate what SQLite would produce.

Trait Implementations

impl Debug for ExplainResult

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

Formats the value using the given formatter.