Skip to content

Expose several methods as public #2612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 13, 2025
Merged

Expose several methods as public #2612

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f35519f
Expose several methods as public
mzitnik Oct 11, 2025
9c871f7
Added comment internal API do not use.
mzitnik Oct 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 16 additions & 7 deletions client-v2/src/main/java/com/clickhouse/client/api/data_formats/internal/SerializerUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,6 +411,9 @@ public static void writeDynamicTypeTag(OutputStream stream, ClickHouseColumn typ
}
}

/**
DO NOT USE - part of internal API that will be changed
*/
public static void serializeArrayData(OutputStream stream, Object value, ClickHouseColumn column) throws IOException {
if (value == null) {
writeVarInt(stream, 0);
Expand All @@ -437,7 +440,10 @@ public static void serializeArrayData(OutputStream stream, Object value, ClickHo
}
}

private static void serializeTupleData(OutputStream stream, Object value, ClickHouseColumn column) throws IOException {
/**
DO NOT USE - part of internal API that will be changed
*/
public static void serializeTupleData(OutputStream stream, Object value, ClickHouseColumn column) throws IOException {
Copy link
Contributor

@chernser chernser Oct 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This Class will be redesigned and API will be changed.
Even it is in internal package please put a short javadoc for each exposed method

/** 
   DO NOT USE - part of internal API that will be changed
*/

//Serialize the tuple to the stream
//The tuple is a list of values
if (value instanceof List) {
Expand All @@ -455,7 +461,10 @@ private static void serializeTupleData(OutputStream stream, Object value, ClickH
}
}

private static void serializeMapData(OutputStream stream, Object value, ClickHouseColumn column) throws IOException {
/**
DO NOT USE - part of internal API that will be changed
*/
public static void serializeMapData(OutputStream stream, Object value, ClickHouseColumn column) throws IOException {
//Serialize the map to the stream
//The map is a list of key-value pairs
Map<?, ?> map = (Map<?, ?>) value;
Expand Down Expand Up @@ -596,7 +605,7 @@ private static void serializePrimitiveData(OutputStream stream, Object value, Cl
}
}

private static void serializeInterval(OutputStream stream, ClickHouseColumn column, Object value) throws IOException {
public static void serializeInterval(OutputStream stream, ClickHouseColumn column, Object value) throws IOException {
long v;

if (value instanceof Duration) {
Expand Down Expand Up @@ -666,7 +675,7 @@ private static void serializeTime64(OutputStream stream, Object value) throws IO
}
}

private static void serializeEnumData(OutputStream stream, ClickHouseColumn column, Object value) throws IOException {
public static void serializeEnumData(OutputStream stream, ClickHouseColumn column, Object value) throws IOException {
int enumValue = -1;
if (value instanceof String) {
enumValue = column.getEnumConstants().value((String) value);
Expand All @@ -687,15 +696,15 @@ private static void serializeEnumData(OutputStream stream, ClickHouseColumn colu
}
}

private static void serializeJSON(OutputStream stream, Object value) throws IOException {
public static void serializeJSON(OutputStream stream, Object value) throws IOException {
if (value instanceof String) {
BinaryStreamUtils.writeString(stream, (String)value);
} else {
throw new UnsupportedOperationException("Serialization of Java object to JSON is not supported yet.");
}
}

private static void serializerVariant(OutputStream out, ClickHouseColumn column, Object value) throws IOException {
public static void serializerVariant(OutputStream out, ClickHouseColumn column, Object value) throws IOException {
int typeOrdNum = column.getVariantOrdNum(value);
if (typeOrdNum != -1) {
BinaryStreamUtils.writeUnsignedInt8(out, typeOrdNum);
Expand All @@ -710,7 +719,7 @@ private static void serializerVariant(OutputStream out, ClickHouseColumn column,
private static final ClickHouseColumn GEO_POLYGON_ARRAY = ClickHouseColumn.parse("geopolygin Array(Array(Tuple(Float64, Float64)))").get(0);
private static final ClickHouseColumn GEO_MULTI_POLYGON_ARRAY = ClickHouseColumn.parse("geomultipolygin Array(Array(Array(Tuple(Float64, Float64))))").get(0);

private static void serializeAggregateFunction(OutputStream stream, Object value, ClickHouseColumn column) throws IOException {
public static void serializeAggregateFunction(OutputStream stream, Object value, ClickHouseColumn column) throws IOException {
if (column.getAggregateFunction() == ClickHouseAggregateFunction.groupBitmap) {
if (value == null) {
throw new IllegalArgumentException("Cannot serialize null value for aggregate function: " + column.getAggregateFunction());
Expand Down
Loading