turso/core/translate/planner.rs

use super::plan::{
    Aggregate, BTreeTableReference, Direction, Plan, ResultSetColumn, SourceOperator,
};
use crate::{function::Func, schema::Schema, util::normalize_ident, Result};
use sqlite3_parser::ast::{self, FromClause, JoinType, ResultColumn};

pub struct OperatorIdCounter {
    id: usize,
}

impl OperatorIdCounter {
    pub fn new() -> Self {
        Self { id: 1 }
    }
    pub fn get_next_id(&mut self) -> usize {
        let id = self.id;
        self.id += 1;
        id
    }
}

fn resolve_aggregates(expr: &ast::Expr, aggs: &mut Vec<Aggregate>) {
    match expr {
        ast::Expr::FunctionCall { name, args, .. } => {
            let args_count = if let Some(args) = &args {
                args.len()
            } else {
                0
            };
            match Func::resolve_function(normalize_ident(name.0.as_str()).as_str(), args_count) {
                Ok(Func::Agg(f)) => aggs.push(Aggregate {
                    func: f,
                    args: args.clone().unwrap_or_default(),
                    original_expr: expr.clone(),
                }),
                _ => {
                    if let Some(args) = args {
                        for arg in args.iter() {
                            resolve_aggregates(arg, aggs);
                        }
                    }
                }
            }
        }
        ast::Expr::FunctionCallStar { name, .. } => {
            if let Ok(Func::Agg(f)) =
                Func::resolve_function(normalize_ident(name.0.as_str()).as_str(), 0)
            {
                aggs.push(Aggregate {
                    func: f,
                    args: vec![],
                    original_expr: expr.clone(),
                })
            }
        }
        ast::Expr::Binary(lhs, _, rhs) => {
            resolve_aggregates(lhs, aggs);
            resolve_aggregates(rhs, aggs);
        }
        _ => {}
    }
}

/// Recursively resolve column references in an expression.
/// Id, Qualified and DoublyQualified are converted to Column.
fn bind_column_references(
    expr: &mut ast::Expr,
    referenced_tables: &[BTreeTableReference],
) -> Result<()> {
    match expr {
        ast::Expr::Id(id) => {
            let mut match_result = None;
            for (tbl_idx, table) in referenced_tables.iter().enumerate() {
                let col_idx = table
                    .table
                    .columns
                    .iter()
                    .position(|c| c.name.eq_ignore_ascii_case(&id.0));
                if col_idx.is_some() {
                    if match_result.is_some() {
                        crate::bail_parse_error!("Column {} is ambiguous", id.0);
                    }
                    let col = table.table.columns.get(col_idx.unwrap()).unwrap();
                    match_result = Some((tbl_idx, col_idx.unwrap(), col.primary_key));
                }
            }
            if match_result.is_none() {
                crate::bail_parse_error!("Column {} not found", id.0);
            }
            let (tbl_idx, col_idx, is_primary_key) = match_result.unwrap();
            *expr = ast::Expr::Column {
                database: None, // TODO: support different databases
                table: tbl_idx,
                column: col_idx,
                is_rowid_alias: is_primary_key,
            };
            Ok(())
        }
        ast::Expr::Qualified(tbl, id) => {
            let matching_tbl_idx = referenced_tables
                .iter()
                .position(|t| t.table_identifier.eq_ignore_ascii_case(&tbl.0));
            if matching_tbl_idx.is_none() {
                crate::bail_parse_error!("Table {} not found", tbl.0);
            }
            let tbl_idx = matching_tbl_idx.unwrap();
            let col_idx = referenced_tables[tbl_idx]
                .table
                .columns
                .iter()
                .position(|c| c.name.eq_ignore_ascii_case(&id.0));
            if col_idx.is_none() {
                crate::bail_parse_error!("Column {} not found", id.0);
            }
            let col = referenced_tables[tbl_idx]
                .table
                .columns
                .get(col_idx.unwrap())
                .unwrap();
            *expr = ast::Expr::Column {
                database: None, // TODO: support different databases
                table: tbl_idx,
                column: col_idx.unwrap(),
                is_rowid_alias: col.primary_key,
            };
            Ok(())
        }
        ast::Expr::Between {
            lhs,
            not: _,
            start,
            end,
        } => {
            bind_column_references(lhs, referenced_tables)?;
            bind_column_references(start, referenced_tables)?;
            bind_column_references(end, referenced_tables)?;
            Ok(())
        }
        ast::Expr::Binary(expr, _operator, expr1) => {
            bind_column_references(expr, referenced_tables)?;
            bind_column_references(expr1, referenced_tables)?;
            Ok(())
        }
        ast::Expr::Case {
            base,
            when_then_pairs,
            else_expr,
        } => {
            if let Some(base) = base {
                bind_column_references(base, referenced_tables)?;
            }
            for (when, then) in when_then_pairs {
                bind_column_references(when, referenced_tables)?;
                bind_column_references(then, referenced_tables)?;
            }
            if let Some(else_expr) = else_expr {
                bind_column_references(else_expr, referenced_tables)?;
            }
            Ok(())
        }
        ast::Expr::Cast { expr, type_name: _ } => bind_column_references(expr, referenced_tables),
        ast::Expr::Collate(expr, _string) => bind_column_references(expr, referenced_tables),
        ast::Expr::FunctionCall {
            name: _,
            distinctness: _,
            args,
            order_by: _,
            filter_over: _,
        } => {
            if let Some(args) = args {
                for arg in args {
                    bind_column_references(arg, referenced_tables)?;
                }
            }
            Ok(())
        }
        // Column references cannot exist before binding
        ast::Expr::Column { .. } => unreachable!(),
        ast::Expr::DoublyQualified(_, _, _) => todo!(),
        ast::Expr::Exists(_) => todo!(),
        ast::Expr::FunctionCallStar { .. } => Ok(()),
        ast::Expr::InList { lhs, not: _, rhs } => {
            bind_column_references(lhs, referenced_tables)?;
            if let Some(rhs) = rhs {
                for arg in rhs {
                    bind_column_references(arg, referenced_tables)?;
                }
            }
            Ok(())
        }
        ast::Expr::InSelect { .. } => todo!(),
        ast::Expr::InTable { .. } => todo!(),
        ast::Expr::IsNull(expr) => {
            bind_column_references(expr, referenced_tables)?;
            Ok(())
        }
        ast::Expr::Like { lhs, rhs, .. } => {
            bind_column_references(lhs, referenced_tables)?;
            bind_column_references(rhs, referenced_tables)?;
            Ok(())
        }
        ast::Expr::Literal(_) => Ok(()),
        ast::Expr::Name(_) => todo!(),
        ast::Expr::NotNull(expr) => {
            bind_column_references(expr, referenced_tables)?;
            Ok(())
        }
        ast::Expr::Parenthesized(expr) => {
            for e in expr.iter_mut() {
                bind_column_references(e, referenced_tables)?;
            }
            Ok(())
        }
        ast::Expr::Raise(_, _) => todo!(),
        ast::Expr::Subquery(_) => todo!(),
        ast::Expr::Unary(_, expr) => {
            bind_column_references(expr, referenced_tables)?;
            Ok(())
        }
        ast::Expr::Variable(_) => todo!(),
    }
}

#[allow(clippy::extra_unused_lifetimes)]
pub fn prepare_select_plan<'a>(schema: &Schema, select: ast::Select) -> Result<Plan> {
    match select.body.select {
        ast::OneSelect::Select {
            columns,
            from,
            where_clause,
            mut group_by,
            ..
        } => {
            let col_count = columns.len();
            if col_count == 0 {
                crate::bail_parse_error!("SELECT without columns is not allowed");
            }

            let mut operator_id_counter = OperatorIdCounter::new();

            // Parse the FROM clause
            let (mut source, referenced_tables) =
                parse_from(schema, from, &mut operator_id_counter)?;

            let mut plan = Plan {
                source,
                result_columns: vec![],
                where_clause: None,
                group_by: None,
                order_by: None,
                aggregates: None,
                limit: None,
                referenced_tables,
                available_indexes: schema.indexes.clone().into_values().flatten().collect(),
            };

            // Parse the WHERE clause
            if let Some(w) = where_clause {
                let mut predicates = vec![];
                break_predicate_at_and_boundaries(w, &mut predicates);
                for expr in predicates.iter_mut() {
                    bind_column_references(expr, &plan.referenced_tables)?;
                }
                plan.where_clause = Some(predicates);
            }

            let mut aggregate_expressions = Vec::new();
            for column in columns.clone() {
                match column {
                    ast::ResultColumn::Star => {
                        for table_reference in plan.referenced_tables.iter() {
                            for (idx, col) in table_reference.table.columns.iter().enumerate() {
                                plan.result_columns.push(ResultSetColumn::Scalar(
                                    ast::Expr::Column {
                                        database: None, // TODO: support different databases
                                        table: table_reference.table_index,
                                        column: idx,
                                        is_rowid_alias: col.primary_key,
                                    },
                                ));
                            }
                        }
                    }
                    ast::ResultColumn::TableStar(name) => {
                        let name_normalized = normalize_ident(name.0.as_str());
                        let referenced_table = plan
                            .referenced_tables
                            .iter()
                            .find(|t| t.table_identifier == name_normalized);

                        if referenced_table.is_none() {
                            crate::bail_parse_error!("Table {} not found", name.0);
                        }
                        let table_reference = referenced_table.unwrap();
                        for (idx, col) in table_reference.table.columns.iter().enumerate() {
                            plan.result_columns
                                .push(ResultSetColumn::Scalar(ast::Expr::Column {
                                    database: None, // TODO: support different databases
                                    table: table_reference.table_index,
                                    column: idx,
                                    is_rowid_alias: col.primary_key,
                                }));
                        }
                    }
                    ast::ResultColumn::Expr(mut expr, _) => {
                        bind_column_references(&mut expr, &plan.referenced_tables)?;
                        match &expr {
                            ast::Expr::FunctionCall {
                                name,
                                distinctness: _,
                                args,
                                filter_over: _,
                                order_by: _,
                            } => {
                                let args_count = if let Some(args) = &args {
                                    args.len()
                                } else {
                                    0
                                };
                                match Func::resolve_function(
                                    normalize_ident(name.0.as_str()).as_str(),
                                    args_count,
                                ) {
                                    Ok(Func::Agg(f)) => {
                                        let agg = Aggregate {
                                            func: f,
                                            args: args.as_ref().unwrap().clone(),
                                            original_expr: expr.clone(),
                                        };
                                        aggregate_expressions.push(agg.clone());
                                        plan.result_columns.push(ResultSetColumn::Agg(agg));
                                    }
                                    Ok(_) => {
                                        resolve_aggregates(&expr, &mut aggregate_expressions);
                                        // TODO: can be compound aggregate
                                        plan.result_columns
                                            .push(ResultSetColumn::Scalar(expr.clone()));
                                    }
                                    _ => {}
                                }
                            }
                            ast::Expr::FunctionCallStar {
                                name,
                                filter_over: _,
                            } => {
                                if let Ok(Func::Agg(f)) = Func::resolve_function(
                                    normalize_ident(name.0.as_str()).as_str(),
                                    0,
                                ) {
                                    let agg = Aggregate {
                                        func: f,
                                        args: vec![ast::Expr::Literal(ast::Literal::Numeric(
                                            "1".to_string(),
                                        ))],
                                        original_expr: expr.clone(),
                                    };
                                    aggregate_expressions.push(agg.clone());
                                    plan.result_columns.push(ResultSetColumn::Agg(agg));
                                } else {
                                    crate::bail_parse_error!(
                                        "Invalid aggregate function: {}",
                                        name.0
                                    );
                                }
                            }
                            ast::Expr::Binary(lhs, _, rhs) => {
                                resolve_aggregates(&lhs, &mut aggregate_expressions);
                                resolve_aggregates(&rhs, &mut aggregate_expressions);
                                plan.result_columns
                                    .push(ResultSetColumn::Scalar(expr.clone()));
                            }
                            e => {
                                plan.result_columns.push(ResultSetColumn::Scalar(e.clone()));
                            }
                        }
                    }
                }
            }
            if let Some(group_by) = group_by.as_mut() {
                for expr in group_by.exprs.iter_mut() {
                    bind_column_references(expr, &plan.referenced_tables)?;
                }
                if aggregate_expressions.is_empty() {
                    crate::bail_parse_error!(
                        "GROUP BY clause without aggregate functions is not allowed"
                    );
                }
            }

            plan.group_by = group_by.map(|g| g.exprs);
            plan.aggregates = if aggregate_expressions.is_empty() {
                None
            } else {
                Some(aggregate_expressions)
            };

            // Parse the ORDER BY clause
            if let Some(order_by) = select.order_by {
                let mut key = Vec::new();

                for o in order_by {
                    // if the ORDER BY expression is a number, interpret it as an 1-indexed column number
                    // otherwise, interpret it normally as an expression
                    let mut expr = if let ast::Expr::Literal(ast::Literal::Numeric(num)) = &o.expr {
                        let column_number = num.parse::<usize>()?;
                        if column_number == 0 {
                            crate::bail_parse_error!("invalid column index: {}", column_number);
                        }
                        let maybe_result_column = columns.get(column_number - 1);
                        match maybe_result_column {
                            Some(ResultColumn::Expr(e, _)) => e.clone(),
                            None => {
                                crate::bail_parse_error!("invalid column index: {}", column_number)
                            }
                            _ => todo!(),
                        }
                    } else {
                        o.expr
                    };

                    bind_column_references(&mut expr, &plan.referenced_tables)?;

                    key.push((
                        expr,
                        o.order.map_or(Direction::Ascending, |o| match o {
                            ast::SortOrder::Asc => Direction::Ascending,
                            ast::SortOrder::Desc => Direction::Descending,
                        }),
                    ));
                }
                plan.order_by = Some(key);
            }

            // Parse the LIMIT clause
            if let Some(limit) = &select.limit {
                plan.limit = match &limit.expr {
                    ast::Expr::Literal(ast::Literal::Numeric(n)) => {
                        let l = n.parse()?;
                        Some(l)
                    }
                    _ => todo!(),
                }
            }

            // Return the unoptimized query plan
            Ok(plan)
        }
        _ => todo!(),
    }
}

#[allow(clippy::type_complexity)]
fn parse_from(
    schema: &Schema,
    from: Option<FromClause>,
    operator_id_counter: &mut OperatorIdCounter,
) -> Result<(SourceOperator, Vec<BTreeTableReference>)> {
    if from.as_ref().and_then(|f| f.select.as_ref()).is_none() {
        return Ok((SourceOperator::Nothing, vec![]));
    }

    let from = from.unwrap();

    let first_table = match *from.select.unwrap() {
        ast::SelectTable::Table(qualified_name, maybe_alias, _) => {
            let Some(table) = schema.get_table(&qualified_name.name.0) else {
                crate::bail_parse_error!("Table {} not found", qualified_name.name.0);
            };
            let alias = maybe_alias
                .map(|a| match a {
                    ast::As::As(id) => id,
                    ast::As::Elided(id) => id,
                })
                .map(|a| a.0);

            BTreeTableReference {
                table: table.clone(),
                table_identifier: alias.unwrap_or(qualified_name.name.0),
                table_index: 0,
            }
        }
        _ => todo!(),
    };

    let mut operator = SourceOperator::Scan {
        table_reference: first_table.clone(),
        predicates: None,
        id: operator_id_counter.get_next_id(),
        iter_dir: None,
    };

    let mut tables = vec![first_table];

    let mut table_index = 1;
    for join in from.joins.unwrap_or_default().into_iter() {
        let (right, outer, predicates) =
            parse_join(schema, join, operator_id_counter, &mut tables, table_index)?;
        operator = SourceOperator::Join {
            left: Box::new(operator),
            right: Box::new(right),
            predicates,
            outer,
            id: operator_id_counter.get_next_id(),
        };
        table_index += 1;
    }

    Ok((operator, tables))
}

fn parse_join(
    schema: &Schema,
    join: ast::JoinedSelectTable,
    operator_id_counter: &mut OperatorIdCounter,
    tables: &mut Vec<BTreeTableReference>,
    table_index: usize,
) -> Result<(SourceOperator, bool, Option<Vec<ast::Expr>>)> {
    let ast::JoinedSelectTable {
        operator,
        table,
        constraint,
    } = join;

    let table = match table {
        ast::SelectTable::Table(qualified_name, maybe_alias, _) => {
            let Some(table) = schema.get_table(&qualified_name.name.0) else {
                crate::bail_parse_error!("Table {} not found", qualified_name.name.0);
            };
            let alias = maybe_alias
                .map(|a| match a {
                    ast::As::As(id) => id,
                    ast::As::Elided(id) => id,
                })
                .map(|a| a.0);
            BTreeTableReference {
                table: table.clone(),
                table_identifier: alias.unwrap_or(qualified_name.name.0),
                table_index,
            }
        }
        _ => todo!(),
    };

    tables.push(table.clone());

    let outer = match operator {
        ast::JoinOperator::TypedJoin(Some(join_type)) => {
            if join_type == JoinType::LEFT | JoinType::OUTER {
                true
            } else {
                join_type == JoinType::RIGHT | JoinType::OUTER
            }
        }
        _ => false,
    };

    let mut predicates = None;
    if let Some(constraint) = constraint {
        match constraint {
            ast::JoinConstraint::On(expr) => {
                let mut preds = vec![];
                break_predicate_at_and_boundaries(expr, &mut preds);
                for predicate in preds.iter_mut() {
                    bind_column_references(predicate, tables)?;
                }
                predicates = Some(preds);
            }
            ast::JoinConstraint::Using(_) => todo!("USING joins not supported yet"),
        }
    }

    Ok((
        SourceOperator::Scan {
            table_reference: table.clone(),
            predicates: None,
            id: operator_id_counter.get_next_id(),
            iter_dir: None,
        },
        outer,
        predicates,
    ))
}

fn break_predicate_at_and_boundaries(predicate: ast::Expr, out_predicates: &mut Vec<ast::Expr>) {
    match predicate {
        ast::Expr::Binary(left, ast::Operator::And, right) => {
            break_predicate_at_and_boundaries(*left, out_predicates);
            break_predicate_at_and_boundaries(*right, out_predicates);
        }
        _ => {
            out_predicates.push(predicate);
        }
    }
}