Skip to main content

Query

Struct Query 

Source
pub struct Query<X: Extension = NoExt> {
    pub with: Option<With<X>>,
    pub body: SetExpr<X>,
    pub order_by: ThinVec<OrderByExpr<X>>,
    pub order_by_all: Option<Box<OrderByAll>>,
    pub limit_by: Option<Box<LimitBy<X>>>,
    pub limit: Option<Limit<X>>,
    pub settings: ThinVec<Setting<X>>,
    pub format: Option<Box<FormatClause>>,
    pub locking: ThinVec<LockingClause>,
    pub pipe_operators: ThinVec<PipeOperator<X>>,
    pub for_clause: Option<Box<ForClause>>,
    pub meta: Meta,
}
Expand description

An SQL query.

Fields§

§with: Option<With<X>>

Common table expressions visible to this statement.

§body: SetExpr<X>

Statement or query body governed by this node.

§order_by: ThinVec<OrderByExpr<X>>

Ordering terms in source order.

§order_by_all: Option<Box<OrderByAll>>

DuckDB’s ORDER BY ALL mode — sort by every projection column, left to right — with its optional direction/nulls modifiers; None for an ordinary (or absent) ORDER BY. Mutually exclusive with a non-empty order_by: DuckDB rejects mixing ALL with explicit sort keys (ORDER BY ALL, x / ORDER BY x, ALL are syntax errors; probed on 1.5.4), so ALL is a mode of the whole clause, never a sort-key expression — the column set is unknowable at parse time, so a synthetic key list would be a lie (the shape is anchored on the semantics). Boxed because the clause is rare while Query is a hot node (the Select::into precedent). Gated by GroupingSyntax::order_by_all; only the query-level clause admits ALL — DuckDB rejects it in window ORDER BY (“Cannot ORDER BY ALL in a window expression”) and has no DML sort tails.

§limit_by: Option<Box<LimitBy<X>>>

ClickHouse LIMIT n [OFFSET m] BY expr, … — per-group row limiting, written after ORDER BY and before the ordinary limit tail. Its own field because it coexists with limit and means something different (see LimitBy); None for the common query that writes no LIMIT BY. Gated by QueryTailSyntax::limit_by_clause — off for every shipped preset but Lenient, so it stays None elsewhere. Boxed because the clause is rare while Query is a hot node (the order_by_all precedent) — keeping the 104-byte LimitBy off the inline Query footprint.

§limit: Option<Limit<X>>

Row limit applied to the result.

§settings: ThinVec<Setting<X>>

ClickHouse SETTINGS name = value, … — query-level setting overrides written after the ordinary limit tail (SELECT … LIMIT 10 SETTINGS max_threads = 8). Empty for the common query that writes none — a bare ThinVec costing one null pointer when unused, following the locking/pipe_operators list-tail precedent rather than a boxed option (a list’s own rarity optimization is the empty vector, so Query’s hot footprint grows by only that one pointer). Gated by QueryTailSyntax::settings_clause — on for Lenient only, so it stays empty under every oracle-compared preset.

§format: Option<Box<FormatClause>>

ClickHouse FORMAT <name> — the output-format clause that closes the query, the last tail of all (after settings); None for the common query that names no format. The format name is a bare identifier (JSON, CSV, TabSeparated, Null), see FormatClause. Gated by QueryTailSyntax::format_clause — off for every shipped preset but Lenient, so it stays None elsewhere. Boxed because the clause is rare while Query is a hot node (the order_by_all/limit_by precedent), keeping the clause off the inline Query footprint at one pointer’s cost.

§locking: ThinVec<LockingClause>

The row-locking clauses (FOR UPDATE/FOR SHARE/…) written after LIMIT. PostgreSQL admits several stacked clauses (FOR UPDATE OF a FOR SHARE OF b), MySQL exactly one, so this is a list; empty when the query writes none. Gated by QueryTailSyntax::locking_clauses. Not generic over X: a LockingClause carries only names and surface tags, no expression.

§pipe_operators: ThinVec<PipeOperator<X>>

BigQuery/ZetaSQL |> pipe operators applied to this query’s result, left to right (FROM t |> WHERE x |> SELECT a). Empty for an ordinary query — the common case, so a bare ThinVec that costs one null pointer when unused, like locking. Each element is one PipeOperator step. Gated by QueryTailSyntax::pipe_syntax; off for every shipped preset, so the field stays empty there and the |> token never even lexes.

§for_clause: Option<Box<ForClause>>

MSSQL FOR XML … / FOR JSON … result-shaping tail — the last clause of all, serializing the result as XML/JSON instead of a rowset; None for the common query that writes no FOR XML/FOR JSON. See ForClause. Gated by QueryTailSyntax::for_xml_json_clause — on for MSSQL and Lenient, so it stays None elsewhere. Boxed because the clause is rare while Query is a hot node (the order_by_all/format precedent), keeping the 92-byte ForClause off the inline Query footprint at one pointer’s cost. Not generic over X: a ForClause carries only mode tags and quoted names, no expression.

§meta: Meta

Source location and node identity.

Trait Implementations§

Source§

impl<X: Clone + Extension> Clone for Query<X>

Source§

fn clone(&self) -> Query<X>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<X: Debug + Extension> Debug for Query<X>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, X> Deserialize<'de> for Query<X>
where X: Deserialize<'de> + Extension,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<X: Eq + Extension> Eq for Query<X>

Source§

impl<X: Extension + Render> FragmentRender for Query<X>

Source§

impl<X: Hash + Extension> Hash for Query<X>

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl<X: PartialEq + Extension> PartialEq for Query<X>

Source§

fn eq(&self, other: &Query<X>) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<X: Extension + Render> Render for Query<X>

Source§

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

Return the render for this value.
Source§

fn operand_binding_power(&self) -> Option<BindingPower>

The binding power this node contributes when it appears as an operand, or None (the default) for a self-delimiting node — an atom, call, or constructor — that never needs parentheses. Read more
Source§

impl<X> Serialize for Query<X>
where X: Serialize + Extension,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<X: Extension> Spanned for Query<X>

Source§

fn span(&self) -> Span

Return the span for this value.
Source§

impl<X: PartialEq + Extension> StructuralPartialEq for Query<X>

Auto Trait Implementations§

§

impl<X> Freeze for Query<X>
where X: Freeze,

§

impl<X> RefUnwindSafe for Query<X>
where X: RefUnwindSafe,

§

impl<X> Send for Query<X>
where X: Send,

§

impl<X> Sync for Query<X>
where X: Sync,

§

impl<X> Unpin for Query<X>
where X: Unpin,

§

impl<X> UnsafeUnpin for Query<X>
where X: UnsafeUnpin,

§

impl<X> UnwindSafe for Query<X>
where X: UnwindSafe,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynAstExt for T
where T: Extension + Render + 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Erase to &dyn Any for downcasting a node back to its concrete type.
Source§

fn dyn_clone(&self) -> Box<dyn DynAstExt>

Clone into a fresh box — the object-safe stand-in for Clone (whose Self-returning signature cannot go through a vtable).
Source§

fn dyn_eq(&self, other: &dyn DynAstExt) -> bool

Structural equality against another erased node — the object-safe stand-in for PartialEq (whose &Self argument cannot go through a vtable). Equal iff other holds the same concrete type and that type deems the values equal; differently-typed nodes are never equal.
Source§

fn dyn_hash(&self, state: &mut dyn Hasher)

Feed this node’s hash into an erased hasher — the object-safe stand-in for Hash::hash (whose generic H: Hasher cannot go through a vtable).
Source§

impl<T> Extension for T
where T: Clone + Debug + Eq + Hash + Spanned,

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> RenderExt for T
where T: Render,

Source§

fn displayed<'a>(&'a self, ctx: &'a RenderCtx<'a>) -> Displayed<'a, T>

Pair this node with an explicit canonical RenderCtx so format!, to_string, and {} render it. This is the canonical path: the ctx’s resolver and source must match the node’s parse.
Source§

fn debug_sql<'a>(&'a self, resolver: &'a dyn Resolver) -> DebugSql<'a, Self>
where Self: Sized,

Render this node for debugging against an explicitly-supplied resolver (the debug-SQL mitigation), returning a Display adapter. Read more
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, 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.