sqlx_gen/codegen/
struct_gen.rs

1use std::collections::{BTreeSet, HashMap};
2
3use heck::{ToSnakeCase, ToUpperCamelCase};
4use proc_macro2::TokenStream;
5use quote::{format_ident, quote};
6
7use crate::cli::{DatabaseKind, TimeCrate};
8use crate::codegen::{imports_for_derives, is_rust_keyword};
9use crate::introspect::{SchemaInfo, TableInfo};
10use crate::typemap;
11
12pub fn generate_struct(
13    table: &TableInfo,
14    db_kind: DatabaseKind,
15    schema_info: &SchemaInfo,
16    extra_derives: &[String],
17    type_overrides: &HashMap<String, String>,
18    is_view: bool,
19    time_crate: TimeCrate,
20) -> (TokenStream, BTreeSet<String>) {
21    let mut imports = BTreeSet::new();
22    for imp in imports_for_derives(extra_derives) {
23        imports.insert(imp);
24    }
25    let struct_name = format_ident!("{}", table.name.to_upper_camel_case());
26
27    // Build derive list
28    imports.insert("use serde::{Serialize, Deserialize};".to_string());
29    imports.insert("use sqlx_gen::SqlxGen;".to_string());
30    let mut derive_tokens = vec![
31        quote! { Debug },
32        quote! { Clone },
33        quote! { PartialEq },
34        quote! { Eq },
35        quote! { Serialize },
36        quote! { Deserialize },
37        quote! { sqlx::FromRow },
38        quote! { SqlxGen },
39    ];
40    for d in extra_derives {
41        let ident = format_ident!("{}", d);
42        derive_tokens.push(quote! { #ident });
43    }
44
45    // Build fields
46    let fields: Vec<TokenStream> = table
47        .columns
48        .iter()
49        .map(|col| {
50            let rust_type = resolve_column_type(col, db_kind, table, schema_info, type_overrides, time_crate);
51            if let Some(imp) = &rust_type.needs_import {
52                imports.insert(imp.clone());
53            }
54
55            let field_name_snake = col.name.to_snake_case();
56            // If the field name is a Rust keyword, prefix with table name
57            // e.g. column "type" on table "connector" → "connector_type"
58            let (effective_name, needs_rename) = if is_rust_keyword(&field_name_snake) {
59                let prefixed = format!(
60                    "{}_{}",
61                    table.name.to_snake_case(),
62                    field_name_snake
63                );
64                (prefixed, true)
65            } else {
66                let changed = field_name_snake != col.name;
67                (field_name_snake, changed)
68            };
69
70            let field_ident = format_ident!("{}", effective_name);
71            let type_tokens: TokenStream = rust_type.path.parse().unwrap_or_else(|_| {
72                let fallback = format_ident!("String");
73                quote! { #fallback }
74            });
75
76            let rename = if needs_rename {
77                let original = &col.name;
78                quote! { #[sqlx(rename = #original)] }
79            } else {
80                quote! {}
81            };
82
83            // Build #[sqlx_gen(...)] attribute with optional primary_key, sql_type, is_array, column_default
84            let (sql_type, is_sql_array) = detect_custom_sql_type(&col.udt_name, schema_info);
85            let has_pk = col.is_primary_key;
86            let has_sql_type = sql_type.is_some();
87            let has_default = col.column_default.is_some();
88
89            let sqlx_gen_attr = if has_pk || has_sql_type || has_default {
90                let pk_part = if has_pk { quote! { primary_key, } } else { quote! {} };
91                let sql_type_part = match &sql_type {
92                    Some(t) => quote! { sql_type = #t, },
93                    None => quote! {},
94                };
95                let array_part = if is_sql_array { quote! { is_array, } } else { quote! {} };
96                let default_part = match &col.column_default {
97                    Some(d) => quote! { column_default = #d, },
98                    None => quote! {},
99                };
100                quote! { #[sqlx_gen(#pk_part #sql_type_part #array_part #default_part)] }
101            } else {
102                quote! {}
103            };
104
105            quote! {
106                #sqlx_gen_attr
107                #rename
108                pub #field_ident: #type_tokens,
109            }
110        })
111        .collect();
112
113    let table_name_str = &table.name;
114    let schema_name_str = &table.schema_name;
115    let kind_str = if is_view { "view" } else { "table" };
116
117    let tokens = quote! {
118        #[derive(#(#derive_tokens),*)]
119        #[sqlx_gen(kind = #kind_str, schema = #schema_name_str, table = #table_name_str)]
120        pub struct #struct_name {
121            #(#fields)*
122        }
123    };
124
125    (tokens, imports)
126}
127
128/// Detect if a column uses a custom SQL type (enum or composite) and return the qualified
129/// SQL type name for casting, plus whether it's an array.
130/// Returns `(Some("type_name"), true)` for arrays of custom types,
131/// `(Some("type_name"), false)` for scalar custom types, or `(None, false)` for built-in types.
132fn detect_custom_sql_type(udt_name: &str, schema_info: &SchemaInfo) -> (Option<String>, bool) {
133    let (base_name, is_array) = match udt_name.strip_prefix('_') {
134        Some(inner) => (inner, true),
135        None => (udt_name, false),
136    };
137
138    // Check enums
139    if schema_info.enums.iter().any(|e| e.name == base_name) {
140        return (Some(base_name.to_string()), is_array);
141    }
142
143    // Check composite types
144    if schema_info.composite_types.iter().any(|c| c.name == base_name) {
145        return (Some(base_name.to_string()), is_array);
146    }
147
148    // Check if this is a non-builtin type that would hit the typemap fallback
149    // (e.g. range types like "timerange", "tsrange", etc.)
150    // Domains resolve to their base type, so they don't need marking.
151    let is_domain = schema_info.domains.iter().any(|d| d.name == base_name);
152    if !is_domain && !typemap::postgres::is_builtin(base_name) {
153        return (Some(base_name.to_string()), is_array);
154    }
155
156    (None, false)
157}
158
159fn resolve_column_type(
160    col: &crate::introspect::ColumnInfo,
161    db_kind: DatabaseKind,
162    table: &TableInfo,
163    schema_info: &SchemaInfo,
164    type_overrides: &HashMap<String, String>,
165    time_crate: TimeCrate,
166) -> typemap::RustType {
167    // For MySQL ENUM columns, resolve to the generated enum type
168    if db_kind == DatabaseKind::Mysql && col.udt_name.starts_with("enum(") {
169        let enum_type_name = typemap::mysql::resolve_enum_type(&table.name, &col.name);
170        let rt = typemap::RustType::with_import(
171            &enum_type_name,
172            &format!("use super::types::{};", enum_type_name),
173        );
174        return if col.is_nullable {
175            rt.wrap_option()
176        } else {
177            rt
178        };
179    }
180
181    typemap::map_column(col, db_kind, schema_info, type_overrides, time_crate)
182}
183
184#[cfg(test)]
185mod tests {
186    use super::*;
187    use crate::codegen::parse_and_format;
188    use crate::introspect::ColumnInfo;
189
190    fn make_table(name: &str, columns: Vec<ColumnInfo>) -> TableInfo {
191        TableInfo {
192            schema_name: "public".to_string(),
193            name: name.to_string(),
194            columns,
195        }
196    }
197
198    fn make_col(name: &str, udt_name: &str, nullable: bool) -> ColumnInfo {
199        ColumnInfo {
200            name: name.to_string(),
201            data_type: udt_name.to_string(),
202            udt_name: udt_name.to_string(),
203            is_nullable: nullable,
204            is_primary_key: false,
205            ordinal_position: 0,
206            schema_name: "public".to_string(),
207            column_default: None,
208        }
209    }
210
211    fn gen(table: &TableInfo) -> String {
212        let schema = SchemaInfo::default();
213        let (tokens, _) = generate_struct(table, DatabaseKind::Postgres, &schema, &[], &HashMap::new(), false, TimeCrate::Chrono);
214        parse_and_format(&tokens)
215    }
216
217    fn gen_with(
218        table: &TableInfo,
219        schema: &SchemaInfo,
220        db: DatabaseKind,
221        derives: &[String],
222        overrides: &HashMap<String, String>,
223    ) -> (String, BTreeSet<String>) {
224        let (tokens, imports) = generate_struct(table, db, schema, derives, overrides, false, TimeCrate::Chrono);
225        (parse_and_format(&tokens), imports)
226    }
227
228    // --- basic structure ---
229
230    #[test]
231    fn test_simple_table() {
232        let table = make_table("users", vec![
233            make_col("id", "int4", false),
234            make_col("name", "text", false),
235        ]);
236        let code = gen(&table);
237        assert!(code.contains("pub id: i32"));
238        assert!(code.contains("pub name: String"));
239    }
240
241    #[test]
242    fn test_struct_name_pascal_case() {
243        let table = make_table("user_roles", vec![make_col("id", "int4", false)]);
244        let code = gen(&table);
245        assert!(code.contains("pub struct UserRoles"));
246    }
247
248    #[test]
249    fn test_struct_name_simple() {
250        let table = make_table("users", vec![make_col("id", "int4", false)]);
251        let code = gen(&table);
252        assert!(code.contains("pub struct Users"));
253    }
254
255    // --- nullable ---
256
257    #[test]
258    fn test_nullable_column() {
259        let table = make_table("users", vec![make_col("email", "text", true)]);
260        let code = gen(&table);
261        assert!(code.contains("pub email: Option<String>"));
262    }
263
264    #[test]
265    fn test_non_nullable_column() {
266        let table = make_table("users", vec![make_col("name", "text", false)]);
267        let code = gen(&table);
268        assert!(code.contains("pub name: String"));
269        assert!(!code.contains("Option"));
270    }
271
272    #[test]
273    fn test_mix_nullable() {
274        let table = make_table("users", vec![
275            make_col("id", "int4", false),
276            make_col("bio", "text", true),
277        ]);
278        let code = gen(&table);
279        assert!(code.contains("pub id: i32"));
280        assert!(code.contains("pub bio: Option<String>"));
281    }
282
283    // --- keyword renaming ---
284
285    #[test]
286    fn test_keyword_type_renamed() {
287        let table = make_table("connector", vec![make_col("type", "text", false)]);
288        let code = gen(&table);
289        assert!(code.contains("pub connector_type: String"));
290        assert!(code.contains("sqlx(rename = \"type\")"));
291    }
292
293    #[test]
294    fn test_keyword_fn_renamed() {
295        let table = make_table("item", vec![make_col("fn", "text", false)]);
296        let code = gen(&table);
297        assert!(code.contains("pub item_fn: String"));
298        assert!(code.contains("sqlx(rename = \"fn\")"));
299    }
300
301    #[test]
302    fn test_keyword_match_renamed() {
303        let table = make_table("game", vec![make_col("match", "text", false)]);
304        let code = gen(&table);
305        assert!(code.contains("pub game_match: String"));
306    }
307
308    #[test]
309    fn test_non_keyword_no_rename() {
310        let table = make_table("users", vec![make_col("name", "text", false)]);
311        let code = gen(&table);
312        assert!(!code.contains("sqlx(rename"));
313    }
314
315    // --- snake_case renaming ---
316
317    #[test]
318    fn test_camel_case_column_renamed() {
319        let table = make_table("users", vec![make_col("CreatedAt", "text", false)]);
320        let code = gen(&table);
321        assert!(code.contains("pub created_at: String"));
322        assert!(code.contains("sqlx(rename = \"CreatedAt\")"));
323    }
324
325    #[test]
326    fn test_mixed_case_column_renamed() {
327        let table = make_table("users", vec![make_col("firstName", "text", false)]);
328        let code = gen(&table);
329        assert!(code.contains("pub first_name: String"));
330        assert!(code.contains("sqlx(rename = \"firstName\")"));
331    }
332
333    #[test]
334    fn test_already_snake_case_no_rename() {
335        let table = make_table("users", vec![make_col("created_at", "text", false)]);
336        let code = gen(&table);
337        assert!(code.contains("pub created_at: String"));
338        assert!(!code.contains("sqlx(rename"));
339    }
340
341    // --- derives ---
342
343    #[test]
344    fn test_default_derives() {
345        let table = make_table("users", vec![make_col("id", "int4", false)]);
346        let code = gen(&table);
347        assert!(code.contains("Debug"));
348        assert!(code.contains("Clone"));
349        assert!(code.contains("sqlx::FromRow") || code.contains("sqlx :: FromRow"));
350    }
351
352    #[test]
353    fn test_extra_derive_serialize() {
354        let table = make_table("users", vec![make_col("id", "int4", false)]);
355        let schema = SchemaInfo::default();
356        let derives = vec!["Serialize".to_string()];
357        let (code, _) = gen_with(&table, &schema, DatabaseKind::Postgres, &derives, &HashMap::new());
358        assert!(code.contains("Serialize"));
359    }
360
361    #[test]
362    fn test_extra_derives_both_serde() {
363        let table = make_table("users", vec![make_col("id", "int4", false)]);
364        let schema = SchemaInfo::default();
365        let derives = vec!["Serialize".to_string(), "Deserialize".to_string()];
366        let (_, imports) = gen_with(&table, &schema, DatabaseKind::Postgres, &derives, &HashMap::new());
367        assert!(imports.iter().any(|i| i.contains("serde")));
368    }
369
370    // --- imports ---
371
372    #[test]
373    fn test_uuid_import() {
374        let table = make_table("users", vec![make_col("id", "uuid", false)]);
375        let schema = SchemaInfo::default();
376        let (_, imports) = gen_with(&table, &schema, DatabaseKind::Postgres, &[], &HashMap::new());
377        assert!(imports.iter().any(|i| i.contains("uuid::Uuid")));
378    }
379
380    #[test]
381    fn test_timestamptz_import() {
382        let table = make_table("users", vec![make_col("created_at", "timestamptz", false)]);
383        let schema = SchemaInfo::default();
384        let (_, imports) = gen_with(&table, &schema, DatabaseKind::Postgres, &[], &HashMap::new());
385        assert!(imports.iter().any(|i| i.contains("chrono")));
386    }
387
388    #[test]
389    fn test_int4_only_serde_import() {
390        let table = make_table("users", vec![make_col("id", "int4", false)]);
391        let schema = SchemaInfo::default();
392        let (_, imports) = gen_with(&table, &schema, DatabaseKind::Postgres, &[], &HashMap::new());
393        assert_eq!(imports.len(), 2);
394        assert!(imports.iter().any(|i| i.contains("serde")));
395        assert!(imports.iter().any(|i| i.contains("sqlx_gen::SqlxGen")));
396    }
397
398    #[test]
399    fn test_multiple_imports_collected() {
400        let table = make_table("users", vec![
401            make_col("id", "uuid", false),
402            make_col("created_at", "timestamptz", false),
403        ]);
404        let schema = SchemaInfo::default();
405        let (_, imports) = gen_with(&table, &schema, DatabaseKind::Postgres, &[], &HashMap::new());
406        assert!(imports.iter().any(|i| i.contains("uuid")));
407        assert!(imports.iter().any(|i| i.contains("chrono")));
408    }
409
410    // --- MySQL enum ---
411
412    #[test]
413    fn test_mysql_enum_column() {
414        let table = make_table("users", vec![ColumnInfo {
415            name: "status".to_string(),
416            data_type: "enum".to_string(),
417            udt_name: "enum('active','inactive')".to_string(),
418            is_nullable: false,
419            is_primary_key: false,
420            ordinal_position: 0,
421            schema_name: "test_db".to_string(),
422            column_default: None,
423        }]);
424        let schema = SchemaInfo::default();
425        let (code, imports) = gen_with(&table, &schema, DatabaseKind::Mysql, &[], &HashMap::new());
426        assert!(code.contains("UsersStatus"));
427        assert!(imports.iter().any(|i| i.contains("super::types::")));
428    }
429
430    #[test]
431    fn test_mysql_enum_nullable() {
432        let table = make_table("users", vec![ColumnInfo {
433            name: "status".to_string(),
434            data_type: "enum".to_string(),
435            udt_name: "enum('a','b')".to_string(),
436            is_nullable: true,
437            is_primary_key: false,
438            ordinal_position: 0,
439            schema_name: "test_db".to_string(),
440            column_default: None,
441        }]);
442        let schema = SchemaInfo::default();
443        let (code, _) = gen_with(&table, &schema, DatabaseKind::Mysql, &[], &HashMap::new());
444        assert!(code.contains("Option<UsersStatus>"));
445    }
446
447    // --- type overrides ---
448
449    #[test]
450    fn test_type_override() {
451        let table = make_table("users", vec![make_col("data", "jsonb", false)]);
452        let schema = SchemaInfo::default();
453        let mut overrides = HashMap::new();
454        overrides.insert("jsonb".to_string(), "MyJson".to_string());
455        let (code, _) = gen_with(&table, &schema, DatabaseKind::Postgres, &[], &overrides);
456        assert!(code.contains("pub data: MyJson"));
457    }
458
459    #[test]
460    fn test_type_override_absent() {
461        let table = make_table("users", vec![make_col("data", "jsonb", false)]);
462        let schema = SchemaInfo::default();
463        let (code, _) = gen_with(&table, &schema, DatabaseKind::Postgres, &[], &HashMap::new());
464        assert!(code.contains("Value"));
465    }
466
467    #[test]
468    fn test_type_override_nullable() {
469        let table = make_table("users", vec![make_col("data", "jsonb", true)]);
470        let schema = SchemaInfo::default();
471        let mut overrides = HashMap::new();
472        overrides.insert("jsonb".to_string(), "MyJson".to_string());
473        let (code, _) = gen_with(&table, &schema, DatabaseKind::Postgres, &[], &overrides);
474        assert!(code.contains("Option<MyJson>"));
475    }
476}
sqlx_gen/codegen/struct_gen.rs

sqlx_gen/codegen/
struct_gen.rs
