icydb-core 0.76.6

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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

//! Module: db::session::sql::surface::lane
//! Responsibility: classify lowered SQL commands into the canonical session
//! lane kinds used by dispatch and explain entrypoint guards.
//! Does not own: detailed route classification or command execution.
//! Boundary: provides the narrow lane taxonomy for session SQL gate checks.

use crate::db::sql::lowering::{LoweredSqlCommand, LoweredSqlLaneKind, lowered_sql_command_lane};

// Canonical reduced SQL lane kind used by session entrypoint gate checks.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(in crate::db::session::sql) enum SqlLaneKind {
    Query,
    Explain,
    Describe,
    ShowIndexes,
    ShowColumns,
    ShowEntities,
}

// Session SQL surfaces that enforce explicit wrong-lane fail-closed contracts.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub(in crate::db::session::sql) enum SqlSurface {
    QueryFrom,
    ExecuteSql,
    ExecuteSqlGrouped,
    Explain,
}

// Resolve one generic-free lowered SQL command to the session lane taxonomy.
pub(in crate::db::session::sql) const fn session_sql_lane(
    command: &LoweredSqlCommand,
) -> SqlLaneKind {
    match lowered_sql_command_lane(command) {
        LoweredSqlLaneKind::Query => SqlLaneKind::Query,
        LoweredSqlLaneKind::Explain => SqlLaneKind::Explain,
        LoweredSqlLaneKind::Describe => SqlLaneKind::Describe,
        LoweredSqlLaneKind::ShowIndexes => SqlLaneKind::ShowIndexes,
        LoweredSqlLaneKind::ShowColumns => SqlLaneKind::ShowColumns,
        LoweredSqlLaneKind::ShowEntities => SqlLaneKind::ShowEntities,
    }
}

// Render one deterministic unsupported-lane message for one SQL surface.
pub(in crate::db::session::sql) const fn unsupported_sql_lane_message(
    surface: SqlSurface,
    lane: SqlLaneKind,
) -> &'static str {
    match (surface, lane) {
        (SqlSurface::QueryFrom, SqlLaneKind::Explain) => {
            "query_from_sql rejects EXPLAIN; use execute_sql_dispatch"
        }
        (SqlSurface::QueryFrom, SqlLaneKind::Describe) => {
            "query_from_sql rejects DESCRIBE; use execute_sql_dispatch"
        }
        (SqlSurface::QueryFrom, SqlLaneKind::ShowIndexes) => {
            "query_from_sql rejects SHOW INDEXES; use execute_sql_dispatch"
        }
        (SqlSurface::QueryFrom, SqlLaneKind::ShowColumns) => {
            "query_from_sql rejects SHOW COLUMNS; use execute_sql_dispatch"
        }
        (SqlSurface::QueryFrom, SqlLaneKind::ShowEntities) => {
            "query_from_sql rejects SHOW ENTITIES; use execute_sql_dispatch"
        }
        (SqlSurface::QueryFrom, SqlLaneKind::Query) => {
            "query_from_sql accepts SELECT or DELETE only"
        }
        (SqlSurface::ExecuteSql, SqlLaneKind::Explain) => {
            "execute_sql rejects EXPLAIN; use execute_sql_dispatch"
        }
        (SqlSurface::ExecuteSql, SqlLaneKind::Describe) => {
            "execute_sql rejects DESCRIBE; use execute_sql_dispatch"
        }
        (SqlSurface::ExecuteSql, SqlLaneKind::ShowIndexes) => {
            "execute_sql rejects SHOW INDEXES; use execute_sql_dispatch"
        }
        (SqlSurface::ExecuteSql, SqlLaneKind::ShowColumns) => {
            "execute_sql rejects SHOW COLUMNS; use execute_sql_dispatch"
        }
        (SqlSurface::ExecuteSql, SqlLaneKind::ShowEntities) => {
            "execute_sql rejects SHOW ENTITIES; use execute_sql_dispatch"
        }
        (SqlSurface::ExecuteSql, SqlLaneKind::Query) => "execute_sql accepts SELECT or DELETE only",
        (SqlSurface::ExecuteSqlGrouped, SqlLaneKind::Explain) => {
            "execute_sql_grouped rejects EXPLAIN; use execute_sql_dispatch"
        }
        (SqlSurface::ExecuteSqlGrouped, SqlLaneKind::Describe) => {
            "execute_sql_grouped rejects DESCRIBE; use execute_sql_dispatch"
        }
        (SqlSurface::ExecuteSqlGrouped, SqlLaneKind::ShowIndexes) => {
            "execute_sql_grouped rejects SHOW INDEXES; use execute_sql_dispatch"
        }
        (SqlSurface::ExecuteSqlGrouped, SqlLaneKind::ShowColumns) => {
            "execute_sql_grouped rejects SHOW COLUMNS; use execute_sql_dispatch"
        }
        (SqlSurface::ExecuteSqlGrouped, SqlLaneKind::ShowEntities) => {
            "execute_sql_grouped rejects SHOW ENTITIES; use execute_sql_dispatch"
        }
        (SqlSurface::ExecuteSqlGrouped, SqlLaneKind::Query) => {
            "execute_sql_grouped requires grouped SELECT"
        }
        (SqlSurface::Explain, SqlLaneKind::Describe) => {
            "explain_sql rejects DESCRIBE; use execute_sql_dispatch"
        }
        (SqlSurface::Explain, SqlLaneKind::ShowIndexes) => {
            "explain_sql rejects SHOW INDEXES; use execute_sql_dispatch"
        }
        (SqlSurface::Explain, SqlLaneKind::ShowColumns) => {
            "explain_sql rejects SHOW COLUMNS; use execute_sql_dispatch"
        }
        (SqlSurface::Explain, SqlLaneKind::ShowEntities) => {
            "explain_sql rejects SHOW ENTITIES; use execute_sql_dispatch"
        }
        (SqlSurface::Explain, SqlLaneKind::Query | SqlLaneKind::Explain) => {
            "explain_sql requires EXPLAIN"
        }
    }
}