client-v2: serializePrimitiveData rejects or silently corrupts String values for UInt64, UUID, Date and DateTime
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 82/100
Research direction
Start in client-v2/src/main/java/com/clickhouse/client/api/data_formats/internal/SerializerUtils.java at serializePrimitiveData and trace the UInt64, UUID, date, and date-time helper paths. Verify the existing conversion behavior and the related BinaryStreamUtils unsigned-long range check. Done means String values are handled consistently for these types, invalid UInt64 values fail instead of silently wrapping, and existing signed or numeric paths remain unchanged.
Written by the indexing model from the issue text.
Description
Summary
SerializerUtils.serializePrimitiveData accepts String input for most scalar column types via the convertToInteger / convertToLong / convertToBigInteger / convertToBigDecimal / convertToString helpers, but a subset of types either reject a String outright or — for UInt64 — silently corrupt it. This makes String coercion inconsistent across the type switch.
Line references are against 0.9.5, file client-v2/src/main/java/com/clickhouse/client/api/data_formats/internal/SerializerUtils.java.
Behaviour today
| Column type | String input | Result |
|---|---|---|
Int8/16/32, UInt8/16, Int64, UInt32 |
convertToInteger / convertToLong |
works |
Int128/256, UInt128/256 |
convertToBigInteger |
works |
Decimal* |
convertToBigDecimal |
works |
String, FixedString |
convertToString |
works |
UInt64 (:522) |
convertToLong → Long.parseLong (:760) |
throws above 2^63-1; silently wraps a negative |
UUID (:575) |
(UUID) value |
ClassCastException |
Date, Date32 (:553, :556) |
writeDate / writeDate32 (:1105) |
IllegalArgumentException: Cannot convert … to Long |
DateTime, DateTime64 (:559, :563) |
writeDateTime / writeDateTime64 (:1141) |
same |
The UInt64 case is a silent-corruption bug
convertToLong("-1") // -> -1L (Long.parseLong, signed)
writeUnsignedInt64(-1L) // -> writeInt64 -> FF FF FF FF FF FF FF FF
ClickHouse reads that back as 18446744073709551615. So a negative String is written as the maximum UInt64 with no error.
This is already inconsistent within the library: BinaryStreamUtils.writeUnsignedInt64(OutputStream, BigInteger) range-checks via ClickHouseChecker.between(value, TYPE_BIG_INTEGER, BigInteger.ZERO, U_INT64_MAX), so a BigInteger of -1 is correctly rejected. Only the String path wraps.
Values in [2^63, 2^64-1] are legal UInt64 values and are encodable on the wire (writeUnsignedInt64(long) just emits the raw 8 bytes), but unreachable through the String path.
Proposed fix
UInt64— use an unsigned-aware conversion at:522rather than changing the sharedconvertToLong, whichInt64(:504) andUInt32(:519) also use and which needs signed parsing:
/** UInt64 runs past Long.MAX_VALUE; the returned long carries the raw bit pattern. */
public static Long convertToUnsignedLong(Object value) {
if (value instanceof String) {
return Long.parseUnsignedLong((String) value);
}
return convertToLong(value);
}
UUID— add aStringbranch usingUUID.fromString.Date/Date32/DateTime/DateTime64— add aStringbranch in thewriteDate/writeDate32/writeDateTime/writeDateTime64helpers, which already dispatch onLocalDate/ZonedDateTime/OffsetDateTime/Timestamp. Fixing them there also covers their other callers.
Backward compatibility
Items 2 and 3 are purely additive: those inputs throw today, so nothing that currently succeeds changes behaviour.
Item 1 has one deliberate behaviour change: "-1" into a UInt64 column currently writes 18446744073709551615 and would now throw NumberFormatException. That replaces silent corruption with a loud error and aligns the String path with the existing BigInteger overload. Suggest keeping it as its own commit so it can be reviewed separately from the additive branches.
The Long / Number path stays permissive and passes raw bits through unchanged — callers legitimately supply the bit pattern for values above 2^63.
Why it matters
Reported from the ClickHouse Flink connector. Its checkpoint state format serialises map keys as strings, so for a Map(K, V) column the key reaches serializeMapData (:478) → serializePrimitiveData as a String. The connector currently has to reject Map(UInt64, …), Map(UUID, …), Map(Date, …), Map(Date32, …) and Map(DateTime(64), …) at planning time and tell users to change their table DDL, even though all of these are legal ClickHouse map key types.
More generally, any caller passing a String value for one of these types — nested or top-level — hits the same behaviour.
- Dominant language
- Java
- Stars
- 1.6k
- Forks
- 637
- Avg merge
- 2d 16h
- Merged PRs (30d)
- 30
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ClickHouse/clickhouse-java
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
ClickHouse/clickhouse-java#3111 ·
-
area:data-type bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ClickHouse/clickhouse-java#3098 · 1 comment ·
-
bug client-api-v2 test
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
ClickHouse/clickhouse-java#3076 ·
-
area:sql-parser bug client-v1
Difficulty 1/5 1-3 hours Newbie friendliness 92/100
ClickHouse/clickhouse-java#3066 ·
-
area:general bug client-api-v2 jdbc jdbc-v2
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ClickHouse/clickhouse-java#3063 ·
All issues in ClickHouse/clickhouse-java
Similar issues
-
awaiting triage bug Causes friction Hop Gui P1 P2 Transforms
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
apache/flink-agents#1152 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
jenkinsci/blueocean-plugin#5417 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
objectionary/eo-graphs#75 ·