Merge pull request #47338 from alihmzyv/feature/unzip-zip-hibernate-import-files

yrodiere · web-flow · commit 545907d8a078 · 2025-07-21T10:55:57.000+02:00
Unzip zip files in hibernate HBM2DDL_IMPORT_FILES setting
diff --git a/docs/src/main/asciidoc/hibernate-orm.adoc b/docs/src/main/asciidoc/hibernate-orm.adoc
@@ -774,6 +774,7 @@ your entity changes or any change to your `import.sql` is immediately picked up
 ====
 By default, in `dev` and `test` modes, Hibernate ORM, upon boot, will read and execute the SQL statements in the `/import.sql` file (if present).
 You can change the file name by changing the property `quarkus.hibernate-orm.sql-load-script` in `application.properties`.
+You can also provide a `.zip` file in the same way which should contain only the files containing the SQL statements to be executed.
 ====
 
 The second approach is to use `quarkus.hibernate-orm.schema-management.strategy=update`.
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
@@ -74,7 +74,8 @@ public interface HibernateOrmConfigPersistenceUnit {
      *
      * [NOTE]
      * ====
-     * Quarkus supports `.sql` file with SQL statements or comments spread over multiple lines.
+     * Quarkus supports files with SQL statements or comments spread over multiple lines,
+     * or `.zip` files containing those files.
      * Each SQL statement must be terminated by a semicolon.
      * ====
      *
diff --git a/extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/util/HibernateProcessorUtil.java b/extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/util/HibernateProcessorUtil.java
@@ -363,11 +363,12 @@ public static void configureSqlLoadScript(String persistenceUnitName,
 
             // only set the found import files if configured
             if (persistenceUnitConfig.sqlLoadScript().isPresent()) {
-                descriptor.getProperties().setProperty(AvailableSettings.HBM2DDL_IMPORT_FILES, String.join(",", importFiles));
+                descriptor.getProperties().setProperty(AvailableSettings.JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE,
+                        String.join(",", importFiles));
             }
         } else {
             //Disable implicit loading of the default import script (import.sql)
-            descriptor.getProperties().setProperty(AvailableSettings.HBM2DDL_IMPORT_FILES, "");
+            descriptor.getProperties().setProperty(AvailableSettings.JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE, "");
             descriptor.getProperties().setProperty(AvailableSettings.HBM2DDL_SKIP_DEFAULT_IMPORT_FILE, "true");
         }
     }
diff --git a/extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/sql_load_script/ImportMultipleSqlLoadScriptsAsZipFileTestCase.java b/extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/sql_load_script/ImportMultipleSqlLoadScriptsAsZipFileTestCase.java
@@ -0,0 +1,28 @@
+package io.quarkus.hibernate.orm.sql_load_script;
+
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.hibernate.orm.MyEntity;
+import io.quarkus.test.QuarkusUnitTest;
+import io.restassured.RestAssured;
+
+public class ImportMultipleSqlLoadScriptsAsZipFileTestCase {
+    @RegisterExtension
+    static QuarkusUnitTest runner = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyEntity.class, SqlLoadScriptTestResource.class)
+                    .addAsResource("application-multiple-load-script-files-as-zip-file-test.properties",
+                            "application.properties")
+                    .addAsResource("multiple-load-script-files.zip"));
+
+    @Test
+    public void testMultipleLoadScriptFilesAsZipFile() {
+        String name1 = "import-1.sql load script entity";
+        String name2 = "import-2.sql load script entity";
+
+        RestAssured.when().get("/orm-sql-load-script/1").then().body(Matchers.is(name1));
+        RestAssured.when().get("/orm-sql-load-script/2").then().body(Matchers.is(name2));
+    }
+}
diff --git a/extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/sql_load_script/ImportSqlLoadScriptAsZipFileTestCase.java b/extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/sql_load_script/ImportSqlLoadScriptAsZipFileTestCase.java
@@ -0,0 +1,24 @@
+package io.quarkus.hibernate.orm.sql_load_script;
+
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.hibernate.orm.MyEntity;
+import io.quarkus.test.QuarkusUnitTest;
+import io.restassured.RestAssured;
+
+public class ImportSqlLoadScriptAsZipFileTestCase {
+    @RegisterExtension
+    static QuarkusUnitTest runner = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyEntity.class, SqlLoadScriptTestResource.class)
+                    .addAsResource("application-load-script-as-zip-file-test.properties", "application.properties")
+                    .addAsResource("load-script-test.zip"));
+
+    @Test
+    public void testSqlLoadScriptAsZipFile() {
+        String name = "other-load-script sql load script entity";
+        RestAssured.when().get("/orm-sql-load-script/3").then().body(Matchers.is(name));
+    }
+}
diff --git a/extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/sql_load_script/ImportSqlLoadScriptsAsMultipleZipFilesTestCase.java b/extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/sql_load_script/ImportSqlLoadScriptsAsMultipleZipFilesTestCase.java
@@ -0,0 +1,29 @@
+package io.quarkus.hibernate.orm.sql_load_script;
+
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.hibernate.orm.MyEntity;
+import io.quarkus.test.QuarkusUnitTest;
+import io.restassured.RestAssured;
+
+public class ImportSqlLoadScriptsAsMultipleZipFilesTestCase {
+    @RegisterExtension
+    static QuarkusUnitTest runner = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyEntity.class, SqlLoadScriptTestResource.class)
+                    .addAsResource("application-load-scripts-as-multiple-zip-files-test.properties",
+                            "application.properties")
+                    .addAsResource("import-multiple-load-scripts-1.zip")
+                    .addAsResource("import-multiple-load-scripts-2.zip"));
+
+    @Test
+    public void testSqlLoadScriptsAsMultipleZipFiles() {
+        String name1 = "import-1.sql load script entity";
+        String name2 = "import-2.sql load script entity";
+
+        RestAssured.when().get("/orm-sql-load-script/1").then().body(Matchers.is(name1));
+        RestAssured.when().get("/orm-sql-load-script/2").then().body(Matchers.is(name2));
+    }
+}
diff --git a/extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/sql_load_script/ImportSqlLoadScriptsAsZipFilesAndSqlFileTestCase.java b/extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/sql_load_script/ImportSqlLoadScriptsAsZipFilesAndSqlFileTestCase.java
@@ -0,0 +1,32 @@
+package io.quarkus.hibernate.orm.sql_load_script;
+
+import org.hamcrest.Matchers;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+import io.quarkus.hibernate.orm.MyEntity;
+import io.quarkus.test.QuarkusUnitTest;
+import io.restassured.RestAssured;
+
+public class ImportSqlLoadScriptsAsZipFilesAndSqlFileTestCase {
+    @RegisterExtension
+    static QuarkusUnitTest runner = new QuarkusUnitTest()
+            .withApplicationRoot((jar) -> jar
+                    .addClasses(MyEntity.class, SqlLoadScriptTestResource.class)
+                    .addAsResource("application-load-scripts-as-multiple-zip-files-and-sql-file-test.properties",
+                            "application.properties")
+                    .addAsResource("load-script-test.sql")
+                    .addAsResource("import-multiple-load-scripts-1.zip")
+                    .addAsResource("import-multiple-load-scripts-2.zip"));
+
+    @Test
+    public void testSqlLoadScriptsAsZipFilesAndSqlFile() {
+        String name = "other-load-script sql load script entity";
+        String name1 = "import-1.sql load script entity";
+        String name2 = "import-2.sql load script entity";
+
+        RestAssured.when().get("/orm-sql-load-script/1").then().body(Matchers.is(name1));
+        RestAssured.when().get("/orm-sql-load-script/2").then().body(Matchers.is(name2));
+        RestAssured.when().get("/orm-sql-load-script/3").then().body(Matchers.is(name));
+    }
+}
diff --git a/extensions/hibernate-orm/deployment/src/test/resources/application-load-script-as-zip-file-test.properties b/extensions/hibernate-orm/deployment/src/test/resources/application-load-script-as-zip-file-test.properties
@@ -0,0 +1,5 @@
+quarkus.datasource.db-kind=h2
+quarkus.datasource.jdbc.url=jdbc:h2:mem:test
+
+quarkus.hibernate-orm.database.generation=drop-and-create
+quarkus.hibernate-orm.sql-load-script=load-script-test.zip
diff --git a/extensions/hibernate-orm/deployment/src/test/resources/application-load-scripts-as-multiple-zip-files-and-sql-file-test.properties b/extensions/hibernate-orm/deployment/src/test/resources/application-load-scripts-as-multiple-zip-files-and-sql-file-test.properties
@@ -0,0 +1,5 @@
+quarkus.datasource.db-kind=h2
+quarkus.datasource.jdbc.url=jdbc:h2:mem:test
+
+quarkus.hibernate-orm.database.generation=drop-and-create
+quarkus.hibernate-orm.sql-load-script=load-script-test.sql, import-multiple-load-scripts-1.zip, import-multiple-load-scripts-2.zip
diff --git a/extensions/hibernate-orm/deployment/src/test/resources/application-load-scripts-as-multiple-zip-files-test.properties b/extensions/hibernate-orm/deployment/src/test/resources/application-load-scripts-as-multiple-zip-files-test.properties
@@ -0,0 +1,5 @@
+quarkus.datasource.db-kind=h2
+quarkus.datasource.jdbc.url=jdbc:h2:mem:test
+
+quarkus.hibernate-orm.database.generation=drop-and-create
+quarkus.hibernate-orm.sql-load-script=import-multiple-load-scripts-1.zip, import-multiple-load-scripts-2.zip
diff --git a/extensions/hibernate-orm/deployment/src/test/resources/application-multiple-load-script-files-as-zip-file-test.properties b/extensions/hibernate-orm/deployment/src/test/resources/application-multiple-load-script-files-as-zip-file-test.properties
@@ -0,0 +1,5 @@
+quarkus.datasource.db-kind=h2
+quarkus.datasource.jdbc.url=jdbc:h2:mem:test
+
+quarkus.hibernate-orm.database.generation=drop-and-create
+quarkus.hibernate-orm.sql-load-script=multiple-load-script-files.zip
diff --git a/extensions/hibernate-orm/deployment/src/test/resources/import-multiple-load-scripts-1.zip b/extensions/hibernate-orm/deployment/src/test/resources/import-multiple-load-scripts-1.zip
diff --git a/extensions/hibernate-orm/deployment/src/test/resources/import-multiple-load-scripts-2.zip b/extensions/hibernate-orm/deployment/src/test/resources/import-multiple-load-scripts-2.zip
diff --git a/extensions/hibernate-orm/deployment/src/test/resources/load-script-test.zip b/extensions/hibernate-orm/deployment/src/test/resources/load-script-test.zip
diff --git a/extensions/hibernate-orm/deployment/src/test/resources/multiple-load-script-files.zip b/extensions/hibernate-orm/deployment/src/test/resources/multiple-load-script-files.zip
diff --git a/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/FastBootHibernatePersistenceProvider.java b/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/FastBootHibernatePersistenceProvider.java
@@ -219,6 +219,7 @@ private RuntimeSettings buildRuntimeSettings(String persistenceUnitName, Recorde
         final BuildTimeSettings buildTimeSettings = recordedState.getBuildTimeSettings();
         final IntegrationSettings integrationSettings = recordedState.getIntegrationSettings();
         Builder runtimeSettingsBuilder = new Builder(buildTimeSettings, integrationSettings);
+        unzipZipFilesAndReplaceZipsInImportFiles(runtimeSettingsBuilder);
 
         Optional<String> dataSourceName = recordedState.getBuildTimeSettings().getSource().getDataSource();
         if (dataSourceName.isPresent()) {
@@ -310,6 +311,12 @@ private RuntimeSettings buildRuntimeSettings(String persistenceUnitName, Recorde
         return runtimeSettingsBuilder.build();
     }
 
+    private void unzipZipFilesAndReplaceZipsInImportFiles(Builder runtimeSettingsBuilder) {
+        String newValue = SchemaToolingUtil.unzipZipFilesAndReplaceZips(
+                (String) runtimeSettingsBuilder.get(AvailableSettings.JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE));
+        runtimeSettingsBuilder.put(AvailableSettings.JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE, newValue);
+    }
+
     private StandardServiceRegistry rewireMetadataAndExtractServiceRegistry(String persistenceUnitName, RecordedState rs,
             HibernateOrmRuntimeConfigPersistenceUnit puConfig, RuntimeSettings runtimeSettings) {
         PreconfiguredServiceRegistryBuilder serviceRegistryBuilder = new PreconfiguredServiceRegistryBuilder(
diff --git a/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/SchemaToolingUtil.java b/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/SchemaToolingUtil.java
@@ -0,0 +1,48 @@
+package io.quarkus.hibernate.orm.runtime;
+
+import java.net.URL;
+import java.nio.file.DirectoryStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Locale;
+
+import io.quarkus.fs.util.ZipUtils;
+
+public class SchemaToolingUtil {
+    private static final String SQL_LOAD_SCRIPT_UNZIPPED_DIR_PREFIX = "import-sql-unzip-";
+
+    public static String unzipZipFilesAndReplaceZips(String commaSeparatedFileNames) {
+        List<String> unzippedFilesNames = new ArrayList<>();
+        if (commaSeparatedFileNames != null) {
+            String[] fileNames = commaSeparatedFileNames.split(",");
+            for (String fileName : fileNames) {
+                if (fileName.endsWith(".zip")) {
+                    try {
+                        Path unzipDir = Files.createTempDirectory(SQL_LOAD_SCRIPT_UNZIPPED_DIR_PREFIX);
+                        URL resource = Thread.currentThread()
+                                .getContextClassLoader()
+                                .getResource(fileName);
+                        Path zipFile = Paths.get(resource.toURI());
+                        ZipUtils.unzip(zipFile, unzipDir);
+                        try (DirectoryStream<Path> paths = Files.newDirectoryStream(unzipDir)) {
+                            for (Path path : paths) {
+                                unzippedFilesNames.add(path.toAbsolutePath().toString());
+                            }
+                        }
+                    } catch (Exception e) {
+                        throw new IllegalStateException(String.format(Locale.ROOT, "Error unzipping import file %s: %s",
+                                fileName, e.getMessage()), e);
+                    }
+                } else {
+                    unzippedFilesNames.add(fileName);
+                }
+            }
+            return String.join(",", unzippedFilesNames);
+        } else {
+            return null;
+        }
+    }
+}
diff --git a/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/dev/HibernateOrmDevController.java b/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/dev/HibernateOrmDevController.java
@@ -120,7 +120,7 @@ private static String generateDDL(Action action, Metadata metadata, ServiceRegis
         Map<String, Object> config = new HashMap<>(ssr.getService(ConfigurationService.class).getSettings());
         config.put(AvailableSettings.HBM2DDL_DELIMITER, ";");
         config.put(AvailableSettings.FORMAT_SQL, true);
-        config.put(AvailableSettings.HBM2DDL_IMPORT_FILES, importFiles);
+        config.put(AvailableSettings.JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE, importFiles);
         ExceptionHandlerCollectingImpl exceptionHandler = new ExceptionHandlerCollectingImpl();
         try {
             final ExecutionOptions executionOptions = SchemaManagementToolCoordinator.buildExecutionOptions(
diff --git a/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/dev/HibernateOrmDevIntegrator.java b/extensions/hibernate-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/dev/HibernateOrmDevIntegrator.java
@@ -1,6 +1,6 @@
 package io.quarkus.hibernate.orm.runtime.dev;
 
-import static org.hibernate.cfg.AvailableSettings.HBM2DDL_IMPORT_FILES;
+import static org.hibernate.cfg.AvailableSettings.JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE;
 
 import java.util.Map;
 import java.util.concurrent.ConcurrentHashMap;
@@ -36,7 +36,7 @@ public void integrate(Metadata metadata, BootstrapContext bootstrapContext,
                 name,
                 metadata,
                 sessionFactoryImplementor.getServiceRegistry(),
-                (String) sessionFactoryImplementor.getProperties().get(HBM2DDL_IMPORT_FILES));
+                (String) sessionFactoryImplementor.getProperties().get(JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE));
     }
 
     @Override
diff --git a/extensions/hibernate-reactive/runtime/src/main/java/io/quarkus/hibernate/reactive/runtime/FastBootHibernateReactivePersistenceProvider.java b/extensions/hibernate-reactive/runtime/src/main/java/io/quarkus/hibernate/reactive/runtime/FastBootHibernateReactivePersistenceProvider.java
@@ -41,6 +41,7 @@
 import io.quarkus.hibernate.orm.runtime.PersistenceUnitsHolder;
 import io.quarkus.hibernate.orm.runtime.RuntimeSettings;
 import io.quarkus.hibernate.orm.runtime.RuntimeSettings.Builder;
+import io.quarkus.hibernate.orm.runtime.SchemaToolingUtil;
 import io.quarkus.hibernate.orm.runtime.boot.QuarkusPersistenceUnitDescriptor;
 import io.quarkus.hibernate.orm.runtime.integration.HibernateOrmIntegrationRuntimeDescriptor;
 import io.quarkus.hibernate.orm.runtime.integration.HibernateOrmIntegrationRuntimeInitListener;
@@ -159,6 +160,7 @@ private EntityManagerFactoryBuilder getEntityManagerFactoryBuilderOrNull(String
             final IntegrationSettings integrationSettings = recordedState.getIntegrationSettings();
             RuntimeSettings.Builder runtimeSettingsBuilder = new RuntimeSettings.Builder(buildTimeSettings,
                     integrationSettings);
+            unzipZipFilesAndReplaceZipsInImportFiles(runtimeSettingsBuilder);
 
             var puConfig = hibernateOrmRuntimeConfig.persistenceUnits().get(persistenceUnit.getConfigurationName());
             if (puConfig.active().isPresent() && !puConfig.active().get()) {
@@ -239,6 +241,12 @@ private EntityManagerFactoryBuilder getEntityManagerFactoryBuilderOrNull(String
         return null;
     }
 
+    private void unzipZipFilesAndReplaceZipsInImportFiles(Builder runtimeSettingsBuilder) {
+        String newValue = SchemaToolingUtil.unzipZipFilesAndReplaceZips(
+                (String) runtimeSettingsBuilder.get(AvailableSettings.JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE));
+        runtimeSettingsBuilder.put(AvailableSettings.JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE, newValue);
+    }
+
     private StandardServiceRegistry rewireMetadataAndExtractServiceRegistry(String persistenceUnitName,
             String persistenceUnitConfigurationName,
             RecordedState recordedState,

Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,8 @@ public interface HibernateOrmConfigPersistenceUnit {`
`74`	`74`	`*`
`75`	`75`	`* [NOTE]`
`76`	`76`	`* ====`
`77`		- * Quarkus supports `.sql` file with SQL statements or comments spread over multiple lines.
	`77`	`+ * Quarkus supports files with SQL statements or comments spread over multiple lines,`
	`78`	+ * or `.zip` files containing those files.
`78`	`79`	`* Each SQL statement must be terminated by a semicolon.`
`79`	`80`	`* ====`
`80`	`81`	`*`
Original file line number	Diff line number	Diff line change
`@@ -363,11 +363,12 @@ public static void configureSqlLoadScript(String persistenceUnitName,`
`363`	`363`
`364`	`364`	`// only set the found import files if configured`
`365`	`365`	`if (persistenceUnitConfig.sqlLoadScript().isPresent()) {`
`366`		`- descriptor.getProperties().setProperty(AvailableSettings.HBM2DDL_IMPORT_FILES, String.join(",", importFiles));`
	`366`	`+ descriptor.getProperties().setProperty(AvailableSettings.JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE,`
	`367`	`+ String.join(",", importFiles));`
`367`	`368`	`}`
`368`	`369`	`} else {`
`369`	`370`	`//Disable implicit loading of the default import script (import.sql)`
`370`		`- descriptor.getProperties().setProperty(AvailableSettings.HBM2DDL_IMPORT_FILES, "");`
	`371`	`+ descriptor.getProperties().setProperty(AvailableSettings.JAKARTA_HBM2DDL_LOAD_SCRIPT_SOURCE, "");`
`371`	`372`	`descriptor.getProperties().setProperty(AvailableSettings.HBM2DDL_SKIP_DEFAULT_IMPORT_FILE, "true");`
`372`	`373`	`}`
`373`	`374`	`}`