#997

Author: babyfish-ct

project/jimmer-sql-kotlin/src/main/kotlin/org/babyfish/jimmer/sql/kt/KSqlClient.kt

@@ -5,6 +5,7 @@ import org.babyfish.jimmer.lang.NewChain
 import org.babyfish.jimmer.sql.JSqlClient
 import org.babyfish.jimmer.sql.ast.mutation.DeleteMode
 import org.babyfish.jimmer.sql.event.binlog.BinLog
+import org.babyfish.jimmer.sql.exception.DatabaseValidationException
 import org.babyfish.jimmer.sql.exception.EmptyResultException
 import org.babyfish.jimmer.sql.exception.TooManyResultsException
 import org.babyfish.jimmer.sql.fetcher.DtoMetadata
@@ -265,6 +266,29 @@ interface KSqlClient : KDeprecatedMoreSaveOperations {
      */
     fun <R> transaction(propagation: Propagation = Propagation.REQUIRED, block: () -> R): R
 
+    /**
+     * Validate the database manually.
+     *
+     * User can either automatically validate the database or manually validate it.
+     *
+     * - Automatically:
+     *   Specify the `databaseValidationMode` as
+     *   [DatabaseValidationMode.ERROR] or [DatabaseValidationMode.WARNING]
+     *   when building the `KSqlClient` object, so there is **NO** need
+     *   to call this function
+     *
+     * - Manually: Specify the `databaseValidationMode` as
+     *   [DatabaseValidationMode.NONE] and call this method after obtaining
+     *   the `KSqlClient` object
+     *
+     * > Note: If there are any database validation errors, the relevant
+     * exceptions will be returned as the result of this method
+     * instead of being thrown directly.
+     *
+     * @return The validation error or null
+     */
+    fun validateDatabase(): DatabaseValidationException?
+
     val javaClient: JSqlClientImplementor
 }
 

project/jimmer-sql-kotlin/src/main/kotlin/org/babyfish/jimmer/sql/kt/di/AbstractKSqlClientDelegate.kt

@@ -1,6 +1,7 @@
 package org.babyfish.jimmer.sql.kt.di
 
 import org.babyfish.jimmer.sql.event.binlog.BinLog
+import org.babyfish.jimmer.sql.exception.DatabaseValidationException
 import org.babyfish.jimmer.sql.kt.*
 import org.babyfish.jimmer.sql.kt.ast.KExecutable
 import org.babyfish.jimmer.sql.kt.ast.mutation.KMutableDelete
@@ -83,6 +84,9 @@ abstract class AbstractKSqlClientDelegate : KSqlClientImplementor {
     override fun <R> transaction(propagation: Propagation, block: () -> R): R =
         sqlClient().transaction(propagation, block)
 
+    override fun validateDatabase(): DatabaseValidationException? =
+        sqlClient().validateDatabase()
+
     override val javaClient: JSqlClientImplementor
         get() = sqlClient().javaClient
 }

project/jimmer-sql-kotlin/src/main/kotlin/org/babyfish/jimmer/sql/kt/impl/KSqlClientImpl.kt

@@ -9,6 +9,7 @@ import org.babyfish.jimmer.sql.ast.impl.query.FilterLevel
 import org.babyfish.jimmer.sql.ast.impl.query.MutableRootQueryImpl
 import org.babyfish.jimmer.sql.ast.table.Table
 import org.babyfish.jimmer.sql.event.binlog.BinLog
+import org.babyfish.jimmer.sql.exception.DatabaseValidationException
 import org.babyfish.jimmer.sql.kt.*
 import org.babyfish.jimmer.sql.kt.ast.KExecutable
 import org.babyfish.jimmer.sql.kt.ast.mutation.*
@@ -152,6 +153,9 @@ internal class KSqlClientImpl(
     override fun <R> transaction(propagation: Propagation, block: () -> R): R =
         javaClient.transaction(propagation, block)
 
+    override fun validateDatabase(): DatabaseValidationException? =
+        javaClient.validateDatabase()
+
     override val entityManager: EntityManager
         get() = javaClient.entityManager
 

project/jimmer-sql/src/main/java/org/babyfish/jimmer/sql/JSqlClient.java

@@ -16,6 +16,7 @@
 import org.babyfish.jimmer.sql.event.Triggers;
 import org.babyfish.jimmer.sql.event.binlog.BinLog;
 import org.babyfish.jimmer.sql.event.binlog.BinLogPropReader;
+import org.babyfish.jimmer.sql.exception.DatabaseValidationException;
 import org.babyfish.jimmer.sql.fetcher.Fetcher;
 import org.babyfish.jimmer.sql.fetcher.ReferenceFetchType;
 import org.babyfish.jimmer.sql.filter.Filter;
@@ -244,6 +245,30 @@ default <R> R transaction(Supplier<R> block) {
      */
     <R> R transaction(Propagation propagation, Supplier<R> block);
 
+    /**
+     * Validate the database manually.
+     *
+     * <p>User can either automatically validate the database or manually validate it.</p>
+     *
+     * <ul>
+     *     <li>Automatically: Specify the {@code databaseValidationMode} as
+     *     {@link DatabaseValidationMode#ERROR} or {@link DatabaseValidationMode#ERROR}
+     *     when building the {@code JSqlClient} object, so there is <b>NO</b> need
+     *     to call this method</li>
+     *     <li>Manually: Specify the {@code databaseValidationMode} as
+     *     {@link DatabaseValidationMode#NONE} and call this method after obtaining
+     *     the {@code JSqlClient} object</li>
+     * </ul>
+     *
+     * <p>Note: If there are any database validation errors, the relevant
+     * exceptions will be returned as the result of this method
+     * instead of being thrown directly.</p>
+     *
+     * @return The validation error or null
+     */
+    @Nullable
+    DatabaseValidationException validateDatabase();
+
     interface Builder {
 
         int DEFAULT_BATCH_SIZE = 128;

project/jimmer-sql/src/main/java/org/babyfish/jimmer/sql/JSqlClientImpl.java

@@ -495,6 +495,34 @@ public <R> R transaction(Propagation propagation, Supplier<R> block) {
         return txConnectionManager.executeTransaction(propagation, con -> block.get());
     }
 
+    @Nullable
+    @Override
+    public DatabaseValidationException validateDatabase() {
+        ConnectionManager cm = connectionManager;
+        if (cm == null) {
+            throw new IllegalStateException(
+                    "The `connectionManager` of must be configured when `validate` is configured"
+            );
+        }
+        return cm.execute(con -> {
+            try {
+                return DatabaseValidators.validate(
+                        entityManager,
+                        microServiceName,
+                        defaultDissociationActionCheckable,
+                        metadataStrategy,
+                        null,
+                        con
+                );
+            } catch (SQLException ex) {
+                throw new ExecutionException(
+                        "Cannot validate the database because of SQL exception",
+                        ex
+                );
+            }
+        });
+    }
+
     @Override
     public Entities getEntities() {
         return entities;
@@ -1838,7 +1866,7 @@ public JSqlClient build() {
                     );
                 }
             }
-            validateDatabase(metadataStrategy);
+            validateDatabase(sqlClient);
             return sqlClient;
         }
 
@@ -1912,31 +1940,9 @@ private void validateAssociations(FilterManager filterManager) {
             }
         }
 
-        private void validateDatabase(MetadataStrategy metadataStrategy) {
+        private void validateDatabase(JSqlClient sqlClient) {
             if (databaseValidationMode != DatabaseValidationMode.NONE) {
-                ConnectionManager cm = connectionManager;
-                if (cm == null) {
-                    throw new IllegalStateException(
-                            "The `connectionManager` of must be configured when `validate` is configured"
-                    );
-                }
-                DatabaseValidationException validationException = cm.execute(con -> {
-                    try {
-                        return DatabaseValidators.validate(
-                                entityManager(),
-                                microServiceName,
-                                defaultDissociationActionCheckable,
-                                metadataStrategy,
-                                null,
-                                con
-                        );
-                    } catch (SQLException ex) {
-                        throw new ExecutionException(
-                                "Cannot validate the database because of SQL exception",
-                                ex
-                        );
-                    }
-                });
+                DatabaseValidationException validationException = sqlClient.validateDatabase();
                 if (validationException != null) {
                     if (databaseValidationMode == DatabaseValidationMode.ERROR) {
                         throw validationException;

project/jimmer-sql/src/main/java/org/babyfish/jimmer/sql/di/AbstractJSqlClientDelegate.java

@@ -20,6 +20,7 @@
 import org.babyfish.jimmer.sql.event.TriggerType;
 import org.babyfish.jimmer.sql.event.Triggers;
 import org.babyfish.jimmer.sql.event.binlog.BinLog;
+import org.babyfish.jimmer.sql.exception.DatabaseValidationException;
 import org.babyfish.jimmer.sql.fetcher.Fetcher;
 import org.babyfish.jimmer.sql.fetcher.ReferenceFetchType;
 import org.babyfish.jimmer.sql.filter.FilterConfig;
@@ -430,6 +431,12 @@ public <R> R transaction(Propagation propagation, Supplier<R> block) {
         return sqlClient().transaction(propagation, block);
     }
 
+    @Override
+    @Nullable
+    public DatabaseValidationException validateDatabase() {
+        return sqlClient().validateDatabase();
+    }
+
     @Override
     public MutableSubQuery createSubQuery(TableProxy<?> table) {
         return sqlClient().createSubQuery(table);

project/jimmer-sql/src/main/java/org/babyfish/jimmer/sql/runtime/ConnectionManager.java

@@ -7,7 +7,6 @@
 import javax.sql.DataSource;
 import java.sql.Connection;
 import java.sql.SQLException;
-import java.util.Objects;
 import java.util.function.Function;
 
 @FunctionalInterface

project/jimmer-sql/src/main/java/org/babyfish/jimmer/sql/runtime/DatabaseValidationMode.java

@@ -1,7 +1,31 @@
 package org.babyfish.jimmer.sql.runtime;
 
 public enum DatabaseValidationMode {
+
+    /**
+     * Default option, no automatic database validation is required.
+     *
+     * <p>You need this configuration in the following two cases:</p>
+     * <ul>
+     *     <li>You do not want to validate the database.</li>
+     *     <li>You want to manually validate the database for specific purposes,
+     *     such as precisely controlling the timing of validation.
+     *     <i>In this case, you need to manually call the `validateDatabase`
+     *     method of the `sqlClient` object.</i>
+     *     </li>
+     * </ul>
+     */
     NONE,
+
+    /**
+     * Automatically validate the database,
+     * and if there are validation errors, throw an exception.
+     */
     WARNING,
+
+    /**
+     * Automatically validate the database,
+     * and if there are validation errors, print a warning.
+     */
     ERROR
 }