yupeng9 commented on a change in pull request #6845: URL: https://github.com/apache/incubator-pinot/pull/6845#discussion_r630734344
########## 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: Added a TODO Yes, that's my next PR to add to the offline segment creation :) ########## File path: pinot-segment-local/src/main/java/org/apache/pinot/segment/local/recordtransformer/ComplexTypeTransformer.java ########## @@ -0,0 +1,252 @@ +/** + * 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.List; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.data.readers.GenericRow; + + +/** + * A transformer to handle the complex types such as Map and Collection, with flattening and unnesting. + * <p> + * The map flattening rule will recursively flatten all the map types, except for those under the collection that is not marked as to unnest. + * + * For example: + * <pre> + * { + * "t1":{ + * "array":[ + * { + * "t2":{ + * "a":"v1" + * } + * } + * ] + * } + * } + * </pre> + * + * flattens to + * <pre> + * { + * "t1.array":[ + * { + * "t2.a":"v1" + * } + * ] + * } + * <pre/> + * + * <p> + * + * The unnesting rule will flatten all the collections provided, which are the paths navigating to the collections. For + * the same example above. If the the collectionToUnnest is provided as "t1.array", then the rule will unnest the + * previous output to: + * + * <pre> + * [{ + * "t1.arrayt2.a": "v1", + * }] + * * <pre/> + * + * Note the unnest rule will output a collection of generic rows under the field {@link GenericRow#MULTIPLE_RECORDS_KEY}. + * + */ +public class ComplexTypeTransformer implements RecordTransformer { + private static final CharSequence DELIMITER = "."; + private final List<String> _unnestFields; + + public ComplexTypeTransformer(TableConfig tableConfig) { + if (tableConfig.getIngestionConfig() != null && tableConfig.getIngestionConfig().getComplexTypeConfig() != null) { + _unnestFields = tableConfig.getIngestionConfig().getComplexTypeConfig().getUnnestConfig() != null ? tableConfig + .getIngestionConfig().getComplexTypeConfig().getUnnestConfig() : new ArrayList<>(); Review comment: Good catch ########## File path: pinot-spi/src/main/java/org/apache/pinot/spi/data/readers/GenericRow.java ########## @@ -120,6 +126,49 @@ public boolean hasNullValues() { return !_nullValueFields.isEmpty(); } + /** + * @return a deep copy of the generic row + */ + public GenericRow copy() { Review comment: hmm, that's an interesting point. The value can be modified when there are map or collection by the complex-type handler. That's why I only copied them but not the primitive values. ########## File path: pinot-segment-local/src/main/java/org/apache/pinot/segment/local/recordtransformer/ComplexTypeTransformer.java ########## @@ -0,0 +1,229 @@ +/** + * 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.ComplexTypeConfig; +import org.apache.pinot.spi.data.readers.GenericRow; + + +/** + * A transformer to handle the complex types such as Map and Collection, with flattening and unnesting. + * <p> + * The map flattening rule will recursively flatten all the map types, except for those under the collection that is not marked as to unnest. + * + * For example: + * <pre> + * { + * "t1":{ + * "array":[ + * { + * "t2":{ + * "a":"v1" + * } + * } + * ] + * } + * } + * </pre> + * + * flattens to + * <pre> + * { + * "t1.array":[ + * { + * "t2.a":"v1" + * } + * ] + * } + * <pre/> + * + * <p> + * + * The unnesting rule will flatten all the collections provided, which are the paths navigating to the collections. For + * the same example above. If the the collectionToUnnest is provided as "t1.array", then the rule will unnest the + * previous output to: + * + * <pre> + * [{ + * "t1.arrayt2.a": "v1", + * }] + * * <pre/> + * + * Note the unnest rule will output a collection of generic rows under the field {@link GenericRow#MULTIPLE_RECORDS_KEY}. + * + */ +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().getComplexTypeConfig() != null) { + _collectionsToUnnest = + tableConfig.getIngestionConfig().getComplexTypeConfig().getUnnestConfig() != null ? tableConfig + .getIngestionConfig().getComplexTypeConfig().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().getComplexTypeConfig() == null + || tableConfig.getIngestionConfig().getComplexTypeConfig().getMode() == null) { + return false; + } + return tableConfig.getIngestionConfig().getComplexTypeConfig().getMode() + != ComplexTypeConfig.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); + } 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) { Review comment: I added the handling ########## File path: pinot-segment-local/src/main/java/org/apache/pinot/segment/local/recordtransformer/ComplexTypeTransformer.java ########## @@ -0,0 +1,252 @@ +/** + * 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.List; +import java.util.Map; +import javax.annotation.Nullable; +import org.apache.pinot.spi.config.table.TableConfig; +import org.apache.pinot.spi.data.readers.GenericRow; + + +/** + * A transformer to handle the complex types such as Map and Collection, with flattening and unnesting. + * <p> + * The map flattening rule will recursively flatten all the map types, except for those under the collection that is not marked as to unnest. + * + * For example: + * <pre> + * { + * "t1":{ + * "array":[ + * { + * "t2":{ + * "a":"v1" + * } + * } + * ] + * } + * } + * </pre> + * + * flattens to + * <pre> + * { + * "t1.array":[ + * { + * "t2.a":"v1" + * } + * ] + * } + * <pre/> + * + * <p> + * + * The unnesting rule will flatten all the collections provided, which are the paths navigating to the collections. For + * the same example above. If the the collectionToUnnest is provided as "t1.array", then the rule will unnest the + * previous output to: + * + * <pre> + * [{ + * "t1.arrayt2.a": "v1", + * }] + * * <pre/> + * + * Note the unnest rule will output a collection of generic rows under the field {@link GenericRow#MULTIPLE_RECORDS_KEY}. + * + */ +public class ComplexTypeTransformer implements RecordTransformer { + private static final CharSequence DELIMITER = "."; + private final List<String> _unnestFields; + + public ComplexTypeTransformer(TableConfig tableConfig) { + if (tableConfig.getIngestionConfig() != null && tableConfig.getIngestionConfig().getComplexTypeConfig() != null) { + _unnestFields = tableConfig.getIngestionConfig().getComplexTypeConfig().getUnnestConfig() != null ? tableConfig + .getIngestionConfig().getComplexTypeConfig().getUnnestConfig() : new ArrayList<>(); + } else { + _unnestFields = new ArrayList<>(); + } + } + + @VisibleForTesting + public ComplexTypeTransformer(List<String> unnestCollections) { + _unnestFields = new ArrayList<>(unnestCollections); + Collections.sort(_unnestFields); + } + + public static boolean isComplexTypeHandlingEnabled(TableConfig tableConfig) { + return tableConfig.getIngestionConfig() != null && tableConfig.getIngestionConfig().getComplexTypeConfig() != null; + } + + @Nullable + @Override + public GenericRow transform(GenericRow record) { + flattenMap(record, new ArrayList<>(record.getFieldToValueMap().keySet())); + for (String collection : _unnestFields) { + 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); + } 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 (isArray(value)) { + 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 : map.entrySet()) { + String flattenName = concat(column, entry.getKey()); + copy.putValue(flattenName, entry.getValue()); + } + } else { Review comment: No, it's not needed, since the caller will take care of it by iterating the `unnestFields` after sort. -- 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