yupeng9 commented on a change in pull request #6845: URL: https://github.com/apache/incubator-pinot/pull/6845#discussion_r623294078
########## File path: pinot-segment-local/src/main/java/org/apache/pinot/segment/local/recordtransformer/ComplexTypeTransformer.java ########## @@ -0,0 +1,184 @@ +/** + * 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.pinot.segment.local.recordtransformer; + +import com.google.common.annotations.VisibleForTesting; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.config.table.ingestion.ComplexTypeHandlingConfig; +import org.apache.pinot.spi.data.readers.GenericRow; + + +public class ComplexTypeTransformer implements RecordTransformer { Review comment: sure. will add ########## File path: pinot-segment-local/src/main/java/org/apache/pinot/segment/local/recordtransformer/ComplexTypeTransformer.java ########## @@ -0,0 +1,184 @@ +/** + * 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.pinot.segment.local.recordtransformer; + +import com.google.common.annotations.VisibleForTesting; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.config.table.ingestion.ComplexTypeHandlingConfig; +import org.apache.pinot.spi.data.readers.GenericRow; + + +public class ComplexTypeTransformer implements RecordTransformer { + private static final CharSequence DELIMITER = "."; + private final List<String> _collectionsToUnnest; + + public ComplexTypeTransformer(TableConfig tableConfig) { + if (tableConfig.getIngestionConfig() != null + && tableConfig.getIngestionConfig().getComplexTypeHandlingConfig() != null) { + _collectionsToUnnest = + tableConfig.getIngestionConfig().getComplexTypeHandlingConfig().getUnnestConfig() != null ? tableConfig + .getIngestionConfig().getComplexTypeHandlingConfig().getUnnestConfig() : new ArrayList<>(); + } else { + _collectionsToUnnest = new ArrayList<>(); + } + } + + @VisibleForTesting + public ComplexTypeTransformer(List<String> unnestCollections) { + _collectionsToUnnest = new ArrayList<>(unnestCollections); + Collections.sort(_collectionsToUnnest); + } + + public static boolean isComplexTypeHandlingEnabled(TableConfig tableConfig) { + if (tableConfig.getIngestionConfig() == null + || tableConfig.getIngestionConfig().getComplexTypeHandlingConfig() == null + || tableConfig.getIngestionConfig().getComplexTypeHandlingConfig().getMode() == null) { + return false; + } + return tableConfig.getIngestionConfig().getComplexTypeHandlingConfig().getMode() + != ComplexTypeHandlingConfig.Mode.NONE; + } + + @Nullable + @Override + public GenericRow transform(GenericRow record) { + flattenMap(record, new HashSet<>(record.getFieldToValueMap().keySet())); + for (String collection : _collectionsToUnnest) { + unnestCollection(record, collection); + } + return record; + } + + private GenericRow unnestCollection(GenericRow record, String column) { + if (record.getValue(GenericRow.MULTIPLE_RECORDS_KEY) == null) { + List<GenericRow> list = new ArrayList<>(); + unnestCollection(record, column, list); + record.putValue(GenericRow.MULTIPLE_RECORDS_KEY, list); + } else { + Collection<GenericRow> records = (Collection) record.getValue(GenericRow.MULTIPLE_RECORDS_KEY); + List<GenericRow> list = new ArrayList<>(); + for (GenericRow innerRecord : records) { + unnestCollection(innerRecord, column, list); + } + record.putValue(GenericRow.MULTIPLE_RECORDS_KEY, list); + } + return record; + } + + private void unnestCollection(GenericRow record, String column, List<GenericRow> list) { + Object value = record.removeValue(column); + if (value == null) { + // use the record itself + list.add(record); + return; + } else if (value instanceof Collection) { + if (((Collection) value).isEmpty()) { + // use the record itself + list.add(record); + } else { + for (Object obj : (Collection) value) { + GenericRow copy = flattenCollectionItem(record, obj, column); + list.add(copy); + } + } + } else if (value.getClass().isArray()) { + if (((Object[]) value).length == 0) { + // use the record itself + list.add(record); + } else { + for (Object obj : (Object[]) value) { + GenericRow copy = flattenCollectionItem(record, obj, column); + list.add(copy); + } + } + } + } + + private GenericRow flattenCollectionItem(GenericRow record, Object obj, String column) { + GenericRow copy = record.copy(); + if (obj instanceof Map) { + Map<String, Object> map = (Map<String, Object>) obj; + for (Map.Entry<String, Object> entry : new HashSet<>(map.entrySet())) { + String flattenName = concat(column, entry.getKey()); + copy.putValue(flattenName, entry.getValue()); + } + } else { + copy.putValue(column, obj); + } + return copy; + } + + @VisibleForTesting + protected GenericRow flattenMap(GenericRow record, Collection<String> columns) { Review comment: used for testing to make the test more granular. ########## File path: pinot-spi/src/main/java/org/apache/pinot/spi/config/table/ingestion/ComplexTypeHandlingConfig.java ########## @@ -0,0 +1,59 @@ +/** + * 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.pinot.spi.config.table.ingestion; + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyDescription; +import java.util.List; +import javax.annotation.Nullable; +import org.apache.pinot.spi.config.BaseJsonConfig; + + +/** + * Config related to handling complex type + */ +public class ComplexTypeHandlingConfig extends BaseJsonConfig { + public enum Mode { + NONE, FLATTEN_MAP + } + + @JsonPropertyDescription("The complex-type handling mode") + private final Mode _mode; + + @JsonPropertyDescription("The collections to unnest") + private final List<String> _unnestConfig; + + @JsonCreator + public ComplexTypeHandlingConfig(@JsonProperty(value = "mode") @Nullable Mode mode, Review comment: Good point. This shall be required field ########## File path: pinot-segment-local/src/main/java/org/apache/pinot/segment/local/recordtransformer/ComplexTypeTransformer.java ########## @@ -0,0 +1,184 @@ +/** + * 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.pinot.segment.local.recordtransformer; + +import com.google.common.annotations.VisibleForTesting; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.config.table.ingestion.ComplexTypeHandlingConfig; +import org.apache.pinot.spi.data.readers.GenericRow; + + +public class ComplexTypeTransformer implements RecordTransformer { + private static final CharSequence DELIMITER = "."; + private final List<String> _collectionsToUnnest; + + public ComplexTypeTransformer(TableConfig tableConfig) { + if (tableConfig.getIngestionConfig() != null + && tableConfig.getIngestionConfig().getComplexTypeHandlingConfig() != null) { + _collectionsToUnnest = + tableConfig.getIngestionConfig().getComplexTypeHandlingConfig().getUnnestConfig() != null ? tableConfig + .getIngestionConfig().getComplexTypeHandlingConfig().getUnnestConfig() : new ArrayList<>(); + } else { + _collectionsToUnnest = new ArrayList<>(); + } + } + + @VisibleForTesting + public ComplexTypeTransformer(List<String> unnestCollections) { + _collectionsToUnnest = new ArrayList<>(unnestCollections); + Collections.sort(_collectionsToUnnest); + } + + public static boolean isComplexTypeHandlingEnabled(TableConfig tableConfig) { + if (tableConfig.getIngestionConfig() == null + || tableConfig.getIngestionConfig().getComplexTypeHandlingConfig() == null + || tableConfig.getIngestionConfig().getComplexTypeHandlingConfig().getMode() == null) { + return false; + } + return tableConfig.getIngestionConfig().getComplexTypeHandlingConfig().getMode() + != ComplexTypeHandlingConfig.Mode.NONE; + } + + @Nullable + @Override + public GenericRow transform(GenericRow record) { + flattenMap(record, new HashSet<>(record.getFieldToValueMap().keySet())); Review comment: otherwise it'll run into concurrent modification exceptions, as the recursion may update the record ########## File path: pinot-core/src/main/java/org/apache/pinot/core/data/manager/realtime/LLRealtimeSegmentDataManager.java ########## @@ -483,6 +485,9 @@ private void processStreamEvents(MessageBatch messagesAndOffsets, long idlePipeS messagesAndOffsets.getMessageLengthAtIndex(index), reuse); if (decodedRow != null) { try { + if (_complexTypeTransformer != null) { + decodedRow = _complexTypeTransformer.transform(decodedRow); Review comment: Because this transformer can add the column of `MULTIPLE_RECORDS_KEY `, which is used in the condition in the next line. I feel this complex-type transformer is special (at least in current implementation) due to this, and all other transformers output 1 row only. ########## File path: pinot-core/src/test/java/org/apache/pinot/core/util/SchemaUtilsTest.java ########## @@ -140,7 +140,7 @@ public void testCompatibilityWithTableConfig() { .addDateTime(TIME_COLUMN, DataType.LONG, "1:MILLISECONDS:EPOCH", "1:HOURS").build(); tableConfig = new TableConfigBuilder(TableType.REALTIME).setTableName(TABLE_NAME).setTimeColumnName(TIME_COLUMN) .setIngestionConfig( - new IngestionConfig(null, null, null, Lists.newArrayList(new TransformConfig("colA", "round(colB, 1000)")))) + new IngestionConfig(null, null, null, Lists.newArrayList(new TransformConfig("colA", "round(colB, 1000)")), null)) Review comment: Agreed. But I think it's better to address this in another PR for refactoring, to keep this PR's scope clear. ########## File path: pinot-spi/src/main/java/org/apache/pinot/spi/config/table/ingestion/IngestionConfig.java ########## @@ -43,15 +43,20 @@ @JsonPropertyDescription("Configs related to record transformation functions applied during ingestion") private final List<TransformConfig> _transformConfigs; + @JsonPropertyDescription("Config related to handling complex type") + private final ComplexTypeHandlingConfig _complexTypeHandlingConfig; Review comment: +1 to `complexTypeConfig ` ########## File path: pinot-tools/src/main/resources/examples/stream/meetupRsvp/complexTypeHandling_meetupRsvp_schema.json ########## @@ -0,0 +1,40 @@ +{ + "schemaName": "meetupRsvp", Review comment: Yes, we can do it for this meetupRsvp. Also, the unit test has a case of unnesting two sibiling collections. ########## File path: pinot-segment-local/src/main/java/org/apache/pinot/segment/local/recordtransformer/ComplexTypeTransformer.java ########## @@ -0,0 +1,184 @@ +/** + * 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.pinot.segment.local.recordtransformer; + +import com.google.common.annotations.VisibleForTesting; +import java.util.ArrayList; +import java.util.Collection; +import java.util.Collections; +import java.util.HashSet; +import java.util.List; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.config.table.ingestion.ComplexTypeHandlingConfig; +import org.apache.pinot.spi.data.readers.GenericRow; + + +public class ComplexTypeTransformer implements RecordTransformer { + private static final CharSequence DELIMITER = "."; + private final List<String> _collectionsToUnnest; + + public ComplexTypeTransformer(TableConfig tableConfig) { + if (tableConfig.getIngestionConfig() != null + && tableConfig.getIngestionConfig().getComplexTypeHandlingConfig() != null) { + _collectionsToUnnest = + tableConfig.getIngestionConfig().getComplexTypeHandlingConfig().getUnnestConfig() != null ? tableConfig + .getIngestionConfig().getComplexTypeHandlingConfig().getUnnestConfig() : new ArrayList<>(); + } else { + _collectionsToUnnest = new ArrayList<>(); + } + } + + @VisibleForTesting + public ComplexTypeTransformer(List<String> unnestCollections) { + _collectionsToUnnest = new ArrayList<>(unnestCollections); + Collections.sort(_collectionsToUnnest); + } + + public static boolean isComplexTypeHandlingEnabled(TableConfig tableConfig) { + if (tableConfig.getIngestionConfig() == null + || tableConfig.getIngestionConfig().getComplexTypeHandlingConfig() == null + || tableConfig.getIngestionConfig().getComplexTypeHandlingConfig().getMode() == null) { + return false; + } + return tableConfig.getIngestionConfig().getComplexTypeHandlingConfig().getMode() + != ComplexTypeHandlingConfig.Mode.NONE; + } + + @Nullable + @Override + public GenericRow transform(GenericRow record) { + flattenMap(record, new HashSet<>(record.getFieldToValueMap().keySet())); + for (String collection : _collectionsToUnnest) { + unnestCollection(record, collection); + } + return record; + } + + private GenericRow unnestCollection(GenericRow record, String column) { + if (record.getValue(GenericRow.MULTIPLE_RECORDS_KEY) == null) { + List<GenericRow> list = new ArrayList<>(); + unnestCollection(record, column, list); + record.putValue(GenericRow.MULTIPLE_RECORDS_KEY, list); + } else { + Collection<GenericRow> records = (Collection) record.getValue(GenericRow.MULTIPLE_RECORDS_KEY); + List<GenericRow> list = new ArrayList<>(); + for (GenericRow innerRecord : records) { + unnestCollection(innerRecord, column, list); + } + record.putValue(GenericRow.MULTIPLE_RECORDS_KEY, list); + } + return record; + } + + private void unnestCollection(GenericRow record, String column, List<GenericRow> list) { + Object value = record.removeValue(column); + if (value == null) { + // use the record itself + list.add(record); + return; + } else if (value instanceof Collection) { + if (((Collection) value).isEmpty()) { + // use the record itself + list.add(record); + } else { + for (Object obj : (Collection) value) { + GenericRow copy = flattenCollectionItem(record, obj, column); + list.add(copy); + } + } + } else if (value.getClass().isArray()) { + if (((Object[]) value).length == 0) { + // use the record itself + list.add(record); + } else { + for (Object obj : (Object[]) value) { + GenericRow copy = flattenCollectionItem(record, obj, column); + list.add(copy); + } + } + } + } + + private GenericRow flattenCollectionItem(GenericRow record, Object obj, String column) { + GenericRow copy = record.copy(); + if (obj instanceof Map) { + Map<String, Object> map = (Map<String, Object>) obj; + for (Map.Entry<String, Object> entry : new HashSet<>(map.entrySet())) { + String flattenName = concat(column, entry.getKey()); + copy.putValue(flattenName, entry.getValue()); + } + } else { + copy.putValue(column, obj); + } + return copy; + } + + @VisibleForTesting + protected GenericRow flattenMap(GenericRow record, Collection<String> columns) { + for (String column : columns) { + if (record.getValue(column) instanceof Map) { + Map<String, Object> map = (Map) record.removeValue(column); + List<String> mapColumns = new ArrayList<>(); + for (Map.Entry<String, Object> entry : new HashSet<>(map.entrySet())) { + String flattenName = concat(column, entry.getKey()); + record.putValue(flattenName, entry.getValue()); + mapColumns.add(flattenName); + } + record = flattenMap(record, mapColumns); + } else if (record.getValue(column) instanceof Collection && _collectionsToUnnest.contains(column)) { + for (Object inner : (Collection) record.getValue(column)) { + if (inner instanceof Map) { + Map<String, Object> innerMap = (Map<String, Object>) inner; + flattenMap(column, innerMap, new HashSet<>(innerMap.keySet())); + } + } + } + } + return record; + } + + private void flattenMap(String path, Map<String, Object> map, Collection<String> fields) { + for (String field : fields) { + if (map.get(field) instanceof Map) { + Map<String, Object> innerMap = (Map<String, Object>) map.remove(field); + List<String> innerMapFields = new ArrayList<>(); + for (Map.Entry<String, Object> innerEntry : new HashSet<>(innerMap.entrySet())) { + map.put(concat(field, innerEntry.getKey()), innerEntry.getValue()); + innerMapFields.add(concat(field, innerEntry.getKey())); + } + if (!innerMapFields.isEmpty()) { + flattenMap(concat(path, field), map, innerMapFields); + } + } else if (map.get(field) instanceof Collection && _collectionsToUnnest.contains(concat(path, field))) { + for (Object inner : (Collection) map.get(field)) { + if (inner instanceof Map) { + Map<String, Object> innerMap = (Map<String, Object>) inner; + flattenMap(concat(path, field), innerMap, new HashSet<>(innerMap.keySet())); + } + } + } + } + } + + private String concat(String left, String right) { + return String.join(DELIMITER, left, right); Review comment: done -- 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. For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@pinot.apache.org For additional commands, e-mail: commits-h...@pinot.apache.org
