Override column name with column_name attribute (SeaQL/sea-orm#433)

SeaQL · Jan 31, 2022 · a9e8149 · a9e8149
1 parent fa5a1e7
commit a9e8149
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/SeaORM/docs/03-generate-entity/02-entity-structure.md b/SeaORM/docs/03-generate-entity/02-entity-structure.md
@@ -38,6 +38,15 @@ pub struct Model { ... }
 
 ## Column
 
+### Column Name
+
+All column names are assumed to be in snake-case. You can override the column name by specifying the `column_name` attribute.
+
+```rust
+#[sea_orm(column_name = "name")]
+pub name: String
+```
+
 ### Column Type
 
 The column type will be derived automatically with the following mapping:

diff --git a/SeaORM/docs/03-generate-entity/03-expanded-entity-structure.md b/SeaORM/docs/03-generate-entity/03-expanded-entity-structure.md
@@ -48,12 +48,13 @@ impl ColumnTrait for Column {
 }
 ```
 
-All column names are assumed to be in snake-case.
+All column names are assumed to be in snake-case. You can override the column name by specifying the `column_name` attribute.
 
 ```rust
 pub enum Column {
     Id,      // maps to "id" in SQL
     Name,    // maps to "name" in SQL
+    #[sea_orm(column_name = "create_at")]
     CreateAt // maps to "create_at" in SQL
 }
 ```