#3572 DDL support for non-nullable JoinColumn column (#3575)

Author: rbygrave

ebean-core/src/main/java/io/ebeaninternal/server/deploy/TableJoinColumn.java

@@ -20,6 +20,7 @@ public final class TableJoinColumn {
   private final String foreignSqlFormula;
   private final boolean insertable;
   private final boolean updateable;
+  private final boolean nullable;
   /**
    * Hash for including in a query plan
    */
@@ -34,7 +35,8 @@ public TableJoinColumn(DeployTableJoinColumn deploy) {
     this.localSqlFormula = InternString.intern(deploy.getLocalSqlFormula());
     this.foreignSqlFormula = InternString.intern(deploy.getForeignSqlFormula());
     this.insertable = deploy.isInsertable();
-    this.updateable = deploy.isUpdateable();
+    this.updateable = deploy.isUpdatable();
+    this.nullable = deploy.isNullable();
     this.queryHash = hash();
   }
 
@@ -45,6 +47,7 @@ private TableJoinColumn(TableJoinColumn source, String overrideColumn) {
     this.foreignSqlFormula = null;
     this.insertable = source.isInsertable();
     this.updateable = source.isUpdateable();
+    this.nullable = source.isNullable();
     this.queryHash = hash();
   }
 
@@ -115,6 +118,13 @@ boolean isUpdateable() {
     return updateable;
   }
 
+  /**
+   * Return if this column is nullable.
+   */
+  public boolean isNullable() {
+    return nullable;
+  }
+
   public String getLocalSqlFormula() {
     return localSqlFormula;
   }

ebean-core/src/main/java/io/ebeaninternal/server/deploy/meta/DeployTableJoin.java

@@ -81,7 +81,7 @@ public void addJoinColumn(DeployUtil deploy, boolean order, JoinColumn jc, BeanT
       // only add the join column details when name or referencedColumnName is specified
       String ref = deploy.convertQuotes(jc.referencedColumnName());
       String nam = deploy.convertQuotes(jc.name());
-      addJoinColumn(new DeployTableJoinColumn(order, ref, nam, jc.insertable(), jc.updatable(), beanTable));
+      addJoinColumn(new DeployTableJoinColumn(order, ref, nam, jc.insertable(), jc.updatable(), jc.nullable(), beanTable));
     }
   }
 

ebean-core/src/main/java/io/ebeaninternal/server/deploy/meta/DeployTableJoinColumn.java

@@ -25,7 +25,8 @@ public final class DeployTableJoinColumn {
    */
   private String foreignSqlFormula;
   private boolean insertable;
-  private boolean updateable;
+  private boolean updatable;
+  private boolean nullable;
 
   /**
    * Construct when automatically determining the join.
@@ -34,21 +35,24 @@ public final class DeployTableJoinColumn {
    * </p>
    */
   public DeployTableJoinColumn(String localDbColumn, String foreignDbColumn) {
-    this(localDbColumn, foreignDbColumn, true, true);
+    this(localDbColumn, foreignDbColumn, true, true, true);
   }
 
   /**
    * Construct with explicit insertable and updateable flags.
    */
-  public DeployTableJoinColumn(String localDbColumn, String foreignDbColumn, boolean insertable, boolean updateable) {
+  public DeployTableJoinColumn(String localDbColumn, String foreignDbColumn,
+                               boolean insertable, boolean updatable, boolean nullable) {
     this.localDbColumn = nullEmptyString(localDbColumn);
     this.foreignDbColumn = nullEmptyString(foreignDbColumn);
     this.insertable = insertable;
-    this.updateable = updateable;
+    this.updatable = updatable;
+    this.nullable = nullable;
   }
 
-  public DeployTableJoinColumn(boolean order, String ref, String name, boolean insertable, boolean updateable, BeanTable beanTable) {
-    this(ref, name, insertable, updateable);
+  public DeployTableJoinColumn(boolean order, String ref, String name,
+                               boolean insertable, boolean updatable, boolean nullable, BeanTable beanTable) {
+    this(ref, name, insertable, updatable, nullable);
     setReferencedColumn(beanTable);
     if (!order) {
       reverse();
@@ -60,7 +64,7 @@ void setLocalSqlFormula(String localSqlFormula) {
       this.localSqlFormula = localSqlFormula;
       this.localDbColumn = null;
       this.insertable = false;
-      this.updateable = false;
+      this.updatable = false;
     }
   }
 
@@ -73,7 +77,7 @@ public void setForeignSqlFormula(String foreignSqlFormula) {
       this.foreignSqlFormula = foreignSqlFormula;
       this.foreignDbColumn = null;
       this.insertable = false;
-      this.updateable = false;
+      this.updatable = false;
     }
   }
 
@@ -121,12 +125,12 @@ public DeployTableJoinColumn copy(boolean reverse) {
     // but will leave it like this for now
     DeployTableJoinColumn ret;
     if (reverse) {
-      ret = new DeployTableJoinColumn(foreignDbColumn, localDbColumn, insertable, updateable);
+      ret = new DeployTableJoinColumn(foreignDbColumn, localDbColumn, insertable, updatable, nullable);
       ret.setLocalSqlFormula(foreignSqlFormula);
       ret.setForeignSqlFormula(localSqlFormula);
 
     } else {
-      ret = new DeployTableJoinColumn(localDbColumn, foreignDbColumn, insertable, updateable);
+      ret = new DeployTableJoinColumn(localDbColumn, foreignDbColumn, insertable, updatable, nullable);
       ret.setLocalSqlFormula(localSqlFormula);
       ret.setForeignSqlFormula(foreignSqlFormula);
     }
@@ -148,8 +152,8 @@ public boolean isInsertable() {
   /**
    * Return true if this column should be updateable.
    */
-  public boolean isUpdateable() {
-    return updateable;
+  public boolean isUpdatable() {
+    return updatable;
   }
 
   /**
@@ -173,4 +177,7 @@ void setLocalDbColumn(String localDbColumn) {
     this.localDbColumn = localDbColumn;
   }
 
+  public boolean isNullable() {
+    return nullable;
+  }
 }

ebean-core/src/main/java/io/ebeaninternal/server/deploy/parse/AnnotationAssocOnes.java

@@ -223,7 +223,7 @@ private void readPrimaryKeyJoin(PrimaryKeyJoinColumn primaryKeyJoin, DeployBeanP
     BeanTable baseBeanTable = factory.beanTable(info.getDescriptor().getBeanType());
     String localPrimaryKey = baseBeanTable.getIdColumn();
     String foreignColumn = getBeanTable(prop).getIdColumn();
-    prop.getTableJoin().addJoinColumn(new DeployTableJoinColumn(localPrimaryKey, foreignColumn, false, false));
+    prop.getTableJoin().addJoinColumn(new DeployTableJoinColumn(localPrimaryKey, foreignColumn, false, false, prop.isNullable()));
   }
 
   private void readEmbedded(DeployBeanPropertyAssocOne<?> prop, Embedded embedded) {

ebean-core/src/test/java/io/ebeaninternal/server/deploy/TableJoinColumnTest.java

@@ -8,7 +8,7 @@
 public class TableJoinColumnTest {
 
   TableJoinColumn col(String localDbColumn, String foreignDbColumn, boolean insertable, boolean updateable) {
-    DeployTableJoinColumn column = new DeployTableJoinColumn(localDbColumn, foreignDbColumn, insertable, updateable);
+    DeployTableJoinColumn column = new DeployTableJoinColumn(localDbColumn, foreignDbColumn, insertable, updateable, true);
     return new TableJoinColumn(column);
   }
 

ebean-core/src/test/java/io/ebeaninternal/server/deploy/TableJoinTest.java

@@ -9,22 +9,22 @@
 
 public class TableJoinTest {
 
-  DeployTableJoinColumn col(String localDbColumn, String foreignDbColumn, boolean insertable, boolean updateable) {
-    return new DeployTableJoinColumn(localDbColumn, foreignDbColumn, insertable, updateable);
+  DeployTableJoinColumn col(String localDbColumn, String foreignDbColumn, boolean insertable, boolean updateable, boolean nullable) {
+    return new DeployTableJoinColumn(localDbColumn, foreignDbColumn, insertable, updateable, nullable);
   }
 
   TableJoin table(String tableName, String col1, String col2) {
     DeployTableJoin deploy = new DeployTableJoin();
     deploy.setTable(tableName);
-    deploy.addJoinColumn(col(col1, col2, true, true));
+    deploy.addJoinColumn(col(col1, col2, true, true, true));
     return new TableJoin(deploy);
   }
 
   TableJoin table(String tableName, String col1, String col2, String col3, String col4) {
     DeployTableJoin deploy = new DeployTableJoin();
     deploy.setTable(tableName);
-    deploy.addJoinColumn(col(col1, col2, true, true));
-    deploy.addJoinColumn(col(col3, col4, true, true));
+    deploy.addJoinColumn(col(col1, col2, true, true, true));
+    deploy.addJoinColumn(col(col3, col4, true, true, true));
     return new TableJoin(deploy);
   }
 

ebean-test/src/test/java/org/tests/compositekeys/TestRecursiveEmbeddedId.java

@@ -0,0 +1,38 @@
+package org.tests.compositekeys;
+
+import io.ebean.DB;
+import io.ebean.xtest.BaseTestCase;
+import org.junit.jupiter.api.Test;
+import org.tests.compositekeys.db.PartitionKey;
+import org.tests.compositekeys.db.EmbeddedSelfRelation;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class TestRecursiveEmbeddedId extends BaseTestCase {
+
+  @Test
+  void insert() {
+    PartitionKey partitionKey = new PartitionKey(78L, 1000L);
+    EmbeddedSelfRelation bean0 = new EmbeddedSelfRelation(partitionKey);
+    DB.save(bean0);
+
+    var found = DB.find(EmbeddedSelfRelation.class).where().eq("key", new PartitionKey(78L, 1000L)).findOne();
+    assertThat(found).isNotNull();
+    assertThat(found.key().orgId()).isEqualTo(78L);
+    assertThat(found.key().code()).isEqualTo(1000L);
+    assertThat(found.root().key()).isNotNull();
+    assertThat(found.root().key().orgId()).isEqualTo(78L);
+    assertThat(found.root().key().code()).isNull();
+
+    var bean1 = new EmbeddedSelfRelation(new PartitionKey(78L, 1001L));
+    bean1.setRoot(bean0);
+    DB.save(bean1);
+
+    var found2 = DB.find(EmbeddedSelfRelation.class).where().eq("key", new PartitionKey(78L, 1001L)).findOne();
+    assertThat(found2).isNotNull();
+    assertThat(found2.key().code()).isEqualTo(1001L);
+
+    assertThat(found2.root().key().orgId()).isEqualTo(78L);
+    assertThat(found2.root().key().code()).isEqualTo(1000L);
+  }
+}

ebean-test/src/test/java/org/tests/compositekeys/db/EmbeddedSelfRelation.java

@@ -0,0 +1,35 @@
+package org.tests.compositekeys.db;
+
+import jakarta.persistence.*;
+
+@Entity
+@Table(name = "em_transactions")
+public class EmbeddedSelfRelation {
+
+  @EmbeddedId
+  private final PartitionKey key;
+
+  @ManyToOne
+  @JoinColumns({
+    @JoinColumn(name = "org_id", referencedColumnName = "org_id", insertable = false, updatable = false),
+    @JoinColumn(name = "root_code", referencedColumnName = "code"),
+  })
+  private EmbeddedSelfRelation root;
+
+  public EmbeddedSelfRelation(PartitionKey key) {
+    this.key = key;
+  }
+
+  public PartitionKey key() {
+    return key;
+  }
+
+  public EmbeddedSelfRelation root() {
+    return root;
+  }
+
+  public void setRoot(EmbeddedSelfRelation root) {
+    this.root = root;
+  }
+}
+

ebean-test/src/test/java/org/tests/compositekeys/db/PartitionKey.java

@@ -0,0 +1,43 @@
+package org.tests.compositekeys.db;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Embeddable;
+
+import java.io.Serializable;
+import java.util.Objects;
+
+@Embeddable
+public class PartitionKey implements Serializable {
+
+  @Column(name = "org_id")
+  private final Long orgId;
+  @Column(name = "code")
+  private final Long code;
+
+  public PartitionKey(Long orgId, Long code) {
+    this.orgId = orgId;
+    this.code= code;
+  }
+
+  public Long orgId() {
+    return orgId;
+  }
+
+  public Long code() {
+    return code;
+  }
+
+  @Override
+  public boolean equals(Object o) {
+    if (this == o) return true;
+    if (o == null || getClass() != o.getClass()) return false;
+    PartitionKey that = (PartitionKey) o;
+    return Objects.equals(orgId, that.orgId) && Objects.equals(code, that.code);
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(orgId, code);
+  }
+}
+