KnightChess commented on code in PR #10191: URL: https://github.com/apache/hudi/pull/10191#discussion_r1442914368
########## hudi-spark-datasource/hudi-spark-common/src/main/scala/org/apache/hudi/BucketIndexSupport.scala: ########## @@ -0,0 +1,193 @@ +/* + * 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 + +import org.apache.avro.generic.GenericData +import org.apache.hadoop.fs.FileStatus +import org.apache.hudi.common.config.HoodieMetadataConfig +import org.apache.hudi.common.fs.FSUtils +import org.apache.hudi.common.table.HoodieTableConfig +import org.apache.hudi.config.HoodieIndexConfig +import org.apache.hudi.index.HoodieIndex +import org.apache.hudi.index.HoodieIndex.IndexType +import org.apache.hudi.index.bucket.BucketIdentifier +import org.apache.hudi.keygen.KeyGenerator +import org.apache.hudi.keygen.factory.HoodieSparkKeyGeneratorFactory +import org.apache.log4j.LogManager +import org.apache.spark.sql.catalyst.expressions +import org.apache.spark.sql.catalyst.expressions.{And, Attribute, EmptyRow, Expression, Literal} +import org.apache.hudi.common.util.collection.Pair +import org.apache.spark.sql.types.{DoubleType, FloatType, StructType} +import org.apache.spark.util.collection.BitSet + +import scala.collection.{JavaConverters, mutable} + +class BucketIndexSupport(metadataConfig: HoodieMetadataConfig, schema: StructType) { + + private val log = LogManager.getLogger(getClass); + + private val keyGenerator = + HoodieSparkKeyGeneratorFactory.createKeyGenerator(metadataConfig.getProps) + + private lazy val avroSchema = AvroConversionUtils.convertStructTypeToAvroSchema(schema, "record", "") + + /** + * the configured bucket field for the table + */ + private val indexBucketHashFieldsOpt: Option[java.util.List[String]] = { + val bucketHashFields = metadataConfig.getStringOrDefault(HoodieIndexConfig.BUCKET_INDEX_HASH_FIELD, + metadataConfig.getString(HoodieTableConfig.RECORDKEY_FIELDS)) + if (bucketHashFields == null || bucketHashFields.isEmpty) { + Option.apply(null) + } else { + Option.apply(JavaConverters.seqAsJavaListConverter(bucketHashFields.split(",")).asJava) + } + } + + def getCandidateFiles(allFiles: Seq[FileStatus], bucketIds: BitSet): Set[String] = { + val candidateFiles: mutable.Set[String] = mutable.Set.empty + for (file <- allFiles) { + val fileId = FSUtils.getFileIdFromFilePath(file.getPath) + val fileBucketId = BucketIdentifier.bucketIdFromFileId(fileId) + if (bucketIds.get(fileBucketId)) { + candidateFiles += file.getPath.getName + } + } + candidateFiles.toSet + } + + def filterQueriesWithBucketHashField(queryFilters: Seq[Expression]): Option[BitSet] = { + val bucketNumber = metadataConfig.getInt(HoodieIndexConfig.BUCKET_INDEX_NUM_BUCKETS) + if (indexBucketHashFieldsOpt.isEmpty || queryFilters.isEmpty) { + None + } else { + var matchedBuckets: BitSet = null + if (indexBucketHashFieldsOpt.get.size == 1) { + matchedBuckets = getBucketsBySingleHashFields(queryFilters.reduce(And), indexBucketHashFieldsOpt.get.get(0), bucketNumber) + } else { + matchedBuckets = getBucketsByMultipleHashFields(queryFilters, + JavaConverters.asScalaBufferConverter(indexBucketHashFieldsOpt.get).asScala.toSet, bucketNumber) + } + + val numBucketsSelected = matchedBuckets.cardinality() + + // None means all the buckets need to be scanned + if (numBucketsSelected == bucketNumber) { + log.info("the query predicates does not specify equality for all the hashing fields, fallback other index") + None + } else { + Some(matchedBuckets) + } + } + } + + // multiple hash fields only support Equality expression by And + private def getBucketsByMultipleHashFields(queryFilters: Seq[Expression], indexBucketHashFields: Set[String], numBuckets: Int): BitSet = { + val hashValuePairs = queryFilters.map(expr => getEqualityFieldPair(expr, indexBucketHashFields)).filter(pair => pair != null) + val matchedBuckets = new BitSet(numBuckets) + if (hashValuePairs.size != indexBucketHashFields.size) { + matchedBuckets.setUntil(numBuckets) + } else { + val record = new GenericData.Record(avroSchema) + hashValuePairs.foreach(p => record.put(p.getKey, p.getValue)) + val hoodieKey = keyGenerator.getKey(record) + matchedBuckets.set(BucketIdentifier.getBucketId(hoodieKey, indexBucketHashFieldsOpt.get, numBuckets)) + } + matchedBuckets + } + + private def getEqualityFieldPair(expr: Expression, equalityFields: Set[String]): Pair[String, Any] = { + expr match { + case expressions.Equality(a: Attribute, Literal(v, _)) if equalityFields.contains(a.name) => + Pair.of(a.name, v) + case _ => + null + } + } + + private def getBucketsBySingleHashFields(expr: Expression, bucketColumnName: String, numBuckets: Int): BitSet = { + + def getBucketNumber(attr: Attribute, v: Any): Int = { + val record = new GenericData.Record(avroSchema) + record.put(attr.name, v) + val hoodieKey = keyGenerator.getKey(record) + BucketIdentifier.getBucketId(hoodieKey, indexBucketHashFieldsOpt.get, numBuckets) + } + + def getBucketSetFromIterable(attr: Attribute, iter: Iterable[Any]): BitSet = { + val matchedBuckets = new BitSet(numBuckets) + iter + .map(v => getBucketNumber(attr, v)) + .foreach(bucketNum => matchedBuckets.set(bucketNum)) + matchedBuckets + } + + def getBucketSetFromValue(attr: Attribute, v: Any): BitSet = { + val matchedBuckets = new BitSet(numBuckets) + matchedBuckets.set(getBucketNumber(attr, v)) + matchedBuckets + } + + expr match { + case expressions.Equality(a: Attribute, Literal(v, _)) if a.name == bucketColumnName => + getBucketSetFromValue(a, v) + case expressions.In(a: Attribute, list) + if list.forall(_.isInstanceOf[Literal]) && a.name == bucketColumnName => + getBucketSetFromIterable(a, list.map(e => e.eval(EmptyRow))) + case expressions.InSet(a: Attribute, hset) if a.name == bucketColumnName => + getBucketSetFromIterable(a, hset) + case expressions.IsNull(a: Attribute) if a.name == bucketColumnName => + getBucketSetFromValue(a, null) + case expressions.IsNaN(a: Attribute) + if a.name == bucketColumnName && a.dataType == FloatType => + getBucketSetFromValue(a, Float.NaN) + case expressions.IsNaN(a: Attribute) + if a.name == bucketColumnName && a.dataType == DoubleType => + getBucketSetFromValue(a, Double.NaN) + case expressions.And(left, right) => + getBucketsBySingleHashFields(left, bucketColumnName, numBuckets) & + getBucketsBySingleHashFields(right, bucketColumnName, numBuckets) + case expressions.Or(left, right) => + getBucketsBySingleHashFields(left, bucketColumnName, numBuckets) | + getBucketsBySingleHashFields(right, bucketColumnName, numBuckets) + case _ => + val matchedBuckets = new BitSet(numBuckets) + matchedBuckets.setUntil(numBuckets) + matchedBuckets + } + } + + /** + * Return true if metadata table is enabled and record index metadata partition is available. + * table is bucket index writer, use default use bucket index try query + * - table may not set bucket field, it will use record key field, now only support simple key Review Comment: in first version, only support one hash field, usually is primary key, so keyGen is Simple key. Now, I had support multiple hash fields, update this describe. -- 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]
