icydb-core 0.76.2

IcyDB — A type-safe, embedded ORM and schema system for the Internet Computer
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

//! Module: query::plan::validate
//! Responsibility: planner-owned query semantic validation and plan-policy enforcement.
//! Does not own: executor defensive runtime checks or execution-route dispatch semantics.
//! Boundary: emits plan-domain typed errors before executor handoff.
//!
//! Query-plan validation for planner-owned logical semantics.
//!
//! Validation ownership contract:
//! - `validate_query_semantics` owns user-facing query semantics and emits `PlanError`.
//! - executor-boundary defensive checks live in `db::executor::plan_validate`.
//!
//! Future rule changes must declare a semantic owner. Defensive re-check layers may mirror
//! rules, but must not reinterpret semantics or error class intent.

mod core;
mod cursor_policy;
mod errors;
mod fluent_policy;
mod grouped;
mod intent_policy;
mod order;
mod plan_shape;
mod symbols;
#[cfg(test)]
mod tests;

pub(crate) use core::{validate_group_query_semantics, validate_query_semantics};
pub(crate) use cursor_policy::validate_cursor_order_plan_shape;
#[cfg(test)]
pub(crate) use cursor_policy::validate_cursor_paging_requirements;
pub use errors::PlanError;
pub(crate) use errors::{
    CursorOrderPlanShapeError, FluentLoadPolicyViolation, IntentKeyAccessKind,
    IntentKeyAccessPolicyViolation,
};
pub(crate) use errors::{
    CursorPagingPolicyError, ExprPlanError, GroupPlanError, OrderPlanError, PolicyPlanError,
};
#[cfg(test)]
pub(crate) use errors::{PlanPolicyError, PlanUserError};
pub(crate) use fluent_policy::{validate_fluent_non_paged_mode, validate_fluent_paged_mode};
#[cfg(test)]
pub(in crate::db::query) use grouped::validate_group_projection_expr_compatibility;
pub(crate) use intent_policy::{validate_intent_key_access_policy, validate_intent_plan_shape};
pub(crate) use order::validate_order;
pub(crate) use plan_shape::{has_explicit_order, validate_order_shape, validate_plan_shape};
pub(in crate::db::query::plan::validate) use symbols::resolve_group_aggregate_target_field_type;
pub(crate) use symbols::{resolve_aggregate_target_field_slot, resolve_group_field_slot};

#[cfg(test)]
pub(crate) fn validate_group_cursor_constraints_for_tests(
    logical: &crate::db::query::plan::ScalarPlan,
    group: &crate::db::query::plan::GroupSpec,
) -> Result<(), PlanError> {
    grouped::validate_group_cursor_constraints(logical, group)
}

#[cfg(test)]
pub(crate) fn validate_group_policy_for_tests(
    schema: &crate::db::schema::SchemaInfo,
    logical: &crate::db::query::plan::ScalarPlan,
    group: &crate::db::query::plan::GroupSpec,
    having: Option<&crate::db::query::plan::GroupHavingSpec>,
) -> Result<(), PlanError> {
    grouped::validate_group_policy(schema, logical, group, having)
}

#[cfg(test)]
pub(crate) fn validate_group_structure_for_tests(
    schema: &crate::db::schema::SchemaInfo,
    model: &crate::model::entity::EntityModel,
    group: &crate::db::query::plan::GroupSpec,
    projection: &crate::db::query::plan::expr::ProjectionSpec,
    having: Option<&crate::db::query::plan::GroupHavingSpec>,
) -> Result<(), PlanError> {
    grouped::validate_group_structure(schema, model, group, projection, having)
}

#[cfg(test)]
pub(crate) fn validate_projection_expr_types_for_tests(
    schema: &crate::db::schema::SchemaInfo,
    projection: &crate::db::query::plan::expr::ProjectionSpec,
) -> Result<(), PlanError> {
    grouped::validate_projection_expr_types(schema, projection)
}