icydb-core 0.144.7

IcyDB — A schema-first typed query engine and persistence runtime for Internet Computer canisters
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
use crate::{
    db::{
        MissingRowPolicy, QueryError,
        query::intent::StructuralQuery,
        sql::{
            lowering::{
                LoweredDeleteShape, LoweredSelectShape, LoweredSqlCommand, LoweredSqlCommandInner,
                LoweredSqlQuery, PreparedSqlStatement, SqlLoweringError,
                aggregate::lower_global_aggregate_select_shape,
                bind_lowered_sql_select_query_structural,
                normalize::{
                    ensure_entity_matches_expected, normalize_delete_statement_to_expected_entity,
                    normalize_select_statement_to_expected_entity,
                    normalize_update_statement_to_expected_entity,
                },
                select::{lower_delete_shape, lower_delete_statement_shape, lower_select_shape},
            },
            parser::{
                SqlAggregateCall, SqlDeleteStatement, SqlExplainMode, SqlExplainStatement,
                SqlExplainTarget, SqlExpr, SqlInsertSource, SqlInsertStatement, SqlOrderTerm,
                SqlProjection, SqlSelectItem, SqlSelectStatement, SqlStatement, SqlUpdateStatement,
            },
        },
    },
    model::entity::EntityModel,
};

/// Prepare one parsed SQL statement for one expected entity route.
#[inline(never)]
pub(crate) fn prepare_sql_statement(
    statement: &SqlStatement,
    expected_entity: &'static str,
) -> Result<PreparedSqlStatement, SqlLoweringError> {
    let statement = prepare_statement(statement, expected_entity)?;
    validate_prepared_statement_parameters(&statement)?;

    Ok(PreparedSqlStatement { statement })
}

// Reject placeholders at the prepared-input boundary until a real binding
// contract exists. This keeps future parameter support focused on replacing
// this owner instead of hunting for lower-level expression failures.
fn validate_prepared_statement_parameters(
    statement: &SqlStatement,
) -> Result<(), SqlLoweringError> {
    let Some(index) = first_statement_parameter_index(statement) else {
        return Ok(());
    };

    Err(SqlLoweringError::unsupported_parameter_placement(
        Some(index),
        "SQL parameter binding is not supported in this release",
    ))
}

// Find the first placeholder index in one normalized statement so prepare can
// report unsupported parameters before lowering builds execution artifacts.
fn first_statement_parameter_index(statement: &SqlStatement) -> Option<usize> {
    match statement {
        SqlStatement::Select(statement) => first_select_parameter_index(statement),
        SqlStatement::Delete(statement) => first_delete_parameter_index(statement),
        SqlStatement::Insert(statement) => first_insert_parameter_index(statement),
        SqlStatement::Update(statement) => first_update_parameter_index(statement),
        SqlStatement::Explain(statement) => first_explain_parameter_index(statement),
        SqlStatement::Describe(_)
        | SqlStatement::ShowIndexes(_)
        | SqlStatement::ShowColumns(_)
        | SqlStatement::ShowEntities(_) => None,
    }
}

// Scan one SELECT statement in clause order so unsupported parameter errors
// point at the first placeholder a user wrote in the executable surface.
fn first_select_parameter_index(statement: &SqlSelectStatement) -> Option<usize> {
    first_projection_parameter_index(&statement.projection)
        .or_else(|| {
            statement
                .predicate
                .as_ref()
                .and_then(first_expr_parameter_index)
        })
        .or_else(|| statement.having.iter().find_map(first_expr_parameter_index))
        .or_else(|| first_order_terms_parameter_index(statement.order_by.as_slice()))
}

// Scan one DELETE statement for unsupported placeholders in executable
// predicate and ordering clauses.
fn first_delete_parameter_index(statement: &SqlDeleteStatement) -> Option<usize> {
    statement
        .predicate
        .as_ref()
        .and_then(first_expr_parameter_index)
        .or_else(|| first_order_terms_parameter_index(statement.order_by.as_slice()))
}

// INSERT only admits placeholders through its prepared SELECT source today;
// literal VALUES are already parsed as concrete runtime values.
fn first_insert_parameter_index(statement: &SqlInsertStatement) -> Option<usize> {
    match &statement.source {
        SqlInsertSource::Values(_) => None,
        SqlInsertSource::Select(select) => first_select_parameter_index(select),
    }
}

// Scan one UPDATE statement for unsupported placeholders in its predicate and
// ordering clauses. SET values are concrete parsed `Value` payloads today.
fn first_update_parameter_index(statement: &SqlUpdateStatement) -> Option<usize> {
    statement
        .predicate
        .as_ref()
        .and_then(first_expr_parameter_index)
        .or_else(|| first_order_terms_parameter_index(statement.order_by.as_slice()))
}

// EXPLAIN wraps an executable reduced-SQL statement and therefore inherits the
// same parameter admission contract as its target.
fn first_explain_parameter_index(statement: &SqlExplainStatement) -> Option<usize> {
    match &statement.statement {
        SqlExplainTarget::Select(select) => first_select_parameter_index(select),
        SqlExplainTarget::Delete(delete) => first_delete_parameter_index(delete),
    }
}

// Scan projection items for placeholders in expression and aggregate inputs.
fn first_projection_parameter_index(projection: &SqlProjection) -> Option<usize> {
    let SqlProjection::Items(items) = projection else {
        return None;
    };

    items.iter().find_map(first_select_item_parameter_index)
}

// Scan one SELECT item, preserving the parser-owned distinction between field,
// aggregate, and general expression projection items.
fn first_select_item_parameter_index(item: &SqlSelectItem) -> Option<usize> {
    match item {
        SqlSelectItem::Field(_) => None,
        SqlSelectItem::Aggregate(aggregate) => first_aggregate_parameter_index(aggregate),
        SqlSelectItem::Expr(expr) => first_expr_parameter_index(expr),
    }
}

// Scan one aggregate call for placeholders in its input or FILTER expression.
fn first_aggregate_parameter_index(aggregate: &SqlAggregateCall) -> Option<usize> {
    aggregate
        .input
        .as_deref()
        .and_then(first_expr_parameter_index)
        .or_else(|| {
            aggregate
                .filter_expr
                .as_deref()
                .and_then(first_expr_parameter_index)
        })
}

// Scan ORDER BY expression terms for unsupported placeholders.
fn first_order_terms_parameter_index(order_by: &[SqlOrderTerm]) -> Option<usize> {
    order_by
        .iter()
        .find_map(|term| first_expr_parameter_index(&term.field))
}

// Use the parser-owned expression traversal so parameter detection stays on the
// same tree shape as aggregate and CASE validation.
fn first_expr_parameter_index(expr: &SqlExpr) -> Option<usize> {
    let mut parameter = None;
    expr.for_each_tree_expr(&mut |expr| {
        if parameter.is_none()
            && let SqlExpr::Param { index } = expr
        {
            parameter = Some(*index);
        }
    });

    parameter
}

/// Lower one prepared SQL statement into one shared generic-free command shape.
#[inline(never)]
pub(crate) fn lower_sql_command_from_prepared_statement(
    prepared: PreparedSqlStatement,
    model: &'static EntityModel,
) -> Result<LoweredSqlCommand, SqlLoweringError> {
    lower_prepared_statement(prepared.statement, model)
}

/// Lower one prepared SQL statement and return its SELECT query artifact.
#[inline(never)]
pub(crate) fn lower_prepared_sql_select_statement(
    prepared: PreparedSqlStatement,
    model: &'static EntityModel,
) -> Result<LoweredSelectShape, SqlLoweringError> {
    let lowered = lower_sql_command_from_prepared_statement(prepared, model)?;
    let Some(select) = lowered.into_select_query() else {
        return Err(QueryError::prepared_sql_select_lane_mismatch().into());
    };

    Ok(select)
}

/// Lower one prepared SQL DELETE statement into its execution-ready artifact.
#[inline(never)]
pub(crate) fn lower_prepared_sql_delete_statement(
    prepared: PreparedSqlStatement,
) -> Result<LoweredDeleteShape, SqlLoweringError> {
    let SqlStatement::Delete(statement) = prepared.into_statement() else {
        return Err(QueryError::prepared_sql_delete_lane_mismatch().into());
    };

    lower_delete_statement_shape(statement)
}

/// Bind one prepared SQL SELECT statement directly onto structural query input.
#[inline(never)]
pub(in crate::db) fn bind_prepared_sql_select_statement_structural(
    prepared: PreparedSqlStatement,
    model: &'static EntityModel,
    consistency: MissingRowPolicy,
) -> Result<StructuralQuery, SqlLoweringError> {
    let select = lower_prepared_sql_select_statement(prepared, model)?;

    bind_lowered_sql_select_query_structural(model, select, consistency)
}

/// Extract one normalized prepared SQL INSERT statement.
pub(crate) fn extract_prepared_sql_insert_statement(
    prepared: PreparedSqlStatement,
) -> Result<SqlInsertStatement, SqlLoweringError> {
    let SqlStatement::Insert(statement) = prepared.into_statement() else {
        return Err(QueryError::prepared_sql_insert_lane_mismatch().into());
    };

    Ok(statement)
}

/// Extract one normalized prepared SQL INSERT SELECT source statement.
pub(crate) fn extract_prepared_sql_insert_select_source(
    prepared: PreparedSqlStatement,
) -> Result<SqlSelectStatement, SqlLoweringError> {
    let statement = extract_prepared_sql_insert_statement(prepared)?;
    let SqlInsertSource::Select(select) = statement.source else {
        return Err(QueryError::prepared_sql_insert_select_source_mismatch().into());
    };

    Ok(*select)
}

/// Extract one normalized prepared SQL UPDATE statement.
pub(crate) fn extract_prepared_sql_update_statement(
    prepared: PreparedSqlStatement,
) -> Result<SqlUpdateStatement, SqlLoweringError> {
    let SqlStatement::Update(statement) = prepared.into_statement() else {
        return Err(QueryError::prepared_sql_update_lane_mismatch().into());
    };

    Ok(statement)
}

#[inline(never)]
fn prepare_statement(
    statement: &SqlStatement,
    expected_entity: &'static str,
) -> Result<SqlStatement, SqlLoweringError> {
    // The compile boundary borrows the parsed statement, but preparation
    // returns an owned normalized statement. Clone only the selected statement
    // variant here so callers avoid a top-level clone before routing is known.
    match statement {
        SqlStatement::Select(statement) => Ok(SqlStatement::Select(prepare_select_statement(
            statement.clone(),
            expected_entity,
        )?)),
        SqlStatement::Delete(statement) => Ok(SqlStatement::Delete(prepare_delete_statement(
            statement.clone(),
            expected_entity,
        )?)),
        SqlStatement::Insert(statement) => Ok(SqlStatement::Insert(prepare_insert_statement(
            statement.clone(),
            expected_entity,
        )?)),
        SqlStatement::Update(statement) => Ok(SqlStatement::Update(prepare_update_statement(
            statement.clone(),
            expected_entity,
        )?)),
        SqlStatement::Explain(statement) => Ok(SqlStatement::Explain(prepare_explain_statement(
            statement.clone(),
            expected_entity,
        )?)),
        SqlStatement::Describe(statement) => {
            ensure_entity_matches_expected(statement.entity.as_str(), expected_entity)?;

            Ok(SqlStatement::Describe(statement.clone()))
        }
        SqlStatement::ShowIndexes(statement) => {
            ensure_entity_matches_expected(statement.entity.as_str(), expected_entity)?;

            Ok(SqlStatement::ShowIndexes(statement.clone()))
        }
        SqlStatement::ShowColumns(statement) => {
            ensure_entity_matches_expected(statement.entity.as_str(), expected_entity)?;

            Ok(SqlStatement::ShowColumns(statement.clone()))
        }
        SqlStatement::ShowEntities(statement) => Ok(SqlStatement::ShowEntities(statement.clone())),
    }
}

fn prepare_explain_statement(
    statement: SqlExplainStatement,
    expected_entity: &'static str,
) -> Result<SqlExplainStatement, SqlLoweringError> {
    let target = match statement.statement {
        SqlExplainTarget::Select(select_statement) => {
            SqlExplainTarget::Select(prepare_select_statement(select_statement, expected_entity)?)
        }
        SqlExplainTarget::Delete(delete_statement) => {
            SqlExplainTarget::Delete(prepare_delete_statement(delete_statement, expected_entity)?)
        }
    };

    Ok(SqlExplainStatement {
        mode: statement.mode,
        verbose: statement.verbose,
        statement: target,
    })
}

fn prepare_select_statement(
    statement: SqlSelectStatement,
    expected_entity: &'static str,
) -> Result<SqlSelectStatement, SqlLoweringError> {
    ensure_entity_matches_expected(statement.entity.as_str(), expected_entity)?;

    normalize_select_statement_to_expected_entity(statement, expected_entity)
}

fn prepare_delete_statement(
    statement: SqlDeleteStatement,
    expected_entity: &'static str,
) -> Result<SqlDeleteStatement, SqlLoweringError> {
    ensure_entity_matches_expected(statement.entity.as_str(), expected_entity)?;

    Ok(normalize_delete_statement_to_expected_entity(
        statement,
        expected_entity,
    ))
}

fn prepare_update_statement(
    statement: SqlUpdateStatement,
    expected_entity: &'static str,
) -> Result<SqlUpdateStatement, SqlLoweringError> {
    ensure_entity_matches_expected(statement.entity.as_str(), expected_entity)?;

    Ok(normalize_update_statement_to_expected_entity(
        statement,
        expected_entity,
    ))
}

fn prepare_insert_statement(
    mut statement: SqlInsertStatement,
    expected_entity: &'static str,
) -> Result<SqlInsertStatement, SqlLoweringError> {
    ensure_entity_matches_expected(statement.entity.as_str(), expected_entity)?;

    if let SqlInsertSource::Select(select) = statement.source {
        statement.source = SqlInsertSource::Select(Box::new(prepare_insert_select_source(
            *select,
            expected_entity,
        )?));
    }

    Ok(statement)
}

// Normalize one SQL INSERT SELECT source and keep it on the scalar query lane.
fn prepare_insert_select_source(
    statement: SqlSelectStatement,
    expected_entity: &'static str,
) -> Result<SqlSelectStatement, SqlLoweringError> {
    let statement = prepare_select_statement(statement, expected_entity)?;

    if !statement.group_by.is_empty() || !statement.having.is_empty() {
        return Err(QueryError::unsupported_query(
            "SQL INSERT SELECT requires scalar SELECT source in this release",
        )
        .into());
    }

    if let SqlProjection::Items(items) = &statement.projection {
        for item in items {
            if item.contains_aggregate() {
                return Err(QueryError::unsupported_query(
                    "SQL INSERT SELECT does not support aggregate source projection in this release",
                )
                .into());
            }
        }
    }

    Ok(statement)
}

#[inline(never)]
fn lower_prepared_statement(
    statement: SqlStatement,
    model: &'static EntityModel,
) -> Result<LoweredSqlCommand, SqlLoweringError> {
    match statement {
        SqlStatement::Select(statement) => Ok(LoweredSqlCommand(LoweredSqlCommandInner::Query(
            LoweredSqlQuery::Select(lower_select_shape(statement, model)?),
        ))),
        SqlStatement::Delete(statement) => Ok(LoweredSqlCommand(LoweredSqlCommandInner::Query(
            LoweredSqlQuery::Delete(lower_delete_shape(statement)?),
        ))),
        SqlStatement::Insert(_) | SqlStatement::Update(_) => {
            Err(SqlLoweringError::unexpected_query_lane_statement())
        }
        SqlStatement::Explain(statement) => lower_explain_prepared(statement, model),
        SqlStatement::Describe(_) => Ok(LoweredSqlCommand(LoweredSqlCommandInner::DescribeEntity)),
        SqlStatement::ShowIndexes(_) => {
            Ok(LoweredSqlCommand(LoweredSqlCommandInner::ShowIndexesEntity))
        }
        SqlStatement::ShowColumns(_) => {
            Ok(LoweredSqlCommand(LoweredSqlCommandInner::ShowColumnsEntity))
        }
        SqlStatement::ShowEntities(_) => {
            Ok(LoweredSqlCommand(LoweredSqlCommandInner::ShowEntities))
        }
    }
}

fn lower_explain_prepared(
    statement: SqlExplainStatement,
    model: &'static EntityModel,
) -> Result<LoweredSqlCommand, SqlLoweringError> {
    let mode = statement.mode;
    let verbose = statement.verbose;

    match statement.statement {
        SqlExplainTarget::Select(select_statement) => {
            lower_explain_select_prepared(select_statement, mode, verbose, model)
        }
        SqlExplainTarget::Delete(delete_statement) => {
            Ok(LoweredSqlCommand(LoweredSqlCommandInner::Explain {
                mode,
                verbose,
                query: LoweredSqlQuery::Delete(lower_delete_shape(delete_statement)?),
            }))
        }
    }
}

fn lower_explain_select_prepared(
    statement: SqlSelectStatement,
    mode: SqlExplainMode,
    verbose: bool,
    model: &'static EntityModel,
) -> Result<LoweredSqlCommand, SqlLoweringError> {
    if SqlStatement::Select(statement.clone()).is_global_aggregate_lane_shape() {
        let command = lower_global_aggregate_select_shape(statement)?;

        return Ok(LoweredSqlCommand(
            LoweredSqlCommandInner::ExplainGlobalAggregate {
                mode,
                verbose,
                command,
            },
        ));
    }

    match lower_select_shape(statement.clone(), model) {
        Ok(query) => Ok(LoweredSqlCommand(LoweredSqlCommandInner::Explain {
            mode,
            verbose,
            query: LoweredSqlQuery::Select(query),
        })),
        Err(SqlLoweringError::UnsupportedSelectProjection) => {
            let command = lower_global_aggregate_select_shape(statement)?;

            Ok(LoweredSqlCommand(
                LoweredSqlCommandInner::ExplainGlobalAggregate {
                    mode,
                    verbose,
                    command,
                },
            ))
        }
        Err(err) => Err(err),
    }
}