pub enum QueryOp {
Show 15 variants
Exchange(ExchangeOp),
ProviderScan {
provider: Option<String>,
rows: Vec<u8>,
filters: Vec<u8>,
projection: Vec<String>,
sort_keys: Vec<(String, bool)>,
limit: Option<usize>,
offset: usize,
distinct: bool,
},
Aggregate {
collection: String,
input: Option<Box<PhysicalPlan>>,
group_by: Vec<GroupKeySpec>,
aggregates: Vec<AggregateSpec>,
filters: Vec<u8>,
having: Vec<u8>,
limit: usize,
sub_group_by: Vec<String>,
sub_aggregates: Vec<AggregateSpec>,
grouping_sets: Vec<Vec<u32>>,
sort_keys: Vec<(String, bool)>,
},
PartialAggregate {
collection: String,
group_by: Vec<String>,
aggregates: Vec<AggregateSpec>,
filters: Vec<u8>,
},
PartialAggregateState {
collection: String,
input: Option<Box<PhysicalPlan>>,
group_by: Vec<GroupKeySpec>,
aggregates: Vec<AggregateSpec>,
filters: Vec<u8>,
},
HashJoin {Show 17 fields
left_collection: String,
right_collection: String,
left_alias: Option<String>,
right_alias: Option<String>,
on: Vec<(String, String)>,
join_type: String,
limit: usize,
post_group_by: Vec<String>,
post_aggregates: Vec<(String, String)>,
projection: Vec<JoinProjection>,
computed_projection: Vec<u8>,
join_filters: Vec<u8>,
post_filters: Vec<u8>,
left_input: Option<Box<PhysicalPlan>>,
right_input: Option<Box<PhysicalPlan>>,
left_bitmap: Option<Box<PhysicalPlan>>,
right_bitmap: Option<Box<PhysicalPlan>>,
},
ShuffleJoinConsume {
build_path: String,
probe_path: String,
on: Vec<(String, String)>,
join_type: String,
limit: usize,
probe_qualifier: String,
index_qualifier: String,
},
ShuffleAggregateConsume {
state_path: String,
group_by: Vec<String>,
aggregates: Vec<AggregateSpec>,
having: Vec<u8>,
limit: usize,
sort_keys: Vec<(String, bool)>,
},
NestedLoopJoin {
left_collection: String,
right_collection: String,
condition: Vec<u8>,
join_type: String,
limit: usize,
},
SortMergeJoin {
left_collection: String,
right_collection: String,
on: Vec<(String, String)>,
join_type: String,
limit: usize,
pre_sorted: bool,
},
FacetCounts {
collection: String,
filters: Vec<u8>,
fields: Vec<String>,
limit_per_facet: usize,
},
RecursiveScan {
collection: String,
base_filters: Vec<u8>,
recursive_filters: Vec<u8>,
join_link: Option<(String, String)>,
max_iterations: usize,
distinct: bool,
limit: usize,
},
RecursiveValue {
cte_name: String,
columns: Vec<String>,
init_exprs: Vec<String>,
step_exprs: Vec<String>,
condition: Option<String>,
max_depth: usize,
distinct: bool,
},
LateralTopK {
outer_plan: Box<PhysicalPlan>,
outer_alias: String,
inner_collection: String,
inner_filters: Vec<u8>,
inner_order_by: Vec<(String, bool)>,
inner_limit: usize,
correlation_keys: Vec<(String, String)>,
lateral_alias: String,
projection: Vec<JoinProjection>,
left_join: bool,
},
LateralLoop {
outer_plan: Box<PhysicalPlan>,
outer_alias: String,
inner_collection: String,
inner_filters: Vec<u8>,
correlation_predicates: Vec<(String, String)>,
lateral_alias: String,
projection: Vec<JoinProjection>,
left_join: bool,
outer_row_cap: usize,
},
}Expand description
Query-level physical operations (joins, aggregates).
Variants§
Exchange(ExchangeOp)
Coordinator-resolved data-movement wrapper. Defensive error if it reaches a core.
ProviderScan
Pre-materialized rows. provider: Some(name) => filled per-request
(identity-scoped catalog table); None => rows is final (constant
SELECT or gathered broadcast child). rows is a canonical msgpack array
of map values (the encode_binary_rows shape).
The executor applies predicate, offset, sort, distinct, projection, and
limit in that order over the rows before emitting the response. Empty
filters/projection and None limit are no-ops (all rows emitted
unchanged through those stages).
Fields
provider: Option<String>Catalog provider name for deferred materialization by the coordinator.
Some(name) is replaced with None after materialize_providers
fills rows. Data-Plane cores must never see Some.
Aggregate
Aggregate: GROUP BY + aggregate functions.
Fields
input: Option<Box<PhysicalPlan>>Optional sub-plan whose decoded rows are aggregated instead of
scanning collection per-shard. Some currently means EXACTLY a
catalog source (a ProviderScan lowered by the converter): the
aggregate runs over the coordinator-materialized catalog rows and is
therefore coordinator-local (never broadcast — see
is_sharded_source). None = legacy path: scan the named
collection on every shard. collection stays populated in both
cases so downstream RLS / permission / classification continue to
read it; the executor simply prefers input when present.
group_by: Vec<GroupKeySpec>aggregates: Vec<AggregateSpec>sub_aggregates: Vec<AggregateSpec>PartialAggregate
Partial aggregate: each core computes locally, Control Plane merges.
PartialAggregateState
Partial aggregate STATE producer (distributed GROUP BY shuffle, map side).
Accumulates exactly like QueryOp::PartialAggregate — scan the named
collection, apply filters, build per-group GroupState accumulators
keyed on group_by — but DOES NOT finalize. Instead it emits one row
PER GROUP of the flat shape:
{ <group_by[0]>: value_0, ..., "__agg_state": <bytes> }where __agg_state is the serialized partial GroupState for that
group. A downstream QueryOp::ShuffleAggregateConsume merges these
partial states (from every producer shard/node) and finalizes them.
This op carries NO node-local paths — it reads only the named collection
(or its input sub-plan) — so it is wire-shippable: a coordinator embeds
it in a producer plan and dispatches it to a remote node’s Data Plane.
Fields
input: Option<Box<PhysicalPlan>>Optional sub-plan whose decoded rows are aggregated instead of
scanning collection per-shard. Mirrors QueryOp::Aggregate’s
input: Some runs the producer over the sub-plan’s rows (e.g. a
coordinator-materialized ProviderScan), None scans the named
collection. collection stays populated either way.
group_by: Vec<GroupKeySpec>aggregates: Vec<AggregateSpec>HashJoin
Hash join: build hash map on right, probe with left.
left_input/right_input carry a resolved child plan (an Exchange
child during planning, or an embedded ProviderScan after coordinator
resolution). When None the side is scanned locally by collection name.
Fields
post_aggregates: Vec<(String, String)>Post-join aggregates: (op, field) pairs (empty = no aggregation).
projection: Vec<JoinProjection>Post-join projection: column names to keep (empty = all).
computed_projection: Vec<u8>MessagePack-encoded computed projection expressions. When present, these represent the complete SELECT list in output order.
join_filters: Vec<u8>Residual ON predicates evaluated for each equi-key candidate
before outer-join match accounting (MessagePack).
left_input: Option<Box<PhysicalPlan>>Resolved child plan for the left side. An Exchange child during
planning; a ProviderScan after coordinator resolution. None
means the left side is scanned locally by left_collection.
right_input: Option<Box<PhysicalPlan>>Resolved child plan for the right side. Same semantics as
left_input but applied to right_collection.
left_bitmap: Option<Box<PhysicalPlan>>Bitmap-producer sub-plan for the left side. When set, the executor
executes this plan first, collects surrogates from all returned rows,
and injects the resulting bitmap into the probe-side prefilter before
scanning. None = no bitmap pushdown for the left side.
right_bitmap: Option<Box<PhysicalPlan>>Bitmap-producer sub-plan for the right side. Same semantics as
left_bitmap but applied to the right (probe) collection.
ShuffleJoinConsume
Cross-node shuffle-join CONSUMER (E4b): run the node-local grace-hash join over two already-staged shuffle frame files.
This variant is BUILT LOCALLY by the part-owner node’s consume hook with
resolved local absolute paths and dispatched to the SAME node’s Data
Plane. It carries node-local filesystem paths (as plain strings) and must
NEVER be serialized cross-node — the wire encoder rejects it for exactly
this reason (see physical_plan::wire::encode).
The owned fields mirror the borrowed JoinParams the Data-Plane handler
(execute_shuffle_join) reconstructs: on (equi-join key pairs),
join_type, limit, and the two column qualifiers. build_path /
probe_path are the staged build (right) and probe (left) frame files.
Fields
ShuffleAggregateConsume
Distributed GROUP BY shuffle CONSUMER (reduce side): merge the staged
partial GroupStates produced by QueryOp::PartialAggregateState
producers, then finalize, HAVING-filter, sort, and LIMIT.
state_path is a node-local frame file written by the shuffle receive
path: a sequence of [u32 LE len][row-bytes] frames, one msgpack row per
frame, each row the flat {<group_by cols>, "__agg_state": <bytes>} shape
a PartialAggregateState producer emits. The handler rebuilds each
group key (byte-identically to the accumulate path), decodes
__agg_state, and merge_froms into a consolidated per-group map before
running the same finalize tail as a normal aggregate.
Like QueryOp::ShuffleJoinConsume, this variant carries a node-local
path and is BUILT LOCALLY by the consume hook for dispatch to the SAME
node’s Data Plane — it must NEVER be serialized cross-node (the wire
encoder rejects it; see physical_plan::wire::encode).
Fields
aggregates: Vec<AggregateSpec>Aggregate specs (must match the producers’ specs, in order).
NestedLoopJoin
Nested loop join: fallback for non-equi joins.
Fields
SortMergeJoin
Sort-merge join: both sides pre-sorted by join key. Optimal when both collections have index-ordered scans or when the planner sorts both sides before joining.
Fields
FacetCounts
Multi-facet aggregation: compute facet counts for multiple fields in a single query, sharing the filter evaluation across all facets.
Fields
RecursiveScan
Recursive CTE: iterative fixed-point execution.
Executes the base query once, then repeatedly executes the recursive query using the previous iteration’s results as the working table, until no new rows are produced (fixed point).
Fields
RecursiveValue
Value-generating recursive CTE: iterative expression evaluation.
No collection is needed. The executor evaluates the anchor expressions
once to produce the first row, then repeatedly applies the step
expressions to the previous row until the condition becomes false,
a fixed point is reached, or max_depth is exceeded (typed error).
Fields
LateralTopK
LATERAL equi-correlated top-K: scan inner_collection once per outer
row, applying the equi-correlation as an equality filter, then return
the top inner_limit rows ordered by inner_order_by.
The executor first runs outer_plan to materialise outer rows, then
for each outer row injects the equi-correlation as an equality filter
on inner_collection, applies inner_order_by, and keeps the top
inner_limit rows. Output rows are (outer_row merged with inner_row).
correlation_keys are (outer_col, inner_col) equi-join pairs.
Fields
outer_plan: Box<PhysicalPlan>Sub-plan that produces the outer (driving) rows.
inner_order_by: Vec<(String, bool)>Sort keys for the inner per-outer-row result.
Each entry is (field_name, ascending).
projection: Vec<JoinProjection>Output projection (empty = all columns).
LateralLoop
LATERAL nested-loop: for each outer row, re-execute the inner plan with correlated values injected as additional equality filters.
The executor runs outer_plan, then for each outer row reads the
outer_col values from correlation_predicates, appends equality
filters on the corresponding inner_col fields, and scans
inner_collection.
Fields
outer_plan: Box<PhysicalPlan>Sub-plan that produces the outer (driving) rows.
projection: Vec<JoinProjection>Output projection (empty = all columns).
Trait Implementations§
Source§impl<'de> Deserialize<'de> for QueryOp
impl<'de> Deserialize<'de> for QueryOp
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for QueryOp
impl<'__msgpack_de> FromMessagePack<'__msgpack_de> for QueryOp
impl StructuralPartialEq for QueryOp
Auto Trait Implementations§
impl Freeze for QueryOp
impl RefUnwindSafe for QueryOp
impl Send for QueryOp
impl Sync for QueryOp
impl Unpin for QueryOp
impl UnsafeUnpin for QueryOp
impl UnwindSafe for QueryOp
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
impl<T> ErasedDestructor for Twhere
T: 'static,
impl<T> FromMessagePackOwned for Twhere
T: for<'a> FromMessagePack<'a>,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
impl<T> MaybeSendSync for T
Source§impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
Source§fn resolve_niched(out: Place<NichedOption<T, N1>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
out indicating that a T is niched.Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
impl<T> Rleable for T
impl<T> Scalar for T
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.