HHH-17325 - @softdelete with timestamp

sebersole · sebersole · commit e1808bdfd96b · 2025-02-20T21:03:16.000-06:00
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/model/internal/SoftDeleteHelper.java b/hibernate-core/src/main/java/org/hibernate/boot/model/internal/SoftDeleteHelper.java
@@ -15,6 +15,7 @@
 import org.hibernate.mapping.Column;
 import org.hibernate.mapping.SoftDeletable;
 import org.hibernate.mapping.Table;
+import org.hibernate.metamodel.UnsupportedMappingException;
 import org.hibernate.metamodel.mapping.SoftDeletableModelPart;
 import org.hibernate.metamodel.mapping.internal.MappingModelCreationProcess;
 import org.hibernate.metamodel.mapping.internal.SoftDeleteMappingImpl;
@@ -63,6 +64,11 @@ private static BasicValue createSoftDeleteIndicatorValue(
 		softDeleteIndicatorValue.makeSoftDelete( softDeleteConfig.strategy() );
 
 		if ( softDeleteConfig.strategy() == SoftDeleteType.TIMESTAMP ) {
+			if ( softDeleteConfig.converter() != SoftDelete.UnspecifiedConversion.class ) {
+				throw new UnsupportedMappingException(
+						"Specifying SoftDelete#converter in conjunction with SoftDeleteType.TIMESTAMP is not supported"
+				);
+			}
 			softDeleteIndicatorValue.setImplicitJavaTypeAccess( (typeConfiguration) -> Instant.class );
 		}
 		else {
@@ -90,9 +96,6 @@ private static Column createSoftDeleteIndicatorColumn(
 
 		applyColumnName( softDeleteColumn, softDeleteConfig, context );
 
-		softDeleteColumn.setLength( 1 );
-		softDeleteColumn.setNullable( false );
-		softDeleteColumn.setUnique( false );
 		softDeleteColumn.setOptions( softDeleteConfig.options() );
 		if ( isBlank( softDeleteConfig.comment() ) ) {
 			softDeleteColumn.setComment( "Soft-delete indicator" );
@@ -101,6 +104,16 @@ private static Column createSoftDeleteIndicatorColumn(
 			softDeleteColumn.setComment( softDeleteConfig.comment() );
 		}
 
+		softDeleteColumn.setUnique( false );
+
+		if ( softDeleteConfig.strategy() == SoftDeleteType.TIMESTAMP ) {
+			softDeleteColumn.setNullable( true );
+		}
+		else {
+			softDeleteColumn.setLength( 1 );
+			softDeleteColumn.setNullable( false );
+		}
+
 		return softDeleteColumn;
 	}
 
diff --git a/hibernate-core/src/main/java/org/hibernate/metamodel/mapping/SoftDeletableModelPart.java b/hibernate-core/src/main/java/org/hibernate/metamodel/mapping/SoftDeletableModelPart.java
@@ -15,5 +15,8 @@ public interface SoftDeletableModelPart extends ModelPartContainer {
 	 */
 	SoftDeleteMapping getSoftDeleteMapping();
 
+	/**
+	 * Details about the table which holds the soft-delete column.
+	 */
 	TableDetails getSoftDeleteTableDetails();
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/metamodel/mapping/SoftDeleteMapping.java b/hibernate-core/src/main/java/org/hibernate/metamodel/mapping/SoftDeleteMapping.java
@@ -82,7 +82,8 @@ public interface SoftDeleteMapping extends SelectableMapping, VirtualModelPart,
 	ColumnValueBinding createDeletedValueBinding(ColumnReference softDeleteColumnReference);
 
 	void applyNonDeletedRestriction(RestrictedTableMutationBuilder<?, ?> tableMutationBuilder);
-	void applyDeletedAssignment(ColumnValuesTableMutationBuilder tableMutationBuilder);
+	void applyDeletedAssignment(ColumnValuesTableMutationBuilder<?> tableMutationBuilder);
+	void applyNonDeletedAssignment(ColumnValuesTableMutationBuilder<?> tableMutationBuilder);
 
 
 	// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/hibernate-core/src/main/java/org/hibernate/metamodel/mapping/internal/SoftDeleteMappingImpl.java b/hibernate-core/src/main/java/org/hibernate/metamodel/mapping/internal/SoftDeleteMappingImpl.java
@@ -220,8 +220,11 @@ public Predicate createNonDeletedRestriction(TableReference tableReference, SqlE
 	public ColumnValueBinding createNonDeletedValueBinding(ColumnReference softDeleteColumnReference) {
 		final ColumnWriteFragment nonDeletedFragment;
 		if ( strategy == SoftDeleteType.TIMESTAMP ) {
-//			return new ColumnValueBinding( softDeleteColumnReference, null );
-			throw new UnsupportedOperationException( );
+			nonDeletedFragment = new ColumnWriteFragment(
+					null,
+					Collections.emptyList(),
+					jdbcMapping
+			);
 		}
 		else {
 			nonDeletedFragment = new ColumnWriteFragment(
@@ -237,12 +240,11 @@ public ColumnValueBinding createNonDeletedValueBinding(ColumnReference softDelet
 	public ColumnValueBinding createDeletedValueBinding(ColumnReference softDeleteColumnReference) {
 		final ColumnWriteFragment deletedFragment;
 		if ( strategy == SoftDeleteType.TIMESTAMP ) {
-//			deletedFragment = new ColumnWriteFragment(
-//					currentTimestampFunctionName,
-//					Collections.emptyList(),
-//					getJdbcMapping()
-//			);
-			throw new UnsupportedOperationException( );
+			deletedFragment = new ColumnWriteFragment(
+					currentTimestampFunctionName,
+					Collections.emptyList(),
+					getJdbcMapping()
+			);
 		}
 		else {
 			deletedFragment = new ColumnWriteFragment(
@@ -269,7 +271,7 @@ public void applyNonDeletedRestriction(RestrictedTableMutationBuilder<?, ?> tabl
 	}
 
 	@Override
-	public void applyDeletedAssignment(ColumnValuesTableMutationBuilder tableMutationBuilder) {
+	public void applyDeletedAssignment(ColumnValuesTableMutationBuilder<?> tableMutationBuilder) {
 		if ( strategy == SoftDeleteType.TIMESTAMP ) {
 			tableMutationBuilder.addValueColumn( getColumnName(), currentTimestampFunctionName, getJdbcMapping() );
 		}
@@ -278,6 +280,21 @@ public void applyDeletedAssignment(ColumnValuesTableMutationBuilder tableMutatio
 		}
 	}
 
+	@Override
+	public void applyNonDeletedAssignment(ColumnValuesTableMutationBuilder<?> tableMutationBuilder) {
+		if ( strategy == SoftDeleteType.TIMESTAMP ) {
+			final ColumnReference columnReference = new ColumnReference(
+					tableMutationBuilder.getMutatingTable(),
+					this
+			);
+			final ColumnValueBinding nonDeletedValueBinding = createNonDeletedValueBinding( columnReference );
+			tableMutationBuilder.addValueColumn( nonDeletedValueBinding );
+		}
+		else {
+			tableMutationBuilder.addValueColumn( getColumnName(), nonDeletedLiteralText, getJdbcMapping() );
+		}
+	}
+
 	@Override
 	public JdbcMapping getJdbcMapping() {
 		return jdbcMapping;
diff --git a/hibernate-core/src/main/java/org/hibernate/persister/collection/BasicCollectionPersister.java b/hibernate-core/src/main/java/org/hibernate/persister/collection/BasicCollectionPersister.java
@@ -223,16 +223,14 @@ public RestrictedTableMutation<JdbcMutationOperation> generateDeleteAllAst(Mutat
 		final ColumnReference softDeleteColumn = new ColumnReference( tableReference, softDeleteMapping );
 		final ColumnValueBinding nonDeletedBinding = softDeleteMapping.createNonDeletedValueBinding( softDeleteColumn );
 		final ColumnValueBinding deletedBinding = softDeleteMapping.createDeletedValueBinding( softDeleteColumn );
-		restrictionBindings.add( nonDeletedBinding );
-		final List<ColumnValueBinding> valueBindings = List.of( deletedBinding );
 
 		return new TableUpdateStandard(
 				tableReference,
 				this,
 				"soft-delete removal",
-				valueBindings,
+				List.of( deletedBinding ),
 				restrictionBindings,
-				null
+				List.of( nonDeletedBinding )
 		);
 	}
 
@@ -329,7 +327,7 @@ else if ( indexDescriptor != null ) {
 
 		final SoftDeleteMapping softDeleteMapping = getAttributeMapping().getSoftDeleteMapping();
 		if ( softDeleteMapping != null ) {
-			insertBuilder.addValueColumn( softDeleteMapping );
+			softDeleteMapping.applyNonDeletedAssignment( insertBuilder );
 		}
 	}
 
diff --git a/hibernate-core/src/main/java/org/hibernate/persister/entity/AbstractEntityPersister.java b/hibernate-core/src/main/java/org/hibernate/persister/entity/AbstractEntityPersister.java
@@ -3458,7 +3458,7 @@ public void addDiscriminatorToInsertGroup(MutationGroupBuilder insertGroupBuilde
 	public void addSoftDeleteToInsertGroup(MutationGroupBuilder insertGroupBuilder) {
 		if ( softDeleteMapping != null ) {
 			final TableInsertBuilder insertBuilder = insertGroupBuilder.getTableDetailsBuilder( getIdentifierTableName() );
-			insertBuilder.addValueColumn( softDeleteMapping );
+			softDeleteMapping.applyNonDeletedAssignment( insertBuilder );
 		}
 	}
 
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/ast/spi/AbstractSqlAstTranslator.java b/hibernate-core/src/main/java/org/hibernate/sql/ast/spi/AbstractSqlAstTranslator.java
@@ -8954,7 +8954,8 @@ private void visitTableUpdate(RestrictedTableMutation<? extends MutationOperatio
 				tableUpdate.forEachOptimisticLockBinding( (position, columnValueBinding) -> {
 					sqlBuffer.append( " and " );
 					sqlBuffer.append( columnValueBinding.getColumnReference().getColumnExpression() );
-					if ( columnValueBinding.getValueExpression() == null ) {
+					if ( columnValueBinding.getValueExpression() == null
+							|| columnValueBinding.getValueExpression().getFragment() == null ) {
 						sqlBuffer.append( " is null" );
 					}
 					else {
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/model/ast/ColumnValueBinding.java b/hibernate-core/src/main/java/org/hibernate/sql/model/ast/ColumnValueBinding.java
@@ -9,11 +9,9 @@
 import org.hibernate.sql.ast.tree.expression.ColumnReference;
 
 /**
- * Represents the binding of a value to a column.  Can be used to
- * uniformly model value assignments wrt inserts, updates and upserts.
- *
- * @apiNote Practically speaking, the {@linkplain #getValueExpression() value}
- * can only be a JDBC parameter or a literal.
+ * Represents the binding of a value to a column.  Uniformly
+ * models both value assignments and value restrictions in
+ * relation to inserts, updates and upserts.
  *
  * @author Steve Ebersole
  */
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/model/ast/ColumnWriteFragment.java b/hibernate-core/src/main/java/org/hibernate/sql/model/ast/ColumnWriteFragment.java
@@ -16,8 +16,8 @@
 
 /**
  * Models a column's value expression within the SQL AST. Used to model:<ul>
- *     <li>a column's new value in a SET clause</li>
- *     <li>a column's old value in a restriction (optimistic locking)</li>
+ *     <li>a column's new value (UPDATE SET clause or INSERT VALUES clause)</li>
+ *     <li>a column's old value in a restriction (optimistic locking, etc.)</li>
  * </ul>
  *
  * @see ColumnTransformer#write()
@@ -64,32 +64,29 @@ public void accept(SqlAstWalker sqlTreeWalker) {
 
 	@Override
 	public String toString() {
-		switch ( parameters.size() ) {
-			case 0:
-				return String.format(
-						Locale.ROOT,
-						"ColumnWriteFragment(%s)@%s",
-						fragment,
-						hashCode()
-				);
-			case 1:
-				return String.format(
-						Locale.ROOT,
-						"ColumnWriteFragment(%s = %s (%s))@%s",
-						parameters.get( 0 ).getColumnReference().getColumnExpression(),
-						fragment,
-						parameters.get( 0 ).getUsage(),
-						hashCode()
-				);
-			default:
-				return String.format(
-						Locale.ROOT,
-						"ColumnWriteFragment(%s = %s (%s))@%s",
-						parameters,
-						fragment,
-						parameters.get( 0 ).getUsage(),
-						hashCode()
-				);
-		}
+		return switch ( parameters.size() ) {
+			case 0 -> String.format(
+					Locale.ROOT,
+					"ColumnWriteFragment(%s)@%s",
+					fragment,
+					hashCode()
+			);
+			case 1 -> String.format(
+					Locale.ROOT,
+					"ColumnWriteFragment(%s = %s (%s))@%s",
+					parameters.get( 0 ).getColumnReference().getColumnExpression(),
+					fragment,
+					parameters.get( 0 ).getUsage(),
+					hashCode()
+			);
+			default -> String.format(
+					Locale.ROOT,
+					"ColumnWriteFragment(%s = %s (%s))@%s",
+					parameters,
+					fragment,
+					parameters.get( 0 ).getUsage(),
+					hashCode()
+			);
+		};
 	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/model/ast/builder/AbstractTableInsertBuilder.java b/hibernate-core/src/main/java/org/hibernate/sql/model/ast/builder/AbstractTableInsertBuilder.java
@@ -81,6 +81,11 @@ public void addValueColumn(String columnName, String columnWriteFragment, JdbcMa
 		}
 	}
 
+	@Override
+	public void addValueColumn(ColumnValueBinding valueBinding) {
+		valueBindingList.add( valueBinding );
+	}
+
 	@Override
 	public void addKeyColumn(String columnName, String columnWriteFragment, JdbcMapping jdbcMapping) {
 		addColumn( columnName, columnWriteFragment, jdbcMapping, keyBindingList );
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/model/ast/builder/AbstractTableUpdateBuilder.java b/hibernate-core/src/main/java/org/hibernate/sql/model/ast/builder/AbstractTableUpdateBuilder.java
@@ -103,6 +103,11 @@ public void addValueColumn(
 		}
 	}
 
+	@Override
+	public void addValueColumn(ColumnValueBinding valueBinding) {
+		valueBindings.add( valueBinding );
+	}
+
 	@Override
 	public void addKeyColumn(
 			String columnName,
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/model/ast/builder/ColumnValuesTableMutationBuilder.java b/hibernate-core/src/main/java/org/hibernate/sql/model/ast/builder/ColumnValuesTableMutationBuilder.java
@@ -6,14 +6,16 @@
 
 import org.hibernate.metamodel.mapping.JdbcMapping;
 import org.hibernate.metamodel.mapping.SelectableMapping;
+import org.hibernate.sql.model.ast.ColumnValueBinding;
+import org.hibernate.sql.model.ast.TableMutation;
 
 /**
  * Common operations of {@link TableUpdateBuilder} and {@link TableInsertBuilder}.
  *
  * @author Steve Ebersole
  * @author Gavin King
  */
-public interface ColumnValuesTableMutationBuilder {
+public interface ColumnValuesTableMutationBuilder<M extends TableMutation<?>> extends TableMutationBuilder<M> {
 	/**
 	 * Add a column as part of the values list
 	 */
@@ -37,6 +39,8 @@ default void addValueColumn(SelectableMapping selectableMapping) {
 		);
 	}
 
+	void addValueColumn(ColumnValueBinding valueBinding);
+
 	/**
 	 * Add a key column
 	 */
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/model/ast/builder/TableInsertBuilder.java b/hibernate-core/src/main/java/org/hibernate/sql/model/ast/builder/TableInsertBuilder.java
@@ -13,7 +13,9 @@
  *
  * @author Steve Ebersole
  */
-public interface TableInsertBuilder extends TableMutationBuilder<TableInsert>, ColumnValuesTableMutationBuilder,
+public interface TableInsertBuilder
+		extends TableMutationBuilder<TableInsert>,
+		ColumnValuesTableMutationBuilder<TableInsert>,
 		SelectableConsumer {
 
 
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/model/ast/builder/TableUpdateBuilder.java b/hibernate-core/src/main/java/org/hibernate/sql/model/ast/builder/TableUpdateBuilder.java
@@ -15,7 +15,9 @@
  * @author Steve Ebersole
  */
 public interface TableUpdateBuilder<O extends MutationOperation>
-		extends RestrictedTableMutationBuilder<O, RestrictedTableMutation<O>>, ColumnValuesTableMutationBuilder, SelectableConsumer {
+		extends RestrictedTableMutationBuilder<O, RestrictedTableMutation<O>>,
+		ColumnValuesTableMutationBuilder<RestrictedTableMutation<O>>,
+		SelectableConsumer {
 
 	/**
 	 * Allows using the update builder as selectable consumer.
diff --git a/hibernate-core/src/main/java/org/hibernate/sql/model/ast/builder/TableUpdateBuilderSkipped.java b/hibernate-core/src/main/java/org/hibernate/sql/model/ast/builder/TableUpdateBuilderSkipped.java
@@ -6,6 +6,7 @@
 
 import org.hibernate.metamodel.mapping.JdbcMapping;
 import org.hibernate.metamodel.mapping.SelectableMapping;
+import org.hibernate.sql.model.ast.ColumnValueBinding;
 import org.hibernate.sql.model.ast.ColumnValueBindingList;
 import org.hibernate.sql.model.ast.MutatingTableReference;
 import org.hibernate.sql.model.ast.RestrictedTableMutation;
@@ -70,6 +71,11 @@ public void addValueColumn(String columnName, String columnWriteFragment, JdbcMa
 		// nothing to do
 	}
 
+	@Override
+	public void addValueColumn(ColumnValueBinding valueBinding) {
+		// nothing to do
+	}
+
 	@Override
 	public void addKeyColumn(String columnName, String valueExpression, JdbcMapping jdbcMapping) {
 		// nothing to do
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/CustomTrueFalseConverter.java b/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/CustomTrueFalseConverter.java
@@ -2,7 +2,7 @@
  * SPDX-License-Identifier: LGPL-2.1-or-later
  * Copyright Red Hat Inc. and Hibernate Authors
  */
-package org.hibernate.orm.test.softdelete.discovery;
+package org.hibernate.orm.test.softdelete;
 
 import jakarta.persistence.AttributeConverter;
 
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/discovery/override/AnEntity.java b/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/discovery/override/AnEntity.java
@@ -13,7 +13,7 @@
 import jakarta.persistence.JoinColumn;
 import jakarta.persistence.Table;
 import org.hibernate.annotations.SoftDelete;
-import org.hibernate.orm.test.softdelete.discovery.CustomTrueFalseConverter;
+import org.hibernate.orm.test.softdelete.CustomTrueFalseConverter;
 
 import java.util.Collection;
 
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/discovery/pkg2/package-info.java b/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/discovery/pkg2/package-info.java
@@ -13,4 +13,4 @@
 package org.hibernate.orm.test.softdelete.discovery.pkg2;
 
 import org.hibernate.annotations.SoftDelete;
-import org.hibernate.orm.test.softdelete.discovery.CustomTrueFalseConverter;
+import org.hibernate.orm.test.softdelete.CustomTrueFalseConverter;
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/timestamp/BadAss.java b/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/timestamp/BadAss.java
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/timestamp/BadJuju.java b/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/timestamp/BadJuju.java
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/timestamp/Employee.java b/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/timestamp/Employee.java
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/timestamp/MappingVerificationTests.java b/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/timestamp/MappingVerificationTests.java
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/timestamp/UsageTests.java b/hibernate-core/src/test/java/org/hibernate/orm/test/softdelete/timestamp/UsageTests.java

Original file line number	Diff line number	Diff line change
`@@ -15,5 +15,8 @@ public interface SoftDeletableModelPart extends ModelPartContainer {`
`15`	`15`	`*/`
`16`	`16`	`SoftDeleteMapping getSoftDeleteMapping();`
`17`	`17`
	`18`	`+ /**`
	`19`	`+ * Details about the table which holds the soft-delete column.`
	`20`	`+ */`
`18`	`21`	`TableDetails getSoftDeleteTableDetails();`
`19`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -3458,7 +3458,7 @@ public void addDiscriminatorToInsertGroup(MutationGroupBuilder insertGroupBuilde`
`3458`	`3458`	`public void addSoftDeleteToInsertGroup(MutationGroupBuilder insertGroupBuilder) {`
`3459`	`3459`	`if ( softDeleteMapping != null ) {`
`3460`	`3460`	`final TableInsertBuilder insertBuilder = insertGroupBuilder.getTableDetailsBuilder( getIdentifierTableName() );`
`3461`		`- insertBuilder.addValueColumn( softDeleteMapping );`
	`3461`	`+ softDeleteMapping.applyNonDeletedAssignment( insertBuilder );`
`3462`	`3462`	`}`
`3463`	`3463`	`}`
`3464`	`3464`
Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,11 @@ public void addValueColumn(String columnName, String columnWriteFragment, JdbcMa`
`81`	`81`	`}`
`82`	`82`	`}`
`83`	`83`
	`84`	`+ @Override`
	`85`	`+ public void addValueColumn(ColumnValueBinding valueBinding) {`
	`86`	`+ valueBindingList.add( valueBinding );`
	`87`	`+ }`
	`88`	`+`
`84`	`89`	`@Override`
`85`	`90`	`public void addKeyColumn(String columnName, String columnWriteFragment, JdbcMapping jdbcMapping) {`
`86`	`91`	`addColumn( columnName, columnWriteFragment, jdbcMapping, keyBindingList );`