weiqingy commented on code in PR #28498: URL: https://github.com/apache/flink/pull/28498#discussion_r3555146442
########## flink-formats/flink-avro-confluent-registry/src/main/java/org/apache/flink/formats/avro/registry/confluent/debezium/DebeziumAvroDecodingFormat.java: ########## @@ -0,0 +1,266 @@ +/* + * 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.formats.avro.registry.confluent.debezium; + +import org.apache.flink.api.common.serialization.DeserializationSchema; +import org.apache.flink.api.common.typeinfo.TypeInformation; +import org.apache.flink.formats.avro.registry.confluent.debezium.DebeziumAvroDeserializationSchema.MetadataConverter; +import org.apache.flink.table.api.DataTypes; +import org.apache.flink.table.connector.ChangelogMode; +import org.apache.flink.table.connector.Projection; +import org.apache.flink.table.connector.format.DecodingFormat; +import org.apache.flink.table.connector.format.ProjectableDecodingFormat; +import org.apache.flink.table.connector.source.DynamicTableSource; +import org.apache.flink.table.data.GenericMapData; +import org.apache.flink.table.data.GenericRowData; +import org.apache.flink.table.data.RowData; +import org.apache.flink.table.data.StringData; +import org.apache.flink.table.types.DataType; +import org.apache.flink.table.types.utils.DataTypeUtils; +import org.apache.flink.types.RowKind; + +import java.util.Collections; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import java.util.stream.Stream; + +/** {@link DecodingFormat} for Debezium using Avro encoding. */ +public class DebeziumAvroDecodingFormat + implements ProjectableDecodingFormat<DeserializationSchema<RowData>> { + + // ---------------------------------------------------------------------------------------- + // Mutable attributes + // ---------------------------------------------------------------------------------------- + + private List<String> metadataKeys; + + // ---------------------------------------------------------------------------------------- + // Debezium-specific attributes + // ---------------------------------------------------------------------------------------- + + private final String schemaRegistryURL; + private final String schema; + private final Map<String, ?> optionalPropertiesMap; + + public DebeziumAvroDecodingFormat( + String schemaRegistryURL, String schema, Map<String, ?> optionalPropertiesMap) { + this.schemaRegistryURL = schemaRegistryURL; + this.schema = schema; + this.optionalPropertiesMap = optionalPropertiesMap; + this.metadataKeys = Collections.emptyList(); + } + + @Override + public DeserializationSchema<RowData> createRuntimeDecoder( + DynamicTableSource.Context context, DataType physicalDataType, int[][] projections) { + physicalDataType = Projection.of(projections).project(physicalDataType); + + final List<ReadableMetadata> readableMetadata = + metadataKeys.stream() + .map( + k -> + Stream.of(ReadableMetadata.values()) + .filter(rm -> rm.key.equals(k)) + .findFirst() + .orElseThrow(IllegalStateException::new)) + .collect(Collectors.toList()); + final List<DataTypes.Field> metadataFields = + readableMetadata.stream() + .map(m -> DataTypes.FIELD(m.key, m.dataType)) + .collect(Collectors.toList()); + + final DataType producedDataType = + DataTypeUtils.appendRowFields(physicalDataType, metadataFields); + final TypeInformation<RowData> producedTypeInfo = + context.createTypeInformation(producedDataType); + + return new DebeziumAvroDeserializationSchema( + physicalDataType, + readableMetadata, + producedTypeInfo, + schemaRegistryURL, + schema, + optionalPropertiesMap); + } + + @Override + public Map<String, DataType> listReadableMetadata() { + final Map<String, DataType> metadataMap = new LinkedHashMap<>(); + Stream.of(ReadableMetadata.values()) + .forEachOrdered(m -> metadataMap.put(m.key, m.dataType)); + return metadataMap; + } + + @Override + public void applyReadableMetadata(List<String> metadataKeys) { + this.metadataKeys = metadataKeys; + } + + @Override + public ChangelogMode getChangelogMode() { + return ChangelogMode.newBuilder() + .addContainedKind(RowKind.INSERT) + .addContainedKind(RowKind.UPDATE_BEFORE) + .addContainedKind(RowKind.UPDATE_AFTER) + .addContainedKind(RowKind.DELETE) + .build(); + } + + // ---------------------------------------------------------------------------------------- + // Metadata handling + // ---------------------------------------------------------------------------------------- + + /** List of metadata that can be read with this format. */ + enum ReadableMetadata { + INGESTION_TIMESTAMP( + "ingestion-timestamp", + DataTypes.TIMESTAMP_WITH_LOCAL_TIME_ZONE(3).nullable(), + DataTypes.FIELD("ts_ms", DataTypes.TIMESTAMP_WITH_LOCAL_TIME_ZONE(3)), + new MetadataConverter() { + private static final long serialVersionUID = 1L; + + @Override + public Object convert(GenericRowData row, int unused) { + return row; + } + }), + + SOURCE_TIMESTAMP( + "source.timestamp", + DataTypes.TIMESTAMP_WITH_LOCAL_TIME_ZONE(3).nullable(), + SOURCE_FIELD, + new MetadataConverter() { + private static final long serialVersionUID = 1L; + + @Override + public Object convert(GenericRowData row, int unused) { + int pos = SOURCE_PROPERTY_POSITION.get("ts_ms"); + return row.getField(pos); + } + }), + + SOURCE_DATABASE( + "source.database", + DataTypes.STRING().nullable(), + SOURCE_FIELD, + new MetadataConverter() { + private static final long serialVersionUID = 1L; + + @Override + public Object convert(GenericRowData row, int unused) { + int pos = SOURCE_PROPERTY_POSITION.get("db"); + return row.getField(pos); + } + }), + + SOURCE_SCHEMA( + "source.schema", + DataTypes.STRING().nullable(), + SOURCE_FIELD, + new MetadataConverter() { + private static final long serialVersionUID = 1L; + + @Override + public Object convert(GenericRowData row, int unused) { + int pos = SOURCE_PROPERTY_POSITION.get("schema"); + return row.getField(pos); + } + }), + + SOURCE_TABLE( + "source.table", + DataTypes.STRING().nullable(), + SOURCE_FIELD, + new MetadataConverter() { + private static final long serialVersionUID = 1L; + + @Override + public Object convert(GenericRowData row, int unused) { + int pos = SOURCE_PROPERTY_POSITION.get("table"); + return row.getField(pos); + } + }), + + SOURCE_PROPERTIES( + "source.properties", + // key and value of the map are nullable to make handling easier in queries + DataTypes.MAP(DataTypes.STRING().nullable(), DataTypes.STRING().nullable()) + .nullable(), + SOURCE_FIELD, + new MetadataConverter() { + private static final long serialVersionUID = 1L; + + @Override + public Object convert(GenericRowData row, int unused) { + Map<StringData, StringData> result = new HashMap<>(); + for (int i = 0; i < SOURCE_PROPERTY_FIELDS.length; i++) { + Object value = row.getField(i); + result.put( + StringData.fromString(SOURCE_PROPERTY_FIELDS[i].getName()), + value == null ? null : StringData.fromString(value.toString())); + } + return new GenericMapData(result); + } + }); + + final String key; + final DataType dataType; + final DataTypes.Field requiredAvroField; + final MetadataConverter converter; + + ReadableMetadata( + String key, + DataType dataType, + DataTypes.Field requiredAvroField, + MetadataConverter converter) { + this.key = key; + this.dataType = dataType; + this.requiredAvroField = requiredAvroField; + this.converter = converter; + } + } + + private static final DataTypes.Field[] SOURCE_PROPERTY_FIELDS = { Review Comment: Resolved — thanks. `convertSourceToMap` now iterates the writer's `source` schema (`DebeziumAvroDeserializationSchema.java:123-140`), so connector-specific fields survive into the `MAP` and the fixed-order 13-field projection is gone. That's exactly the shape this thread was after. ########## flink-formats/flink-avro-confluent-registry/src/test/java/org/apache/flink/formats/avro/registry/confluent/debezium/DebeziumAvroSerDeSchemaTest.java: ########## @@ -146,10 +151,42 @@ void testDeleteDataDeserialization() throws Exception { assertThat(actual).isEqualTo(expected); } + @Test + void testDeserializationWithMetadata() throws Exception { + testDeserializationWithMetadata( + "debezium-avro-insert.avro", + row -> { + // Physical columns + assertThat(row.getLong(0)).isEqualTo(1L); + assertThat(row.getString(1).toString()).isEqualTo("lisi"); + assertThat(row.getString(2).toString()).isEqualTo("test debezium avro data"); + assertThat(row.getDouble(3)).isEqualTo(21.799999237060547); + + // Metadata: ingestion-timestamp (field index 4) + assertThat(row.getTimestamp(4, 3)).isNotNull(); Review Comment: The assertion quality is much better here — the `isNotNull()` tautology is replaced with exact-value checks and `source.schema` null is now asserted (`:205,208,214`). One thing carries over, so I've raised it inline on the injection site rather than repeat it here: the test injects a pre-opened `genericDeserializer` and requests all six metadata in enum order, which is the one path that avoids both production-path bugs. ########## flink-formats/flink-avro-confluent-registry/src/main/java/org/apache/flink/formats/avro/registry/confluent/debezium/DebeziumAvroDeserializationSchema.java: ########## @@ -189,22 +252,41 @@ public boolean equals(Object o) { } DebeziumAvroDeserializationSchema that = (DebeziumAvroDeserializationSchema) o; return Objects.equals(avroDeserializer, that.avroDeserializer) - && Objects.equals(producedTypeInfo, that.producedTypeInfo); + && Objects.equals(producedTypeInfo, that.producedTypeInfo) + && hasMetadata == that.hasMetadata; } @Override public int hashCode() { - return Objects.hash(avroDeserializer, producedTypeInfo); + return Objects.hash(avroDeserializer, producedTypeInfo, hasMetadata); } - public static RowType createDebeziumAvroRowType(DataType databaseSchema) { - // Debezium Avro contains other information, e.g. "source", "ts_ms" - // but we don't need them - return (RowType) + public static RowType createDebeziumAvroRowType( Review Comment: Resolved — the stale param-list comment is gone. ########## flink-formats/flink-avro-confluent-registry/src/main/java/org/apache/flink/formats/avro/registry/confluent/debezium/DebeziumAvroDecodingFormat.java: ########## @@ -0,0 +1,266 @@ +/* + * 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.formats.avro.registry.confluent.debezium; + +import org.apache.flink.api.common.serialization.DeserializationSchema; +import org.apache.flink.api.common.typeinfo.TypeInformation; +import org.apache.flink.formats.avro.registry.confluent.debezium.DebeziumAvroDeserializationSchema.MetadataConverter; +import org.apache.flink.table.api.DataTypes; +import org.apache.flink.table.connector.ChangelogMode; +import org.apache.flink.table.connector.Projection; +import org.apache.flink.table.connector.format.DecodingFormat; +import org.apache.flink.table.connector.format.ProjectableDecodingFormat; +import org.apache.flink.table.connector.source.DynamicTableSource; +import org.apache.flink.table.data.GenericMapData; +import org.apache.flink.table.data.GenericRowData; +import org.apache.flink.table.data.RowData; +import org.apache.flink.table.data.StringData; +import org.apache.flink.table.types.DataType; +import org.apache.flink.table.types.utils.DataTypeUtils; +import org.apache.flink.types.RowKind; + +import java.util.Collections; +import java.util.HashMap; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.stream.Collectors; +import java.util.stream.IntStream; +import java.util.stream.Stream; + +/** {@link DecodingFormat} for Debezium using Avro encoding. */ +public class DebeziumAvroDecodingFormat + implements ProjectableDecodingFormat<DeserializationSchema<RowData>> { + + // ---------------------------------------------------------------------------------------- + // Mutable attributes + // ---------------------------------------------------------------------------------------- + + private List<String> metadataKeys; + + // ---------------------------------------------------------------------------------------- + // Debezium-specific attributes + // ---------------------------------------------------------------------------------------- + + private final String schemaRegistryURL; + private final String schema; + private final Map<String, ?> optionalPropertiesMap; + + public DebeziumAvroDecodingFormat( + String schemaRegistryURL, String schema, Map<String, ?> optionalPropertiesMap) { + this.schemaRegistryURL = schemaRegistryURL; + this.schema = schema; + this.optionalPropertiesMap = optionalPropertiesMap; + this.metadataKeys = Collections.emptyList(); + } + + @Override + public DeserializationSchema<RowData> createRuntimeDecoder( + DynamicTableSource.Context context, DataType physicalDataType, int[][] projections) { + physicalDataType = Projection.of(projections).project(physicalDataType); + + final List<ReadableMetadata> readableMetadata = + metadataKeys.stream() + .map( + k -> + Stream.of(ReadableMetadata.values()) + .filter(rm -> rm.key.equals(k)) + .findFirst() + .orElseThrow(IllegalStateException::new)) + .collect(Collectors.toList()); + final List<DataTypes.Field> metadataFields = + readableMetadata.stream() + .map(m -> DataTypes.FIELD(m.key, m.dataType)) + .collect(Collectors.toList()); + + final DataType producedDataType = + DataTypeUtils.appendRowFields(physicalDataType, metadataFields); + final TypeInformation<RowData> producedTypeInfo = + context.createTypeInformation(producedDataType); + + return new DebeziumAvroDeserializationSchema( + physicalDataType, + readableMetadata, + producedTypeInfo, + schemaRegistryURL, + schema, + optionalPropertiesMap); + } + + @Override + public Map<String, DataType> listReadableMetadata() { + final Map<String, DataType> metadataMap = new LinkedHashMap<>(); + Stream.of(ReadableMetadata.values()) + .forEachOrdered(m -> metadataMap.put(m.key, m.dataType)); + return metadataMap; + } + + @Override + public void applyReadableMetadata(List<String> metadataKeys) { + this.metadataKeys = metadataKeys; + } + + @Override + public ChangelogMode getChangelogMode() { + return ChangelogMode.newBuilder() + .addContainedKind(RowKind.INSERT) + .addContainedKind(RowKind.UPDATE_BEFORE) + .addContainedKind(RowKind.UPDATE_AFTER) + .addContainedKind(RowKind.DELETE) + .build(); + } + + // ---------------------------------------------------------------------------------------- + // Metadata handling + // ---------------------------------------------------------------------------------------- + + /** List of metadata that can be read with this format. */ + enum ReadableMetadata { + INGESTION_TIMESTAMP( Review Comment: Resolved — `ts_ms` is now read as a top-level `BIGINT` and the inner converter does real extraction (`DebeziumAvroDecodingFormat.java:152-157`); the unreachable `return row` is gone. -- 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]
