MartijnVisser commented on code in PR #171: URL: https://github.com/apache/flink-connector-jdbc/pull/171#discussion_r4417119081
########## flink-connector-jdbc-clickhouse/pom.xml: ########## @@ -0,0 +1,133 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- +Licensed to the Apache Software Foundation (ASF) under one +or more contributor license agreements. See the NOTICE file +distributed with this work for additional information +regarding copyright ownership. The ASF licenses this file +to you under the Apache License, Version 2.0 (the +"License"); you may not use this file except in compliance +with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, +software distributed under the License is distributed on an +"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +KIND, either express or implied. See the License for the +specific language governing permissions and limitations +under the License. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd";> + <modelVersion>4.0.0</modelVersion> + + <parent> + <groupId>org.apache.flink</groupId> + <artifactId>flink-connector-jdbc-parent</artifactId> + <version>5.0-SNAPSHOT</version> + </parent> + + <artifactId>flink-connector-jdbc-clickhouse</artifactId> + <name>Flink : Connectors : JDBC : ClickHouse</name> + + <packaging>jar</packaging> + + <properties> + <clickhouse.jdbc.version>0.9.7</clickhouse.jdbc.version> + <httpcore5.version>5.3.4</httpcore5.version> + <httpcore5-h2.version>5.3.4</httpcore5-h2.version> + <commons-io.version>2.20.0</commons-io.version> + </properties> + + <dependencies> + + <dependency> + <groupId>org.apache.flink</groupId> + <artifactId>flink-connector-jdbc-core</artifactId> + <version>${project.version}</version> + </dependency> + + <dependency> + <groupId>commons-io</groupId> + <artifactId>commons-io</artifactId> Review Comment: These three are compile scope, so users get httpcore5 5.3.4 next to the 5.4.3 from OpenLineage's httpclient5 5.6.4. Only the test-scoped driver needs them, can they move to test scope? ########## flink-connector-jdbc-clickhouse/src/main/java/org/apache/flink/connector/jdbc/clickhouse/database/dialect/ClickHouseDialect.java: ########## @@ -0,0 +1,139 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.connector.jdbc.clickhouse.database.dialect; + +import org.apache.flink.annotation.Internal; +import org.apache.flink.connector.jdbc.core.database.dialect.AbstractDialect; +import org.apache.flink.connector.jdbc.core.database.dialect.JdbcDialectConverter; +import org.apache.flink.table.types.logical.LogicalTypeRoot; +import org.apache.flink.table.types.logical.RowType; + +import java.util.Arrays; +import java.util.EnumSet; +import java.util.Optional; +import java.util.Set; +import java.util.stream.Collectors; + +import static java.lang.String.format; + +/** JDBC dialect for ClickHouse. */ +@Internal +public class ClickHouseDialect extends AbstractDialect { + + private static final long serialVersionUID = 1L; + + // Define MAX/MIN precision of TIMESTAMP type according to ClickHouse docs: + // https://clickhouse.com/docs/sql-reference/data-types/datetime64 + private static final int MAX_TIMESTAMP_PRECISION = 9; + private static final int MIN_TIMESTAMP_PRECISION = 0; + + // Define MAX/MIN precision of DECIMAL type according to ClickHouse docs: + // https://clickhouse.com/docs/sql-reference/data-types/decimal + private static final int MAX_DECIMAL_PRECISION = 76; + private static final int MIN_DECIMAL_PRECISION = 1; + + @Override + public JdbcDialectConverter getRowConverter(RowType rowType) { + return new ClickHouseDialectConverter(rowType); + } + + @Override + public String getLimitClause(long limit) { + return "LIMIT " + limit; + } + + @Override + public Optional<String> defaultDriverName() { + return Optional.of("com.clickhouse.jdbc.Driver"); + } + + @Override + public String dialectName() { + return "ClickHouse"; + } + + @Override + public String quoteIdentifier(String identifier) { + return "`" + identifier + "`"; + } + + // ClickHouse does not support Upsert statements + // Instead you can create a table with ReplacingMergeTree engine; + // https://clickhouse.com/docs/engines/table-engines/mergetree-family/replacingmergetree + @Override + public Optional<String> getUpsertStatement( + String tableName, String[] fieldNames, String[] uniqueKeyFields) { + return Optional.empty(); + } + + // ClickHouse pkField cannot be updated via sql + @Override + public String getUpdateStatement( + String tableName, String[] fieldNames, String[] conditionFields) { + String setClause = + Arrays.stream(fieldNames) + .filter(item -> !Arrays.asList(conditionFields).contains(item)) Review Comment: Every non-PK column ends up in the SET, so a table with `ORDER BY (event_date, id)` or `PARTITION BY toYYYYMM(event_date)` fails its first update with `Cannot UPDATE key column`. ########## flink-connector-jdbc-clickhouse/src/main/java/org/apache/flink/connector/jdbc/clickhouse/database/dialect/ClickHouseDialectConverter.java: ########## @@ -0,0 +1,261 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.connector.jdbc.clickhouse.database.dialect; + +import org.apache.flink.annotation.Internal; +import org.apache.flink.connector.jdbc.core.database.dialect.AbstractDialectConverter; +import org.apache.flink.table.data.ArrayData; +import org.apache.flink.table.data.DecimalData; +import org.apache.flink.table.data.GenericArrayData; +import org.apache.flink.table.data.GenericMapData; +import org.apache.flink.table.data.MapData; +import org.apache.flink.table.data.TimestampData; +import org.apache.flink.table.types.logical.ArrayType; +import org.apache.flink.table.types.logical.LogicalType; +import org.apache.flink.table.types.logical.LogicalTypeRoot; +import org.apache.flink.table.types.logical.MapType; +import org.apache.flink.table.types.logical.RowType; +import org.apache.flink.table.types.logical.TimestampType; +import org.apache.flink.table.types.logical.utils.LogicalTypeUtils; + +import java.lang.reflect.Array; +import java.sql.Date; +import java.sql.Time; +import java.sql.Timestamp; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.time.LocalTime; +import java.time.ZoneOffset; +import java.time.format.DateTimeFormatter; +import java.util.HashMap; +import java.util.Map; + +/** + * Runtime converter that responsible to convert between JDBC object and Flink internal object for + * ClickHouse. + */ +@Internal +public class ClickHouseDialectConverter extends AbstractDialectConverter { + + private static final long serialVersionUID = 1L; + + public ClickHouseDialectConverter(RowType rowType) { + super(rowType); + } + + @Override + public JdbcDeserializationConverter createInternalConverter(LogicalType type) { + LogicalTypeRoot root = type.getTypeRoot(); + + if (root == LogicalTypeRoot.ARRAY) { + ArrayType arrayType = (ArrayType) type; + return createClickHouseArrayConverter(arrayType); + } else if (root == LogicalTypeRoot.MAP) { + MapType mapType = (MapType) type; + return createClickHouseMapConverter(mapType); + } else { + return createPrimitiveConverter(type); + } + } + + @Override + public JdbcSerializationConverter createExternalConverter(LogicalType type) { + LogicalTypeRoot root = type.getTypeRoot(); + + if (root == LogicalTypeRoot.ARRAY) { + return (val, index, statement) -> + statement.setObject(index, toExternalSerializer(val.getArray(index), type)); + } else if (root == LogicalTypeRoot.MAP) { + return (val, index, statement) -> + statement.setObject(index, toExternalSerializer(val.getMap(index), type)); + } else if (root == LogicalTypeRoot.TIMESTAMP_WITH_TIME_ZONE + || root == LogicalTypeRoot.TIMESTAMP_WITHOUT_TIME_ZONE) { + final int precision = ((TimestampType) type).getPrecision(); + final String pattern = timestampPattern(precision); + + return (val, index, statement) -> { + DateTimeFormatter formatter = + DateTimeFormatter.ofPattern(pattern).withZone(ZoneOffset.UTC); + statement.setString( + index, formatter.format(val.getTimestamp(index, precision).toInstant())); + }; + } else { + return super.createExternalConverter(type); + } + } + + // adding support to MAP and ARRAY types + private static Object toExternalSerializer(Object value, LogicalType type) { + if (value == null) { Review Comment: Removing this null check, or going back to `setTimestamp` on L95, leaves every test green under UTC. Can you add tests with null elements and a non-UTC default zone? ########## flink-connector-jdbc-clickhouse/src/test/java/org/apache/flink/connector/jdbc/clickhouse/testutils/ClickHouseTableRow.java: ########## @@ -0,0 +1,146 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.connector.jdbc.clickhouse.testutils; + +import org.apache.flink.connector.jdbc.testutils.functions.JdbcResultSetBuilder; +import org.apache.flink.connector.jdbc.testutils.tables.TableField; +import org.apache.flink.connector.jdbc.testutils.tables.TableRow; +import org.apache.flink.table.api.DataTypes; +import org.apache.flink.types.Row; + +import java.sql.Array; +import java.sql.ResultSet; +import java.sql.SQLException; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.time.LocalTime; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; + +/** ClickHouseTableRow. */ +public class ClickHouseTableRow extends TableRow { Review Comment: With a non-UTC JVM all 15 source ITCases fail: the driver shifts `setTimestamp` by the JVM zone. Can you override `insertIntoTableValues` here and bind the timestamps as strings? ########## flink-connector-jdbc-clickhouse/src/main/java/org/apache/flink/connector/jdbc/clickhouse/database/dialect/ClickHouseDialectConverter.java: ########## @@ -0,0 +1,261 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.flink.connector.jdbc.clickhouse.database.dialect; + +import org.apache.flink.annotation.Internal; +import org.apache.flink.connector.jdbc.core.database.dialect.AbstractDialectConverter; +import org.apache.flink.table.data.ArrayData; +import org.apache.flink.table.data.DecimalData; +import org.apache.flink.table.data.GenericArrayData; +import org.apache.flink.table.data.GenericMapData; +import org.apache.flink.table.data.MapData; +import org.apache.flink.table.data.TimestampData; +import org.apache.flink.table.types.logical.ArrayType; +import org.apache.flink.table.types.logical.LogicalType; +import org.apache.flink.table.types.logical.LogicalTypeRoot; +import org.apache.flink.table.types.logical.MapType; +import org.apache.flink.table.types.logical.RowType; +import org.apache.flink.table.types.logical.TimestampType; +import org.apache.flink.table.types.logical.utils.LogicalTypeUtils; + +import java.lang.reflect.Array; +import java.sql.Date; +import java.sql.Time; +import java.sql.Timestamp; +import java.time.LocalDate; +import java.time.LocalDateTime; +import java.time.LocalTime; +import java.time.ZoneOffset; +import java.time.format.DateTimeFormatter; +import java.util.HashMap; +import java.util.Map; + +/** + * Runtime converter that responsible to convert between JDBC object and Flink internal object for + * ClickHouse. + */ +@Internal +public class ClickHouseDialectConverter extends AbstractDialectConverter { + + private static final long serialVersionUID = 1L; + + public ClickHouseDialectConverter(RowType rowType) { + super(rowType); + } + + @Override + public JdbcDeserializationConverter createInternalConverter(LogicalType type) { + LogicalTypeRoot root = type.getTypeRoot(); + + if (root == LogicalTypeRoot.ARRAY) { + ArrayType arrayType = (ArrayType) type; + return createClickHouseArrayConverter(arrayType); + } else if (root == LogicalTypeRoot.MAP) { + MapType mapType = (MapType) type; + return createClickHouseMapConverter(mapType); + } else { + return createPrimitiveConverter(type); + } + } + + @Override + public JdbcSerializationConverter createExternalConverter(LogicalType type) { + LogicalTypeRoot root = type.getTypeRoot(); + + if (root == LogicalTypeRoot.ARRAY) { + return (val, index, statement) -> + statement.setObject(index, toExternalSerializer(val.getArray(index), type)); + } else if (root == LogicalTypeRoot.MAP) { + return (val, index, statement) -> + statement.setObject(index, toExternalSerializer(val.getMap(index), type)); + } else if (root == LogicalTypeRoot.TIMESTAMP_WITH_TIME_ZONE + || root == LogicalTypeRoot.TIMESTAMP_WITHOUT_TIME_ZONE) { + final int precision = ((TimestampType) type).getPrecision(); + final String pattern = timestampPattern(precision); + + return (val, index, statement) -> { + DateTimeFormatter formatter = + DateTimeFormatter.ofPattern(pattern).withZone(ZoneOffset.UTC); + statement.setString( + index, formatter.format(val.getTimestamp(index, precision).toInstant())); + }; + } else { + return super.createExternalConverter(type); + } + } + + // adding support to MAP and ARRAY types + private static Object toExternalSerializer(Object value, LogicalType type) { + if (value == null) { + return null; + } + switch (type.getTypeRoot()) { + case BOOLEAN: + return value; + case TINYINT: + return value instanceof Number ? ((Number) value).byteValue() : value; + case SMALLINT: + return value instanceof Number ? ((Number) value).shortValue() : value; + case INTEGER: + case INTERVAL_YEAR_MONTH: + return value instanceof Number ? ((Number) value).intValue() : value; + case BIGINT: + case INTERVAL_DAY_TIME: + return value instanceof Number ? ((Number) value).longValue() : value; + case FLOAT: + return value instanceof Number ? ((Number) value).floatValue() : value; + case DOUBLE: + return value instanceof Number ? ((Number) value).doubleValue() : value; + case CHAR: + case VARCHAR: + return value.toString(); + case DATE: + return Date.valueOf(LocalDate.ofEpochDay((int) value)); + case TIME_WITHOUT_TIME_ZONE: + return Time.valueOf(LocalTime.ofNanoOfDay((int) value * 1_000_000L)); + case TIMESTAMP_WITH_TIME_ZONE: + case TIMESTAMP_WITHOUT_TIME_ZONE: + return ((TimestampData) value).toTimestamp(); + case DECIMAL: + return ((DecimalData) value).toBigDecimal(); + case ARRAY: + ArrayType arrayType = (ArrayType) type; + final LogicalType elementType = arrayType.getElementType(); + ArrayData.ElementGetter elementGetter = ArrayData.createElementGetter(elementType); + ArrayData arrayData = ((ArrayData) value); + Object[] objectArray = new Object[arrayData.size()]; + for (int i = 0; i < arrayData.size(); i++) { + objectArray[i] = + toExternalSerializer( + elementGetter.getElementOrNull(arrayData, i), elementType); + } + return objectArray; + case MAP: + LogicalType keyType = ((MapType) type).getKeyType(); + LogicalType valueType = ((MapType) type).getValueType(); + ArrayData.ElementGetter keyGetter = ArrayData.createElementGetter(keyType); + ArrayData.ElementGetter valueGetter = ArrayData.createElementGetter(valueType); + MapData mapData = (MapData) value; + ArrayData keyArrayData = mapData.keyArray(); + ArrayData valueArrayData = mapData.valueArray(); + Map<Object, Object> objectMap = new HashMap<>(keyArrayData.size()); + for (int i = 0; i < keyArrayData.size(); i++) { + objectMap.put( + toExternalSerializer( + keyGetter.getElementOrNull(keyArrayData, i), keyType), + toExternalSerializer( + valueGetter.getElementOrNull(valueArrayData, i), valueType)); + } + return objectMap; + default: + throw new UnsupportedOperationException("Unsupported type:" + type); + } + } + + // creating separate array converter + private JdbcDeserializationConverter createClickHouseArrayConverter(ArrayType arrayType) { + final LogicalType elementType = arrayType.getElementType(); + final Class<?> elementClass = LogicalTypeUtils.toInternalConversionClass(elementType); + final JdbcDeserializationConverter elementConverter = + createNullableInternalConverter(elementType); + return val -> { + java.sql.Array chArray = (java.sql.Array) val; + Object[] in = (Object[]) chArray.getArray(); + final Object[] converted = (Object[]) Array.newInstance(elementClass, in.length); + for (int i = 0; i < in.length; i++) { + converted[i] = elementConverter.deserialize(in[i]); + } + return new GenericArrayData(converted); + }; + } + + // creating separate map converter + private JdbcDeserializationConverter createClickHouseMapConverter(MapType mapType) { + final LogicalType keyType = mapType.getKeyType(); + final LogicalType valueType = mapType.getValueType(); + final JdbcDeserializationConverter keyConverter = createNullableInternalConverter(keyType); + final JdbcDeserializationConverter valueConverter = + createNullableInternalConverter(valueType); + return val -> { + Map<?, ?> rawMap = (Map<?, ?>) val; + Map<Object, Object> result = new HashMap<>(rawMap.size()); + for (Map.Entry<?, ?> entry : rawMap.entrySet()) { + Object k = entry.getKey(); + Object v = entry.getValue(); + result.put(keyConverter.deserialize(k), valueConverter.deserialize(v)); + } + return new GenericMapData(result); + }; + } + + // some types should be properly handled for clickhouse + private JdbcDeserializationConverter createPrimitiveConverter(LogicalType type) { + switch (type.getTypeRoot()) { + case TINYINT: + return val -> val instanceof Number ? ((Number) val).byteValue() : val; + case SMALLINT: + return val -> val instanceof Number ? ((Number) val).shortValue() : val; + case INTEGER: + case INTERVAL_YEAR_MONTH: + return val -> val instanceof Number ? ((Number) val).intValue() : val; + case BIGINT: + case INTERVAL_DAY_TIME: + return val -> val instanceof Number ? ((Number) val).longValue() : val; Review Comment: A UInt64 above `Long.MAX_VALUE` read as `BIGINT` comes back as -1 here, and UInt8 200 as `TINYINT` as -56. I think a range check that fails is better than narrowing silently. ########## docs/content/docs/connectors/table/jdbc.md: ########## @@ -928,6 +950,7 @@ Flink supports the connection to several databases using dialect like MySQL, Ora <td><code>TIME [(p)]</code></td> <td><code>DATE</code></td> <td></td> + <td><code>Time</code> / <code>Time64(p)</code></td> Review Comment: On 25.8 creating a `Time` column fails unless `enable_time_time64_type = 1` is set, which might be worth a note here. ########## docs/content/docs/connectors/table/jdbc.md: ########## @@ -960,6 +984,7 @@ Flink supports the connection to several databases using dialect like MySQL, Ora <td><code>TIMESTAMP [(p)]</code></td> <td><code>TIMESTAMP [(p)] [WITH TIMEZONE]</code></td> <td><code>TIMESTAMP</code></td> + <td><code>DateTime('TZ')</code> / <code>DateTime64(p, 'TZ')</code></td> Review Comment: The planner doesn't support `TIMESTAMP WITH TIME ZONE`, and `ClickHouseDialectConverter` throws a ClassCastException on `ZonedTimestampType`. I would drop this row and the type from `supportedTypes()`. ########## docs/content/docs/connectors/table/jdbc.md: ########## @@ -452,6 +453,10 @@ As there is no standard syntax for upsert, the following table describes the dat <td>Spanner</td> <td>INSERT OR UPDATE INTO .. (..) VALUES (..)</td> </tr> + <tr> + <td>ClickHouse</td> + <td>INSERT INTO .. (..) VALUES (..) <i>Table engine should be from ReplacingMergeTree() family</i></td> Review Comment: The sink runs a SELECT per key, then an INSERT or `ALTER TABLE ... UPDATE`, not just this INSERT. `docs/content.zh` needs the ClickHouse rows too. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
