dibs-sql 0.2.0-rc.1

Typed SQL AST and renderer for dibs
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
//! SQL statements.

use crate::expr::Expr;
use crate::{ColumnName, PgType, TableName};

/// A SQL statement.
#[derive(Debug, Clone)]
pub enum Stmt {
    /// A SELECT query.
    Select(SelectStmt),
    /// An INSERT statement.
    Insert(InsertStmt),
    /// An INSERT ... SELECT statement (for bulk inserts with UNNEST).
    InsertSelect(InsertSelectStmt),
    /// An UPDATE statement.
    Update(UpdateStmt),
    /// A DELETE statement.
    Delete(DeleteStmt),
}

/// A SELECT statement.
#[derive(Debug, Clone, Default)]
pub struct SelectStmt {
    /// Whether to use DISTINCT (eliminates duplicate rows).
    pub distinct: bool,
    /// DISTINCT ON columns (PostgreSQL-specific, returns first row of each group).
    pub distinct_on: Vec<Expr>,
    /// Columns to select (empty means `SELECT *`).
    pub columns: Vec<SelectColumn>,
    /// The FROM clause specifying the primary table.
    pub from: Option<FromClause>,
    /// JOIN clauses for related tables.
    pub joins: Vec<Join>,
    /// The WHERE clause filter condition.
    pub where_: Option<Expr>,
    /// ORDER BY clauses for sorting results.
    pub order_by: Vec<OrderBy>,
    /// LIMIT clause to restrict number of rows.
    pub limit: Option<Expr>,
    /// OFFSET clause for pagination.
    pub offset: Option<Expr>,
}

/// A column in a SELECT clause.
#[derive(Debug, Clone)]
pub enum SelectColumn {
    /// An expression with optional alias: `expr AS alias`.
    Expr {
        /// The expression to select.
        expr: Expr,
        /// Optional alias for the column.
        alias: Option<ColumnName>,
    },

    /// All columns from a table: `table.*`.
    AllFrom(TableName),
}

impl SelectColumn {
    pub fn expr(expr: Expr) -> Self {
        SelectColumn::Expr { expr, alias: None }
    }

    pub fn aliased(expr: Expr, alias: ColumnName) -> Self {
        SelectColumn::Expr {
            expr,
            alias: Some(alias),
        }
    }

    pub fn all_from(table: TableName) -> Self {
        SelectColumn::AllFrom(table)
    }
}

/// A FROM clause specifying the primary table.
#[derive(Debug, Clone)]
pub struct FromClause {
    /// The table name.
    pub table: TableName,
    /// Optional alias for the table (e.g., `FROM users t0`).
    pub alias: Option<TableName>,
}

impl FromClause {
    pub fn table(name: TableName) -> Self {
        Self {
            table: name,
            alias: None,
        }
    }

    pub fn aliased(name: TableName, alias: TableName) -> Self {
        Self {
            table: name,
            alias: Some(alias),
        }
    }
}

/// An UNNEST clause for bulk operations.
///
/// Generates SQL like: `UNNEST($1::text[], $2::bigint[]) AS t(col1, col2)`
#[derive(Debug, Clone)]
pub struct Unnest {
    /// Parameters with their PostgreSQL array types.
    pub params: Vec<UnnestParam>,
    /// Alias for the UNNEST result (e.g., "t").
    pub alias: TableName,
}

/// A parameter in an UNNEST clause.
#[derive(Debug, Clone)]
pub struct UnnestParam {
    /// The parameter name.
    pub name: ColumnName,
    /// The PostgreSQL array type (e.g., "text[]", "bigint[]").
    pub pg_type: PgType,
}

impl UnnestParam {
    pub fn new(name: ColumnName, pg_type: PgType) -> Self {
        Self { name, pg_type }
    }
}

impl Unnest {
    pub fn new(alias: TableName) -> Self {
        Self {
            params: Vec::new(),
            alias,
        }
    }

    pub fn param(mut self, name: ColumnName, pg_type: PgType) -> Self {
        self.params.push(UnnestParam::new(name, pg_type));
        self
    }

    pub fn params(mut self, params: impl IntoIterator<Item = UnnestParam>) -> Self {
        self.params.extend(params);
        self
    }
}

/// A JOIN clause.
#[derive(Debug, Clone)]
pub struct Join {
    /// The type of join (INNER, LEFT, RIGHT, FULL).
    pub kind: JoinKind,
    /// The table to join.
    pub table: TableName,
    /// Optional alias for the joined table.
    pub alias: Option<TableName>,
    /// The ON condition for the join.
    pub on: Expr,
}

/// Type of JOIN.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum JoinKind {
    /// INNER JOIN - only matching rows from both tables.
    Inner,
    /// LEFT JOIN - all rows from left table, matching from right.
    Left,
    /// RIGHT JOIN - all rows from right table, matching from left.
    Right,
    /// FULL JOIN - all rows from both tables.
    Full,
}

impl JoinKind {
    pub fn as_str(self) -> &'static str {
        match self {
            JoinKind::Inner => "INNER JOIN",
            JoinKind::Left => "LEFT JOIN",
            JoinKind::Right => "RIGHT JOIN",
            JoinKind::Full => "FULL JOIN",
        }
    }
}

/// ORDER BY clause for sorting query results.
#[derive(Debug, Clone)]
pub struct OrderBy {
    /// The expression to sort by.
    pub expr: Expr,
    /// Whether to sort descending (true) or ascending (false).
    pub desc: bool,
    /// Optional NULLS FIRST / NULLS LAST specification.
    pub nulls: Option<NullsOrder>,
}

impl OrderBy {
    pub fn asc(expr: Expr) -> Self {
        Self {
            expr,
            desc: false,
            nulls: None,
        }
    }

    pub fn desc(expr: Expr) -> Self {
        Self {
            expr,
            desc: true,
            nulls: None,
        }
    }
}

/// NULLS FIRST / NULLS LAST ordering for ORDER BY.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum NullsOrder {
    /// NULL values sort before non-NULL values.
    First,
    /// NULL values sort after non-NULL values.
    Last,
}

// ============================================================================
// INSERT statement
// ============================================================================

/// An INSERT statement.
#[derive(Debug, Clone)]
pub struct InsertStmt {
    /// The table to insert into.
    pub table: TableName,
    /// Column names for the insert.
    pub columns: Vec<ColumnName>,
    /// Values to insert (parallel to columns).
    pub values: Vec<Expr>,
    /// Optional ON CONFLICT clause for upsert behavior.
    pub on_conflict: Option<OnConflict>,
    /// Columns to return after insert (RETURNING clause).
    pub returning: Vec<ColumnName>,
}

/// ON CONFLICT clause for upsert behavior.
#[derive(Debug, Clone)]
pub struct OnConflict {
    /// Conflict target columns (the unique constraint columns).
    pub columns: Vec<ColumnName>,
    /// What to do when a conflict occurs.
    pub action: ConflictAction,
}

/// Action to take when a conflict occurs.
#[derive(Debug, Clone)]
pub enum ConflictAction {
    /// DO NOTHING - skip the conflicting row.
    DoNothing,
    /// DO UPDATE SET - update the existing row.
    DoUpdate(Vec<UpdateAssignment>),
}

/// An INSERT ... SELECT statement for bulk inserts.
///
/// Used with UNNEST for efficient bulk operations:
/// ```sql
/// INSERT INTO products (handle, status, created_at)
/// SELECT handle, status, NOW()
/// FROM UNNEST($1::text[], $2::text[]) AS t(handle, status)
/// RETURNING id, handle, status
/// ```
#[derive(Debug, Clone)]
pub struct InsertSelectStmt {
    /// The table to insert into.
    pub table: TableName,
    /// Column names for the insert.
    pub columns: Vec<ColumnName>,
    /// Expressions to select (parallel to columns).
    pub select_exprs: Vec<Expr>,
    /// The UNNEST source.
    pub unnest: Unnest,
    /// Optional ON CONFLICT clause for upsert behavior.
    pub on_conflict: Option<OnConflict>,
    /// Columns to return after insert (RETURNING clause).
    pub returning: Vec<ColumnName>,
}

/// A column assignment for UPDATE SET or ON CONFLICT DO UPDATE SET.
#[derive(Debug, Clone)]
pub struct UpdateAssignment {
    /// The column to update.
    pub column: ColumnName,
    /// The value to assign.
    pub value: Expr,
}

impl UpdateAssignment {
    pub fn new(column: ColumnName, value: Expr) -> Self {
        Self { column, value }
    }
}

// ============================================================================
// UPDATE statement
// ============================================================================

/// An UPDATE statement.
#[derive(Debug, Clone)]
pub struct UpdateStmt {
    /// The table to update.
    pub table: TableName,
    /// Column assignments (SET clause).
    pub assignments: Vec<UpdateAssignment>,
    /// Optional WHERE clause filter.
    pub where_: Option<Expr>,
    /// Columns to return after update (RETURNING clause).
    pub returning: Vec<ColumnName>,
}

// ============================================================================
// DELETE statement
// ============================================================================

/// A DELETE statement.
#[derive(Debug, Clone)]
pub struct DeleteStmt {
    /// The table to delete from.
    pub table: TableName,
    /// Optional WHERE clause filter.
    pub where_: Option<Expr>,
    /// Columns to return after delete (RETURNING clause).
    pub returning: Vec<ColumnName>,
}

// ============================================================================
// Builder-style constructors
// ============================================================================

impl SelectStmt {
    pub fn new() -> Self {
        Self::default()
    }

    /// Set DISTINCT to eliminate duplicate rows.
    pub fn distinct(mut self) -> Self {
        self.distinct = true;
        self
    }

    /// Set DISTINCT ON columns (PostgreSQL-specific).
    /// Returns the first row of each group defined by these columns.
    pub fn distinct_on(mut self, cols: impl IntoIterator<Item = Expr>) -> Self {
        self.distinct_on.extend(cols);
        self
    }

    pub fn column(mut self, col: SelectColumn) -> Self {
        self.columns.push(col);
        self
    }

    pub fn columns(mut self, cols: impl IntoIterator<Item = SelectColumn>) -> Self {
        self.columns.extend(cols);
        self
    }

    pub fn from(mut self, from: FromClause) -> Self {
        self.from = Some(from);
        self
    }

    pub fn join(mut self, join: Join) -> Self {
        self.joins.push(join);
        self
    }

    pub fn where_(mut self, expr: Expr) -> Self {
        self.where_ = Some(expr);
        self
    }

    pub fn and_where(mut self, expr: Expr) -> Self {
        self.where_ = Some(match self.where_ {
            Some(existing) => existing.and(expr),
            None => expr,
        });
        self
    }

    pub fn order_by(mut self, order: OrderBy) -> Self {
        self.order_by.push(order);
        self
    }

    pub fn limit(mut self, expr: Expr) -> Self {
        self.limit = Some(expr);
        self
    }

    pub fn offset(mut self, expr: Expr) -> Self {
        self.offset = Some(expr);
        self
    }
}

impl InsertStmt {
    pub fn new(table: TableName) -> Self {
        Self {
            table,
            columns: Vec::new(),
            values: Vec::new(),
            on_conflict: None,
            returning: Vec::new(),
        }
    }

    pub fn column(mut self, name: ColumnName, value: Expr) -> Self {
        self.columns.push(name);
        self.values.push(value);
        self
    }

    pub fn on_conflict(mut self, conflict: OnConflict) -> Self {
        self.on_conflict = Some(conflict);
        self
    }

    pub fn returning(mut self, cols: impl IntoIterator<Item = ColumnName>) -> Self {
        self.returning.extend(cols);
        self
    }
}

impl UpdateStmt {
    pub fn new(table: TableName) -> Self {
        Self {
            table,
            assignments: Vec::new(),
            where_: None,
            returning: Vec::new(),
        }
    }

    pub fn set(mut self, column: ColumnName, value: Expr) -> Self {
        self.assignments.push(UpdateAssignment::new(column, value));
        self
    }

    pub fn where_(mut self, expr: Expr) -> Self {
        self.where_ = Some(expr);
        self
    }

    pub fn and_where(mut self, expr: Expr) -> Self {
        self.where_ = Some(match self.where_ {
            Some(existing) => existing.and(expr),
            None => expr,
        });
        self
    }

    pub fn returning(mut self, cols: impl IntoIterator<Item = ColumnName>) -> Self {
        self.returning.extend(cols);
        self
    }
}

impl DeleteStmt {
    pub fn new(table: TableName) -> Self {
        Self {
            table,
            where_: None,
            returning: Vec::new(),
        }
    }

    pub fn where_(mut self, expr: Expr) -> Self {
        self.where_ = Some(expr);
        self
    }

    pub fn and_where(mut self, expr: Expr) -> Self {
        self.where_ = Some(match self.where_ {
            Some(existing) => existing.and(expr),
            None => expr,
        });
        self
    }

    pub fn returning(mut self, cols: impl IntoIterator<Item = ColumnName>) -> Self {
        self.returning.extend(cols);
        self
    }
}

impl InsertSelectStmt {
    pub fn new(table: TableName, unnest: Unnest) -> Self {
        Self {
            table,
            columns: Vec::new(),
            select_exprs: Vec::new(),
            unnest,
            on_conflict: None,
            returning: Vec::new(),
        }
    }

    /// Add a column with its select expression.
    pub fn column(mut self, name: ColumnName, expr: Expr) -> Self {
        self.columns.push(name);
        self.select_exprs.push(expr);
        self
    }

    pub fn on_conflict(mut self, conflict: OnConflict) -> Self {
        self.on_conflict = Some(conflict);
        self
    }

    pub fn returning(mut self, cols: impl IntoIterator<Item = ColumnName>) -> Self {
        self.returning.extend(cols);
        self
    }
}