Merge pull request #5185 from anamarija/4082-validationQuery

Introduce the ability to configure Agroal validation query

Author: gsmet

extensions/agroal/runtime/src/main/java/io/quarkus/agroal/runtime/AbstractDataSourceProducer.java

@@ -1,6 +1,8 @@
 package io.quarkus.agroal.runtime;
 
+import java.sql.Connection;
 import java.sql.Driver;
+import java.sql.Statement;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Optional;
@@ -167,6 +169,22 @@ public AgroalDataSource createDataSource(String dataSourceName,
         if (dataSourceRuntimeConfig.backgroundValidationInterval.isPresent()) {
             poolConfiguration.validationTimeout(dataSourceRuntimeConfig.backgroundValidationInterval.get());
         }
+        if (dataSourceRuntimeConfig.validationQuerySql.isPresent()) {
+            String validationQuery = dataSourceRuntimeConfig.validationQuerySql.get();
+            poolConfiguration.connectionValidator(new ConnectionValidator() {
+
+                @Override
+                public boolean isValid(Connection connection) {
+                    try (Statement stmt = connection.createStatement()) {
+                        stmt.execute(validationQuery);
+                        return true;
+                    } catch (Exception e) {
+                        log.warn("Connection validation failed", e);
+                    }
+                    return false;
+                }
+            });
+        }
         if (dataSourceRuntimeConfig.idleRemovalInterval.isPresent()) {
             poolConfiguration.reapTimeout(dataSourceRuntimeConfig.idleRemovalInterval.get());
         }

extensions/agroal/runtime/src/main/java/io/quarkus/agroal/runtime/DataSourceRuntimeConfig.java

@@ -124,4 +124,10 @@ public class DataSourceRuntimeConfig {
      */
     @ConfigItem
     public Optional<String> newConnectionSql;
+
+    /**
+     * Query executed to validate a connection.
+     */
+    @ConfigItem
+    public Optional<String> validationQuerySql;
 }