Skip to main content

scythe_codegen/backends/
csharp_microsoft_sqlite.rs

1use std::fmt::Write;
2use std::path::Path;
3
4use scythe_backend::manifest::{BackendManifest, load_manifest};
5use scythe_backend::naming::{
6    enum_type_name, enum_variant_name, fn_name, row_struct_name, to_pascal_case,
7};
8use scythe_backend::types::resolve_type;
9
10use scythe_core::analyzer::{AnalyzedQuery, CompositeInfo, EnumInfo};
11use scythe_core::errors::{ErrorCode, ScytheError};
12use scythe_core::parser::QueryCommand;
13
14use crate::backend_trait::{CodegenBackend, ResolvedColumn, ResolvedParam};
15
16const DEFAULT_MANIFEST_TOML: &str = include_str!("../../manifests/csharp-microsoft-sqlite.toml");
17
18pub struct CsharpMicrosoftSqliteBackend {
19    manifest: BackendManifest,
20}
21
22impl CsharpMicrosoftSqliteBackend {
23    pub fn new(engine: &str) -> Result<Self, ScytheError> {
24        match engine {
25            "sqlite" | "sqlite3" => {}
26            _ => {
27                return Err(ScytheError::new(
28                    ErrorCode::InternalError,
29                    format!(
30                        "csharp-microsoft-sqlite only supports SQLite, got engine '{}'",
31                        engine
32                    ),
33                ));
34            }
35        }
36        let manifest_path = Path::new("backends/csharp-microsoft-sqlite/manifest.toml");
37        let manifest = if manifest_path.exists() {
38            load_manifest(manifest_path)
39                .map_err(|e| ScytheError::new(ErrorCode::InternalError, format!("manifest: {e}")))?
40        } else {
41            toml::from_str(DEFAULT_MANIFEST_TOML)
42                .map_err(|e| ScytheError::new(ErrorCode::InternalError, format!("manifest: {e}")))?
43        };
44        Ok(Self { manifest })
45    }
46}
47
48/// Map a neutral type to a SqliteDataReader method.
49fn reader_method(neutral_type: &str) -> &'static str {
50    match neutral_type {
51        "bool" => "GetBoolean",
52        "int16" => "GetInt16",
53        "int32" => "GetInt32",
54        "int64" => "GetInt64",
55        "float32" => "GetFloat",
56        "float64" => "GetDouble",
57        "string" | "json" | "inet" | "interval" | "uuid" | "date" | "time" | "time_tz"
58        | "datetime_tz" => "GetString",
59        "decimal" => "GetDouble",
60        "datetime" => "GetDateTime",
61        _ => "GetValue",
62    }
63}
64
65/// Rewrite $1, $2, ... to $p1, $p2, ...
66fn rewrite_params(sql: &str) -> String {
67    let mut result = sql.to_string();
68    for i in (1..=99).rev() {
69        let from = format!("${}", i);
70        let to = format!("$p{}", i);
71        result = result.replace(&from, &to);
72    }
73    result
74}
75
76/// Build the expression to read a column from SqliteDataReader.
77fn column_read_expr(col: &ResolvedColumn, ordinal: usize) -> String {
78    if col.neutral_type.starts_with("enum::") {
79        format!(
80            "(Enum.TryParse<{typ}>(reader.GetString({ord}), true, out var enumVal{ord}) ? enumVal{ord} : throw new InvalidOperationException($\"Invalid enum value '{{reader.GetString({ord})}}' for {typ}\"))",
81            typ = col.lang_type,
82            ord = ordinal
83        )
84    } else {
85        let method = reader_method(&col.neutral_type);
86        format!("reader.{}({})", method, ordinal)
87    }
88}
89
90impl CodegenBackend for CsharpMicrosoftSqliteBackend {
91    fn name(&self) -> &str {
92        "csharp-microsoft-sqlite"
93    }
94
95    fn manifest(&self) -> &scythe_backend::manifest::BackendManifest {
96        &self.manifest
97    }
98
99    fn supported_engines(&self) -> &[&str] {
100        &["sqlite"]
101    }
102
103    fn file_header(&self) -> String {
104        "// Auto-generated by scythe. Do not edit.\nusing System.Threading.Tasks;\nusing Microsoft.Data.Sqlite;\n\npublic static class Queries {"
105            .to_string()
106    }
107
108    fn file_footer(&self) -> String {
109        "}".to_string()
110    }
111
112    fn generate_row_struct(
113        &self,
114        query_name: &str,
115        columns: &[ResolvedColumn],
116    ) -> Result<String, ScytheError> {
117        let struct_name = row_struct_name(query_name, &self.manifest.naming);
118        let mut out = String::new();
119        let _ = writeln!(out, "public record {}(", struct_name);
120        for (i, c) in columns.iter().enumerate() {
121            let field = to_pascal_case(&c.field_name);
122            let sep = if i + 1 < columns.len() { "," } else { "" };
123            let _ = writeln!(out, "    {} {}{}", c.full_type, field, sep);
124        }
125        let _ = write!(out, ");");
126        Ok(out)
127    }
128
129    fn generate_model_struct(
130        &self,
131        table_name: &str,
132        columns: &[ResolvedColumn],
133    ) -> Result<String, ScytheError> {
134        let name = to_pascal_case(table_name);
135        self.generate_row_struct(&name, columns)
136    }
137
138    fn generate_query_fn(
139        &self,
140        analyzed: &AnalyzedQuery,
141        struct_name: &str,
142        columns: &[ResolvedColumn],
143        params: &[ResolvedParam],
144    ) -> Result<String, ScytheError> {
145        let func_name = fn_name(&analyzed.name, &self.manifest.naming);
146        let sql = rewrite_params(&super::clean_sql_oneline_with_optional(
147            &analyzed.sql,
148            &analyzed.optional_params,
149            &analyzed.params,
150        ));
151        let mut out = String::new();
152
153        let param_list = params
154            .iter()
155            .map(|p| format!("{} {}", p.full_type, p.field_name))
156            .collect::<Vec<_>>()
157            .join(", ");
158        let sep = if param_list.is_empty() { "" } else { ", " };
159
160        // Handle :batch separately
161        if matches!(analyzed.command, QueryCommand::Batch) {
162            let batch_fn_name = format!("{}Batch", func_name);
163            if params.len() > 1 {
164                let params_record_name = format!("{}BatchParams", to_pascal_case(&analyzed.name));
165                let _ = writeln!(out, "public record {}(", params_record_name);
166                for (i, p) in params.iter().enumerate() {
167                    let field = to_pascal_case(&p.field_name);
168                    let sep = if i + 1 < params.len() { "," } else { "" };
169                    let _ = writeln!(out, "    {} {}{}", p.full_type, field, sep);
170                }
171                let _ = writeln!(out, ");");
172                let _ = writeln!(out);
173                let _ = writeln!(
174                    out,
175                    "public static async Task {}(SqliteConnection conn, List<{}> items) {{",
176                    batch_fn_name, params_record_name
177                );
178            } else if params.len() == 1 {
179                let _ = writeln!(
180                    out,
181                    "public static async Task {}(SqliteConnection conn, List<{}> items) {{",
182                    batch_fn_name, params[0].full_type
183                );
184            } else {
185                let _ = writeln!(
186                    out,
187                    "public static async Task {}(SqliteConnection conn, int count) {{",
188                    batch_fn_name
189                );
190            }
191            let _ = writeln!(
192                out,
193                "    await using var tx = await conn.BeginTransactionAsync();"
194            );
195            let _ = writeln!(out, "    try {{");
196            if params.is_empty() {
197                let _ = writeln!(out, "        for (int i = 0; i < count; i++) {{");
198            } else {
199                let _ = writeln!(out, "        foreach (var item in items) {{");
200            }
201            let _ = writeln!(
202                out,
203                "            await using var cmd = new SqliteCommand(\"{}\", conn, (SqliteTransaction)tx);",
204                sql
205            );
206            for (i, p) in params.iter().enumerate() {
207                let value_expr = if params.len() > 1 {
208                    let field = to_pascal_case(&p.field_name);
209                    format!("item.{}", field)
210                } else {
211                    "item".to_string()
212                };
213                let _ = writeln!(
214                    out,
215                    "            cmd.Parameters.AddWithValue(\"$p{}\", {});",
216                    i + 1,
217                    value_expr
218                );
219            }
220            let _ = writeln!(out, "            await cmd.ExecuteNonQueryAsync();");
221            let _ = writeln!(out, "        }}");
222            let _ = writeln!(out, "        await tx.CommitAsync();");
223            let _ = writeln!(out, "    }} catch {{");
224            let _ = writeln!(out, "        await tx.RollbackAsync();");
225            let _ = writeln!(out, "        throw;");
226            let _ = writeln!(out, "    }}");
227            let _ = write!(out, "}}");
228            return Ok(out);
229        }
230
231        let return_type = match &analyzed.command {
232            QueryCommand::One => format!("{}?", struct_name),
233            QueryCommand::Many => {
234                format!("List<{}>", struct_name)
235            }
236            QueryCommand::Exec => "void".to_string(),
237            QueryCommand::ExecResult | QueryCommand::ExecRows => "int".to_string(),
238            QueryCommand::Batch => unreachable!(),
239        };
240
241        let is_async_void = return_type == "void";
242        let task_type = if is_async_void {
243            "Task".to_string()
244        } else {
245            format!("Task<{}>", return_type)
246        };
247
248        let _ = writeln!(
249            out,
250            "public static async {} {}(SqliteConnection conn{}{}) {{",
251            task_type, func_name, sep, param_list
252        );
253
254        let _ = writeln!(
255            out,
256            "    await using var cmd = new SqliteCommand(\"{}\", conn);",
257            sql
258        );
259        for (i, p) in params.iter().enumerate() {
260            let value_expr = if p.neutral_type.starts_with("enum::") {
261                format!("{}.ToString().ToLower()", p.field_name)
262            } else {
263                p.field_name.clone()
264            };
265            let _ = writeln!(
266                out,
267                "    cmd.Parameters.AddWithValue(\"$p{}\", {});",
268                i + 1,
269                value_expr
270            );
271        }
272
273        match &analyzed.command {
274            QueryCommand::One => {
275                let _ = writeln!(
276                    out,
277                    "    await using var reader = await cmd.ExecuteReaderAsync();"
278                );
279                let _ = writeln!(out, "    if (!await reader.ReadAsync()) return null;");
280                let _ = writeln!(out, "    return new {}(", struct_name);
281                for (i, col) in columns.iter().enumerate() {
282                    let expr = column_read_expr(col, i);
283                    let sep = if i + 1 < columns.len() { "," } else { "" };
284                    if col.nullable {
285                        let _ = writeln!(out, "        reader.IsDBNull({i}) ? null : {expr}{sep}");
286                    } else {
287                        let _ = writeln!(out, "        {expr}{sep}");
288                    }
289                }
290                let _ = writeln!(out, "    );");
291            }
292            QueryCommand::Many => {
293                let _ = writeln!(
294                    out,
295                    "    await using var reader = await cmd.ExecuteReaderAsync();"
296                );
297                let _ = writeln!(out, "    var results = new List<{}>();", struct_name);
298                let _ = writeln!(out, "    while (await reader.ReadAsync()) {{");
299                let _ = writeln!(out, "        results.Add(new {}(", struct_name);
300                for (i, col) in columns.iter().enumerate() {
301                    let expr = column_read_expr(col, i);
302                    let sep = if i + 1 < columns.len() { "," } else { "" };
303                    if col.nullable {
304                        let _ =
305                            writeln!(out, "            reader.IsDBNull({i}) ? null : {expr}{sep}");
306                    } else {
307                        let _ = writeln!(out, "            {expr}{sep}");
308                    }
309                }
310                let _ = writeln!(out, "        ));");
311                let _ = writeln!(out, "    }}");
312                let _ = writeln!(out, "    return results;");
313            }
314            QueryCommand::Exec => {
315                let _ = writeln!(out, "    await cmd.ExecuteNonQueryAsync();");
316            }
317            QueryCommand::ExecResult | QueryCommand::ExecRows => {
318                let _ = writeln!(out, "    return await cmd.ExecuteNonQueryAsync();");
319            }
320            QueryCommand::Batch => unreachable!(),
321        }
322
323        let _ = write!(out, "}}");
324        Ok(out)
325    }
326
327    fn generate_enum_def(&self, enum_info: &EnumInfo) -> Result<String, ScytheError> {
328        let type_name = enum_type_name(&enum_info.sql_name, &self.manifest.naming);
329        let mut out = String::new();
330        let _ = writeln!(out, "public enum {} {{", type_name);
331        for value in &enum_info.values {
332            let variant = enum_variant_name(value, &self.manifest.naming);
333            let _ = writeln!(out, "    {},", variant);
334        }
335        let _ = write!(out, "}}");
336        Ok(out)
337    }
338
339    fn generate_composite_def(&self, composite: &CompositeInfo) -> Result<String, ScytheError> {
340        let name = to_pascal_case(&composite.sql_name);
341        let mut out = String::new();
342        if composite.fields.is_empty() {
343            let _ = writeln!(out, "public record {}();", name);
344        } else {
345            let _ = writeln!(out, "public record {}(", name);
346            for (i, field) in composite.fields.iter().enumerate() {
347                let cs_type = resolve_type(&field.neutral_type, &self.manifest, false)
348                    .map(|t| t.into_owned())
349                    .unwrap_or_else(|_| "object".to_string());
350                let field_name = to_pascal_case(&field.name);
351                let sep = if i + 1 < composite.fields.len() {
352                    ","
353                } else {
354                    ""
355                };
356                let _ = writeln!(out, "    {} {}{}", cs_type, field_name, sep);
357            }
358            let _ = write!(out, ");");
359        }
360        Ok(out)
361    }
362}