Merge pull request #3274 from ebean-orm/feature/3269

#3268 - @DbComment on @manytoone fields are ignored (ddl-generator)
ebean-orm · Nov 21, 2023 · 196cb09 · 196cb09
2 parents b2b8167 + 589e198
commit 196cb09
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 0 deletions.
diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/deploy/parse/AnnotationFields.java b/ebean-core/src/main/java/io/ebeaninternal/server/deploy/parse/AnnotationFields.java
@@ -99,6 +99,10 @@ private void readAssocOne(DeployBeanPropertyAssoc<?> prop) {
     if (formula != null) {
       prop.setSqlFormula(processFormula(formula.select()), processFormula(formula.join()));
     }
+    DbComment comment = get(prop, DbComment.class);
+    if (comment != null) {
+      prop.setDbComment(comment.value());
+    }
     initWhoProperties(prop);
     initDbMigration(prop);
   }

diff --git a/...tor/src/main/java/io/ebeaninternal/dbmigration/model/build/ModelBuildPropertyVisitor.java b/...tor/src/main/java/io/ebeaninternal/dbmigration/model/build/ModelBuildPropertyVisitor.java
@@ -203,6 +203,7 @@ public void visitOneImported(BeanPropertyAssocOne<?> p) {
       MColumn col = table.addColumn(dbCol, columnDefn, !p.isNullable());
       col.setDbMigrationInfos(p.dbMigrationInfos());
       col.setDefaultValue(p.dbColumnDefault());
+      col.setComment(p.dbComment());
       if (addForeignKey) {
         if (columns.length > 1) {
           compoundKey.addColumnPair(dbCol, refColumn);

diff --git a/...tor/src/test/java/io/ebeaninternal/dbmigration/model/build/ModelBuildBeanVisitorTest.java b/...tor/src/test/java/io/ebeaninternal/dbmigration/model/build/ModelBuildBeanVisitorTest.java
@@ -49,6 +49,7 @@ public void test() {
     assert_discriminatorColumn_explicit(model);
     assert_discriminatorColumn_implied(model);
     assert_discriminatorColumn_length(model);
+    assert_comment_onManyToOne(model);
   }
 
   @Test
@@ -144,4 +145,11 @@ private void assert_discriminatorColumn_length(ModelContainer model) {
     assertThat(discTypeColumn.getType()).isEqualTo("varchar(3)");
     assertThat(discTypeColumn.isNotnull()).isTrue();
   }
+
+  private void assert_comment_onManyToOne(ModelContainer model) {
+    MTable message = model.getTable("c_message");
+    MColumn conversation = message.getColumn("conversation_id");
+    assertThat(conversation.getType()).isEqualTo("bigint");
+    assertThat(conversation.getComment()).isEqualTo("A ManyToOne comment");
+  }
 }
diff --git a/ebean-ddl-generator/src/test/java/org/tests/model/converstation/Message.java b/ebean-ddl-generator/src/test/java/org/tests/model/converstation/Message.java
@@ -1,5 +1,6 @@
 package org.tests.model.converstation;
 
+import io.ebean.annotation.DbComment;
 import org.tests.model.BaseModel;
 
 import jakarta.persistence.Entity;
@@ -14,6 +15,7 @@ public class Message extends BaseModel {
 
   String body;
 
+  @DbComment("A ManyToOne comment")
   @ManyToOne
   Conversation conversation;