Hibernate ORM extension config overhaul

docs/src/main/asciidoc/hibernate-orm-guide.adoc

@@ -106,23 +106,77 @@ This is useful to have a data set ready for your tests or demos.
 
 There are optional properties useful to refine your `EntityManagerFactory` or guide guesses of {project-name}.
 
-`quarkus.hibernate.dialect`:: (e.g. `org.hibernate.dialect.PostgreSQL95Dialect`).
+==== Dialect
+
+`quarkus.hibernate-orm.dialect`:: (e.g. `org.hibernate.dialect.PostgreSQL95Dialect`).
 Class name of the Hibernate ORM dialect.
 
-`quarkus.hibernate.schema-generation.database.action`::
+`quarkus.hibernate-orm.dialect.storage-engine`:: (e.g. `MyISAM` or `InnoDB`).
+The storage engine to use when the dialect supports multiple storage engines.
+
+==== Miscellaneous
+
+`quarkus.hibernate-orm.sql-load-script`::
+(defaults to `/import.sql`) Name of the file containing the SQL statements to execute when Hibernate ORM starts.
+By default, simply add `import.sql` in the root of your resources directory and it will be picked up without having to set this property.
+
+`quarkus.hibernate-orm.batch-fetch-size`:: (defaults to `-1` i.e. batch fetching is disabled).
+The size of the batches used when loading entities and collections.
+
+==== Query
+
+`quarkus.hibernate-orm.query.query-plan-cache-max-size`::
+The maximum size of the query plan cache.
+
+`quarkus.hibernate-orm.query.default-null-ordering`:: (defaults to `none`).
+Default precedence of null values in `ORDER BY` clauses.
+Options are `none`, `first`, `last`.
+
+==== Database
+
+`quarkus.hibernate-orm.database.generation`::
 (e.g. `drop-and-create` which is awesome in development mode). Select whether the database schema is generated or not.
 Options are `none`, `create`, `drop-and-create`, `drop`
 
-`quarkus.hibernate.show-sql`:: (defaults to `false`).
+`quarkus.hibernate-orm.database.generation.halt-on-error`:: (defaults to `false`)
+Whether we should stop on the first error when applying the schema.
+
+`quarkus.hibernate-orm.database.default-catalog`::
+The default catalog to use for the database objects.
+
+`quarkus.hibernate-orm.database.default-schema`::
+The default schema to use for the database objects.
+
+`quarkus.hibernate-orm.database.charset`::
+The charset of the database.
+
+==== JDBC
+
+`quarkus.hibernate-orm.jdbc.timezone`::
+The time zone pushed to the JDBC driver.
+
+`quarkus.hibernate-orm.jdbc.statement-fetch-size`::
+How many rows are fetched at a time by the JDBC driver.
+
+`quarkus.hibernate-orm.jdbc.statement-batch-size`::
+The number of updates (inserts, updates and deletes) that are sent by the JDBC driver at one time for execution.
+
+==== Logging
+
+`quarkus.hibernate-orm.log.sql`:: (defaults to `false`).
 Show SQL logs and format them nicely.
 
-`quarkus.hibernate.sql-load-script-source`::
-(defaults to `/import.sql`) Name of the file containing the SQL statements to execute when Hibernate ORM starts.
-By default, simply add `import.sql` in the root of your resources directory and it will be picked up without having to set this property.
+`quarkus.hibernate-orm.log.jdbc-warnings`:: (defaults to `false`).
+Whether JDBC warnings should be collected and logged.
+
+==== Statistics
+
+`quarkus.hibernate-orm.statistics`:: (defaults to `false`)
+Whether statistics collection is enabled.
 
 [NOTE]
 --
-Do not mix `persistence.xml` and `quarkus.hibernate.*` properties in `{config-file}`.
+Do not mix `persistence.xml` and `quarkus.hibernate-orm.*` properties in `{config-file}`.
 {project-name} will raise an exception.
 Make up your mind on which approach you want to use.
 --
@@ -149,7 +203,7 @@ This is useful for:
 
 [NOTE]
 --
-If you have a `persistence.xml`, then you cannot use the `quarkus.hibernate.*` properties
+If you have a `persistence.xml`, then you cannot use the `quarkus.hibernate-orm.*` properties
 and only persistence units defined in `persistence.xml` will be taken into account.
 --
 

extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/HibernateOrmConfig.java

@@ -0,0 +1,200 @@
+package io.quarkus.hibernate.orm;
+
+import java.util.Optional;
+
+import io.quarkus.runtime.annotations.ConfigGroup;
+import io.quarkus.runtime.annotations.ConfigItem;
+import io.quarkus.runtime.annotations.ConfigRoot;
+
+/**
+ * @author Emmanuel Bernard [email protected]
+ */
+@ConfigRoot
+public class HibernateOrmConfig {
+    /**
+     * The hibernate ORM dialect class name
+     */
+    // TODO should it be dialects
+    //TODO should it be shortcuts like "postgresql" "h2" etc
+    @ConfigItem
+    public Optional<String> dialect;
+
+    /**
+     * The storage engine used by the dialect if it supports several storage engines.
+     * <p>
+     * This is the case of MariaDB.
+     */
+    @ConfigItem(name = "dialect.storage-engine")
+    public Optional<String> dialectStorageEngine;
+
+    /**
+     * To populate the database tables with data before the application loads,
+     * specify the location of a load script.
+     * The location specified in this property is relative to the root of the persistence unit.
+     */
+    @ConfigItem
+    public Optional<String> sqlLoadScript;
+
+    /**
+     * The size of a batch when using batch loading to load entities and collections.
+     * <p>
+     * -1 means batch loading is disabled.
+     */
+    @ConfigItem(defaultValue = "-1")
+    public int batchFetchSize;
+
+    /**
+     * Query related configuration.
+     */
+    @ConfigItem
+    public HibernateOrmConfigQuery query;
+
+    /**
+     * Database related configuration.
+     */
+    @ConfigItem
+    public HibernateOrmConfigDatabase database;
+
+    /**
+     * JDBC related configuration.
+     */
+    @ConfigItem
+    public HibernateOrmConfigJdbc jdbc;
+
+    /**
+     * Logging configuration.
+     */
+    @ConfigItem
+    public HibernateOrmConfigLog log;
+
+    /**
+     * Statistics configuration.
+     */
+    @ConfigItem(defaultValue = "false")
+    public boolean statistics;
+
+    public boolean isAnyPropertySet() {
+        return dialect.isPresent() ||
+                dialectStorageEngine.isPresent() ||
+                sqlLoadScript.isPresent() ||
+                batchFetchSize > 0 ||
+                statistics ||
+                query.isAnyPropertySet() ||
+                database.isAnyPropertySet() ||
+                jdbc.isAnyPropertySet() ||
+                log.isAnyPropertySet();
+    }
+
+    @ConfigGroup
+    public static class HibernateOrmConfigQuery {
+
+        /**
+         * The max size of the query plan cache.
+         */
+        @ConfigItem
+        public Optional<String> queryPlanCacheMaxSize;
+
+        /**
+         * The default ordering of nulls specific in the ORDER BY clause.
+         * <p>
+         * Valid values are: none, first, last.
+         */
+        @ConfigItem
+        public Optional<String> defaultNullOrdering;
+
+        public boolean isAnyPropertySet() {
+            return queryPlanCacheMaxSize.isPresent() || defaultNullOrdering.isPresent();
+        }
+    }
+
+    @ConfigGroup
+    public static class HibernateOrmConfigDatabase {
+
+        /**
+         * Control how schema generation is happening in Hibernate ORM.
+         * <p>
+         * Same as JPA's javax.persistence.schema-generation.database.action.
+         */
+        @ConfigItem
+        public Optional<String> generation;
+
+        /**
+         * Whether we should stop schema application at the first error or continue.
+         */
+        @ConfigItem(name = "generation.halt-on-error", defaultValue = "false")
+        public boolean generationHaltOnError;
+
+        /**
+         * The default database catalog.
+         */
+        @ConfigItem
+        public Optional<String> defaultCatalog;
+
+        /**
+         * The default database schema.
+         */
+        @ConfigItem
+        public Optional<String> defaultSchema;
+
+        /**
+         * The charset of the database.
+         */
+        @ConfigItem
+        public Optional<String> charset;
+
+        public boolean isAnyPropertySet() {
+            return generation.isPresent() || defaultCatalog.isPresent() || defaultSchema.isPresent() || generationHaltOnError
+                    || charset.isPresent();
+        }
+    }
+
+    @ConfigGroup
+    public static class HibernateOrmConfigJdbc {
+
+        /**
+         * The timezone pushed to the JDBC driver.
+         */
+        @ConfigItem
+        public Optional<String> timezone;
+
+        /**
+         * How many rows are fetched at a time by the JDBC driver.
+         */
+        @ConfigItem
+        public Optional<Integer> statementFetchSize;
+
+        /**
+         * The number of updates (inserts, updates and deletes) that are sent to the database at one time for execution.
+         */
+        @ConfigItem
+        public Optional<Integer> statementBatchSize;
+
+        public boolean isAnyPropertySet() {
+            return timezone.isPresent() || statementFetchSize.isPresent() || statementBatchSize.isPresent();
+        }
+    }
+
+    @ConfigGroup
+    public static class HibernateOrmConfigLog {
+
+        /**
+         * Whether we log all the SQL queries executed.
+         * <p>
+         * Setting it to true is obviously not recommended in production.
+         */
+        @ConfigItem(defaultValue = "false")
+        public boolean sql;
+
+        /**
+         * Whether JDBC warnings should be collected and logged.
+         * <p>
+         * Default value depends on the dialect.
+         */
+        @ConfigItem
+        public Optional<Boolean> jdbcWarnings;
+
+        public boolean isAnyPropertySet() {
+            return sql || jdbcWarnings.isPresent();
+        }
+    }
+}