Enum SqlPlan 

pub enum SqlPlan {
    ConstantResult {
        columns: Vec<String>,
        values: Vec<SqlValue>,
    },
    Scan {
        collection: String,
        alias: Option<String>,
        engine: EngineType,
        filters: Vec<Filter>,
        projection: Vec<Projection>,
        sort_keys: Vec<SortKey>,
        limit: Option<usize>,
        offset: usize,
        distinct: bool,
        window_functions: Vec<WindowSpec>,
    },
    PointGet {
        collection: String,
        alias: Option<String>,
        engine: EngineType,
        key_column: String,
        key_value: SqlValue,
    },
    DocumentIndexLookup {

        collection: String,
        alias: Option<String>,
        engine: EngineType,
        field: String,
        value: SqlValue,
        filters: Vec<Filter>,
        projection: Vec<Projection>,
        sort_keys: Vec<SortKey>,
        limit: Option<usize>,
        offset: usize,
        distinct: bool,
        window_functions: Vec<WindowSpec>,
        case_insensitive: bool,
    
},
    RangeScan {
        collection: String,
        field: String,
        lower: Option<SqlValue>,
        upper: Option<SqlValue>,
        limit: usize,
    },
    Insert {
        collection: String,
        engine: EngineType,
        rows: Vec<Vec<(String, SqlValue)>>,
        column_defaults: Vec<(String, String)>,
    },
    KvInsert {
        collection: String,
        entries: Vec<(SqlValue, Vec<(String, SqlValue)>)>,
        ttl_secs: u64,
    },
    Upsert {
        collection: String,
        engine: EngineType,
        rows: Vec<Vec<(String, SqlValue)>>,
        column_defaults: Vec<(String, String)>,
        on_conflict_updates: Vec<(String, SqlExpr)>,
    },
    InsertSelect {
        target: String,
        source: Box<SqlPlan>,
        limit: usize,
    },
    Update {
        collection: String,
        engine: EngineType,
        assignments: Vec<(String, SqlExpr)>,
        filters: Vec<Filter>,
        target_keys: Vec<SqlValue>,
        returning: bool,
    },
    Delete {
        collection: String,
        engine: EngineType,
        filters: Vec<Filter>,
        target_keys: Vec<SqlValue>,
    },
    Truncate {
        collection: String,
        restart_identity: bool,
    },
    Join {
        left: Box<SqlPlan>,
        right: Box<SqlPlan>,
        on: Vec<(String, String)>,
        join_type: JoinType,
        condition: Option<SqlExpr>,
        limit: usize,
        projection: Vec<Projection>,
        filters: Vec<Filter>,
    },
    Aggregate {
        input: Box<SqlPlan>,
        group_by: Vec<SqlExpr>,
        aggregates: Vec<AggregateExpr>,
        having: Vec<Filter>,
        limit: usize,
    },
    TimeseriesScan {
        collection: String,
        time_range: (i64, i64),
        bucket_interval_ms: i64,
        group_by: Vec<String>,
        aggregates: Vec<AggregateExpr>,
        filters: Vec<Filter>,
        projection: Vec<Projection>,
        gap_fill: String,
        limit: usize,
        tiered: bool,
    },
    TimeseriesIngest {
        collection: String,
        rows: Vec<Vec<(String, SqlValue)>>,
    },
    VectorSearch {
        collection: String,
        field: String,
        query_vector: Vec<f32>,
        top_k: usize,
        ef_search: usize,
        filters: Vec<Filter>,
    },
    MultiVectorSearch {
        collection: String,
        query_vector: Vec<f32>,
        top_k: usize,
        ef_search: usize,
    },
    TextSearch {
        collection: String,
        query: String,
        top_k: usize,
        fuzzy: bool,
        filters: Vec<Filter>,
    },
    HybridSearch {
        collection: String,
        query_vector: Vec<f32>,
        query_text: String,
        top_k: usize,
        ef_search: usize,
        vector_weight: f32,
        fuzzy: bool,
    },
    SpatialScan {
        collection: String,
        field: String,
        predicate: SpatialPredicate,
        query_geometry: Vec<u8>,
        distance_meters: f64,
        attribute_filters: Vec<Filter>,
        limit: usize,
        projection: Vec<Projection>,
    },
    Union {
        inputs: Vec<SqlPlan>,
        distinct: bool,
    },
    Intersect {
        left: Box<SqlPlan>,
        right: Box<SqlPlan>,
        all: bool,
    },
    Except {
        left: Box<SqlPlan>,
        right: Box<SqlPlan>,
        all: bool,
    },
    RecursiveScan {
        collection: String,
        base_filters: Vec<Filter>,
        recursive_filters: Vec<Filter>,
        join_link: Option<(String, String)>,
        max_iterations: usize,
        distinct: bool,
        limit: usize,
    },
    Cte {
        definitions: Vec<(String, SqlPlan)>,
        outer: Box<SqlPlan>,
    },
}

The top-level plan produced by the SQL planner.

Variants

ConstantResult

Query with no FROM clause: SELECT 1, SELECT ‘hello’ AS name, etc. Produces a single row with evaluated constant expressions.

Fields

columns: Vec<String>

values: Vec<SqlValue>

Scan

Fields

collection: String

alias: Option<String>

engine: EngineType

filters: Vec<Filter>

projection: Vec<Projection>

sort_keys: Vec<SortKey>

limit: Option<usize>

offset: usize

distinct: bool

window_functions: Vec<WindowSpec>

PointGet

Fields

collection: String

alias: Option<String>

engine: EngineType

key_column: String

key_value: SqlValue

DocumentIndexLookup

Document fetch via a secondary index: equality predicate on an indexed field. The executor performs an index lookup to resolve matching document IDs, reads each document, and applies any remaining filters, projection, sort, and limit.

Emitted by document_schemaless::plan_scan / document_strict::plan_scan when the WHERE clause contains a single equality predicate on a Ready indexed field. Any additional predicates fall through as post-filters.

Fields

collection: String

alias: Option<String>

engine: EngineType

field: String

Indexed field path used for the lookup.

value: SqlValue

Equality value from the WHERE clause.

filters: Vec<Filter>

Remaining filters after extracting the equality used for lookup.

projection: Vec<Projection>

sort_keys: Vec<SortKey>

limit: Option<usize>

offset: usize

distinct: bool

window_functions: Vec<WindowSpec>

case_insensitive: bool

Whether the chosen index is COLLATE NOCASE — the executor lowercases the lookup value before probing.

RangeScan

Fields

collection: String

field: String

lower: Option<SqlValue>

upper: Option<SqlValue>

limit: usize

Insert

Fields

collection: String

engine: EngineType

rows: Vec<Vec<(String, SqlValue)>>

column_defaults: Vec<(String, String)>

Column defaults from schema: (column_name, default_expr). Used to auto-generate values for missing columns (e.g. id with UUID_V7).

KvInsert

KV INSERT: key and value are fundamentally separate. Each entry is (key, value_columns).

Fields

collection: String

entries: Vec<(SqlValue, Vec<(String, SqlValue)>)>

ttl_secs: u64

TTL in seconds (0 = no expiry). Extracted from ttl column if present.

Upsert

UPSERT: insert or merge if document exists.

Fields

collection: String

engine: EngineType

rows: Vec<Vec<(String, SqlValue)>>

column_defaults: Vec<(String, String)>

on_conflict_updates: Vec<(String, SqlExpr)>

ON CONFLICT (...) DO UPDATE SET field = expr assignments. When empty, upsert is a plain merge: new columns overwrite existing. When non-empty, the engine applies these per-row against the existing document instead of merging the inserted values.

InsertSelect

Fields

target: String

source: Box<SqlPlan>

limit: usize

Update

Fields

collection: String

engine: EngineType

assignments: Vec<(String, SqlExpr)>

filters: Vec<Filter>

target_keys: Vec<SqlValue>

returning: bool

Delete

Fields

collection: String

engine: EngineType

filters: Vec<Filter>

target_keys: Vec<SqlValue>

Truncate

Fields

collection: String

restart_identity: bool

Join

Fields

left: Box<SqlPlan>

right: Box<SqlPlan>

on: Vec<(String, String)>

join_type: JoinType

condition: Option<SqlExpr>

limit: usize

projection: Vec<Projection>

Post-join projection: column names to keep (empty = all columns).

filters: Vec<Filter>

Post-join filters (from WHERE clause).

Aggregate

Fields

input: Box<SqlPlan>

group_by: Vec<SqlExpr>

aggregates: Vec<AggregateExpr>

having: Vec<Filter>

limit: usize

TimeseriesScan

Fields

collection: String

time_range: (i64, i64)

bucket_interval_ms: i64

group_by: Vec<String>

aggregates: Vec<AggregateExpr>

filters: Vec<Filter>

projection: Vec<Projection>

gap_fill: String

limit: usize

tiered: bool

TimeseriesIngest

Fields

collection: String

rows: Vec<Vec<(String, SqlValue)>>

VectorSearch

Fields

collection: String

field: String

query_vector: Vec<f32>

top_k: usize

ef_search: usize

filters: Vec<Filter>

MultiVectorSearch

Fields

collection: String

query_vector: Vec<f32>

top_k: usize

ef_search: usize

TextSearch

Fields

collection: String

query: String

top_k: usize

fuzzy: bool

filters: Vec<Filter>

HybridSearch

Fields

collection: String

query_vector: Vec<f32>

query_text: String

top_k: usize

ef_search: usize

vector_weight: f32

fuzzy: bool

SpatialScan

Fields

collection: String

field: String

predicate: SpatialPredicate

query_geometry: Vec<u8>

distance_meters: f64

attribute_filters: Vec<Filter>

limit: usize

projection: Vec<Projection>

Union

Fields

inputs: Vec<SqlPlan>

distinct: bool

Intersect

Fields

left: Box<SqlPlan>

right: Box<SqlPlan>

all: bool

Except

Fields

left: Box<SqlPlan>

right: Box<SqlPlan>

all: bool

RecursiveScan

Fields

collection: String

base_filters: Vec<Filter>

recursive_filters: Vec<Filter>

join_link: Option<(String, String)>

Equi-join link for tree-traversal recursion: (collection_field, working_table_field). e.g. ("parent_id", "id") means each iteration finds rows where collection.parent_id matches a working_table.id.

max_iterations: usize

distinct: bool

limit: usize

Cte

Non-recursive CTE: execute each definition, then the outer query.

Fields

definitions: Vec<(String, SqlPlan)>

CTE definitions: (name, subquery_plan).

outer: Box<SqlPlan>

The outer query that references CTE names.

Trait Implementations

impl Clone for SqlPlan

fn clone(&self) -> SqlPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SqlPlan

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

Formats the value using the given formatter.