add check and comment to @column and @table

rough draft only
jakartaee · Sep 8, 2022 · 4a1718a · 4a1718a
1 parent 31d2cf0
commit 4a1718a
Show file tree

Hide file tree

Showing 6 changed files with 150 additions and 0 deletions.
diff --git a/api/src/main/java/jakarta/persistence/Column.java b/api/src/main/java/jakarta/persistence/Column.java
@@ -121,4 +121,20 @@
      * (Applies only if a decimal column is used.)
      */
     int scale() default 0;
+
+    /**
+     * (Optional) A check constraint to be applied to the column.
+     * This is only used if table generation is in effect.
+     *
+     * @since 3.2
+     */
+    String check() default "";
+
+    /**
+     * (Optional) A comment to be applied to the column.
+     * This is only used if table generation is in effect.
+     *
+     * @since 3.2
+     */
+    String comment() default "";
 }
diff --git a/api/src/main/java/jakarta/persistence/JoinColumn.java b/api/src/main/java/jakarta/persistence/JoinColumn.java
@@ -183,4 +183,20 @@
      *  @since 2.1
      */
     ForeignKey foreignKey() default @ForeignKey(PROVIDER_DEFAULT);
+
+    /**
+     * (Optional) A check constraint to be applied to the column.
+     * This is only used if table generation is in effect.
+     *
+     * @since 3.2
+     */
+    String check() default "";
+
+    /**
+     * (Optional) A comment to be applied to the column.
+     * This is only used if table generation is in effect.
+     *
+     * @since 3.2
+     */
+    String comment() default "";
 }
diff --git a/api/src/main/java/jakarta/persistence/JoinTable.java b/api/src/main/java/jakarta/persistence/JoinTable.java
@@ -152,4 +152,20 @@
      * @since 2.1 
      */
     Index[] indexes() default {};
+
+    /**
+     * (Optional) A check constraint to be applied to the table.
+     * This is only used if table generation is in effect.
+     *
+     * @since 3.2
+     */
+    String check() default "";
+
+    /**
+     * (Optional) A comment to be applied to the table.
+     * This is only used if table generation is in effect.
+     *
+     * @since 3.2
+     */
+    String comment() default "";
 }
diff --git a/api/src/main/java/jakarta/persistence/SecondaryTable.java b/api/src/main/java/jakarta/persistence/SecondaryTable.java
@@ -118,4 +118,20 @@
      * @since 2.1
      */
     Index[] indexes() default {};
+
+    /**
+     * (Optional) A check constraint to be applied to the table.
+     * This is only used if table generation is in effect.
+     *
+     * @since 3.2
+     */
+    String check() default "";
+
+    /**
+     * (Optional) A comment to be applied to the table.
+     * This is only used if table generation is in effect.
+     *
+     * @since 3.2
+     */
+    String comment() default "";
 }
diff --git a/api/src/main/java/jakarta/persistence/Table.java b/api/src/main/java/jakarta/persistence/Table.java
@@ -78,4 +78,20 @@
      * @since 2.1
      */
     Index[] indexes() default {};
+
+    /**
+     * (Optional) A check constraint to be applied to the table.
+     * This is only used if table generation is in effect.
+     *
+     * @since 3.2
+     */
+    String check() default "";
+
+    /**
+     * (Optional) A comment to be applied to the table.
+     * This is only used if table generation is in effect.
+     *
+     * @since 3.2
+     */
+    String comment() default "";
 }
diff --git a/spec/src/main/asciidoc/ch11-metadata-for-or-mapping.adoc b/spec/src/main/asciidoc/ch11-metadata-for-or-mapping.adoc
@@ -852,6 +852,8 @@ public @interface Column {
     int length() default 255;
     int precision() default 0; // decimal precision
     int scale() default 0; // decimal scale
+    String check() default "";
+    String comment() default "";
 }
 ----
 
@@ -925,6 +927,18 @@ if a string-valued column is used.)
 |(Optional) The scale for a decimal (exact
 numeric) column. (Applies only if a decimal column is used.)
 |0
+
+|String
+|check
+|(Optional) Check constraint for the column. This is
+only used if table generation is in effect.
+|No check constraint
+
+|String
+|comment
+|(Optional) Comment for the column. This is
+only used if table generation is in effect.
+|No comment
 |===
 
 *Example 1:*
@@ -2178,6 +2192,8 @@ public @interface JoinColumn {
     String columnDefinition() default "";
     String table() default "";
     ForeignKey foreignKey() default @ForeignKey(PROVIDER_DEFAULT);
+    String check() default "";
+    String comment() default "";
 }
 ----
 
@@ -2272,6 +2288,18 @@ join is for an element collection, the name of the collection table.
 |(Optional) The foreign key constraint for
 the join column. This is used only if table generation is in effect.
 |Provider's default
+
+|String
+|check
+|(Optional) Check constraint for the column. This is
+only used if table generation is in effect.
+|No check constraint
+
+|String
+|comment
+|(Optional) Comment for the column. This is
+only used if table generation is in effect.
+|No comment
 |===
 
 *Example 1:*
@@ -2407,6 +2435,8 @@ public @interface JoinTable {
     ForeignKey inverseForeignKey() default @ForeignKey(PROVIDER_DEFAULT);
     UniqueConstraint[] uniqueConstraints() default {};
     Index[] indexes() default {};
+    String check() default "";
+    String comment() default "";
 }
 ----
 
@@ -2471,6 +2501,18 @@ effect.
 |(Optional) Indexes for the table. These are
 only used if table generation is in effect.
 |No additional indexes
+
+|String
+|check
+|(Optional) Check constraint for the table. This is
+only used if table generation is in effect.
+|No check constraint
+
+|String
+|comment
+|(Optional) Comment for the table. This is
+only used if table generation is in effect.
+|No comment
 |===
 
 *Example:*
@@ -4541,6 +4583,8 @@ public @interface SecondaryTable {
     ForeignKey foreignKey() default @ForeignKey(PROVIDER_DEFAULT);
     UniqueConstraint[] uniqueConstraints() default {};
     Index[] indexes() default {};
+    String check() default "";
+    String comment() default "";
 }
 ----
 
@@ -4589,6 +4633,18 @@ entailed by primary key mappings.
 |(Optional) Indexes for the table. These are
 only used if table generation is in effect.
 |No additional indexes
+
+|String
+|check
+|(Optional) Check constraint for the table. This is
+only used if table generation is in effect.
+|No check constraint
+
+|String
+|comment
+|(Optional) Comment for the table. This is
+only used if table generation is in effect.
+|No comment
 |===
 
 *Example 1:* Single secondary table with a single primary key column.
@@ -4806,6 +4862,8 @@ public @interface Table {
     String schema() default "";
     UniqueConstraint[] uniqueConstraints() default {};
     Index[] indexes() default {};
+    String check() default "";
+    String comment() default "";
 }
 ----
 
@@ -4844,6 +4902,18 @@ constraints
 |(Optional) Indexes for the table. These are
 only used if table generation is in effect.
 |No additional indexes
+
+|String
+|check
+|(Optional) Check constraint for the table. This is
+only used if table generation is in effect.
+|No check constraint
+
+|String
+|comment
+|(Optional) Comment for the table. This is
+only used if table generation is in effect.
+|No comment
 |===
 
 *Example:*