Skip to main content

LogicalPlan

Enum LogicalPlan 

Source
pub enum LogicalPlan {
Show 34 variants Scan { table: Arc<Table>, alias: Option<String>, projection: Option<Vec<usize>>, filter: Option<Expr>, }, IndexScan { table: Arc<Table>, alias: Option<String>, index: Index, index_column: usize, range: IndexRange, residual_filter: Option<Expr>, projection: Option<Vec<usize>>, }, PkSeek { table: Arc<Table>, alias: Option<String>, key_values: Vec<Expr>, residual_filter: Option<Expr>, projection: Option<Vec<usize>>, }, PkRangeScan { table: Arc<Table>, alias: Option<String>, range: IndexRange, residual_filter: Option<Expr>, projection: Option<Vec<usize>>, }, Filter { input: Box<LogicalPlan>, predicate: Expr, }, Project { input: Box<LogicalPlan>, exprs: Vec<(Expr, String)>, }, Join { left: Box<LogicalPlan>, right: Box<LogicalPlan>, join_type: JoinType, condition: Option<Expr>, }, Aggregate { input: Box<LogicalPlan>, group_by: Vec<Expr>, aggregates: Vec<(Expr, String)>, }, Sort { input: Box<LogicalPlan>, order_by: Vec<(Expr, SortOrder)>, }, Limit { input: Box<LogicalPlan>, limit: Option<usize>, offset: usize, }, Distinct { input: Box<LogicalPlan>, }, Insert { table: Arc<Table>, columns: Vec<String>, values: Vec<Vec<Expr>>, }, Update { table: Arc<Table>, assignments: Vec<(String, Expr)>, filter: Option<Expr>, }, Delete { table: Arc<Table>, filter: Option<Expr>, }, CreateTable { table: Table, }, DropTable { name: String, if_exists: bool, }, EmptyRelation, Explain { input: Box<LogicalPlan>, verbose: bool, analyze: bool, }, Window { input: Box<LogicalPlan>, window_exprs: Vec<(Expr, String)>, }, AlterTable { table_name: String, operations: Vec<AlterTableOp>, }, WithCte { ctes: Vec<CommonTableExpression>, query: Box<LogicalPlan>, }, CteScan { cte_name: String, alias: Option<String>, columns: Vec<String>, }, SubqueryScan { subquery: Box<LogicalPlan>, subquery_id: usize, alias: Option<String>, }, SemiJoin { left: Box<LogicalPlan>, right: Box<LogicalPlan>, condition: Option<Expr>, positive: bool, }, AntiJoin { left: Box<LogicalPlan>, right: Box<LogicalPlan>, condition: Option<Expr>, }, Grant { privileges: Permissions, table: Option<String>, grantee: String, }, Revoke { privileges: Permissions, table: Option<String>, grantee: String, }, ShowGrants { target: ShowGrantsTarget, }, Union { left: Box<LogicalPlan>, right: Box<LogicalPlan>, all: bool, }, Intersect { left: Box<LogicalPlan>, right: Box<LogicalPlan>, all: bool, }, Except { left: Box<LogicalPlan>, right: Box<LogicalPlan>, all: bool, }, CreateView { name: String, query: Box<LogicalPlan>, query_sql: String, columns: Vec<String>, }, DropView { name: String, if_exists: bool, }, CreateIndex { index_name: String, table_name: String, columns: Vec<String>, unique: bool, },
}
Expand description

Logical plan - represents a query as a tree of relational operators

Variants§

§

Scan

Scan a table

Fields

§table: Arc<Table>
§projection: Option<Vec<usize>>
§filter: Option<Expr>
§

IndexScan

Index scan - uses an index for efficient lookups This provides 100-1000x speedup for indexed queries

Fields

§table: Arc<Table>

Table being scanned

§alias: Option<String>

Table alias

§index: Index

Index to use for the scan

§index_column: usize

Column index in the table that the index covers (for single-column indexes)

§range: IndexRange

Range to scan in the index

§residual_filter: Option<Expr>

Additional filter for non-indexed predicates Applied after index lookup

§projection: Option<Vec<usize>>

Projection columns

§

PkSeek

Direct primary key lookup - O(log N) instead of O(N) scan Used when ALL primary key columns have equality predicates

Fields

§table: Arc<Table>
§key_values: Vec<Expr>

One expression per PK column, in PK order

§residual_filter: Option<Expr>

Non-PK predicates applied after lookup

§projection: Option<Vec<usize>>

Projection columns

§

PkRangeScan

Direct primary key range scan - O(range_size) instead of O(N) Used when PK column has range predicates (>=, >, <=, <)

Fields

§table: Arc<Table>
§range: IndexRange

Range bounds for PK scan

§residual_filter: Option<Expr>

Non-PK predicates applied after lookup

§projection: Option<Vec<usize>>

Projection columns

§

Filter

Filter rows

Fields

§predicate: Expr
§

Project

Project columns

Fields

§exprs: Vec<(Expr, String)>
§

Join

Join two inputs

Fields

§join_type: JoinType
§condition: Option<Expr>
§

Aggregate

Aggregate

Fields

§group_by: Vec<Expr>
§aggregates: Vec<(Expr, String)>
§

Sort

Sort

Fields

§order_by: Vec<(Expr, SortOrder)>
§

Limit

Limit output rows

Fields

§limit: Option<usize>
§offset: usize
§

Distinct

Distinct

Fields

§

Insert

Insert rows

Fields

§table: Arc<Table>
§columns: Vec<String>
§values: Vec<Vec<Expr>>
§

Update

Update rows

Fields

§table: Arc<Table>
§assignments: Vec<(String, Expr)>
§filter: Option<Expr>
§

Delete

Delete rows

Fields

§table: Arc<Table>
§filter: Option<Expr>
§

CreateTable

Create table

Fields

§table: Table
§

DropTable

Drop table

Fields

§name: String
§if_exists: bool
§

EmptyRelation

Empty relation (for queries with no FROM)

§

Explain

Explain plan - shows query execution plan with cost estimates

Fields

§input: Box<LogicalPlan>

The plan to explain

§verbose: bool

Whether to show detailed costs

§analyze: bool

Whether to actually run the query and show execution stats

§

Window

Window function evaluation

Fields

§input: Box<LogicalPlan>

Input plan

§window_exprs: Vec<(Expr, String)>

Window function expressions with their output aliases

§

AlterTable

Alter table schema

Fields

§table_name: String

Name of the table to alter

§operations: Vec<AlterTableOp>

Operations to perform

§

WithCte

Common Table Expression (CTE) - WITH clause Materializes CTE results and makes them available as virtual tables

Fields

§ctes: Vec<CommonTableExpression>

CTE definitions (name, columns, plan, is_recursive)

§query: Box<LogicalPlan>

The main query that uses the CTEs

§

CteScan

Scan a CTE by name

Fields

§cte_name: String

Name of the CTE being scanned

§alias: Option<String>

Table alias (e.g. eng_dept e1 → alias = Some(“e1”))

§columns: Vec<String>

Output column names (bare, without prefix)

§

SubqueryScan

Subquery scan - executes a subquery and provides its results

Fields

§subquery: Box<LogicalPlan>

The subquery plan

§subquery_id: usize

Unique identifier for tracking

§alias: Option<String>

Output alias

§

SemiJoin

Semi-join - optimized execution for EXISTS/IN subqueries Returns rows from left where at least one matching row exists in right

Fields

§condition: Option<Expr>
§positive: bool

True for EXISTS, false for NOT EXISTS / NOT IN

§

AntiJoin

Anti-join - returns rows from left where NO matching row exists in right Used for NOT IN / NOT EXISTS optimization

Fields

§condition: Option<Expr>
§

Grant

Grant permissions on a table to an API key (v0.4.0)

Fields

§privileges: Permissions

Permissions to grant (SELECT, INSERT, UPDATE, DELETE, ALL)

§table: Option<String>

Table name, or None for wildcard (all tables)

§grantee: String

The API key ID to grant permissions to

§

Revoke

Revoke permissions from an API key (v0.4.0)

Fields

§privileges: Permissions

Permissions to revoke (SELECT, INSERT, UPDATE, DELETE, ALL)

§table: Option<String>

Table name, or None for wildcard (all tables)

§grantee: String

The API key ID to revoke permissions from

§

ShowGrants

Show grants for a table or API key (v0.4.0)

Fields

§target: ShowGrantsTarget

Target of SHOW GRANTS query

§

Union

UNION / UNION ALL - combines results of two queries

Fields

§all: bool

If true, keep duplicates (UNION ALL). If false, deduplicate (UNION).

§

Intersect

INTERSECT / INTERSECT ALL - returns rows common to both queries

Fields

§all: bool

If true, keep duplicates (INTERSECT ALL). If false, deduplicate.

§

Except

EXCEPT / EXCEPT ALL - returns rows in left but not in right

Fields

§all: bool

If true, keep duplicates (EXCEPT ALL). If false, deduplicate.

§

CreateView

CREATE VIEW - stores a named query definition

Fields

§name: String
§query_sql: String

The original SQL of the view query (for re-planning on scan)

§columns: Vec<String>

Column aliases for the view

§

DropView

DROP VIEW

Fields

§name: String
§if_exists: bool
§

CreateIndex

CREATE INDEX

Fields

§index_name: String
§table_name: String
§columns: Vec<String>
§unique: bool

Implementations§

Source§

impl LogicalPlan

Source

pub fn output_columns(&self) -> Vec<String>

Get output column names

Source

pub fn collect_column_references(&self) -> Vec<(Option<String>, String)>

Collect all column references from expressions in the plan Returns tuples of (table, column_name)

Trait Implementations§

Source§

impl Clone for LogicalPlan

Source§

fn clone(&self) -> LogicalPlan

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LogicalPlan

Source§

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

Formats the value using the given formatter. 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<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> Conv for T

Source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
Source§

impl<T> FmtForward for T

Source§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
Source§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
Source§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
Source§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
Source§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
Source§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
Source§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
Source§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
Source§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. 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> Pipe for T
where T: ?Sized,

Source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
Source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
Source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
Source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
Source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
Source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
Source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Tap for T

Source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
Source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
Source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
Source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
Source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
Source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
Source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
Source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
Source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
Source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
Source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
Source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
Source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
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> TryConv for T

Source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. 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