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

sqlx_gen/codegen/
struct_gen.rs
