nodedb 0.3.0-beta.1

Local-first, real-time, edge-to-cloud hybrid database for multi-modal workloads
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
493
494
// SPDX-License-Identifier: BUSL-1.1

//! DDL handler for CONVERT COLLECTION.
//!
//! Syntax:
//! - `CONVERT COLLECTION <name> TO document`
//! - `CONVERT COLLECTION <name> TO strict (col1 TYPE, col2 TYPE, ...)`
//! - `CONVERT COLLECTION <name> TO kv`

use nodedb_types::DatabaseId;
use std::time::Duration;

use pgwire::api::results::Response;
use pgwire::error::PgWireResult;
use sonic_rs;

use crate::bridge::envelope::PhysicalPlan;
use crate::control::security::identity::AuthenticatedIdentity;
use crate::control::state::SharedState;
use nodedb_physical::physical_plan::MetaOp;

use super::super::types::sqlstate_error;

/// CONVERT COLLECTION <name> TO <target_type> [(<col_defs>)]
pub async fn convert_collection(
    state: &SharedState,
    identity: &AuthenticatedIdentity,
    sql: &str,
) -> PgWireResult<Vec<Response>> {
    let (collection, target_type, explicit_columns) = parse_convert_sql(sql)?;
    let tenant_id = identity.tenant_id;

    // Validate collection exists.
    let Some(catalog) = state.credentials.catalog() else {
        return Err(sqlstate_error("XX000", "catalog unavailable"));
    };

    let mut coll = catalog
        .get_collection(DatabaseId::DEFAULT, tenant_id.as_u64(), &collection)
        .map_err(|e| sqlstate_error("XX000", &e.to_string()))?
        .ok_or_else(|| {
            sqlstate_error(
                "42P01",
                &format!("collection '{collection}' does not exist"),
            )
        })?;

    // Build columns before dispatch — needed for both Data Plane and catalog.
    let columns: Option<Vec<nodedb_types::columnar::ColumnDef>> = match target_type.as_str() {
        "document_strict" | "kv" => {
            let cols = if let Some(cols) = explicit_columns {
                cols
            } else if !coll.type_guards.is_empty() {
                typeguards_to_column_defs(&coll.type_guards)?
            } else {
                return Err(sqlstate_error(
                    "42601",
                    "CONVERT TO strict requires column definitions or active typeguards",
                ));
            };
            Some(cols)
        }
        _ => None,
    };

    let schema_json_for_dp = if let Some(ref cols) = columns {
        sonic_rs::to_string(cols)
            .map_err(|e| sqlstate_error("XX000", &format!("schema serialization: {e}")))?
    } else {
        String::new()
    };

    // Dispatch to Data Plane: re-encode if needed (strict = Binary Tuple).
    let plan = PhysicalPlan::Meta(MetaOp::ConvertCollection {
        collection: collection.clone(),
        target_type: target_type.clone(),
        schema_json: schema_json_for_dp,
    });

    super::sync_dispatch::dispatch_async(
        state,
        tenant_id,
        &collection,
        plan,
        Duration::from_secs(60),
    )
    .await
    .map_err(|e| sqlstate_error("XX000", &format!("conversion failed: {e}")))?;

    // Update catalog collection type.
    let new_type = match target_type.as_str() {
        "document_schemaless" => nodedb_types::CollectionType::document(),
        "document_strict" | "kv" => {
            let columns = columns.expect(
                "invariant: columns is Some for document_strict/kv targets, validated above",
            );
            let schema = nodedb_types::columnar::StrictSchema {
                columns,
                version: 1,
                dropped_columns: Vec::new(),
                bitemporal: false,
            };
            if target_type == "kv" {
                nodedb_types::CollectionType::kv(schema)
            } else {
                nodedb_types::CollectionType::strict(schema)
            }
        }
        _ => {
            return Err(sqlstate_error(
                "42601",
                &format!("unsupported target type: {target_type}"),
            ));
        }
    };

    coll.collection_type = new_type;

    // CONVERT TO document_strict: if collection had typeguards, carry over CHECK constraints
    // and drop typeguard definitions (strict schema subsumes type checking).
    if target_type == "document_strict" && !coll.type_guards.is_empty() {
        for guard in &coll.type_guards {
            if let Some(ref check_expr) = guard.check_expr {
                // Avoid duplicate names.
                let name = format!("_guard_{}", guard.field);
                if !coll.check_constraints.iter().any(|c| c.name == name) {
                    coll.check_constraints.push(
                        crate::control::security::catalog::types::CheckConstraintDef {
                            name,
                            check_sql: check_expr.clone(),
                            has_subquery: false,
                        },
                    );
                }
            }
        }
        coll.type_guards.clear();
    }

    catalog
        .put_collection(DatabaseId::DEFAULT, &coll)
        .map_err(|e| sqlstate_error("XX000", &e.to_string()))?;

    tracing::info!(
        %collection,
        target_type,
        tenant = tenant_id.as_u64(),
        "collection converted"
    );

    Ok(vec![Response::Execution(pgwire::api::results::Tag::new(
        "CONVERT COLLECTION",
    ))])
}

// ── SQL Parsing ──────────────────────────────────────────────────────────

/// Parse CONVERT COLLECTION SQL.
///
/// Returns `(collection_name, target_type, explicit_columns)`.
/// `explicit_columns` is `None` for `TO document` or `TO strict` without parens.
fn parse_convert_sql(
    sql: &str,
) -> PgWireResult<(
    String,
    String,
    Option<Vec<nodedb_types::columnar::ColumnDef>>,
)> {
    let upper = sql.to_uppercase();

    // Extract collection name: CONVERT COLLECTION <name> TO ...
    let coll_pos = upper
        .find("COLLECTION ")
        .ok_or_else(|| sqlstate_error("42601", "expected COLLECTION keyword"))?;
    let after_coll = sql[coll_pos + 11..].trim_start();
    let collection = after_coll
        .split_whitespace()
        .next()
        .ok_or_else(|| sqlstate_error("42601", "missing collection name"))?
        .to_lowercase();

    // Extract target type: TO <type>
    let to_pos = upper[coll_pos + 11..]
        .find(" TO ")
        .ok_or_else(|| sqlstate_error("42601", "expected TO <type> clause"))?;
    let after_to = sql[coll_pos + 11 + to_pos + 4..].trim_start();
    let target_type = after_to
        .split_whitespace()
        .next()
        .ok_or_else(|| sqlstate_error("42601", "missing target type after TO"))?
        .to_lowercase()
        .trim_matches('(')
        .to_string();

    match target_type.as_str() {
        "document_schemaless" => Ok((collection, "document_schemaless".into(), None)),
        "document_strict" | "kv" => {
            if after_to.contains('(') {
                let cols = parse_column_defs(after_to)?;
                Ok((collection, target_type, Some(cols)))
            } else {
                Ok((collection, target_type, None))
            }
        }
        "document" | "doc" => Err(sqlstate_error(
            "42601",
            "deprecated target type 'document'; use 'document_schemaless'",
        )),
        "strict" => Err(sqlstate_error(
            "42601",
            "deprecated target type 'strict'; use 'document_strict'",
        )),
        "key_value" | "keyvalue" => {
            Err(sqlstate_error("42601", "deprecated target type; use 'kv'"))
        }
        other => Err(sqlstate_error(
            "42601",
            &format!(
                "unsupported target type: '{other}' \
                 (expected document_schemaless, document_strict, kv)"
            ),
        )),
    }
}

/// Parse `(col1 TYPE, col2 TYPE, ...)` into `Vec<ColumnDef>`.
fn parse_column_defs(s: &str) -> PgWireResult<Vec<nodedb_types::columnar::ColumnDef>> {
    use nodedb_types::columnar::ColumnDef;

    let open = s
        .find('(')
        .ok_or_else(|| sqlstate_error("42601", "expected (column definitions) after type"))?;
    let close = s
        .rfind(')')
        .ok_or_else(|| sqlstate_error("42601", "missing closing parenthesis"))?;
    if close <= open {
        return Err(sqlstate_error("42601", "empty column definitions"));
    }

    let inner = &s[open + 1..close];
    let mut columns: Vec<ColumnDef> = Vec::new();

    for part in inner.split(',') {
        let part = part.trim();
        if part.is_empty() {
            continue;
        }
        let tokens: Vec<&str> = part.split_whitespace().collect();
        if tokens.len() < 2 {
            return Err(sqlstate_error(
                "42601",
                &format!("expected 'name TYPE' in column def: {part}"),
            ));
        }
        let col_name = tokens[0].to_lowercase();
        let col_type = tokens[1].to_uppercase();
        let nullable = !tokens
            .windows(2)
            .any(|w| w[0].eq_ignore_ascii_case("NOT") && w[1].eq_ignore_ascii_case("NULL"))
            && !tokens.iter().any(|t| t.eq_ignore_ascii_case("NOTNULL"));
        let primary_key = tokens
            .windows(2)
            .any(|w| w[0].eq_ignore_ascii_case("PRIMARY") && w[1].eq_ignore_ascii_case("KEY"));

        let ct = sql_type_to_column_type(&col_type);
        let mut col = if nullable {
            ColumnDef::nullable(col_name, ct)
        } else {
            ColumnDef::required(col_name, ct)
        };
        if primary_key {
            col = col.with_primary_key();
        }
        columns.push(col);
    }

    if columns.is_empty() {
        return Err(sqlstate_error("42601", "at least one column required"));
    }

    Ok(columns)
}

/// Map SQL type names to ColumnType.
fn sql_type_to_column_type(sql_type: &str) -> nodedb_types::columnar::ColumnType {
    use nodedb_types::columnar::ColumnType;
    match sql_type {
        "INT" | "INTEGER" | "INT8" | "BIGINT" | "INT4" | "INT2" | "SMALLINT" => ColumnType::Int64,
        "FLOAT" | "FLOAT8" | "DOUBLE" | "REAL" => ColumnType::Float64,
        "NUMERIC" | "DECIMAL" => ColumnType::Decimal {
            precision: 38,
            scale: 10,
        },
        "BOOL" | "BOOLEAN" => ColumnType::Bool,
        "TIMESTAMP" | "TIMESTAMP WITHOUT TIME ZONE" => ColumnType::Timestamp,
        "TIMESTAMPTZ" | "TIMESTAMP WITH TIME ZONE" => ColumnType::Timestamptz,
        "BLOB" | "BYTEA" | "BINARY" => ColumnType::Bytes,
        "UUID" => ColumnType::Uuid,
        "JSON" | "JSONB" => ColumnType::Json,
        "GEOMETRY" => ColumnType::Geometry,
        _ => ColumnType::String, // VARCHAR, TEXT, STRING, and anything else
    }
}

/// Convert typeguard field definitions to strict schema column definitions.
///
/// Each typeguard field becomes a column. The type expression is mapped to ColumnType.
/// REQUIRED fields become NOT NULL. DEFAULT expressions carry over.
fn typeguards_to_column_defs(
    guards: &[nodedb_types::TypeGuardFieldDef],
) -> PgWireResult<Vec<nodedb_types::columnar::ColumnDef>> {
    use nodedb_types::columnar::{ColumnDef, ColumnType};

    // Always include an `id` column as primary key.
    let mut columns = vec![ColumnDef::required("id", ColumnType::String).with_primary_key()];

    for guard in guards {
        // Skip dot-path fields (nested) — strict schema is flat.
        if guard.field.contains('.') {
            continue;
        }
        // Skip if already added (e.g., "id").
        if guard.field == "id" || columns.iter().any(|c| c.name == guard.field) {
            continue;
        }

        let ct = typeguard_type_to_column_type(&guard.type_expr);
        let mut col = if guard.required {
            ColumnDef::required(guard.field.clone(), ct)
        } else {
            ColumnDef::nullable(guard.field.clone(), ct)
        };
        col.default = guard.default_expr.clone().or(guard.value_expr.clone());
        columns.push(col);
    }

    Ok(columns)
}

/// Map a typeguard type expression string to a ColumnType.
fn typeguard_type_to_column_type(type_expr: &str) -> nodedb_types::columnar::ColumnType {
    use nodedb_types::columnar::ColumnType;

    // Strip union types — take the first non-NULL type.
    let base = type_expr
        .split('|')
        .map(|s| s.trim())
        .find(|s| !s.eq_ignore_ascii_case("NULL"))
        .unwrap_or(type_expr)
        .to_uppercase();

    // Strip generic parameters: ARRAY<STRING> → ARRAY, SET<INT> → SET.
    let base = base.split('<').next().unwrap_or(&base);

    match base {
        "INT" | "INTEGER" | "BIGINT" | "INT64" => ColumnType::Int64,
        "FLOAT" | "DOUBLE" | "REAL" | "FLOAT64" => ColumnType::Float64,
        "STRING" | "TEXT" | "VARCHAR" => ColumnType::String,
        "BOOL" | "BOOLEAN" => ColumnType::Bool,
        "BYTES" | "BYTEA" | "BLOB" => ColumnType::Bytes,
        "TIMESTAMP" | "TIMESTAMP WITHOUT TIME ZONE" => ColumnType::Timestamp,
        "TIMESTAMPTZ" | "TIMESTAMP WITH TIME ZONE" => ColumnType::Timestamptz,
        "DECIMAL" | "NUMERIC" => ColumnType::Decimal {
            precision: 38,
            scale: 10,
        },
        "UUID" => ColumnType::Uuid,
        "GEOMETRY" => ColumnType::Geometry,
        "JSON" | "JSONB" | "OBJECT" => ColumnType::Json,
        _ => ColumnType::String, // fallback
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parse_convert_to_document_schemaless() {
        let (coll, target, cols) =
            parse_convert_sql("CONVERT COLLECTION users TO document_schemaless").unwrap();
        assert_eq!(coll, "users");
        assert_eq!(target, "document_schemaless");
        assert!(cols.is_none());
    }

    #[test]
    fn parse_convert_deprecated_document_rejected() {
        assert!(parse_convert_sql("CONVERT COLLECTION users TO document").is_err());
    }

    #[test]
    fn parse_convert_to_document_strict() {
        let sql =
            "CONVERT COLLECTION users TO document_strict (name VARCHAR, age INT, active BOOLEAN)";
        let (coll, target, cols) = parse_convert_sql(sql).unwrap();
        assert_eq!(coll, "users");
        assert_eq!(target, "document_strict");

        let cols = cols.unwrap();
        assert_eq!(cols.len(), 3);
        assert_eq!(cols[0].name, "name");
        assert!(matches!(
            cols[0].column_type,
            nodedb_types::columnar::ColumnType::String
        ));
        assert_eq!(cols[1].name, "age");
        assert!(matches!(
            cols[1].column_type,
            nodedb_types::columnar::ColumnType::Int64
        ));
        assert_eq!(cols[2].name, "active");
        assert!(matches!(
            cols[2].column_type,
            nodedb_types::columnar::ColumnType::Bool
        ));
    }

    #[test]
    fn parse_convert_deprecated_strict_rejected() {
        let sql = "CONVERT COLLECTION users TO strict (name VARCHAR)";
        assert!(parse_convert_sql(sql).is_err());
    }

    #[test]
    fn parse_convert_to_kv() {
        let sql = "CONVERT COLLECTION cache TO kv (key VARCHAR, value BLOB)";
        let (coll, target, cols) = parse_convert_sql(sql).unwrap();
        assert_eq!(coll, "cache");
        assert_eq!(target, "kv");
        assert!(cols.is_some());
    }

    #[test]
    fn parse_convert_not_null_constraint() {
        let sql = "CONVERT COLLECTION users TO document_strict (id INT NOT NULL, name VARCHAR)";
        let (_, _, cols) = parse_convert_sql(sql).unwrap();
        let cols = cols.unwrap();
        assert!(!cols[0].nullable);
        assert!(cols[1].nullable);
    }

    #[test]
    fn parse_convert_missing_to_errors() {
        assert!(parse_convert_sql("CONVERT COLLECTION users").is_err());
    }

    #[test]
    fn parse_convert_unknown_type_errors() {
        assert!(parse_convert_sql("CONVERT COLLECTION users TO graph").is_err());
    }

    #[test]
    fn sql_type_to_column_type_distinguishes_timestamp_from_timestamptz() {
        use nodedb_types::columnar::ColumnType;
        assert!(matches!(
            sql_type_to_column_type("TIMESTAMP"),
            ColumnType::Timestamp
        ));
        assert!(matches!(
            sql_type_to_column_type("TIMESTAMP WITHOUT TIME ZONE"),
            ColumnType::Timestamp
        ));
        assert!(matches!(
            sql_type_to_column_type("TIMESTAMPTZ"),
            ColumnType::Timestamptz
        ));
        assert!(matches!(
            sql_type_to_column_type("TIMESTAMP WITH TIME ZONE"),
            ColumnType::Timestamptz
        ));
    }

    #[test]
    fn typeguard_type_to_column_type_distinguishes_timestamp_from_timestamptz() {
        use nodedb_types::columnar::ColumnType;
        assert!(matches!(
            typeguard_type_to_column_type("TIMESTAMP"),
            ColumnType::Timestamp
        ));
        assert!(matches!(
            typeguard_type_to_column_type("TIMESTAMP WITHOUT TIME ZONE"),
            ColumnType::Timestamp
        ));
        assert!(matches!(
            typeguard_type_to_column_type("TIMESTAMPTZ"),
            ColumnType::Timestamptz
        ));
        assert!(matches!(
            typeguard_type_to_column_type("TIMESTAMP WITH TIME ZONE"),
            ColumnType::Timestamptz
        ));
    }
}