Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

create_table_from_entity support comment #2009

Merged
merged 6 commits into from Dec 14, 2023
Merged

create_table_from_entity support comment #2009

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f7196bf
support table and column comment
Caisin Mar 24, 2023
710b233
create_table_from_entity support comment
Caisin Dec 13, 2023
cd516cc
fmt code
Caisin Dec 13, 2023
126ddd3
fmt code
Caisin Dec 13, 2023
7a0a216
add comment test
Caisin Dec 14, 2023
5eb304f
fix test
Caisin Dec 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions sea-orm-codegen/src/entity/base_entity.rs
View file
Open in desktop
Expand Up @@ -15,9 +15,14 @@ pub struct Entity {
pub(crate) relations: Vec<Relation>,
pub(crate) conjunct_relations: Vec<ConjunctRelation>,
pub(crate) primary_keys: Vec<PrimaryKey>,
pub(crate) comment: Option<String>,
}

impl Entity {
pub fn get_table_comment(&self) -> Option<&String> {
self.comment.as_ref()
}

pub fn get_table_name_snake_case(&self) -> String {
self.table_name.to_snake_case()
}
Expand Down Expand Up @@ -318,6 +323,7 @@ mod tests {
primary_keys: vec![PrimaryKey {
name: "id".to_owned(),
}],
comment: None,
}
}

Expand Down
2 changes: 2 additions & 0 deletions sea-orm-codegen/src/entity/transformer.rs
View file
Open in desktop
Expand Up @@ -117,12 +117,14 @@ impl EntityTransformer {
.collect::<Vec<_>>()
}),
);
let comment = table_create.get_comment().cloned();
let entity = Entity {
table_name: table_name.clone(),
columns,
relations: relations.clone(),
conjunct_relations: vec![],
primary_keys,
comment,
};
entities.insert(table_name.clone(), entity.clone());
for mut rel in relations.into_iter() {
Expand Down
16 changes: 16 additions & 0 deletions sea-orm-codegen/src/entity/writer.rs
View file
Open in desktop
Expand Up @@ -785,6 +785,7 @@ impl EntityWriter {
},
None => quote! {},
};

let extra_derive = with_serde.extra_derive();

quote! {
Expand Down Expand Up @@ -882,9 +883,11 @@ mod tests {
primary_keys: vec![PrimaryKey {
name: "id".to_owned(),
}],
comment: None,
},
Entity {
table_name: "_cake_filling_".to_owned(),
comment: None,
columns: vec![
Column {
name: "cake_id".to_owned(),
Expand Down Expand Up @@ -980,6 +983,7 @@ mod tests {
name: "filling_id".to_owned(),
},
],
comment: None,
},
Entity {
table_name: "filling".to_owned(),
Expand Down Expand Up @@ -1007,6 +1011,7 @@ mod tests {
primary_keys: vec![PrimaryKey {
name: "id".to_owned(),
}],
comment: None,
},
Entity {
table_name: "fruit".to_owned(),
Expand Down Expand Up @@ -1061,6 +1066,7 @@ mod tests {
primary_keys: vec![PrimaryKey {
name: "id".to_owned(),
}],
comment: None,
},
Entity {
table_name: "vendor".to_owned(),
Expand Down Expand Up @@ -1102,6 +1108,7 @@ mod tests {
primary_keys: vec![PrimaryKey {
name: "id".to_owned(),
}],
comment: None,
},
Entity {
table_name: "rust_keyword".to_owned(),
Expand Down Expand Up @@ -1259,6 +1266,7 @@ mod tests {
primary_keys: vec![PrimaryKey {
name: "id".to_owned(),
}],
comment: None,
},
Entity {
table_name: "cake_with_float".to_owned(),
Expand Down Expand Up @@ -1303,6 +1311,7 @@ mod tests {
primary_keys: vec![PrimaryKey {
name: "id".to_owned(),
}],
comment: None,
},
Entity {
table_name: "cake_with_double".to_owned(),
Expand Down Expand Up @@ -1347,6 +1356,7 @@ mod tests {
primary_keys: vec![PrimaryKey {
name: "id".to_owned(),
}],
comment: None,
},
Entity {
table_name: "collection".to_owned(),
Expand Down Expand Up @@ -1378,6 +1388,7 @@ mod tests {
primary_keys: vec![PrimaryKey {
name: "id".to_owned(),
}],
comment: None,
},
Entity {
table_name: "collection_float".to_owned(),
Expand Down Expand Up @@ -1409,6 +1420,7 @@ mod tests {
primary_keys: vec![PrimaryKey {
name: "id".to_owned(),
}],
comment: None,
},
]
}
Expand Down Expand Up @@ -1770,6 +1782,7 @@ mod tests {
fn test_gen_with_seaography() -> io::Result<()> {
let cake_entity = Entity {
table_name: "cake".to_owned(),
comment: None,
columns: vec![
Column {
name: "id".to_owned(),
Expand Down Expand Up @@ -2225,6 +2238,7 @@ mod tests {
primary_keys: vec![PrimaryKey {
name: "id".to_owned(),
}],
comment: None,
},
];
const ENTITY_FILES: [&str; 1] = [include_str!("../../tests/postgres/binary_json.rs")];
Expand Down Expand Up @@ -2308,6 +2322,7 @@ mod tests {
let entities = vec![
Entity {
table_name: "tea_pairing".to_owned(),
comment: None,
columns: vec![
Column {
name: "id".to_owned(),
Expand Down Expand Up @@ -2351,6 +2366,7 @@ mod tests {
},
Entity {
table_name: "tea_pairing_with_size".to_owned(),
comment: None,
columns: vec![
Column {
name: "id".to_owned(),
Expand Down
1 change: 1 addition & 0 deletions sea-orm-macros/src/derives/attributes.rs
View file
Open in desktop
Expand Up @@ -11,6 +11,7 @@ pub mod derive_attr {
pub relation: Option<syn::Ident>,
pub schema_name: Option<syn::Lit>,
pub table_name: Option<syn::Lit>,
pub comment: Option<syn::Lit>,
pub table_iden: Option<()>,
}
}
Expand Down
17 changes: 16 additions & 1 deletion sea-orm-macros/src/derives/entity_model.rs
View file
Open in desktop
Expand Up @@ -10,14 +10,18 @@ use syn::{
pub fn expand_derive_entity_model(data: Data, attrs: Vec<Attribute>) -> syn::Result<TokenStream> {
// if #[sea_orm(table_name = "foo", schema_name = "bar")] specified, create Entity struct
let mut table_name = None;
let mut comment = quote! {None};
let mut schema_name = quote! { None };
let mut table_iden = false;
attrs
.iter()
.filter(|attr| attr.path().is_ident("sea_orm"))
.try_for_each(|attr| {
attr.parse_nested_meta(|meta| {
if meta.path.is_ident("table_name") {
if meta.path.is_ident("comment") {
let name: Lit = meta.value()?.parse()?;
comment = quote! { Some(#name) };
} else if meta.path.is_ident("table_name") {
table_name = Some(meta.value()?.parse::<Lit>()?);
} else if meta.path.is_ident("schema_name") {
let name: Lit = meta.value()?.parse()?;
Expand Down Expand Up @@ -51,6 +55,10 @@ pub fn expand_derive_entity_model(data: Data, attrs: Vec<Attribute>) -> syn::Res
fn table_name(&self) -> &str {
#table_name
}

fn comment(&self) -> Option<&str> {
#comment
}
}
}
})
Expand Down Expand Up @@ -90,6 +98,7 @@ pub fn expand_derive_entity_model(data: Data, attrs: Vec<Attribute>) -> syn::Res

let mut nullable = false;
let mut default_value = None;
let mut comment = None;
let mut default_expr = None;
let mut select_as = None;
let mut save_as = None;
Expand Down Expand Up @@ -134,6 +143,8 @@ pub fn expand_derive_entity_model(data: Data, attrs: Vec<Attribute>) -> syn::Res
meta.error(format!("Invalid auto_increment = {:?}", lit))
);
}
} else if meta.path.is_ident("comment") {
comment = Some(meta.value()?.parse::<Lit>()?);
} else if meta.path.is_ident("default_value") {
default_value = Some(meta.value()?.parse::<Lit>()?);
} else if meta.path.is_ident("default_expr") {
Expand Down Expand Up @@ -274,9 +285,13 @@ pub fn expand_derive_entity_model(data: Data, attrs: Vec<Attribute>) -> syn::Res
if let Some(default_value) = default_value {
match_row = quote! { #match_row.default_value(#default_value) };
}
if let Some(comment) = comment {
match_row = quote! { #match_row.comment(#comment) };
}
if let Some(default_expr) = default_expr {
match_row = quote! { #match_row.default(#default_expr) };
}
// match_row = quote! { #match_row.comment() };
columns_trait.push(match_row);
}
}
Expand Down
1 change: 0 additions & 1 deletion sea-orm-macros/src/derives/model.rs
View file
Open in desktop
Expand Up @@ -182,7 +182,6 @@ impl DeriveModel {
/// Method to derive an ActiveModel
pub fn expand_derive_model(input: syn::DeriveInput) -> syn::Result<TokenStream> {
let ident_span = input.ident.span();

match DeriveModel::new(input) {
Ok(model) => model.expand(),
Err(Error::InputNotStruct) => Ok(quote_spanned! {
Expand Down
5 changes: 5 additions & 0 deletions src/entity/base_entity.rs
View file
Open in desktop
Expand Up @@ -20,6 +20,11 @@ pub trait EntityName: IdenStatic + Default {
None
}

/// Method to get the comment for the schema, defaults to [Option::None] if not set
fn comment(&self) -> Option<&str> {
None
}

/// Get the name of the table
fn table_name(&self) -> &str;

Expand Down
7 changes: 7 additions & 0 deletions src/entity/column.rs
View file
Open in desktop
Expand Up @@ -16,6 +16,7 @@ pub struct ColumnDef {
pub(crate) unique: bool,
pub(crate) indexed: bool,
pub(crate) default: Option<SimpleExpr>,
pub(crate) comment: Option<String>,
}

macro_rules! bind_oper {
Expand Down Expand Up @@ -312,6 +313,7 @@ impl ColumnTypeTrait for ColumnType {
unique: false,
indexed: false,
default: None,
comment: None,
}
}

Expand Down Expand Up @@ -344,6 +346,11 @@ impl ColumnDef {
self.unique = true;
self
}
/// Set column comment
pub fn comment(mut self, v: &str) -> Self {
self.comment = Some(v.into());
self
}

/// Mark the column as nullable
pub fn null(self) -> Self {
Expand Down
7 changes: 7 additions & 0 deletions src/schema/entity.rs
View file
Open in desktop
Expand Up @@ -163,6 +163,10 @@ where
{
let mut stmt = TableCreateStatement::new();

if let Some(comment) = entity.comment() {
stmt.comment(comment);
}

for column in E::Column::iter() {
let mut column_def = column_def_from_entity_column::<E>(column, backend);
stmt.col(&mut column_def);
Expand Down Expand Up @@ -213,6 +217,9 @@ where
if let Some(default) = orm_column_def.default {
column_def.default(default);
}
if let Some(comment) = orm_column_def.comment {
column_def.comment(comment);
}
for primary_key in E::PrimaryKey::iter() {
if column.to_string() == primary_key.into_column().to_string() {
if E::PrimaryKey::auto_increment() {
Expand Down