Function plan

src/sql/src/plan/statement.rs:288–480

(
    pcx: Option<&PlanContext>,
    catalog: &dyn SessionCatalog,
    stmt: Statement<Aug>,
    params: &Params,
    resolved_ids: &ResolvedIds,
)

/// statements as not necessarily depending on external state.
#[mz_ore::instrument(level = "debug")]
pub fn plan(
    pcx: Option<&PlanContext>,
    catalog: &dyn SessionCatalog,
    stmt: Statement<Aug>,
    params: &Params,
    resolved_ids: &ResolvedIds,
) -> Result<(Plan, ResolvedIds), PlanError> {
    let param_types = params
        // We need the `expected_types` here, not the `actual_types`! This is because
        // `expected_types` is how the parameter expression (e.g. `$1`) looks "from the outside":
        // `bind_parameters` will insert a cast from the actual type to the expected type.
        .expected_types
        .iter()
        .enumerate()
        .map(|(i, ty)| (i + 1, ty.clone()))
        .collect();

    let kind: StatementKind = (&stmt).into();
    let permitted_plans = Plan::generated_from(&kind);

    let scx = &mut StatementContext {
        pcx,
        catalog,
        param_types: RefCell::new(param_types),
        ambiguous_columns: RefCell::new(false),
        sql_impl_resolved_ids: Arc::new(Mutex::new(ResolvedIds::empty())),
    };

    if resolved_ids
        .items()
        // Filter out items that may not have been created yet, such as sub-sources.
        .filter_map(|id| catalog.try_get_item(id))
        .any(|item| {
            item.func().is_ok()
                && item.name().qualifiers.schema_spec
                    == SchemaSpecifier::Id(catalog.get_mz_unsafe_schema_id())
        })
    {
        scx.require_feature_flag(&vars::UNSAFE_ENABLE_UNSAFE_FUNCTIONS)?;
    }

    let plan = match stmt {
        // DDL statements.
        Statement::AlterCluster(stmt) => ddl::plan_alter_cluster(scx, stmt),
        Statement::AlterConnection(stmt) => ddl::plan_alter_connection(scx, stmt),
        Statement::AlterIndex(stmt) => ddl::plan_alter_index_options(scx, stmt),
        Statement::AlterMaterializedViewApplyReplacement(stmt) => {
            ddl::plan_alter_materialized_view_apply_replacement(scx, stmt)
        }
        Statement::AlterObjectRename(stmt) => ddl::plan_alter_object_rename(scx, stmt),
        Statement::AlterObjectSwap(stmt) => ddl::plan_alter_object_swap(scx, stmt),
        Statement::AlterRetainHistory(stmt) => ddl::plan_alter_retain_history(scx, stmt),
        Statement::AlterRole(stmt) => ddl::plan_alter_role(scx, stmt),
        Statement::AlterSecret(stmt) => ddl::plan_alter_secret(scx, stmt),
        Statement::AlterSetCluster(stmt) => ddl::plan_alter_item_set_cluster(scx, stmt),
        Statement::AlterSink(stmt) => ddl::plan_alter_sink(scx, stmt),
        Statement::AlterSource(stmt) => ddl::plan_alter_source(scx, stmt),
        Statement::AlterSystemSet(stmt) => ddl::plan_alter_system_set(scx, stmt),