CTTY commented on code in PR #13226: URL: https://github.com/apache/hudi/pull/13226#discussion_r2067448332
########## hudi-client/hudi-client-common/src/main/java/org/apache/hudi/metadata/index/columnstats/ColumnStatsIndexer.java: ########## @@ -0,0 +1,667 @@ +/* + * 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.hudi.metadata.index.columnstats; + +import org.apache.hudi.avro.ConvertingGenericData; +import org.apache.hudi.avro.HoodieAvroUtils; +import org.apache.hudi.avro.model.BooleanWrapper; +import org.apache.hudi.avro.model.DateWrapper; +import org.apache.hudi.avro.model.DoubleWrapper; +import org.apache.hudi.avro.model.FloatWrapper; +import org.apache.hudi.avro.model.HoodieCleanMetadata; +import org.apache.hudi.avro.model.IntWrapper; +import org.apache.hudi.avro.model.LongWrapper; +import org.apache.hudi.avro.model.StringWrapper; +import org.apache.hudi.avro.model.TimeMicrosWrapper; +import org.apache.hudi.avro.model.TimestampMicrosWrapper; +import org.apache.hudi.common.config.HoodieMetadataConfig; +import org.apache.hudi.common.config.HoodieStorageConfig; +import org.apache.hudi.common.data.HoodieData; +import org.apache.hudi.common.engine.HoodieEngineContext; +import org.apache.hudi.common.fs.FSUtils; +import org.apache.hudi.common.model.HoodieColumnRangeMetadata; +import org.apache.hudi.common.model.HoodieCommitMetadata; +import org.apache.hudi.common.model.HoodieDeltaWriteStat; +import org.apache.hudi.common.model.HoodieFileFormat; +import org.apache.hudi.common.model.HoodieIndexDefinition; +import org.apache.hudi.common.model.HoodieRecord; +import org.apache.hudi.common.model.HoodieWriteStat; +import org.apache.hudi.common.table.HoodieTableConfig; +import org.apache.hudi.common.table.HoodieTableMetaClient; +import org.apache.hudi.common.table.log.HoodieUnMergedLogRecordScanner; +import org.apache.hudi.common.table.view.HoodieTableFileSystemView; +import org.apache.hudi.common.util.Option; +import org.apache.hudi.common.util.ValidationUtils; +import org.apache.hudi.common.util.VisibleForTesting; +import org.apache.hudi.common.util.collection.Pair; +import org.apache.hudi.common.util.collection.Tuple3; +import org.apache.hudi.config.HoodieWriteConfig; +import org.apache.hudi.exception.HoodieException; +import org.apache.hudi.exception.HoodieNotSupportedException; +import org.apache.hudi.io.storage.HoodieIOFactory; +import org.apache.hudi.metadata.HoodieBackedTableMetadata; +import org.apache.hudi.metadata.HoodieMetadataPayload; +import org.apache.hudi.metadata.HoodieTableMetadataUtil; +import org.apache.hudi.metadata.index.Indexer; +import org.apache.hudi.storage.StorageConfiguration; +import org.apache.hudi.storage.StoragePath; +import org.apache.hudi.util.Lazy; + +import org.apache.avro.LogicalType; +import org.apache.avro.LogicalTypes; +import org.apache.avro.Schema; +import org.apache.avro.generic.IndexedRecord; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import java.io.IOException; +import java.time.LocalDate; +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.Collections; +import java.util.HashMap; +import java.util.HashSet; +import java.util.LinkedHashMap; +import java.util.List; +import java.util.Map; +import java.util.Properties; +import java.util.Set; +import java.util.TreeMap; +import java.util.function.Function; +import java.util.stream.Collectors; +import java.util.stream.Stream; + +import static org.apache.hudi.avro.AvroSchemaUtils.resolveNullableSchema; +import static org.apache.hudi.avro.HoodieAvroUtils.addMetadataFields; +import static org.apache.hudi.common.fs.FSUtils.getFileNameFromPath; +import static org.apache.hudi.common.model.HoodieRecord.COMMIT_TIME_METADATA_FIELD; +import static org.apache.hudi.common.model.HoodieRecord.HOODIE_META_COLUMNS_WITH_OPERATION; +import static org.apache.hudi.common.model.HoodieRecord.PARTITION_PATH_METADATA_FIELD; +import static org.apache.hudi.common.model.HoodieRecord.RECORD_KEY_METADATA_FIELD; +import static org.apache.hudi.common.util.StringUtils.isNullOrEmpty; +import static org.apache.hudi.index.HoodieIndexUtils.register; +import static org.apache.hudi.metadata.HoodieTableMetadata.EMPTY_PARTITION_NAME; +import static org.apache.hudi.metadata.HoodieTableMetadata.NON_PARTITIONED_NAME; +import static org.apache.hudi.metadata.HoodieTableMetadataUtil.PARTITION_NAME_COLUMN_STATS; +import static org.apache.hudi.metadata.HoodieTableMetadataUtil.coerceToComparable; +import static org.apache.hudi.metadata.HoodieTableMetadataUtil.fetchPartitionFileInfoTriplets; +import static org.apache.hudi.metadata.HoodieTableMetadataUtil.tryResolveSchemaForTable; +import static org.apache.hudi.metadata.MetadataPartitionType.COLUMN_STATS; + +public class ColumnStatsIndexer implements Indexer { + + private static final Logger LOG = LoggerFactory.getLogger(ColumnStatsIndexer.class); + private static final Set<Class<?>> COLUMN_STATS_RECORD_SUPPORTED_TYPES = new HashSet<>(Arrays.asList( + IntWrapper.class, BooleanWrapper.class, DateWrapper.class, + DoubleWrapper.class, FloatWrapper.class, LongWrapper.class, + StringWrapper.class, TimeMicrosWrapper.class, TimestampMicrosWrapper.class)); + // The maximum allowed precision and scale as per the payload schema. See DecimalWrapper in HoodieMetadata.avsc: + // https://github.com/apache/hudi/blob/45dedd819e56e521148bde51a3dfa4e472ea70cd/hudi-common/src/main/avro/HoodieMetadata.avsc#L247 + private static final int DECIMAL_MAX_PRECISION = 30; + private static final int DECIMAL_MAX_SCALE = 15; + @VisibleForTesting + static final String[] META_COLS_TO_ALWAYS_INDEX = {COMMIT_TIME_METADATA_FIELD, RECORD_KEY_METADATA_FIELD, PARTITION_PATH_METADATA_FIELD}; + @VisibleForTesting + public static final Set<String> META_COL_SET_TO_INDEX = new HashSet<>(Arrays.asList(META_COLS_TO_ALWAYS_INDEX)); + @VisibleForTesting + static final Map<String, Schema> META_COLS_TO_ALWAYS_INDEX_SCHEMA_MAP = new TreeMap() { + { + put(COMMIT_TIME_METADATA_FIELD, Schema.create(Schema.Type.STRING)); + put(RECORD_KEY_METADATA_FIELD, Schema.create(Schema.Type.STRING)); + put(PARTITION_PATH_METADATA_FIELD, Schema.create(Schema.Type.STRING)); + } + }; + + private final HoodieEngineContext engineContext; + private final HoodieWriteConfig dataTableWriteConfig; + private final HoodieTableMetaClient dataTableMetaClient; + private final Lazy<List<String>> columnsToIndex; + + public ColumnStatsIndexer(HoodieEngineContext engineContext, + HoodieWriteConfig dataTableWriteConfig, + HoodieTableMetaClient dataTableMetaClient) { + this.engineContext = engineContext; + this.dataTableWriteConfig = dataTableWriteConfig; + this.dataTableMetaClient = dataTableMetaClient; + this.columnsToIndex = Lazy.lazily(() -> + new ArrayList<>(getColumnsToIndex(dataTableMetaClient.getTableConfig(), + dataTableWriteConfig.getMetadataConfig(), + Lazy.lazily(() -> tryResolveSchemaForTable(dataTableMetaClient)), + true, + Option.of(dataTableWriteConfig.getRecordMerger().getRecordType())).keySet())); + } + + @Override + public List<InitialIndexPartitionData> build( + List<HoodieTableMetadataUtil.DirectoryInfo> partitionInfoList, + Map<String, Map<String, Long>> partitionToFilesMap, + String createInstantTime, + Lazy<HoodieTableFileSystemView> fsView, + HoodieBackedTableMetadata metadata, + String instantTimeForPartition) throws IOException { + + final int numFileGroup = dataTableWriteConfig.getMetadataConfig().getColumnStatsIndexFileGroupCount(); + // TODO(yihua): Revisit to see to return -1 + if (partitionToFilesMap.isEmpty()) { + return Collections.singletonList(InitialIndexPartitionData.of( + numFileGroup, COLUMN_STATS.getPartitionPath(), engineContext.emptyHoodieData())); + } + + if (columnsToIndex.get().isEmpty()) { + // this can only happen if meta fields are disabled and cols to index is not explicitly overridden. + return Collections.singletonList(InitialIndexPartitionData.of( + numFileGroup, COLUMN_STATS.getPartitionPath(), engineContext.emptyHoodieData())); + } + + LOG.info("Indexing {} columns for column stats index", columnsToIndex.get().size()); + + // during initialization, we need stats for base and log files. + HoodieData<HoodieRecord> records = convertFilesToColumnStatsRecords( + engineContext, Collections.emptyMap(), partitionToFilesMap, dataTableMetaClient, + dataTableWriteConfig.getMetadataConfig(), + dataTableWriteConfig.getColumnStatsIndexParallelism(), + dataTableWriteConfig.getMetadataConfig().getMaxReaderBufferSize(), + columnsToIndex.get()); + + return Collections.singletonList(InitialIndexPartitionData.of( + numFileGroup, COLUMN_STATS.getPartitionPath(), records)); + } + + @Override + public List<IndexPartitionData> update(String instantTime, + HoodieBackedTableMetadata tableMetadata, + Lazy<HoodieTableFileSystemView> lazyFileSystemView, HoodieCommitMetadata commitMetadata) { + return convertMetadataToColumnStatsRecords( + commitMetadata, engineContext, + dataTableMetaClient, dataTableWriteConfig.getMetadataConfig(), + Option.of(dataTableWriteConfig.getRecordMerger().getRecordType())); + } + + @Override + public List<IndexPartitionData> clean(String instantTime, HoodieCleanMetadata cleanMetadata) { + Option<HoodieData<HoodieRecord>> recordOption = convertMetadataToColumnStatsRecords(cleanMetadata, engineContext, + dataTableMetaClient, dataTableWriteConfig.getMetadataConfig(), + Option.of(dataTableWriteConfig.getRecordMerger().getRecordType())); + return recordOption.isPresent() + ? Collections.singletonList(IndexPartitionData.of(COLUMN_STATS.getPartitionPath(), recordOption.get())) + : Collections.emptyList(); + } + + @Override + public void updateTableConfig() { + // TODO(yihua): though this engine-independent, only Spark has implemented before this PR. + // Revisit to make sure if that's intentional + HoodieIndexDefinition indexDefinition = HoodieIndexDefinition.newBuilder() + .withIndexName(PARTITION_NAME_COLUMN_STATS) + .withIndexType(PARTITION_NAME_COLUMN_STATS) + .withIndexFunction(PARTITION_NAME_COLUMN_STATS) + .withSourceFields(columnsToIndex.get()) + .withIndexOptions(Collections.EMPTY_MAP) + .build(); + LOG.info("Registering Or Updating the index {}", PARTITION_NAME_COLUMN_STATS); + register(dataTableMetaClient, indexDefinition); + } + + /** + * Convert added and deleted action metadata to column stats index records. + */ + public static HoodieData<HoodieRecord> convertFilesToColumnStatsRecords(HoodieEngineContext engineContext, Review Comment: Can we include methods like this (converting files/records to index recors) in the interface as well? -- 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]
