[jdbc-v2] Connection.createArrayOf / createStruct throw IllegalArgumentException instead of SQLException for an invalid type name

Abierto Apto para principiantes
#3,347 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
85/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
java
Área
database

Línea de trabajo

Empieza en jdbc-v2/src/main/java/com/clickhouse/jdbc/ConnectionImpl.java en createArrayOf (alrededor de la línea 652) y createStruct (alrededor de la línea 667), y rastrea dónde ClickHouseColumn.of lanza IllegalArgumentException o NumberFormatException. Está terminado cuando ambos métodos lanzan SQLException con la excepción del parser como causa y SQLState HY000, mientras que el comportamiento con null, con la conexión cerrada y con tipos válidos sigue igual. Añade un DataProvider con nombres de tipo rechazados que cubra ambos métodos y verifica SQLException y su causa.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

bug jdbc-v2

Description

In jdbc-v2, Connection.createArrayOf(typeName, ...) and Connection.createStruct(typeName, ...) throw an unchecked IllegalArgumentException (or NumberFormatException) when the type-name parser rejects typeName. Both methods declare throws SQLException, and the JDBC API says that they throw SQLException. A caller that catches SQLException does not catch this error. Frameworks that translate SQLException (for example Spring's SQLExceptionTranslator) also do not see it.

All type names that the parser rejects are affected: an unknown type, a misspelled type, unbalanced parentheses, invalid type parameters, and an empty string. The server also rejects these names (see below), so an exception is correct. Only the exception type is wrong.

The two methods already throw SQLException for their other failures: a closed connection (08000), a non-Tuple type in createStruct (HY000, "Only Tuple datatype is supported for Struct"), and an error while createArrayOf builds the array (HY000, "Failed to create array"). Only the type-name parse step is outside this handling.

This is a different problem from #3344. #3344 is about one parse failure (Enum elements without numbers). After a fix for #3344, createArrayOf("NoSuchType", ...) still throws IllegalArgumentException.

Root cause

jdbc-v2/src/main/java/com/clickhouse/jdbc/ConnectionImpl.java:

  • createArrayOf, line 652: ClickHouseColumn.of("array", typeName) runs before the try { ... } catch (Exception e) { throw new SQLException("Failed to create array", ...) } block. A parse exception is not wrapped.
  • createStruct, line 667: ClickHouseColumn.of("v", typeName) has no try/catch.

ClickHouseColumn.of throws IllegalArgumentException for a type name that it cannot parse (for example from ClickHouseDataType.of, ClickHouseDataType.java:497), and NumberFormatException for an invalid numeric parameter.

Suggested fix
  • createArrayOf: move ClickHouseColumn.of(...) into the existing try.
  • createStruct: put ClickHouseColumn.of(...) in a try, and rethrow a parse exception as SQLException with ExceptionUtils.SQL_STATE_CLIENT_ERROR and the original exception as the cause. Put the type name in the message.
  • Keep the current behavior for: typeName == null (SQLFeatureNotSupportedException), a closed connection (SQLException, 08000), a non-Tuple type in createStruct, and all valid type names.
  • Test: one @DataProvider of rejected type names (unknown type, unbalanced parentheses, invalid Decimal parameters, empty string) for both methods. Assert SQLException and its cause.

Compatibility: a caller that catches IllegalArgumentException from these two methods gets SQLException after the fix. SQLException is already in both method signatures, so existing code still compiles.

Steps to reproduce
  1. Build main (f73e372bc). Connect with jdbc-v2 to ClickHouse 26.9.1.1629.
  2. Call conn.createArrayOf("NoSuchType", new Object[] {1}) in try { ... } catch (SQLException e) { ... }.
  3. The catch block does not run. java.lang.IllegalArgumentException: Unknown data type: NoSuchType goes out of the try. createStruct("Tuple(NoSuchType, UInt8)", ...) gives the same result.
Error Log or Exception StackTrace
java.lang.IllegalArgumentException: Unknown data type: NoSuchType
	at com.clickhouse.data.ClickHouseDataType.of(ClickHouseDataType.java:497)
	at com.clickhouse.data.ClickHouseColumn.readColumn(ClickHouseColumn.java:714)
	at com.clickhouse.data.ClickHouseColumn.of(ClickHouseColumn.java:763)
	at com.clickhouse.jdbc.ConnectionImpl.createArrayOf(ConnectionImpl.java:652)

java.lang.IllegalArgumentException: Unknown data type: NoSuchType
	at com.clickhouse.data.ClickHouseDataType.of(ClickHouseDataType.java:497)
	at com.clickhouse.data.ClickHouseColumn.readColumn(ClickHouseColumn.java:714)
	at com.clickhouse.data.ClickHouseColumn.readColumn(ClickHouseColumn.java:544)
	at com.clickhouse.data.ClickHouseColumn.of(ClickHouseColumn.java:763)
	at com.clickhouse.jdbc.ConnectionImpl.createStruct(ConnectionImpl.java:667)

Results of the jdbc-v2 calls (same program, same connection):

createArrayOf("Int32")                    -> OK
createArrayOf("NoSuchType")               -> java.lang.IllegalArgumentException: Unknown data type: NoSuchType
createArrayOf("Array(NoSuchType)")        -> java.lang.IllegalArgumentException: Unknown data type: NoSuchType
createArrayOf("Nullable(Strng)")          -> java.lang.IllegalArgumentException: Unknown data type: Strng
createArrayOf("Array(Int32")              -> java.lang.IllegalArgumentException: Missing ')' for '(' at position 5
createArrayOf("Decimal(abc, 2)")          -> java.lang.NumberFormatException: For input string: "abc"
createArrayOf("")                         -> java.lang.IllegalArgumentException: Non-empty typeName is required
createStruct("Tuple(Int8, String)")       -> OK
createStruct("Int32")                     -> java.sql.SQLException (HY000): Only Tuple datatype is supported for Struct
createStruct("NoSuchType")                -> java.lang.IllegalArgumentException: Unknown data type: NoSuchType
createStruct("Tuple(NoSuchType, UInt8)")  -> java.lang.IllegalArgumentException: Unknown data type: NoSuchType
createStruct("Tuple(Int8, String")        -> java.lang.IllegalArgumentException: Missing ')' for '(' at position 5
createStruct("Tuple(Decimal(abc, 2), UInt8)") -> java.lang.NumberFormatException: For input string: "abc"
createStruct("")                          -> java.lang.IllegalArgumentException: Non-empty typeName is required
createArrayOf(null) / createStruct(null)  -> java.sql.SQLFeatureNotSupportedException: typeName cannot be null
closed connection, both methods           -> java.sql.SQLException (08000): Connection is closed

The server rejects the same type names (SELECT toTypeName(defaultValueOfTypeName('<type>'))):

NoSuchType                Code: 50. DB::Exception: Unknown data type family: NoSuchType ... (UNKNOWN_TYPE)
Nullable(Strng)           Code: 50. DB::Exception: Unknown data type family: Strng. Maybe you meant: ['String'] ... (UNKNOWN_TYPE)
Tuple(NoSuchType, UInt8)  Code: 50. DB::Exception: Unknown data type family: NoSuchType ... (UNKNOWN_TYPE)
Array(Int32               Code: 62. DB::Exception: Syntax error (data type): ... Unmatched parentheses: '(' at position 6 is never closed ...
Decimal(abc, 2)           Code: 43. DB::Exception: Decimal argument precision is invalid ... (ILLEGAL_TYPE_OF_ARGUMENT)
Expected Behaviour

Both methods throw java.sql.SQLException for a type name that they cannot parse, with the parser exception as the cause. Use SQLState HY000, as the other client-side errors in these methods do.

java.sql.Connection Javadoc:

  • createArrayOf: "SQLException - if a database error occurs, the JDBC type is not appropriate for the typeName and the conversion is not supported, the typeName is null or this method is called on a closed connection"
  • createStruct: "SQLException - if a database error occurs, typeName is null or this method is called on a closed connection"
Code Example
Properties props = new Properties();
props.setProperty("user", "default");
props.setProperty("password", "<password>");
try (Connection conn = DriverManager.getConnection("jdbc:clickhouse://<host>:8123/default", props)) {
    try {
        conn.createArrayOf("NoSuchType", new Object[] {1});
        // same for: conn.createStruct("Tuple(NoSuchType, UInt8)", new Object[] {1, 2});
    } catch (SQLException e) {
        System.out.println("caught: " + e); // not reached
    }
}
// Exception in thread "main" java.lang.IllegalArgumentException: Unknown data type: NoSuchType
Configuration
Client Configuration
// default jdbc-v2 configuration, no extra properties
Environment
  • Cloud
  • Client version: jdbc-v2 0.12.0-rc1-SNAPSHOT (main, f73e372bc)
  • Language version: OpenJDK 17.0.21
  • OS: Linux (Docker)
ClickHouse Server
  • ClickHouse Server version: 26.9.1.1629
  • ClickHouse Server non-default settings, if any: none
  • CREATE TABLE statements for tables involved: none
  • Sample data for all these tables: none

Found by automated analysis (Polyglot AI) while investigating #3344. Verified with a program against a live ClickHouse 26.9.1.1629 server, not only by reading the code.

Lenguaje dominante
Java
Estrellas
1.6k
Forks
649
Merge medio
1 d 20 h
PR fusionados (30 d)
39

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de ClickHouse/clickhouse-java

Todos los issues de ClickHouse/clickhouse-java

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.