macros: Set auto_increment to false for String/Uuid pk by default (#2881)

Author: Huliiiiii

sea-orm-macros/src/derives/entity_model.rs

@@ -11,6 +11,8 @@ use syn::{
     Attribute, Data, Fields, Lit, LitStr, punctuated::Punctuated, spanned::Spanned, token::Comma,
 };
 
+const NOT_AUTO_INCRE_TYPE_SUFFIX: [&str; 2] = ["String", "Uuid"];
+
 #[allow(dead_code)]
 fn convert_case(s: &str, case_style: CaseStyle) -> String {
     match case_style {
@@ -164,7 +166,7 @@ pub fn expand_derive_entity_model(data: &Data, attrs: &[Attribute]) -> syn::Resu
     let mut columns_save_as: Punctuated<_, Comma> = Punctuated::new();
     let mut primary_keys: Punctuated<_, Comma> = Punctuated::new();
     let mut primary_key_types: Punctuated<_, Comma> = Punctuated::new();
-    let mut auto_increment = true;
+    let mut auto_increment: Option<bool> = None;
     #[cfg(feature = "with-json")]
     let mut columns_json_keys: Punctuated<_, Comma> = Punctuated::new();
 
@@ -240,7 +242,7 @@ pub fn expand_derive_entity_model(data: &Data, attrs: &[Attribute]) -> syn::Resu
                                     let lit = meta.value()?.parse()?;
                                     if let Lit::Bool(litbool) = lit {
                                         is_auto_increment = litbool.value();
-                                        auto_increment = litbool.value();
+                                        auto_increment = Some(litbool.value());
                                     } else {
                                         return Err(
                                             meta.error(format!("Invalid auto_increment = {lit:?}"))
@@ -455,6 +457,15 @@ pub fn expand_derive_entity_model(data: &Data, attrs: &[Attribute]) -> syn::Resu
                     };
                     let field_span = field.span();
 
+                    if is_primary_key && auto_increment.is_none() {
+                        for suffix in NOT_AUTO_INCRE_TYPE_SUFFIX {
+                            if field_type.ends_with(suffix) {
+                                auto_increment = Some(false);
+                                break;
+                            }
+                        }
+                    }
+
                     let sea_query_col_type =
                         super::value_type_match::column_type_expr(sql_type, field_type, field_span);
 
@@ -518,7 +529,10 @@ pub fn expand_derive_entity_model(data: &Data, attrs: &[Attribute]) -> syn::Resu
     }
 
     let primary_key = {
-        let auto_increment = auto_increment && primary_keys.len() == 1;
+        let auto_increment = match auto_increment {
+            Some(value) => value && primary_keys.len() == 1,
+            None => primary_keys.len() == 1,
+        };
         let primary_key_types = if primary_key_types.len() == 1 {
             let first = primary_key_types.first();
             quote! { #first }

sea-orm-macros/tests/derive_entity_model_auto_increment_test.rs

@@ -0,0 +1,40 @@
+use sea_orm::entity::prelude::*;
+use sea_orm_macros::DeriveEntityModel;
+
+mod string_pk {
+    use super::*;
+
+    #[derive(Clone, Debug, PartialEq, Eq, DeriveEntityModel)]
+    #[sea_orm(table_name = "string_pk")]
+    pub struct Model {
+        #[sea_orm(primary_key)]
+        pub id: String,
+    }
+
+    #[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
+    pub enum Relation {}
+
+    impl ActiveModelBehavior for ActiveModel {}
+}
+
+mod string_pk_set_true {
+    use super::*;
+
+    #[derive(Clone, Debug, PartialEq, Eq, DeriveEntityModel)]
+    #[sea_orm(table_name = "string_pk")]
+    pub struct Model {
+        #[sea_orm(primary_key, auto_increment = true)]
+        pub id: String,
+    }
+
+    #[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
+    pub enum Relation {}
+
+    impl ActiveModelBehavior for ActiveModel {}
+}
+
+#[test]
+fn test_auto_increment_default_by_type() {
+    assert!(!string_pk::PrimaryKey::auto_increment());
+    assert!(string_pk_set_true::PrimaryKey::auto_increment());
+}