Merge pull request #329 from wayne-pq/feat/optimized-code-wayne

mark deprecated method and fix unreachable exception

Author: hantmac

databend-jdbc/pom.xml

@@ -36,7 +36,10 @@
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-core</artifactId>
-            <version>2.13.1</version>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.core</groupId>
+            <artifactId>jackson-databind</artifactId>
         </dependency>
 
         <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->

databend-jdbc/src/main/java/com/databend/jdbc/AbstractDatabendResultSet.java

@@ -21,6 +21,7 @@
 import java.io.InputStream;
 import java.io.Reader;
 import java.math.BigDecimal;
+import java.math.RoundingMode;
 import java.net.URL;
 import java.nio.charset.StandardCharsets;
 import java.sql.Array;
@@ -43,13 +44,7 @@
 import java.time.LocalDateTime;
 import java.time.ZoneId;
 import java.time.ZonedDateTime;
-import java.util.Calendar;
-import java.util.GregorianCalendar;
-import java.util.Iterator;
-import java.util.List;
-import java.util.Map;
-import java.util.Optional;
-import java.util.TimeZone;
+import java.util.*;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicLong;
 import java.util.concurrent.atomic.AtomicReference;
@@ -490,21 +485,43 @@ public double getDouble(int columnIndex)
         }
     }
 
-    @Override
+    /**
+     * Retrieves a BigDecimal value from the specified column with scaling (Deprecated method)
+     *
+     * <p><b>Note: This method is deprecated and will be removed in a future release.
+     * It is recommended to use the scale-free {@link #getBigDecimal(int)} method
+     * to get the raw value and control scaling in the business layer.</b></p>
+     *
+     * <p><b>Migration Example:</b><br>
+     * // Data access layer gets raw value<br>
+     * BigDecimal rawValue = resultSet.getBigDecimal("price");<br>
+     * // Business layer controls scaling<br>
+     * BigDecimal scaledValue = rawValue.setScale(2, RoundingMode.HALF_UP);</p>
+     *
+     * @param columnIndex 1-based column index
+     * @param scale Number of decimal places (must be ≥ 0)
+     * @return BigDecimal value with specified scale
+     * @throws SQLException If column value is not a valid number format or scale is invalid
+     *
+     * @deprecated Since JDK 1.2, scheduled for removal. Use {@link #getBigDecimal(int)}
+     *             with business layer scaling instead.
+     */
+    @Override
+    @Deprecated
     public BigDecimal getBigDecimal(int columnIndex, int scale)
             throws SQLException {
         Object value = column(columnIndex);
-        if (value == null) {
+        if (Objects.isNull(value)) {
             return null;
         }
         try {
             BigDecimal bigDecimal = (BigDecimal) value;
-            return bigDecimal.setScale(scale, BigDecimal.ROUND_HALF_UP);
+            return bigDecimal.setScale(scale, RoundingMode.HALF_UP);
         } catch (ClassCastException e) {
             // try to parse bigDecimal
             try {
                 BigDecimal bigDecimal = new BigDecimal(value.toString());
-                return bigDecimal.setScale(scale, BigDecimal.ROUND_HALF_UP);
+                return bigDecimal.setScale(scale, RoundingMode.HALF_UP);
             } catch (NumberFormatException ex) {
                 throw new SQLException("Value at columnIndex " + columnIndex + " is not a valid BigDecimal.");
             }
@@ -601,6 +618,7 @@ public InputStream getAsciiStream(int columnIndex)
     }
 
     @Override
+    @Deprecated
     public InputStream getUnicodeStream(int columnIndex)
             throws SQLException {
         throw new SQLFeatureNotSupportedException("getUnicodeStream");
@@ -678,7 +696,29 @@ public double getDouble(String columnLabel)
         return getDouble(columnIndex(columnLabel));
     }
 
-    @Override
+    /**
+     * Retrieves a BigDecimal value from the specified column by name with scaling (Deprecated method)
+     *
+     * <p><strong>Deprecation Notice:</strong><br>
+     * This method is scheduled for removal in a future release. The scaling operation should be
+     * performed in the business layer rather than during data retrieval.</p>
+     *
+     * <p><b>Migration Example:</b><br>
+     * // Data access layer gets raw value<br>
+     * BigDecimal rawValue = getBigDecimal(columnLabel);<br>
+     * // Business layer controls scaling<br>
+     * BigDecimal scaledValue = rawValue.setScale(desiredScale, RoundingMode.HALF_UP);</p>
+     *
+     * @param columnLabel the column name label (case sensitivity depends on database)
+     * @param scale the number of digits after the decimal point (must be ≥ 0)
+     * @return the column value as BigDecimal with specified scale, or null if the value is SQL NULL
+     * @throws SQLException if columnLabel is invalid or scale is invalid
+     *
+     * @deprecated As of JDK 1.2, replaced by {@link #getBigDecimal(String)} combined with
+     *             explicit scaling in business logic. Scheduled for removal in a future release.
+     */
+    @Override
+    @Deprecated
     public BigDecimal getBigDecimal(String columnLabel, int scale)
             throws SQLException {
         return getBigDecimal(columnIndex(columnLabel), scale);
@@ -715,6 +755,7 @@ public InputStream getAsciiStream(String columnLabel)
     }
 
     @Override
+    @Deprecated
     public InputStream getUnicodeStream(String columnLabel)
             throws SQLException {
         throw new SQLFeatureNotSupportedException("getUnicodeStream");
@@ -789,7 +830,6 @@ public BigDecimal getBigDecimal(int columnIndex)
         if (value == null) {
             return null;
         }
-
         return parseBigDecimal(String.valueOf(value));
     }
 

databend-jdbc/src/main/java/com/databend/jdbc/DatabendConnection.java

@@ -98,9 +98,11 @@ private void initializeFileHandler() {
                 return;
             }
             try {
-                System.setProperty("java.util.logging.FileHandler.limit", "2147483647"); // 2GB，Integer.MAX_VALUE
+                // 2GB，Integer.MAX_VALUE
+                System.setProperty("java.util.logging.FileHandler.limit", "2147483647");
                 System.setProperty("java.util.logging.FileHandler.count", "200");
-                System.setProperty("java.util.logging.FileHandler.append", "true"); // Enable log file reuse
+                // Enable log file reuse
+                System.setProperty("java.util.logging.FileHandler.append", "true");
                 FILE_HANDLER = new FileHandler(file.getAbsolutePath(), Integer.parseInt(System.getProperty("java.util.logging.FileHandler.limit")),
                         Integer.parseInt(System.getProperty("java.util.logging.FileHandler.count")), true);
                 FILE_HANDLER.setLevel(Level.ALL);
@@ -730,7 +732,8 @@ DatabendClient startQueryWithFailover(String sql, StageAttachment attach) throws
                 if (shouldRetryException(e) && attempt < maxRetries) {
                     lastException = wrapException("query failed", sql, e);
                     try {
-                        Thread.sleep(Math.min(100 * (1 << attempt), 5000)); // back off retry
+                        // back off retry
+                        Thread.sleep(Math.min(100 * (1 << attempt), 5000));
                     } catch (InterruptedException ie) {
                         Thread.currentThread().interrupt();
                         throw wrapException("query interrupt", sql, ie);
@@ -924,7 +927,8 @@ public void uploadStream(String stageName, String destPrefix, InputStream inputS
                     }
                 }
                 dataStream = new ByteArrayInputStream(byteArrayOutputStream.toByteArray());
-                fileSize = byteArrayOutputStream.size();  // Update the file size to the compressed size
+                // Update the file size to the compressed size
+                fileSize = byteArrayOutputStream.size();
             }
             if (this.driverUri.presignedUrlDisabled()) {
                 DatabendPresignClient cli = new DatabendPresignClientV1(httpClient, this.httpUri.toString());
@@ -1128,7 +1132,7 @@ private void doHeartbeat(ArrayList<QueryLiveness> queryLivenesses ) {
                 logger.warning("fail to encode heartbeat body: " + e);
             } catch (SQLException e) {
                 logger.warning("fail to send heartbeat: " + e);
-            } catch (IOException e) {
+            } catch (Exception e) {
                 logger.warning("fail to send heartbeat: " + e);
                 throw new RuntimeException(e);
             }

databend-jdbc/src/test/java/com/databend/jdbc/TestDatabendDatabaseMetaData.java

@@ -5,6 +5,7 @@
 import org.testng.annotations.Test;
 
 import java.math.BigDecimal;
+import java.math.RoundingMode;
 import java.sql.*;
 import java.util.ArrayList;
 import java.util.List;
@@ -59,10 +60,12 @@ public void setUp()
         Connection c = Utils.createConnection();
         c.createStatement().execute("drop table if exists test_column_meta");
         c.createStatement().execute("drop table if exists decimal_test");
+        c.createStatement().execute("drop table if exists decimal_test_1");
         c.createStatement().execute("drop table if exists test_comment");
         c.createStatement().execute("drop view if exists v_test_comment");
         c.createStatement().execute("create table test_column_meta (nu1 uint8 null, u1 uint8, u2 uint16, u3 uint32, u4 uint64, i1 int8, i2 int16, i3 int32, i4 int64, f1 float32, f2 float64, s1 string,d1 date, d2 datetime, v1 variant, a1 array(int64), t1 Tuple(x Int64, y Int64 NULL)) engine = fuse");
         c.createStatement().execute("create table decimal_test (a decimal(4,2))");
+        c.createStatement().execute("create table decimal_test_1 (a decimal(15,12))");
         c.createStatement().execute("create table test_comment (a int comment 'test comment')");
         c.createStatement().execute("create view v_test_comment as select * from test_comment");
         // json data
@@ -236,6 +239,45 @@ public void testGetObjectWithDecimal() throws Exception {
         }
     }
 
+    @Test(groups = {"IT"})
+    public void testGetBigDecimal() throws Exception {
+        String bigDecimalStr = "123.456789012345";
+        String scaleBigDecimalStr = "123.46";
+        String columnLabel = "a";
+        try (Connection connection = Utils.createConnection()) {
+            connection.createStatement().execute(String.format("insert into decimal_test_1 values(%s)", bigDecimalStr));
+            ResultSet rs = connection.createStatement().executeQuery("select * from decimal_test_1");
+            while (rs.next()) {
+                // get BigDecimal using columnIndex
+                BigDecimal value = rs.getBigDecimal(1);
+                Assert.assertEquals(value.stripTrailingZeros().toPlainString(), bigDecimalStr);
+
+                // get BigDecimal using columnLabel
+                value = rs.getBigDecimal(columnLabel);
+                Assert.assertEquals(value.stripTrailingZeros().toPlainString(), bigDecimalStr);
+
+                // get BigDecimal using column index + scale （No longer recommended）
+                value = rs.getBigDecimal(1, 2);
+                Assert.assertEquals(value.stripTrailingZeros().toPlainString(), scaleBigDecimalStr);
+
+                // get BigDecimal using columnLabel + scale （No longer recommended）
+                value = rs.getBigDecimal(columnLabel, 2);
+                Assert.assertEquals(value.stripTrailingZeros().toPlainString(), scaleBigDecimalStr);
+
+                // get BigDecimal with scale using index （recommended）
+                value = rs.getBigDecimal(1);
+                value = value.setScale(2, RoundingMode.HALF_UP);
+                Assert.assertEquals(value.stripTrailingZeros().toPlainString(), scaleBigDecimalStr);
+
+                // get BigDecimal with scale using columnLabel + scale （recommended）
+                value = rs.getBigDecimal(columnLabel);
+                value = value.setScale(2, RoundingMode.HALF_UP);
+                Assert.assertEquals(value.stripTrailingZeros().toPlainString(), scaleBigDecimalStr);
+
+            }
+        }
+    }
+
     @Test(groups = {"IT"})
     public void testGetPrimaryKeys() throws Exception {
         try (Connection connection = Utils.createConnection()) {