HHH-18337 Account for physical naming strategy when querying db sequence

mbellade · mbellade · commit 4b06bf63cdd2 · 2024-08-26T13:47:24.000+02:00
Introduced new signature for `Configurable#configure` which accepts a `GeneratorCreationContext`.
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/model/internal/GeneratorBinder.java b/hibernate-core/src/main/java/org/hibernate/boot/model/internal/GeneratorBinder.java
@@ -560,23 +560,22 @@ private static void checkVersionGenerationAlways(MemberDetails property, Generat
 
 	/**
 	 * If the given {@link Generator} also implements {@link Configurable},
-	 * call its {@link Configurable#configure(Type, Properties, ServiceRegistry)
+	 * call its {@link Configurable#configure(GeneratorCreationContext, Properties)
 	 * configure()} method.
 	 */
 	private static void callConfigure(
 			GeneratorCreationContext creationContext,
 			Generator generator,
 			Map<String, Object> configuration,
 			SimpleValue identifierValue) {
-		if ( generator instanceof Configurable ) {
-			final Configurable configurable = (Configurable) generator;
+		if ( generator instanceof final Configurable configurable ) {
 			final Properties parameters = collectParameters(
 					identifierValue,
 					creationContext.getDatabase().getDialect(),
 					creationContext.getRootClass(),
 					configuration
 			);
-			configurable.configure( identifierValue.getType(), parameters, creationContext.getServiceRegistry() );
+			configurable.configure( creationContext, parameters );
 		}
 	}
 
diff --git a/hibernate-core/src/main/java/org/hibernate/boot/model/internal/GeneratorParameters.java b/hibernate-core/src/main/java/org/hibernate/boot/model/internal/GeneratorParameters.java
@@ -15,6 +15,7 @@
 import org.hibernate.dialect.Dialect;
 import org.hibernate.engine.config.spi.ConfigurationService;
 import org.hibernate.engine.config.spi.StandardConverters;
+import org.hibernate.generator.GeneratorCreationContext;
 import org.hibernate.id.Configurable;
 import org.hibernate.id.IdentifierGenerator;
 import org.hibernate.id.OptimizableGenerator;
@@ -38,7 +39,7 @@
 
 /**
  * Responsible for setting up the parameters which are passed to
- * {@link Configurable#configure(Type, Properties, ServiceRegistry)}
+ * {@link Configurable#configure(GeneratorCreationContext, Properties)}
  * when a {@link Configurable} generator is instantiated.
  *
  * @since 7.0
@@ -51,7 +52,7 @@ public class GeneratorParameters {
 
 	/**
 	 * Collect the parameters which should be passed to
-	 * {@link Configurable#configure(Type, Properties, ServiceRegistry)}.
+	 * {@link Configurable#configure(GeneratorCreationContext, Properties)}.
 	 */
 	public static Properties collectParameters(
 			SimpleValue identifierValue,
diff --git a/hibernate-core/src/main/java/org/hibernate/generator/GeneratorCreationContext.java b/hibernate-core/src/main/java/org/hibernate/generator/GeneratorCreationContext.java
@@ -12,6 +12,7 @@
 import org.hibernate.mapping.Property;
 import org.hibernate.mapping.RootClass;
 import org.hibernate.service.ServiceRegistry;
+import org.hibernate.type.Type;
 
 /**
  * An object passed as a parameter to the constructor or
@@ -34,4 +35,7 @@ public interface GeneratorCreationContext {
 	RootClass getRootClass();
 
 	Property getProperty();
+	default Type getType() {
+		return getProperty().getType();
+	}
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/id/Configurable.java b/hibernate-core/src/main/java/org/hibernate/id/Configurable.java
@@ -11,6 +11,7 @@
 import org.hibernate.MappingException;
 import org.hibernate.boot.model.relational.Database;
 import org.hibernate.boot.model.relational.SqlStringGenerationContext;
+import org.hibernate.generator.GeneratorCreationContext;
 import org.hibernate.service.ServiceRegistry;
 import org.hibernate.type.Type;
 
@@ -21,6 +22,13 @@
  * @author Steve Ebersole
  */
 public interface Configurable {
+	/**
+	 * @deprecated Use {@link #configure(GeneratorCreationContext, Properties)} instead
+	 */
+	@Deprecated( since = "7.0", forRemoval = true )
+	default void configure(Type type, Properties parameters, ServiceRegistry serviceRegistry) throws MappingException {
+	}
+
 	/**
 	 * Configure this instance, given the value of parameters
 	 * specified by the user as XML {@code <param>} elements and
@@ -32,13 +40,14 @@ public interface Configurable {
 	 * then this method is always called before
 	 * {@link org.hibernate.boot.model.relational.ExportableProducer#registerExportables(Database)},
 	 *
-	 * @param type The id property type descriptor
+	 * @param creationContext Access to the generator creation context
 	 * @param parameters param values, keyed by parameter name
-	 * @param serviceRegistry Access to service that may be needed.
 	 *
 	 * @throws MappingException when there's something wrong with the given parameters
 	 */
-	void configure(Type type, Properties parameters, ServiceRegistry serviceRegistry) throws MappingException;
+	default void configure(GeneratorCreationContext creationContext, Properties parameters) throws MappingException {
+		configure( creationContext.getType(), parameters, creationContext.getServiceRegistry() );
+	};
 
 	/**
 	 * Initializes this instance, pre-generating SQL if necessary.
diff --git a/hibernate-core/src/main/java/org/hibernate/id/ForeignGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/ForeignGenerator.java
@@ -10,6 +10,7 @@
 
 import org.hibernate.MappingException;
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
+import org.hibernate.generator.GeneratorCreationContext;
 import org.hibernate.service.ServiceRegistry;
 import org.hibernate.type.Type;
 
@@ -68,7 +69,7 @@ public String getRole() {
 
 
 	@Override
-	public void configure(Type type, Properties parameters, ServiceRegistry serviceRegistry) throws MappingException {
+	public void configure(GeneratorCreationContext creationContext, Properties parameters) throws MappingException {
 		propertyName = parameters.getProperty( PROPERTY );
 		entityName = parameters.getProperty( ENTITY_NAME );
 		if ( propertyName==null ) {
diff --git a/hibernate-core/src/main/java/org/hibernate/id/IdentifierGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/IdentifierGenerator.java
@@ -17,6 +17,8 @@
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
 import org.hibernate.generator.EventType;
 import org.hibernate.generator.EventTypeSets;
+import org.hibernate.generator.Generator;
+import org.hibernate.generator.GeneratorCreationContext;
 import org.hibernate.service.ServiceRegistry;
 import org.hibernate.generator.BeforeExecutionGenerator;
 import org.hibernate.type.Type;
@@ -39,7 +41,7 @@
  * {@code ExportableProducer}, in case the implementation needs to export
  * objects to the database as part of the process of schema export.
  * <p>
- * The {@link #configure(Type, Properties, ServiceRegistry)} method accepts
+ * The {@link #configure(GeneratorCreationContext, Properties)} method accepts
  * a properties object containing named values. These include:
  * <ul>
  * <li>several "standard" parameters with keys defined as static members of
@@ -104,7 +106,7 @@ default void configure(Type type, Properties parameters, ServiceRegistry service
 	 * for example, a sequence or tables.
 	 * <p>
 	 * This method is called just once, after
-	 * {@link #configure(Type, Properties, ServiceRegistry)}.
+	 * {@link #configure(GeneratorCreationContext, Properties)}.
 	 *
 	 * @param database The database instance
 	 */
diff --git a/hibernate-core/src/main/java/org/hibernate/id/IncrementGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/IncrementGenerator.java
@@ -22,6 +22,7 @@
 import org.hibernate.engine.jdbc.env.spi.IdentifierHelper;
 import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
+import org.hibernate.generator.GeneratorCreationContext;
 import org.hibernate.internal.CoreLogging;
 import org.hibernate.internal.CoreMessageLogger;
 import org.hibernate.service.ServiceRegistry;
@@ -85,10 +86,10 @@ public synchronized Object generate(SharedSessionContractImplementor session, Ob
 	}
 
 	@Override
-	public void configure(Type type, Properties parameters, ServiceRegistry serviceRegistry) throws MappingException {
-		returnClass = type.getReturnedClass();
+	public void configure(GeneratorCreationContext creationContext, Properties parameters) throws MappingException {
+		returnClass = creationContext.getType().getReturnedClass();
 
-		final JdbcEnvironment jdbcEnvironment = serviceRegistry.requireService( JdbcEnvironment.class );
+		final JdbcEnvironment jdbcEnvironment = creationContext.getServiceRegistry().requireService( JdbcEnvironment.class );
 		final IdentifierHelper identifierHelper = jdbcEnvironment.getIdentifierHelper();
 
 		column = parameters.getProperty( COLUMN );
diff --git a/hibernate-core/src/main/java/org/hibernate/id/PersistentIdentifierGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/PersistentIdentifierGenerator.java
@@ -8,14 +8,15 @@
 
 import java.util.Properties;
 
+import org.hibernate.generator.GeneratorCreationContext;
 import org.hibernate.service.ServiceRegistry;
 import org.hibernate.type.Type;
 
 /**
  * An {@link IdentifierGenerator} that requires creation of database objects.
  * <p>
  * All instances have access to a special mapping parameter in their
- * {@link #configure(Type, Properties, ServiceRegistry)} method: schema
+ * {@link #configure(GeneratorCreationContext, Properties)} method: schema
  *
  * @author Gavin King
  * @author Steve Ebersole
diff --git a/hibernate-core/src/main/java/org/hibernate/id/PostInsertIdentifierGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/PostInsertIdentifierGenerator.java
@@ -8,8 +8,9 @@
 
 import org.hibernate.generator.EventType;
 import org.hibernate.generator.EventTypeSets;
-import org.hibernate.service.ServiceRegistry;
+import org.hibernate.generator.GeneratorCreationContext;
 import org.hibernate.generator.OnExecutionGenerator;
+import org.hibernate.service.ServiceRegistry;
 import org.hibernate.type.Type;
 
 import java.util.EnumSet;
diff --git a/hibernate-core/src/main/java/org/hibernate/id/SelectGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/SelectGenerator.java
@@ -9,9 +9,9 @@
 import java.util.Properties;
 
 import org.hibernate.dialect.Dialect;
+import org.hibernate.generator.GeneratorCreationContext;
 import org.hibernate.generator.OnExecutionGenerator;
 import org.hibernate.persister.entity.EntityPersister;
-import org.hibernate.service.ServiceRegistry;
 import org.hibernate.type.Type;
 
 import static org.hibernate.generator.internal.NaturalIdHelper.getNaturalIdPropertyNames;
@@ -87,7 +87,7 @@ public class SelectGenerator
 	private String uniqueKeyPropertyName;
 
 	@Override
-	public void configure(Type type, Properties parameters, ServiceRegistry serviceRegistry) {
+	public void configure(GeneratorCreationContext creationContext, Properties parameters) {
 		uniqueKeyPropertyName = parameters.getProperty( KEY );
 	}
 
diff --git a/hibernate-core/src/main/java/org/hibernate/id/UUIDGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/UUIDGenerator.java
@@ -14,10 +14,10 @@
 import org.hibernate.boot.registry.classloading.spi.ClassLoaderService;
 import org.hibernate.boot.registry.classloading.spi.ClassLoadingException;
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
+import org.hibernate.generator.GeneratorCreationContext;
 import org.hibernate.id.uuid.StandardRandomStrategy;
 import org.hibernate.internal.CoreLogging;
 import org.hibernate.internal.CoreMessageLogger;
-import org.hibernate.service.ServiceRegistry;
 import org.hibernate.type.Type;
 import org.hibernate.type.descriptor.java.UUIDJavaType;
 
@@ -50,7 +50,7 @@ public class UUIDGenerator implements IdentifierGenerator {
 	private UUIDJavaType.ValueTransformer valueTransformer;
 
 	@Override
-	public void configure(Type type, Properties parameters, ServiceRegistry serviceRegistry) throws MappingException {
+	public void configure(GeneratorCreationContext creationContext, Properties parameters) throws MappingException {
 		// check first for an explicit strategy instance
 		strategy = (UUIDGenerationStrategy) parameters.get( UUID_GEN_STRATEGY );
 
@@ -60,7 +60,7 @@ public void configure(Type type, Properties parameters, ServiceRegistry serviceR
 			if ( strategyClassName != null ) {
 				try {
 					final Class<?> strategyClass =
-							serviceRegistry.requireService( ClassLoaderService.class )
+							creationContext.getServiceRegistry().requireService( ClassLoaderService.class )
 									.classForName( strategyClassName );
 					try {
 						strategy = (UUIDGenerationStrategy) strategyClass.newInstance();
@@ -80,6 +80,7 @@ public void configure(Type type, Properties parameters, ServiceRegistry serviceR
 			strategy = StandardRandomStrategy.INSTANCE;
 		}
 
+		final Type type = creationContext.getType();
 		if ( UUID.class.isAssignableFrom( type.getReturnedClass() ) ) {
 			valueTransformer = UUIDJavaType.PassThroughTransformer.INSTANCE;
 		}
diff --git a/hibernate-core/src/main/java/org/hibernate/id/UUIDHexGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/UUIDHexGenerator.java
@@ -10,9 +10,9 @@
 
 import org.hibernate.MappingException;
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
+import org.hibernate.generator.GeneratorCreationContext;
 import org.hibernate.internal.CoreLogging;
 import org.hibernate.internal.CoreMessageLogger;
-import org.hibernate.service.ServiceRegistry;
 import org.hibernate.type.Type;
 
 import static org.hibernate.internal.util.config.ConfigurationHelper.getString;
@@ -53,7 +53,7 @@ public UUIDHexGenerator() {
 
 
 	@Override
-	public void configure(Type type, Properties parameters, ServiceRegistry serviceRegistry) throws MappingException {
+	public void configure(GeneratorCreationContext creationContext, Properties parameters) throws MappingException {
 		sep = getString( SEPARATOR, parameters, "" );
 	}
 
diff --git a/hibernate-core/src/main/java/org/hibernate/id/enhanced/SequenceStyleGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/enhanced/SequenceStyleGenerator.java
@@ -24,6 +24,7 @@
 import org.hibernate.engine.jdbc.env.spi.IdentifierHelper;
 import org.hibernate.engine.jdbc.env.spi.JdbcEnvironment;
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
+import org.hibernate.generator.GeneratorCreationContext;
 import org.hibernate.id.BulkInsertionCapableIdentifierGenerator;
 import org.hibernate.id.IdentifierGenerator;
 import org.hibernate.id.PersistentIdentifierGenerator;
@@ -193,11 +194,12 @@ public Type getIdentifierType() {
 	// Configurable implementation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 	@Override
-	public void configure(Type type, Properties parameters, ServiceRegistry serviceRegistry) throws MappingException {
+	public void configure(GeneratorCreationContext creationContext, Properties parameters) throws MappingException {
+		final ServiceRegistry serviceRegistry = creationContext.getServiceRegistry();
 		final JdbcEnvironment jdbcEnvironment = serviceRegistry.requireService( JdbcEnvironment.class );
 		final Dialect dialect = jdbcEnvironment.getDialect();
 
-		identifierType = type;
+		this.identifierType = creationContext.getType();
 
 		final QualifiedName sequenceName = determineSequenceName( parameters, dialect, jdbcEnvironment, serviceRegistry );
 		final int initialValue = determineInitialValue( parameters );
@@ -214,7 +216,8 @@ public void configure(Type type, Properties parameters, ServiceRegistry serviceR
 				physicalSequence,
 				optimizationStrategy,
 				serviceRegistry,
-				determineContributor( parameters )
+				determineContributor( parameters ),
+				creationContext
 		);
 
 		if ( physicalSequence
@@ -224,8 +227,8 @@ public void configure(Type type, Properties parameters, ServiceRegistry serviceR
 			LOG.forcingTableUse();
 		}
 
-		databaseStructure = buildDatabaseStructure(
-				type,
+		this.databaseStructure = buildDatabaseStructure(
+				identifierType,
 				parameters,
 				jdbcEnvironment,
 				forceTableUse,
@@ -251,7 +254,8 @@ private int adjustIncrementSize(
 			boolean physicalSequence,
 			OptimizerDescriptor optimizationStrategy,
 			ServiceRegistry serviceRegistry,
-			String contributor) {
+			String contributor,
+			GeneratorCreationContext creationContext) {
 		final ConfigurationService configurationService = serviceRegistry.requireService( ConfigurationService.class );
 		final SequenceMismatchStrategy sequenceMismatchStrategy = configurationService.getSetting(
 				AvailableSettings.SEQUENCE_INCREMENT_SIZE_MISMATCH_STRATEGY,
@@ -262,7 +266,13 @@ private int adjustIncrementSize(
 		if ( sequenceMismatchStrategy != SequenceMismatchStrategy.NONE
 				&& optimizationStrategy.isPooled()
 				&& physicalSequence ) {
-			final String databaseSequenceName = sequenceName.getObjectName().getText();
+			final Database database = creationContext.getDatabase();
+			final String databaseSequenceName = database != null ?
+					database.getPhysicalNamingStrategy().toPhysicalSequenceName(
+							sequenceName.getObjectName(),
+							jdbcEnvironment
+					).getText() :
+					sequenceName.getObjectName().getText();
 			final Number databaseIncrementValue =
 					isSchemaToBeRecreated( contributor, configurationService ) ? null
 							: getSequenceIncrementValue( jdbcEnvironment, databaseSequenceName );
diff --git a/hibernate-core/src/main/java/org/hibernate/id/enhanced/TableGenerator.java b/hibernate-core/src/main/java/org/hibernate/id/enhanced/TableGenerator.java
@@ -36,6 +36,7 @@
 import org.hibernate.engine.spi.SharedSessionContractImplementor;
 import org.hibernate.event.spi.EventManager;
 import org.hibernate.event.spi.HibernateMonitoringEvent;
+import org.hibernate.generator.GeneratorCreationContext;
 import org.hibernate.id.ExportableColumn;
 import org.hibernate.id.IdentifierGeneratorHelper;
 import org.hibernate.id.IntegralDataTypeHolder;
@@ -332,10 +333,11 @@ public String[] getAllSqlForTests() {
 	}
 
 	@Override
-	public void configure(Type type, Properties parameters, ServiceRegistry serviceRegistry) throws MappingException {
+	public void configure(GeneratorCreationContext creationContext, Properties parameters) throws MappingException {
+		final ServiceRegistry serviceRegistry = creationContext.getServiceRegistry();
 		storeLastUsedValue = serviceRegistry.requireService( ConfigurationService.class )
 				.getSetting( AvailableSettings.TABLE_GENERATOR_STORE_LAST_USED, StandardConverters.BOOLEAN, true );
-		identifierType = type;
+		identifierType = creationContext.getType();
 
 		final JdbcEnvironment jdbcEnvironment = serviceRegistry.requireService( JdbcEnvironment.class );
 
diff --git a/hibernate-core/src/main/java/org/hibernate/mapping/SimpleValue.java b/hibernate-core/src/main/java/org/hibernate/mapping/SimpleValue.java
@@ -1051,6 +1051,11 @@ public Property getProperty() {
 			return rootClass.getIdentifierProperty();
 		}
 
+		@Override
+		public Type getType() {
+			return SimpleValue.this.getType();
+		}
+
 		// we could add these if it helps integrate old infrastructure
 //		@Override
 //		public Properties getParameters() {
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/id/SequenceStyleGeneratorBehavesLikeSequeceHiloGeneratorWitZeroIncrementSizeTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/id/SequenceStyleGeneratorBehavesLikeSequeceHiloGeneratorWitZeroIncrementSizeTest.java
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/id/enhanced/SequenceStyleConfigUnitTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/id/enhanced/SequenceStyleConfigUnitTest.java
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/idgen/enhanced/table/Db2GenerationTest.java b/hibernate-core/src/test/java/org/hibernate/orm/test/idgen/enhanced/table/Db2GenerationTest.java
diff --git a/hibernate-core/src/test/java/org/hibernate/orm/test/idgen/userdefined/NativeGenerator.java b/hibernate-core/src/test/java/org/hibernate/orm/test/idgen/userdefined/NativeGenerator.java
diff --git a/migration-guide.adoc b/migration-guide.adoc
