Skip to main content

razeri_plugin_contract/
renderer.rs

1// Copyright (C) 2026 Gabriel Shea
2// Licensed under either of the Apache License, Version 2.0 or the MIT
3// license, at your option.
4
5//! Layered rendering traits for SQL generation.
6//!
7//! The hierarchy is designed so that implementing [`SqlRenderer`] (4 methods)
8//! gives you ANSI-standard defaults for all higher-level traits.
9
10use crate::DataType;
11use crate::constraint_enforcement::ConstraintEnforcement;
12use crate::date_format::DateFormat;
13use crate::evolution::ColumnEvolution;
14use crate::flatten::{Flatten, FlattenRequest};
15use crate::procedure_log_level::ProcedureLogLevel;
16use crate::routine_form::{ProcedureForm, ScalarFunctionForm, TableFunctionForm};
17use crate::routine_spec::RoutineSpec;
18use crate::sid_spelling::{SidHelperBody, SidSpelling, UNSPELLED_SID};
19
20/// **Where the aggregated expression goes** in a form returned by
21/// [`SqlRenderer::median_aggregate_form`].
22///
23/// The form is a template rather than finished SQL so that *which function*
24/// and *how a column is written* stay in different hands — the dialect answers
25/// the first, the query renderer the second. A form must carry this token
26/// exactly once.
27pub const AGGREGATE_ARGUMENT: &str = "{argument}";
28
29/// **What kind of value an aggregate would have to collapse** — the axis
30/// [`SqlRenderer::render_single_row_aggregate`] varies on, held to three arms
31/// because three is what the measurements distinguish.
32///
33/// Not the full type lattice: `MAX` behaves identically across every numeric,
34/// textual and temporal type on every platform razeri reaches, and splitting
35/// them would invite per-type arms nothing has measured.
36#[derive(Debug, Clone, Copy, PartialEq, Eq)]
37pub enum AggregableKind {
38    /// Numeric, textual and temporal — every platform orders these and every
39    /// platform has `MAX` for them.
40    Orderable,
41    /// A truth value. `PostgreSQL` and SQL Server have no `MAX` for it and each
42    /// spells the collapse differently.
43    Boolean,
44    /// `uuid`, JSON, binary, interval, array, map — the families with no
45    /// ordering to borrow. Availability is per platform and is measured, never
46    /// assumed.
47    Opaque,
48}
49
50/// **A clock bound once for a whole load script** — what
51/// [`SqlRenderer::render_inline_clock_binding`] answers on an engine whose
52/// loads ship as flat statement lists rather than procedure bodies.
53///
54/// The `statements` run first and capture the engine's current moment under
55/// one name; `reference` is the expression every later statement of the same
56/// run reads it back by. One binding, many readers, is what makes a version's
57/// close and its successor's open the same instant by construction.
58#[derive(Debug, Clone, PartialEq, Eq)]
59pub struct InlineClockBinding {
60    /// The statement(s) that bind the moment, in run order, each terminated.
61    pub statements: Vec<String>,
62    /// The expression that reads the bound moment back.
63    pub reference: String,
64}
65
66/// Level 1 — Core SQL rendering. REQUIRED: every dialect must implement these 4 methods.
67///
68/// These methods define the absolute minimum surface for rendering SQL:
69/// data types, identifier quoting, qualified names, and timestamps.
70pub trait SqlRenderer: Send + Sync {
71    /// Render a [`DataType`] as platform-specific SQL.
72    fn render_data_type(&self, dt: &DataType) -> String;
73
74    /// **The type text for a routine's PARAMETER**, which is not always the text
75    /// a column carries.
76    ///
77    /// Most engines spell a type one way wherever it appears, and for those this
78    /// hook is [`Self::render_data_type`] under another name — which is the
79    /// default, so a dialect with nothing to say says nothing.
80    ///
81    /// **Oracle is the reason it exists.** A column there takes
82    /// `NUMBER(19, 0)` and `VARCHAR2(100)`; the same types in a parameter list
83    /// are a compile error (`PLS-00103`, reported at the opening parenthesis),
84    /// and the bare `NUMBER` and `VARCHAR2` are what a parameter clause takes.
85    /// The length and the precision belong on the local declaration instead,
86    /// which keeps them. A dialect there answers:
87    ///
88    /// ```ignore
89    /// fn render_parameter_data_type(&self, dt: &DataType) -> String {
90    ///     let column = self.render_data_type(dt);
91    ///     match column.find('(') {
92    ///         Some(at) => column[..at].trim_end().to_owned(),
93    ///         None => column,
94    ///     }
95    /// }
96    /// ```
97    ///
98    /// It is what fills
99    /// [`RoutineParameter::data_type`](crate::routine_spec::RoutineParameter::data_type),
100    /// so a dialect that answers it does not also post-process the string
101    /// Razeri handed it.
102    ///
103    /// Parameters:
104    /// - `dt`: the type the design declared.
105    fn render_parameter_data_type(&self, dt: &DataType) -> String {
106        self.render_data_type(dt)
107    }
108
109    /// **The type text for a column that ADMITS NULL** — the whole type, not a
110    /// modifier appended to one.
111    ///
112    /// Nine of razeri's ten platforms spell nullability by SILENCE: a column
113    /// declared without `NOT NULL` admits one, and its type text is the same
114    /// text a required column carries. That is the default here, and for those
115    /// nine this hook is [`SqlRenderer::render_data_type`] under another name.
116    ///
117    /// **`ClickHouse` is the exception, and it is the reason this hook exists.**
118    /// There a bare type is NOT NULL — nullability is a property OF the type,
119    /// spelled `Nullable(T)` — so a renderer that expresses *nullable* by
120    /// omitting a keyword expresses nothing at all. `render_field` used to carry
121    /// a comment saying the wrapper was *"handled in data type"*; it was handled
122    /// nowhere, and every `nullable:` a design declared was discarded on that
123    /// one engine (`Nullable(` appeared ZERO times in any rendered
124    /// `schema.sql`).
125    ///
126    /// # What the discard actually cost, measured rather than assumed
127    ///
128    /// Not a loud refusal. `insert_null_as_default` **defaults to `1`** on
129    /// `ClickHouse` (24.10.2, server default, `changed = 0`), so
130    /// `INSERT … SELECT NULL` into a bare column does not raise — it writes the
131    /// TYPE'S DEFAULT, silently: `''` for `String`, `0` for `Int64`,
132    /// `1900-01-01` for `Date32` (which is razeri's own unknown-member date, so
133    /// an unknown attribute came back indistinguishable from a deliberately
134    /// seeded one). Only with `insert_null_as_default = 0` does the engine
135    /// answer `Code: 70 … Cannot convert NULL to a non-nullable type`. **A
136    /// design's own data was being fabricated on one engine and honest on the
137    /// other nine**, and the DDL is where that is fixed.
138    ///
139    /// # A dialect overriding this owes a measurement
140    ///
141    /// Not every type can be wrapped. `ClickHouse` refuses
142    /// `Nullable(Array(…))`, `Nullable(Map(…))` and `Nullable(JSON)` outright,
143    /// so its override declines those and says so in its own rustdoc. A
144    /// wrapper that cannot be applied must be DECLINED by name, never applied
145    /// and hoped for: an unwrappable type rendered `Nullable(…)` turns a silent
146    /// wrong value into a `CREATE TABLE` that does not run.
147    fn render_nullable_data_type(&self, dt: &DataType) -> String {
148        self.render_data_type(dt)
149    }
150
151    /// Quote an identifier using platform conventions.
152    ///
153    /// `PostgreSQL`: `"name"`, `MySQL`: `` `name` ``, SQL Server: `[name]`
154    fn quote_identifier(&self, name: &str) -> String;
155
156    /// Render a fully qualified name (optional schema + name).
157    fn qualify_name(&self, schema: Option<&str>, name: &str) -> String;
158
159    /// Whether this dialect uses schemas in qualified names.
160    ///
161    /// `ClickHouse` uses only `database.object` (no schema level).
162    /// Default: `true` (most platforms use `catalog.schema.object`).
163    fn uses_schema_in_qualified_names(&self) -> bool {
164        true
165    }
166
167    /// Whether this dialect is the "agnostic" pseudo-dialect.
168    ///
169    /// Agnostic rendering produces unquoted, platform-neutral DDL.
170    /// Real dialect implementations should not override this.
171    fn is_agnostic_dialect(&self) -> bool {
172        false
173    }
174
175    /// Whether this dialect supports `SECURE VIEW` (Snowflake).
176    fn supports_secure_view(&self) -> bool {
177        false
178    }
179
180    /// Whether this dialect supports `GLOBAL TEMPORARY VIEW` (Databricks).
181    fn supports_global_temporary_view(&self) -> bool {
182        false
183    }
184
185    /// Render the platform's `CURRENT_TIMESTAMP` expression.
186    fn render_current_timestamp(&self) -> String;
187
188    /// Return a stable string identifier for this dialect.
189    ///
190    /// Used for dispatch when trait-based rendering is not yet available for
191    /// a domain concept, and as a human-readable label in diagnostics and
192    /// error messages.  This method works for **all dialects** registered
193    /// in the `PlatformRegistry` (e.g. `"postgresql"`, `"sqlite"`,
194    /// `"cockroachdb"`).
195    ///
196    /// Convention: lowercase, hyphen-separated (e.g. `"postgresql"`,
197    /// `"sql-server"`, `"snowflake"`, `"sqlite"`).
198    ///
199    /// The default returns `"ansi"`.
200    fn dialect_name(&self) -> &'static str {
201        "ansi"
202    }
203
204    /// **How this engine spells a surrogate key.**
205    ///
206    /// Razeri derives every key one way — normalize each part, join them, hash
207    /// the result, guard NULLs with a sentinel — and composes that derivation
208    /// in exactly one place. What a dialect decides is the *vocabulary*: what
209    /// this engine calls `LOWER` and `TRIM`, how it joins strings, how it casts
210    /// a value to text, and how it spells a 64-bit hash.
211    ///
212    /// The default is [`UNSPELLED_SID`] — ANSI's vocabulary under a name that
213    /// says it is a guess. **A dialect that leaves it there is telling Razeri it
214    /// has not decided**, and the emitted SQL will call an `xxhash64` its engine
215    /// very likely does not have. Override it.
216    ///
217    /// If your engine has no portable 64-bit hash, say so rather than reaching
218    /// for the nearest-looking function: a hash that is deterministic within one
219    /// warehouse and equal to nothing outside it is the lock-in a portable key
220    /// exists to end. Name an artifact your dialect's prerequisites install, or
221    /// refuse the key and orient the reader.
222    fn sid_spelling(&self) -> SidSpelling {
223        UNSPELLED_SID
224    }
225
226    /// **The body of the surrogate-key helper, where SQL cannot spell it.**
227    ///
228    /// Razeri emits one function per warehouse — `generate_sid` — and normally
229    /// builds its body itself, from the vocabulary
230    /// [`sid_spelling`](Self::sid_spelling) states. The default here is `None`,
231    /// which says exactly that: *compose the derivation in my own SQL*.
232    ///
233    /// Answer with [`SidHelperBody`] only when there is no SQL that could hold
234    /// the derivation — the engine has no 64-bit hash under any name, so the
235    /// vocabulary has nothing to spell the hash with and the definition has to
236    /// be written in another language. `BigQuery` is the case Razeri ships:
237    /// `GoogleSQL` has no XXH64, and the function that looks like the answer
238    /// (`FARM_FINGERPRINT`) is a different number, so the body is JavaScript.
239    ///
240    /// **Do not use this to change the key.** The body computes the same number
241    /// every other engine computes — XXH64, seed 0, over the UTF-8 bytes of the
242    /// one already-normalized argument — and [`SidHelperBody`] says what it owes
243    /// in full. Reaching for a native hash that is merely deterministic keys a
244    /// warehouse to numbers nothing outside it can reproduce.
245    ///
246    /// A dialect that answers here should also state a
247    /// [`SidSpelling::hash`](crate::SidSpelling::hash) that no engine has, so
248    /// that any path which fell back to composing SQL fails loudly at deploy
249    /// time rather than hashing nothing and handing back the value.
250    fn sid_helper_body(&self) -> Option<SidHelperBody> {
251        None
252    }
253
254    /// **How this engine reads a delimited text file as a relation**, or `None`
255    /// where it cannot.
256    ///
257    /// A design can bind an entity to a source file, and Razeri then generates
258    /// the staging fill: an `INSERT … SELECT … FROM <this>`. That only works on
259    /// an engine that can open a file from inside a query. `DuckDB` can
260    /// (`read_csv_auto`); most cannot — `PostgreSQL` wants `COPY`, Snowflake a
261    /// stage, `SQLite` has nothing at all. Each of those is a bulk-load design
262    /// decision rather than a rendering detail, so the default is `None` and
263    /// the generated bundle says which platform declined and why instead of
264    /// emitting SQL the engine would refuse.
265    ///
266    /// `path_literal` arrives as a finished single-quoted SQL string literal,
267    /// already escaped — put it where the relation takes a path and do not
268    /// quote it again.
269    ///
270    /// **What the returned relation owes**, because the fill is written against
271    /// it and nothing checks these at render time:
272    ///
273    /// - the file's first row is its header, and the column names come from it,
274    ///   spelled exactly as the file spells them;
275    /// - every column reads as **text**, unparsed. The fill casts nothing: a
276    ///   date's layout and a currency's prefix are the source's business, and a
277    ///   reader that guessed a type would fail the load on its first row;
278    /// - it is a relation usable in a `FROM` clause, not a statement.
279    ///
280    /// The path is embedded in the generated file as it was spelled when the
281    /// bundle was built, so it must be one the engine resolves at run time.
282    fn delimited_file_relation(&self, path_literal: &str) -> Option<String> {
283        let _ = path_literal;
284        None
285    }
286
287    /// **How this engine reads a delimited text file whose bytes are not
288    /// UTF-8**, or `None` where it states no way to.
289    ///
290    /// UTF-8 is the canonical form and every engine reads it, so
291    /// [`delimited_file_relation`](Self::delimited_file_relation) answers for
292    /// it and this is asked only about the other days. A design can name the
293    /// encoding to fall back to when a file's bytes are not UTF-8, and razeri
294    /// resolves that name once, to the one name the encoding standard files it
295    /// under — `windows-1252`, `shift_jis`, `koi8-r`. That name arrives here,
296    /// and an engine that has its own word for the same encoding translates it
297    /// the way an engine translates every other name razeri hands it.
298    ///
299    /// Everything the returned relation owes, it owes for the same reasons
300    /// [`delimited_file_relation`](Self::delimited_file_relation) says: header
301    /// from the first row, every column as text, usable in a `FROM` clause.
302    ///
303    /// **`None` is a complete answer, and the common one.** An engine that
304    /// reads no file at all says nothing here; so does an engine that reads
305    /// files but has no word for this particular encoding. Razeri then declines
306    /// that source by name and says what to do instead — convert the file to
307    /// UTF-8, or write the load by hand — rather than pointing the engine at
308    /// bytes it will read as some other language.
309    ///
310    /// **Answer only for encodings you have run.** An engine that accepts the
311    /// name and reads the bytes as something else is worse than one that
312    /// refuses the name: the first is a warehouse of plausible nonsense and the
313    /// second is a sentence on a terminal.
314    ///
315    /// `path_literal` arrives as a finished single-quoted SQL string literal,
316    /// already escaped — put it where the relation takes a path and do not
317    /// quote it again. `encoding` does not: it is a bare name, and an engine
318    /// that puts it in a string literal writes the quotes itself.
319    fn delimited_file_relation_in_encoding(
320        &self,
321        path_literal: &str,
322        encoding: &str,
323    ) -> Option<String> {
324        let _ = (path_literal, encoding);
325        None
326    }
327
328    /// **The `CAST` target spelling for a [`DataType`] on this engine.**
329    ///
330    /// A column declaration and a `CAST` target are two grammars on most
331    /// engines, so this is a separate answer from
332    /// [`render_data_type`](Self::render_data_type) and not a synonym for it.
333    /// `MySQL` takes `SIGNED` where it declares `BIGINT`; T-SQL takes
334    /// `NVARCHAR(MAX)` where ANSI says `TEXT`.
335    ///
336    /// Where the two *are* the same on your engine — which is the common case
337    /// on engines with one type vocabulary — say so by delegating:
338    ///
339    /// ```ignore
340    /// fn render_cast_type(&self, dt: &DataType) -> String {
341    ///     self.render_data_type(dt)
342    /// }
343    /// ```
344    ///
345    /// The default is ANSI's cast vocabulary. Razeri's generated load opens
346    /// with a CTE that casts every source column to its declared type, so a
347    /// wrong name here fails the load on its first statement.
348    fn render_cast_type(&self, dt: &DataType) -> String {
349        crate::agnostic::render_cast_type_ansi(dt)
350    }
351
352    /// **Which stored-procedure grammar this engine speaks.**
353    ///
354    /// Razeri composes the procedure — its parameters, its steps, its comment —
355    /// and spells it in the form this returns. The default is
356    /// [`ProcedureForm::Agnostic`], which parses on no engine: it is the honest
357    /// answer for a dialect that has not said, and it is what an unlisted
358    /// platform has always been handed.
359    ///
360    /// It lives on `SqlRenderer` rather than on
361    /// [`ProcedureRenderer`] because the composer
362    /// holds the renderer as a [`DdlRenderer`], and a decision reachable only
363    /// through a trait the caller does not hold is a decision the caller makes
364    /// instead.
365    fn procedure_form(&self) -> ProcedureForm {
366        ProcedureForm::Agnostic
367    }
368
369    /// **Which scalar-function grammar this engine speaks.**
370    ///
371    /// The default is [`ScalarFunctionForm::PostgreSql`] — what an unlisted
372    /// dialect has always been handed, and a dangerous inheritance on a near
373    /// neighbour: `LANGUAGE SQL IMMUTABLE PARALLEL SAFE` is a *"syntax error at
374    /// or near `PARALLEL`"* on an engine that descends from `PostgreSQL` and
375    /// reports itself as one.
376    fn scalar_function_form(&self) -> ScalarFunctionForm {
377        ScalarFunctionForm::PostgreSql
378    }
379
380    /// **Which table-valued-function grammar this engine speaks, and — where it
381    /// has none — the words it refuses in.**
382    ///
383    /// The default is [`TableFunctionForm::PostgreSql`], what an unlisted
384    /// dialect has always been handed. If your engine has no routine a query
385    /// selects `FROM`, answer [`TableFunctionForm::Unsupported`] with your own
386    /// sentence: Razeri then declines to build the routine at all and prints
387    /// **your** words rather than another engine's. A refusal written once per
388    /// artifact kind tells every author about whichever engine happened to need
389    /// it first, and the near form an author will otherwise find on their own
390    /// is exactly what costs them a day.
391    fn table_function_form(&self) -> TableFunctionForm {
392        TableFunctionForm::PostgreSql
393    }
394
395    // ═══════════════════════════════════════════════════════════════
396    // Routines this dialect spells itself
397    // ═══════════════════════════════════════════════════════════════
398
399    /// **Spell a whole stored procedure in this engine's own grammar** — the
400    /// method [`ProcedureForm::Custom`] promises.
401    ///
402    /// Razeri composes the routine and hands it over as a [`RoutineSpec`]: the
403    /// name, the parameters with their types already in your spelling, the
404    /// declarations, the body's statements, the comment. What comes back is the
405    /// complete `CREATE`, punctuation and all, and Razeri emits it unchanged.
406    ///
407    /// The default is `None`, which means *"I did not write one"*. It is only
408    /// ever reached by a dialect that answered
409    /// [`ProcedureForm::Custom`] and then did not override this — the
410    /// conformance kit reports that as blocking, and the emitted SQL carries a
411    /// comment saying the same thing where the procedure would have been.
412    ///
413    /// It lives on `SqlRenderer` rather than on [`ProcedureRenderer`] for the
414    /// reason [`Self::procedure_form`] does: the composer holds the renderer as
415    /// a [`DdlRenderer`], and an answer reachable only through a trait the
416    /// caller does not hold is an answer the caller makes up instead.
417    ///
418    /// Parameters:
419    /// - `routine`: the procedure Razeri composed.
420    fn render_procedure(&self, routine: &RoutineSpec) -> Option<String> {
421        let _ = routine;
422        None
423    }
424
425    /// **Spell a whole scalar function in this engine's own grammar** — the
426    /// method [`ScalarFunctionForm::Custom`] promises.
427    ///
428    /// The same contract as [`Self::render_procedure`]: a composed
429    /// [`RoutineSpec`] in, the complete `CREATE` out, and `None` only where a
430    /// dialect claimed a custom grammar and did not write the method.
431    ///
432    /// Parameters:
433    /// - `routine`: the function Razeri composed.
434    fn render_scalar_function(&self, routine: &RoutineSpec) -> Option<String> {
435        let _ = routine;
436        None
437    }
438
439    /// **Spell a whole table-valued function in this engine's own grammar** —
440    /// the method [`TableFunctionForm::Custom`] promises.
441    ///
442    /// The same contract as [`Self::render_procedure`]: a composed
443    /// [`RoutineSpec`] in, the complete `CREATE` out, and `None` only where a
444    /// dialect claimed a custom grammar and did not write the method.
445    ///
446    /// Parameters:
447    /// - `routine`: the function Razeri composed.
448    fn render_table_function(&self, routine: &RoutineSpec) -> Option<String> {
449        let _ = routine;
450        None
451    }
452
453    // ═══════════════════════════════════════════════════════════════
454    // Expression rendering extensions
455    // ═══════════════════════════════════════════════════════════════
456
457    /// Platform's `CURRENT_DATE` expression.
458    ///
459    /// `SqlServer`: `CAST(GETDATE() AS DATE)`, `ClickHouse`: `today()`, others: `CURRENT_DATE`
460    fn render_current_date(&self) -> String {
461        "CURRENT_DATE".to_string()
462    }
463
464    /// Render a boolean literal.
465    ///
466    /// SqlServer/ClickHouse: `1`/`0`, others: `TRUE`/`FALSE`
467    fn render_boolean_literal(&self, value: bool) -> String {
468        if value { "TRUE".to_string() } else { "FALSE".to_string() }
469    }
470
471    /// **Collapse a subquery that selects AT MOST ONE ROW into an aggregate**,
472    /// for the engines that will not accept an unaggregated correlated scalar.
473    ///
474    /// Razeri's SCD-2 and SCD-1 re-opens assign `col = (SELECT … WHERE
475    /// {correlation})`. Databricks refuses that shape by name
476    /// (`MUST_AGGREGATE_CORRELATED_SCALAR_SUBQUERY`) and Snowflake stopped
477    /// unnesting it the day the guard beside it became uncorrelated, so the
478    /// emission wraps the projection in an aggregate. **Which** aggregate is a
479    /// dialect fact and **whether one exists at all** is a dialect × type fact,
480    /// which is why this hook takes the kind and may answer `None`:
481    ///
482    /// - `MAX` is the obvious choice and is wrong for a BOOLEAN on two of the
483    ///   platforms razeri reaches. Measured on the running
484    ///   containers: `PostgreSQL` and Citus raise
485    ///   *"function max(boolean) does not exist"*, SQL Server raises
486    ///   *"Msg 8117: Operand data type bit is invalid for max operator"*, while
487    ///   `MariaDB` (`MAX(TRUE)` → `1`) and `ClickHouse` (`max(true)` → `true`)
488    ///   answer it happily;
489    /// - `PostgreSQL` has no `max()` for `uuid`, `jsonb` or `bytea` either
490    ///   (measured, same run), and SQL Server has one for both
491    ///   `uniqueidentifier` and `varbinary` (measured).
492    ///
493    /// **`None` means *this dialect cannot aggregate this kind* and is not a
494    /// failure.** The caller then emits the bare correlated scalar — the
495    /// prior shape, measured green on the whole
496    /// `PostgreSQL` family — and says so on the output, because that shape is
497    /// the one Databricks refuses.
498    ///
499    /// **Correctness does not come from the aggregate's meaning.** The subquery
500    /// is under a guard that is false for the entire load if any member
501    /// disagrees with itself, so it selects one row; `MAX`, `BOOL_OR` and
502    /// `BOOLOR_AGG` of one value are all that value. The choice between them is
503    /// availability, not semantics.
504    fn render_single_row_aggregate(
505        &self,
506        expression: &str,
507        kind: AggregableKind,
508    ) -> Option<String> {
509        let _ = kind;
510        Some(format!("MAX({expression})"))
511    }
512
513    /// **Take any one value of `expression` from a group**, for the engines
514    /// that cannot group on the column itself.
515    ///
516    /// A load collapses staged rows that repeat. Where the engine will not
517    /// group on a nested column
518    /// ([`crate::DialectCapabilities::groups_nested_values`]) the collapse
519    /// groups on the remaining columns and takes one value of that one, which
520    /// is what this renders.
521    ///
522    /// `ANY_VALUE` is the spelling `BigQuery`, Snowflake, Redshift, Databricks
523    /// and `MySQL` all use, so it is the default; an engine that spells it
524    /// differently, or reaches it through `FIRST`, says so here.
525    ///
526    /// Unlike [`Self::render_single_row_aggregate`] this one cannot decline:
527    /// it is asked only where the dialect has already said it cannot group on
528    /// the column, so there is no second shape to fall back to.
529    ///
530    /// Parameters:
531    /// - `expression`: the column reference, already spelled by the renderer
532    ///   that lays out the query.
533    fn render_any_value(&self, expression: &str) -> String {
534        format!("ANY_VALUE({expression})")
535    }
536
537    /// **The AGGREGATE median this engine has for `expression`, or `None` when
538    /// it has none.**
539    ///
540    /// Aggregate is the load-bearing word, and it is why this cannot be
541    /// answered from a function-name table. Four spellings are in the wild:
542    ///
543    /// - a plain `median(x)` aggregate — `duckdb`, `clickhouse`, `snowflake`;
544    /// - the SQL ordered-set aggregate
545    ///   `PERCENTILE_CONT(0.5) WITHIN GROUP (ORDER BY x)` — `postgres` and its
546    ///   family (measured on a running instance: it groups);
547    /// - a two-argument `PERCENTILE(x, 0.5)` — `databricks`;
548    /// - and a WINDOW function wearing one of those names, which is **not**
549    ///   this. `mariadb` has `MEDIAN(x) OVER (…)` and `sqlserver` has
550    ///   `PERCENTILE_CONT(…) OVER (…)`, and both are a syntax error in a
551    ///   `GROUP BY` select list (measured: `MariaDB` raises `ERROR 1064` and
552    ///   SQL Server raises *"Msg 10753: The function `PERCENTILE_CONT` must
553    ///   have an OVER clause"*). A window function returns one value per ROW,
554    ///   not one per group, so it is a different answer and not a fallback.
555    ///
556    /// **The default declines**, so a dialect that has never been asked the
557    /// question is never assumed to have the answer, and a dialect added
558    /// tomorrow opts in deliberately with a form somebody measured. The caller
559    /// turns `None` into a build-time refusal naming the column and the target
560    /// — razeri does not emit SQL its target cannot run.
561    ///
562    /// # Why a TEMPLATE rather than finished SQL
563    ///
564    /// The aggregated expression is a column reference, and how a column
565    /// reference is spelled — quoted, bracketed, upper-cased — belongs to the
566    /// renderer that lays out the query, not to this answer. Handing back a
567    /// form with [`AGGREGATE_ARGUMENT`] where the expression goes keeps the
568    /// two apart: this trait owns *which function*, the query renderer owns
569    /// *how the column is written*, and neither has to reimplement the other.
570    fn median_aggregate_form(&self) -> Option<&'static str> {
571        None
572    }
573
574    /// Render a date literal.
575    ///
576    /// `ClickHouse`: `toDate('2024-01-15')`, others: `DATE '2024-01-15'`
577    fn render_date_literal(&self, date: &str) -> String {
578        format!("DATE '{date}'")
579    }
580
581    /// Render a timestamp literal.
582    ///
583    /// `ClickHouse`: `toDateTime('...')`, others: `TIMESTAMP '...'`
584    fn render_timestamp_literal(&self, ts: &str) -> String {
585        format!("TIMESTAMP '{ts}'")
586    }
587
588    /// Render an interval literal.
589    ///
590    /// `SqlServer`: `'P1Y2M3D'`, `ClickHouse`: `INTERVAL 1 YEAR`, others: `INTERVAL '1 year'`
591    fn render_interval_literal(&self, interval: &str) -> String {
592        format!("INTERVAL '{interval}'")
593    }
594
595    /// Render the string concatenation operator.
596    ///
597    /// `SqlServer`: `+`, others: `||`
598    fn concat_operator(&self) -> &'static str {
599        "||"
600    }
601
602    /// Render a NaN literal for a floating-point type.
603    ///
604    /// `PostgreSQL`: `'NaN'::float`, others: `NULL`
605    fn render_nan_literal(&self, _dt: &DataType) -> String {
606        "NULL".to_string()
607    }
608
609    /// Render an infinity literal for a floating-point type.
610    ///
611    /// `PostgreSQL`: `'Infinity'::float` / `'-Infinity'::float`, others: `NULL`
612    fn render_infinity_literal(&self, _positive: bool, _dt: &DataType) -> String {
613        "NULL".to_string()
614    }
615
616    /// Render the NULL-coalescing function name.
617    ///
618    /// `SqlServer`: `ISNULL`, `ClickHouse`: `ifNull`, others: `COALESCE`
619    fn ifnull_function_name(&self) -> &'static str {
620        "COALESCE"
621    }
622
623    /// Render an IIF expression (or CASE WHEN equivalent).
624    ///
625    /// `SqlServer`: `IIF(cond, then, else)`, others: `CASE WHEN cond THEN then ELSE else END`
626    fn render_iif(&self, cond: &str, then_val: &str, else_val: &str) -> String {
627        format!("CASE WHEN {cond} THEN {then_val} ELSE {else_val} END")
628    }
629
630    /// Render a `DATE_TRUNC` expression.
631    ///
632    /// `SqlServer`: `DATETRUNC(field, expr)`, `ClickHouse`: `toStartOfMonth(expr)`, others: `DATE_TRUNC('field', expr)`
633    fn render_date_trunc(&self, field: &str, expr: &str) -> String {
634        format!("DATE_TRUNC('{field}', {expr})")
635    }
636
637    /// Render a date field extraction expression.
638    ///
639    /// `SqlServer`: `DATEPART(field, column)`, `ClickHouse`: `toYear(col)/toMonth(col)`, others: `EXTRACT(field FROM column)`
640    fn render_date_extract(&self, field: &str, column: &str) -> String {
641        format!("EXTRACT({field} FROM {column})")
642    }
643
644    /// Render a `TRY_CAST` expression.
645    ///
646    /// `ClickHouse`: `accurateCastOrNull(expr, 'Type')`, others: `TRY_CAST(expr AS Type)`
647    fn render_try_cast(&self, expr: &str, target: &DataType) -> String {
648        format!("TRY_CAST({} AS {})", expr, self.render_data_type(target))
649    }
650
651    /// Render a positional parameter placeholder.
652    ///
653    /// `PostgreSQL`: `$1`, `SqlServer`: `@p1`, Databricks: `{param1}`, others: `?`
654    fn render_parameter_placeholder(&self, index: usize) -> String {
655        format!("${index}")
656    }
657
658    /// Render a named parameter placeholder.
659    ///
660    /// `SqlServer`: `@name`, `PostgreSQL`: `:name`, Databricks: `{name}`
661    fn render_named_parameter(&self, name: &str) -> String {
662        format!(":{name}")
663    }
664
665    /// Keyword emitted for MERGE NOT MATCHED branch.
666    ///
667    /// SqlServer/Databricks: `WHEN NOT MATCHED BY TARGET`, others: `WHEN NOT MATCHED`.
668    fn merge_not_matched_keyword(&self) -> &'static str {
669        "WHEN NOT MATCHED"
670    }
671
672    /// Whether MERGE supports `WHEN NOT MATCHED BY SOURCE`.
673    fn supports_merge_not_matched_by_source(&self) -> bool {
674        false
675    }
676
677    /// Whether this platform takes a `MERGE` statement.
678    ///
679    /// **This is `DialectCapabilities::merge_shape().merges()`, restated where
680    /// only a `SqlRenderer` is in hand** — the standalone `MergeStatement`
681    /// builder takes this trait alone and cannot ask the capability surface.
682    /// The two must answer identically; the capability/renderer consistency
683    /// gate holds them to equality with no exceptions, so a dialect that
684    /// overrides one and not the other is refused before it ships. An engine
685    /// whose shape is an upsert statement, an engine-deduplicated insert, or a
686    /// refusal answers `false` here.
687    fn merge_supported(&self) -> bool {
688        true
689    }
690
691    /// Whether `WITH SCHEMA EVOLUTION` is supported for MERGE.
692    fn merge_supports_schema_evolution_keyword(&self) -> bool {
693        false
694    }
695
696    /// Whether table hints are supported in MERGE target.
697    fn merge_supports_table_hints(&self) -> bool {
698        false
699    }
700
701    /// Whether OUTPUT clause should be used for MERGE result projection.
702    fn merge_uses_output_clause(&self) -> bool {
703        false
704    }
705
706    /// Whether RETURNING clause is supported for MERGE.
707    fn merge_supports_returning_clause(&self) -> bool {
708        false
709    }
710
711    /// **Whether this engine lets a `MERGE` target carry an alias.**
712    ///
713    /// Most do, and the composed load addresses the target through a short
714    /// `tgt`. An engine that answers `false` gets the target's own qualified
715    /// name in every position the alias would have stood — dropping the
716    /// qualifier instead makes the shared column names ambiguous.
717    fn merge_target_accepts_alias(&self) -> bool {
718        true
719    }
720
721    /// **Whether this engine refuses a `WITH` clause in front of `MERGE`.**
722    ///
723    /// The composed load types its staging rows in one common table expression
724    /// and hashes them in a second. Where a leading `WITH` parses, the two sit
725    /// in front of the statement and the source is the second one by name.
726    /// Where it does not, the same two move inside the `USING` subquery, which
727    /// is the same query in a position the grammar accepts.
728    ///
729    /// Answer `true` if `WITH … MERGE INTO …` is a syntax error on your engine.
730    fn merge_source_requires_inlined_ctes(&self) -> bool {
731        false
732    }
733
734    /// **Whether a `WITH` clause parses in front of this engine's `INSERT`.**
735    ///
736    /// A load that writes rows without matching them — one slice replaced, or
737    /// rows appended — types its staging rows in one common table expression
738    /// and hashes them in a second, exactly as the matching load does. Most
739    /// engines take those two inside the statement, after the column list and
740    /// in front of the `SELECT`, which is where Razeri puts them by default.
741    ///
742    /// Answer `true` where the same two have to lead instead, because the
743    /// engine reads a `WITH` after a table name as something else entirely:
744    /// T-SQL parses it as a table hint and rejects the statement. Nothing here
745    /// changes the query — only where the engine will accept it written down.
746    fn insert_accepts_leading_ctes(&self) -> bool {
747        false
748    }
749
750    /// **Whether this engine can be given a function by `CREATE FUNCTION`.**
751    ///
752    /// Razeri derives a surrogate key through a small emitted function, and an
753    /// engine whose SQL surface has no `CREATE FUNCTION` at all can never
754    /// receive it — the definition has to come from application code instead.
755    /// Such an engine gets no emitted helper and no per-entity key function,
756    /// and its dialect states the substitute in its own words.
757    ///
758    /// This is about the **grammar**, not about who owns the name: an engine
759    /// that can define functions but takes its key function from an installed
760    /// artifact still answers `true` here.
761    fn supports_sql_function_ddl(&self) -> bool {
762        true
763    }
764
765    /// **Whether a scalar function's body is a bare expression.**
766    ///
767    /// Most engines want a full `SELECT` in front of the value a function
768    /// returns. Some take the expression alone and reject the `SELECT`.
769    fn scalar_function_body_is_expression(&self) -> bool {
770        false
771    }
772
773    /// **Whether a scalar function belongs to a schema.**
774    ///
775    /// On most engines a function lives in a schema and both its definition and
776    /// its call sites name it. On an engine that answers `false`, functions are
777    /// server-global: `CREATE FUNCTION` takes no qualifier, and a qualified
778    /// call names a function that does not exist.
779    fn scalar_function_names_are_schema_qualified(&self) -> bool {
780        true
781    }
782
783    /// **Whether an unqualified scalar-function call resolves.**
784    ///
785    /// Most engines resolve a bare function name through a search path. An
786    /// engine that answers `true` resolves none, so a call with no schema in
787    /// front of it has to be given one — [`DialectCapabilities::default_schema`]
788    /// is the
789    /// schema the function was created in when the caller named none.
790    ///
791    /// [`DialectCapabilities::default_schema`]: crate::DialectCapabilities::default_schema
792    fn scalar_function_call_requires_schema(&self) -> bool {
793        false
794    }
795
796    /// **How this engine invokes a stored procedure**, as a whole statement.
797    ///
798    /// The composed load calls its own identity step, and a deploy script that
799    /// has no procedures at all has to recognise these calls in order to inline
800    /// what they would have run — so the call is spelled once, here.
801    fn render_procedure_call(&self, qualified_name: &str) -> String {
802        format!("CALL {qualified_name}();")
803    }
804
805    /// The schema separator for qualified names.
806    ///
807    /// Almost always `.`, but could differ for some platforms.
808    fn schema_separator(&self) -> &'static str {
809        "."
810    }
811
812    /// The statement separator for scripts.
813    ///
814    /// Almost all platforms: `;\n`, `SqlServer`: `;\nGO\n`
815    fn statement_separator(&self) -> &'static str {
816        ";\n"
817    }
818
819    // ═══════════════════════════════════════════════════════════════
820    // UPDATE behavior hooks
821    // ═══════════════════════════════════════════════════════════════
822
823    /// Whether the platform supports compound assignment operators (e.g., `col += value`).
824    ///
825    /// `SqlServer`: `true`, others: `false`.
826    fn supports_compound_assignment(&self) -> bool {
827        false
828    }
829
830    /// Whether UPDATE supports FROM clause for join-based updates.
831    ///
832    /// `PostgreSQL`, `SqlServer`, Snowflake, `CitusDB`: `true`, others: `false`.
833    fn supports_update_from(&self) -> bool {
834        false
835    }
836
837    /// Whether the platform uses ALTER TABLE ... UPDATE syntax (`ClickHouse` mutations).
838    fn uses_alter_table_update(&self) -> bool {
839        false
840    }
841
842    /// **Whether a mutation on this platform can read only the row it is
843    /// mutating.**
844    ///
845    /// `uses_alter_table_update` above says how the mutation is SPELLED; this
846    /// says what the mutation may LOOK AT, and the two are independent facts
847    /// that happen to be true of the same engine today. A platform answering
848    /// `true` here cannot express *assign this column from another relation*
849    /// at all: neither the `SET` list nor the `WHERE` may correlate out to a
850    /// second table, so no re-spelling of a correlated `UPDATE` compiles —
851    /// what is available instead is `INSERT … SELECT` over a join and a
852    /// mutation whose predicate is an uncorrelated `IN`.
853    ///
854    /// **Measured, and it is the reason the seam exists.** `ClickHouse`
855    /// 24.10.2 (2026-08-23) answered razeri's emitted re-open with
856    /// `Code: 47 … UNKNOWN_IDENTIFIER` while resolving the assignment's own
857    /// subquery — after the statement PARSED, which is what made the
858    /// distinction visible: the syntax was right and the reach was not.
859    ///
860    /// It sits here on [`SqlRenderer`] and **only** here, deliberately not
861    /// duplicated onto `DialectCapabilities`: `SqlRenderer` is the trait
862    /// razeri's generators call, so this is the definition that decides, and a
863    /// second declaration of the same fact is one that can drift.
864    ///
865    /// Default `false`: every engine razeri reaches except `ClickHouse` lets a
866    /// mutation correlate, and the ANSI correlated `UPDATE` those nine compile
867    /// is unchanged by this flag existing.
868    fn mutation_reads_only_its_own_rows(&self) -> bool {
869        false
870    }
871
872    /// **The spelling a SQL statement inside a generated procedure body reads
873    /// a declared local variable by.**
874    ///
875    /// A versioning load binds its clock ONCE — a `Declare` step at the top of
876    /// the procedure — and every close and every open reads the variable
877    /// instead of the engine's clock, so there is no daylight between the
878    /// close of one version and the open of the next. The DECLARATION is the
879    /// procedure renderer's business; what the load generators need is the
880    /// reference spelling to embed in the raw statements they compose, and
881    /// that differs by procedure language:
882    ///
883    /// - bare `name` — PL/pgSQL, MySQL/MariaDB, and the default;
884    /// - `@name` — T-SQL;
885    /// - `:name` — Snowflake Scripting's bind syntax inside SQL statements;
886    /// - `$name` — the agnostic format's marker.
887    ///
888    /// It mirrors the variable-reference spelling of Razeri's own procedure
889    /// renderers — the two must agree, and each override says so beside the
890    /// spelling.
891    fn render_procedure_variable_reference(&self, name: &str) -> String {
892        name.to_owned()
893    }
894
895    /// **The statement that binds one query's answer to a declared local.**
896    ///
897    /// A procedure body asks a question — how many rows arrived, what the
898    /// latest timestamp is — and keeps the answer in a variable the rest of the
899    /// body reads. Every procedural language has that statement and no two
900    /// spell it alike:
901    ///
902    /// - `SELECT COUNT(*) FROM stage INTO v_seen;` — PL/pgSQL;
903    /// - `SELECT @v_seen = (SELECT COUNT(*) FROM stage);` — T-SQL;
904    /// - `v_seen := (SELECT COUNT(*) FROM stage);` — Snowflake Scripting;
905    /// - `EXECUTE IMMEDIATE 'SELECT COUNT(*) FROM stage' INTO v_seen;` —
906    ///   Oracle's PL/SQL.
907    ///
908    /// `query` is the question, already carrying this dialect's variable
909    /// spelling and with no trailing terminator; `variable` is the bare name of
910    /// the local, so a grammar that wants the reference spelling asks
911    /// [`Self::render_procedure_variable_reference`] for it and one that wants
912    /// the bare name has it already. The answer is a whole statement,
913    /// terminator included.
914    ///
915    /// The default names the query and the target in a form that belongs to no
916    /// engine, because there is no spelling every engine shares. A dialect
917    /// rendering its own routine grammar answers this and the body arrives
918    /// ready to compile.
919    fn render_procedure_query_into_variable(&self, variable: &str, query: &str) -> String {
920        format!("EXECUTE {query} INTO {};", self.render_procedure_variable_reference(variable))
921    }
922
923    /// **The statement that stops a procedure body with an error of its own.**
924    ///
925    /// A generated load checks what it was given and refuses to go on when the
926    /// answer is wrong. Every procedural language can stop that way and no two
927    /// write it alike:
928    ///
929    /// - `RAISE EXCEPTION '%', 'the run brought no rows';` — PL/pgSQL;
930    /// - `THROW 50000, 'the run brought no rows', 1;` — T-SQL;
931    /// - `SIGNAL SQLSTATE '45000' SET MESSAGE_TEXT = 'the run brought no rows';`
932    ///   — `MySQL` and `MariaDB`;
933    /// - `RAISE_APPLICATION_ERROR(-20001, 'the run brought no rows');` —
934    ///   Oracle's PL/SQL.
935    ///
936    /// `message` is the message **already rendered as a SQL expression in this
937    /// dialect's spelling**: a literal arrives quoted and escaped, and a
938    /// variable arrives named the way
939    /// [`Self::render_procedure_variable_reference`] names one, because a body
940    /// may raise what it read rather than what it was written with. Put it
941    /// where the statement wants it and do not quote it again. `error_code` is
942    /// the number the design gave, if it gave one; an engine whose statement
943    /// takes a number supplies its own when this is `None`. The answer is a
944    /// whole statement, terminator included.
945    ///
946    /// The default names the raise in a form that belongs to no engine. A
947    /// dialect rendering its own routine grammar answers this and the body
948    /// arrives ready to compile.
949    fn render_procedure_raise(&self, message: &str, error_code: Option<i32>) -> String {
950        match error_code {
951            Some(code) => format!("RAISE EXCEPTION [{code}] {message};"),
952            None => format!("RAISE EXCEPTION {message};"),
953        }
954    }
955
956    /// **The statement that writes a message where an operator can read it.**
957    ///
958    /// A load says how it is going, and where that message goes is an engine's
959    /// own business — a client notice, a print stream, an event table, a
960    /// result set nobody reads:
961    ///
962    /// - `RAISE NOTICE '%', 'loaded';` — PL/pgSQL;
963    /// - `PRINT 'loaded';` — T-SQL;
964    /// - `SYSTEM$LOG('INFO', 'loaded');` — Snowflake Scripting;
965    /// - `DBMS_OUTPUT.PUT_LINE('loaded');` — Oracle's PL/SQL, which has no
966    ///   levels and ignores the one it is given.
967    ///
968    /// `message` arrives the same way [`Self::render_procedure_raise`] takes
969    /// it: already a SQL expression in this dialect's spelling, quoted where it
970    /// is a literal. `level` is the severity the design wrote; an engine whose
971    /// statement carries one reads
972    /// [`ProcedureLogLevel::as_str`] and spells it the way that statement
973    /// wants. The answer is a whole statement, terminator included.
974    ///
975    /// The default names the level and the message in a form that belongs to no
976    /// engine. A dialect rendering its own routine grammar answers this and the
977    /// body arrives ready to compile.
978    fn render_procedure_log(&self, level: ProcedureLogLevel, message: &str) -> String {
979        let word = match level {
980            ProcedureLogLevel::Debug => "DEBUG",
981            ProcedureLogLevel::Info => "NOTICE",
982            ProcedureLogLevel::Warning => "WARNING",
983            ProcedureLogLevel::Error => "EXCEPTION",
984        };
985        format!("LOG {word} {message};")
986    }
987
988    /// **The statement a generated load asks a scalar question with and throws
989    /// the answer away.**
990    ///
991    /// A load's guard evaluates one scalar and reads nothing back: it either
992    /// passes silently or stops the load on the engine's own error. What
993    /// differs between engines is not the question but the STATEMENT that may
994    /// carry it, and the difference is a procedure-language rule rather than a
995    /// SQL one:
996    ///
997    /// - a bare `SELECT` is a legal script statement everywhere, and is legal
998    ///   inside the procedure bodies `MySQL`, `MariaDB` and T-SQL accept, where it
999    ///   simply hands the caller a result set nobody reads — so that is the
1000    ///   default;
1001    /// - **PL/pgSQL refuses it.** A `SELECT` with no destination inside a
1002    ///   procedure body is `query has no destination for result data`, raised
1003    ///   the moment the procedure is called. PL/pgSQL's own discard form is
1004    ///   `PERFORM`, and the Postgres family overrides this to spell it.
1005    ///
1006    /// The engines that ship no stored procedure inline the same statement into
1007    /// a script, where the default is the only form that runs — and every such
1008    /// engine takes the default, so one answer per dialect is unambiguous.
1009    ///
1010    /// `alias` names the answered column for the forms that answer one; a
1011    /// discard form that answers nothing ignores it.
1012    fn render_discarded_scalar(&self, expression: &str, alias: &str) -> String {
1013        format!("SELECT {expression} AS {alias};")
1014    }
1015
1016    /// **How a script with no stored procedures binds the load's clock once**
1017    /// — same rule as [`Self::render_procedure_variable_reference`], on the
1018    /// engines where a load ships as a flat statement list rather than a
1019    /// procedure body.
1020    ///
1021    /// The statements run FIRST and bind the engine's current moment to
1022    /// `name`; the reference is the expression every close and open in the
1023    /// same run then reads, so a version's `record_end_timestamp` and its
1024    /// successor's `record_start_timestamp` are one value by construction.
1025    /// Every spelling must be RE-RUNNABLE in one session — a second load in
1026    /// the same session rebinds rather than failing — because a load script is
1027    /// run whole and run again.
1028    ///
1029    /// The default is the one shape every engine can carry: a one-row
1030    /// temporary table capturing [`Self::render_current_timestamp`], read back
1031    /// through a scalar subquery. Engines with a native variable idiom
1032    /// override it (`DuckDB`'s `SET VARIABLE`, Databricks' session variables);
1033    /// `ClickHouse` overrides only the temporary-table spelling its own DDL
1034    /// requires.
1035    fn render_inline_clock_binding(&self, name: &str, moment: &str) -> InlineClockBinding {
1036        InlineClockBinding {
1037            statements: vec![
1038                format!("DROP TABLE IF EXISTS {name};"),
1039                format!("CREATE TEMPORARY TABLE {name} AS SELECT {moment} AS load_clock;"),
1040            ],
1041            reference: format!("(SELECT load_clock FROM {name})"),
1042        }
1043    }
1044
1045    /// Whether UPDATE supports TOP(n) clause (`SqlServer`).
1046    fn update_supports_top_clause(&self) -> bool {
1047        false
1048    }
1049
1050    /// Whether UPDATE supports table hints (e.g., `WITH (NOLOCK)`) (`SqlServer`).
1051    fn update_supports_table_hints(&self) -> bool {
1052        false
1053    }
1054
1055    /// Whether UPDATE uses OUTPUT clause positioned before FROM (`SqlServer`).
1056    ///
1057    /// When `true`, RETURNING/OUTPUT is rendered between SET and FROM.
1058    /// When `false`, RETURNING is rendered at the end of the statement.
1059    fn update_uses_output_clause(&self) -> bool {
1060        false
1061    }
1062
1063    /// Whether UPDATE supports a RETURNING clause at the end of the statement.
1064    ///
1065    /// `PostgreSQL`, `CitusDB`: `true`. Others: `false`.
1066    fn update_supports_returning(&self) -> bool {
1067        false
1068    }
1069
1070    // ========================================================================
1071    // INSERT behavior hooks
1072    // ========================================================================
1073
1074    /// Whether INSERT uses OUTPUT clause positioned before VALUES/SELECT (`SqlServer`).
1075    ///
1076    /// When `true`, RETURNING/OUTPUT is rendered between column list and source.
1077    /// When `false`, RETURNING is rendered at the end of the statement.
1078    fn insert_uses_output_clause(&self) -> bool {
1079        false
1080    }
1081
1082    /// Whether INSERT supports RETURNING at the end (`PostgreSQL`, `CitusDB`).
1083    fn insert_supports_returning(&self) -> bool {
1084        false
1085    }
1086
1087    /// Whether INSERT supports table hints (e.g., `WITH (TABLOCK)`) (`SqlServer`).
1088    fn insert_supports_table_hints(&self) -> bool {
1089        false
1090    }
1091
1092    /// Whether INSERT OVERWRITE is supported (Snowflake, Databricks).
1093    fn supports_insert_overwrite(&self) -> bool {
1094        false
1095    }
1096
1097    /// Whether INSERT ... ON CONFLICT is supported (`PostgreSQL`, `CitusDB`).
1098    fn supports_on_conflict(&self) -> bool {
1099        false
1100    }
1101
1102    /// Whether OVERRIDING SYSTEM/USER VALUE clause is supported (`PostgreSQL`).
1103    fn supports_overriding_clause(&self) -> bool {
1104        false
1105    }
1106
1107    /// The keyword for returning data from DML: "OUTPUT" (`SqlServer`) or "RETURNING" (others).
1108    fn returning_clause_keyword(&self) -> &'static str {
1109        "RETURNING"
1110    }
1111
1112    /// Whether OUTPUT ... INTO is supported (`SqlServer`).
1113    fn supports_returning_into(&self) -> bool {
1114        false
1115    }
1116
1117    /// Whether multi-table INSERT (INSERT ALL) is supported (Snowflake).
1118    fn supports_multi_table_insert(&self) -> bool {
1119        false
1120    }
1121
1122    // ========================================================================
1123    // Function/procedure parameter behavior hooks
1124    // ========================================================================
1125
1126    /// Render the security mode clause for function/procedure definitions.
1127    ///
1128    /// Standard SQL: `SECURITY INVOKER`/`SECURITY DEFINER`.
1129    /// T-SQL: `EXECUTE AS CALLER`/`EXECUTE AS OWNER`.
1130    fn render_security_mode(&self, is_definer: bool) -> &'static str {
1131        if is_definer { "SECURITY DEFINER" } else { "SECURITY INVOKER" }
1132    }
1133
1134    /// Render a function parameter name.
1135    ///
1136    /// Standard SQL uses the bare name. T-SQL prefixes with `@`.
1137    fn render_function_parameter_name(&self, name: &str) -> String {
1138        name.to_string()
1139    }
1140
1141    /// Render explicit nullability for a function parameter, if the platform requires it.
1142    ///
1143    /// Most platforms omit nullability in parameter lists. T-SQL native
1144    /// compilation requires explicit `NULL`/`NOT NULL`.
1145    fn render_function_parameter_nullable(&self, _nullable: bool) -> Option<&'static str> {
1146        None
1147    }
1148
1149    /// Render the default-value clause for a function parameter.
1150    ///
1151    /// Standard SQL: `DEFAULT value`. T-SQL: `= value`.
1152    fn render_function_parameter_default(&self, value: &str) -> String {
1153        format!("DEFAULT {value}")
1154    }
1155
1156    /// Render a column name inside a table-valued function definition.
1157    ///
1158    /// Standard SQL uses the bare name. T-SQL uses bracket quoting `[name]`.
1159    fn render_function_column_name(&self, name: &str) -> String {
1160        name.to_string()
1161    }
1162
1163    // ========================================================================
1164    // Partition & generated column rendering hooks
1165    // ========================================================================
1166
1167    /// Render a time partition expression for a column and granularity.
1168    ///
1169    /// Granularity values: `"hourly"`, `"daily"`, `"weekly"`, `"monthly"`,
1170    /// `"quarterly"`, `"yearly"`.
1171    ///
1172    /// Default: `date_trunc('unit', column)` (ANSI / `PostgreSQL` style),
1173    /// mapping granularity names to `date_trunc` units.
1174    fn render_time_partition_expr(&self, column: &str, granularity: &str) -> String {
1175        let unit = match granularity {
1176            "hourly" => "hour",
1177            "daily" => "day",
1178            "weekly" => "week",
1179            "monthly" => "month",
1180            "quarterly" => "quarter",
1181            "yearly" => "year",
1182            other => other,
1183        };
1184        format!("date_trunc('{unit}', {column})")
1185    }
1186
1187    /// Render a DDL partition clause wrapping the expression list.
1188    ///
1189    /// Default: `PARTITION BY (expr)`. Snowflake: `CLUSTER BY (expr)`,
1190    /// Databricks: `PARTITIONED BY (expr)`, `ClickHouse`: `PARTITION BY expr` (no parens).
1191    fn render_partition_clause(&self, expr: &str) -> String {
1192        format!("PARTITION BY ({expr})")
1193    }
1194
1195    /// Render a generated column declaration.
1196    ///
1197    /// Default: `name GENERATED ALWAYS AS (expr) STORED` (`PostgreSQL` style).
1198    fn render_generated_column(&self, name: &str, expr: &str) -> String {
1199        format!("{name} GENERATED ALWAYS AS ({expr}) STORED")
1200    }
1201
1202    // ========================================================================
1203    // Window function capability hooks
1204    // ========================================================================
1205
1206    /// Whether the platform supports the EXCLUDE clause in window frame specifications.
1207    ///
1208    /// `PostgreSQL`, Snowflake, Databricks: `true`. Others: `false`.
1209    fn supports_window_frame_exclude(&self) -> bool {
1210        false
1211    }
1212
1213    /// Whether the platform supports the GROUPS frame mode in window functions.
1214    ///
1215    /// `PostgreSQL`, Databricks: `true`. Others: `false`.
1216    fn supports_window_frame_groups(&self) -> bool {
1217        false
1218    }
1219
1220    /// Whether the platform supports named windows (WINDOW clause).
1221    ///
1222    /// Most platforms: `true`. `ClickHouse`, `DuckDB`, `MariaDB`: `false`.
1223    fn supports_named_windows(&self) -> bool {
1224        true
1225    }
1226
1227    // ========================================================================
1228    // DDL table-scope capability hooks
1229    // ========================================================================
1230
1231    /// Whether the platform uses a `#` prefix for session-scoped temporary table names.
1232    ///
1233    /// SQL Server: `true`. Others: `false`.
1234    fn uses_hash_temp_table_prefix(&self) -> bool {
1235        false
1236    }
1237
1238    /// Whether the platform supports `DECLARE @name TABLE (...)` table variables.
1239    ///
1240    /// SQL Server: `true`. Others: `false`.
1241    fn supports_table_variables(&self) -> bool {
1242        false
1243    }
1244
1245    /// The full CREATE keyword for session-scoped temporary tables.
1246    ///
1247    /// Default: `"CREATE TEMPORARY"`.
1248    /// SQL Server: `"CREATE"` (uses `#name` instead of TEMPORARY keyword).
1249    /// Databricks: `"CREATE OR REPLACE TEMPORARY"`.
1250    fn render_create_temp_table_keyword(&self) -> &'static str {
1251        "CREATE TEMPORARY"
1252    }
1253
1254    /// Whether the platform supports transient tables (e.g. `CREATE TRANSIENT TABLE`).
1255    ///
1256    /// Snowflake: `true`. Others: `false`.
1257    fn supports_transient_tables(&self) -> bool {
1258        false
1259    }
1260
1261    /// Whether the platform supports `ON COMMIT DROP` for transaction-scoped temp tables.
1262    ///
1263    /// `PostgreSQL`, `CitusDB`: `true`. Others: `false`.
1264    fn supports_on_commit_drop(&self) -> bool {
1265        false
1266    }
1267
1268    /// Whether the platform requires an `ENGINE = ...` clause on CREATE TABLE.
1269    ///
1270    /// `ClickHouse`: `true`. Others: `false`.
1271    ///
1272    /// A platform that answers `true` owns its whole engine suffix in ONE place:
1273    /// the `CREATE TABLE` composer emits the engine, then the sorting key, then
1274    /// whatever the resolved storage plan contributes. A storage renderer for
1275    /// such a platform must therefore contribute NEITHER an engine clause nor a
1276    /// sorting key — two engine clauses is `Code: 62 … Syntax error`, and a
1277    /// sorting key that disagrees with the inline `PRIMARY KEY` is
1278    /// `Code: 36 … Primary key must be a prefix of the sorting key` (both
1279    /// measured on `ClickHouse` 24.10.2).
1280    fn requires_table_engine(&self) -> bool {
1281        false
1282    }
1283
1284    /// Whether this platform's table sorting key refuses nullable columns.
1285    ///
1286    /// `ClickHouse`: `true` — a `MergeTree` sorting key containing a
1287    /// `Nullable(…)` column answers `Code: 44 … Sorting key contains nullable
1288    /// columns, but merge tree setting allow_nullable_key is disabled`, measured
1289    /// on 24.10.2 against the control (the same key over a non-nullable column
1290    /// of the same type is accepted). Others: `false`.
1291    ///
1292    /// The materializer asks this before it lets a design's clustering columns
1293    /// into a sorting key, so the answer is a refusal the author can act on
1294    /// rather than a deployment failure they cannot.
1295    fn sorting_key_refuses_nullable_columns(&self) -> bool {
1296        false
1297    }
1298
1299    /// Whether the platform requires a primary key on every table.
1300    ///
1301    /// `ClickHouse` (MergeTree): `true`. Others: `false`.
1302    fn requires_primary_key_in_create_table(&self) -> bool {
1303        false
1304    }
1305
1306    /// Create a boxed [`FormulaRenderer`](crate::FormulaRenderer) for this dialect.
1307    ///
1308    /// Real dialect implementations override this to return `Box::new(Self)`.
1309    /// The default returns an ANSI dialect with standard function names.
1310    fn to_formula_renderer(&self) -> Box<dyn crate::FormulaRenderer> {
1311        Box::new(crate::AnsiDialect)
1312    }
1313}
1314
1315/// Level 2 — Expression rendering with ANSI SQL defaults.
1316pub trait ExpressionRenderer: SqlRenderer {
1317    /// **Render a conversion of `expr` to `target`** — the expression the
1318    /// generated load's typed projection writes for every column.
1319    ///
1320    /// The default is `CAST(expr AS …)` over
1321    /// [`render_cast_type`](SqlRenderer::render_cast_type), the cast vocabulary
1322    /// rather than the column vocabulary: a column may be declared `STRING(36)`
1323    /// where a cast may name only `STRING`, and `TINYINT` where a cast must say
1324    /// `SMALLINT`. Override it where a conversion is not a `CAST` at all —
1325    /// `GoogleSQL` has no cast from `STRING` to `JSON` ("Invalid cast from
1326    /// STRING to JSON") and converts with `PARSE_JSON(expr)` instead.
1327    fn render_cast(&self, expr: &str, target: &DataType) -> String {
1328        format!("CAST({} AS {})", expr, self.render_cast_type(target))
1329    }
1330
1331    /// **Read a value the source spells its own way** into `target`, which is
1332    /// a date or a timestamp.
1333    ///
1334    /// An import arrives with `1/1/2015` in one column and
1335    /// `2015-01-01T00:00:00Z` in the next, and no engine reads either of them
1336    /// the same way as the engine beside it. So the design states the
1337    /// spelling, razeri reads it once into a [`DateFormat`], and this
1338    /// translates that list into whatever this engine's own pattern language
1339    /// is — `MM/DD/YYYY`, `MM/dd/yyyy`, a style number, or a format string
1340    /// this engine calls its own.
1341    ///
1342    /// **A value that is not spelled that way has to come back as NULL.**
1343    /// razeri reads the NULL as *this row did not parse* and writes the row
1344    /// into the table it sets rows aside in, naming the column and the format
1345    /// it was told to expect. An expression that stops the load instead leaves
1346    /// a warehouse half-loaded over one bad row, and one that answers a
1347    /// different day than the value says is worse than either. An engine whose
1348    /// parse reads a value it cannot read — rolling the forty-fifth of a month
1349    /// forward rather than answering nothing — writes its own guard beside the
1350    /// parse; [`DateFormat::shape_pattern`] and
1351    /// [`DateFormat::capture_pattern`] come from the same directive list, so
1352    /// the guard and the parse cannot hold two opinions about one spelling.
1353    ///
1354    /// **A directive this engine cannot say is a refusal, not a guess.**
1355    /// [`DateFormat::translate`] hands back the first directive this engine
1356    /// answered nothing for, and answering `None` here is how that reaches
1357    /// the author — by name, at the door, rather than as a wrong day in the
1358    /// warehouse.
1359    ///
1360    /// `None` — the default — is this engine stating nothing about how it
1361    /// reads a spelled value. razeri then refuses the column and names the
1362    /// engine.
1363    fn render_parse_datetime(
1364        &self,
1365        _expr: &str,
1366        _format: &DateFormat,
1367        _target: &DataType,
1368    ) -> Option<String> {
1369        None
1370    }
1371
1372    /// Render string concatenation.
1373    fn render_concat(&self, parts: &[String]) -> String {
1374        format!("CONCAT({})", parts.join(", "))
1375    }
1376
1377    /// Render a COALESCE expression.
1378    fn render_coalesce(&self, parts: &[String]) -> String {
1379        format!("COALESCE({})", parts.join(", "))
1380    }
1381
1382    /// Render a string aggregation function.
1383    fn render_string_agg(&self, expr: &str, separator: &str) -> String {
1384        format!("STRING_AGG({expr}, '{separator}')")
1385    }
1386}
1387
1388/// A foreign key's referential action — SQL's own five words, no synonyms.
1389///
1390/// Lives here (rather than in the table model) so a dialect can answer
1391/// [`DdlRenderer::supports_foreign_key_action`] about a specific action
1392/// without depending on the modeling crate.
1393#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1394pub enum ReferentialAction {
1395    /// Also delete or update the referencing rows
1396    Cascade,
1397    /// Set the referencing columns to NULL
1398    SetNull,
1399    /// Reject the delete or update; some engines defer the check
1400    Restrict,
1401    /// Reject the delete or update (the SQL default)
1402    NoAction,
1403    /// Set the referencing columns to their default values
1404    SetDefault,
1405}
1406
1407impl ReferentialAction {
1408    /// Parses the SQL words, case-insensitively; underscores read as spaces
1409    /// so `set_null` and `SET NULL` both land.
1410    ///
1411    /// # Errors
1412    /// Returns a plain message listing the valid words when the input is not
1413    /// one of them.
1414    pub fn from_sql_word(word: &str) -> Result<Self, String> {
1415        match word.trim().replace('_', " ").to_uppercase().as_str() {
1416            "CASCADE" => Ok(Self::Cascade),
1417            "SET NULL" => Ok(Self::SetNull),
1418            "RESTRICT" => Ok(Self::Restrict),
1419            "NO ACTION" => Ok(Self::NoAction),
1420            "SET DEFAULT" => Ok(Self::SetDefault),
1421            _ => Err(format!(
1422                "'{word}' is not a referential action. Use one of: CASCADE, SET NULL, \
1423                 RESTRICT, NO ACTION, SET DEFAULT."
1424            )),
1425        }
1426    }
1427}
1428
1429impl std::fmt::Display for ReferentialAction {
1430    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1431        match self {
1432            Self::Cascade => write!(f, "CASCADE"),
1433            Self::SetNull => write!(f, "SET NULL"),
1434            Self::Restrict => write!(f, "RESTRICT"),
1435            Self::NoAction => write!(f, "NO ACTION"),
1436            Self::SetDefault => write!(f, "SET DEFAULT"),
1437        }
1438    }
1439}
1440
1441/// Level 3 — DDL rendering with reasonable defaults.
1442pub trait DdlRenderer: SqlRenderer {
1443    /// Prefix for CREATE TABLE statements.
1444    fn render_create_table_prefix(&self) -> &'static str {
1445        "CREATE TABLE"
1446    }
1447
1448    /// Whether this engine carries the given foreign-key referential action
1449    /// (`ON DELETE …` / `ON UPDATE …`) in `CREATE TABLE` DDL.
1450    ///
1451    /// The ANSI default says yes to all five words. A dialect answers `false`
1452    /// for an action its engine rejects or silently never enforces; the
1453    /// renderer then keeps the author's declaration visible as a plain
1454    /// comment instead of emitting a clause the engine would refuse — a
1455    /// declared action never vanishes without a trace.
1456    fn supports_foreign_key_action(&self, action: ReferentialAction) -> bool {
1457        let _ = action;
1458        true
1459    }
1460
1461    /// Prefix for CREATE VIEW statements.
1462    fn render_create_view_prefix(&self) -> &'static str {
1463        "CREATE OR REPLACE VIEW"
1464    }
1465
1466    /// Render a column definition (name, type, nullability).
1467    fn render_column_definition(&self, name: &str, dt: &DataType, nullable: bool) -> String {
1468        let quoted = self.quote_identifier(name);
1469        let (type_str, null_str) = if nullable {
1470            (self.render_nullable_data_type(dt), "")
1471        } else {
1472            (self.render_data_type(dt), " NOT NULL")
1473        };
1474        format!("{quoted} {type_str}{null_str}")
1475    }
1476
1477    /// **The statement this engine takes for one change to a table that
1478    /// already holds rows**, or `None` where it has none.
1479    ///
1480    /// Razeri classifies every difference between two deploys and hands the
1481    /// ones that lose nothing to this method, one at a time. What comes back
1482    /// goes into the file an operator runs; `None` means the change is named in
1483    /// the plan with this engine's name beside it, so the reader learns which
1484    /// engine has no statement rather than that no engine does.
1485    ///
1486    /// # The default, and why it is the only one
1487    ///
1488    /// `ALTER TABLE … ADD COLUMN … <type>` is the one spelling every engine
1489    /// Razeri targets accepts, so a dialect that answers nothing still writes
1490    /// the commonest evolution there is: a column that was not there yesterday.
1491    /// The column is declared without `NOT NULL`, which is the only form that
1492    /// can be added to a table that already holds rows.
1493    ///
1494    /// Every other change answers `None` by default. A widening and a record
1495    /// that gained a field are each spelled three or four ways across the
1496    /// engines Razeri reaches, and a default picked from one of them writes SQL
1497    /// the others reject — a statement handed to an operator who then finds out
1498    /// their engine will not take it. A dialect that has measured its engine
1499    /// says so here, and the ones that have not say nothing.
1500    ///
1501    /// The statement comes back without a terminator; the caller separates
1502    /// statements the way this engine separates them.
1503    fn render_column_evolution(&self, change: &ColumnEvolution<'_>) -> Option<String> {
1504        match change {
1505            ColumnEvolution::AddColumn { schema, table, column, data_type } => {
1506                let target = self.qualify_name(*schema, table);
1507                let name = self.quote_identifier(column);
1508                let rendered = self.render_nullable_data_type(data_type);
1509                Some(format!("ALTER TABLE {target} ADD COLUMN {name} {rendered}"))
1510            }
1511            ColumnEvolution::WidenColumn { .. } | ColumnEvolution::AddNestedField { .. } => None,
1512        }
1513    }
1514
1515    /// Render the surrogate identity column — a plain, ungenerated `BIGINT NOT
1516    /// NULL` on **every** dialect.
1517    ///
1518    /// **razeri's surrogate keys are logical and DETERMINATE, never
1519    /// engine-generated.** The identity value is a hash
1520    /// derived from the entity's identity grain, WRITTEN BY THE LOAD
1521    /// (`materialize_core`, `sid_expression`), so the same design loaded with the
1522    /// same data converges to the same key on `Postgres`, `Snowflake`, `MariaDB`,
1523    /// `ClickHouse` — every target. A database-assigned `AUTO_INCREMENT` /
1524    /// `IDENTITY(1,1)` / `GENERATED ALWAYS AS IDENTITY` would be sequential,
1525    /// load-order-dependent and **non-portable** — a different key per database
1526    /// for the same row — which is the one thing a portable key may not be. So no
1527    /// dialect emits a generator here; every one renders a plain column and the
1528    /// load fills it.
1529    ///
1530    /// `SQLite` narrows the type to `INTEGER` and `ClickHouse`/`DuckDB` carry
1531    /// their own overrides only to document the same plain shape; no override
1532    /// re-introduces a generator.
1533    ///
1534    /// The `_data_type` argument is reserved for future use (e.g., dialect-aware
1535    /// width selection); current dialects always emit `BIGINT` / `INTEGER`.
1536    fn render_identity_column(&self, name: &str, _data_type: &DataType) -> String {
1537        let quoted = self.quote_identifier(name);
1538        format!("{quoted} BIGINT NOT NULL")
1539    }
1540
1541    /// Whether this platform's engine actually **assigns** an identity column's
1542    /// value, rather than merely tolerating the declaration.
1543    ///
1544    /// **This is a dialect fact, not a field fact, and the difference is a
1545    /// deploy-time failure.** `Field::identity` says razeri intends the engine
1546    /// to generate the value; whether it does depends entirely on the target.
1547    /// `render_identity_column`'s own table above records that `DuckDB`,
1548    /// `SQLite` and `ClickHouse` have **no native identity** — there the column
1549    /// comes out as a plain `NOT NULL` and **the writer must supply it.**
1550    ///
1551    /// The default is `false` because the default `render_identity_column`
1552    /// emits no generation clause: a dialect that overrides the rendering to
1553    /// generate values must override this too, and
1554    /// `the_identity_capability_matches_what_each_dialect_renders` holds the two
1555    /// in step so they cannot drift.
1556    ///
1557    /// Read by the deploy bundle's write contract: a column
1558    /// the engine does not generate is a column a hand-written `INSERT` owes.
1559    fn generates_identity_values(&self) -> bool {
1560        false
1561    }
1562
1563    /// **The latest instant this platform can hold EXACTLY in the column it
1564    /// renders for `data_type`** — the ceiling the refuse-by-name rule compares
1565    /// against, or `None` for *no declared ceiling*.
1566    ///
1567    /// Spelled `YYYY-MM-DD HH:MM:SS`, which is how razeri writes a timestamp
1568    /// literal (`razeri_materialize::convert::OPEN_INTERVAL_SENTINEL`), so the
1569    /// comparison is a string comparison over a format that sorts
1570    /// chronologically. A ceiling and a value in the same spelling cannot be
1571    /// compared wrongly by a parser neither of them goes through.
1572    ///
1573    /// # What the refusal contract asks of this
1574    ///
1575    /// > A value razeri cannot store exactly on a target platform is a
1576    /// > deploy-time refusal naming the value, the column, the platform and the
1577    /// > ceiling — never a truncation, never a saturated write.
1578    ///
1579    /// The *refusal* lives in `razeri_materialize::bundle`, which is the one
1580    /// place it is built — the function is `refuse_unrepresentable_values`, and
1581    /// it is reached from `generate_bundle` before a single file is rendered.
1582    /// This is only where a platform declares the number.
1583    ///
1584    /// # A stated variance from the decision's original wording
1585    ///
1586    /// The refusal was decided as a *deploy-time* act, homed in the
1587    /// prerequisites step. Razeri refuses **earlier**: at bundle
1588    /// generation, by declining to emit the bundle at all. That is strictly
1589    /// ahead of deploy time and cannot be skipped by an operator who never runs
1590    /// the script — a deliberate strengthening, recorded rather
1591    /// than glossed. The consequence worth knowing: a *hand-assembled* bundle,
1592    /// or one from an older razeri, is not re-checked at deploy time by
1593    /// anything. **The default is `None`, which
1594    /// means "razeri has no measured ceiling for this platform and type" and not
1595    /// "this platform holds everything"** — an unmeasured platform gets no
1596    /// refusal rather than an invented one.
1597    ///
1598    /// # The ceiling is a property of the TYPE, not of the platform
1599    ///
1600    /// That is the half a platform-flat capability would get wrong, and it is
1601    /// measured rather than assumed (reading the renderers):
1602    ///
1603    /// | platform | `Timestamp(p)` renders | ceiling | `TimestampTz(p)` renders | ceiling |
1604    /// |---|---|---|---|---|
1605    /// | `MySQL`, `MariaDB` | `DATETIME(p)` | `None` — the end of the four-digit calendar is not a constraint | `TIMESTAMP(p)` | **`2038-01-19 03:14:07`** |
1606    /// | `ClickHouse` | `DateTime64(p)` | `2299-12-31 23:59:59` at p ≤ 6, **`2262-04-11 23:47:16`** at p ≥ 7 | `DateTime64(p,'UTC')` | the same |
1607    /// | everything else | — | not measured → `None` | — | `None` |
1608    ///
1609    /// On `MySQL` the two razeri type variants land on *different engine types*
1610    /// and get different answers: `Timestamp` renders as the
1611    /// non-converting `DATETIME` — the type whose semantics match the declared
1612    /// non-tz timestamp — which runs to the end of the calendar and so
1613    /// declares no ceiling at all, while `TimestampTz` keeps `TIMESTAMP` and its
1614    /// 32-bit epoch boundary. A check keyed on the platform alone would either
1615    /// miss the real ceiling or refuse a column that is fine. On `ClickHouse`
1616    /// the ceiling moves with the **declared precision** of one type:
1617    /// `DateTime64(9)` is int64 nanoseconds from the epoch and stops at
1618    /// 2262-04-11, while `DateTime64(6)` reaches 2299.
1619    ///
1620    /// Parameters:
1621    /// - `data_type`: the column's declared type, as the design carries it —
1622    ///   not the rendered string, because the precision is what moves the answer
1623    ///   and re-parsing it back out of `DateTime64(9)` would be a second reading
1624    ///   of what the dialect already knows.
1625    fn representable_timestamp_ceiling(&self, data_type: &DataType) -> Option<&'static str> {
1626        let _ = data_type;
1627        None
1628    }
1629
1630    /// Whether the platform requires every auto-increment / identity column to
1631    /// be the leading column of an index (PK or KEY).
1632    ///
1633    /// `MySQL` / `MariaDB`: `true` (otherwise error 1075). Others: `false`.
1634    ///
1635    /// When this is `true` and an identity column is not already the leading
1636    /// column of the primary key, the DDL renderer must emit an additional
1637    /// `KEY (identity_col)` clause on the table.
1638    fn auto_increment_requires_key(&self) -> bool {
1639        false
1640    }
1641
1642    /// Prefix for DROP TABLE statements.
1643    fn render_drop_table_prefix(&self, if_exists: bool) -> String {
1644        if if_exists { "DROP TABLE IF EXISTS".to_string() } else { "DROP TABLE".to_string() }
1645    }
1646
1647    /// Prefix for DROP VIEW statements.
1648    fn render_drop_view_prefix(&self, if_exists: bool) -> String {
1649        if if_exists { "DROP VIEW IF EXISTS".to_string() } else { "DROP VIEW".to_string() }
1650    }
1651
1652    /// Prefix for CREATE SCHEMA / CREATE NAMESPACE.
1653    fn render_create_schema_prefix(&self, if_not_exists: bool) -> String {
1654        if if_not_exists {
1655            "CREATE SCHEMA IF NOT EXISTS".to_string()
1656        } else {
1657            "CREATE SCHEMA".to_string()
1658        }
1659    }
1660
1661    /// Render a complete CREATE SCHEMA statement.
1662    ///
1663    /// Dialects that need fundamentally different syntax (e.g. T-SQL wrapping
1664    /// in `IF SCHEMA_ID(...) IS NULL EXEC(...)`) should override this method.
1665    /// The default concatenates [`Self::render_create_schema_prefix`] with the name.
1666    fn render_create_schema_statement(&self, name: &str, if_not_exists: bool) -> String {
1667        let prefix = self.render_create_schema_prefix(if_not_exists);
1668        format!("{prefix} {name}")
1669    }
1670
1671    /// Render a table comment (platform-specific syntax).
1672    ///
1673    /// Like [`Self::render_column_comment`], nothing in the tree calls this and
1674    /// no dialect overrides it — **and unlike its sibling it has not been
1675    /// measured.** Read that method's table before wiring either: the ANSI
1676    /// spelling is a hard syntax error on five of the ten platforms razeri
1677    /// renders for at the column level, and this form was not probed.
1678    fn render_table_comment(&self, table: &str, comment: &str) -> Option<String> {
1679        Some(format!("COMMENT ON TABLE {table} IS '{comment}'"))
1680    }
1681
1682    /// Render a column comment — **not wired to anything, and measured**.
1683    ///
1684    /// # Nothing calls this
1685    ///
1686    /// No caller in the tree, no dialect override, and, until measured, no
1687    /// execution against a live engine — the exact state the column `DEFAULT`
1688    /// clause was in when it turned out to be refused outright on four platforms
1689    /// of ten and silently wrong on a fifth. Moving the open
1690    /// interval's meaning here was proposed **on the condition that it be measured first**,
1691    /// because *"a comment that fails to compile is a worse outcome than the
1692    /// clause it replaced"*.
1693    ///
1694    /// # It was measured, on ten platforms, and this ANSI form is right on five
1695    ///
1696    /// Executed against six containers, in-process `DuckDB` and
1697    /// `SQLite`, and both live cloud accounts:
1698    ///
1699    /// | platform | this `COMMENT ON COLUMN` | inline `COMMENT` in `CREATE TABLE` | what it does take |
1700    /// |---|---|---|---|
1701    /// | `PostgreSQL`, Citus | ✅ | ❌ syntax error | this, as a separate statement |
1702    /// | `DuckDB` | ✅ | ❌ syntax error | this, as a separate statement |
1703    /// | Snowflake, Databricks | ✅ | ✅ | either |
1704    /// | `ClickHouse` | ❌ `SYNTAX_ERROR` (code 62) | ✅ | inline, or `ALTER TABLE … COMMENT COLUMN c '…'` |
1705    /// | `MySQL`, `MariaDB` | ❌ `ERROR 1064` | ✅ | inline, or `ALTER TABLE … MODIFY <whole column definition> COMMENT '…'` |
1706    /// | SQL Server | ❌ `Msg 156, Incorrect syntax near the keyword 'ON'` | ❌ `Msg 102` | `EXEC sp_addextendedproperty …` — a stored procedure, not DDL |
1707    /// | `SQLite` | ❌ syntax error | ❌ syntax error | **nothing at all** |
1708    ///
1709    /// Four mechanisms for ten platforms, and two of them carry a hazard the
1710    /// `DEFAULT` clause never had:
1711    ///
1712    /// - `MySQL`'s and `MariaDB`'s only `ALTER` route **redefines the column**.
1713    ///   Measured: a `MODIFY` that did not restate `NOT NULL` left
1714    ///   `is_nullable = YES` behind it. A documentation mechanism that can
1715    ///   silently de-constrain a column is strictly worse than the clause it
1716    ///   replaces.
1717    /// - SQL Server's `sp_addextendedproperty` **is not idempotent**:
1718    ///   `Msg 15233 — Property 'MS_Description' already exists`. Razeri emits
1719    ///   `CREATE TABLE IF NOT EXISTS` so a deploy bundle can be re-applied; a
1720    ///   comment mechanism that fails on the second run takes that away.
1721    ///
1722    /// # So the escape hatch was taken
1723    ///
1724    /// Q1's answer included its own fall-back — *"if the measurement comes back
1725    /// ugly, take the simpler answer: no comment, and the bundle README carries
1726    /// the contract"* — and the measurement is ugly. **Razeri emits no column
1727    /// comment.** The open interval's meaning ships instead in the deploy
1728    /// bundle's generated *write contract*
1729    /// (`razeri_materialize::bundle::write_contract`, Q5), which is prose an
1730    /// operator reads, is right on all ten platforms because no engine parses
1731    /// it, and is owed regardless of how this measurement came out.
1732    ///
1733    /// The hook stays, unchanged and unwired, for the same reason
1734    /// `render_column_default` stays: a dialect that genuinely wants to emit one
1735    /// has somewhere to say so. **A dialect that overrides this owes a
1736    /// measurement first** — the ANSI spelling below is a hard syntax error on
1737    /// five of the ten platforms razeri renders for.
1738    fn render_column_comment(&self, table: &str, column: &str, comment: &str) -> Option<String> {
1739        Some(format!("COMMENT ON COLUMN {table}.{column} IS '{comment}'"))
1740    }
1741
1742    /// Whether to render IF NOT EXISTS on CREATE TABLE.
1743    fn supports_if_not_exists(&self) -> bool {
1744        true
1745    }
1746
1747    /// Render a column's `DEFAULT` clause — **keyword included** — or decline it.
1748    ///
1749    /// `None` means *this dialect renders no default clause for this value*,
1750    /// and Razeri's column renderer omits the whole clause. The ANSI default
1751    /// returns `None` for every value, which
1752    /// is the write-contract rule expressed where the renderer can see it:
1753    /// **razeri emits no
1754    /// column `DEFAULT` clause in rendered DDL, on any platform, for any value —
1755    /// a value the generated load owns is written by the load, never by the
1756    /// schema.**
1757    ///
1758    /// *Read that qualifier deliberately.* The sentence is about the DDL an engine
1759    /// executes. The `.raz.sql` **agnostic interchange** form —
1760    /// `Table::to_ddl()`, which `Table::from_ddl()` parses back — still
1761    /// serializes `Field::default_value` as `DEFAULT <value>`, because that is
1762    /// where a design's declared default survives a save and a load.
1763    ///
1764    /// **That exception is a serializer, not a platform, and the word "agnostic"
1765    /// names both.** `to_ddl()` renders through a free function and consults no
1766    /// dialect; you reach it by calling it, never by choosing a target.
1767    /// `SchemaObject::render_ddl` short-circuits to it only for a renderer whose
1768    /// [`SqlRenderer::is_agnostic_dialect`] answers `true` — which defaults to
1769    /// `false` here and is overridden by exactly one type in the tree,
1770    /// `AnsiDialect`, which no registration hands out. The platform the registry
1771    /// publishes under the name `agnostic` is `AgnosticDialect`; it does **not**
1772    /// override the method, so it declines the clause like every other target.
1773    /// The rule therefore holds on all eleven registered platforms, `agnostic`
1774    /// included, on every rendering path, and a regression test pins it.
1775    ///
1776    /// # Why the keyword lives in here
1777    ///
1778    /// It used to be concatenated by the caller — `parts.push(format!("DEFAULT
1779    /// {rendered}"))` — so the hook could rewrite a value and **could not decline
1780    /// a clause**: a dialect returning `""` emitted a bare dangling `DEFAULT`.
1781    /// This is the same correction made for
1782    /// statement boundaries: *the emission declares the boundary; a consumer
1783    /// never infers it.*
1784    ///
1785    /// # Why the hook survives the decision
1786    ///
1787    /// `Field::default_value` stays on the struct, so the design
1788    /// still knows what a column's intended default is, and a future dialect that
1789    /// genuinely wants to emit one has somewhere to say so. The distinction being
1790    /// bought is between **what razeri knows** and **what razeri emits**.
1791    ///
1792    /// A dialect that overrides this owes the whole clause, keyword and all —
1793    /// `Some(format!("DEFAULT {value}"))` — because there is nowhere else it is
1794    /// added.
1795    fn render_column_default(&self, value: &str) -> Option<String> {
1796        let _ = value;
1797        None
1798    }
1799
1800    /// **Spell an author's OWN declared default in this engine's words.**
1801    ///
1802    /// This is the other sense of "default", and the seam a dialect had no way
1803    /// to reach. [`render_column_default`](Self::render_column_default) governs
1804    /// the tables Razeri's generated load owns, and it declines everywhere by
1805    /// design. A `tile: base` table is the ruled exception: the author owns
1806    /// every column, no generated statement writes into it, and the declared
1807    /// default is an engine constraint they asked for — so it is rendered, on
1808    /// every platform, and it used to be rendered **verbatim**.
1809    ///
1810    /// Verbatim is a portability hole with the design's own words in it. A
1811    /// design declaring `default: CURRENT_TIMESTAMP` is asking for *the current
1812    /// moment*, not for those eighteen characters; on `BigQuery` those
1813    /// characters name the zone-aware type, the column Razeri builds is
1814    /// `DATETIME`, and the `CREATE TABLE` is refused outright — *"Column
1815    /// default expression has type TIMESTAMP which cannot be assigned to column
1816    /// type DATETIME"*. The design was right and had nowhere to be translated.
1817    ///
1818    /// The default returns the value unchanged, which is exactly today's
1819    /// behaviour on every platform, so a dialect that says nothing renders what
1820    /// it always did.
1821    ///
1822    /// # A dialect overriding this owes a measurement, and owes restraint
1823    ///
1824    /// Translate an expression whose *meaning* your engine spells differently.
1825    /// Do not rewrite an author's literal, do not widen a type, and do not
1826    /// silently drop a default you cannot express — an author who declared one
1827    /// and got none has a column that fills with NULL and a document that says
1828    /// otherwise. Where the engine has no equivalent at all, leave the value
1829    /// alone and let the engine refuse it: a loud failure belongs to the value
1830    /// the author wrote, and a quiet substitution belongs to nobody.
1831    ///
1832    /// Parameters:
1833    /// - `value`: the default exactly as the design declares it.
1834    /// - `column_type`: the type of the column it is being assigned to —
1835    ///   load-bearing, because the same expression is legal against one type
1836    ///   and refused against another on the same engine.
1837    fn render_declared_column_default(&self, value: &str, column_type: &DataType) -> String {
1838        let _ = column_type;
1839        value.to_owned()
1840    }
1841
1842    // ═══════════════════════════════════════════════════════════════
1843    // DDL Extensions
1844    // ═══════════════════════════════════════════════════════════════
1845
1846    /// Render a BEGIN transaction statement.
1847    ///
1848    /// `PostgreSQL`: `BEGIN`, `SqlServer`: `BEGIN TRANSACTION`, `ClickHouse`: empty (no DDL transactions)
1849    fn render_begin_transaction(&self) -> &'static str {
1850        "BEGIN"
1851    }
1852
1853    /// Render a COMMIT transaction statement.
1854    fn render_commit(&self) -> &'static str {
1855        "COMMIT"
1856    }
1857
1858    /// Whether the platform supports DDL transactions.
1859    fn supports_ddl_transactions(&self) -> bool {
1860        true
1861    }
1862
1863    /// Render a DROP FUNCTION statement with optional parameter types for overloaded functions.
1864    fn render_drop_function(&self, name: &str, param_types: &[&str], if_exists: bool) -> String {
1865        let exists = if if_exists { " IF EXISTS" } else { "" };
1866        if param_types.is_empty() {
1867            format!("DROP FUNCTION{exists} {name}")
1868        } else {
1869            format!("DROP FUNCTION{exists} {name}({})", param_types.join(", "))
1870        }
1871    }
1872
1873    /// Render the drop keyword for a SQL object type.
1874    fn render_drop_object_keyword(&self, obj_type: &str) -> String {
1875        obj_type.to_uppercase()
1876    }
1877
1878    /// Render the CREATE VIEW keyword/prefix with `secure/global_temp` modifiers.
1879    fn render_create_view_keyword(&self, secure: bool, global_temp: bool) -> String {
1880        let mut parts = vec!["CREATE OR REPLACE"];
1881        if secure {
1882            parts.push("SECURE");
1883        }
1884        if global_temp {
1885            parts.push("GLOBAL TEMPORARY");
1886        }
1887        parts.push("VIEW");
1888        parts.join(" ")
1889    }
1890
1891    /// Render an IF EXISTS clause for ALTER TABLE DROP COLUMN/CONSTRAINT.
1892    ///
1893    /// Some platforms (`SqlServer`, Databricks, `MariaDB`) don't support IF EXISTS in ALTER DROP.
1894    fn supports_alter_drop_if_exists(&self) -> bool {
1895        true
1896    }
1897
1898    // ═══════════════════════════════════════════════════════════════
1899    // Drop Behavior Hooks
1900    // ═══════════════════════════════════════════════════════════════
1901
1902    /// Whether DROP INDEX uses ON syntax: `DROP INDEX idx ON table` (`SqlServer`).
1903    fn drop_index_uses_on_syntax(&self) -> bool {
1904        false
1905    }
1906
1907    /// **Whether this engine checks the constraints it accepts.**
1908    ///
1909    /// The default is [`ConstraintEnforcement::Enforced`] — eight of Razeri's
1910    /// registered platforms, and the safe assumption for a dialect that has not
1911    /// said, because *"this engine guarantees nothing"* is the unusual claim.
1912    ///
1913    /// Answer [`ConstraintEnforcement::DeclaredOnly`] where a `PRIMARY KEY`,
1914    /// `FOREIGN KEY` or `UNIQUE` is accepted and never checked. Two engines are
1915    /// that, in two different ways, and the type carries both:
1916    ///
1917    /// - `BigQuery` has the words. `NOT ENFORCED` is the only legal spelling,
1918    ///   so the keyword goes on the constraint line and the engine makes the
1919    ///   declaration honest by itself.
1920    /// - `Redshift` has no words. It takes all three constraints, checks none,
1921    ///   and renders DDL a reader cannot tell from `PostgreSQL`'s — so the note
1922    ///   is written above the constraint list instead, and it is the only place
1923    ///   that DDL says what it means.
1924    ///
1925    /// [`key_constraint_suffix`](Self::key_constraint_suffix) reads this, so
1926    /// stating enforcement states the suffix too.
1927    fn constraint_enforcement(&self) -> ConstraintEnforcement {
1928        ConstraintEnforcement::Enforced
1929    }
1930
1931    /// **The words a key constraint must carry to be accepted at all.**
1932    ///
1933    /// Appended to a table-level `PRIMARY KEY (…)` and to a
1934    /// `FOREIGN KEY (…) REFERENCES …`. Empty on every engine that enforces its
1935    /// keys, and empty on a declaring engine that has no keyword for it.
1936    ///
1937    /// The default reads
1938    /// [`constraint_enforcement`](Self::constraint_enforcement), so the two are
1939    /// one fact rather than two that must be kept in step. Override this only
1940    /// for a keyword a key constraint needs for some *other* reason than
1941    /// enforcement — there is no such engine in Razeri's set today.
1942    fn key_constraint_suffix(&self) -> &'static str {
1943        self.constraint_enforcement().keyword()
1944    }
1945
1946    /// Whether a table-level `UNIQUE (…)` constraint is part of the grammar.
1947    ///
1948    /// `false` on an engine that has no such constraint at all, where the
1949    /// declaration is left out of the `CREATE TABLE` and named in a comment
1950    /// beside it rather than emitted and refused.
1951    fn supports_unique_constraint(&self) -> bool {
1952        true
1953    }
1954
1955    /// Whether a table-level `CHECK (…)` constraint is part of the grammar.
1956    ///
1957    /// `false` on an engine that has none, with the same treatment as
1958    /// [`supports_unique_constraint`](Self::supports_unique_constraint): named
1959    /// in a comment, never written as SQL the engine will reject.
1960    fn supports_check_constraint(&self) -> bool {
1961        true
1962    }
1963
1964    /// Whether the platform supports CASCADE/RESTRICT in DROP statements.
1965    ///
1966    /// True for `PostgreSQL`, `CitusDB`, `DuckDB`, Snowflake, Agnostic.
1967    /// False for `SqlServer`, `ClickHouse`, Databricks, `MySQL`, `MariaDB`.
1968    fn supports_cascade_drop(&self) -> bool {
1969        true
1970    }
1971
1972    /// Whether `COMMENT ON PROCEDURE` is part of the grammar.
1973    ///
1974    /// `true` almost everywhere, and **false on `Redshift`**, where
1975    /// `COMMENT ON FUNCTION`, `COMMENT ON VIEW` and `COMMENT ON COLUMN` all
1976    /// exist and the procedure form alone does not: *"syntax error at or near
1977    /// `PROCEDURE`"*, measured on a live workgroup. A description is worth
1978    /// having and is not worth a statement that stops the script, so a
1979    /// declining engine simply carries no description on its procedures.
1980    fn supports_procedure_comment(&self) -> bool {
1981        true
1982    }
1983
1984    /// Whether the platform supports function argument types in DROP FUNCTION.
1985    ///
1986    /// False for `ClickHouse` (no overloaded functions).
1987    fn supports_drop_function_arg_types(&self) -> bool {
1988        true
1989    }
1990
1991    /// Whether the platform supports SYNC option for DROP (`ClickHouse`).
1992    fn supports_sync_drop(&self) -> bool {
1993        false
1994    }
1995
1996    /// Whether the platform supports FORCE option for DROP (Databricks).
1997    fn supports_force_drop(&self) -> bool {
1998        false
1999    }
2000
2001    /// Whether the platform supports CASCADE in ALTER TABLE DROP.
2002    ///
2003    /// Only `PostgreSQL`, `CitusDB`, `DuckDB` support CASCADE in ALTER TABLE DROP.
2004    fn supports_alter_drop_cascade(&self) -> bool {
2005        false
2006    }
2007}
2008
2009/// **One row, written once** — the pieces of an INSERT that must do nothing
2010/// when a row already carries the same key.
2011///
2012/// The key value is not a field of its own: it is whichever `values` entry sits
2013/// at the same index as the key column in `columns`. Two fields that must agree
2014/// are two fields free to disagree, and the one they would disagree about here
2015/// is the one that decides whether a second write is a duplicate.
2016#[derive(Debug, Clone, Copy)]
2017pub struct InsertIfAbsent<'a> {
2018    /// The target table, already spelled the way the caller wants it written —
2019    /// schema-qualified or bare.
2020    pub table: &'a str,
2021    /// The columns being written, in the order `values` supplies them.
2022    pub columns: &'a [&'a str],
2023    /// One value expression per column.
2024    pub values: &'a [String],
2025    /// The columns whose equality means *this row is already here*.
2026    pub key_columns: &'a [&'a str],
2027}
2028
2029impl InsertIfAbsent<'_> {
2030    /// The value expression written into `column`, if it is being written.
2031    #[must_use]
2032    pub fn value_of(&self, column: &str) -> Option<&str> {
2033        let at = self.columns.iter().position(|name| *name == column)?;
2034        self.values.get(at).map(String::as_str)
2035    }
2036
2037    /// `key = value AND …` — the test for *already here*, in terms of the
2038    /// values this INSERT would have written.
2039    ///
2040    /// `qualifier` prefixes the column side, which the guarded form needs so
2041    /// the probe's own row is named unambiguously.
2042    ///
2043    /// # Panics
2044    ///
2045    /// When a key column is not among the columns being written. A key the
2046    /// INSERT does not supply cannot be tested for, and silently dropping it
2047    /// from the predicate would make the guard match everything.
2048    #[must_use]
2049    pub fn key_predicate(&self, qualifier: &str) -> String {
2050        self.key_columns
2051            .iter()
2052            .map(|column| {
2053                let value = self
2054                    .value_of(column)
2055                    .unwrap_or_else(|| panic!("{column} is a key column and must be written"));
2056                format!("{qualifier}{column} = {value}")
2057            })
2058            .collect::<Vec<_>>()
2059            .join(" AND ")
2060    }
2061
2062    /// **`ON CONFLICT (key) DO NOTHING`** — for the platforms that let the
2063    /// engine decide, which is every platform that has the clause.
2064    ///
2065    /// The engine tests the key as it writes, so two sessions registering one
2066    /// file at the same moment settle on one row rather than on whichever of
2067    /// them looked first.
2068    #[must_use]
2069    pub fn on_conflict_do_nothing(&self) -> String {
2070        format!(
2071            "{}\n{}\nON CONFLICT ({}) DO NOTHING;",
2072            self.target(),
2073            self.values_clause(),
2074            self.key_columns.join(", ")
2075        )
2076    }
2077
2078    /// **`ON DUPLICATE KEY UPDATE key = key`** — the `MySQL` family's no-op.
2079    ///
2080    /// `INSERT IGNORE` would be shorter and it is not the same request: it
2081    /// downgrades *every* error on the statement to a warning — a truncated
2082    /// value, a bad date — so a row that should have been refused arrives
2083    /// mangled and silent. Assigning the key to itself touches only the
2084    /// collision this is about, and leaves everything else to complain
2085    /// normally.
2086    #[must_use]
2087    pub fn on_duplicate_key_no_op(&self) -> String {
2088        let held = self
2089            .key_columns
2090            .iter()
2091            .map(|column| format!("{column} = {column}"))
2092            .collect::<Vec<_>>()
2093            .join(", ");
2094        format!("{}\n{}\nON DUPLICATE KEY UPDATE {held};", self.target(), self.values_clause())
2095    }
2096
2097    /// **The guarded form over an explicit one-row source** — the same
2098    /// `INSERT … SELECT … WHERE NOT EXISTS` the portable default writes, with a
2099    /// `FROM` clause under it.
2100    ///
2101    /// `GoogleSQL` refuses a `WHERE` on a query that selects from nothing —
2102    /// *"Query without FROM clause cannot have a WHERE clause"*, measured on the
2103    /// live service on every generated `register_file` procedure — while
2104    /// `PostgreSQL` and its cousins accept the bare form. `(SELECT 1)` is a
2105    /// one-row table that changes no result: the guard still decides whether
2106    /// the row is written, and the values are still the caller's.
2107    ///
2108    /// It stays a separate form rather than becoming the default because the
2109    /// engines that need no `FROM` read better without one, and a clause every
2110    /// platform carries for one platform's sake is how a rendering stops saying
2111    /// what it means.
2112    #[must_use]
2113    pub fn guarded_over_one_row(&self) -> String {
2114        format!(
2115            "{}\nSELECT {}\nFROM (SELECT 1)\nWHERE NOT EXISTS (SELECT 1 FROM {} WHERE {});",
2116            self.target(),
2117            self.values.join(", "),
2118            self.table,
2119            self.key_predicate("")
2120        )
2121    }
2122
2123    /// `INSERT INTO t (a, b)` — shared by every form below.
2124    fn target(&self) -> String {
2125        format!("INSERT INTO {} ({})", self.table, self.columns.join(", "))
2126    }
2127
2128    /// `VALUES (…)`.
2129    fn values_clause(&self) -> String {
2130        format!("VALUES ({})", self.values.join(", "))
2131    }
2132}
2133
2134/// Level 4 — DML rendering with reasonable defaults.
2135pub trait DmlRenderer: SqlRenderer {
2136    /// Prefix for INSERT statements.
2137    fn render_insert_prefix(&self) -> &'static str {
2138        "INSERT INTO"
2139    }
2140
2141    /// **Write one row, and do nothing if its key is already there.**
2142    ///
2143    /// Every platform can express this and they do not agree on how, so the
2144    /// spelling belongs to the dialect and not to the caller. The default is
2145    /// the portable one — an `INSERT … SELECT` guarded by `WHERE NOT EXISTS` —
2146    /// which needs no upsert syntax at all and is therefore the right answer
2147    /// for a platform nobody has written an arm for. Platforms with a native
2148    /// idiom override it: `ON CONFLICT … DO NOTHING` where that exists,
2149    /// `ON DUPLICATE KEY UPDATE` on the `MySQL` family.
2150    ///
2151    /// **No dialect is left without an idempotent form.** The guarded form is
2152    /// weaker than the native ones under concurrency — two sessions can both
2153    /// find the row absent and both insert — which is why a platform that can
2154    /// let the engine decide should, and why this one leans on the key's own
2155    /// uniqueness constraint to catch the race rather than pretending it cannot
2156    /// happen. On an engine that enforces no key at all the guard is the whole
2157    /// of what there is, and it is worth saying so rather than implying more.
2158    fn render_insert_if_absent(&self, insert: &InsertIfAbsent<'_>) -> String {
2159        format!(
2160            "{}\nSELECT {}\nWHERE NOT EXISTS (SELECT 1 FROM {} WHERE {});",
2161            insert.target(),
2162            insert.values.join(", "),
2163            insert.table,
2164            insert.key_predicate("")
2165        )
2166    }
2167
2168    /// Prefix for MERGE statements.
2169    fn render_merge_prefix(&self) -> &'static str {
2170        "MERGE INTO"
2171    }
2172
2173    /// Render the platform's upsert strategy keyword.
2174    ///
2175    /// Returns `None` if platform doesn't support upsert natively.
2176    fn render_upsert_strategy(&self) -> Option<&str> {
2177        None
2178    }
2179
2180    /// Render RETURNING / OUTPUT clause for INSERT/UPDATE.
2181    fn render_returning_clause(&self, _columns: &[&str]) -> Option<String> {
2182        None
2183    }
2184
2185    /// Render a LIMIT clause.
2186    fn render_limit_clause(&self, n: usize) -> String {
2187        format!("LIMIT {n}")
2188    }
2189
2190    /// Render a temporary table prefix or keyword.
2191    fn render_temp_table_prefix(&self) -> &'static str {
2192        "TEMPORARY"
2193    }
2194
2195    /// **One row holding an array becomes one row per element.**
2196    ///
2197    /// Razeri hands over the relation it is reading, the array column, and the
2198    /// element fields the statement needs; the engine answers with the `FROM`
2199    /// item that produces the rows and the expressions that read them. The
2200    /// three parts come back together because on at least one engine they
2201    /// depend on each other: its field expressions name an alias its own
2202    /// `FROM` item introduced.
2203    ///
2204    /// **The ordinal is one for the first element, on every engine.** Engines
2205    /// disagree about where an array starts — some count from one, some from
2206    /// zero, one answers in text — and the element's surrogate key is derived
2207    /// from its position. An engine answering in its own base would give one
2208    /// element two different keys depending on where it was stored, so the
2209    /// normalization belongs here, where the engine that counts from zero pays
2210    /// for it with one addition.
2211    ///
2212    /// `None` — the default — is this engine stating no flatten. Razeri then
2213    /// refuses the declaration and names the engine, rather than guessing an
2214    /// idiom or emitting a statement that does not run.
2215    fn render_flatten(&self, _request: &FlattenRequest<'_>) -> Option<Flatten> {
2216        None
2217    }
2218}
2219
2220/// Level 5 — Stored procedure / function rendering with defaults.
2221pub trait ProcedureRenderer: SqlRenderer {
2222    /// Prefix for CREATE PROCEDURE.
2223    fn render_create_procedure_prefix(&self) -> &'static str {
2224        "CREATE OR REPLACE PROCEDURE"
2225    }
2226
2227    /// Prefix for CREATE FUNCTION.
2228    fn render_create_function_prefix(&self) -> &'static str {
2229        "CREATE OR REPLACE FUNCTION"
2230    }
2231
2232    /// Render a variable declaration inside a procedure body.
2233    fn render_variable_declaration(&self, name: &str, dt: &DataType) -> String {
2234        format!("DECLARE {} {};", name, self.render_data_type(dt))
2235    }
2236
2237    /// Render BEGIN/END block delimiters.
2238    fn render_begin_end(&self, body: &str) -> String {
2239        format!("BEGIN\n{body}\nEND;")
2240    }
2241
2242    /// Whether procedures use a language clause (e.g., Snowflake JavaScript).
2243    fn requires_language_clause(&self) -> bool {
2244        false
2245    }
2246}
2247
2248#[cfg(test)]
2249mod tests {
2250    use super::*;
2251    use crate::DialectCapabilities;
2252    use crate::sid_spelling::SidHelperLanguage;
2253
2254    /// A test dialect that implements only the required `SqlRenderer` methods.
2255    /// All other traits use defaults.
2256    struct TestDialect;
2257
2258    impl SqlRenderer for TestDialect {
2259        fn render_data_type(&self, dt: &DataType) -> String {
2260            match dt {
2261                DataType::Boolean(_) => "BOOLEAN".to_string(),
2262                DataType::Integer(_) => "INTEGER".to_string(),
2263                _ => "TEXT".to_string(),
2264            }
2265        }
2266        fn quote_identifier(&self, name: &str) -> String {
2267            format!("\"{name}\"")
2268        }
2269        fn qualify_name(&self, schema: Option<&str>, name: &str) -> String {
2270            match schema {
2271                Some(s) => format!("{}.{}", self.quote_identifier(s), self.quote_identifier(name)),
2272                None => self.quote_identifier(name),
2273            }
2274        }
2275        fn render_current_timestamp(&self) -> String {
2276            "CURRENT_TIMESTAMP".to_string()
2277        }
2278    }
2279
2280    impl ExpressionRenderer for TestDialect {}
2281    impl DdlRenderer for TestDialect {}
2282    impl DmlRenderer for TestDialect {}
2283    impl ProcedureRenderer for TestDialect {}
2284    impl DialectCapabilities for TestDialect {}
2285
2286    /// The same dialect with the two file-and-key facts stated. It exists to
2287    /// prove that a dialect Razeri never compiled against reaches the behaviour
2288    /// by *declaring* it — which is the whole property, and is not visible from
2289    /// a dialect that ships in this tree.
2290    struct StatedDialect;
2291
2292    impl SqlRenderer for StatedDialect {
2293        fn render_data_type(&self, _dt: &DataType) -> String {
2294            "TEXT".to_string()
2295        }
2296        fn quote_identifier(&self, name: &str) -> String {
2297            format!("\"{name}\"")
2298        }
2299        fn qualify_name(&self, _schema: Option<&str>, name: &str) -> String {
2300            self.quote_identifier(name)
2301        }
2302        fn render_current_timestamp(&self) -> String {
2303            "CURRENT_TIMESTAMP".to_string()
2304        }
2305        fn sid_helper_body(&self) -> Option<SidHelperBody> {
2306            Some(SidHelperBody {
2307                language: SidHelperLanguage::Named("ecmascript"),
2308                body: "return 1;",
2309            })
2310        }
2311        fn delimited_file_relation(&self, path_literal: &str) -> Option<String> {
2312            Some(format!("SCAN({path_literal})"))
2313        }
2314    }
2315
2316    /// **Silence is the default, and silence means Razeri composes.**
2317    ///
2318    /// Both facts are opt-in: a dialect that says nothing gets the SQL
2319    /// derivation for its key and no generated staging fill at all. Neither
2320    /// default may become a guess — a composed body on an engine with no hash
2321    /// keys a warehouse to a number nothing reproduces, and an invented file
2322    /// relation fails the load on its first statement.
2323    #[test]
2324    fn a_dialect_that_states_neither_fact_is_asked_for_nothing() {
2325        let d: &dyn SqlRenderer = &TestDialect;
2326        assert_eq!(d.sid_helper_body(), None);
2327        assert_eq!(d.delimited_file_relation("'/data/x.csv'"), None);
2328    }
2329
2330    /// And a dialect that states them is heard through the trait object, which
2331    /// is the only way Razeri ever holds one.
2332    #[test]
2333    fn a_dialect_that_states_them_is_heard_through_the_trait_object() {
2334        let d: &dyn SqlRenderer = &StatedDialect;
2335        assert_eq!(
2336            d.sid_helper_body(),
2337            Some(SidHelperBody {
2338                language: SidHelperLanguage::Named("ecmascript"),
2339                body: "return 1;",
2340            })
2341        );
2342        assert_eq!(
2343            d.delimited_file_relation("'/data/x.csv'").as_deref(),
2344            Some("SCAN('/data/x.csv')")
2345        );
2346    }
2347
2348    #[test]
2349    fn sql_renderer_core_methods_work() {
2350        let d = TestDialect;
2351        assert_eq!(d.render_data_type(&DataType::boolean()), "BOOLEAN");
2352        assert_eq!(d.quote_identifier("users"), "\"users\"");
2353        assert_eq!(d.qualify_name(Some("public"), "users"), "\"public\".\"users\"");
2354        assert_eq!(d.render_current_timestamp(), "CURRENT_TIMESTAMP");
2355    }
2356
2357    #[test]
2358    fn dialect_name_returns_ansi_by_default() {
2359        let d = TestDialect;
2360        assert_eq!(d.dialect_name(), "ansi");
2361    }
2362
2363    #[test]
2364    fn expression_renderer_defaults_produce_ansi_sql() {
2365        let d = TestDialect;
2366        assert_eq!(d.render_cast("age", &DataType::int()), "CAST(age AS INTEGER)");
2367        assert_eq!(d.render_concat(&["a".into(), "b".into()]), "CONCAT(a, b)");
2368        assert_eq!(d.render_coalesce(&["x".into(), "y".into()]), "COALESCE(x, y)");
2369    }
2370
2371    #[test]
2372    fn ddl_renderer_defaults_produce_ansi_sql() {
2373        let d = TestDialect;
2374        assert_eq!(d.render_create_table_prefix(), "CREATE TABLE");
2375        assert_eq!(d.render_create_view_prefix(), "CREATE OR REPLACE VIEW");
2376        assert_eq!(
2377            d.render_column_definition("name", &DataType::boolean(), false),
2378            "\"name\" BOOLEAN NOT NULL"
2379        );
2380        assert_eq!(d.render_column_definition("age", &DataType::int(), true), "\"age\" INTEGER");
2381    }
2382
2383    #[test]
2384    fn dml_renderer_defaults_produce_ansi_sql() {
2385        let d = TestDialect;
2386        assert_eq!(d.render_insert_prefix(), "INSERT INTO");
2387        assert_eq!(d.render_merge_prefix(), "MERGE INTO");
2388        assert_eq!(d.render_limit_clause(10), "LIMIT 10");
2389        assert!(d.render_upsert_strategy().is_none());
2390        assert!(d.render_returning_clause(&["id"]).is_none());
2391    }
2392
2393    #[test]
2394    fn procedure_renderer_defaults_produce_ansi_sql() {
2395        let d = TestDialect;
2396        assert_eq!(d.render_create_procedure_prefix(), "CREATE OR REPLACE PROCEDURE");
2397        assert_eq!(
2398            d.render_variable_declaration("v_count", &DataType::int()),
2399            "DECLARE v_count INTEGER;"
2400        );
2401        assert!(!d.requires_language_clause());
2402    }
2403
2404    #[test]
2405    fn trait_hierarchy_allows_selective_override() {
2406        struct MySqlLike;
2407        impl SqlRenderer for MySqlLike {
2408            fn render_data_type(&self, _: &DataType) -> String {
2409                "INT".into()
2410            }
2411            fn quote_identifier(&self, name: &str) -> String {
2412                format!("`{name}`")
2413            }
2414            fn qualify_name(&self, schema: Option<&str>, name: &str) -> String {
2415                match schema {
2416                    Some(s) => format!("`{s}`.`{name}`"),
2417                    None => format!("`{name}`"),
2418                }
2419            }
2420            fn render_current_timestamp(&self) -> String {
2421                "NOW()".into()
2422            }
2423        }
2424        impl ExpressionRenderer for MySqlLike {
2425            fn render_concat(&self, parts: &[String]) -> String {
2426                format!("CONCAT({})", parts.join(", "))
2427            }
2428        }
2429        impl DdlRenderer for MySqlLike {}
2430        impl DmlRenderer for MySqlLike {}
2431        impl ProcedureRenderer for MySqlLike {}
2432        impl DialectCapabilities for MySqlLike {}
2433
2434        let d = MySqlLike;
2435        assert_eq!(d.quote_identifier("users"), "`users`");
2436        assert_eq!(d.render_current_timestamp(), "NOW()");
2437        // DDL defaults still work even though we only overrode expressions
2438        assert_eq!(d.render_create_table_prefix(), "CREATE TABLE");
2439    }
2440
2441    #[test]
2442    fn sql_renderer_expression_extensions_produce_ansi_defaults() {
2443        let d = TestDialect;
2444        assert_sql_renderer_literal_defaults(&d);
2445        assert_sql_renderer_parameter_and_merge_defaults(&d);
2446        assert_sql_renderer_update_insert_defaults(&d);
2447        assert_sql_renderer_partition_and_window_defaults(&d);
2448    }
2449
2450    /// Assert ANSI defaults for literal, date/time, and basic expression hooks.
2451    /// Parameters:
2452    /// - dialect: Renderer under test.
2453    fn assert_sql_renderer_literal_defaults(dialect: &TestDialect) {
2454        assert_eq!(dialect.render_boolean_literal(true), "TRUE");
2455        assert_eq!(dialect.render_boolean_literal(false), "FALSE");
2456        assert_eq!(dialect.render_date_literal("2024-01-15"), "DATE '2024-01-15'");
2457        assert_eq!(
2458            dialect.render_timestamp_literal("2024-01-15 12:00:00"),
2459            "TIMESTAMP '2024-01-15 12:00:00'"
2460        );
2461        assert_eq!(dialect.render_interval_literal("1 year"), "INTERVAL '1 year'");
2462        assert_eq!(dialect.render_current_date(), "CURRENT_DATE");
2463        assert_eq!(dialect.concat_operator(), "||");
2464        assert_eq!(dialect.render_nan_literal(&DataType::float()), "NULL");
2465        assert_eq!(dialect.render_infinity_literal(true, &DataType::float()), "NULL");
2466        assert_eq!(dialect.ifnull_function_name(), "COALESCE");
2467        assert_eq!(
2468            dialect.render_iif("x > 0", "pos", "neg"),
2469            "CASE WHEN x > 0 THEN pos ELSE neg END"
2470        );
2471        assert_eq!(
2472            dialect.render_date_trunc("month", "created_at"),
2473            "DATE_TRUNC('month', created_at)"
2474        );
2475        assert_eq!(
2476            dialect.render_date_extract("year", "created_at"),
2477            "EXTRACT(year FROM created_at)"
2478        );
2479        assert_eq!(dialect.render_try_cast("age", &DataType::int()), "TRY_CAST(age AS INTEGER)");
2480    }
2481
2482    /// Assert ANSI defaults for parameter and merge-related extension hooks.
2483    /// Parameters:
2484    /// - dialect: Renderer under test.
2485    fn assert_sql_renderer_parameter_and_merge_defaults(dialect: &TestDialect) {
2486        assert_eq!(dialect.render_parameter_placeholder(1), "$1");
2487        assert_eq!(dialect.render_named_parameter("user_id"), ":user_id");
2488        assert_eq!(SqlRenderer::merge_not_matched_keyword(dialect), "WHEN NOT MATCHED");
2489        assert!(!SqlRenderer::supports_merge_not_matched_by_source(dialect));
2490        assert!(SqlRenderer::merge_supported(dialect));
2491        assert!(!SqlRenderer::merge_supports_schema_evolution_keyword(dialect));
2492        assert!(!SqlRenderer::merge_supports_table_hints(dialect));
2493        assert!(!SqlRenderer::merge_uses_output_clause(dialect));
2494        assert!(!SqlRenderer::merge_supports_returning_clause(dialect));
2495        assert_eq!(dialect.schema_separator(), ".");
2496        assert_eq!(dialect.statement_separator(), ";\n");
2497    }
2498
2499    /// Assert ANSI defaults for update and insert behavior extension hooks.
2500    /// Parameters:
2501    /// - dialect: Renderer under test.
2502    fn assert_sql_renderer_update_insert_defaults(dialect: &TestDialect) {
2503        assert!(!SqlRenderer::supports_compound_assignment(dialect));
2504        assert!(!SqlRenderer::supports_update_from(dialect));
2505        assert!(!SqlRenderer::uses_alter_table_update(dialect));
2506        // How a mutation is SPELLED and what it may LOOK AT are
2507        // two facts, and the ANSI default is that a mutation may correlate.
2508        assert!(!SqlRenderer::mutation_reads_only_its_own_rows(dialect));
2509        assert!(!dialect.update_supports_top_clause());
2510        assert!(!dialect.update_supports_table_hints());
2511        assert!(!dialect.update_uses_output_clause());
2512        assert!(!dialect.update_supports_returning());
2513        assert!(!dialect.insert_uses_output_clause());
2514        assert!(!dialect.insert_supports_returning());
2515        assert!(!dialect.insert_supports_table_hints());
2516        assert!(!SqlRenderer::supports_insert_overwrite(dialect));
2517        assert!(!SqlRenderer::supports_on_conflict(dialect));
2518        assert!(!dialect.supports_overriding_clause());
2519        assert_eq!(dialect.returning_clause_keyword(), "RETURNING");
2520        assert!(!SqlRenderer::supports_returning_into(dialect));
2521        assert!(!SqlRenderer::supports_multi_table_insert(dialect));
2522    }
2523
2524    /// Assert ANSI defaults for partitioning, generated columns, and window hooks.
2525    /// Parameters:
2526    /// - dialect: Renderer under test.
2527    fn assert_sql_renderer_partition_and_window_defaults(dialect: &TestDialect) {
2528        assert_eq!(
2529            dialect.render_time_partition_expr("event_ts", "monthly"),
2530            "date_trunc('month', event_ts)"
2531        );
2532        assert_eq!(dialect.render_partition_clause("event_ts"), "PARTITION BY (event_ts)");
2533        assert_eq!(
2534            dialect.render_generated_column("event_month", "DATE_TRUNC('month', event_ts)"),
2535            "event_month GENERATED ALWAYS AS (DATE_TRUNC('month', event_ts)) STORED"
2536        );
2537        assert!(!SqlRenderer::supports_window_frame_exclude(dialect));
2538        assert!(!SqlRenderer::supports_window_frame_groups(dialect));
2539        assert!(SqlRenderer::supports_named_windows(dialect));
2540    }
2541
2542    #[test]
2543    fn ddl_renderer_extensions_produce_ansi_defaults() {
2544        let d = TestDialect;
2545        assert_ddl_renderer_transaction_and_view_defaults(&d);
2546        assert_ddl_renderer_drop_defaults(&d);
2547    }
2548
2549    /// Assert ANSI DDL defaults for transaction and view keyword hooks.
2550    /// Parameters:
2551    /// - dialect: Renderer under test.
2552    fn assert_ddl_renderer_transaction_and_view_defaults(dialect: &TestDialect) {
2553        assert_eq!(dialect.render_begin_transaction(), "BEGIN");
2554        assert_eq!(dialect.render_commit(), "COMMIT");
2555        assert!(dialect.supports_ddl_transactions());
2556        assert_eq!(dialect.render_create_view_keyword(false, false), "CREATE OR REPLACE VIEW");
2557        assert_eq!(
2558            dialect.render_create_view_keyword(true, false),
2559            "CREATE OR REPLACE SECURE VIEW"
2560        );
2561        assert!(dialect.supports_alter_drop_if_exists());
2562    }
2563
2564    /// Assert ANSI DDL defaults for drop-related behavior hooks.
2565    /// Parameters:
2566    /// - dialect: Renderer under test.
2567    fn assert_ddl_renderer_drop_defaults(dialect: &TestDialect) {
2568        assert_eq!(dialect.render_drop_object_keyword("table"), "TABLE");
2569        assert_eq!(
2570            dialect.render_drop_function("my_func", &[], true),
2571            "DROP FUNCTION IF EXISTS my_func"
2572        );
2573        assert!(!dialect.drop_index_uses_on_syntax());
2574        assert!(DdlRenderer::supports_cascade_drop(dialect));
2575        assert!(dialect.supports_drop_function_arg_types());
2576        assert!(!DdlRenderer::supports_sync_drop(dialect));
2577        assert!(!DdlRenderer::supports_force_drop(dialect));
2578        assert!(!dialect.supports_alter_drop_cascade());
2579    }
2580
2581    /// **The one statement every engine takes**, written for a dialect that
2582    /// answered nothing. A plugin author gets the commonest evolution there is
2583    /// without writing a line for it.
2584    #[test]
2585    fn a_dialect_that_answers_nothing_still_adds_a_column() {
2586        let data_type = DataType::boolean();
2587        let written = TestDialect.render_column_evolution(&ColumnEvolution::AddColumn {
2588            schema: Some("telemetry_core"),
2589            table: "clients_daily",
2590            column: "is_default_browser",
2591            data_type: &data_type,
2592        });
2593        assert_eq!(
2594            written.as_deref(),
2595            Some(
2596                r#"ALTER TABLE "telemetry_core"."clients_daily" ADD COLUMN "is_default_browser" BOOLEAN"#
2597            )
2598        );
2599    }
2600
2601    /// Everything else waits to be spelled. A default picked from one engine's
2602    /// grammar is a statement the others reject, handed to an operator who
2603    /// finds that out against their own warehouse.
2604    #[test]
2605    fn nothing_else_is_spelled_until_a_dialect_spells_it() {
2606        let data_type = DataType::text();
2607        assert!(
2608            TestDialect
2609                .render_column_evolution(&ColumnEvolution::WidenColumn {
2610                    schema: None,
2611                    table: "t",
2612                    column: "c",
2613                    data_type: &data_type,
2614                })
2615                .is_none()
2616        );
2617        assert!(
2618            TestDialect
2619                .render_column_evolution(&ColumnEvolution::AddNestedField {
2620                    schema: None,
2621                    table: "t",
2622                    column: "c",
2623                    field: "f",
2624                    data_type: &data_type,
2625                })
2626                .is_none()
2627        );
2628    }
2629}