You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@empire-db.apache.org by do...@apache.org on 2025/10/14 13:30:27 UTC

(empire-db) branch master updated: EMPIREDB-479 QueryFailedException improved logging

This is an automated email from the ASF dual-hosted git repository.

doebele pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/empire-db.git


The following commit(s) were added to refs/heads/master by this push:
     new 2ae2460e EMPIREDB-479 QueryFailedException improved logging
2ae2460e is described below

commit 2ae2460e2d26e8af265bc01b1727c29846f2ddde
Author: Rainer Döbele <do...@apache.org>
AuthorDate: Tue Oct 14 15:30:24 2025 +0200

    EMPIREDB-479
    QueryFailedException improved logging
---
 .../java/org/apache/empire/db/DBSQLScript.java     |  2 +-
 .../main/java/org/apache/empire/db/DBUtils.java    | 51 ++++++++++++----------
 .../empire/db/exceptions/QueryFailedException.java | 11 ++---
 .../java/org/apache/empire/dbms/DBMSHandler.java   |  3 +-
 .../org/apache/empire/dbms/DBMSHandlerBase.java    |  7 +--
 .../apache/empire/dbms/hsql/DBMSHandlerHSql.java   | 26 +++++++----
 .../empire/dbms/oracle/DBMSHandlerOracle.java      | 23 ++++++----
 .../dbms/postgresql/DBMSHandlerPostgreSQL.java     | 34 ++++++++++-----
 .../empire/dbms/sqlserver/DBMSHandlerMSSQL.java    | 10 ++++-
 9 files changed, 101 insertions(+), 66 deletions(-)

diff --git a/empire-db/src/main/java/org/apache/empire/db/DBSQLScript.java b/empire-db/src/main/java/org/apache/empire/db/DBSQLScript.java
index 4c33f9a9..1aeb15ef 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBSQLScript.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBSQLScript.java
@@ -477,7 +477,7 @@ public class DBSQLScript implements DBContextAware, Iterable<String>
             log.debug("SQL Comment: {}{}", utils.LOG_NEW_LINE, sqlCmd);
         // Log with or without parameters
         else if (sqlParams!=null && sqlParams.length>0)
-            log.debug("Executing Stmt: {}{}{}Parameters: [{}]", utils.LOG_NEW_LINE, sqlCmd, utils.LOG_NEW_LINE, utils.paramsToString(sqlParams)); 
+            log.debug("Executing Stmt: {}{}{}with params: [{}]", utils.LOG_NEW_LINE, sqlCmd, utils.LOG_NEW_LINE, utils.paramsToString(sqlParams)); 
         else
             log.debug("Executing Stmt: {}{}", utils.LOG_NEW_LINE, sqlCmd);
     }
diff --git a/empire-db/src/main/java/org/apache/empire/db/DBUtils.java b/empire-db/src/main/java/org/apache/empire/db/DBUtils.java
index 8576fe58..b18a15b6 100644
--- a/empire-db/src/main/java/org/apache/empire/db/DBUtils.java
+++ b/empire-db/src/main/java/org/apache/empire/db/DBUtils.java
@@ -175,7 +175,7 @@ public class DBUtils implements DBContextAware
         if (log.isDebugEnabled())
         {   // Log with or without parameters   
             if (sqlParams!=null && sqlParams.length>0)
-                log.debug("Executing DQL: {}{}{}Parameters: [{}]", LOG_NEW_LINE, sqlCmd, LOG_NEW_LINE, paramsToString(sqlParams));
+                log.debug("Executing DQL: {}{}{}with params: [{}]", LOG_NEW_LINE, sqlCmd, LOG_NEW_LINE, paramsToString(sqlParams));
             else
                 log.debug("Executing DQL: {}{}", LOG_NEW_LINE, sqlCmd);
         }
@@ -191,7 +191,7 @@ public class DBUtils implements DBContextAware
         if (log.isInfoEnabled())
         {   // Log with or without parameters   
             if (sqlParams!=null && sqlParams.length>0)
-                log.info("Executing DML: {}{}{}Parameters: [{}]", LOG_NEW_LINE, sqlCmd, LOG_NEW_LINE, paramsToString(sqlParams));
+                log.info("Executing DML: {}{}{}with params: [{}]", LOG_NEW_LINE, sqlCmd, LOG_NEW_LINE, paramsToString(sqlParams));
             else
                 log.info("Executing DML: {}{}", LOG_NEW_LINE, sqlCmd);
         }
@@ -266,7 +266,7 @@ public class DBUtils implements DBContextAware
     
         } catch (SQLException sqle) 
         {   // Error
-            throw new QueryFailedException(dbms, sqlCmd, sqle);
+            throw new QueryFailedException(dbms, sqlCmd, paramsToString(sqlParams), sqle);
         } 
     }
     
@@ -286,23 +286,28 @@ public class DBUtils implements DBContextAware
         // Debug
         logQueryStatement(sqlCmd, sqlParams);
         // Read value
-        long start = System.currentTimeMillis();
-        Object result = dbms.querySingleValue(sqlCmd, sqlParams, dataType, context.getConnection());
-        if (result==ObjectUtils.NO_VALUE)
-        {   // Query returned no result
-            if (failOnNoResult)
-                throw new QueryNoResultException(sqlCmd);
-            else
-                result = null;
-        }
-        // Debug
-        long queryTime = (System.currentTimeMillis() - start);
-        if (log.isDebugEnabled())
-            log.debug("querySingleValue successful in {} ms. Result value={}.", queryTime, result);
-        else if (queryTime>=longRunndingStmtThreshold)
-            log.warn("Long running query took {} seconds for statement {}.", queryTime / 1000, sqlCmd);
-        // done
-        return result;
+        try {
+            long start = System.currentTimeMillis();
+            Object result = dbms.querySingleValue(sqlCmd, sqlParams, dataType, context.getConnection());
+            if (result==ObjectUtils.NO_VALUE)
+            {   // Query returned no result
+                if (failOnNoResult)
+                    throw new QueryNoResultException(sqlCmd);
+                else
+                    result = null;
+            }
+            // Debug
+            long queryTime = (System.currentTimeMillis() - start);
+            if (log.isDebugEnabled())
+                log.debug("querySingleValue successful in {} ms. Result value={}.", queryTime, result);
+            else if (queryTime>=longRunndingStmtThreshold)
+                log.warn("Long running query took {} seconds for statement {}.", queryTime / 1000, sqlCmd);
+            // done
+            return result;
+        } catch (SQLException sqle) 
+        {   // Error
+            throw new QueryFailedException(dbms, sqlCmd, paramsToString(sqlParams), sqle);
+        } 
     }
     
     /**
@@ -545,7 +550,7 @@ public class DBUtils implements DBContextAware
             throw new InternalException(e);
         } catch (SQLException sqle) 
         {   // Error
-            throw new QueryFailedException(dbms, sqlCmd, sqle);
+            throw new QueryFailedException(dbms, sqlCmd, paramsToString(sqlParams), sqle);
         } finally
         { // Cleanup
             dbms.closeResultSet(rs);
@@ -643,7 +648,7 @@ public class DBUtils implements DBContextAware
             return count;
         } catch (SQLException sqle) 
         {   // Error
-            throw new QueryFailedException(dbms, sqlCmd, sqle);
+            throw new QueryFailedException(dbms, sqlCmd, paramsToString(sqlParams), sqle);
         } finally
         { // Cleanup
             dbms.closeResultSet(rs);
@@ -724,7 +729,7 @@ public class DBUtils implements DBContextAware
             return count;
         } catch (SQLException sqle) 
         {   // Error
-            throw new QueryFailedException(dbms, sqlCmd, sqle);
+            throw new QueryFailedException(dbms, sqlCmd, paramsToString(sqlParams), sqle);
         } finally
         { // Cleanup
             dbms.closeResultSet(rs);
diff --git a/empire-db/src/main/java/org/apache/empire/db/exceptions/QueryFailedException.java b/empire-db/src/main/java/org/apache/empire/db/exceptions/QueryFailedException.java
index 8953867e..e36556a1 100644
--- a/empire-db/src/main/java/org/apache/empire/db/exceptions/QueryFailedException.java
+++ b/empire-db/src/main/java/org/apache/empire/db/exceptions/QueryFailedException.java
@@ -21,6 +21,7 @@ package org.apache.empire.db.exceptions;
 import java.sql.SQLException;
 
 import org.apache.empire.commons.ErrorType;
+import org.apache.empire.commons.StringUtils;
 import org.apache.empire.db.DBObject;
 import org.apache.empire.dbms.DBMSHandler;
 import org.slf4j.Logger;
@@ -33,16 +34,16 @@ public class QueryFailedException extends EmpireSQLException
     // Logger
     private static final Logger log = LoggerFactory.getLogger(QueryFailedException.class);
     
-    public static final ErrorType errorType = new ErrorType("error.db.queryFailed",  "Error executing query {0}.\r\nNative error is: {1}");
+    public static final ErrorType errorType = new ErrorType("error.db.queryFailed",  "Error executing query: {0} \nwith params [{2}]. \nNative error is: {1}");
     
-    public QueryFailedException(DBMSHandler dbms, String sqlCmd, SQLException cause)
+    public QueryFailedException(DBMSHandler dbms, String sqlCmd, String sqlParams, SQLException cause)
     {
-        super(QueryFailedException.errorType, new String[] { sqlCmd, messageFromSQLException(dbms, cause) }, 1, cause);
+        super(QueryFailedException.errorType, new String[] { sqlCmd, messageFromSQLException(dbms, cause), StringUtils.coalesce(sqlParams, StringUtils.EMPTY) }, 1, cause);
     }
     
-    public QueryFailedException(DBObject obj, String sqlCmd, SQLException cause)
+    public QueryFailedException(DBObject obj, String sqlCmd, String sqlParams, SQLException cause)
     {
-        this(handlerFromObject(obj), sqlCmd, cause);
+        this(handlerFromObject(obj), sqlCmd, sqlParams, cause);
     }
     
     /**
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandler.java b/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandler.java
index 0503d5a5..f6445c86 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandler.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandler.java
@@ -165,7 +165,8 @@ public interface DBMSHandler
      * @param conn a valid connection to the database.
      * @return the scalar result value or ObjectUtils.NO_VALUE if no row are returned by the query
      */
-    public Object querySingleValue(String sqlCmd, Object[] sqlParams, DataType dataType, Connection conn);
+    public Object querySingleValue(String sqlCmd, Object[] sqlParams, DataType dataType, Connection conn)
+        throws SQLException;
     
     /**
      * This interface is used to set the auto generated keys when executing insert statements.
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandlerBase.java b/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandlerBase.java
index eecabcdd..3decd759 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandlerBase.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/DBMSHandlerBase.java
@@ -52,7 +52,6 @@ import org.apache.empire.db.DBSQLScript;
 import org.apache.empire.db.DBTable;
 import org.apache.empire.db.DBTableColumn;
 import org.apache.empire.db.exceptions.EmpireSQLException;
-import org.apache.empire.db.exceptions.QueryFailedException;
 import org.apache.empire.db.validation.DBModelChecker;
 import org.apache.empire.db.validation.DBModelParser;
 import org.apache.empire.exceptions.InvalidArgumentException;
@@ -296,7 +295,7 @@ public abstract class DBMSHandlerBase implements DBMSHandler
         try {
             querySingleValue(sql.toString(), null, DataType.INTEGER, conn);
             return true;
-        } catch(QueryFailedException e) {
+        } catch(SQLException e) {
             // Database does not exist
             return false;
         }
@@ -758,6 +757,7 @@ public abstract class DBMSHandlerBase implements DBMSHandler
      */
     @Override
     public Object querySingleValue(String sqlCmd, Object[] sqlParams, DataType dataType, Connection conn)
+        throws SQLException
     {
         ResultSet rs = null;
         try
@@ -773,9 +773,6 @@ public abstract class DBMSHandlerBase implements DBMSHandler
             }
             // Read value
             return getResultValue(rs, 1, dataType);
-        } catch (SQLException sqle) 
-        {   // Error
-            throw new QueryFailedException(this, sqlCmd, sqle);
         } finally {
             // Cleanup
             closeResultSet(rs);
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/hsql/DBMSHandlerHSql.java b/empire-db/src/main/java/org/apache/empire/dbms/hsql/DBMSHandlerHSql.java
index 43eb91d6..87bf3a32 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/hsql/DBMSHandlerHSql.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/hsql/DBMSHandlerHSql.java
@@ -19,6 +19,7 @@
 package org.apache.empire.dbms.hsql;
 
 import java.sql.Connection;
+import java.sql.SQLException;
 import java.util.GregorianCalendar;
 
 import org.apache.empire.commons.ObjectUtils;
@@ -32,6 +33,7 @@ import org.apache.empire.db.DBObject;
 import org.apache.empire.db.DBSQLBuilder;
 import org.apache.empire.db.DBSQLScript;
 import org.apache.empire.db.DBTableColumn;
+import org.apache.empire.db.exceptions.QueryFailedException;
 import org.apache.empire.db.exceptions.QueryNoResultException;
 import org.apache.empire.db.validation.DBModelChecker;
 import org.apache.empire.dbms.DBMSFeature;
@@ -234,7 +236,7 @@ public class DBMSHandlerHSql extends DBMSHandlerBase
      */
     @Override
     public Object getNextSequenceValue(DBDatabase db, String seqName, int minValue, Connection conn)
-    { 	//Use Oracle Sequences
+    { 	//Use Sequence
         DBSQLBuilder sql = createSQLBuilder();
         sql.append("SELECT ");
         sql.append("NEXT VALUE FOR ");
@@ -244,14 +246,20 @@ public class DBMSHandlerHSql extends DBMSHandlerBase
         String sqlCmd = sql.toString();
         if (log.isDebugEnabled())
             log.debug("Executing: " + sqlCmd);
-        Object val = querySingleValue(sqlCmd, null, DataType.INTEGER, conn);
-        if (ObjectUtils.isEmpty(val))
-        {   // Error!
-            log.error("getNextSequenceValue: Invalid sequence value for sequence " + seqName);
-            throw new QueryNoResultException(sqlCmd);
-        }
-        // Done
-        return val;
+        // execute
+        try {
+            Object val = querySingleValue(sqlCmd, null, DataType.INTEGER, conn);
+            if (ObjectUtils.isEmpty(val))
+            {   // Error!
+                log.error("getNextSequenceValue: Invalid sequence value for sequence " + seqName);
+                throw new QueryNoResultException(sqlCmd);
+            }
+            // Done
+            return val;
+        } catch (SQLException sqle) 
+        {   // Error
+            throw new QueryFailedException(this, sqlCmd, null, sqle);
+        } 
     }
 
     /**
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/oracle/DBMSHandlerOracle.java b/empire-db/src/main/java/org/apache/empire/dbms/oracle/DBMSHandlerOracle.java
index 6f8229d4..dc45f618 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/oracle/DBMSHandlerOracle.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/oracle/DBMSHandlerOracle.java
@@ -46,6 +46,7 @@ import org.apache.empire.db.DBTableColumn;
 import org.apache.empire.db.DBView;
 import org.apache.empire.db.context.DBContextStatic;
 import org.apache.empire.db.exceptions.EmpireSQLException;
+import org.apache.empire.db.exceptions.QueryFailedException;
 import org.apache.empire.db.exceptions.QueryNoResultException;
 import org.apache.empire.db.validation.DBModelChecker;
 import org.apache.empire.dbms.DBMSFeature;
@@ -399,14 +400,20 @@ public class DBMSHandlerOracle extends DBMSHandlerBase
         String sqlCmd = sql.toString();
         if (log.isDebugEnabled())
             log.debug("Executing: " + sqlCmd);
-        Object val = querySingleValue(sqlCmd, null, DataType.UNKNOWN, conn);
-        if (ObjectUtils.isEmpty(val))
-        {   // Error!
-            log.error("getNextSequenceValue: Invalid sequence value for sequence " + seqName);
-            throw new QueryNoResultException(sqlCmd);
-        }
-        // Done
-        return val;
+        // execute
+        try {
+            Object val = querySingleValue(sqlCmd, null, DataType.UNKNOWN, conn);
+            if (ObjectUtils.isEmpty(val))
+            {   // Error!
+                log.error("getNextSequenceValue: Invalid sequence value for sequence " + seqName);
+                throw new QueryNoResultException(sqlCmd);
+            }
+            // Done
+            return val;
+        } catch (SQLException sqle) 
+        {   // Error
+            throw new QueryFailedException(this, sqlCmd, null, sqle);
+        } 
     }
 
     /**
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/postgresql/DBMSHandlerPostgreSQL.java b/empire-db/src/main/java/org/apache/empire/dbms/postgresql/DBMSHandlerPostgreSQL.java
index f7deac83..41845e8b 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/postgresql/DBMSHandlerPostgreSQL.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/postgresql/DBMSHandlerPostgreSQL.java
@@ -31,6 +31,7 @@ import org.apache.empire.db.DBColumn;
 import org.apache.empire.db.DBColumnExpr;
 import org.apache.empire.db.DBDDLGenerator;
 import org.apache.empire.db.DBDDLGenerator.DDLActionType;
+import org.apache.empire.db.exceptions.QueryFailedException;
 import org.apache.empire.db.DBDatabase;
 import org.apache.empire.db.DBObject;
 import org.apache.empire.db.DBSQLBuilder;
@@ -283,13 +284,17 @@ public class DBMSHandlerPostgreSQL extends DBMSHandlerBase
     { 
 		// Use PostgreSQL Sequences
 		String sqlCmd = "SELECT nextval(?)";
-		Object[] sqlParams = { seqName };
-		Object val = querySingleValue(sqlCmd, sqlParams, DataType.INTEGER, conn);
-		if (val == null)
-		{
-			log.error("getNextSequenceValue: Invalid sequence value for sequence " + seqName);
-		}
-		return val;
+		try {
+	        Object val = querySingleValue(sqlCmd, new Object[] { seqName }, DataType.INTEGER, conn);
+	        if (val == null)
+	        {
+	            log.error("getNextSequenceValue: Invalid sequence value for sequence " + seqName);
+	        }
+	        return val;
+        } catch (SQLException sqle) 
+        {   // Error
+            throw new QueryFailedException(this, sqlCmd, seqName, sqle);
+        } 
     }
 
     /**
@@ -399,11 +404,16 @@ public class DBMSHandlerPostgreSQL extends DBMSHandlerBase
 		// Use find PostgreSQL auto-generated sequence
 		String sqlCmd = "SELECT pg_get_serial_sequence(?, ?)";
 		Object[] sqlParams = { column.getRowSet().getName().toLowerCase(), column.getName().toLowerCase() };
-		String seqName = StringUtils.toString(querySingleValue(sqlCmd, sqlParams, DataType.VARCHAR, conn));
-		if (seqName == null) { // Error!
-			log.error("getNextSequenceName: Invalid sequence value for column " + column.getName());
-		}
-		return seqName;
+		try {
+	        String seqName = StringUtils.toString(querySingleValue(sqlCmd, sqlParams, DataType.VARCHAR, conn));
+	        if (seqName == null) { // Error!
+	            log.error("getNextSequenceName: Invalid sequence value for column " + column.getName());
+	        }
+	        return seqName;
+        } catch (SQLException sqle) 
+        {   // Error
+            throw new QueryFailedException(this, sqlCmd, StringUtils.arrayToString(sqlParams), sqle);
+        } 
 	}
     
 }
diff --git a/empire-db/src/main/java/org/apache/empire/dbms/sqlserver/DBMSHandlerMSSQL.java b/empire-db/src/main/java/org/apache/empire/dbms/sqlserver/DBMSHandlerMSSQL.java
index 59d65d63..fa3e2e04 100644
--- a/empire-db/src/main/java/org/apache/empire/dbms/sqlserver/DBMSHandlerMSSQL.java
+++ b/empire-db/src/main/java/org/apache/empire/dbms/sqlserver/DBMSHandlerMSSQL.java
@@ -39,6 +39,7 @@ import org.apache.empire.db.DBSQLScript;
 import org.apache.empire.db.DBTable;
 import org.apache.empire.db.DBTableColumn;
 import org.apache.empire.db.exceptions.EmpireSQLException;
+import org.apache.empire.db.exceptions.QueryFailedException;
 import org.apache.empire.db.validation.DBModelChecker;
 import org.apache.empire.db.validation.DBModelParser;
 import org.apache.empire.dbms.DBMSFeature;
@@ -549,8 +550,13 @@ public class DBMSHandlerMSSQL extends DBMSHandlerBase
     {
         // Supports sequences?
         if (column.getDataType()==DataType.UNIQUEID)
-        {
-            return querySingleValue("select newid()", null, DataType.UNIQUEID, conn);
+        {   // create new unique-id
+            String sqlCmd = "select newid()";
+            try {
+                return querySingleValue(sqlCmd, null, DataType.UNIQUEID, conn);
+            } catch (SQLException sqle) {
+                throw new QueryFailedException(this, sqlCmd, null, sqle);
+            } 
         }
         return super.getColumnAutoValue(db, column, conn);
     }