Skip to main content

rudb_bind/
binder.rs

1//! From an `Ast` to a `Plan`.
2//!
3//! The binder walks the written query once, in the order the operators end up in rather than the
4//! order the clauses are written in, which is `FROM`, `WHERE`, `GROUP BY`, `HAVING`, `SELECT`,
5//! `DISTINCT`, `ORDER BY`, `LIMIT`. That order is not a stylistic choice: it is the reason `WHERE`
6//! cannot see an output alias and `HAVING` cannot see a column that was not grouped, and doing it
7//! in any other order means special casing both of those instead of getting them for free.
8//!
9//! Two things leave here settled that nothing downstream reconsiders. Every column is a table index
10//! and a position rather than a name, so the optimizer never has to ask which `id` a name meant.
11//! And every expression has a type, with the casts that make the types line up already written into
12//! the plan as [`Expr::Cast`] nodes, so an executor never has to decide what a comparison between
13//! an `INTEGER` and a `BIGINT` does.
14
15use std::sync::Arc;
16
17use rudb_catalog::{Catalog, Entry, FileStamp, QualifiedName, same_name};
18use rudb_common::bounds::Zones;
19use rudb_common::{
20    Error, Field, LogicalType, Result, Semantics, Session, ShowBehavior, Span, Stat, Value,
21};
22use rudb_functions::{
23    Columns, FILE_ROW_NUMBER, Footers, FunctionKind, Given, Resolved, TableFunction, csv_fields,
24    csv_given, files, is_file, is_pattern, kind_of, parquet_footers, parquet_outline, resolve,
25    resolve_pragma, resolve_table,
26};
27use rudb_kernels::{percentage, row_count};
28use rudb_parse::ast::{self, Ast, Distinct, LiteralKind, Nulls, Order, Quantifier, SetOp};
29use rudb_parse::{NONE, identifier_parts, parse_ast_with_case};
30use rudb_plan::{
31    Bound, BuildSide, ColumnBinding, ConjunctionOp, Expr, ExprRef, JoinKind, Node, NodeRef, Plan,
32    SetOpKind, Share, SortKey, WindowBound, WindowExclude, WindowFrame, WindowUnit,
33};
34
35use crate::expr::{describe, has_aggregate};
36use crate::fold;
37use crate::parameters::Parameters;
38use crate::scope::{Scope, Visible};
39
40/// Binds a parsed statement against a catalog.
41///
42/// # Errors
43///
44/// If the script does not hold exactly one statement, if a name does not resolve, if a type does
45/// not work out, or if the query uses something M0 does not bind yet.
46pub fn bind(ast: &Ast, catalog: &Catalog) -> Result<Plan> {
47    bind_with(ast, catalog, &Parameters::new(), &Session::new())
48}
49
50/// Binds a parsed query against a catalog, with values for its parameters and its settings.
51///
52/// The session is what `current_setting()` reads, and a caller with no database behind it passes an
53/// empty one, which makes every setting name unrecognized rather than making up an answer.
54///
55/// # Errors
56///
57/// Everything [`bind`] reports, plus an error for a parameter that was given no value.
58pub fn bind_with(
59    ast: &Ast,
60    catalog: &Catalog,
61    parameters: &Parameters,
62    session: &Session,
63) -> Result<Plan> {
64    let query = match ast.statements.as_slice() {
65        [ast::Statement::Query(query)] => *query,
66        [] => return Err(Error::binder("no statement to bind")),
67        // One statement that is not a query is its own answer. Reporting it as a script of several
68        // reads as a count being wrong, and the count is right.
69        [_] => return Err(Error::not_implemented("a statement that is not a query")),
70        _ => return Err(Error::not_implemented("a script of more than one statement")),
71    };
72    let mut binder = Binder::with(catalog, parameters, session);
73    let (root, _) = binder.bind_query(ast, query)?;
74    let mut plan = binder.into_plan();
75    plan.set_root(root);
76    plan.validate()?;
77    Ok(plan)
78}
79
80/// Parses and binds one query, which is the whole front end in one call.
81///
82/// # Errors
83///
84/// Anything the parser or the binder reports.
85pub fn bind_sql(query: &str, catalog: &Catalog) -> Result<Plan> {
86    bind_sql_with(query, catalog, &Session::new())
87}
88
89/// Parses and binds one query, with the settings a call to `current_setting()` reads.
90///
91/// # Errors
92///
93/// Anything the parser or the binder reports.
94pub fn bind_sql_with(query: &str, catalog: &Catalog, session: &Session) -> Result<Plan> {
95    let ast = parse_ast_with_case(query, session.semantics().identifier_case())?;
96    bind_with(&ast, catalog, &Parameters::new(), session)
97}
98
99/// What an aggregating select block has decided so far.
100#[derive(Debug)]
101pub(crate) struct Aggregation {
102    /// The table index the aggregate's output binds against.
103    pub(crate) index: u32,
104    /// The group expressions, over the input, which are the first output columns.
105    pub(crate) groups: Vec<ExprRef>,
106    /// The aggregate calls found so far, which follow the groups in the output.
107    pub(crate) aggregates: Vec<ExprRef>,
108}
109
110/// One run of window calls that agree on where the rows come from and in what order.
111///
112/// The run is the unit the plan has an operator for, so two calls that write the same partition,
113/// the same order and the same frame are one operator and one sort, and a third that writes a
114/// different order is a second operator stacked on the first. Nothing here merges runs that only
115/// look compatible, because a window is evaluated over the rows the operator below it produced and
116/// deciding two runs are the same is the optimizer's job rather than the binder's.
117#[derive(Debug)]
118pub(crate) struct WindowRun {
119    /// The table index the run's result columns bind against.
120    index: u32,
121    /// What divides the input into independent partitions.
122    partition: Vec<ExprRef>,
123    /// The order within a partition.
124    order: Vec<SortKey>,
125    /// The frame every call in the run shares.
126    frame: WindowFrame,
127    /// The calls, in the order their columns are appended.
128    calls: Vec<ExprRef>,
129}
130
131/// One window call as it was written, before any of it has been bound.
132///
133/// These six travel together from the parser all the way to the run they end up filed under, and
134/// carrying them as one thing keeps the call that binds them readable.
135pub(crate) struct WindowCall<'a> {
136    /// The function name, as written and not yet resolved.
137    pub(crate) name: &'a str,
138    /// The arguments, which may include a star that only `count` is allowed to be given.
139    pub(crate) args: &'a [ast::ExprRef],
140    /// Whether `DISTINCT` was written inside the parens.
141    pub(crate) distinct: bool,
142    /// The `FILTER (WHERE ...)` predicate, which is written before the `OVER`, or `NONE`.
143    pub(crate) filter: ast::ExprRef,
144    /// Whether `IGNORE NULLS` was written inside the parens, which is where DuckDB puts it.
145    pub(crate) ignore_nulls: bool,
146    /// The `ORDER BY` written inside the parens, which says what order the call reads the rows of
147    /// its frame in and is a different clause from the one in the `OVER`.
148    pub(crate) order: ast::Slice,
149    /// The `OVER`, which the parser has already resolved against any `WINDOW` clause.
150    pub(crate) spec: ast::WindowRef,
151}
152
153/// Everything inside one window call once it is bound, which is what decides its run.
154struct WindowParts {
155    /// The arguments, before the casts the resolved signature asks for.
156    args: Vec<ExprRef>,
157    /// What divides the input into independent partitions.
158    partition: Vec<ExprRef>,
159    /// The order within a partition.
160    order: Vec<SortKey>,
161    /// The order the call reads the rows of its frame in, which is the `ORDER BY` written inside
162    /// the brackets rather than the one in the `OVER` and is empty far more often than not.
163    inner: Vec<SortKey>,
164    /// The frame, with both ends and the exclusion.
165    frame: WindowFrame,
166}
167
168/// What opening the files behind a table function call said about them.
169///
170/// The answers travel together because they come out of the same footer. A Parquet file states its
171/// columns, its row count and its statistics in the same few kilobytes at the end of it, so a
172/// binder that has read one has read all of them, and splitting them into four arguments would
173/// mean four ways to forget one.
174#[derive(Debug)]
175struct Read {
176    /// The columns the call produces, in the order the file stores them.
177    fields: Vec<Field>,
178    /// How many rows all of the files hold, where anybody counted.
179    rows: Stat<u64>,
180    /// How many distinct values a column holds, by name, for the columns anybody counted.
181    distincts: Vec<(String, Stat<u64>)>,
182    /// The bounds the files keep per part of themselves, where anything can answer for them.
183    zones: Option<Arc<dyn Zones>>,
184}
185
186impl Read {
187    /// Columns that came from somewhere other than a file, so nothing counted anything.
188    fn uncounted(fields: Vec<Field>) -> Self {
189        Self { fields, rows: Stat::Unknown, distincts: Vec::new(), zones: None }
190    }
191}
192
193/// A materialised `WITH` definition that has been bound and can be read by name.
194#[derive(Debug)]
195struct Materialized {
196    /// Which written definition this is, as an index into `Ast::ctes`.
197    written: u32,
198    /// The number the plan uses to pair a read with what it reads.
199    cte: u32,
200    /// The name it was written with, which is the table name a read is reachable through.
201    name: String,
202    /// What it produces, in order, under the declared names when a column list was written.
203    fields: Vec<Field>,
204}
205
206#[derive(Debug)]
207pub(crate) struct PendingSubquery {
208    pub(crate) node: NodeRef,
209    pub(crate) kind: JoinKind,
210    pub(crate) conditions: Vec<ExprRef>,
211    pub(crate) dependent: bool,
212    /// The outer columns the query's body read, which is what `dependent` counts.
213    ///
214    /// Kept rather than reduced to the flag because a join's `ON` has to decide which of its two
215    /// inputs the query is joined into, and the answer is the side those columns come from. A
216    /// query that reads neither side can go on either.
217    pub(crate) reads: Vec<ColumnBinding>,
218    /// The table index this query's join adds to the rows it is joined into.
219    ///
220    /// Kept so that a `HAVING` which reads one of these can say which columns came from a query
221    /// joined above the grouping rather than from the table underneath it. Those columns are not
222    /// the table's and the grouping rule has nothing to say about them.
223    pub(crate) index: u32,
224    /// Whether the query was written inside an aggregate call's argument or its `FILTER`.
225    ///
226    /// One written there is read once per row going into the aggregate, so it has to be joined in
227    /// underneath the grouping however uncorrelated it is. Every other query a grouped block writes
228    /// is one row for the whole block and is lifted over the grouping instead, which is what
229    /// [`Binder::lift_over_aggregate`] decides.
230    pub(crate) inside_aggregate: bool,
231}
232
233/// Which input of a join a query written in that join's `ON` is joined into.
234#[derive(Debug, Clone, Copy, PartialEq, Eq)]
235enum Side {
236    Left,
237    Right,
238}
239
240/// The state one binding run carries.
241#[derive(Debug)]
242pub(crate) struct Binder<'a> {
243    catalog: &'a Catalog,
244    /// What the parameters were given, empty for a statement that is not prepared.
245    pub(crate) parameters: &'a Parameters,
246    /// What the settings are now, which is what `current_setting()` folds to.
247    pub(crate) session: &'a Session,
248    /// Meaning-changing choices copied once and resolved into the plan above execution.
249    pub(crate) semantics: Semantics,
250    plan: Plan,
251    next_index: u32,
252    /// Source range inherited by plan objects built for the current AST expression or query.
253    pub(crate) current_span: Span,
254    /// Set while a select block aggregates, which changes what a bare column means.
255    pub(crate) aggregation: Option<Aggregation>,
256    /// A grouped block may need stored column order to close groups while it scans. Other queries
257    /// leave the summaries in the file instead of reading every column's section while binding.
258    want_ascending: bool,
259    /// Whether this binds the query of an `ON CONFLICT DO UPDATE`, whose `excluded` reads the new
260    /// rows rather than the table.
261    pub(crate) upsert: bool,
262    /// The type and the default of each column an `INSERT` writes, handed to the `VALUES` right
263    /// under it so that a `DEFAULT` item there can be the default of the column it lands in.
264    pub(crate) insert_defaults: Option<Vec<(LogicalType, Option<String>)>>,
265    /// Whether a `DEFAULT` binds as a null that the statement replaces afterwards, which is what an
266    /// `UPDATE` does with `SET c = DEFAULT`.
267    pub(crate) default_as_null: bool,
268    /// Set while an aggregate's own arguments are being bound, so nesting is caught.
269    pub(crate) in_aggregate: bool,
270    /// Set while an aggregate's `FILTER` is being bound, which is refused its own aggregate.
271    pub(crate) in_filter: bool,
272    /// The window runs this select block has collected, in the order they were first written.
273    pub(crate) windows: Vec<WindowRun>,
274    /// The sequences a `nextval`, `currval` or `setval` named, which a table's default depends on.
275    pub(crate) sequences: Vec<QualifiedName>,
276    /// Set while a window call's own arguments and keys are being bound, so nesting is caught.
277    pub(crate) in_window: bool,
278    /// Uncorrelated scalar queries waiting to be joined into the select block that uses them.
279    pub(crate) scalar_subqueries: Vec<PendingSubquery>,
280    /// Table indices of the queries this block will join in above its grouping, not below it.
281    ///
282    /// Only ever set while a `HAVING` is being rewritten over the aggregate. A column from one of
283    /// these is not a column of the grouped table, so the rule about grouping every column does not
284    /// reach it, and the join that produces it goes on top of the `Aggregate` rather than under it.
285    pub(crate) joined_above: Vec<u32>,
286    pub(crate) outer_scopes: Vec<Scope>,
287    /// Which of the outer scopes are a FROM entry's left neighbours rather than an enclosing query.
288    ///
289    /// The two are resolved the same way and refused differently. An aggregate may read a column of
290    /// the query it is written in and may not read one a LATERAL brought in from the left, so the
291    /// check needs to know which scope the name came out of. Each entry is a position in
292    /// `outer_scopes`.
293    pub(crate) lateral_scopes: Vec<usize>,
294    pub(crate) correlations: Vec<Vec<ColumnBinding>>,
295    /// The lambdas whose bodies are being bound, innermost last. See `crate::lambda`.
296    pub(crate) lambda_frames: Vec<crate::lambda::Frame>,
297    /// Where we are, for an error message that says which clause the writer should look at.
298    pub(crate) clause: &'static str,
299    /// Whether a Parquet file that could be read through a native mirror is bound from its outline
300    /// alone, which is the columns and the row count and none of the row groups.
301    ///
302    /// Set by a bind whose plan is thrown away: a `CREATE VIEW`, and the first bind of a query that
303    /// may be bound again once its mirrors are in. A plan bound this way knows no bounds and no
304    /// distinct counts for the file, so the caller must not run it, and every read it did this for
305    /// asked for a mirror, which is how the caller knows to bind again. See
306    /// [`rudb_parquet::Outline`].
307    pub(crate) outlined: bool,
308    /// The views whose bodies are open on the stack, which is what catches a cycle.
309    expanding: Vec<String>,
310    /// The materialised `WITH` definitions whose bodies are being bound, innermost last.
311    ///
312    /// A stack rather than a map from what was written, because a plain `WITH` is put into every
313    /// place it is named, so a materialised one written inside a plain one is bound once per use
314    /// and each of those is a materialisation of its own with a number of its own.
315    materialized: Vec<Materialized>,
316    /// How many materialisations have been numbered, which is where the next number comes from.
317    next_cte: u32,
318    /// When this statement started, read once and kept, which is what `now()` folds to.
319    started: Option<i64>,
320}
321
322impl<'a> Binder<'a> {
323    pub(crate) fn with(
324        catalog: &'a Catalog,
325        parameters: &'a Parameters,
326        session: &'a Session,
327    ) -> Self {
328        Self {
329            catalog,
330            parameters,
331            session,
332            semantics: session.semantics(),
333            plan: Plan::new(),
334            next_index: 0,
335            current_span: Span::new(0, 0),
336            aggregation: None,
337            want_ascending: false,
338            upsert: false,
339            insert_defaults: None,
340            default_as_null: false,
341            in_aggregate: false,
342            in_filter: false,
343            windows: Vec::new(),
344            sequences: Vec::new(),
345            in_window: false,
346            scalar_subqueries: Vec::new(),
347            joined_above: Vec::new(),
348            outer_scopes: Vec::new(),
349            lateral_scopes: Vec::new(),
350            correlations: Vec::new(),
351            lambda_frames: Vec::new(),
352            clause: "SELECT clause",
353            outlined: false,
354            expanding: Vec::new(),
355            materialized: Vec::new(),
356            next_cte: 0,
357            started: None,
358        }
359    }
360
361    pub(crate) fn catalog(&self) -> &Catalog {
362        self.catalog
363    }
364
365    /// When this statement started, in microseconds since the epoch.
366    ///
367    /// Read from the clock the first time something asks and kept after that, so a query that
368    /// writes `now()` twice gets one answer for both. That is what the pin does and what it reports
369    /// in the `stability` column of `duckdb_functions()`, where every one of these is
370    /// `CONSISTENT_WITHIN_QUERY`. A query that never asks never reads the clock.
371    pub(crate) fn instant(&mut self) -> i64 {
372        *self.started.get_or_insert_with(crate::context::micros_now)
373    }
374
375    pub(crate) fn plan(&self) -> &Plan {
376        &self.plan
377    }
378
379    pub(crate) fn plan_mut(&mut self) -> &mut Plan {
380        &mut self.plan
381    }
382
383    pub(crate) fn add_expr(&mut self, expr: Expr, ty: LogicalType) -> ExprRef {
384        self.plan.add_expr_at(expr, ty, self.current_span)
385    }
386
387    pub(crate) fn add_constant(&mut self, value: Value) -> ExprRef {
388        let ty = value.logical_type();
389        let reference = self.plan.add_value(value);
390        self.plan.add_expr_at(Expr::Constant(reference), ty, self.current_span)
391    }
392
393    pub(crate) fn add_node(&mut self, node: Node) -> NodeRef {
394        self.plan.add_node_at(node, self.current_span)
395    }
396
397    pub(crate) fn into_plan(self) -> Plan {
398        self.plan
399    }
400
401    /// A table index nothing else has.
402    pub(crate) fn fresh_index(&mut self) -> u32 {
403        let index = self.next_index;
404        self.next_index += 1;
405        index
406    }
407
408    /// A reference to one column of an operator's output.
409    fn column(&mut self, index: u32, position: usize, ty: LogicalType) -> ExprRef {
410        let binding = ColumnBinding::new(index, position as u32);
411        self.plan.add_expr(Expr::Column(binding), ty)
412    }
413
414    /// Joins scalar query results into the row stream that contains their expressions.
415    fn attach_scalar_subqueries(&mut self, mut input: NodeRef) -> NodeRef {
416        let subqueries = std::mem::take(&mut self.scalar_subqueries);
417        for pending in subqueries {
418            input = self.attach_subquery(input, pending);
419        }
420        input
421    }
422
423    /// Joins one query's result into a row stream, which is where its columns come from.
424    ///
425    /// Split out from [`Self::attach_scalar_subqueries`] because a join's `ON` does not attach its
426    /// queries to the rows the whole `FROM` produced. It attaches them to one of the join's two
427    /// inputs, since a join condition is evaluated by the join and can only read what the join was
428    /// given.
429    fn attach_subquery(&mut self, input: NodeRef, pending: PendingSubquery) -> NodeRef {
430        let PendingSubquery {
431            node: mut right,
432            kind,
433            conditions,
434            dependent,
435            reads: _,
436            index: _,
437            inside_aggregate: _,
438        } = pending;
439        if kind == JoinKind::Single && !self.semantics.scalar_subquery_error_on_multiple_rows() {
440            right = self.add_node(Node::Limit {
441                input: right,
442                count: Bound::Rows(1),
443                offset: Bound::Rows(0),
444            });
445        }
446        let conditions = self.plan.add_expr_list(&conditions);
447        if dependent {
448            self.add_node(Node::DependentJoin { left: input, right, kind, conditions })
449        } else {
450            self.add_node(Node::Join {
451                left: input,
452                right,
453                kind,
454                conditions,
455                build: BuildSide::default(),
456            })
457        }
458    }
459
460    // ---------------------------------------------------------------- queries
461
462    pub(crate) fn bind_query(
463        &mut self,
464        ast: &Ast,
465        query: ast::QueryRef,
466    ) -> Result<(NodeRef, Scope)> {
467        let span = ast.query_span(query);
468        let outer = std::mem::replace(&mut self.current_span, span);
469        let result =
470            self.bind_query_inner(ast, query).map_err(|error| error.with_fallback_span(span));
471        self.current_span = outer;
472        result
473    }
474
475    fn bind_query_inner(&mut self, ast: &Ast, query: ast::QueryRef) -> Result<(NodeRef, Scope)> {
476        let written = ast.query(query);
477        if written.ctes.is_empty() {
478            return self.bind_body(ast, &written);
479        }
480        // The names a query introduces are gone again once it is bound, and they go whether the
481        // binding worked or not, which is why the stack is cut back here rather than at the end of
482        // the call that pushed onto it.
483        let depth = self.materialized.len();
484        let result = self.bind_materialized(ast, &written);
485        self.materialized.truncate(depth);
486        result
487    }
488
489    /// A query with materialised `WITH` definitions in front of it.
490    ///
491    /// The definitions are bound first and in the order they were written, so that a later one can
492    /// read an earlier one, and then the body. The wrapping runs backwards so that the first
493    /// definition ends up outermost, which is the order they have to be filled in.
494    fn bind_materialized(&mut self, ast: &Ast, written: &ast::Query) -> Result<(NodeRef, Scope)> {
495        let depth = self.materialized.len();
496        let held = ast.cte_list(written.ctes).to_vec();
497        let mut definitions = Vec::with_capacity(held.len());
498        for &index in &held {
499            definitions.push(self.bind_definition(ast, index)?);
500        }
501        let (mut node, scope) = self.bind_body(ast, written)?;
502        for (at, definition) in definitions.into_iter().enumerate().rev() {
503            let entry = &self.materialized[depth + at];
504            let cte = entry.cte;
505            let name = entry.name.clone();
506            let fields = entry.fields.clone();
507            let name = self.plan.intern(&name);
508            let columns = self.plan.add_fields(&fields);
509            node =
510                self.add_node(Node::MaterializedCte { definition, body: node, name, cte, columns });
511        }
512        Ok((node, scope))
513    }
514
515    /// Binds one materialised `WITH` definition and makes its name readable from there on.
516    ///
517    /// The definition is projected onto exactly the columns a read of it sees, under the names the
518    /// column list declared when there was one. That projection is not decoration: what is held is
519    /// what a read gets back, so the held rows have to be the rows of the definition's own select
520    /// list and nothing it happened to carry along underneath.
521    ///
522    /// A column list with more names in it than the definition has columns is not an error here,
523    /// which is the pinned build's rule and is written out on [`Scope::rename_prefix`].
524    fn bind_definition(&mut self, ast: &Ast, index: u32) -> Result<NodeRef> {
525        let held = ast.cte(index);
526        let name = ast.string(held.name).to_string();
527        let (node, mut scope) = self.bind_query(ast, held.query)?;
528        if !held.columns.is_empty() {
529            let names: Vec<&str> = ast.name(held.columns).collect();
530            scope.rename_prefix(&names);
531        }
532        let table = self.fresh_index();
533        let mut exprs = Vec::with_capacity(scope.len());
534        let mut names = Vec::with_capacity(scope.len());
535        for column in &scope.columns {
536            exprs.push(self.plan.add_expr(Expr::Column(column.binding), column.ty.clone()));
537            names.push(self.plan.intern(&column.name));
538        }
539        let exprs = self.plan.add_expr_list(&exprs);
540        let names = self.plan.add_name_list(&names);
541        let node = self.add_node(Node::Project { input: node, index: table, exprs, names });
542        let cte = self.next_cte;
543        self.next_cte += 1;
544        self.materialized.push(Materialized { written: index, cte, name, fields: scope.fields() });
545        Ok(node)
546    }
547
548    fn bind_body(&mut self, ast: &Ast, written: &ast::Query) -> Result<(NodeRef, Scope)> {
549        match written.body {
550            ast::QueryBody::Select(select) => self.bind_select(ast, select, written),
551            ast::QueryBody::SetOp { op, quantifier, by_name, left, right } => {
552                let operator = Operator { op, quantifier, by_name };
553                self.bind_set_op(ast, written, operator, left, right)
554            }
555            ast::QueryBody::Values(rows) => self.bind_values(ast, written, rows),
556            ast::QueryBody::Describe(inner) => self.bind_describe(ast, written, inner),
557            ast::QueryBody::Show { name, relation } => self.bind_show(ast, written, name, relation),
558        }
559    }
560
561    /// `SHOW name`, resolved while binding so execution receives an ordinary constant plan.
562    fn bind_show(
563        &mut self,
564        ast: &Ast,
565        query: &ast::Query,
566        name: ast::Slice,
567        relation: ast::QueryRef,
568    ) -> Result<(NodeRef, Scope)> {
569        let text = ast.name_text(name);
570        let parts: Vec<&str> = ast.name(name).collect();
571        let table_exists = self.catalog.resolve(&parts).is_ok();
572        let as_table = match self.semantics.show_behavior() {
573            ShowBehavior::Auto => table_exists,
574            ShowBehavior::Setting => false,
575            ShowBehavior::Table => true,
576        };
577        if as_table {
578            return self.bind_describe(ast, query, relation);
579        }
580        // A name the session has no answer for is either a setting rudb has and DuckDB does not, in
581        // which case [`Binder::beyond`] reads it, or it is nothing, in which case that says so in
582        // upstream's words. `SHOW` prints and printing is text, so a rule's boolean comes back here
583        // as the word it reads back as rather than as a boolean column.
584        let shown = match self.session.iter().find(|(name, _)| name.eq_ignore_ascii_case(&text)) {
585            Some((_, value)) => value.to_string(),
586            None => match self.beyond(&text)? {
587                Some(Value::Varchar(declared)) => declared,
588                Some(other) => other.to_string(),
589                None => {
590                    return Err(Error::catalog(format!(
591                        "Setting with name \"{text}\" does not exist"
592                    )));
593                }
594            },
595        };
596        let field = Field::new(text, LogicalType::Varchar);
597        let expr = self.plan.add_constant(Value::Varchar(shown));
598        let row = self.plan.add_expr_list(&[expr]);
599        let rows = self.plan.add_rows(&[row]);
600        let columns = self.plan.add_fields(std::slice::from_ref(&field));
601        let index = self.fresh_index();
602        let node = self.add_node(Node::Values { index, columns, rows });
603        let mut scope = Scope::empty();
604        scope.push(Visible {
605            table: String::new(),
606            name: field.name,
607            binding: ColumnBinding::new(index, 0),
608            ty: LogicalType::Varchar,
609            not_null: false,
610            key: None,
611            default: None,
612            qualified: false,
613            also: None,
614        });
615        Ok((node, scope))
616    }
617
618    /// `DESCRIBE <query>`, which is six VARCHAR columns saying what the query returns.
619    ///
620    /// The query is bound and never run, because binding is the whole of the answer: the names and
621    /// the types of a query's columns are settled by the time the binder is done with it, so the
622    /// rows of a describe are a constant from there on. That is why this comes out as a `VALUES`
623    /// whose rows were computed here rather than as an operator of its own, and it is what makes
624    /// `SELECT column_name FROM (DESCRIBE ...) WHERE ...` an ordinary query over an ordinary
625    /// relation with no special case above it.
626    ///
627    /// The six columns, their order and their types are the reference binary's. `key` says which
628    /// key of its table a column passed straight through from one is in. `default` is the SQL of the column's `DEFAULT` in the pin's spelling, and
629    /// `extra` is empty upstream as well on every table it was asked about. They are here rather
630    /// than left out because the width of a result is part of the result, and a program that reads
631    /// the fifth column has to find one.
632    fn bind_describe(
633        &mut self,
634        ast: &Ast,
635        query: &ast::Query,
636        inner: ast::QueryRef,
637    ) -> Result<(NodeRef, Scope)> {
638        let (_, described) = self.bind_query(ast, inner)?;
639        let fields: Vec<Field> = ["column_name", "column_type", "null", "key", "default", "extra"]
640            .iter()
641            .map(|name| Field::new(*name, LogicalType::Varchar))
642            .collect();
643        let mut slices = Vec::with_capacity(described.columns.len());
644        for column in described.columns.clone() {
645            // `NO` and `YES` and not a boolean, because the column is VARCHAR upstream and a
646            // client that prints the result has to get the same four or three characters.
647            let written = [
648                column.name.clone(),
649                column.ty.to_string(),
650                if column.not_null { "NO" } else { "YES" }.to_owned(),
651            ];
652            let mut items: Vec<ExprRef> = written
653                .into_iter()
654                .map(|text| self.plan.add_constant(Value::Varchar(text)))
655                .collect();
656            let mark = match column.key {
657                Some(mark) => self.plan.add_constant(Value::Varchar(mark.to_owned())),
658                None => {
659                    let empty = self.plan.add_constant(Value::Null);
660                    self.cast_to(empty, &LogicalType::Varchar)
661                }
662            };
663            items.push(mark);
664            if let Some(default) = &column.default {
665                items.push(self.plan.add_constant(Value::Varchar(default.clone())));
666            }
667            while items.len() < 6 {
668                let empty = self.plan.add_constant(Value::Null);
669                items.push(self.cast_to(empty, &LogicalType::Varchar));
670            }
671            slices.push(self.plan.add_expr_list(&items));
672        }
673        let rows = self.plan.add_rows(&slices);
674        let columns = self.plan.add_fields(&fields);
675        let index = self.fresh_index();
676        let mut node = self.add_node(Node::Values { index, columns, rows });
677        let mut scope = Scope::empty();
678        for (at, field) in fields.iter().enumerate() {
679            scope.push(Visible {
680                table: String::new(),
681                name: field.name.clone(),
682                binding: ColumnBinding::new(index, at as u32),
683                ty: field.ty.clone(),
684                not_null: false,
685                key: None,
686                default: None,
687                qualified: false,
688                also: None,
689            });
690        }
691        let keys = self.sort_keys(ast, query, &scope, &[])?;
692        if !keys.is_empty() {
693            let keys = self.plan.add_sort_keys(&keys);
694            node = self.add_node(Node::Sort { input: node, keys });
695        }
696        node = self.apply_limit(ast, query, node, &mut scope)?;
697        Ok((node, scope))
698    }
699
700    /// A column's default as an expression of the column's type, or a null of that type for a
701    /// column with none. A typed null rather than `add_constant`, which would give it the null
702    /// type and make the column's type depend on whether a row happened to be inserted into it.
703    pub(crate) fn bind_default(&mut self, text: Option<&str>, ty: &LogicalType) -> Result<ExprRef> {
704        let Some(text) = text else {
705            let value = self.plan.add_value(Value::Null);
706            return Ok(self.plan.add_expr(Expr::Constant(value), ty.clone()));
707        };
708        let ast = rudb_parse::parse_ast(&format!("SELECT {text}"))?;
709        let found = match ast.statements.first() {
710            Some(&ast::Statement::Query(query)) => match ast.query(query).body {
711                ast::QueryBody::Select(select) => {
712                    ast.target_list(ast.select(select).targets).first().map(|target| target.expr)
713                }
714                _ => None,
715            },
716            _ => None,
717        };
718        let Some(expr) = found else {
719            return Err(Error::internal(format!("a default that is not an expression: {text}")));
720        };
721        let expr = self.bind_expr(&ast, expr, &Scope::empty())?;
722        self.checked_cast_to(expr, ty, false)
723    }
724
725    /// Whether a projected expression is a column passed straight through from below.
726    ///
727    /// Only `DESCRIBE` asks, and only to decide whether the `null` column says `NO`. Anything that
728    /// is computed is nullable however strict its inputs were, which is both the safe reading and
729    /// the one the reference binary gives.
730    fn passes_through(&self, expr: ExprRef, input: &Scope) -> bool {
731        let Expr::Column(binding) = *self.plan.expr(expr) else { return false };
732        input.columns.iter().any(|column| column.binding == binding && column.not_null)
733    }
734
735    /// The key a projected expression is in, when it is a column passed straight through from a
736    /// table that has one. The same question as [`Self::passes_through`], asked for `DESCRIBE`'s
737    /// `key` column.
738    fn key_through(&self, expr: ExprRef, input: &Scope) -> Option<&'static str> {
739        self.through(expr, input).and_then(|column| column.key)
740    }
741
742    /// The column a projected expression passes straight through from below, if it is one.
743    fn through<'s>(&self, expr: ExprRef, input: &'s Scope) -> Option<&'s Visible> {
744        let Expr::Column(binding) = *self.plan.expr(expr) else { return None };
745        input.columns.iter().find(|column| column.binding == binding)
746    }
747
748    /// `VALUES (1, 'a'), (2, 'b')`, as a query in its own right.
749    ///
750    /// The column names are `col0`, `col1` and so on, which is what DuckDB calls them, and the
751    /// column types are what every row in that position promotes to. Promotion is the same rule a
752    /// set operation uses, and for the same reason: a column has one type and the rows have to
753    /// agree on it before anything downstream can read the column.
754    fn bind_values(
755        &mut self,
756        ast: &Ast,
757        query: &ast::Query,
758        rows: ast::Slice,
759    ) -> Result<(NodeRef, Scope)> {
760        let written = ast.rows(rows).to_vec();
761        let Some(first) = written.first() else {
762            return Err(Error::binder("VALUES needs at least one row"));
763        };
764        let width = first.len as usize;
765        for (at, row) in written.iter().enumerate() {
766            if row.len as usize != width {
767                return Err(Error::binder(format!(
768                    "VALUES lists must all be the same length, expected {width} columns but row {} has {}",
769                    at + 1,
770                    row.len
771                )));
772            }
773        }
774        // A row of a `VALUES` cannot see a column, because there is nothing under it to see.
775        let empty = Scope::empty();
776        let defaults = self.insert_defaults.take();
777        let previous = std::mem::replace(&mut self.clause, "VALUES clause");
778        let mut bound: Vec<Vec<ExprRef>> = Vec::with_capacity(written.len());
779        for row in &written {
780            let mut items = Vec::with_capacity(width);
781            for (at, &expr) in ast.expr_list(*row).iter().enumerate() {
782                let column = defaults.as_ref().and_then(|defaults| defaults.get(at));
783                items.push(match (ast.expr(expr), column) {
784                    (ast::Expr::Default, Some((ty, default))) => {
785                        self.bind_default(default.as_deref(), ty)?
786                    }
787                    _ => self.bind_expr(ast, expr, &empty)?,
788                });
789            }
790            bound.push(items);
791        }
792        self.clause = previous;
793        let mut types = Vec::with_capacity(width);
794        for at in 0..width {
795            let mut ty = self.plan.expr_type(bound[0][at]).clone();
796            for row in &bound[1..] {
797                let other = self.plan.expr_type(row[at]).clone();
798                ty = ty.promote(&other).ok_or_else(|| {
799                    Error::binder(format!(
800                        "Cannot combine a value of type {ty} with a value of type {other} in column {} of a VALUES",
801                        at + 1
802                    ))
803                })?;
804            }
805            types.push(ty);
806        }
807        let mut slices = Vec::with_capacity(bound.len());
808        for row in &bound {
809            let items: Vec<ExprRef> = row
810                .iter()
811                .zip(&types)
812                .map(|(&expr, ty)| self.checked_cast_to(expr, ty, false))
813                .collect::<Result<_>>()?;
814            slices.push(self.plan.add_expr_list(&items));
815        }
816        let rows = self.plan.add_rows(&slices);
817        let fields: Vec<Field> = types
818            .iter()
819            .enumerate()
820            .map(|(at, ty)| Field::new(format!("col{at}"), ty.clone()))
821            .collect();
822        let columns = self.plan.add_fields(&fields);
823        let index = self.fresh_index();
824        let mut node = self.add_node(Node::Values { index, columns, rows });
825        let mut scope = Scope::empty();
826        for (at, field) in fields.iter().enumerate() {
827            scope.push(Visible {
828                table: String::new(),
829                name: field.name.clone(),
830                binding: ColumnBinding::new(index, at as u32),
831                ty: field.ty.clone(),
832                not_null: false,
833                key: None,
834                default: None,
835                qualified: false,
836                also: None,
837            });
838        }
839        let keys = self.sort_keys(ast, query, &scope, &[])?;
840        if !keys.is_empty() {
841            let keys = self.plan.add_sort_keys(&keys);
842            node = self.add_node(Node::Sort { input: node, keys });
843        }
844        node = self.apply_limit(ast, query, node, &mut scope)?;
845        Ok((node, scope))
846    }
847
848    fn bind_set_op(
849        &mut self,
850        ast: &Ast,
851        query: &ast::Query,
852        operator: Operator,
853        left: ast::QueryRef,
854        right: ast::QueryRef,
855    ) -> Result<(NodeRef, Scope)> {
856        let (left_node, left_scope) = self.bind_query(ast, left)?;
857        let (right_node, right_scope) = self.bind_query(ast, right)?;
858        let merged = if operator.by_name {
859            match_by_name(&left_scope, &right_scope)?
860        } else {
861            match_by_position(&left_scope, &right_scope)?
862        };
863        let left_node = self.conform(left_node, &left_scope, &merged, |column| column.left)?;
864        let right_node = self.conform(right_node, &right_scope, &merged, |column| column.right)?;
865        let index = self.fresh_index();
866        let kind = match operator.op {
867            SetOp::Union => SetOpKind::Union,
868            SetOp::Except => SetOpKind::Except,
869            SetOp::Intersect => SetOpKind::Intersect,
870        };
871        // UNION alone removes duplicates and UNION ALL keeps them, which is the one place the
872        // unwritten quantifier and ALL disagree.
873        let all = operator.quantifier == Quantifier::All;
874        let mut node =
875            self.add_node(Node::SetOp { left: left_node, right: right_node, kind, all, index });
876        let mut scope = Scope::empty();
877        for (at, column) in merged.iter().enumerate() {
878            scope.push(Visible {
879                table: String::new(),
880                name: column.name.clone(),
881                binding: ColumnBinding::new(index, at as u32),
882                ty: column.ty.clone(),
883                // A column of a set operation is nullable whatever the two sides were, because a
884                // column that refuses nulls on one side and takes them on the other takes them.
885                not_null: false,
886                key: None,
887                default: None,
888                qualified: false,
889                also: None,
890            });
891        }
892        // Above a set operation there is nothing but the output columns, so an ORDER BY term is
893        // either a position, an output name, or an expression over the output, and never needs a
894        // column projected for it that the query did not ask for.
895        let keys = self.sort_keys(ast, query, &scope, &[])?;
896        if !keys.is_empty() {
897            let keys = self.plan.add_sort_keys(&keys);
898            node = self.add_node(Node::Sort { input: node, keys });
899        }
900        node = self.apply_limit(ast, query, node, &mut scope)?;
901        Ok((node, scope))
902    }
903
904    /// Projects one side of a set operation onto the columns the operation comes out with.
905    ///
906    /// `pick` says which column of this side each output column is. It answers nothing for a
907    /// column only the other side wrote, which happens under `BY NAME` and which this side fills
908    /// with a null, since that is the row it would have written if it had written the column.
909    fn conform(
910        &mut self,
911        node: NodeRef,
912        scope: &Scope,
913        merged: &[Merged],
914        pick: impl Fn(&Merged) -> Option<usize>,
915    ) -> Result<NodeRef> {
916        let unchanged = merged.len() == scope.len()
917            && merged
918                .iter()
919                .enumerate()
920                .all(|(at, column)| pick(column) == Some(at) && column.ty == scope.columns[at].ty);
921        if unchanged {
922            return Ok(node);
923        }
924        let index = self.fresh_index();
925        let mut exprs = Vec::with_capacity(merged.len());
926        let mut names = Vec::with_capacity(merged.len());
927        for column in merged {
928            let expr = match pick(column) {
929                Some(at) => {
930                    let held = &scope.columns[at];
931                    self.plan.add_expr(Expr::Column(held.binding), held.ty.clone())
932                }
933                None => self.plan.add_constant(Value::Null),
934            };
935            exprs.push(self.checked_cast_to(expr, &column.ty, false)?);
936            names.push(self.plan.intern(&column.name));
937        }
938        let exprs = self.plan.add_expr_list(&exprs);
939        let names = self.plan.add_name_list(&names);
940        Ok(self.add_node(Node::Project { input: node, index, exprs, names }))
941    }
942
943    // ----------------------------------------------------------------- select
944
945    fn bind_select(
946        &mut self,
947        ast: &Ast,
948        select: ast::SelectRef,
949        query: &ast::Query,
950    ) -> Result<(NodeRef, Scope)> {
951        let written = ast.select(select);
952        self.want_ascending |= !written.group_by.is_empty() || written.group_by_all;
953        // A window belongs to the block that wrote it, and a block can be bound inside another one
954        // without a subquery in between, so the outer block's runs are put aside for the duration
955        // rather than left where a nested block would append to them.
956        let outer_windows = std::mem::take(&mut self.windows);
957        // Same argument for the queries lifted over this block's grouping. They are recorded while
958        // the select list is being bound and read until the sort keys are done, and a block bound
959        // inside that stretch has its own set, so the outer block's is put aside rather than left
960        // where the inner one would clear it.
961        let outer_joined_above = std::mem::take(&mut self.joined_above);
962        let (mut node, input) = self.bind_from(ast, written.from)?;
963        node = self.attach_scalar_subqueries(node);
964
965        if written.filter != NONE {
966            self.clause = "WHERE clause";
967            let predicate = self.bind_expr(ast, written.filter, &input)?;
968            let predicate = self.as_boolean(predicate, "WHERE")?;
969            node = self.attach_scalar_subqueries(node);
970            node = self.add_node(Node::Filter { input: node, predicate });
971        }
972
973        let targets = ast.target_list(written.targets).to_vec();
974        if targets.is_empty() {
975            return Err(Error::binder("a SELECT needs at least one expression to select"));
976        }
977
978        let group_items = self.group_items(ast, &written, &targets)?;
979        let aggregating = !group_items.is_empty()
980            || written.having != NONE
981            || targets.iter().any(|target| has_aggregate(ast, target.expr));
982        if aggregating {
983            self.clause = "GROUP BY clause";
984            let mut groups = Vec::with_capacity(group_items.len());
985            for item in &group_items {
986                groups.push(self.bind_expr(ast, *item, &input)?);
987            }
988            let index = self.fresh_index();
989            self.aggregation = Some(Aggregation { index, groups, aggregates: Vec::new() });
990        }
991
992        // The queries this block's clauses wrote that are joined in above the grouping rather than
993        // below it. TPC-H q11 is the case in a `HAVING`: `HAVING sum(ps_supplycost * ps_availqty) >
994        // (SELECT sum(...))` compares one group's total against a total over the whole table, and
995        // the second total is one row that has nothing to do with the groups. Joined underneath the
996        // grouping it would be a column of every input row and the grouping rule would ask for it in
997        // the GROUP BY, which is the complaint this used to make.
998        let mut above = Vec::new();
999
1000        self.clause = "SELECT clause";
1001        let (mut exprs, mut names) = self.bind_targets(ast, &targets, &input, &mut above)?;
1002        let visible = exprs.len();
1003
1004        let mut having = None;
1005        if written.having != NONE {
1006            self.clause = "HAVING clause";
1007            let before = self.scalar_subqueries.len();
1008            let predicate = self.bind_expr(ast, written.having, &input)?;
1009            self.lift_over_aggregate(before, &mut above, &input)?;
1010            let predicate = self.over_aggregate(predicate, &input)?;
1011            having = Some(self.as_boolean(predicate, "HAVING")?);
1012        }
1013
1014        // The projection's index has to exist before the sort keys are built, because a key is a
1015        // reference to a projected column even when the expression it sorts on is not selected.
1016        let project = self.fresh_index();
1017        let mut output = Scope::empty();
1018        for (at, (expr, name)) in exprs.iter().zip(&names).enumerate() {
1019            output.push(Visible {
1020                table: String::new(),
1021                name: name.clone(),
1022                binding: ColumnBinding::new(project, at as u32),
1023                ty: self.plan.expr_type(*expr).clone(),
1024                not_null: self.passes_through(*expr, &input),
1025                key: self.key_through(*expr, &input),
1026                default: self.through(*expr, &input).and_then(|column| column.default.clone()),
1027                qualified: false,
1028                also: None,
1029            });
1030        }
1031
1032        self.clause = "ORDER BY clause";
1033        let mut extra = Vec::new();
1034        let keys = self.select_sort_keys(
1035            ast, query, &input, &output, project, &mut exprs, &mut names, &mut extra, &mut above,
1036        )?;
1037        self.joined_above = outer_joined_above;
1038        if !extra.is_empty() && written.distinct != Distinct::No {
1039            return Err(Error::binder(
1040                "For SELECT DISTINCT, ORDER BY expressions must appear in the select list",
1041            ));
1042        }
1043        let on = self.distinct_on(ast, written.distinct, &output)?;
1044
1045        node = self.attach_scalar_subqueries(node);
1046
1047        if let Some(aggregation) = self.aggregation.take() {
1048            let index = aggregation.index;
1049            let groups = self.plan.add_expr_list(&aggregation.groups);
1050            let aggregates = self.plan.add_expr_list(&aggregation.aggregates);
1051            node = self.add_node(Node::Aggregate { input: node, index, groups, aggregates });
1052        }
1053        if !above.is_empty() {
1054            debug_assert!(self.scalar_subqueries.is_empty(), "a query is waiting to be joined");
1055            self.scalar_subqueries = above;
1056            node = self.attach_scalar_subqueries(node);
1057        }
1058        if let Some(predicate) = having {
1059            node = self.add_node(Node::Filter { input: node, predicate });
1060        }
1061
1062        // After the grouping and after `HAVING`, which is where the reference binary puts it:
1063        // `SELECT j, sum(count(i)) OVER () FROM t GROUP BY j HAVING count(i) > 1` totals only the
1064        // groups that survived the filter.
1065        for run in std::mem::replace(&mut self.windows, outer_windows) {
1066            let partition = self.plan.add_expr_list(&run.partition);
1067            let order = self.plan.add_sort_keys(&run.order);
1068            let expressions = self.plan.add_expr_list(&run.calls);
1069            node = self.add_node(Node::Window {
1070                input: node,
1071                index: run.index,
1072                partition,
1073                order,
1074                frame: run.frame,
1075                expressions,
1076            });
1077        }
1078
1079        let interned: Vec<u32> = names.iter().map(|name| self.plan.intern(name)).collect();
1080        let exprs_slice = self.plan.add_expr_list(&exprs);
1081        let names_slice = self.plan.add_name_list(&interned);
1082        node = self.add_node(Node::Project {
1083            input: node,
1084            index: project,
1085            exprs: exprs_slice,
1086            names: names_slice,
1087        });
1088
1089        if written.distinct != Distinct::No {
1090            let on = self.plan.add_expr_list(&on);
1091            node = self.add_node(Node::Distinct { input: node, on });
1092        }
1093        if !keys.is_empty() {
1094            let keys = self.plan.add_sort_keys(&keys);
1095            node = self.add_node(Node::Sort { input: node, keys });
1096        }
1097        node = self.apply_limit(ast, query, node, &mut output)?;
1098
1099        if extra.is_empty() {
1100            output.columns.truncate(visible);
1101            return Ok((node, output));
1102        }
1103        // An expression sorted on but not selected was carried this far to make the sort possible,
1104        // and now it goes, because the query did not ask for it.
1105        let index = self.fresh_index();
1106        let mut kept = Vec::with_capacity(visible);
1107        let mut kept_names = Vec::with_capacity(visible);
1108        let mut scope = Scope::empty();
1109        for (at, name) in names.iter().enumerate().take(visible) {
1110            let ty = output.columns[at].ty.clone();
1111            // Through the scope rather than through `project`, because a limit that had a query
1112            // joined in under it put a projection of its own over the top and these columns are
1113            // that projection's now.
1114            let binding = output.columns[at].binding;
1115            kept.push(self.plan.add_expr(Expr::Column(binding), ty.clone()));
1116            kept_names.push(self.plan.intern(name));
1117            scope.push(Visible {
1118                table: String::new(),
1119                name: name.clone(),
1120                binding: ColumnBinding::new(index, at as u32),
1121                ty,
1122                not_null: output.columns[at].not_null,
1123                key: output.columns[at].key,
1124                default: output.columns[at].default.clone(),
1125                qualified: false,
1126                also: None,
1127            });
1128        }
1129        let exprs = self.plan.add_expr_list(&kept);
1130        let names = self.plan.add_name_list(&kept_names);
1131        node = self.add_node(Node::Project { input: node, index, exprs, names });
1132        Ok((node, scope))
1133    }
1134
1135    /// Binds the target list, expanding every star into the columns it stands for.
1136    /// Moves the queries a clause just wrote from under this block's grouping to over it.
1137    ///
1138    /// A query written in a select list, a `HAVING` or an `ORDER BY` is one row that has nothing to
1139    /// do with the groups, so it belongs on top of the grouping and not underneath it. Underneath,
1140    /// its column is a column of every row going into the aggregate, which the grouping rule then
1141    /// asks for in the `GROUP BY`, and the aggregate carries nothing but its groups and its
1142    /// aggregates upward, so the projection could not read the column even if the rule let it
1143    /// through. That is both halves of #1027.
1144    ///
1145    /// A correlated one goes over the grouping too when what it correlates to is a column the block
1146    /// groups by, which is [`Self::lift_correlated`], and stays underneath when it is not. One
1147    /// written inside an aggregate call stays underneath whatever it correlates to, since that is
1148    /// read once per row going into the aggregate and lifting it over would put it where the
1149    /// aggregate that reads it cannot.
1150    ///
1151    /// `before` is what [`Self::scalar_subqueries`] held before the clause was bound, so only the
1152    /// queries that clause wrote are considered.
1153    fn lift_over_aggregate(
1154        &mut self,
1155        before: usize,
1156        above: &mut Vec<PendingSubquery>,
1157        scope: &Scope,
1158    ) -> Result<()> {
1159        if self.aggregation.is_none() {
1160            return Ok(());
1161        }
1162        let mut lifted = Vec::new();
1163        for mut pending in self.scalar_subqueries.split_off(before) {
1164            let stays = pending.inside_aggregate
1165                || (pending.dependent && !self.lift_correlated(&mut pending));
1166            if stays {
1167                self.scalar_subqueries.push(pending);
1168            } else {
1169                self.joined_above.push(pending.index);
1170                lifted.push(pending);
1171            }
1172        }
1173        // A mark join carries its comparison rather than the expression carrying it, and that
1174        // comparison is written over the outer rows, so it needs the same rewrite the expression
1175        // gets. It is done in a second pass so that a comparison reading another query lifted by
1176        // the same clause finds that query's index already recorded.
1177        for pending in &mut lifted {
1178            let conditions = std::mem::take(&mut pending.conditions);
1179            let mut over = Vec::with_capacity(conditions.len());
1180            for condition in conditions {
1181                over.push(self.over_aggregate(condition, scope)?);
1182            }
1183            pending.conditions = over;
1184        }
1185        above.append(&mut lifted);
1186        Ok(())
1187    }
1188
1189    /// Moves one correlated query over this block's grouping, if the grouping lets it.
1190    ///
1191    /// It does when every outer column the query reads is a column this block groups by. That value
1192    /// is the group's own column above the aggregate, the same value read from a different operator,
1193    /// so the query can be joined against the groups instead of against the rows going into them,
1194    /// and what the query answers per group is what it answered per row of a group since every row
1195    /// of a group agreed on it. The rewrite is the references inside the query's body, which were
1196    /// bound against the table underneath and have to read the aggregate's output instead.
1197    ///
1198    /// A correlation on a column that is neither grouped nor aggregated is a different question with
1199    /// a different answer and there is nothing above the grouping that holds it, so that query stays
1200    /// where it is and [`Self::over_aggregate`] reports it as the missing `GROUP BY` it is. That is
1201    /// #1032.
1202    ///
1203    /// The query stays a dependent join either way. What changed is which operator the outer rows
1204    /// come from, not that there are any.
1205    fn lift_correlated(&mut self, pending: &mut PendingSubquery) -> bool {
1206        let Some(index) = self.aggregation.as_ref().map(|aggregation| aggregation.index) else {
1207            return false;
1208        };
1209        let mut moved = Vec::with_capacity(pending.reads.len());
1210        for read in &pending.reads {
1211            let Some(at) = self.group_of(*read) else {
1212                return false;
1213            };
1214            moved.push((*read, ColumnBinding::new(index, at as u32)));
1215        }
1216        let mut rewrites = Vec::new();
1217        self.plan.subtree_columns(pending.node, &mut |reference, binding| {
1218            if let Some(&(_, to)) = moved.iter().find(|(from, _)| *from == binding) {
1219                rewrites.push((reference, to));
1220            }
1221        });
1222        for (reference, to) in rewrites {
1223            self.plan.rebind(reference, to);
1224        }
1225        pending.reads = moved.into_iter().map(|(_, to)| to).collect();
1226        true
1227    }
1228
1229    fn bind_targets(
1230        &mut self,
1231        ast: &Ast,
1232        targets: &[ast::Target],
1233        input: &Scope,
1234        above: &mut Vec<PendingSubquery>,
1235    ) -> Result<(Vec<ExprRef>, Vec<String>)> {
1236        let mut exprs = Vec::with_capacity(targets.len());
1237        let mut names = Vec::with_capacity(targets.len());
1238        for target in targets {
1239            if let ast::Expr::Star { qualifier, replacements } = ast.expr(target.expr) {
1240                let table = ast.name(qualifier).last().map(str::to_string);
1241                let expanded: Vec<Visible> =
1242                    input.star(table.as_deref())?.into_iter().cloned().collect();
1243                let replacements = ast.target_list(replacements).to_vec();
1244                let mut used = vec![false; replacements.len()];
1245                for column in expanded {
1246                    let found = replacements.iter().zip(&mut used).find(|(replacement, _)| {
1247                        same_name(ast.string(replacement.alias), &column.name)
1248                    });
1249                    // The replacement takes the column's place and its position, and it is named the
1250                    // way the replace list spells it rather than the way the table does. That only
1251                    // shows when the two differ in case, and `AS EventDate` over a column called
1252                    // `eventdate` is exactly the case that shows it.
1253                    let before = self.scalar_subqueries.len();
1254                    let (expr, name) = match found {
1255                        Some((replacement, used)) => {
1256                            *used = true;
1257                            let expr = self.bind_expr(ast, replacement.expr, input)?;
1258                            (expr, ast.string(replacement.alias).to_string())
1259                        }
1260                        None => (
1261                            self.plan.add_expr(Expr::Column(column.binding), column.ty),
1262                            column.name,
1263                        ),
1264                    };
1265                    self.lift_over_aggregate(before, above, input)?;
1266                    exprs.push(self.over_aggregate(expr, input)?);
1267                    names.push(name);
1268                }
1269                // A replace list that named something the star did not stand for is a mistake and
1270                // not a no op, and it is caught here because this is the first point at which the
1271                // set of names the star stands for is known.
1272                if let Some((replacement, _)) =
1273                    replacements.iter().zip(&used).find(|(_, used)| !**used)
1274                {
1275                    return Err(missing_replacement(ast.string(replacement.alias), input));
1276                }
1277                continue;
1278            }
1279            let before = self.scalar_subqueries.len();
1280            let expr = self.bind_expr(ast, target.expr, input)?;
1281            self.lift_over_aggregate(before, above, input)?;
1282            exprs.push(self.over_aggregate(expr, input)?);
1283            names.push(if target.alias == NONE {
1284                self.output_name(ast, target.expr, input)
1285            } else {
1286                ast.string(target.alias).to_string()
1287            });
1288        }
1289        Ok((exprs, names))
1290    }
1291
1292    /// The name an unaliased target gets.
1293    ///
1294    /// A bare column keeps the spelling the table was created with rather than the spelling the
1295    /// query used, so `SELECT USERID FROM hits` has a column called `UserID`. Identifiers match
1296    /// without regard to case and the catalog is the one that holds the case.
1297    fn output_name(&self, ast: &Ast, target: ast::ExprRef, input: &Scope) -> String {
1298        if let ast::Expr::Column { name } = ast.expr(target) {
1299            let parts: Vec<&str> = ast.name(name).collect();
1300            if let Ok(found) = input.resolve(&parts) {
1301                // A column found by its second name is headed by that name, so `t.range` over
1302                // `range(2) t` is a column called `range` on the pin while `SELECT *` calls it `t`.
1303                let written = parts.last().copied().unwrap_or_default();
1304                if let Some(also) = &found.also {
1305                    if !same_name(&found.name, written) && same_name(also, written) {
1306                        return also.clone();
1307                    }
1308                }
1309                return found.name.clone();
1310            }
1311        }
1312        describe(ast, target, self.semantics)
1313    }
1314
1315    /// The expressions a `GROUP BY` clause names, with positions and output aliases followed.
1316    fn group_items(
1317        &self,
1318        ast: &Ast,
1319        select: &ast::Select,
1320        targets: &[ast::Target],
1321    ) -> Result<Vec<ast::ExprRef>> {
1322        if select.group_by_all {
1323            // GROUP BY ALL means every target that is not itself an aggregate, which is the set
1324            // that would otherwise have to be written out again by hand.
1325            return Ok(targets
1326                .iter()
1327                .filter(|target| !has_aggregate(ast, target.expr))
1328                .map(|target| target.expr)
1329                .collect());
1330        }
1331        let mut items = Vec::new();
1332        for &item in ast.expr_list(select.group_by) {
1333            items.push(self.output_reference(ast, item, targets, "GROUP BY")?.unwrap_or(item));
1334        }
1335        Ok(items)
1336    }
1337
1338    /// The target a `GROUP BY` or `ORDER BY` term names, when it names one by position or alias.
1339    fn output_reference(
1340        &self,
1341        ast: &Ast,
1342        item: ast::ExprRef,
1343        targets: &[ast::Target],
1344        clause: &str,
1345    ) -> Result<Option<ast::ExprRef>> {
1346        match ast.expr(item) {
1347            ast::Expr::Literal { kind: LiteralKind::Number, text } => {
1348                let written = ast.string(text);
1349                let position: usize = written.parse().map_err(|_| {
1350                    Error::binder(format!("{clause} term {written} is not a column"))
1351                })?;
1352                if position == 0 || position > targets.len() {
1353                    return Err(Error::binder(format!(
1354                        "{clause} term out of range - should be between 1 and {}",
1355                        targets.len()
1356                    )));
1357                }
1358                Ok(Some(targets[position - 1].expr))
1359            }
1360            ast::Expr::Column { name } => {
1361                let parts: Vec<&str> = ast.name(name).collect();
1362                let [written] = parts.as_slice() else { return Ok(None) };
1363                let mut found = None;
1364                for target in targets {
1365                    if target.alias != NONE && same_name(ast.string(target.alias), written) {
1366                        if found.is_some() {
1367                            return Ok(None);
1368                        }
1369                        found = Some(target.expr);
1370                    }
1371                }
1372                Ok(found)
1373            }
1374            _ => Ok(None),
1375        }
1376    }
1377
1378    // -------------------------------------------------------------- modifiers
1379
1380    /// Sort keys for a select, projecting anything sorted on that is not already selected.
1381    #[allow(clippy::too_many_arguments)]
1382    fn select_sort_keys(
1383        &mut self,
1384        ast: &Ast,
1385        query: &ast::Query,
1386        input: &Scope,
1387        output: &Scope,
1388        project: u32,
1389        exprs: &mut Vec<ExprRef>,
1390        names: &mut Vec<String>,
1391        extra: &mut Vec<usize>,
1392        above: &mut Vec<PendingSubquery>,
1393    ) -> Result<Vec<SortKey>> {
1394        if query.order_by_all {
1395            return Ok(self.every_column(output));
1396        }
1397        let items = ast.order_list(query.order_by).to_vec();
1398        let mut keys = Vec::with_capacity(items.len());
1399        for item in items {
1400            self.check_order_literal(ast, item.expr)?;
1401            let position = match self.output_position(ast, item.expr, output)? {
1402                Some(position) => position,
1403                None => {
1404                    let before = self.scalar_subqueries.len();
1405                    let bound = self.bind_expr(ast, item.expr, input)?;
1406                    self.lift_over_aggregate(before, above, input)?;
1407                    let bound = self.over_aggregate(bound, input)?;
1408                    match exprs.iter().position(|&held| self.same_expr(held, bound)) {
1409                        Some(position) => position,
1410                        None => {
1411                            exprs.push(bound);
1412                            names.push(describe(ast, item.expr, self.semantics));
1413                            extra.push(exprs.len() - 1);
1414                            exprs.len() - 1
1415                        }
1416                    }
1417                }
1418            };
1419            let ty = self.plan.expr_type(exprs[position]).clone();
1420            let expr = self.column(project, position, ty);
1421            keys.push(self.sort_key(expr, item));
1422        }
1423        Ok(keys)
1424    }
1425
1426    /// Sort keys over an output that has nothing behind it to project, which is a set operation.
1427    fn sort_keys(
1428        &mut self,
1429        ast: &Ast,
1430        query: &ast::Query,
1431        output: &Scope,
1432        targets: &[ast::Target],
1433    ) -> Result<Vec<SortKey>> {
1434        if query.order_by_all {
1435            return Ok(self.every_column(output));
1436        }
1437        let items = ast.order_list(query.order_by).to_vec();
1438        let mut keys = Vec::with_capacity(items.len());
1439        for item in items {
1440            self.check_order_literal(ast, item.expr)?;
1441            let expr = match self.output_position(ast, item.expr, output)? {
1442                Some(position) => {
1443                    let column = &output.columns[position];
1444                    let (binding, ty) = (column.binding, column.ty.clone());
1445                    self.plan.add_expr(Expr::Column(binding), ty)
1446                }
1447                None => {
1448                    let _ = targets;
1449                    self.bind_expr(ast, item.expr, output)?
1450                }
1451            };
1452            keys.push(self.sort_key(expr, item));
1453        }
1454        Ok(keys)
1455    }
1456
1457    fn every_column(&mut self, output: &Scope) -> Vec<SortKey> {
1458        let columns: Vec<(ColumnBinding, LogicalType)> =
1459            output.columns.iter().map(|column| (column.binding, column.ty.clone())).collect();
1460        columns
1461            .into_iter()
1462            .map(|(binding, ty)| {
1463                let expr = self.plan.add_expr(Expr::Column(binding), ty);
1464                let descending = self.semantics.default_descending();
1465                SortKey { expr, descending, nulls_first: self.semantics.nulls_first(descending) }
1466            })
1467            .collect()
1468    }
1469
1470    /// A sort key with the session defaults filled in.
1471    fn sort_key(&self, expr: ExprRef, item: ast::OrderItem) -> SortKey {
1472        let descending = match item.order {
1473            Order::Unstated => self.semantics.default_descending(),
1474            Order::Ascending => false,
1475            Order::Descending => true,
1476        };
1477        let nulls_first = match item.nulls {
1478            Nulls::First => true,
1479            Nulls::Last => false,
1480            Nulls::Unstated => self.semantics.nulls_first(descending),
1481        };
1482        SortKey { expr, descending, nulls_first }
1483    }
1484
1485    /// Which output column a term names, by position or by name.
1486    fn output_position(
1487        &self,
1488        ast: &Ast,
1489        item: ast::ExprRef,
1490        output: &Scope,
1491    ) -> Result<Option<usize>> {
1492        match ast.expr(item) {
1493            ast::Expr::Literal { kind: LiteralKind::Number, text } => {
1494                let written = ast.string(text);
1495                if written.contains(['.', 'e', 'E']) {
1496                    return Ok(None);
1497                }
1498                let position: usize = written.parse().map_err(|_| {
1499                    Error::binder(format!("ORDER BY term {written} is not a column"))
1500                })?;
1501                if position == 0 || position > output.len() {
1502                    return Err(Error::binder(format!(
1503                        "ORDER BY term out of range - should be between 1 and {}",
1504                        output.len()
1505                    )));
1506                }
1507                Ok(Some(position - 1))
1508            }
1509            ast::Expr::Column { name } => {
1510                let parts: Vec<&str> = ast.name(name).collect();
1511                let [written] = parts.as_slice() else { return Ok(None) };
1512                Ok(output.position_of(None, written))
1513            }
1514            _ => Ok(None),
1515        }
1516    }
1517
1518    /// Refuses a literal sort key unless the session explicitly accepts its no-op behavior.
1519    fn check_order_literal(&self, ast: &Ast, item: ast::ExprRef) -> Result<()> {
1520        if !self.semantics.order_by_non_integer_literal()
1521            && matches!(
1522                ast.expr(item),
1523                ast::Expr::Literal { kind, text }
1524                    if kind != LiteralKind::Number
1525                        || ast.string(text).contains(['.', 'e', 'E'])
1526            )
1527        {
1528            return Err(Error::binder(
1529                "ORDER BY non-integer literal has no effect.\n* SET order_by_non_integer_literal=true to allow this behavior.",
1530            ));
1531        }
1532        Ok(())
1533    }
1534
1535    /// The expressions a `DISTINCT ON` names, which have to be columns of the output.
1536    fn distinct_on(
1537        &mut self,
1538        ast: &Ast,
1539        distinct: Distinct,
1540        output: &Scope,
1541    ) -> Result<Vec<ExprRef>> {
1542        let Distinct::On(items) = distinct else {
1543            return Ok(Vec::new());
1544        };
1545        let items = ast.expr_list(items).to_vec();
1546        let mut on = Vec::with_capacity(items.len());
1547        for item in items {
1548            let Some(position) = self.output_position(ast, item, output)? else {
1549                return Err(Error::not_implemented(
1550                    "DISTINCT ON an expression that is not in the select list",
1551                ));
1552            };
1553            let column = &output.columns[position];
1554            let (binding, ty) = (column.binding, column.ty.clone());
1555            on.push(self.plan.add_expr(Expr::Column(binding), ty));
1556        }
1557        Ok(on)
1558    }
1559
1560    /// The `LIMIT` and the `OFFSET`, over the rows everything else in the query produced.
1561    ///
1562    /// The scope is taken by reference because a limit the binder could not work out reads its
1563    /// number off a query joined in underneath, and that join puts a column in the rows which the
1564    /// query did not ask for. A projection over the limit drops it again, and the scope has to say
1565    /// so, since its bindings are what anything above this reads.
1566    fn apply_limit(
1567        &mut self,
1568        ast: &Ast,
1569        query: &ast::Query,
1570        input: NodeRef,
1571        scope: &mut Scope,
1572    ) -> Result<NodeRef> {
1573        let waiting = self.scalar_subqueries.len();
1574        if query.limit_percent {
1575            let percent = self.share(ast, query.limit)?;
1576            let offset = self.skipped(ast, query.offset)?;
1577            let node = |binder: &mut Self, input| match percent {
1578                Some(percent) => binder.add_node(Node::LimitPercent { input, percent, offset }),
1579                // A null share is no limit at all, the same as a null row count, so what is left
1580                // is whatever the offset asked for.
1581                None => binder.limited(input, Bound::All, offset),
1582            };
1583            return self.over_subqueries(waiting, input, scope, node);
1584        }
1585        let count = self.count_bound(ast, query.limit, "LIMIT")?;
1586        let offset = self.skipped(ast, query.offset)?;
1587        let node = |binder: &mut Self, input| binder.limited(input, count, offset);
1588        self.over_subqueries(waiting, input, scope, node)
1589    }
1590
1591    /// The offset a query wrote, as nought rows skipped when it wrote none.
1592    ///
1593    /// An offset the query left off is nought rows skipped, where a limit it left off is every row
1594    /// emitted, so the two clauses read the same word differently.
1595    fn skipped(&mut self, ast: &Ast, written: ast::ExprRef) -> Result<Bound> {
1596        Ok(match self.count_bound(ast, written, "OFFSET")? {
1597            Bound::All => Bound::Rows(0),
1598            named => named,
1599        })
1600    }
1601
1602    /// Builds a limit node over `input`, joining in whatever queries its bounds turned out to need.
1603    ///
1604    /// A bound the binder could not work out reads its number off a column, and that column comes
1605    /// from a query joined in underneath. The join puts a column in the rows nobody asked for, so a
1606    /// projection over the limit drops it again and the scope is told to read that projection. When
1607    /// no query had to be joined in there is nothing to drop and the limit stands on its own.
1608    fn over_subqueries(
1609        &mut self,
1610        waiting: usize,
1611        input: NodeRef,
1612        scope: &mut Scope,
1613        node: impl FnOnce(&mut Self, NodeRef) -> NodeRef,
1614    ) -> Result<NodeRef> {
1615        let joined = self.scalar_subqueries.split_off(waiting);
1616        if joined.is_empty() {
1617            return Ok(node(self, input));
1618        }
1619        let mut input = input;
1620        for pending in joined {
1621            input = self.attach_subquery(input, pending);
1622        }
1623        let limit = node(self, input);
1624        Ok(self.reproject(limit, scope))
1625    }
1626
1627    /// A row count limit over `input`, or `input` itself when neither half of the clause asks for
1628    /// anything.
1629    fn limited(&mut self, input: NodeRef, count: Bound, offset: Bound) -> NodeRef {
1630        if count == Bound::All && offset == Bound::Rows(0) {
1631            return input;
1632        }
1633        self.add_node(Node::Limit { input, count, offset })
1634    }
1635
1636    /// A projection over `node` handing back exactly the columns `scope` names.
1637    ///
1638    /// The scope's bindings are rewritten to this projection's, because its columns are the ones
1639    /// anything above reads. Only a limit that had a query joined in under it wants this, and only
1640    /// because there is not always a projection above to drop the column that join added.
1641    fn reproject(&mut self, node: NodeRef, scope: &mut Scope) -> NodeRef {
1642        let index = self.fresh_index();
1643        let mut exprs = Vec::with_capacity(scope.columns.len());
1644        let mut names = Vec::with_capacity(scope.columns.len());
1645        for column in &scope.columns {
1646            exprs.push(self.plan.add_expr(Expr::Column(column.binding), column.ty.clone()));
1647            names.push(self.plan.intern(&column.name));
1648        }
1649        for (at, column) in scope.columns.iter_mut().enumerate() {
1650            column.binding = ColumnBinding::new(index, at as u32);
1651        }
1652        let exprs = self.plan.add_expr_list(&exprs);
1653        let names = self.plan.add_name_list(&names);
1654        self.add_node(Node::Project { input: node, index, exprs, names })
1655    }
1656
1657    /// The share of the input a `LIMIT n PERCENT` names.
1658    ///
1659    /// The same evaluation as a row count and a different type at the end of it: the value is cast
1660    /// to `DOUBLE` rather than to `BIGINT`, so `LIMIT '30'%` is thirty percent and `LIMIT true%` is
1661    /// one percent, which is what the pin answers. A null is no limit at all.
1662    ///
1663    /// The range is checked here because the pin checks it here. `LIMIT 101 PERCENT` fails an
1664    /// `EXPLAIN` on the pinned binary, so it is refused while the query is planned and not when it
1665    /// is run, and a `NAN` is outside the range like any other value that is not between nought and
1666    /// a hundred.
1667    ///
1668    /// What the binder cannot work out is a subquery and a call that answers differently every
1669    /// time, the same two things a row count cannot work out, and those become a [`Share::Read`]
1670    /// over the expression. The value is checked where it turns up instead, which is the executor.
1671    /// Only the sign can be written that way, because the grammar refuses `PERCENT` after a closing
1672    /// bracket, but nothing below here depends on which of the two was typed.
1673    fn share(&mut self, ast: &Ast, written: ast::ExprRef) -> Result<Option<Share>> {
1674        if written == NONE {
1675            return Ok(None);
1676        }
1677        self.clause = "LIMIT clause";
1678        let scope = Scope::empty();
1679        let bound = self.bind_expr(ast, written, &scope)?;
1680        let Some(value) = fold::value_of(&self.plan, bound)? else {
1681            return Ok(Some(Share::Read(bound)));
1682        };
1683        if value.is_null() {
1684            return Ok(None);
1685        }
1686        let percent = percentage(&value)?;
1687        if !(0.0..=100.0).contains(&percent) {
1688            return Err(Error::out_of_range(
1689                "Limit percent out of range, should be between 0% and 100%",
1690            ));
1691        }
1692        Ok(Some(Share::Percent(percent)))
1693    }
1694
1695    /// The row count a `LIMIT` or an `OFFSET` names.
1696    ///
1697    /// It does not have to be a literal. Anything whose value is settled before the first row is
1698    /// read will do, so `LIMIT 1 + 1` and `LIMIT CAST(3 AS BIGINT)` are both two, and that is what
1699    /// the pin does with them: its binder evaluates the expression and writes the number down.
1700    ///
1701    /// What is left over is an expression the binder cannot settle, which is a subquery, because it
1702    /// has to run first, and a call that answers differently every time it is made, such as
1703    /// `RANDOM()` or `nextval`. Those become a [`Bound::Read`] holding the expression, and the
1704    /// number comes off the first chunk that reaches the limit. The pin takes both and answers them
1705    /// the same way.
1706    ///
1707    /// The value is cast to `BIGINT` whatever it was written as, which is the whole of the type
1708    /// rule. `LIMIT '3'` is three rows because the string converts, `LIMIT 2.5` is three rows
1709    /// because the conversion rounds, `LIMIT true` is one row, and `LIMIT DATE '2020-01-01'` is the
1710    /// cast refusing a date. Every one of those messages is the cast's own, which is why there is
1711    /// no type check here to write a worse one. A limit that is read while the query runs is cast
1712    /// the same way by the operator that reads it, so the two paths answer alike.
1713    fn count_bound(&mut self, ast: &Ast, written: ast::ExprRef, clause: &str) -> Result<Bound> {
1714        if written == NONE {
1715            return Ok(Bound::All);
1716        }
1717        self.clause = "LIMIT clause";
1718        let scope = Scope::empty();
1719        let bound = self.bind_expr(ast, written, &scope)?;
1720        let Some(value) = fold::value_of(&self.plan, bound)? else {
1721            return Ok(Bound::Read(bound));
1722        };
1723        // A null is no limit at all, the same as leaving the clause off, and the pin agrees:
1724        // `LIMIT NULL` and `LIMIT CAST(NULL AS INTEGER)` both answer every row.
1725        if value.is_null() {
1726            return Ok(Bound::All);
1727        }
1728        row_count(&value, clause).map(Bound::Rows)
1729    }
1730
1731    // ------------------------------------------------------------------- from
1732
1733    fn bind_from(&mut self, ast: &Ast, from: ast::Slice) -> Result<(NodeRef, Scope)> {
1734        let sources = ast.source_list(from).to_vec();
1735        let Some((first, rest)) = sources.split_first() else {
1736            // No FROM clause is one row of no columns, which is what SELECT 1 sits on. Not an
1737            // empty table: an empty table would make SELECT 1 return nothing.
1738            return Ok((self.add_node(Node::Dummy), Scope::empty()));
1739        };
1740        let (mut node, mut scope) = self.bind_source(ast, *first)?;
1741        for source in rest {
1742            let (right, right_scope, correlations) = self.bind_lateral(ast, *source, &scope)?;
1743            node = if correlations.is_empty() {
1744                self.add_node(Node::CrossProduct { left: node, right })
1745            } else {
1746                let conditions = self.plan.add_expr_list(&[]);
1747                self.add_node(Node::DependentJoin {
1748                    left: node,
1749                    right,
1750                    kind: JoinKind::Inner,
1751                    conditions,
1752                })
1753            };
1754            scope = scope.concat(right_scope);
1755        }
1756        Ok((node, scope))
1757    }
1758
1759    /// Binds one FROM entry with everything written to its left already visible.
1760    ///
1761    /// That is what LATERAL means, and it is what a comma separated FROM does here whether the word
1762    /// was written or not, because the pinned build resolves `FROM o, (SELECT o.k + 1)` without it.
1763    /// The keyword therefore changes nothing and is accepted rather than acted on.
1764    ///
1765    /// The columns of the left that the entry read come back with it, and an entry that read none
1766    /// is an ordinary product. The rest are somebody else's: a name that resolved past the left
1767    /// neighbours belongs to an enclosing query, so it is handed up to whichever frame is waiting
1768    /// for it rather than counted here, or the subquery this FROM sits in would lose track of its
1769    /// own correlation.
1770    fn bind_lateral(
1771        &mut self,
1772        ast: &Ast,
1773        source: ast::SourceRef,
1774        left: &Scope,
1775    ) -> Result<(NodeRef, Scope, Vec<ColumnBinding>)> {
1776        self.lateral_scopes.push(self.outer_scopes.len());
1777        self.outer_scopes.push(left.clone());
1778        self.correlations.push(Vec::new());
1779        let bound = self.bind_source(ast, source);
1780        let read = self.correlations.pop().expect("correlation frame");
1781        self.outer_scopes.pop();
1782        self.lateral_scopes.pop();
1783        let (node, scope) = bound?;
1784
1785        let mut here = Vec::new();
1786        for binding in read {
1787            if left.columns.iter().any(|column| column.binding == binding) {
1788                here.push(binding);
1789            } else if let Some(enclosing) = self.correlations.last_mut() {
1790                if !enclosing.contains(&binding) {
1791                    enclosing.push(binding);
1792                }
1793            }
1794        }
1795        // A table function is allowed to read the left the same as anything else here. There is
1796        // nothing underneath one for the domain to be pushed into, since its arguments are what
1797        // produce its rows, so the unnesting pass turns it into a `LateralFunction` and the call is
1798        // made once per domain value. That is `domain.rs`.
1799        //
1800        // Nothing has to be turned down here for the functions that would not survive it. The only
1801        // table functions taking an argument that is not a name are the series family, which is the
1802        // family that operator answers, and a name that is not a constant is refused where the
1803        // columns are settled, because settling them means opening the file or reading the catalog.
1804        Ok((node, scope, here))
1805    }
1806
1807    fn bind_source(&mut self, ast: &Ast, source: ast::SourceRef) -> Result<(NodeRef, Scope)> {
1808        match ast.source(source) {
1809            ast::Source::Table { name, alias, columns } => {
1810                self.bind_table(ast, name, alias, columns)
1811            }
1812            ast::Source::Function { name, args, alias, columns, pragma } => {
1813                self.bind_table_function(ast, name, args, alias, columns, pragma)
1814            }
1815            ast::Source::Subquery { query, alias, columns } => {
1816                let (node, mut scope) = self.bind_query(ast, query)?;
1817                let label = if alias == NONE {
1818                    "unnamed_subquery".to_string()
1819                } else {
1820                    ast.string(alias).to_string()
1821                };
1822                scope.relabel(&label);
1823                if !columns.is_empty() {
1824                    let names: Vec<&str> = ast.name(columns).collect();
1825                    scope.rename(&names, &label)?;
1826                }
1827                Ok((node, scope))
1828            }
1829            ast::Source::Values { rows, alias, columns } => {
1830                let bare = ast::Query::bare(ast::QueryBody::Values(rows));
1831                let (node, mut scope) = self.bind_values(ast, &bare, rows)?;
1832                let label =
1833                    if alias == NONE { String::new() } else { ast.string(alias).to_string() };
1834                scope.relabel(&label);
1835                if !columns.is_empty() {
1836                    let names: Vec<&str> = ast.name(columns).collect();
1837                    scope.rename(&names, &label)?;
1838                }
1839                Ok((node, scope))
1840            }
1841            ast::Source::Cte { cte, alias, columns } => {
1842                self.bind_cte_scan(ast, cte, alias, columns)
1843            }
1844            ast::Source::Join { left, right, kind, natural, on, using } => {
1845                self.bind_join(ast, left, right, kind, natural, on, using)
1846            }
1847        }
1848    }
1849
1850    /// A read of a materialised `WITH`, which is a leaf the same way a table scan is.
1851    ///
1852    /// Which definition it reads was settled by the parser, so there is no name to look up here and
1853    /// no shadowing left to think about. What is looked up is the materialisation that definition
1854    /// turned into, and the search runs backwards because the same definition is bound again for
1855    /// each use of a plain `WITH` it sits inside, and a read means the innermost of those.
1856    fn bind_cte_scan(
1857        &mut self,
1858        ast: &Ast,
1859        written: u32,
1860        alias: ast::StrRef,
1861        columns: ast::Slice,
1862    ) -> Result<(NodeRef, Scope)> {
1863        let Some(held) = self.materialized.iter().rev().find(|held| held.written == written) else {
1864            let name = ast.string(ast.cte(written).name);
1865            return Err(Error::binder(format!("Table with name {name} does not exist!")));
1866        };
1867        let cte = held.cte;
1868        let fields = held.fields.clone();
1869        let text = held.name.clone();
1870        let label = if alias == NONE { text.clone() } else { ast.string(alias).to_string() };
1871        let name = self.plan.intern(&text);
1872        let index = self.fresh_index();
1873        let mut scope = Scope::empty();
1874        for (at, field) in fields.iter().enumerate() {
1875            scope.push(Visible {
1876                table: label.clone(),
1877                name: field.name.clone(),
1878                binding: ColumnBinding::new(index, at as u32),
1879                ty: field.ty.clone(),
1880                not_null: field.not_null,
1881                key: None,
1882                default: None,
1883                qualified: false,
1884                also: None,
1885            });
1886        }
1887        if !columns.is_empty() {
1888            let names: Vec<&str> = ast.name(columns).collect();
1889            scope.rename(&names, &label)?;
1890        }
1891        let columns = self.plan.add_fields(&fields);
1892        let node = self.add_node(Node::CteScan { index, cte, name, columns });
1893        Ok((node, scope))
1894    }
1895
1896    fn bind_table(
1897        &mut self,
1898        ast: &Ast,
1899        name: ast::Slice,
1900        alias: ast::StrRef,
1901        columns: ast::Slice,
1902    ) -> Result<(NodeRef, Scope)> {
1903        let parts: Vec<&str> = ast.name(name).collect();
1904        let catalog = self.catalog;
1905        // The catalog is asked first and the file is the fallback, which is the order DuckDB uses:
1906        // a table really called `mixed.parquet` wins over a file of that name sitting next to it.
1907        let resolved = match catalog.resolve(&parts) {
1908            Ok(resolved) => resolved,
1909            Err(missing) => {
1910                return self.bind_replacement_scan(ast, &parts, alias, columns, missing);
1911            }
1912        };
1913        if catalog.entry(&resolved)? == Entry::View {
1914            return self.bind_view(ast, &resolved, alias, columns);
1915        }
1916        let label =
1917            if alias == NONE { resolved.table.clone() } else { ast.string(alias).to_string() };
1918        self.bind_catalog_table(ast, &resolved, label, columns)
1919    }
1920
1921    /// A table the catalog holds, under the name `label`, which is where [`Self::bind_table`] ends
1922    /// and where a Parquet file with a native mirror goes instead of to its reader.
1923    pub(crate) fn bind_catalog_table(
1924        &mut self,
1925        ast: &Ast,
1926        resolved: &QualifiedName,
1927        label: String,
1928        columns: ast::Slice,
1929    ) -> Result<(NodeRef, Scope)> {
1930        let table = self.catalog.table(resolved)?;
1931        let fields: Vec<Field> = table.columns().to_vec();
1932        // The new rows of an `ON CONFLICT DO UPDATE`, which the write puts in a table of their own
1933        // before it runs the query. Nothing the table knows about its own rows holds for them.
1934        let excluded = self.upsert && same_name(&label, "excluded");
1935        // `PRI` for a column of the primary key and `UNI` for one of a unique key, the primary key
1936        // winning where a column is in both.
1937        let mut marks = vec![None; fields.len()];
1938        for key in table.keys() {
1939            for &column in &key.columns {
1940                if key.primary || marks[column].is_none() {
1941                    marks[column] = Some(if key.primary { "PRI" } else { "UNI" });
1942                }
1943            }
1944        }
1945        let index = self.fresh_index();
1946        let mut scope = Scope::empty();
1947        for (at, field) in fields.iter().enumerate() {
1948            scope.push(Visible {
1949                table: label.clone(),
1950                name: field.name.clone(),
1951                binding: ColumnBinding::new(index, at as u32),
1952                ty: field.ty.clone(),
1953                not_null: field.not_null,
1954                key: marks[at],
1955                default: table.default(at).map(str::to_owned),
1956                qualified: excluded,
1957                also: None,
1958            });
1959        }
1960        if !columns.is_empty() {
1961            let names: Vec<&str> = ast.name(columns).collect();
1962            scope.rename(&names, &label)?;
1963        }
1964        let resolved = if excluded { &QualifiedName::excluded() } else { resolved };
1965        let catalog_name = self.plan.intern(&resolved.catalog);
1966        let schema = self.plan.intern(&resolved.schema);
1967        let table_name = self.plan.intern(&resolved.table);
1968        let alias = self.plan.intern(&label);
1969        let columns = self.plan.add_fields(&fields);
1970        // What the store wrote down about itself, against the table index the same way a Parquet
1971        // footer is. A table with nothing to say records nothing and the estimate falls back to the
1972        // constants it used before, which is what every table did until the file had a directory
1973        // worth asking.
1974        if let Some(zones) = table.rows().zones().filter(|_| !excluded) {
1975            self.plan.set_zones(index, zones);
1976        }
1977        if let Some(frequencies) = table.frequencies().filter(|_| !excluded) {
1978            self.plan.set_frequencies(index, frequencies);
1979        }
1980        for (column, distinct) in table.distincts() {
1981            if !excluded {
1982                self.plan.measure_distinct(index, &column, distinct);
1983            }
1984        }
1985        if self.want_ascending && !excluded {
1986            for column in table.ascending() {
1987                self.plan.mark_ascending(index, &column);
1988            }
1989        }
1990        let node = self.add_node(Node::Get {
1991            catalog: catalog_name,
1992            schema,
1993            table: table_name,
1994            alias,
1995            index,
1996            columns,
1997        });
1998        Ok((node, scope))
1999    }
2000
2001    /// A view where a table goes, which is the body bound again right here.
2002    ///
2003    /// Inline and not behind a node. The view is gone by the time the plan exists, so everything
2004    /// downstream sees the query somebody would have written by hand, and the column pruning that
2005    /// makes `SELECT COUNT(*) FROM 'hits.parquet'` read no columns at all keeps working through
2006    /// `FROM hits`. A `Node::View` would be a barrier with nothing on the other side of it.
2007    ///
2008    /// The scope this builds is a subquery's, right down to the name in the error message. duckdb
2009    /// v1.5.1 reports a view whose column list has gone stale as `table "unnamed_subquery" has 1
2010    /// columns available but 2 columns specified`, which is the sentence its subquery alias rule
2011    /// produces, so a view there is a subquery with the view's name written over it afterwards.
2012    fn bind_view(
2013        &mut self,
2014        ast: &Ast,
2015        name: &QualifiedName,
2016        alias: ast::StrRef,
2017        columns: ast::Slice,
2018    ) -> Result<(NodeRef, Scope)> {
2019        let view = self.catalog.view(name)?;
2020        let full = name.to_string();
2021        if self.expanding.contains(&full) {
2022            // Two quotes each side, which is what the binary prints. It quotes the name on the way
2023            // in and then formats the quoted name into a quoted slot, so a view called `a` comes
2024            // back as `""a""`. That is upstream's wart and copying it is the whole job here.
2025            return Err(Error::binder(format!(
2026                "infinite recursion detected: attempting to recursively bind view \"\"{}\"\"",
2027                name.table
2028            )));
2029        }
2030        let body = parse_ast_with_case(view.sql(), self.semantics.identifier_case())?;
2031        let query = match body.statements.as_slice() {
2032            [ast::Statement::Query(query)] => *query,
2033            // Only a query can have got past the binder at creation, so this is a view the catalog
2034            // was handed some other way rather than anything a statement can produce.
2035            _ => return Err(Error::binder(format!("view \"{}\" is not a query", name.table))),
2036        };
2037        self.expanding.push(full);
2038        let bound = self.bind_query(&body, query);
2039        self.expanding.pop();
2040        let (node, mut scope) = bound?;
2041
2042        let aliases: Vec<&str> = view.aliases().iter().map(String::as_str).collect();
2043        if !aliases.is_empty() {
2044            scope.rename(&aliases, "unnamed_subquery")?;
2045        }
2046        // What the catalog tables report as this view's columns, written down here because this is
2047        // the moment they are known. Upstream refreshes the same cache at the same point, which was
2048        // measured: both `duckdb_columns()` and `duckdb_views().column_count` keep reporting the old
2049        // list after an `ALTER TABLE` underneath until something reads the view, and then both move.
2050        // It is written before the label and before the `AS t(a, b)` list below, because those two
2051        // rename the view for one query and not for everyone.
2052        view.remember(scope.fields());
2053        let label = if alias == NONE { name.table.clone() } else { ast.string(alias).to_string() };
2054        scope.relabel(&label);
2055        if !columns.is_empty() {
2056            let names: Vec<&str> = ast.name(columns).collect();
2057            scope.rename(&names, &label)?;
2058        }
2059        Ok((node, scope))
2060    }
2061
2062    /// A function call where a table goes, such as `range(10)`.
2063    ///
2064    /// The arguments are bound against an empty scope. A table function that can see the row on its
2065    /// left is `LATERAL`, and this is not it, so a column name in here is not resolved against
2066    /// whatever happens to be to the left in the `FROM` list. Letting it would mean `FROM t,
2067    /// range(t.n)` quietly binding to something whose meaning depends on the order the sources were
2068    /// written in.
2069    fn bind_table_function(
2070        &mut self,
2071        ast: &Ast,
2072        name: ast::Slice,
2073        args: ast::Slice,
2074        alias: ast::StrRef,
2075        columns: ast::Slice,
2076        pragma: bool,
2077    ) -> Result<(NodeRef, Scope)> {
2078        // The column names written after the alias, kept under a name of their own because the
2079        // match on what the function's columns are below binds `columns` to something else.
2080        let renamed = columns;
2081        let parts: Vec<&str> = ast.name(name).collect();
2082        // A qualified call names a schema, and the two schemas that exist are the ones every
2083        // built-in lives in. Anything else is a name that has to fail rather than fall through to
2084        // the unqualified lookup and be found somewhere it was not asked for.
2085        let function_name = *parts.last().unwrap_or(&"");
2086        if let Some(schema) = parts.iter().rev().nth(1) {
2087            if !schema.eq_ignore_ascii_case("main") && !schema.eq_ignore_ascii_case("system") {
2088                return Err(Error::catalog(format!(
2089                    "Table Function with name {} does not exist!",
2090                    parts.join(".")
2091                )));
2092            }
2093        }
2094        // The name is looked up before the arguments are bound so that a call of something that is
2095        // not a table function says that, rather than reporting whatever is wrong with the
2096        // arguments of a function that was never going to exist.
2097        let Some(called) = TableFunction::lookup(function_name) else {
2098            if pragma {
2099                // `PRAGMA database_list` is a view upstream and not a function, and the pragma
2100                // namespace holds both, so a name that is not a function gets one more look in the
2101                // catalog before it is turned down. It has to be the no argument form: a view
2102                // takes none, and `pragma_database_list()` with parentheses is a missing function
2103                // on the pin too.
2104                if args.is_empty() && self.catalog.resolve(&parts).is_ok() {
2105                    return self.bind_table(ast, name, alias, columns);
2106                }
2107                let spelled = function_name.strip_prefix("pragma_").unwrap_or(function_name);
2108                return Err(Error::catalog(format!(
2109                    "Pragma Function with name {spelled} does not exist!"
2110                )));
2111            }
2112            return Err(Error::catalog(format!(
2113                "Table Function with name {function_name} does not exist!"
2114            )));
2115        };
2116        let written = ast.target_list(args).to_vec();
2117        let empty = Scope::empty();
2118        let previous = std::mem::replace(&mut self.clause, "table function arguments");
2119        let mut bound = Vec::new();
2120        let mut written_options = Vec::new();
2121        for argument in written {
2122            let expr = self.bind_expr(ast, argument.expr, &empty)?;
2123            if argument.alias == NONE {
2124                bound.push(expr);
2125            } else {
2126                let name = ast.string(argument.alias).to_string();
2127                let (parameter, value) = self.named_argument(called, &name, expr)?;
2128                written_options.push((parameter, value, expr));
2129            }
2130        }
2131        self.clause = previous;
2132        let options = Options::of(&written_options)?;
2133
2134        // The types are what resolve the call, not the count, because `read_parquet(3)` is a
2135        // different answer from `read_parquet('3')` and only the types tell them apart.
2136        let given: Vec<LogicalType> =
2137            bound.iter().map(|&expr| self.plan.expr_type(expr).clone()).collect();
2138        let resolved = if pragma {
2139            resolve_pragma(function_name, &given)?
2140        } else {
2141            resolve_table(function_name, &given)?
2142        };
2143        let mut cast: Vec<ExprRef> = bound
2144            .iter()
2145            .zip(&resolved.arguments)
2146            .map(|(&expr, ty)| self.checked_cast_to(expr, ty, false))
2147            .collect::<Result<_>>()?;
2148
2149        if resolved.function.answered_when_bound() {
2150            let Columns::Fixed(fields) = resolved.columns else {
2151                return Err(Error::internal("a pragma that resolved to a file"));
2152            };
2153            let [argument] = cast[..] else {
2154                return Err(Error::internal("a pragma that resolved to more than one name"));
2155            };
2156            return self.bind_pragma(ast, resolved.function, &fields, argument, alias, columns);
2157        }
2158        // Filled in by the arm below that has the file names, and left alone by a function whose
2159        // columns are fixed, because none of those reads a file to find out how tall it is.
2160        let mut measured = Stat::Unknown;
2161        let mut counted: Vec<(String, Stat<u64>)> = Vec::new();
2162        let mut bounded: Option<Arc<dyn Zones>> = None;
2163        let fields = match resolved.columns {
2164            Columns::Fixed(fields) => fields,
2165            columns => {
2166                // The one argument is a pattern, and what replaces it is one constant per file it
2167                // matched. The executor is handed names rather than a pattern, so it never walks a
2168                // directory and the answer cannot change between binding a prepared statement and
2169                // running it, which is the same reason the schema is settled here.
2170                let paths = self.file_paths(cast[0], resolved.function.name())?;
2171                let mut mirrorable = None;
2172                if resolved.function == TableFunction::ReadParquet && !options.file_row_number {
2173                    if let Some((path, stamp)) = mirror_target(&paths) {
2174                        if let Some(name) =
2175                            self.catalog.mirror(&path, options.binary_as_string, stamp)
2176                        {
2177                            let name = name.clone();
2178                            let label = if alias == NONE {
2179                                resolved.function.name().to_string()
2180                            } else {
2181                                ast.string(alias).to_string()
2182                            };
2183                            return self.bind_catalog_table(ast, &name, label, renamed);
2184                        }
2185                        mirrorable = Some(path);
2186                    }
2187                }
2188                let mut fields = match columns {
2189                    // Parquet takes the first file's footer as the answer and CSV sniffs all of
2190                    // them, which is not a choice made here. See `csv_fields`.
2191                    Columns::Csv => csv_fields(&paths, options.given)?,
2192                    _ => {
2193                        let footers = self.footers(&paths, mirrorable.as_deref())?;
2194                        if let Some(path) = mirrorable.as_deref() {
2195                            self.want_mirror(path, options.binary_as_string, &footers.rows);
2196                        }
2197                        measured = footers.rows;
2198                        counted = footers.distincts;
2199                        bounded = footers.zones;
2200                        footers.fields
2201                    }
2202                };
2203                if options.all_varchar {
2204                    // The sniffer still ran, because the names come out of the same pass over the
2205                    // front of the file and only the types are being overruled. The executor reads
2206                    // the text as VARCHAR because this is the schema it is told to read into, which
2207                    // is the same road a file in a glob takes when the set is wider than the file.
2208                    for field in &mut fields {
2209                        field.ty = LogicalType::Varchar;
2210                    }
2211                }
2212                if options.binary_as_string {
2213                    // A byte array column with no annotation on it is a BLOB, and this is the caller
2214                    // saying that the file's writer meant text. The reader already holds both in the
2215                    // same string column and already validates the bytes, so the whole of the option
2216                    // is what the column is called from here on.
2217                    for field in &mut fields {
2218                        if field.ty == LogicalType::Blob {
2219                            field.ty = LogicalType::Varchar;
2220                        }
2221                    }
2222                }
2223                if options.file_row_number {
2224                    // Not a column of the file, so it goes on the end where a projection cannot be
2225                    // confused about which one it is, and the executor counts it as the rows come
2226                    // out. A file that already has a column of that name is the one case where the
2227                    // option cannot be honoured, and saying so is better than handing back two
2228                    // columns with the same name and letting a reference to it pick one.
2229                    if fields.iter().any(|field| field.name == FILE_ROW_NUMBER) {
2230                        return Err(Error::binder(format!(
2231                            "Duplicate column name \"{FILE_ROW_NUMBER}\": the file already has a \
2232                             column of that name, so file_row_number cannot add one"
2233                        )));
2234                    }
2235                    fields.push(Field::required(FILE_ROW_NUMBER.to_string(), LogicalType::BigInt));
2236                }
2237                cast = paths.iter().map(|path| self.path_constant(path)).collect();
2238                fields
2239            }
2240        };
2241        let label = if alias == NONE {
2242            resolved.function.name().to_string()
2243        } else {
2244            ast.string(alias).to_string()
2245        };
2246        let names: Vec<&str> = ast.name(columns).collect();
2247        self.table_function_source(
2248            resolved.function,
2249            &cast,
2250            &written_options,
2251            Read { fields, rows: measured, distincts: counted, zones: bounded },
2252            &label,
2253            &names,
2254        )
2255    }
2256
2257    /// `pragma_table_info('t')` or `pragma_show('t')`, answered while it is bound.
2258    ///
2259    /// The same trick `DESCRIBE` uses and for the same reason: the columns of a table are settled by
2260    /// the time the name has resolved, so the rows are a constant from there on and this comes out
2261    /// as a `VALUES` rather than as an operator that reads a catalog while the query runs. It also
2262    /// means `SELECT name FROM pragma_table_info('t') WHERE notnull` is an ordinary query over an
2263    /// ordinary relation, which is the whole reason these exist as functions rather than only as
2264    /// statements.
2265    ///
2266    /// The name arrives as a string rather than as something the parser read, so it is split here
2267    /// under the identifier rule and then resolved like any other name. A name that is not there
2268    /// comes back as the catalog's own complaint, which is what the pin answers with too.
2269    fn bind_pragma(
2270        &mut self,
2271        ast: &Ast,
2272        function: TableFunction,
2273        fields: &[Field],
2274        argument: ExprRef,
2275        alias: ast::StrRef,
2276        columns: ast::Slice,
2277    ) -> Result<(NodeRef, Scope)> {
2278        let written = self.pragma_name(argument, function)?;
2279        let parts = identifier_parts(&written);
2280        let spelled: Vec<&str> = parts.iter().map(String::as_str).collect();
2281        let name = self.catalog.resolve(&spelled)?;
2282        let described = self.described(ast, &name)?;
2283        let mut rows = Vec::with_capacity(described.len());
2284        for (at, field) in described.iter().enumerate() {
2285            let items = if matches!(function, TableFunction::PragmaShow) {
2286                self.describing(field)
2287            } else {
2288                self.table_info(at, field)
2289            };
2290            rows.push(self.plan.add_expr_list(&items));
2291        }
2292        let rows = self.plan.add_rows(&rows);
2293        let held = self.plan.add_fields(fields);
2294        let index = self.fresh_index();
2295        let node = self.add_node(Node::Values { index, columns: held, rows });
2296        let label =
2297            if alias == NONE { function.name().to_string() } else { ast.string(alias).to_string() };
2298        let mut scope = Scope::empty();
2299        for (at, field) in fields.iter().enumerate() {
2300            scope.push(Visible {
2301                table: label.clone(),
2302                name: field.name.clone(),
2303                binding: ColumnBinding::new(index, at as u32),
2304                ty: field.ty.clone(),
2305                not_null: false,
2306                key: None,
2307                default: None,
2308                qualified: false,
2309                also: None,
2310            });
2311        }
2312        if !columns.is_empty() {
2313            let names: Vec<&str> = ast.name(columns).collect();
2314            scope.rename(&names, &label)?;
2315        }
2316        Ok((node, scope))
2317    }
2318
2319    /// The name a pragma was called with, which has to be a constant.
2320    ///
2321    /// A null is a name spelled `NULL` rather than an error about nulls, because the pin turns
2322    /// whatever it was handed into text before it goes looking and then says a table of that name
2323    /// does not exist. Writing `pragma_table_info(NULL)` is a mistake either way and this is the
2324    /// sentence the mistake already has.
2325    ///
2326    /// `pragma_table_info('t' || 'x')` is the pin's `tx` and is turned away here, which is the same
2327    /// missing constant folding [`Binder::named_argument`] writes about and closes the same day.
2328    fn pragma_name(&self, argument: ExprRef, function: TableFunction) -> Result<String> {
2329        let Expr::Constant(reference) = *self.plan.expr(argument) else {
2330            return Err(Error::not_implemented(format!(
2331                "{}() given a name that is not a constant",
2332                function.name()
2333            )));
2334        };
2335        match self.plan.value(reference) {
2336            Value::Varchar(name) => Ok(name.clone()),
2337            Value::Null => Ok("NULL".to_string()),
2338            other => {
2339                Err(Error::internal(format!("a pragma name bound as VARCHAR arrived as {other}")))
2340            }
2341        }
2342    }
2343
2344    /// The columns of whatever a pragma was pointed at.
2345    ///
2346    /// A view is bound here, which is how it comes to have columns at all. Reading a view is what
2347    /// binds it and describing one counts as reading it, so a view the engine ships with reports a
2348    /// column count from this point on, the same as it would after a select. The node that binding
2349    /// produces is thrown away, because the answer is the scope and not the query.
2350    ///
2351    /// Every column of a view is nullable whatever the column underneath was declared as, which is
2352    /// the pin's answer through `pragma_table_info()`, `pragma_show()` and `duckdb_columns()` alike.
2353    /// [`Scope::fields`] drops the flag on its own, so there is nothing to clear here.
2354    fn described(&mut self, ast: &Ast, name: &QualifiedName) -> Result<Vec<Field>> {
2355        if self.catalog.entry(name)? == Entry::Table {
2356            return Ok(self.catalog.table(name)?.columns().to_vec());
2357        }
2358        let (_, scope) = self.bind_view(ast, name, NONE, ast::Slice::default())?;
2359        Ok(scope.fields())
2360    }
2361
2362    /// One row of `pragma_show()`, which is one row of `DESCRIBE` written by the other caller.
2363    fn describing(&mut self, field: &Field) -> Vec<ExprRef> {
2364        let written = [
2365            field.name.clone(),
2366            field.ty.to_string(),
2367            if field.not_null { "NO" } else { "YES" }.to_owned(),
2368        ];
2369        let mut items: Vec<ExprRef> =
2370            written.into_iter().map(|text| self.plan.add_constant(Value::Varchar(text))).collect();
2371        for _ in 0..3 {
2372            let empty = self.plan.add_constant(Value::Null);
2373            items.push(self.cast_to(empty, &LogicalType::Varchar));
2374        }
2375        items
2376    }
2377
2378    /// One row of `pragma_table_info()`, which is SQLite's six columns about the same column.
2379    ///
2380    /// `cid` counts from zero, which is SQLite's numbering and not the one based `ordinal_position`
2381    /// the standard views report. `dflt_value` and `pk` are the two nothings rudb has to report
2382    /// until `CREATE TABLE` takes a `DEFAULT` or a key.
2383    fn table_info(&mut self, at: usize, field: &Field) -> Vec<ExprRef> {
2384        let cid = self.plan.add_constant(Value::Integer(i32::try_from(at).unwrap_or(i32::MAX)));
2385        let name = self.plan.add_constant(Value::Varchar(field.name.clone()));
2386        let ty = self.plan.add_constant(Value::Varchar(field.ty.to_string()));
2387        let not_null = self.plan.add_constant(Value::Boolean(field.not_null));
2388        let default = self.plan.add_constant(Value::Null);
2389        let default = self.cast_to(default, &LogicalType::Varchar);
2390        let key = self.plan.add_constant(Value::Boolean(false));
2391        vec![cid, name, ty, not_null, default, key]
2392    }
2393
2394    /// One named parameter of a table function call, folded into what the call was given.
2395    ///
2396    /// The value has to be a constant of the type the parameter wants. It has to be constant
2397    /// because an option can decide what the columns are and the columns are settled here, and it
2398    /// has to be already of the type because there is no constant folding in front of the binder
2399    /// yet. DuckDB folds first, so `binary_as_string=1` and `binary_as_string='yes'` are both true
2400    /// there and both are turned away here, which is a gap that closes on its own the day the
2401    /// optimizer runs before the plan is finished. `binary_as_string=True` is what the ClickBench
2402    /// entry writes and is what has to work.
2403    ///
2404    /// A name that is not a parameter of this function is the binary's sentence followed by what it
2405    /// could have been. The binary puts the candidates on their own indented lines and this puts
2406    /// them on the same line, because an error is one line here.
2407    fn named_argument(
2408        &mut self,
2409        function: TableFunction,
2410        name: &str,
2411        expr: ExprRef,
2412    ) -> Result<(&'static str, Value)> {
2413        let known = function
2414            .parameters()
2415            .iter()
2416            .find(|(parameter, _)| parameter.eq_ignore_ascii_case(name));
2417        let Some((parameter, wanted)) = known else {
2418            let candidates: Vec<String> = function
2419                .parameters()
2420                .iter()
2421                .map(|(parameter, ty)| format!("    {parameter} {ty}"))
2422                .collect();
2423            return Err(Error::binder(format!(
2424                "Invalid named parameter \"{name}\" for function {}\nCandidates:\n{}\n",
2425                function.name(),
2426                candidates.join("\n")
2427            )));
2428        };
2429        let Expr::Constant(reference) = *self.plan.expr(expr) else {
2430            return Err(Error::not_implemented(format!(
2431                "the named parameter {parameter} with a value that is not a constant"
2432            )));
2433        };
2434        let value = self.plan.value(reference).clone();
2435        if value == Value::Null {
2436            return Err(Error::binder(null_parameter(function, parameter)));
2437        }
2438        let given = self.plan.expr_type(expr).clone();
2439        if given != *wanted {
2440            return Err(Error::not_implemented(format!(
2441                "the named parameter {parameter} given a {given} where a {wanted} was wanted"
2442            )));
2443        }
2444        Ok((parameter, value))
2445    }
2446
2447    /// A file where a table name goes, which is what DuckDB calls a replacement scan.
2448    ///
2449    /// `SELECT * FROM 'hits.parquet'` is how most DuckDB queries in the wild are written, ClickBench
2450    /// among them, so this is not sugar over `read_parquet` so much as the spelling people use. The
2451    /// catalog has already been asked and has already said no, and `missing` is what it said, so a
2452    /// name that is not a file comes back with the catalog's own answer rather than with a complaint
2453    /// about files.
2454    ///
2455    /// Only a single unqualified name is a candidate. A qualified one names a schema and a schema
2456    /// that does not exist is not a path.
2457    fn bind_replacement_scan(
2458        &mut self,
2459        ast: &Ast,
2460        parts: &[&str],
2461        alias: ast::StrRef,
2462        columns: ast::Slice,
2463        missing: Error,
2464    ) -> Result<(NodeRef, Scope)> {
2465        let [path] = parts else { return Err(missing) };
2466        let path = *path;
2467        let extension = path.rsplit_once('.').map(|(_, after)| after).unwrap_or_default();
2468        let Some(function) = Self::reader_for(extension) else {
2469            if is_file(path) {
2470                // A file that is really there and that nothing here can read is a different mistake
2471                // from a name that is not a file, and DuckDB says so with both lines, the second of
2472                // which is the way out. A file with no dot in it lands here too, which is why the
2473                // test is on the extension having a reader rather than on there being an extension.
2474                return Err(Error::binder(format!(
2475                    "No extension found that is capable of reading the file \"{path}\"\n* If this \
2476                     file is a supported file format you can explicitly use the reader functions, \
2477                     such as read_csv, read_json or read_parquet"
2478                )));
2479            }
2480            return Err(missing);
2481        };
2482        // The pattern is expanded before it is known to match anything, so a name that ends in .csv
2483        // and is not there gives the reader's own message rather than the catalog's. That is
2484        // DuckDB's order and it is the helpful one: somebody who wrote a file name wants to hear
2485        // about the file.
2486        let paths = files(path)?;
2487        // The name the columns answer to is the file's stem, so `SELECT mixed.a FROM
2488        // 'data/mixed.parquet'` works. That is DuckDB's choice and it is the useful one, since the
2489        // alternative is a table name with a dot and a slash in it that nothing can write. A pattern
2490        // keeps the whole of what was written instead, which is DuckDB's choice too and was
2491        // measured: there is no stem to take when the name stands for a directory full of files.
2492        let label = if alias == NONE {
2493            if is_pattern(path) {
2494                path.to_string()
2495            } else {
2496                let file = path.rsplit_once('/').map_or(path, |(_, file)| file);
2497                file.rsplit_once('.').map_or(file, |(stem, _)| stem).to_string()
2498            }
2499        } else {
2500            ast.string(alias).to_string()
2501        };
2502        let mut mirrorable = None;
2503        if function == TableFunction::ReadParquet {
2504            if let Some((canonical, stamp)) = mirror_target(&paths) {
2505                if let Some(name) = self.catalog.mirror(&canonical, false, stamp) {
2506                    let name = name.clone();
2507                    return self.bind_catalog_table(ast, &name, label, columns);
2508                }
2509                mirrorable = Some(canonical);
2510            }
2511        }
2512        let read = match function {
2513            TableFunction::ReadParquet => {
2514                let footers = self.footers(&paths, mirrorable.as_deref())?;
2515                if let Some(canonical) = mirrorable.as_deref() {
2516                    self.want_mirror(canonical, false, &footers.rows);
2517                }
2518                Read {
2519                    fields: footers.fields,
2520                    rows: footers.rows,
2521                    distincts: footers.distincts,
2522                    zones: footers.zones,
2523                }
2524            }
2525            _ => Read::uncounted(csv_fields(&paths, Given::default())?),
2526        };
2527        let arguments: Vec<ExprRef> = paths.iter().map(|path| self.path_constant(path)).collect();
2528        let names: Vec<&str> = ast.name(columns).collect();
2529        self.table_function_source(function, &arguments, &[], read, &label, &names)
2530    }
2531
2532    /// What the footers of `paths` say, from the outline alone where this bind is outlined and the
2533    /// read could go through a mirror.
2534    ///
2535    /// An outline that does not state a row count is read again in full, because a read that asks
2536    /// for no mirror would leave the plan outlined with nothing telling the caller to bind again.
2537    fn footers(&self, paths: &[String], mirrorable: Option<&str>) -> Result<Footers> {
2538        if let Some(path) = mirrorable.filter(|_| self.outlined) {
2539            let outline = parquet_outline(path)?;
2540            if outline.rows.value().is_some() {
2541                return Ok(outline);
2542            }
2543        }
2544        parquet_footers(paths)
2545    }
2546
2547    /// Says the Parquet file at `path` could have been read through a native mirror, when its
2548    /// footer says how many rows it holds, which is what the database decides whether one would
2549    /// repay itself by.
2550    fn want_mirror(&mut self, path: &str, binary_as_string: bool, rows: &Stat<u64>) {
2551        if let Some(&rows) = rows.value() {
2552            self.plan.want_mirror(path, binary_as_string, rows);
2553        }
2554    }
2555
2556    /// One file name, as a constant expression in the plan.
2557    fn path_constant(&mut self, path: &str) -> ExprRef {
2558        let value = self.plan.add_value(Value::Varchar(path.to_string()));
2559        self.plan.add_expr(Expr::Constant(value), LogicalType::Varchar)
2560    }
2561
2562    /// The table function a file with this extension is read by, and `None` for one nothing reads.
2563    ///
2564    /// Both spellings of a tab separated file go to the CSV reader, which is not a shortcut: the
2565    /// extension picks the reader and the reader sniffs the punctuation, so a `.tsv` file that holds
2566    /// commas is read as commas. That was measured rather than assumed. The comparison ignores case
2567    /// because `UP.CSV` reads in duckdb v1.4.1.
2568    fn reader_for(extension: &str) -> Option<TableFunction> {
2569        if extension.eq_ignore_ascii_case("parquet") {
2570            return Some(TableFunction::ReadParquet);
2571        }
2572        if extension.eq_ignore_ascii_case("csv") || extension.eq_ignore_ascii_case("tsv") {
2573            return Some(TableFunction::ReadCsv);
2574        }
2575        None
2576    }
2577
2578    /// The node and the scope of a table function call whose arguments and columns are settled.
2579    ///
2580    /// The half a written out call shares with a replacement scan, which is everything after the
2581    /// question of what the file is called has been answered one way or the other.
2582    ///
2583    /// `read` is what the caller found out about the files, which comes in here rather than being
2584    /// read here because this function has the names and not the files: a replacement scan has
2585    /// already expanded its pattern and a written out call has already cast its argument, and
2586    /// neither of them wants to do it twice.
2587    fn table_function_source(
2588        &mut self,
2589        function: TableFunction,
2590        args: &[ExprRef],
2591        written: &[(&'static str, Value, ExprRef)],
2592        read: Read,
2593        label: &str,
2594        names: &[&str],
2595    ) -> Result<(NodeRef, Scope)> {
2596        let Read { fields, rows, distincts, zones } = read;
2597        let index = self.fresh_index();
2598        // Against the table index rather than against the node, because a pass is free to move the
2599        // node and none of them can move an index: an index is what a column reference names and
2600        // rewriting one would mean rewriting every expression above it. Nothing is recorded for a
2601        // function nobody measured, since an absent entry already reads back as unknown.
2602        if rows.is_known() {
2603            self.plan.measure(index, rows);
2604        }
2605        for (column, distinct) in distincts {
2606            self.plan.measure_distinct(index, &column, distinct);
2607        }
2608        if let Some(zones) = zones {
2609            self.plan.set_zones(index, zones);
2610        }
2611        let mut scope = Scope::empty();
2612        for (at, field) in fields.iter().enumerate() {
2613            scope.push(Visible {
2614                table: label.to_string(),
2615                name: field.name.clone(),
2616                binding: ColumnBinding::new(index, at as u32),
2617                ty: field.ty.clone(),
2618                // A reader takes what the file has, and no file format this reads says a column
2619                // cannot be null. The reference binary answers YES for every column of a Parquet.
2620                not_null: false,
2621                key: None,
2622                default: None,
2623                qualified: false,
2624                also: None,
2625            });
2626        }
2627        if !names.is_empty() {
2628            scope.rename(names, label)?;
2629        } else if matches!(function, TableFunction::Range | TableFunction::GenerateSeries) {
2630            // The PostgreSQL naming, which the pin follows for these two and for no reader: the
2631            // alias names the one column, and the column keeps answering to its own name too.
2632            for column in &mut scope.columns {
2633                column.also = Some(std::mem::replace(&mut column.name, label.to_string()));
2634            }
2635        }
2636        let function = self.plan.intern(function.name());
2637        let args = self.plan.add_expr_list(args);
2638        let named: Vec<u32> =
2639            written.iter().map(|(parameter, _, _)| self.plan.intern(parameter)).collect();
2640        let settings: Vec<ExprRef> = written.iter().map(|(_, _, expr)| *expr).collect();
2641        let options = self.plan.add_name_list(&named);
2642        let settings = self.plan.add_expr_list(&settings);
2643        let columns = self.plan.add_fields(&fields);
2644        let node = self.add_node(Node::TableFunction {
2645            index,
2646            function,
2647            args,
2648            options,
2649            settings,
2650            columns,
2651        });
2652        Ok((node, scope))
2653    }
2654
2655    /// Every file a table function's file argument names, in the order they were written.
2656    ///
2657    /// Each pattern has to find at least one file of its own, which is DuckDB's rule and is why
2658    /// this expands one at a time rather than gathering everything and looking at the total. A
2659    /// list keeps its written order and its duplicates, so a file named twice is read twice, which
2660    /// was measured: the sort and the dedup belong to one pattern rather than to the list.
2661    fn file_paths(&self, expr: ExprRef, name: &str) -> Result<Vec<String>> {
2662        let mut paths = Vec::new();
2663        for pattern in self.file_patterns(expr, name)? {
2664            paths.extend(files(&pattern)?);
2665        }
2666        Ok(paths)
2667    }
2668
2669    /// The patterns a table function argument names, which have to be constants.
2670    ///
2671    /// A table function that reads a file is resolved by opening the file, and that happens here
2672    /// rather than when the query runs, because the rest of the statement cannot bind until the
2673    /// column names are known. So the path has to be something this binder can work out without
2674    /// running anything, and a literal is that. DuckDB folds a constant expression first, so
2675    /// `read_parquet('a' || '.parquet')` works there, and folding is M1 work that this will pick up
2676    /// for free once the optimizer runs before the plan is finished rather than after.
2677    ///
2678    /// One string is one pattern and a list is one pattern an item, which is DuckDB's pair of
2679    /// overloads. A null is a different sentence in each of them, both of them measured.
2680    ///
2681    /// The argument is folded rather than required to be a literal. A list is a call to `list_value`
2682    /// as of the work on #467, so requiring a literal here would have turned every `read_parquet`
2683    /// over a list into the message about a name that is not a constant, and the sentence this
2684    /// comment used to carry about folding being picked up for free was the plan for exactly that.
2685    /// What it buys beyond keeping the list working is `read_parquet('a' || '.parquet')`, which the
2686    /// pin answers and which used to be refused here.
2687    fn file_patterns(&self, expr: ExprRef, name: &str) -> Result<Vec<String>> {
2688        let Some(value) = fold::value_of(&self.plan, expr)? else {
2689            return Err(Error::not_implemented(
2690                "a table function file name that is not a constant",
2691            ));
2692        };
2693        match value {
2694            Value::Varchar(path) => Ok(vec![path]),
2695            // DuckDB's own wording, which says list because its other overload takes one.
2696            Value::Null => Err(Error::parser(format!("{name} cannot take NULL list as parameter"))),
2697            // An empty list reaches the reader rather than failing to bind, because `[]` carries an
2698            // element type of the untyped null and a null promotes to VARCHAR, so the call resolves.
2699            // The pin says this, and it says it as an IO error rather than as a binder one, since
2700            // the list was a fine list and the objection is that there is no file in it.
2701            Value::List { values, .. } if values.is_empty() => {
2702                Err(Error::io(format!("\"{name}\" needs at least one file to read")))
2703            }
2704            Value::List { values, .. } => values
2705                .iter()
2706                .map(|value| match value {
2707                    Value::Varchar(path) => Ok(path.clone()),
2708                    _ => Err(Error::parser(format!(
2709                        "{name} reader cannot take NULL input as parameter"
2710                    ))),
2711                })
2712                .collect(),
2713            other => {
2714                Err(Error::internal(format!("a file name bound as VARCHAR arrived as {other}")))
2715            }
2716        }
2717    }
2718
2719    /// Which input of a join a query written in its `ON` has to be joined into.
2720    ///
2721    /// A join condition is evaluated by the join, over the rows its two inputs handed it, so a
2722    /// column the condition reads has to be produced by one of those two. A query written in the
2723    /// `ON` produces columns the condition reads, which means the query cannot be joined in above
2724    /// the join the way one written in a `WHERE` or a `SELECT` is. It has to go underneath, into
2725    /// one input or the other.
2726    ///
2727    /// Which input is decided by what the query reads. A query whose body reads the right side can
2728    /// only be evaluated where those rows are, so it goes into the right input, and the same for
2729    /// the left. A query that reads neither could go into either and goes into the left, which is
2730    /// also where an `IN` puts one whose left hand side reads the left and whose body reads
2731    /// nothing.
2732    ///
2733    /// The one that has no answer is a query that reads both sides. There is no single input that
2734    /// produces what it needs, and the shape upstream calls a pair dependent join is what handles
2735    /// it. `None` is that case, and the caller turns it into a refusal rather than a plan.
2736    fn side_of(
2737        &self,
2738        pending: &PendingSubquery,
2739        left_tables: &[u32],
2740        right_tables: &[u32],
2741    ) -> Option<Side> {
2742        let mut needs_left = false;
2743        let mut needs_right = false;
2744        let mut note = |binding: ColumnBinding| {
2745            needs_left |= left_tables.contains(&binding.table);
2746            needs_right |= right_tables.contains(&binding.table);
2747        };
2748        for &binding in &pending.reads {
2749            note(binding);
2750        }
2751        // A mark join carries the comparison rather than the condition carrying it, and that
2752        // comparison is written over the join's own rows. `l.a IN (SELECT ...)` reads the left side
2753        // there and nowhere else, so leaving it out would put the query on whichever side its body
2754        // happened to name and let the comparison ask a join for a column it was not given.
2755        for &condition in &pending.conditions {
2756            self.plan.read_columns(condition, &mut |_, binding| note(binding));
2757        }
2758        match (needs_left, needs_right) {
2759            (true, true) => None,
2760            (_, true) => Some(Side::Right),
2761            _ => Some(Side::Left),
2762        }
2763    }
2764
2765    /// A join whose condition holds a query that reads rows from both of its inputs.
2766    ///
2767    /// This is the one [`Binder::side_of`] has no side for. The query has to be evaluated once per
2768    /// pair of rows, and there is no input that produces a pair, so it cannot go into either input
2769    /// the way the other two cases do. What produces a pair is the join itself, so the join becomes
2770    /// a product, the query is joined into the product's rows the way a query in a `WHERE` is joined
2771    /// into the rows the whole `FROM` produced, and the condition becomes a filter above that.
2772    ///
2773    /// That rewrite is only the same query for an inner join. An inner join keeps the pairs its
2774    /// condition holds and drops the rest, which is what a product and a filter do. Every other kind
2775    /// does something with the pairs it dropped, a left join pads them, a semi join counts them, and
2776    /// a filter above a product has already thrown away which left row a dropped pair came from, so
2777    /// those are refused by name. Upstream plans them as a pair dependent join and rudb does not
2778    /// have one yet, which is what tamnd/rudb#913 stays open for.
2779    ///
2780    /// The product is not the plan that runs. The condition goes back into the join as a condition
2781    /// when filter pushdown looks at it, which is the pass that already turns a filter over an inner
2782    /// join into a join condition, so an equality in the `ON` is still an equality the hash join can
2783    /// build on. What cannot be pushed back down is the part that reads the query's output, and that
2784    /// part could not have been a join condition in the first place.
2785    #[allow(clippy::too_many_arguments)]
2786    fn bind_pair_dependent_join(
2787        &mut self,
2788        kind: ast::JoinKind,
2789        independent: bool,
2790        left: NodeRef,
2791        right: NodeRef,
2792        pair: Vec<PendingSubquery>,
2793        conditions: Vec<ExprRef>,
2794        scope: Scope,
2795    ) -> Result<(NodeRef, Scope)> {
2796        if kind != ast::JoinKind::Inner {
2797            return Err(Error::not_implemented(
2798                "a subquery that reads both sides of that join, written in the condition of a join \
2799                 that is not an inner join"
2800                    .to_string(),
2801            ));
2802        }
2803        // A lateral right side is already evaluated per left row, so the product this would build is
2804        // not the product the query means.
2805        if !independent {
2806            return Err(Error::not_implemented(
2807                "a subquery that reads both sides of that join, written in the condition of a join \
2808                 whose right side is lateral"
2809                    .to_string(),
2810            ));
2811        }
2812        let mut node = self.add_node(Node::CrossProduct { left, right });
2813        for pending in pair {
2814            node = self.attach_subquery(node, pending);
2815        }
2816        // `ON` and `USING` cannot both be written, and this is only reached from the `ON` path, so
2817        // the list is the one bound condition. The fold is here so that it stays right if that stops
2818        // being true rather than for a case that exists today.
2819        let mut conditions = conditions.into_iter();
2820        let mut predicate = conditions.next().expect("a join condition was bound");
2821        for next in conditions {
2822            let children = self.plan.add_expr_list(&[predicate, next]);
2823            let conjunction = Expr::Conjunction { op: ConjunctionOp::And, children };
2824            predicate = self.plan.add_expr(conjunction, LogicalType::Boolean);
2825        }
2826        let node = self.add_node(Node::Filter { input: node, predicate });
2827        Ok((node, scope))
2828    }
2829
2830    #[allow(clippy::too_many_arguments)]
2831    fn bind_join(
2832        &mut self,
2833        ast: &Ast,
2834        left: ast::SourceRef,
2835        right: ast::SourceRef,
2836        kind: ast::JoinKind,
2837        natural: bool,
2838        on: ast::ExprRef,
2839        using: ast::Slice,
2840    ) -> Result<(NodeRef, Scope)> {
2841        let (left_node, left_scope) = self.bind_source(ast, left)?;
2842        let (right_node, right_scope, correlated) = self.bind_lateral(ast, right, &left_scope)?;
2843        // A row of the right side exists only for the left row it was evaluated against, so a kind
2844        // that has to produce right rows with no left row has nothing to produce them from. The
2845        // pinned build says this and names only the two kinds that work.
2846        if !correlated.is_empty()
2847            && !matches!(kind, ast::JoinKind::Inner | ast::JoinKind::Cross | ast::JoinKind::Left)
2848        {
2849            return Err(Error::binder(
2850                "The combining JOIN type must be INNER or LEFT for a LATERAL reference",
2851            ));
2852        }
2853        let split = left_scope.len();
2854        // Which table index came from which side, kept before the two scopes become one. A query
2855        // written in the `ON` is joined into one of the inputs rather than above the join, and this
2856        // is what says which. A `USING` drops the right side's copy of a joined-on column out of
2857        // the scope below, and dropping a column does not change the index it came from, so the
2858        // answer this gives is still right afterwards.
2859        let left_tables: Vec<u32> =
2860            left_scope.columns.iter().map(|column| column.binding.table).collect();
2861        let right_tables: Vec<u32> =
2862            right_scope.columns.iter().map(|column| column.binding.table).collect();
2863        let mut scope = left_scope.concat(right_scope);
2864
2865        // NATURAL is USING over whatever both sides happen to call the same thing, which is why it
2866        // is resolved here and never reaches the plan as its own idea.
2867        let merged: Vec<String> = if natural {
2868            let mut names = Vec::new();
2869            for (at, column) in scope.columns.iter().enumerate().take(split) {
2870                if scope.columns[split..].iter().any(|right| same_name(&right.name, &column.name))
2871                    && !names.iter().any(|held: &String| same_name(held, &column.name))
2872                {
2873                    let _ = at;
2874                    names.push(column.name.clone());
2875                }
2876            }
2877            names
2878        } else {
2879            // A name written twice is one column, not two. `USING (id, id)` is legal and means what
2880            // `USING (id)` means, and the reference binary agrees. Taking it twice would build the
2881            // same equality twice and, worse, drop the right side's copy twice, which takes a
2882            // column out of the answer that nobody named and runs off the end of the scope when the
2883            // copy was the last column in it.
2884            let mut names: Vec<String> = Vec::new();
2885            for name in ast.name(using) {
2886                if !names.iter().any(|held| same_name(held, name)) {
2887                    names.push(name.to_string());
2888                }
2889            }
2890            names
2891        };
2892
2893        let mut conditions = Vec::new();
2894        let mut dropped = Vec::new();
2895        for name in &merged {
2896            let left_at = scope.columns[..split]
2897                .iter()
2898                .position(|column| same_name(&column.name, name))
2899                .ok_or_else(|| {
2900                    Error::binder(format!(
2901                        "column \"{name}\" specified in USING clause does not exist in left table"
2902                    ))
2903                })?;
2904            let right_at = scope.columns[split..]
2905                .iter()
2906                .position(|column| same_name(&column.name, name))
2907                .map(|at| at + split)
2908                .ok_or_else(|| {
2909                    Error::binder(format!(
2910                        "column \"{name}\" specified in USING clause does not exist in right table"
2911                    ))
2912                })?;
2913            let left_column = &scope.columns[left_at];
2914            let (left_binding, left_type) = (left_column.binding, left_column.ty.clone());
2915            let right_column = &scope.columns[right_at];
2916            let (right_binding, right_type) = (right_column.binding, right_column.ty.clone());
2917            let left_expr = self.plan.add_expr(Expr::Column(left_binding), left_type);
2918            let right_expr = self.plan.add_expr(Expr::Column(right_binding), right_type);
2919            conditions.push(self.compare(rudb_plan::CompareOp::Equal, left_expr, right_expr)?);
2920            dropped.push(right_at);
2921        }
2922        // A joined-on column appears once, so the right side's copy goes. Dropping from the back
2923        // keeps the positions of the ones still to drop correct.
2924        dropped.sort_unstable();
2925        for at in dropped.into_iter().rev() {
2926            scope.remove(at);
2927        }
2928
2929        let mut left_node = left_node;
2930        let mut right_node = right_node;
2931        let mut pair = Vec::new();
2932        if on != NONE {
2933            if !merged.is_empty() {
2934                return Err(Error::binder("a join cannot have both ON and USING"));
2935            }
2936            self.clause = "JOIN condition";
2937            let waiting = self.scalar_subqueries.len();
2938            let predicate = self.bind_expr(ast, on, &scope)?;
2939            conditions.push(self.as_boolean(predicate, "JOIN")?);
2940            for pending in self.scalar_subqueries.split_off(waiting) {
2941                match self.side_of(&pending, &left_tables, &right_tables) {
2942                    Some(Side::Right) => right_node = self.attach_subquery(right_node, pending),
2943                    Some(Side::Left) => left_node = self.attach_subquery(left_node, pending),
2944                    None => pair.push(pending),
2945                }
2946            }
2947        }
2948
2949        if kind == ast::JoinKind::Cross && !conditions.is_empty() {
2950            return Err(Error::binder("a CROSS JOIN cannot have a condition"));
2951        }
2952        if !pair.is_empty() {
2953            return self.bind_pair_dependent_join(
2954                kind,
2955                correlated.is_empty(),
2956                left_node,
2957                right_node,
2958                pair,
2959                conditions,
2960                scope,
2961            );
2962        }
2963        // A product is the join with nothing to join on, and it is not one when the right side has
2964        // to be evaluated per left row, because then there is a dependency to lower even though
2965        // there is no condition to test.
2966        if correlated.is_empty()
2967            && conditions.is_empty()
2968            && matches!(kind, ast::JoinKind::Cross | ast::JoinKind::Inner)
2969        {
2970            let node = self.add_node(Node::CrossProduct { left: left_node, right: right_node });
2971            return Ok((node, scope));
2972        }
2973        // A semi join and an anti join ask a question about the right side rather than producing
2974        // any of it, so what is in scope after one is the left side alone. The condition is bound
2975        // above and is the last thing that can name the right side. Without this, `SELECT *` over
2976        // one expanded to both sides and the projection asked a join whose output is the left side
2977        // for columns it does not have, which came out as an internal error about a column not
2978        // being in the schema. That is tamnd/rudb#847. The reference binary refuses `b.w` here with
2979        // a binder error naming `a` as the only candidate table, which is the same rule said from
2980        // the other end.
2981        if matches!(kind, ast::JoinKind::Semi | ast::JoinKind::Anti) {
2982            scope.truncate(split);
2983        }
2984        let kind = match kind {
2985            ast::JoinKind::Inner | ast::JoinKind::Cross => JoinKind::Inner,
2986            ast::JoinKind::Left => JoinKind::Left,
2987            ast::JoinKind::Right => JoinKind::Right,
2988            ast::JoinKind::Full => JoinKind::Full,
2989            ast::JoinKind::Semi => JoinKind::Semi,
2990            ast::JoinKind::Anti => JoinKind::Anti,
2991            ast::JoinKind::Positional => JoinKind::Positional,
2992        };
2993        let conditions = self.plan.add_expr_list(&conditions);
2994        let node = if correlated.is_empty() {
2995            self.add_node(Node::Join {
2996                left: left_node,
2997                right: right_node,
2998                kind,
2999                conditions,
3000                build: BuildSide::default(),
3001            })
3002        } else {
3003            self.add_node(Node::DependentJoin {
3004                left: left_node,
3005                right: right_node,
3006                kind,
3007                conditions,
3008            })
3009        };
3010        Ok((node, scope))
3011    }
3012
3013    // -------------------------------------------------------------- aggregates
3014
3015    /// Binds a `FILTER (WHERE ...)` predicate, or says there was none.
3016    ///
3017    /// The predicate is a condition over the input rows and not over the answer, so it is bound in
3018    /// the scope the arguments are bound in, and it is cast to `BOOLEAN` the way a `WHERE` is:
3019    /// `FILTER (WHERE i)` over an integer column is a filter on whether the integer is not zero.
3020    fn bind_filter(
3021        &mut self,
3022        ast: &Ast,
3023        filter: ast::ExprRef,
3024        scope: &Scope,
3025    ) -> Result<Option<ExprRef>> {
3026        if filter == NONE {
3027            return Ok(None);
3028        }
3029        let bound = self.bind_expr(ast, filter, scope)?;
3030        Ok(Some(self.checked_cast_to(bound, &LogicalType::Boolean, false)?))
3031    }
3032
3033    /// Binds an aggregate call, records it, and hands back a reference to where its result lands.
3034    ///
3035    /// An aggregate inside a lambda's body is computed over the rows and not over the elements,
3036    /// so its arguments cannot see the lambda's parameters. See `crate::lambda`.
3037    pub(crate) fn bind_aggregate(
3038        &mut self,
3039        ast: &Ast,
3040        name: &str,
3041        args: &[ast::ExprRef],
3042        distinct: bool,
3043        filter: ast::ExprRef,
3044        scope: &Scope,
3045    ) -> Result<ExprRef> {
3046        let frames = std::mem::take(&mut self.lambda_frames);
3047        let bound = self.bind_aggregate_over_rows(ast, name, args, distinct, filter, scope);
3048        self.lambda_frames = frames;
3049        bound
3050    }
3051
3052    fn bind_aggregate_over_rows(
3053        &mut self,
3054        ast: &Ast,
3055        name: &str,
3056        args: &[ast::ExprRef],
3057        distinct: bool,
3058        filter: ast::ExprRef,
3059        scope: &Scope,
3060    ) -> Result<ExprRef> {
3061        if self.in_filter {
3062            return Err(Error::binder("aggregate functions are not allowed in FILTER"));
3063        }
3064        if self.in_aggregate {
3065            return Err(Error::binder(format!(
3066                "aggregate function calls cannot be nested, and {name}() is inside one"
3067            )));
3068        }
3069        if self.aggregation.is_none() {
3070            return Err(Error::binder(format!(
3071                "aggregate function calls cannot be used in the {}",
3072                self.clause
3073            )));
3074        }
3075        // The predicate goes first, which is the order the messages come out in upstream: a call
3076        // whose argument and whose filter both name columns that are not there is refused over the
3077        // filter. It is bound as if it were inside the call, so an aggregate in it is caught, and a
3078        // window in it is refused with the words a window inside an aggregate is refused with.
3079        self.in_aggregate = true;
3080        self.in_filter = true;
3081        let filter = self.bind_filter(ast, filter, scope);
3082        self.in_filter = false;
3083        self.in_aggregate = false;
3084        let filter = filter?;
3085
3086        self.in_aggregate = true;
3087        let mut bound = Vec::with_capacity(args.len());
3088        let mut failure = None;
3089        for &arg in args {
3090            match self.bind_expr(ast, arg, scope) {
3091                Ok(expr) => bound.push(expr),
3092                Err(error) => {
3093                    failure = Some(error);
3094                    break;
3095                }
3096            }
3097        }
3098        self.in_aggregate = false;
3099        if let Some(error) = failure {
3100            return Err(error);
3101        }
3102
3103        let types: Vec<LogicalType> =
3104            bound.iter().map(|&arg| self.plan.expr_type(arg).clone()).collect();
3105        let resolved = resolve(name, &types)?;
3106        // The separator is read once per group and not once per row, so the pin wants it to be the
3107        // same on every row and says so in these words.
3108        if resolved.name == "string_agg"
3109            && bound.len() == 2
3110            && !matches!(fold::value_of(&self.plan, bound[1]), Ok(Some(_)))
3111        {
3112            return Err(Error::binder(
3113                "The \"separator\" argument in function \"string_agg\" must be a constant expression",
3114            ));
3115        }
3116        let mut cast = Vec::with_capacity(bound.len());
3117        for (arg, wanted) in bound.iter().zip(&resolved.arguments) {
3118            cast.push(self.checked_cast_to(*arg, wanted, false)?);
3119        }
3120        let args = self.plan.add_expr_list(&cast);
3121        let name = self.plan.intern(resolved.name);
3122        let ty = resolved.returns;
3123        let call = self.plan.add_expr(Expr::Aggregate { name, args, distinct, filter }, ty.clone());
3124
3125        // Two identical aggregates are one column of the aggregate's output. `SELECT sum(x),
3126        // sum(x) / count(*)` computes one sum, not two.
3127        let existing = self.aggregation.as_ref().map(|held| held.aggregates.clone());
3128        let existing = existing.unwrap_or_default();
3129        let at = match existing.iter().position(|&held| self.same_expr(held, call)) {
3130            Some(at) => at,
3131            None => {
3132                let aggregation = self.aggregation.as_mut().expect("checked above");
3133                aggregation.aggregates.push(call);
3134                aggregation.aggregates.len() - 1
3135            }
3136        };
3137        let aggregation = self.aggregation.as_ref().expect("checked above");
3138        let (index, groups) = (aggregation.index, aggregation.groups.len());
3139        Ok(self.column(index, groups + at, ty))
3140    }
3141
3142    // ----------------------------------------------------------------- windows
3143
3144    /// Binds a window call, files it under the run it belongs to, and hands back its column.
3145    ///
3146    /// The result is a column of a [`Node::Window`] rather than the call itself, for the reason the
3147    /// aggregate path returns a column too: the operator produces the value and everything above it
3148    /// reads the value, so a target that wraps a window in arithmetic is arithmetic over a column.
3149    ///
3150    /// A window inside a lambda's body is computed over the rows for the reason an aggregate is,
3151    /// so it cannot see the lambda's parameters either.
3152    pub(crate) fn bind_window(
3153        &mut self,
3154        ast: &Ast,
3155        written: &WindowCall<'_>,
3156        scope: &Scope,
3157    ) -> Result<ExprRef> {
3158        let frames = std::mem::take(&mut self.lambda_frames);
3159        let bound = self.bind_window_over_rows(ast, written, scope);
3160        self.lambda_frames = frames;
3161        bound
3162    }
3163
3164    fn bind_window_over_rows(
3165        &mut self,
3166        ast: &Ast,
3167        written: &WindowCall<'_>,
3168        scope: &Scope,
3169    ) -> Result<ExprRef> {
3170        let WindowCall { name, args, distinct, filter, ignore_nulls, spec, .. } = *written;
3171        if self.in_aggregate {
3172            return Err(Error::binder(
3173                "aggregate function calls cannot contain window function calls",
3174            ));
3175        }
3176        if self.in_window {
3177            return Err(Error::binder("window function calls cannot be nested"));
3178        }
3179        // A join condition is part of the `WHERE` clause as far as this one sentence is concerned,
3180        // which is upstream's wording and not a simplification: `ON sum(a.i) OVER () = b.i` is
3181        // refused there with the words a window in a `WHERE` is refused with.
3182        let clause = if self.clause == "JOIN condition" { "WHERE clause" } else { self.clause };
3183        if clause != "SELECT clause" && clause != "ORDER BY clause" {
3184            return Err(Error::binder(format!("{clause} cannot contain window functions!")));
3185        }
3186
3187        // `count(*)` is a different function from `count(x)` here for the reason it is a different
3188        // function in an ordinary call: one counts rows and the other counts the rows where its
3189        // argument is not null. A star is not an expression and nothing below this binds one.
3190        let starred = args.iter().any(|&arg| {
3191            matches!(ast.expr(arg), ast::Expr::Star { qualifier, replacements }
3192                if qualifier.is_empty() && replacements.is_empty())
3193        });
3194        let (name, args): (&str, &[ast::ExprRef]) = if starred {
3195            if !same_name(name, "count") || args.len() != 1 {
3196                return Err(Error::binder(format!("* is not allowed in {name}()")));
3197            }
3198            ("count_star", &[])
3199        } else if same_name(name, "count") && args.is_empty() {
3200            // `count()` with nothing in it is upstream's other spelling of `count(*)`. It counts
3201            // rows the same way and it is not an arity mistake.
3202            ("count_star", &[])
3203        } else {
3204            (name, args)
3205        };
3206
3207        let held = ast.window(spec);
3208        self.in_window = true;
3209        let parts = self.window_parts(ast, written, args, held, scope);
3210        // The predicate goes last here, which is the other way round from an ordinary aggregate and
3211        // is again the order the messages come out in upstream. It is still inside the window, so a
3212        // window in it is a nested window, while an aggregate in it is an ordinary aggregate over
3213        // the same rows and is answered.
3214        let filter = if parts.is_ok() { self.bind_filter(ast, filter, scope) } else { Ok(None) };
3215        self.in_window = false;
3216        let parts = parts?;
3217        let filter = filter?;
3218        // Upstream's rule, in its words. A `RANGE` offset is a distance from the current row's sort
3219        // key, so there has to be exactly one sort key for it to be a distance from.
3220        let offsets = [parts.frame.start, parts.frame.end]
3221            .iter()
3222            .any(|end| matches!(end, WindowBound::Preceding(_) | WindowBound::Following(_)));
3223        if parts.frame.unit == WindowUnit::Range && offsets && parts.order.len() != 1 {
3224            return Err(Error::binder("RANGE frames must have only one ORDER BY expression"));
3225        }
3226
3227        let types: Vec<LogicalType> =
3228            parts.args.iter().map(|&arg| self.plan.expr_type(arg).clone()).collect();
3229        let resolved = window_signature(name, &types)?;
3230        // `fill` reads the sort key rather than the frame, so what it needs from the query is not
3231        // what any other window needs and it is refused on its own terms.
3232        if resolved.name == "fill" {
3233            let keys: Vec<LogicalType> =
3234                parts.order.iter().map(|key| self.plan.expr_type(key.expr).clone()).collect();
3235            refuse_fill(&types[0], &keys, distinct, ignore_nulls)?;
3236        }
3237        // Upstream's sentence, doubled quotes and all. A DISTINCT over an aggregate inside an OVER
3238        // is ordinary and answered, and a DISTINCT over a ranking window is refused there, because
3239        // there is nothing for it to collapse when the call reads no values in the first place.
3240        if distinct && kind_of(resolved.name) == Some(FunctionKind::Window) {
3241            return Err(Error::binder(format!(
3242                "DISTINCT is not implemented for the window function \"\"{name}\"\""
3243            )));
3244        }
3245        // The same sentence for the same reason. A ranking window reads no values, so there is
3246        // nothing for a predicate over the values to keep or drop.
3247        if filter.is_some() && kind_of(resolved.name) == Some(FunctionKind::Window) {
3248            return Err(Error::binder(format!(
3249                "FILTER is not implemented for the window function \"\"{name}\"\""
3250            )));
3251        }
3252        // An `ORDER BY` inside the brackets puts the rows of the frame in a different order for
3253        // this one call to read them in, which is a question every aggregate and the three that
3254        // count through the frame have an answer to. The rest of the window functions read
3255        // something other than the frame, and what the reference binary does with them under an
3256        // order of their own is a different reading again, so they are turned down rather than
3257        // guessed at. The exclusion is refused first and in the reference binary's own sentence,
3258        // because that is the one it reaches for when both apply. Per #1204.
3259        if !parts.inner.is_empty() && kind_of(resolved.name) == Some(FunctionKind::Window) {
3260            let counts = matches!(resolved.name, "first_value" | "last_value" | "nth_value");
3261            if !counts {
3262                if parts.frame.exclude != WindowExclude::NoOthers {
3263                    return Err(Error::binder(format!(
3264                        "EXCLUDE is not supported for the window function \"\"{}\"\"",
3265                        resolved.name
3266                    )));
3267                }
3268                return Err(Error::not_implemented(format!(
3269                    "ORDER BY inside the arguments of the window function \"{}\"",
3270                    resolved.name
3271                )));
3272            }
3273        }
3274        let mut cast = Vec::with_capacity(parts.args.len());
3275        for (arg, wanted) in parts.args.iter().zip(&resolved.arguments) {
3276            cast.push(self.checked_cast_to(*arg, wanted, false)?);
3277        }
3278        let args = self.plan.add_expr_list(&cast);
3279        let order = self.plan.add_sort_keys(&parts.inner);
3280        let name = self.plan.intern(resolved.name);
3281        let ty = resolved.returns;
3282        let call = self.plan.add_expr(
3283            Expr::Window { name, args, distinct, filter, ignore_nulls, order },
3284            ty.clone(),
3285        );
3286
3287        let at = self.window_run(parts.partition, parts.order, parts.frame, call);
3288        let index = self.windows.last().expect("the run was just filed").index;
3289        Ok(self.column(index, at, ty))
3290    }
3291
3292    /// Files a call under the run that matches it, or opens a new run, and says which column it is.
3293    ///
3294    /// The run that matches is only ever the last one, because a query that goes back to an earlier
3295    /// partitioning after using a different one in between wants the operators in the order it wrote
3296    /// them. Merging the two would be a rewrite, and a rewrite over a window is the optimizer's to
3297    /// make once it knows what the sort below each one costs.
3298    fn window_run(
3299        &mut self,
3300        partition: Vec<ExprRef>,
3301        order: Vec<SortKey>,
3302        frame: WindowFrame,
3303        call: ExprRef,
3304    ) -> usize {
3305        let matches = self.windows.last().is_some_and(|run| {
3306            run.frame == frame
3307                && run.partition.len() == partition.len()
3308                && run.order.len() == order.len()
3309                && run.partition.iter().zip(&partition).all(|(&l, &r)| self.same_expr(l, r))
3310                && run.order.iter().zip(&order).all(|(l, r)| {
3311                    l.descending == r.descending
3312                        && l.nulls_first == r.nulls_first
3313                        && self.same_expr(l.expr, r.expr)
3314                })
3315        });
3316        if !matches {
3317            let index = self.fresh_index();
3318            self.windows.push(WindowRun { index, partition, order, frame, calls: Vec::new() });
3319        }
3320        // Two identical calls over one run are one column, the same way two identical aggregates
3321        // over one grouping are. `SELECT sum(i) OVER (), sum(i) OVER () + 1` totals once.
3322        let calls = self.windows.last().expect("a run is open").calls.clone();
3323        if let Some(at) = calls.iter().position(|&held| self.same_expr(held, call)) {
3324            return at;
3325        }
3326        let run = self.windows.last_mut().expect("a run is open");
3327        run.calls.push(call);
3328        run.calls.len() - 1
3329    }
3330
3331    /// Binds the arguments and everything inside the `OVER`, with the aggregate rule applied.
3332    ///
3333    /// The aggregate rule applies to all of it, which is measured rather than assumed: over a
3334    /// grouped block `sum(count(i)) OVER ()` binds and `sum(i) OVER ()` is the ungrouped column
3335    /// complaint, and the same pair of answers comes back for a partition key and for an order key.
3336    fn window_parts(
3337        &mut self,
3338        ast: &Ast,
3339        written: &WindowCall<'_>,
3340        args: &[ast::ExprRef],
3341        held: ast::WindowSpec,
3342        scope: &Scope,
3343    ) -> Result<WindowParts> {
3344        let mut bound = Vec::with_capacity(args.len());
3345        for &arg in args {
3346            let expr = self.bind_expr(ast, arg, scope)?;
3347            bound.push(self.over_aggregate(expr, scope)?);
3348        }
3349        // The keys inside the brackets are bound against the same rows the arguments are, because
3350        // that is what they sort: the call reads its frame in this order, and the frame is made of
3351        // the operator's input rows.
3352        let mut inner = Vec::new();
3353        for item in ast.order_list(written.order).to_vec() {
3354            let expr = self.bind_expr(ast, item.expr, scope)?;
3355            let expr = self.over_aggregate(expr, scope)?;
3356            inner.push(self.sort_key(expr, item));
3357        }
3358        let mut partition = Vec::new();
3359        for &key in ast.expr_list(held.partition) {
3360            let expr = self.bind_expr(ast, key, scope)?;
3361            partition.push(self.over_aggregate(expr, scope)?);
3362        }
3363        let mut order = Vec::new();
3364        for item in ast.order_list(held.order).to_vec() {
3365            let expr = self.bind_expr(ast, item.expr, scope)?;
3366            let expr = self.over_aggregate(expr, scope)?;
3367            order.push(self.sort_key(expr, item));
3368        }
3369        let frame = WindowFrame {
3370            unit: match held.unit {
3371                ast::WindowUnit::Rows => WindowUnit::Rows,
3372                ast::WindowUnit::Range => WindowUnit::Range,
3373                ast::WindowUnit::Groups => WindowUnit::Groups,
3374            },
3375            start: self.window_bound(ast, held.start, scope)?,
3376            end: self.window_bound(ast, held.end, scope)?,
3377            exclude: match held.exclude {
3378                ast::WindowExclude::NoOthers => WindowExclude::NoOthers,
3379                ast::WindowExclude::CurrentRow => WindowExclude::CurrentRow,
3380                ast::WindowExclude::Group => WindowExclude::Group,
3381                ast::WindowExclude::Ties => WindowExclude::Ties,
3382            },
3383        };
3384        Ok(WindowParts { args: bound, partition, order, inner, frame })
3385    }
3386
3387    /// One end of a frame, with its offset bound where it has one.
3388    fn window_bound(
3389        &mut self,
3390        ast: &Ast,
3391        bound: ast::WindowBound,
3392        scope: &Scope,
3393    ) -> Result<WindowBound> {
3394        let offset = |binder: &mut Self, written| {
3395            let expr = binder.bind_expr(ast, written, scope)?;
3396            binder.over_aggregate(expr, scope)
3397        };
3398        Ok(match bound {
3399            ast::WindowBound::UnboundedPreceding => WindowBound::UnboundedPreceding,
3400            ast::WindowBound::CurrentRow => WindowBound::CurrentRow,
3401            ast::WindowBound::UnboundedFollowing => WindowBound::UnboundedFollowing,
3402            ast::WindowBound::Preceding(written) => WindowBound::Preceding(offset(self, written)?),
3403            ast::WindowBound::Following(written) => WindowBound::Following(offset(self, written)?),
3404        })
3405    }
3406
3407    /// Which of this block's groups is exactly that column, if one of them is.
3408    ///
3409    /// Exactly the column and not an expression over it, because the caller is looking for the same
3410    /// value read from the aggregate instead of from the table underneath it, and `GROUP BY k + 1`
3411    /// carries the sum and not the column.
3412    fn group_of(&self, read: ColumnBinding) -> Option<usize> {
3413        self.aggregation.as_ref()?.groups.iter().position(
3414            |group| matches!(*self.plan.expr(*group), Expr::Column(binding) if binding == read),
3415        )
3416    }
3417
3418    /// The outer column a query still waiting under this grouping correlates to and the grouping
3419    /// does not carry upward, which is the column an error should name.
3420    ///
3421    /// `None` when the binding is not one of those queries, which is every ordinary case of a
3422    /// column read without a group.
3423    fn ungrouped_correlation(&self, binding: ColumnBinding) -> Option<ColumnBinding> {
3424        let pending =
3425            self.scalar_subqueries.iter().find(|pending| pending.index == binding.table)?;
3426        pending.reads.iter().copied().find(|read| self.group_of(*read).is_none())
3427    }
3428
3429    /// Whether a column is the result of a window this block is building.
3430    fn is_window_output(&self, binding: ColumnBinding) -> bool {
3431        self.windows.iter().any(|run| run.index == binding.table)
3432    }
3433
3434    /// Whether a column was resolved in an enclosing query rather than in this one.
3435    ///
3436    /// Every such read is written into the frame of the query being bound as it is resolved, and
3437    /// the frame is only handed up once that query's body is done, so while a select list or a
3438    /// `HAVING` is being bound the frame still holds everything this query read from outside it.
3439    fn is_correlation(&self, binding: ColumnBinding) -> bool {
3440        self.correlations.last().is_some_and(|frame| frame.contains(&binding))
3441    }
3442
3443    /// The name a column is written under, for an error message to say which one it means.
3444    ///
3445    /// A column of an enclosing query is not in this query's scope, so the outer scopes are searched
3446    /// as well. Without that the message names no column at all, which is how `column a column must
3447    /// appear in the GROUP BY clause` came to be a sentence this engine printed.
3448    fn name_of(&self, binding: ColumnBinding, scope: &Scope) -> String {
3449        std::iter::once(scope)
3450            .chain(self.outer_scopes.iter().rev())
3451            .flat_map(|visible| visible.columns.iter())
3452            .find(|column| column.binding == binding)
3453            .map_or_else(|| "a column".to_string(), |column| format!("\"{}\"", column.name))
3454    }
3455
3456    /// Rewrites a bound expression into one the aggregate's output can answer.
3457    ///
3458    /// A subexpression that is one of the group expressions becomes a reference to that group. A
3459    /// column that is neither grouped nor inside an aggregate is the error every SQL user has seen,
3460    /// and it is reported here because this is the first point where it is knowable.
3461    pub(crate) fn over_aggregate(&mut self, expr: ExprRef, scope: &Scope) -> Result<ExprRef> {
3462        let Some(aggregation) = self.aggregation.as_ref() else {
3463            return Ok(expr);
3464        };
3465        let index = aggregation.index;
3466        let groups = aggregation.groups.clone();
3467        for (at, group) in groups.iter().enumerate() {
3468            if self.same_expr(expr, *group) {
3469                let ty = self.plan.expr_type(*group).clone();
3470                return Ok(self.column(index, at, ty));
3471            }
3472        }
3473        let ty = self.plan.expr_type(expr).clone();
3474        match self.plan.expr(expr).clone() {
3475            Expr::Column(binding) if binding.table == index => Ok(expr),
3476            // A window result is not a column of the input and the grouping rule has nothing to say
3477            // about it. It reads the aggregate's output rather than the table's, which is why
3478            // `SELECT sum(count(i)) OVER () FROM t GROUP BY j` binds and `sum(i) OVER ()` over the
3479            // same block does not.
3480            Expr::Column(binding) if self.is_window_output(binding) => Ok(expr),
3481            // The same argument for a query joined in above the grouping. `HAVING sum(x) > (SELECT
3482            // ...)` reads one row out of a query that has nothing to do with the groups, and the
3483            // join that produces it sits on top of the `Aggregate`, so what it produces is not one
3484            // of the grouped table's columns either.
3485            Expr::Column(binding) if self.joined_above.contains(&binding.table) => Ok(expr),
3486            // A column of an enclosing query is one value for the whole of this one, because this
3487            // query is evaluated once per outer row. It is a constant here in the sense the grouping
3488            // rule cares about, so it is allowed wherever a grouped column is and needs no group of
3489            // its own. The grouping rule is about columns of this query's own `FROM`, and a name
3490            // that resolved past it is not one of those. That is #995.
3491            Expr::Column(binding) if self.is_correlation(binding) => Ok(expr),
3492            // A query this block wrote that is still waiting to be joined in underneath the
3493            // grouping lands here as well, and the column the complaint should name is the one that
3494            // query correlates to rather than the column the query produces, which belongs to no
3495            // table anybody wrote. An uncorrelated query and a correlated one whose correlation is
3496            // grouped were both moved over the grouping by [`Self::lift_over_aggregate`] and are
3497            // not here, so what is left correlates to something this block neither grouped nor
3498            // aggregated, and that is an ordinary missing GROUP BY however far inside a query it
3499            // was written. That is #1032.
3500            Expr::Column(binding) => {
3501                let read = self.ungrouped_correlation(binding).unwrap_or(binding);
3502                let name = self.name_of(read, scope);
3503                Err(Error::binder(format!(
3504                    "column {name} must appear in the GROUP BY clause or must be part of an aggregate function"
3505                )))
3506            }
3507            Expr::Constant(_)
3508            | Expr::Aggregate { .. }
3509            | Expr::Window { .. }
3510            | Expr::LambdaParam(_) => Ok(expr),
3511            // The body is over the elements and the columns it captures, and a captured column is
3512            // held to the grouping rule like any other, which is the pin's error for
3513            // `list_transform(l, lambda x: x * k) ... GROUP BY l`.
3514            Expr::Lambda { table, params, body } => {
3515                let body = self.over_aggregate(body, scope)?;
3516                Ok(self.plan.add_expr(Expr::Lambda { table, params, body }, ty))
3517            }
3518            Expr::Cast { input, try_cast } => {
3519                let input = self.over_aggregate(input, scope)?;
3520                Ok(self.plan.add_expr(Expr::Cast { input, try_cast }, ty))
3521            }
3522            Expr::Compare { op, left, right } => {
3523                let left = self.over_aggregate(left, scope)?;
3524                let right = self.over_aggregate(right, scope)?;
3525                Ok(self.plan.add_expr(Expr::Compare { op, left, right }, ty))
3526            }
3527            Expr::Conjunction { op, children } => {
3528                let written = self.plan.expr_list(children).to_vec();
3529                let mut rewritten = Vec::with_capacity(written.len());
3530                for child in written {
3531                    rewritten.push(self.over_aggregate(child, scope)?);
3532                }
3533                let children = self.plan.add_expr_list(&rewritten);
3534                Ok(self.plan.add_expr(Expr::Conjunction { op, children }, ty))
3535            }
3536            Expr::Function { name, args } => {
3537                let written = self.plan.expr_list(args).to_vec();
3538                let mut rewritten = Vec::with_capacity(written.len());
3539                for arg in written {
3540                    rewritten.push(self.over_aggregate(arg, scope)?);
3541                }
3542                let args = self.plan.add_expr_list(&rewritten);
3543                Ok(self.plan.add_expr(Expr::Function { name, args }, ty))
3544            }
3545            Expr::Case { arms, otherwise } => {
3546                let written = self.plan.arm_list(arms).to_vec();
3547                let mut rewritten = Vec::with_capacity(written.len());
3548                for arm in written {
3549                    let when = self.over_aggregate(arm.when, scope)?;
3550                    let then = self.over_aggregate(arm.then, scope)?;
3551                    rewritten.push(rudb_plan::Arm { when, then });
3552                }
3553                let otherwise = match otherwise {
3554                    Some(expr) => Some(self.over_aggregate(expr, scope)?),
3555                    None => None,
3556                };
3557                let arms = self.plan.add_arms(&rewritten);
3558                Ok(self.plan.add_expr(Expr::Case { arms, otherwise }, ty))
3559            }
3560        }
3561    }
3562
3563    /// Whether two bound expressions are the same expression, by shape rather than by reference.
3564    pub(crate) fn same_expr(&self, left: ExprRef, right: ExprRef) -> bool {
3565        same_expr(&self.plan, left, right)
3566    }
3567}
3568
3569/// The named parameters a table function call was written with.
3570///
3571/// A struct rather than the fields loose, because the seventeen DuckDB has on `read_parquet` and the
3572/// thirty on `read_csv` are all going to want somewhere to go, and because a call with none of them
3573/// written should read as the default of this rather than as a bare false somewhere.
3574///
3575/// The CSV half goes on to the reader and is opened with, here and again in the executor. The
3576/// Parquet half is answered here and nothing downstream sees it, which is what `binary_as_string`
3577/// turning a BLOB column into a VARCHAR one is.
3578#[derive(Debug, Default)]
3579struct Options {
3580    /// `binary_as_string`, which says an unannotated byte array column in a Parquet file holds
3581    /// text. The ClickBench file has twenty eight of those and every query reads them as strings.
3582    binary_as_string: bool,
3583    /// `all_varchar`, which reads every column of a CSV file as text rather than sniffing a type.
3584    all_varchar: bool,
3585    /// `file_row_number`, which adds a column holding each row's ordinal inside its own file.
3586    ///
3587    /// The one Parquet option here that the executor has to act on rather than the binder, since
3588    /// the column is not in the file and has to be counted as the rows come out of it.
3589    file_row_number: bool,
3590    /// `delim`, `sep`, `quote`, `escape` and `header`, which are what the sniffer would decide.
3591    given: Given,
3592}
3593
3594impl Options {
3595    /// What these named parameters add up to.
3596    ///
3597    /// Each one was already checked against the function's list, so a name in here is a name that
3598    /// function takes and the value is already the type it wants. What is left is reading them, and
3599    /// the last one written wins, which is DuckDB's answer to `delim='|', delim=','` and was
3600    /// measured rather than assumed.
3601    fn of(written: &[(&'static str, Value, ExprRef)]) -> Result<Self> {
3602        let mut options = Self::default();
3603        for (parameter, value, _) in written {
3604            match (*parameter, value) {
3605                ("binary_as_string", Value::Boolean(on)) => options.binary_as_string = *on,
3606                ("all_varchar", Value::Boolean(on)) => options.all_varchar = *on,
3607                ("file_row_number", Value::Boolean(on)) => options.file_row_number = *on,
3608                _ => {}
3609            }
3610        }
3611        let named: Vec<(&str, Value)> =
3612            written.iter().map(|(parameter, value, _)| (*parameter, value.clone())).collect();
3613        options.given = csv_given(&named)?;
3614        Ok(options)
3615    }
3616}
3617
3618/// The one file a read names, canonical, with what the file system says about it now, or `None`
3619/// for a read of several files or of something that is not a regular file with a UTF-8 name.
3620fn mirror_target(paths: &[String]) -> Option<(String, FileStamp)> {
3621    let [path] = paths else { return None };
3622    let canonical = std::fs::canonicalize(path).ok()?;
3623    let stamp = FileStamp::of(&canonical)?;
3624    Some((canonical.to_str()?.to_string(), stamp))
3625}
3626
3627/// What was written between the two sides of a set operation.
3628#[derive(Clone, Copy)]
3629struct Operator {
3630    /// `UNION`, `EXCEPT` or `INTERSECT`.
3631    op: SetOp,
3632    /// `ALL`, `DISTINCT`, or neither, which means `DISTINCT` everywhere it is allowed.
3633    quantifier: Quantifier,
3634    /// Whether `BY NAME` was written, which only `UNION` takes.
3635    by_name: bool,
3636}
3637
3638/// One column of the result of a set operation, and where each side keeps it.
3639struct Merged {
3640    /// The name it comes out under, which is the left side's when both sides wrote it.
3641    name: String,
3642    /// What it is, after the two sides' types have met.
3643    ty: LogicalType,
3644    /// Which column of the left side it is, absent when only the right side wrote it.
3645    left: Option<usize>,
3646    /// Which column of the right side it is, absent when only the left side wrote it.
3647    right: Option<usize>,
3648}
3649
3650/// Matches the two sides of an ordinary set operation, which is first column to first column.
3651///
3652/// The names are the left side's, so `SELECT a FROM t UNION SELECT b FROM u` comes out as `a`.
3653fn match_by_position(left: &Scope, right: &Scope) -> Result<Vec<Merged>> {
3654    if left.len() != right.len() {
3655        return Err(Error::binder(format!(
3656            "Set operations can only apply to expressions with the same number of result columns, but left side has {} and right side has {}",
3657            left.len(),
3658            right.len()
3659        )));
3660    }
3661    let mut merged = Vec::with_capacity(left.len());
3662    for (at, (held, other)) in left.columns.iter().zip(&right.columns).enumerate() {
3663        merged.push(Merged {
3664            name: held.name.clone(),
3665            ty: meet(&held.ty, &other.ty)?,
3666            left: Some(at),
3667            right: Some(at),
3668        });
3669    }
3670    Ok(merged)
3671}
3672
3673/// Matches the two sides of a `UNION BY NAME`, which is by column name and not by position.
3674///
3675/// The result has the left side's columns in the order the left side wrote them, then the right
3676/// side's columns the left side did not write, in the order the right side wrote them. A column
3677/// only one side wrote is that side's type and the other side fills it with a null, which is why
3678/// nothing here needs the two sides to be the same width. Names match without regard to case, and
3679/// the spelling that comes out is the left side's, both of which follow the rest of the engine.
3680fn match_by_name(left: &Scope, right: &Scope) -> Result<Vec<Merged>> {
3681    named_once(left)?;
3682    named_once(right)?;
3683    let mut merged = Vec::with_capacity(left.len() + right.len());
3684    for (at, held) in left.columns.iter().enumerate() {
3685        let other = right.columns.iter().position(|column| same_name(&column.name, &held.name));
3686        let ty = match other {
3687            Some(other) => meet(&held.ty, &right.columns[other].ty)?,
3688            None => held.ty.clone(),
3689        };
3690        merged.push(Merged { name: held.name.clone(), ty, left: Some(at), right: other });
3691    }
3692    for (at, held) in right.columns.iter().enumerate() {
3693        if left.columns.iter().any(|column| same_name(&column.name, &held.name)) {
3694            continue;
3695        }
3696        merged.push(Merged {
3697            name: held.name.clone(),
3698            ty: held.ty.clone(),
3699            left: None,
3700            right: Some(at),
3701        });
3702    }
3703    Ok(merged)
3704}
3705
3706/// Refuses a side of a `UNION BY NAME` that wrote one name twice.
3707///
3708/// Matching by name needs the name to say which column, and a side that wrote `a` twice has no
3709/// answer to give. An ordinary union does not care, because there the position says which column.
3710/// The doubled quotes around the name are the reference binary's and not a mistake here.
3711fn named_once(scope: &Scope) -> Result<()> {
3712    for (at, held) in scope.columns.iter().enumerate() {
3713        if scope.columns[..at].iter().any(|column| same_name(&column.name, &held.name)) {
3714            return Err(Error::binder(format!(
3715                "UNION (ALL) BY NAME operation doesn't support duplicate names in the SELECT list - the name \"\"{}\"\" occurs multiple times",
3716                held.name
3717            )));
3718        }
3719    }
3720    Ok(())
3721}
3722
3723/// The one type a column of a set operation comes out as, given what each side wrote.
3724fn meet(left: &LogicalType, right: &LogicalType) -> Result<LogicalType> {
3725    left.promote(right).ok_or_else(|| {
3726        Error::binder(format!(
3727            "Cannot combine a column of type {left} with a column of type {right} in a set operation"
3728        ))
3729    })
3730}
3731
3732/// DuckDB's complaint about a named parameter that was given a null, which is a different sentence
3733/// for almost every parameter.
3734///
3735/// Three of them were measured on `v2.0.0-dev84237` and no two agree: `binary_as_string` is the
3736/// first, `all_varchar` is the second and `header` is the third. They read like three people each
3737/// writing the message in front of them, which is what they are, and a harness that compares error
3738/// text compares all of it. Anything not measured gets the first one, which is the most general of
3739/// the three.
3740fn null_parameter(function: TableFunction, parameter: &str) -> String {
3741    match parameter {
3742        "header" => format!("\"{parameter}\" expects a non-null boolean value (e.g. TRUE or 1)"),
3743        "all_varchar" => format!("{} \"{parameter}\" cannot be NULL", function.name()),
3744        _ => format!("Cannot use NULL as argument to \"{parameter}\""),
3745    }
3746}
3747
3748/// The complaint about a `REPLACE` entry that named a column the star did not stand for.
3749///
3750/// It reads like the complaint about any other name that is not there, down to the list of names
3751/// that are, because from the writer's side it is the same mistake.
3752fn missing_replacement(name: &str, input: &Scope) -> Error {
3753    Error::binder(format!(
3754        "Column \"{name}\" in REPLACE list not found in FROM clause{}",
3755        input.candidates()
3756    ))
3757}
3758
3759/// Whether a type is one `fill` can interpolate over, which is the pin's phrase for it.
3760///
3761/// The pin refuses `fill` with `FILL argument must support subtraction` and its sort key with
3762/// `FILL ordering must support subtraction`, and the two lists are not the same list, which is why
3763/// this takes a flag rather than answering one question. Every number is on both, so are `DATE`,
3764/// `TIME` and the two timestamps, and `TIME WITH TIME ZONE` is a sort key there but not an
3765/// argument. `INTERVAL` is on neither, which is worth saying out loud because an interval does
3766/// subtract: the sentence names subtraction and the rule is narrower than the sentence.
3767fn subtractable(ty: &LogicalType, ordering: bool) -> bool {
3768    if ty.is_numeric() {
3769        return true;
3770    }
3771    match ty {
3772        LogicalType::Date
3773        | LogicalType::Time
3774        | LogicalType::Timestamp
3775        | LogicalType::TimestampS
3776        | LogicalType::TimestampMs
3777        | LogicalType::TimestampNs
3778        | LogicalType::TimestampTz => true,
3779        LogicalType::TimeTz => ordering,
3780        _ => false,
3781    }
3782}
3783
3784/// Refuses a `fill` call the way the pin refuses one, in the pin's order.
3785///
3786/// The order was measured and it is not the order the clauses are written in. A `fill` over a
3787/// `VARCHAR` with no `ORDER BY` at all complains about the argument, so the argument is looked at
3788/// before the sort key is counted, and a `fill` with `DISTINCT` and no `ORDER BY` complains about
3789/// the `ORDER BY`, so the count comes before the clauses. `IGNORE NULLS` is refused here rather
3790/// than being answered as a no-op, since there is nothing for it to skip: `fill` is the one window
3791/// whose whole job is the nulls.
3792fn refuse_fill(
3793    argument: &LogicalType,
3794    order: &[LogicalType],
3795    distinct: bool,
3796    ignore_nulls: bool,
3797) -> Result<()> {
3798    if !subtractable(argument, false) {
3799        return Err(Error::binder("FILL argument must support subtraction"));
3800    }
3801    let [key] = order else {
3802        return Err(Error::binder("FILL functions must have only one ORDER BY expression"));
3803    };
3804    if !subtractable(key, true) {
3805        return Err(Error::binder("FILL ordering must support subtraction"));
3806    }
3807    if distinct {
3808        return Err(Error::binder(
3809            "DISTINCT is not implemented for the window function \"\"fill\"\"",
3810        ));
3811    }
3812    if ignore_nulls {
3813        return Err(Error::binder(
3814            "RESPECT/IGNORE NULLS is not supported for the window function \"fill\"",
3815        ));
3816    }
3817    Ok(())
3818}
3819
3820/// Resolves the call written inside an `OVER`.
3821///
3822/// Every aggregate is also a window, which is why this goes through the same signature table the
3823/// aggregate path uses, and the ranking windows go through it too because they are rows in the same
3824/// table. Everything else is one of three refusals, and all three are the reference binary's: a name
3825/// it knows as a scalar and a name it does not know at all each get their own sentence there.
3826fn window_signature(name: &str, types: &[LogicalType]) -> Result<Resolved> {
3827    match kind_of(name) {
3828        Some(FunctionKind::Aggregate | FunctionKind::Window) => resolve(name, types),
3829        Some(FunctionKind::Scalar) => {
3830            Err(Error::catalog(format!("{name} is not an aggregate function")))
3831        }
3832        None => Err(Error::catalog(format!("Aggregate Function with name {name} does not exist!"))),
3833    }
3834}
3835
3836/// Structural equality over two expressions of one plan.
3837fn same_expr(plan: &Plan, left: ExprRef, right: ExprRef) -> bool {
3838    if left == right {
3839        return true;
3840    }
3841    if plan.expr_type(left) != plan.expr_type(right) {
3842        return false;
3843    }
3844    let lists = |left, right| {
3845        let left: &[ExprRef] = plan.expr_list(left);
3846        let right: &[ExprRef] = plan.expr_list(right);
3847        left.len() == right.len()
3848            && left.iter().zip(right).all(|(&left, &right)| same_expr(plan, left, right))
3849    };
3850    match (plan.expr(left), plan.expr(right)) {
3851        (Expr::Column(left), Expr::Column(right)) => left == right,
3852        (Expr::Constant(left), Expr::Constant(right)) => plan.value(*left) == plan.value(*right),
3853        (
3854            Expr::Cast { input: left, try_cast: left_try },
3855            Expr::Cast { input: right, try_cast: right_try },
3856        ) => left_try == right_try && same_expr(plan, *left, *right),
3857        (
3858            Expr::Compare { op: left_op, left: left_a, right: left_b },
3859            Expr::Compare { op: right_op, left: right_a, right: right_b },
3860        ) => {
3861            left_op == right_op
3862                && same_expr(plan, *left_a, *right_a)
3863                && same_expr(plan, *left_b, *right_b)
3864        }
3865        (
3866            Expr::Conjunction { op: left_op, children: left_children },
3867            Expr::Conjunction { op: right_op, children: right_children },
3868        ) => left_op == right_op && lists(*left_children, *right_children),
3869        (
3870            Expr::Function { name: left_name, args: left_args },
3871            Expr::Function { name: right_name, args: right_args },
3872        ) => plan.string(*left_name) == plan.string(*right_name) && lists(*left_args, *right_args),
3873        (
3874            Expr::Aggregate {
3875                name: left_name,
3876                args: left_args,
3877                distinct: left_distinct,
3878                filter: left_filter,
3879            },
3880            Expr::Aggregate {
3881                name: right_name,
3882                args: right_args,
3883                distinct: right_distinct,
3884                filter: right_filter,
3885            },
3886        ) => {
3887            plan.string(*left_name) == plan.string(*right_name)
3888                && left_distinct == right_distinct
3889                && match (left_filter, right_filter) {
3890                    (None, None) => true,
3891                    (Some(left), Some(right)) => same_expr(plan, *left, *right),
3892                    _ => false,
3893                }
3894                && lists(*left_args, *right_args)
3895        }
3896        // The partition, the order and the frame are not compared here and do not need to be. Two
3897        // window calls are only ever asked about when they are already in the same run, which is
3898        // what agreeing on all three means.
3899        (
3900            Expr::Window {
3901                name: left_name,
3902                args: left_args,
3903                distinct: left_distinct,
3904                filter: left_filter,
3905                ignore_nulls: left_nulls,
3906                order: left_order,
3907            },
3908            Expr::Window {
3909                name: right_name,
3910                args: right_args,
3911                distinct: right_distinct,
3912                filter: right_filter,
3913                ignore_nulls: right_nulls,
3914                order: right_order,
3915            },
3916        ) => {
3917            // The keys inside the brackets are compared, unlike the ones in the `OVER`, because two
3918            // calls in the same run can still read their frame in different orders.
3919            let left_keys = plan.sort_key_list(*left_order);
3920            let right_keys = plan.sort_key_list(*right_order);
3921            plan.string(*left_name) == plan.string(*right_name)
3922                && left_distinct == right_distinct
3923                && left_nulls == right_nulls
3924                && left_keys.len() == right_keys.len()
3925                && left_keys.iter().zip(right_keys).all(|(left, right)| {
3926                    left.descending == right.descending
3927                        && left.nulls_first == right.nulls_first
3928                        && same_expr(plan, left.expr, right.expr)
3929                })
3930                && match (left_filter, right_filter) {
3931                    (None, None) => true,
3932                    (Some(left), Some(right)) => same_expr(plan, *left, *right),
3933                    _ => false,
3934                }
3935                && lists(*left_args, *right_args)
3936        }
3937        (
3938            Expr::Case { arms: left_arms, otherwise: left_otherwise },
3939            Expr::Case { arms: right_arms, otherwise: right_otherwise },
3940        ) => {
3941            let left_arms = plan.arm_list(*left_arms);
3942            let right_arms = plan.arm_list(*right_arms);
3943            left_arms.len() == right_arms.len()
3944                && left_arms.iter().zip(right_arms).all(|(left, right)| {
3945                    same_expr(plan, left.when, right.when) && same_expr(plan, left.then, right.then)
3946                })
3947                && match (left_otherwise, right_otherwise) {
3948                    (None, None) => true,
3949                    (Some(left), Some(right)) => same_expr(plan, *left, *right),
3950                    _ => false,
3951                }
3952        }
3953        _ => false,
3954    }
3955}