qail-core 0.27.8

AST-native query builder - type-safe expressions, zero SQL strings
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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
use crate::ast::{
    Action, Cage, CageKind, Condition, Expr, Join, LogicalOp, Operator, Qail, SortOrder, Value,
};
use std::fmt::{Result, Write};

#[cfg(test)]
mod tests;

/// Pretty-printer for QAIL AST nodes.
///
/// Renders a `Qail` command back into human-readable QAIL syntax
/// with indentation for readability.
pub struct Formatter {
    /// Current indentation depth.
    indent_level: usize,
    /// Output buffer.
    buffer: String,
}

impl Default for Formatter {
    fn default() -> Self {
        Self::new()
    }
}

impl Formatter {
    /// Create a new formatter with default settings.
    pub fn new() -> Self {
        Self {
            indent_level: 0,
            buffer: String::new(),
        }
    }

    /// Format a query into a readable QAIL string.
    pub fn format(mut self, cmd: &Qail) -> std::result::Result<String, std::fmt::Error> {
        self.visit_cmd(cmd)?;
        Ok(self.buffer)
    }

    fn indent(&mut self) -> Result {
        for _ in 0..self.indent_level {
            write!(self.buffer, "  ")?;
        }
        Ok(())
    }

    fn visit_cmd(&mut self, cmd: &Qail) -> Result {
        for cte in &cmd.ctes {
            write!(self.buffer, "with {} = ", cte.name)?;
            self.indent_level += 1;
            writeln!(self.buffer)?;
            self.indent()?;
            self.visit_cmd(&cte.base_query)?;

            if cte.recursive
                && let Some(ref recursive_query) = cte.recursive_query
            {
                writeln!(self.buffer)?;
                self.indent()?;
                writeln!(self.buffer, "union all")?;
                self.indent()?;
                self.visit_cmd(recursive_query)?;
            }

            self.indent_level -= 1;
            writeln!(self.buffer)?;
        }

        // Action and Table
        match cmd.action {
            Action::Get => write!(self.buffer, "get {}", cmd.table)?,
            Action::Set => write!(self.buffer, "set {}", cmd.table)?,
            Action::Del => write!(self.buffer, "del {}", cmd.table)?,
            Action::Add => write!(self.buffer, "add {}", cmd.table)?,
            _ => write!(self.buffer, "{} {}", cmd.action, cmd.table)?, // Fallback for others
        }
        writeln!(self.buffer)?;

        // self.indent_level += 1; // Removed: Clauses should act at same level as command

        // Cages: Group By (if any "by" equivalent exists? No, "by" is usually implicit in AST or explicit in group_by_mode?)
        // The proposal example shows "by phone_number".
        // In AST `cmd.rs`, there isn't a direct "Group By" list, usually inferred or group_by_mode.
        // Wait, where is `by phone_number` stored in AST?
        // Checking `ast/cmd.rs`: `group_by_mode: GroupByMode`.
        // Usually group by is inferred from aggregates or explicit.
        // If the AST doesn't have explicit group by columns, we might need to derive it or it's in `cages`?
        // Let's check `cages.rs` again. `CageKind` has `Filter`, `Sort`, `Limit`... no `GroupBy`.
        // Maybe it's implied by non-aggregated columns in a `Get` with aggregates?
        // For now, I will skip "by" unless I find it in AST.

        if !cmd.columns.is_empty() {
            // But proposal says "Canonical".
            // "get table" implies "get table fields *" usually?
            // If manual explicit columns:
            if !(cmd.columns.len() == 1 && matches!(cmd.columns[0], Expr::Star)) {
                self.indent()?;
                writeln!(self.buffer, "fields")?;
                self.indent_level += 1;
                for (i, col) in cmd.columns.iter().enumerate() {
                    self.indent()?;
                    self.format_column(col)?;
                    if i < cmd.columns.len() - 1 {
                        writeln!(self.buffer, ",")?;
                    } else {
                        writeln!(self.buffer)?;
                    }
                }
                self.indent_level -= 1;
            }
        }

        // Joins
        for join in &cmd.joins {
            self.indent()?;
            self.format_join(join)?;
            writeln!(self.buffer)?;
        }

        // Where (Filter Cages)
        let filters: Vec<&Cage> = cmd
            .cages
            .iter()
            .filter(|c| matches!(c.kind, CageKind::Filter))
            .collect();
        if !filters.is_empty() {
            // We need to merge them or print them?
            // Proposal says: "where rn = 1"
            self.indent()?;
            write!(self.buffer, "where ")?;
            for (i, cage) in filters.iter().enumerate() {
                if i > 0 {
                    write!(self.buffer, " and ")?;
                }
                let wrap_or_group = cage.logical_op == LogicalOp::Or && cage.conditions.len() > 1;
                if wrap_or_group {
                    write!(self.buffer, "(")?;
                }
                self.format_conditions(&cage.conditions, cage.logical_op)?;
                if wrap_or_group {
                    write!(self.buffer, ")")?;
                }
            }
            writeln!(self.buffer)?;
        }

        // Order By (Sort Cages)
        let sorts: Vec<&Cage> = cmd
            .cages
            .iter()
            .filter(|c| matches!(c.kind, CageKind::Sort(_)))
            .collect();
        if !sorts.is_empty() {
            self.indent()?;
            writeln!(self.buffer, "order by")?;
            self.indent_level += 1;
            for (i, cage) in sorts.iter().enumerate() {
                if let CageKind::Sort(order) = cage.kind {
                    for (j, cond) in cage.conditions.iter().enumerate() {
                        self.indent()?;
                        write!(self.buffer, "{}", cond.left)?;
                        self.format_sort_order(order)?;
                        if i < sorts.len() - 1 || j < cage.conditions.len() - 1 {
                            writeln!(self.buffer, ",")?;
                        } else {
                            writeln!(self.buffer)?;
                        }
                    }
                }
            }
            self.indent_level -= 1;
        }

        for cage in &cmd.cages {
            match cage.kind {
                CageKind::Limit(n) => {
                    self.indent()?;
                    writeln!(self.buffer, "limit {}", n)?;
                }
                CageKind::Offset(n) => {
                    self.indent()?;
                    writeln!(self.buffer, "offset {}", n)?;
                }
                _ => {}
            }
        }

        // self.indent_level -= 1; // Removed matching decrement
        Ok(())
    }

    fn format_column(&mut self, col: &Expr) -> Result {
        match col {
            Expr::Star => write!(self.buffer, "*")?,
            Expr::Named(name) => write!(self.buffer, "{}", name)?,
            Expr::Aliased { name, alias } => write!(self.buffer, "{} as {}", name, alias)?,
            Expr::Aggregate {
                col,
                func,
                distinct,
                filter,
                alias,
            } => {
                let func_name = match func {
                    crate::ast::AggregateFunc::Count => "count",
                    crate::ast::AggregateFunc::Sum => "sum",
                    crate::ast::AggregateFunc::Avg => "avg",
                    crate::ast::AggregateFunc::Min => "min",
                    crate::ast::AggregateFunc::Max => "max",
                    crate::ast::AggregateFunc::ArrayAgg => "array_agg",
                    crate::ast::AggregateFunc::StringAgg => "string_agg",
                    crate::ast::AggregateFunc::JsonAgg => "json_agg",
                    crate::ast::AggregateFunc::JsonbAgg => "jsonb_agg",
                    crate::ast::AggregateFunc::BoolAnd => "bool_and",
                    crate::ast::AggregateFunc::BoolOr => "bool_or",
                };
                if *distinct {
                    write!(self.buffer, "{}(distinct {})", func_name, col)?;
                } else {
                    write!(self.buffer, "{}({})", func_name, col)?;
                }
                if let Some(conditions) = filter {
                    write!(
                        self.buffer,
                        " filter (where {})",
                        conditions
                            .iter()
                            .map(|c| c.to_string())
                            .collect::<Vec<_>>()
                            .join(" and ")
                    )?;
                }
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::FunctionCall { name, args, alias } => {
                let args_str: Vec<String> = args.iter().map(|a| a.to_string()).collect();
                write!(self.buffer, "{}({})", name, args_str.join(", "))?;
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::Window {
                name,
                func,
                params,
                partition,
                ..
            } => {
                // Use Window function format: func(params) OVER (PARTITION BY ...)
                let params_str: Vec<String> = params.iter().map(|p| p.to_string()).collect();
                write!(self.buffer, "{}({})", func, params_str.join(", "))?;
                if !partition.is_empty() {
                    write!(self.buffer, " over (partition by {})", partition.join(", "))?;
                }
                write!(self.buffer, " as {}", name)?;
            }
            Expr::Case {
                when_clauses,
                else_value,
                alias,
            } => {
                write!(self.buffer, "case")?;
                for (cond, val) in when_clauses {
                    write!(self.buffer, " when {} then {}", cond.left, val)?;
                }
                if let Some(e) = else_value {
                    write!(self.buffer, " else {}", e)?;
                }
                write!(self.buffer, " end")?;
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::JsonAccess {
                column,
                path_segments,
                alias,
            } => {
                write!(self.buffer, "{}", column)?;
                for (path, as_text) in path_segments {
                    let op = if *as_text { "->>" } else { "->" };
                    if path.parse::<i64>().is_ok() {
                        write!(self.buffer, "{}{}", op, path)?;
                    } else {
                        write!(self.buffer, "{}'{}'", op, path)?;
                    }
                }
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::Cast {
                expr,
                target_type,
                alias,
            } => {
                write!(self.buffer, "{}::{}", expr, target_type)?;
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::Binary {
                left,
                op,
                right,
                alias,
            } => {
                write!(self.buffer, "({} {} {})", left, op, right)?;
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::SpecialFunction { name, args, alias } => {
                write!(self.buffer, "{}(", name)?;
                for (i, (keyword, expr)) in args.iter().enumerate() {
                    if i > 0 {
                        write!(self.buffer, " ")?;
                    }
                    if let Some(kw) = keyword {
                        write!(self.buffer, "{} ", kw)?;
                    }
                    write!(self.buffer, "{}", expr)?;
                }
                write!(self.buffer, ")")?;
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::Literal(val) => self.format_value(val)?,
            Expr::Def {
                name,
                data_type,
                constraints,
            } => {
                write!(self.buffer, "{}:{}", name, data_type)?;
                for c in constraints {
                    write!(self.buffer, "^{}", c)?;
                }
            }
            Expr::Mod { kind, col } => {
                let prefix = match kind {
                    crate::ast::ModKind::Add => "+",
                    crate::ast::ModKind::Drop => "-",
                };
                write!(self.buffer, "{}{}", prefix, col)?;
            }
            Expr::ArrayConstructor { elements, alias } => {
                write!(self.buffer, "ARRAY[")?;
                for (i, elem) in elements.iter().enumerate() {
                    if i > 0 {
                        write!(self.buffer, ", ")?;
                    }
                    self.format_column(elem)?;
                }
                write!(self.buffer, "]")?;
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::RowConstructor { elements, alias } => {
                write!(self.buffer, "ROW(")?;
                for (i, elem) in elements.iter().enumerate() {
                    if i > 0 {
                        write!(self.buffer, ", ")?;
                    }
                    self.format_column(elem)?;
                }
                write!(self.buffer, ")")?;
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::Subscript { expr, index, alias } => {
                self.format_column(expr)?;
                write!(self.buffer, "[")?;
                self.format_column(index)?;
                write!(self.buffer, "]")?;
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::Collate {
                expr,
                collation,
                alias,
            } => {
                self.format_column(expr)?;
                write!(self.buffer, " COLLATE \"{}\"", collation)?;
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::FieldAccess { expr, field, alias } => {
                write!(self.buffer, "(")?;
                self.format_column(expr)?;
                write!(self.buffer, ").{}", field)?;
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::Subquery { query, alias } => {
                write!(self.buffer, "(")?;
                self.visit_cmd(query)?;
                write!(self.buffer, ")")?;
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
            Expr::Exists {
                query,
                negated,
                alias,
            } => {
                if *negated {
                    write!(self.buffer, "not ")?;
                }
                write!(self.buffer, "exists (")?;
                self.visit_cmd(query)?;
                write!(self.buffer, ")")?;
                if let Some(a) = alias {
                    write!(self.buffer, " as {}", a)?;
                }
            }
        }
        Ok(())
    }

    fn format_join(&mut self, join: &Join) -> Result {
        match join.kind {
            crate::ast::JoinKind::Inner => write!(self.buffer, "join {}", join.table)?,
            crate::ast::JoinKind::Left => write!(self.buffer, "left join {}", join.table)?,
            crate::ast::JoinKind::Right => write!(self.buffer, "right join {}", join.table)?,
            crate::ast::JoinKind::Full => write!(self.buffer, "full join {}", join.table)?,
            crate::ast::JoinKind::Cross => write!(self.buffer, "cross join {}", join.table)?,
            crate::ast::JoinKind::Lateral => write!(self.buffer, "lateral join {}", join.table)?,
        }

        if let Some(conditions) = &join.on
            && !conditions.is_empty()
        {
            writeln!(self.buffer)?;
            self.indent_level += 1;
            self.indent()?;
            write!(self.buffer, "on ")?;
            self.format_conditions(conditions, LogicalOp::And)?;
            self.indent_level -= 1;
        }
        Ok(())
    }

    fn format_conditions(&mut self, conditions: &[Condition], logical_op: LogicalOp) -> Result {
        for (i, cond) in conditions.iter().enumerate() {
            if i > 0 {
                match logical_op {
                    LogicalOp::And => write!(self.buffer, " and ")?,
                    LogicalOp::Or => write!(self.buffer, " or ")?,
                }
            }

            write!(self.buffer, "{}", cond.left)?;

            match cond.op {
                Operator::Eq => write!(self.buffer, " = ")?,
                Operator::Ne => write!(self.buffer, " != ")?,
                Operator::Gt => write!(self.buffer, " > ")?,
                Operator::Gte => write!(self.buffer, " >= ")?,
                Operator::Lt => write!(self.buffer, " < ")?,
                Operator::Lte => write!(self.buffer, " <= ")?,
                Operator::Fuzzy => write!(self.buffer, " ~ ")?, // ILIKE
                Operator::In => write!(self.buffer, " in ")?,
                Operator::NotIn => write!(self.buffer, " not in ")?,
                Operator::IsNull => write!(self.buffer, " is null")?,
                Operator::IsNotNull => write!(self.buffer, " is not null")?,
                Operator::Contains => write!(self.buffer, " @> ")?,
                Operator::KeyExists => write!(self.buffer, " ? ")?,
                _ => write!(self.buffer, " {:?} ", cond.op)?,
            }

            // Some operators like IsNull don't need a value printed
            if !matches!(cond.op, Operator::IsNull | Operator::IsNotNull) {
                self.format_value(&cond.value)?;
            }
        }
        Ok(())
    }

    fn format_value(&mut self, val: &Value) -> Result {
        match val {
            Value::Null => write!(self.buffer, "null")?,
            Value::Bool(b) => write!(self.buffer, "{}", b)?,
            Value::Int(n) => write!(self.buffer, "{}", n)?,
            Value::Float(n) => write!(self.buffer, "{}", n)?,
            Value::Param(n) => write!(self.buffer, "${}", n)?,
            Value::Function(f) => write!(self.buffer, "{}", f)?,
            Value::Column(c) => write!(self.buffer, "{}", c)?,
            Value::String(s) => write!(self.buffer, "'{}'", s)?, // Simple quoting, might need escaping
            // Value::Date and Value::Interval are not in AST, likely Strings
            // Value::Date(d) => write!(self.buffer, "'{}'", d)?,
            // Value::Interval(i) => write!(self.buffer, "interval '{}'", i)?,
            Value::Array(arr) => {
                write!(self.buffer, "[")?;
                for (i, v) in arr.iter().enumerate() {
                    if i > 0 {
                        write!(self.buffer, ", ")?;
                    }
                    self.format_value(v)?;
                }
                write!(self.buffer, "]")?;
            }
            Value::NamedParam(name) => write!(self.buffer, ":{}", name)?,
            Value::Uuid(u) => write!(self.buffer, "'{}'", u)?,
            Value::NullUuid => write!(self.buffer, "null")?,
            Value::Interval { amount, unit } => {
                write!(self.buffer, "interval '{} {}'", amount, unit)?
            }
            Value::Timestamp(ts) => write!(self.buffer, "'{}'", ts)?,
            Value::Bytes(bytes) => {
                write!(self.buffer, "'\\x")?;
                for byte in bytes {
                    write!(self.buffer, "{:02x}", byte)?;
                }
                write!(self.buffer, "'")?;
            }
            Value::Subquery(cmd) => {
                write!(self.buffer, "(")?;
                self.visit_cmd(cmd)?;
                write!(self.buffer, ")")?;
            }
            Value::Expr(expr) => write!(self.buffer, "{}", expr)?,
            Value::Vector(v) => {
                write!(self.buffer, "[")?;
                for (i, val) in v.iter().enumerate() {
                    if i > 0 {
                        write!(self.buffer, ", ")?;
                    }
                    write!(self.buffer, "{}", val)?;
                }
                write!(self.buffer, "]")?;
            }
            Value::Json(json) => write!(self.buffer, "'{}'::jsonb", json.replace('\'', "''"))?,
        }
        Ok(())
    }

    fn format_sort_order(&mut self, order: SortOrder) -> Result {
        match order {
            SortOrder::Asc => {}
            SortOrder::Desc => write!(self.buffer, " desc")?,
            SortOrder::AscNullsFirst => write!(self.buffer, " nulls first")?,
            SortOrder::AscNullsLast => write!(self.buffer, " nulls last")?,
            SortOrder::DescNullsFirst => write!(self.buffer, " desc nulls first")?,
            SortOrder::DescNullsLast => write!(self.buffer, " desc nulls last")?,
        }
        Ok(())
    }
}