tank-core 0.49.0

Core of Tank: the Rust data layer. This is intended to be used by drivers to implement a backend.
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
use crate::{
    AnyQuery, ColumnDef, Dataset, Expression, Fragment, InsertIntoQuery, IsTrue, SelectQuery,
    TableRef, UpdateQuery,
    future::Either,
    separated_by,
    writer::{Context, SqlCoreWriter, SqlExpressionWriter, SqlFragmentWriter, SqlValueWriter},
};

/// SQL dialect printer for complete statements, combining [`SqlCoreWriter`],
/// [`SqlValueWriter`], [`SqlExpressionWriter`], and [`SqlFragmentWriter`].
pub trait SqlWriter:
    SqlCoreWriter + SqlValueWriter + SqlExpressionWriter + SqlFragmentWriter
{
    /// Emit BEGIN statement.
    fn write_transaction_begin(&self, out: &mut AnyQuery) {
        const SQL: &str = "BEGIN;";
        out.buffer().reserve(SQL.len() + 1);
        if !out.is_empty() {
            out.push('\n');
        }
        out.push_str(SQL);
    }

    /// Emit COMMIT statement.
    fn write_transaction_commit(&self, out: &mut AnyQuery) {
        const SQL: &str = "COMMIT;";
        out.buffer().reserve(SQL.len() + 1);
        if !out.is_empty() {
            out.push('\n');
        }
        out.push_str(SQL);
    }

    /// Emit ROLLBACK statement.
    fn write_transaction_rollback(&self, out: &mut AnyQuery) {
        const SQL: &str = "ROLLBACK;";
        out.buffer().reserve(SQL.len() + 1);
        if !out.is_empty() {
            out.push('\n');
        }
        out.push_str(SQL);
    }

    /// Emit CREATE SCHEMA.
    fn write_create_schema(&self, out: &mut AnyQuery, table: &TableRef, if_not_exists: bool)
    where
        Self: Sized,
    {
        out.buffer().reserve(32 + table.schema.len());
        if !out.is_empty() {
            out.push('\n');
        }
        out.push_str("CREATE SCHEMA ");
        let mut context = Context::new(Fragment::SqlCreateSchema, table.qualified_columns());
        if if_not_exists {
            out.push_str("IF NOT EXISTS ");
        }
        self.write_identifier(&mut context, out, &table.schema, true);
        out.push(';');
    }

    /// Emit DROP SCHEMA.
    fn write_drop_schema(&self, out: &mut AnyQuery, table: &TableRef, if_exists: bool)
    where
        Self: Sized,
    {
        let mut context = Context::new(Fragment::SqlDropSchema, table.qualified_columns());
        out.buffer().reserve(32 + table.schema.len());
        if !out.is_empty() {
            out.push('\n');
        }
        out.push_str("DROP SCHEMA ");
        if if_exists {
            out.push_str("IF EXISTS ");
        }
        self.write_identifier(&mut context, out, &table.schema, true);
        out.push(';');
    }

    /// Emit CREATE TABLE with columns and constraints.
    fn write_create_table(&self, out: &mut AnyQuery, table: &TableRef, if_not_exists: bool)
    where
        Self: Sized,
    {
        let mut context = Context::new(Fragment::SqlCreateTable, table.qualified_columns());
        let estimated = 128 + table.columns.len() * 64 + table.primary_key.len() * 24;
        out.buffer().reserve(estimated);
        if !out.is_empty() {
            out.push('\n');
        }
        out.push_str("CREATE TABLE ");
        if if_not_exists {
            out.push_str("IF NOT EXISTS ");
        }
        self.write_table_ref(&mut context, out, table);
        out.push_str(" (\n");
        separated_by(
            out,
            table.columns.iter(),
            |out, col| {
                self.write_create_table_column_fragment(&mut context, out, col);
            },
            ",\n",
        );
        if table.primary_key.len() > 1 {
            self.write_create_table_primary_key_fragment(&mut context, out, table.primary_key());
        }
        for unique in table.unique() {
            let mut unique = unique.peekable();
            if unique.peek().is_some() {
                out.push_str(",\nUNIQUE (");
                separated_by(
                    out,
                    unique,
                    |out, col| {
                        self.write_identifier(
                            &mut context
                                .switch_fragment(Fragment::SqlCreateTableUnique)
                                .current,
                            out,
                            col.name(),
                            true,
                        );
                    },
                    ", ",
                );
                out.push(')');
            }
        }
        let foreign_keys = table.columns.iter().filter(|c| c.references.is_some());
        separated_by(
            out,
            foreign_keys,
            |out, column| {
                let Some(references) = column.references.as_ref() else {
                    log::error!(
                        "Column `{}` was filtered as a foreign key but has no references",
                        column.name()
                    );
                    return;
                };
                out.push_str(",\nFOREIGN KEY (");
                self.write_identifier(&mut context, out, &column.name(), true);
                out.push_str(") REFERENCES ");
                self.write_table_ref(&mut context, out, &references.table());
                out.push('(');
                self.write_column_ref(&mut context, out, references);
                out.push(')');
                if let Some(on_delete) = &column.on_delete {
                    out.push_str(" ON DELETE ");
                    self.write_create_table_references_action(&mut context, out, on_delete);
                }
                if let Some(on_update) = &column.on_update {
                    out.push_str(" ON UPDATE ");
                    self.write_create_table_references_action(&mut context, out, on_update);
                }
            },
            "",
        );
        out.push_str(");");
    }

    /// Write the `COMMENT ON COLUMN` statement of a single column.
    fn write_column_comment(&self, context: &mut Context, out: &mut AnyQuery, column: &ColumnDef) {
        let mut context = context.switch_fragment(Fragment::SqlCommentOnColumn);
        context.current.qualify_columns = true;
        // Exact length of `\nCOMMENT ON COLUMN "s"."t"."c" IS '...';` when nothing is escaped.
        out.buffer().reserve(
            34 + column.schema().len()
                + column.table().len()
                + column.name().len()
                + column.comment.len(),
        );
        if !out.is_empty() {
            out.push('\n');
        }
        out.push_str("COMMENT ON COLUMN ");
        self.write_column_ref(&mut context.current, out, column.into());
        out.push_str(" IS ");
        self.write_string(&mut context.current, out, column.comment);
        out.push(';');
    }

    /// Write DROP TABLE statement.
    fn write_drop_table(&self, out: &mut AnyQuery, table: &TableRef, if_exists: bool)
    where
        Self: Sized,
    {
        out.buffer()
            .reserve(32 + table.schema.len() + table.name.len());
        if !out.is_empty() {
            out.push('\n');
        }
        out.push_str("DROP TABLE ");
        let mut context = Context::new(Fragment::SqlDropTable, table.qualified_columns());
        if if_exists {
            out.push_str("IF EXISTS ");
        }
        self.write_table_ref(&mut context, out, table);
        out.push(';');
    }

    /// Write SELECT statement.
    fn write_select<'a, Data>(&self, out: &mut AnyQuery, query: impl SelectQuery<Data>)
    where
        Self: Sized,
        Data: Dataset + 'a,
    {
        let columns = query.get_select();
        let columns_count = columns.clone().into_iter().count();
        out.buffer().reserve(256 + columns_count * 32);
        if !out.is_empty() {
            out.push('\n');
        }
        out.push_str("SELECT ");
        if query.is_distinct() {
            out.push_str("DISTINCT ");
        }
        let qualified = query
            .get_from()
            .as_ref()
            .is_some_and(Dataset::qualified_columns);
        let mut context = Context::new(Fragment::SqlSelect, qualified);
        if columns_count != 0 {
            separated_by(
                out,
                columns.clone(),
                |out, col| {
                    col.write_query(self, &mut context, out);
                },
                ", ",
            );
        } else {
            out.push('*');
        }
        if let Some(from) = query.get_from() {
            out.push_str("\nFROM ");
            from.write_table_name(
                self,
                &mut context.switch_fragment(Fragment::SqlSelectFrom).current,
                out,
            );
        }
        if let Some(condition) = query.get_where()
            && !condition.accept_visitor(&mut IsTrue, self, &mut context, out)
        {
            out.push_str("\nWHERE ");
            condition.write_query(
                self,
                &mut context.switch_fragment(Fragment::SqlSelectWhere).current,
                out,
            );
        }
        let mut group_by = query.get_group_by().peekable();
        if group_by.peek().is_some() {
            out.push_str("\nGROUP BY ");
            let mut context = context.switch_fragment(Fragment::SqlSelectGroupBy);
            separated_by(
                out,
                group_by,
                |out, col| {
                    col.write_query(self, &mut context.current, out);
                },
                ", ",
            );
        }
        if let Some(having) = query.get_having() {
            out.push_str("\nHAVING ");
            having.write_query(
                self,
                &mut context.switch_fragment(Fragment::SqlSelectHaving).current,
                out,
            );
        }
        let mut order_by = query.get_order_by().peekable();
        if order_by.peek().is_some() {
            out.push_str("\nORDER BY ");
            let mut context = context.switch_fragment(Fragment::SqlSelectOrderBy);
            separated_by(
                out,
                order_by,
                |out, col| {
                    col.write_query(self, &mut context.current, out);
                },
                ", ",
            );
        }
        self.write_limit_offset(&mut context, out, query.get_limit(), query.get_offset());
        out.push(';');
    }

    /// Write INSERT statement printing rows of values or a SELECT.
    fn write_insert(&self, out: &mut AnyQuery, query: impl InsertIntoQuery)
    where
        Self: Sized,
    {
        let table = query.get_table();
        let columns = query.get_columns();
        // A SELECT without named columns fills all the table columns, rows always name theirs.
        let write_head = |out: &mut AnyQuery, context: &mut Context, all: bool| {
            if !out.is_empty() {
                out.push('\n');
            }
            out.push_str("INSERT INTO ");
            self.write_table_ref(context, out, table);
            if !all || !columns.is_empty() {
                out.push_str(" (");
                separated_by(
                    out,
                    columns,
                    |out, column| self.write_identifier(context, out, column.name(), true),
                    ", ",
                );
                out.push(')');
            }
        };
        let mut context = Context::new(Fragment::SqlInsertInto, table.qualified_columns());
        let rows = match query.get_values() {
            Either::Left(rows) => rows,
            Either::Right(select) => {
                out.buffer().reserve(32 + columns.len() * 32);
                write_head(out, &mut context, true);
                return self.write_select(out, select);
            }
        };
        let mut rows = rows.peekable();
        if rows.peek().is_none() {
            return;
        }
        out.buffer()
            .reserve(128 + columns.len() * (32 + rows.size_hint().0 * 16));
        write_head(out, &mut context, false);
        out.push_str(" VALUES");
        let mut context = context.switch_fragment(Fragment::SqlInsertIntoValues);
        separated_by(
            out,
            rows,
            |out, row| {
                out.push_str("\n(");
                separated_by(
                    out,
                    row,
                    |out, cell| cell.write_query(self.as_dyn(), &mut context.current, out),
                    ", ",
                );
                out.push(')');
            },
            ",",
        );
        if query.get_update() {
            self.write_insert_update_fragment(
                &mut context.current,
                out,
                table.primary_key(),
                columns.iter(),
            );
        }
        out.push(';');
    }

    /// Write UPDATE statement.
    fn write_update<Data>(&self, out: &mut AnyQuery, query: impl UpdateQuery<Data>)
    where
        Self: Sized,
        Data: Dataset,
    {
        let table = query.get_from();
        let assignments = query.get_set();
        let assignments_count = assignments.clone().count();
        if assignments_count == 0 {
            return;
        }
        out.buffer().reserve(128 + assignments_count * 32);
        if !out.is_empty() {
            out.push('\n');
        }
        out.push_str("UPDATE ");
        let mut context = Context::new(Fragment::SqlUpdate, table.qualified_columns());
        table.write_table_name(self, &mut context, out);
        out.push_str("\nSET ");
        {
            let mut set = context.switch_fragment(Fragment::SqlUpdateSet);
            // A SET target is a bare column name, never a qualified one.
            set.current.qualify_columns = false;
            separated_by(
                out,
                assignments,
                |out, assignment| assignment.write_query(self, &mut set.current, out),
                ",\n",
            );
        }
        if let Some(condition) = query.get_where()
            && !condition.accept_visitor(&mut IsTrue, self, &mut context, out)
        {
            out.push_str("\nWHERE ");
            condition.write_query(
                self,
                &mut context.switch_fragment(Fragment::SqlUpdateWhere).current,
                out,
            );
        }
        out.push(';');
    }

    /// Write DELETE statement.
    fn write_delete(&self, out: &mut AnyQuery, from: &dyn Dataset, condition: impl Expression)
    where
        Self: Sized,
    {
        out.buffer().reserve(128);
        if !out.is_empty() {
            out.push('\n');
        }
        out.push_str("DELETE FROM ");
        let mut context = Context::new(Fragment::SqlDeleteFrom, from.qualified_columns());
        from.write_table_name(self, &mut context, out);
        out.push_str("\nWHERE ");
        condition.write_query(
            self,
            &mut context
                .switch_fragment(Fragment::SqlDeleteFromWhere)
                .current,
            out,
        );
        out.push(';');
    }
}

/// Generic SQL writer.
pub struct GenericSqlWriter;
impl GenericSqlWriter {
    /// New generic writer.
    pub const fn new() -> Self {
        Self {}
    }
}
impl SqlCoreWriter for GenericSqlWriter {
    fn as_dyn(&self) -> &dyn SqlWriter {
        self
    }
}
impl SqlValueWriter for GenericSqlWriter {}
impl SqlExpressionWriter for GenericSqlWriter {}
impl SqlFragmentWriter for GenericSqlWriter {}
impl SqlWriter for GenericSqlWriter {}