Rename quarkus.datasource.db-min-version to db-version

yrodiere · yrodiere · commit d0ea5ca5dd6c · 2023-03-09T13:03:50.000+01:00
diff --git a/extensions/agroal/deployment/src/main/java/io/quarkus/agroal/deployment/AgroalProcessor.java b/extensions/agroal/deployment/src/main/java/io/quarkus/agroal/deployment/AgroalProcessor.java
@@ -186,7 +186,7 @@ private DataSourceSupport getDataSourceSupport(
             String dataSourceName = aggregatedDataSourceBuildTimeConfig.getName();
             dataSourceSupportEntries.put(dataSourceName,
                     new DataSourceSupport.Entry(dataSourceName, aggregatedDataSourceBuildTimeConfig.getDbKind(),
-                            aggregatedDataSourceBuildTimeConfig.getDataSourceConfig().dbMinVersion,
+                            aggregatedDataSourceBuildTimeConfig.getDataSourceConfig().dbVersion,
                             aggregatedDataSourceBuildTimeConfig.getResolvedDriverClass(),
                             aggregatedDataSourceBuildTimeConfig.isDefault()));
         }
@@ -275,7 +275,7 @@ void generateDataSourceBeans(AgroalRecorder recorder,
 
             jdbcDataSource.produce(new JdbcDataSourceBuildItem(dataSourceName,
                     entry.getValue().resolvedDbKind,
-                    entry.getValue().dbMinVersion,
+                    entry.getValue().dbVersion,
                     entry.getValue().isDefault));
         }
     }
diff --git a/extensions/agroal/runtime/src/main/java/io/quarkus/agroal/runtime/DataSourceSupport.java b/extensions/agroal/runtime/src/main/java/io/quarkus/agroal/runtime/DataSourceSupport.java
@@ -18,16 +18,16 @@ public DataSourceSupport(boolean disableSslSupport, boolean mpMetricsPresent, Ma
     public static class Entry {
         public final String dataSourceName;
         public final String resolvedDbKind;
-        public final Optional<String> dbMinVersion;
+        public final Optional<String> dbVersion;
         public final String resolvedDriverClass;
         public final boolean isDefault;
 
-        public Entry(String dataSourceName, String resolvedDbKind, Optional<String> dbMinVersion,
+        public Entry(String dataSourceName, String resolvedDbKind, Optional<String> dbVersion,
                 String resolvedDriverClass,
                 boolean isDefault) {
             this.dataSourceName = dataSourceName;
             this.resolvedDbKind = resolvedDbKind;
-            this.dbMinVersion = dbMinVersion;
+            this.dbVersion = dbVersion;
             this.resolvedDriverClass = resolvedDriverClass;
             this.isDefault = isDefault;
         }
diff --git a/extensions/agroal/spi/src/main/java/io/quarkus/agroal/spi/JdbcDataSourceBuildItem.java b/extensions/agroal/spi/src/main/java/io/quarkus/agroal/spi/JdbcDataSourceBuildItem.java
@@ -16,13 +16,13 @@ public final class JdbcDataSourceBuildItem extends MultiBuildItem {
 
     private final String dbKind;
 
-    private final Optional<String> dbMinVersion;
+    private final Optional<String> dbVersion;
     private final boolean isDefault;
 
-    public JdbcDataSourceBuildItem(String name, String kind, Optional<String> dbMinVersion, boolean isDefault) {
+    public JdbcDataSourceBuildItem(String name, String kind, Optional<String> dbVersion, boolean isDefault) {
         this.name = name;
         this.dbKind = kind;
-        this.dbMinVersion = dbMinVersion;
+        this.dbVersion = dbVersion;
         this.isDefault = isDefault;
     }
 
@@ -34,8 +34,8 @@ public String getDbKind() {
         return dbKind;
     }
 
-    public Optional<String> getDbMinVersion() {
-        return dbMinVersion;
+    public Optional<String> getDbVersion() {
+        return dbVersion;
     }
 
     public boolean isDefault() {
diff --git a/extensions/datasource/runtime/src/main/java/io/quarkus/datasource/runtime/DataSourceBuildTimeConfig.java b/extensions/datasource/runtime/src/main/java/io/quarkus/datasource/runtime/DataSourceBuildTimeConfig.java
@@ -17,7 +17,7 @@ public class DataSourceBuildTimeConfig {
     public Optional<String> dbKind = Optional.empty();
 
     /**
-     * The minimum version of the database we will connect to (e.g. '10.0').
+     * The version of the database we will connect to (e.g. '10.0').
      *
      * CAUTION: The version number set here should follow the same numbering scheme
      * as the string returned by `java.sql.DatabaseMetaData#getDatabaseProductVersion()`
@@ -36,8 +36,8 @@ public class DataSourceBuildTimeConfig {
      * (e.g. Hibernate ORM may generate invalid SQL that your database will reject).
      *
      * Some extensions (like the Hibernate ORM extension)
-     * will try to check this minimum version against the actual database version on startup,
-     * leading to a startup failure in case of mismatch
+     * will try to check this version against the actual database version on startup,
+     * leading to a startup failure when the actual version is lower
      * or simply a warning in case the database cannot be reached.
      *
      * The default for this property is specific to each extension;
@@ -46,7 +46,7 @@ public class DataSourceBuildTimeConfig {
      * @asciidoclet
      */
     @ConfigItem
-    public Optional<String> dbMinVersion = Optional.empty();
+    public Optional<String> dbVersion = Optional.empty();
 
     /**
      * Configuration for DevServices. DevServices allows Quarkus to automatically start a database in dev and test mode.
diff --git a/extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/HibernateOrmConfigPersistenceUnit.java b/extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/HibernateOrmConfigPersistenceUnit.java
@@ -293,7 +293,7 @@ public static class HibernateOrmConfigPersistenceUnitDialect {
          * allowing Quarkus to select the dialect automatically,
          * in which case you do not need to set the dialect at all,
          * though you may want to set
-         * xref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-min-version[`quarkus.datasource.db-min-version`] as
+         * xref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[`quarkus.datasource.db-version`] as
          * high as possible
          * to benefit from the best performance and latest features.
          *
diff --git a/extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/HibernateOrmProcessor.java b/extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/HibernateOrmProcessor.java
@@ -397,7 +397,7 @@ public void configurationDescriptorBuilding(
                             new RecordedConfig(
                                     Optional.of(DataSourceUtil.DEFAULT_DATASOURCE_NAME),
                                     jdbcDataSource.map(JdbcDataSourceBuildItem::getDbKind),
-                                    jdbcDataSource.flatMap(JdbcDataSourceBuildItem::getDbMinVersion),
+                                    jdbcDataSource.flatMap(JdbcDataSourceBuildItem::getDbVersion),
                                     getMultiTenancyStrategy(
                                             Optional.ofNullable(persistenceXmlDescriptorBuildItem.getDescriptor()
                                                     .getProperties().getProperty("hibernate.multiTenancy"))), //FIXME this property is meaningless in Hibernate ORM 6
@@ -1167,7 +1167,7 @@ private static void producePersistenceUnitDescriptorFromConfig(
                         new RecordedConfig(
                                 jdbcDataSource.map(JdbcDataSourceBuildItem::getName),
                                 jdbcDataSource.map(JdbcDataSourceBuildItem::getDbKind),
-                                jdbcDataSource.flatMap(JdbcDataSourceBuildItem::getDbMinVersion),
+                                jdbcDataSource.flatMap(JdbcDataSourceBuildItem::getDbVersion),
                                 multiTenancyStrategy,
                                 hibernateOrmConfig.database.ormCompatibilityVersion,
                                 persistenceUnitConfig.unsupportedProperties),
@@ -1184,7 +1184,7 @@ private static void collectDialectConfig(String persistenceUnitName,
             BiConsumer<String, String> puPropertiesCollector, Set<String> storageEngineCollector) {
         Optional<String> explicitDialect = persistenceUnitConfig.dialect.dialect;
         Optional<String> dbKind = jdbcDataSource.map(JdbcDataSourceBuildItem::getDbKind);
-        Optional<String> explicitDbMinVersion = jdbcDataSource.flatMap(JdbcDataSourceBuildItem::getDbMinVersion);
+        Optional<String> explicitDbMinVersion = jdbcDataSource.flatMap(JdbcDataSourceBuildItem::getDbVersion);
         if (multiTenancyStrategy != MultiTenancyStrategy.DATABASE && jdbcDataSource.isEmpty()) {
             throw new ConfigurationException(String.format(Locale.ROOT,
                     "Datasource must be defined for persistence unit '%s'."
diff --git a/extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/config/dialect/DbVersionInvalidTest.java b/extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/config/dialect/DbVersionInvalidTest.java
@@ -14,40 +14,40 @@
 import io.quarkus.hibernate.orm.runtime.config.DialectVersions;
 import io.quarkus.test.QuarkusUnitTest;
 
-public class DbMinVersionInvalidTest {
+public class DbVersionInvalidTest {
 
     private static final String ACTUAL_H2_VERSION = DialectVersions.Defaults.H2;
-    // We will set the DB min version to something higher than the actual version: this is invalid.
-    private static final String DB_MIN_VERSION = "999.999";
+    // We will set the DB version to something higher than the actual version: this is invalid.
+    private static final String CONFIGURED_DB_VERSION = "999.999";
     static {
         assertThat(ACTUAL_H2_VERSION)
                 .as("Test setup - we need the required version to be different from the actual one")
-                .doesNotStartWith(DB_MIN_VERSION);
+                .doesNotStartWith(CONFIGURED_DB_VERSION);
     }
 
     private static final String ACTUAL_H2_VERSION_REPORTED;
-    private static final String DB_MIN_VERSION_REPORTED;
+    private static final String CONFIGURED_DB_VERSION_REPORTED;
     static {
         // For some reason Hibernate ORM does not catch the actual micro version of H2 and default to 0; no big deal.
         ACTUAL_H2_VERSION_REPORTED = ACTUAL_H2_VERSION.replaceAll("\\.[\\d]+$", ".0");
         // For some reason Hibernate ORM infers a micro version of 0; no big deal.
-        DB_MIN_VERSION_REPORTED = DB_MIN_VERSION + ".0";
+        CONFIGURED_DB_VERSION_REPORTED = CONFIGURED_DB_VERSION + ".0";
     }
 
     @RegisterExtension
     static QuarkusUnitTest runner = new QuarkusUnitTest()
             .withApplicationRoot((jar) -> jar
                     .addClass(MyEntity.class))
             .withConfigurationResource("application.properties")
-            .overrideConfigKey("quarkus.datasource.db-min-version", "999.999")
+            .overrideConfigKey("quarkus.datasource.db-version", "999.999")
             .assertException(throwable -> assertThat(throwable)
                     .rootCause()
                     .hasMessageContainingAll(
                             "Persistence unit '<default>' was configured to run with a database version"
-                                    + " of at least '" + DB_MIN_VERSION_REPORTED + "', but the actual version is '"
+                                    + " of at least '" + CONFIGURED_DB_VERSION_REPORTED + "', but the actual version is '"
                                     + ACTUAL_H2_VERSION_REPORTED + "'",
                             "Consider upgrading your database",
-                            "Alternatively, rebuild your application with 'quarkus.datasource.db-min-version="
+                            "Alternatively, rebuild your application with 'quarkus.datasource.db-version="
                                     + ACTUAL_H2_VERSION_REPORTED + "'",
                             "this may disable some features and/or impact performance negatively"));
 
diff --git a/extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/config/dialect/DbVersionValidTest.java b/extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/config/dialect/DbVersionValidTest.java
@@ -16,16 +16,16 @@
 import io.quarkus.hibernate.orm.runtime.config.DialectVersions;
 import io.quarkus.test.QuarkusUnitTest;
 
-public class DbMinVersionValidTest {
+public class DbVersionValidTest {
 
     private static final String ACTUAL_H2_VERSION = DialectVersions.Defaults.H2;
-    private static final String DB_MIN_VERSION;
+    private static final String CONFIGURED_DB_VERSION;
     static {
-        // We will set the DB min version to something lower than the actual version: this is valid.
-        DB_MIN_VERSION = ACTUAL_H2_VERSION.replaceAll("\\.[\\d]+\\.[\\d]+$", ".0.0");
+        // We will set the DB version to something lower than the actual version: this is valid.
+        CONFIGURED_DB_VERSION = ACTUAL_H2_VERSION.replaceAll("\\.[\\d]+\\.[\\d]+$", ".0.0");
         assertThat(ACTUAL_H2_VERSION)
                 .as("Test setup - we need the required version to be different from the actual one")
-                .isNotEqualTo(DB_MIN_VERSION);
+                .isNotEqualTo(CONFIGURED_DB_VERSION);
     }
 
     @RegisterExtension
@@ -34,7 +34,7 @@ public class DbMinVersionValidTest {
                     .addClass(SmokeTestUtils.class)
                     .addClass(MyEntity.class))
             .withConfigurationResource("application.properties")
-            .overrideConfigKey("quarkus.datasource.db-min-version", DB_MIN_VERSION);
+            .overrideConfigKey("quarkus.datasource.db-version", CONFIGURED_DB_VERSION);
 
     @Inject
     SessionFactory sessionFactory;
@@ -45,7 +45,7 @@ public class DbMinVersionValidTest {
     @Test
     public void dialectVersion() {
         var dialectVersion = sessionFactory.unwrap(SessionFactoryImplementor.class).getJdbcServices().getDialect().getVersion();
-        assertThat(DialectVersions.toString(dialectVersion)).isEqualTo(DB_MIN_VERSION);
+        assertThat(DialectVersions.toString(dialectVersion)).isEqualTo(CONFIGURED_DB_VERSION);
     }
 
     @Test
diff --git a/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/boot/FastBootEntityManagerFactoryBuilder.java b/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/boot/FastBootEntityManagerFactoryBuilder.java
@@ -34,7 +34,7 @@
 import io.quarkus.arc.InjectableInstance;
 import io.quarkus.hibernate.orm.runtime.PersistenceUnitUtil;
 import io.quarkus.hibernate.orm.runtime.RuntimeSettings;
-import io.quarkus.hibernate.orm.runtime.observers.QuarkusSessionFactoryObserverForDbMinVersionCheck;
+import io.quarkus.hibernate.orm.runtime.observers.QuarkusSessionFactoryObserverForDbVersionCheck;
 import io.quarkus.hibernate.orm.runtime.observers.SessionFactoryObserverForNamedQueryValidation;
 import io.quarkus.hibernate.orm.runtime.observers.SessionFactoryObserverForSchemaExport;
 import io.quarkus.hibernate.orm.runtime.recording.PrevalidatedQuarkusMetadata;
@@ -167,7 +167,7 @@ protected void populate(String persistenceUnitName, SessionFactoryOptionsBuilder
         //options.addSessionFactoryObservers( new SessionFactoryObserverForRegistration() );
 
         // This one is specific to Quarkus
-        options.addSessionFactoryObservers(new QuarkusSessionFactoryObserverForDbMinVersionCheck());
+        options.addSessionFactoryObservers(new QuarkusSessionFactoryObserverForDbVersionCheck());
 
         options.applyEntityNotFoundDelegate(new JpaEntityNotFoundDelegate());
 
diff --git a/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/observers/QuarkusSessionFactoryObserverForDbVersionCheck.java b/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/observers/QuarkusSessionFactoryObserverForDbVersionCheck.java
@@ -7,7 +7,7 @@
 
 import io.quarkus.hibernate.orm.runtime.service.QuarkusRuntimeInitDialectFactory;
 
-public class QuarkusSessionFactoryObserverForDbMinVersionCheck implements SessionFactoryObserver {
+public class QuarkusSessionFactoryObserverForDbVersionCheck implements SessionFactoryObserver {
     @Override
     public void sessionFactoryCreated(SessionFactory factory) {
         var dialectFactory = (QuarkusRuntimeInitDialectFactory) ((SessionFactoryImplementor) factory)
diff --git a/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/recording/RecordedConfig.java b/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/recording/RecordedConfig.java
@@ -14,23 +14,23 @@
 public class RecordedConfig {
     private final Optional<String> dataSource;
     private final Optional<String> dbKind;
-    private final Optional<String> dbMinVersion;
+    private final Optional<String> dbVersion;
     private final MultiTenancyStrategy multiTenancyStrategy;
     private final Map<String, String> quarkusConfigUnsupportedProperties;
     private final DatabaseOrmCompatibilityVersion databaseOrmCompatibilityVersion;
 
     @RecordableConstructor
     public RecordedConfig(Optional<String> dataSource, Optional<String> dbKind,
-            Optional<String> dbMinVersion, MultiTenancyStrategy multiTenancyStrategy,
+            Optional<String> dbVersion, MultiTenancyStrategy multiTenancyStrategy,
             DatabaseOrmCompatibilityVersion databaseOrmCompatibilityVersion,
             Map<String, String> quarkusConfigUnsupportedProperties) {
         Objects.requireNonNull(dataSource);
         Objects.requireNonNull(dbKind);
-        Objects.requireNonNull(dbMinVersion);
+        Objects.requireNonNull(dbVersion);
         Objects.requireNonNull(multiTenancyStrategy);
         this.dataSource = dataSource;
         this.dbKind = dbKind;
-        this.dbMinVersion = dbMinVersion;
+        this.dbVersion = dbVersion;
         this.multiTenancyStrategy = multiTenancyStrategy;
         this.quarkusConfigUnsupportedProperties = quarkusConfigUnsupportedProperties;
         this.databaseOrmCompatibilityVersion = databaseOrmCompatibilityVersion;
@@ -44,8 +44,8 @@ public Optional<String> getDbKind() {
         return dbKind;
     }
 
-    public Optional<String> getDbMinVersion() {
-        return dbMinVersion;
+    public Optional<String> getDbVersion() {
+        return dbVersion;
     }
 
     public MultiTenancyStrategy getMultiTenancyStrategy() {
diff --git a/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/service/QuarkusRuntimeInitDialectFactory.java b/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/service/QuarkusRuntimeInitDialectFactory.java
@@ -75,7 +75,7 @@ public void checkActualDbVersion() {
                                     " Alternatively, rebuild your application with"
                                             + " '%1$s=%2$s'"
                                             + " (but this may disable some features and/or impact performance negatively).",
-                                    DataSourceUtil.dataSourcePropertyKey(datasourceName.get(), "db-min-version"),
+                                    DataSourceUtil.dataSourcePropertyKey(datasourceName.get(), "db-version"),
                                     DialectVersions.toString(actualDbVersion.get()))));
         }
 
diff --git a/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/service/QuarkusRuntimeInitDialectFactoryInitiator.java b/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/service/QuarkusRuntimeInitDialectFactoryInitiator.java
@@ -23,7 +23,7 @@ public QuarkusRuntimeInitDialectFactoryInitiator(String persistenceUnitName, Dia
         this.persistenceUnitName = persistenceUnitName;
         this.dialect = dialect;
         this.datasourceName = recordedConfig.getDataSource();
-        this.buildTimeDbVersion = recordedConfig.getDbMinVersion().isPresent()
+        this.buildTimeDbVersion = recordedConfig.getDbVersion().isPresent()
                 // This is the same version, but parsed in a dialect-specific way.
                 ? Optional.of(dialect.getVersion())
                 : Optional.empty();

Original file line number	Diff line number	Diff line change
`@@ -186,7 +186,7 @@ private DataSourceSupport getDataSourceSupport(`
`186`	`186`	`String dataSourceName = aggregatedDataSourceBuildTimeConfig.getName();`
`187`	`187`	`dataSourceSupportEntries.put(dataSourceName,`
`188`	`188`	`new DataSourceSupport.Entry(dataSourceName, aggregatedDataSourceBuildTimeConfig.getDbKind(),`
`189`		`- aggregatedDataSourceBuildTimeConfig.getDataSourceConfig().dbMinVersion,`
	`189`	`+ aggregatedDataSourceBuildTimeConfig.getDataSourceConfig().dbVersion,`
`190`	`190`	`aggregatedDataSourceBuildTimeConfig.getResolvedDriverClass(),`
`191`	`191`	`aggregatedDataSourceBuildTimeConfig.isDefault()));`
`192`	`192`	`}`
`@@ -275,7 +275,7 @@ void generateDataSourceBeans(AgroalRecorder recorder,`
`275`	`275`
`276`	`276`	`jdbcDataSource.produce(new JdbcDataSourceBuildItem(dataSourceName,`
`277`	`277`	`entry.getValue().resolvedDbKind,`
`278`		`- entry.getValue().dbMinVersion,`
	`278`	`+ entry.getValue().dbVersion,`
`279`	`279`	`entry.getValue().isDefault));`
`280`	`280`	`}`
`281`	`281`	`}`
Original file line number	Diff line number	Diff line change
`@@ -293,7 +293,7 @@ public static class HibernateOrmConfigPersistenceUnitDialect {`
`293`	`293`	`* allowing Quarkus to select the dialect automatically,`
`294`	`294`	`* in which case you do not need to set the dialect at all,`
`295`	`295`	`* though you may want to set`
`296`		- * xref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-min-version[`quarkus.datasource.db-min-version`] as
	`296`	+ * xref:datasource.adoc#quarkus-datasource_quarkus.datasource.db-version[`quarkus.datasource.db-version`] as
`297`	`297`	`* high as possible`
`298`	`298`	`* to benefit from the best performance and latest features.`
`299`	`299`	`*`