nodedb-sql 0.6.1

// SPDX-License-Identifier: Apache-2.0

//! Engine rules for schemaless document collections.

use crate::engine_rules::*;
use crate::error::{Result, SqlError};
use crate::types::*;

pub struct SchemalessRules;

impl EngineRules for SchemalessRules {
    fn plan_insert(&self, p: InsertParams) -> Result<Vec<SqlPlan>> {
        Ok(vec![SqlPlan::Insert(InsertPlan {
            collection: p.collection,
            engine: EngineType::DocumentSchemaless,
            route: WriteRoute::Document,
            rows: p.rows,
            volatile_defaults: p.volatile_defaults,
            if_absent: p.if_absent,
            column_schema: vec![],
            primary_key: p.primary_key,
        })])
    }

    fn plan_insert_select(&self, p: InsertSelectParams) -> Result<Vec<SqlPlan>> {
        Ok(vec![SqlPlan::InsertSelect {
            target: p.collection,
            source: p.source,
            column_map: p.column_map,
            source_columns: p.source_columns,
        }])
    }

    fn plan_upsert(&self, p: UpsertParams) -> Result<Vec<SqlPlan>> {
        Ok(vec![SqlPlan::Upsert(UpsertPlan {
            collection: p.collection,
            engine: EngineType::DocumentSchemaless,
            route: WriteRoute::Document,
            rows: p.rows,
            volatile_defaults: p.volatile_defaults,
            on_conflict_updates: p.on_conflict_updates,
            column_schema: vec![],
            primary_key: p.primary_key,
        })])
    }

    fn plan_scan(&self, p: ScanParams) -> Result<SqlPlan> {
        if p.temporal.is_temporal() && !p.bitemporal {
            return Err(SqlError::Unsupported {
                detail: format!(
                    "FOR SYSTEM_TIME / FOR VALID_TIME requires a bitemporal \
                     collection; '{}' was not created WITH bitemporal = true",
                    p.collection
                ),
            });
        }
        if let Some(plan) =
            crate::engine_rules::try_document_index_lookup(&p, EngineType::DocumentSchemaless)
        {
            return Ok(plan);
        }
        Ok(SqlPlan::Scan {
            collection: p.collection,
            alias: p.alias,
            engine: EngineType::DocumentSchemaless,
            filters: p.filters,
            projection: p.projection,
            sort_keys: p.sort_keys,
            limit: p.limit,
            offset: p.offset,
            distinct: p.distinct,
            window_functions: p.window_functions,
            temporal: p.temporal,
        })
    }

    fn plan_point_get(&self, p: PointGetParams) -> Result<SqlPlan> {
        Ok(SqlPlan::PointGet {
            collection: p.collection,
            alias: p.alias,
            engine: EngineType::DocumentSchemaless,
            key_column: p.key_column,
            key_value: p.key_value,
            projection: p.projection,
        })
    }

    fn plan_update(&self, p: UpdateParams) -> Result<Vec<SqlPlan>> {
        Ok(vec![SqlPlan::Update {
            collection: p.collection,
            engine: EngineType::DocumentSchemaless,
            assignments: p.assignments,
            filters: p.filters,
            target_keys: p.target_keys,
            returning: p.returning,
        }])
    }

    fn plan_update_from(&self, p: UpdateFromParams) -> Result<Vec<SqlPlan>> {
        Ok(vec![SqlPlan::UpdateFrom {
            collection: p.collection,
            engine: EngineType::DocumentSchemaless,
            source: p.source,
            source_alias: p.source_alias,
            target_join_col: p.target_join_col,
            source_join_col: p.source_join_col,
            assignments: p.assignments,
            target_filters: p.target_filters,
            returning: p.returning,
        }])
    }

    fn plan_delete(&self, p: DeleteParams) -> Result<Vec<SqlPlan>> {
        Ok(vec![SqlPlan::Delete {
            collection: p.collection,
            engine: EngineType::DocumentSchemaless,
            filters: p.filters,
            target_keys: p.target_keys,
        }])
    }

    fn plan_merge(&self, p: MergeParams) -> Result<Vec<SqlPlan>> {
        Ok(vec![SqlPlan::Merge(MergePlan {
            target: p.collection,
            engine: EngineType::DocumentSchemaless,
            source: p.source,
            target_join_col: p.target_join_col,
            source_join_col: p.source_join_col,
            source_alias: p.source_alias,
            clauses: p.clauses,
            returning: p.returning,
        })])
    }

    fn plan_truncate(&self, p: TruncateParams) -> Result<Vec<SqlPlan>> {
        Ok(vec![SqlPlan::Truncate {
            collection: p.collection,
            engine: EngineType::DocumentSchemaless,
            restart_identity: p.restart_identity,
        }])
    }

    fn plan_aggregate(&self, p: AggregateParams) -> Result<SqlPlan> {
        let base_scan = SqlPlan::Scan {
            collection: p.collection,
            alias: p.alias,
            engine: EngineType::DocumentSchemaless,
            filters: p.filters,
            projection: Vec::new(),
            sort_keys: Vec::new(),
            limit: None,
            offset: 0,
            distinct: false,
            window_functions: Vec::new(),
            temporal: p.temporal,
        };
        Ok(SqlPlan::Aggregate {
            input: Box::new(base_scan),
            group_by: p.group_by,
            group_by_aliases: Vec::new(),
            output_order: Vec::new(),
            aggregates: p.aggregates,
            having: p.having,
            limit: p.limit,
            grouping_sets: p.grouping_sets,
            sort_keys: Vec::new(),
        })
    }

    /// Schemaless documents store fields the schema never declares, so an
    /// undeclared name is a valid read.
    fn accepts_undeclared_columns(&self) -> bool {
        true
    }
}