ajantha-bhat commented on code in PR #10288: URL: https://github.com/apache/iceberg/pull/10288#discussion_r1593501067
########## spark/v3.5/spark/src/main/java/org/apache/iceberg/spark/actions/AnalyzeTableSparkAction.java: ########## @@ -0,0 +1,150 @@ +/* + * 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.iceberg.spark.actions; + +import java.io.IOException; +import java.util.List; +import java.util.Set; +import java.util.stream.Collectors; +import org.apache.iceberg.StatisticsFile; +import org.apache.iceberg.Table; +import org.apache.iceberg.actions.AnalyzeTable; +import org.apache.iceberg.actions.ImmutableAnalyzeTable; +import org.apache.iceberg.exceptions.ValidationException; +import org.apache.iceberg.puffin.StandardBlobTypes; +import org.apache.iceberg.relocated.com.google.common.collect.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Sets; +import org.apache.iceberg.spark.JobGroupInfo; +import org.apache.iceberg.types.Type; +import org.apache.iceberg.types.Types; +import org.apache.spark.sql.SparkSession; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** Computes the statistic of the given columns and stores it as Puffin files. */ +public class AnalyzeTableSparkAction extends BaseSparkAction<AnalyzeTableSparkAction> + implements AnalyzeTable { + + private static final Logger LOG = LoggerFactory.getLogger(AnalyzeTableSparkAction.class); + private final Table table; + private Set<String> columnsToBeAnalyzed; + private Set<String> statsToBecollected = + Sets.newHashSet(StandardBlobTypes.APACHE_DATASKETCHES_THETA_V1); + + AnalyzeTableSparkAction(SparkSession spark, Table table) { + super(spark); + this.table = table; + } + + @Override + protected AnalyzeTableSparkAction self() { + return this; + } + + @Override + public Result execute() { + String desc = String.format("Analyzing table %s", table.name()); + JobGroupInfo info = newJobGroupInfo("ANALYZE-TABLE", desc); + return withJobGroupInfo(info, this::doExecute); + } + + private Result doExecute() { + LOG.info("Starting the analysis of {}", table.name()); + validateColumns(); + List<AnalysisResult> analysisResults = + statsToBecollected.stream() + .map( + statsName -> { + switch (statsName) { + case StandardBlobTypes.APACHE_DATASKETCHES_THETA_V1: + return generateNDVAndCommit(); + default: + return ImmutableAnalyzeTable.AnalysisResult.builder() + .statsName(statsName) + .statsCollected(false) + .addAllErrors(Lists.newArrayList("Stats type not supported")) + .build(); + } + }) + .collect(Collectors.toList()); + return ImmutableAnalyzeTable.Result.builder().analysisResults(analysisResults).build(); + } + + private void validateColumns() { + validateEmptyColumns(); + validateTypes(); + } + + private void validateEmptyColumns() { + if (columnsToBeAnalyzed == null || columnsToBeAnalyzed.isEmpty()) { + throw new ValidationException("No columns to analyze for the table", table.name()); + } + } + + private void validateTypes() { + columnsToBeAnalyzed.forEach( + columnName -> { + Types.NestedField field = table.schema().findField(columnName); + if (field == null) { + throw new ValidationException("No column with %s name in the table", columnName); + } + Type type = field.type(); + if (type.isListType() || type.isMapType() || type.isNestedType() || type.isStructType()) { + throw new ValidationException( + "Analysis not supported on column %s of type %s", columnName, type.typeId()); + } + }); + } + + private AnalysisResult generateNDVAndCommit() { + try { + StatisticsFile statisticsFile = + NDVSketchGenerator.generateNDV( + spark(), table, columnsToBeAnalyzed.toArray(new String[0])); + table + .updateStatistics() + .setStatistics(table.currentSnapshot().snapshotId(), statisticsFile) Review Comment: what of table's current snapshot has modified concurrently by another client between like 117 to line 120? ########## spark/v3.5/spark/src/test/java/org/apache/iceberg/spark/actions/TestAnalyzeTableAction.java: ########## @@ -0,0 +1,134 @@ +/* + * 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.iceberg.spark.actions; + +import static org.junit.jupiter.api.Assertions.assertNotEquals; +import static org.junit.jupiter.api.Assertions.assertNotNull; +import static org.junit.jupiter.api.Assertions.assertThrows; +import static org.junit.jupiter.api.Assertions.assertTrue; +import static org.junit.jupiter.api.Assumptions.assumeTrue; + +import java.util.List; +import org.apache.iceberg.Table; +import org.apache.iceberg.actions.AnalyzeTable; +import org.apache.iceberg.exceptions.ValidationException; +import org.apache.iceberg.relocated.com.google.common.collect.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Sets; +import org.apache.iceberg.spark.CatalogTestBase; +import org.apache.iceberg.spark.Spark3Util; +import org.apache.iceberg.spark.source.SimpleRecord; +import org.apache.spark.sql.Encoders; +import org.apache.spark.sql.catalyst.analysis.NoSuchTableException; +import org.apache.spark.sql.catalyst.parser.ParseException; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.Assertions; +import org.junit.jupiter.api.TestTemplate; + +public class TestAnalyzeTableAction extends CatalogTestBase { + + @TestTemplate + public void testAnalyzeTableAction() throws NoSuchTableException, ParseException { + assumeTrue(catalogName.equals("spark_catalog")); + sql( + "CREATE TABLE %s (id int, data string) USING iceberg TBLPROPERTIES" + + "('format-version'='2')", Review Comment: default format version itself v2 now. So, specifying it again is redundant. ########## spark/v3.5/spark/src/main/java/org/apache/iceberg/spark/actions/NDVSketchGenerator.java: ########## @@ -0,0 +1,169 @@ +/* + * 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.iceberg.spark.actions; + +import java.io.IOException; +import java.nio.ByteBuffer; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.UUID; +import org.apache.datasketches.theta.CompactSketch; +import org.apache.datasketches.theta.SetOperationBuilder; +import org.apache.datasketches.theta.UpdateSketch; +import org.apache.iceberg.GenericBlobMetadata; +import org.apache.iceberg.GenericStatisticsFile; +import org.apache.iceberg.HasTableOperations; +import org.apache.iceberg.StatisticsFile; +import org.apache.iceberg.Table; +import org.apache.iceberg.TableOperations; +import org.apache.iceberg.io.FileIO; +import org.apache.iceberg.io.OutputFile; +import org.apache.iceberg.puffin.Blob; +import org.apache.iceberg.puffin.Puffin; +import org.apache.iceberg.puffin.PuffinWriter; +import org.apache.iceberg.puffin.StandardBlobTypes; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableList; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.relocated.com.google.common.collect.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.spark.api.java.JavaPairRDD; +import org.apache.spark.api.java.function.Function2; +import org.apache.spark.api.java.function.PairFlatMapFunction; +import org.apache.spark.sql.Dataset; +import org.apache.spark.sql.Row; +import org.apache.spark.sql.SparkSession; +import scala.Tuple2; + +public class NDVSketchGenerator { + + private NDVSketchGenerator() {} + + public static StatisticsFile generateNDV( + SparkSession spark, Table table, String... columnsToBeAnalyzed) throws IOException { + Iterator<Tuple2<String, ThetaSketchJavaSerializable>> tuple2Iterator = + NDVSketchGenerator.computeNDVSketches(spark, table.name(), columnsToBeAnalyzed); + Map<String, ThetaSketchJavaSerializable> sketchMap = Maps.newHashMap(); + + tuple2Iterator.forEachRemaining(tuple -> sketchMap.put(tuple._1, tuple._2)); + return writeToPuffin(table, Lists.newArrayList(columnsToBeAnalyzed), sketchMap); + } + + private static StatisticsFile writeToPuffin( + Table table, List<String> columns, Map<String, ThetaSketchJavaSerializable> sketchMap) + throws IOException { + int columnSizes = columns.size(); + TableOperations operations = ((HasTableOperations) table).operations(); + FileIO fileIO = ((HasTableOperations) table).operations().io(); + String path = operations.metadataFileLocation(String.format("%s.stats", UUID.randomUUID())); + OutputFile outputFile = fileIO.newOutputFile(path); + try (PuffinWriter writer = + Puffin.write(outputFile).createdBy("Spark DistinctCountProcedure").build()) { Review Comment: I like this name instead of "analyze table procedure". ########## spark/v3.5/spark/src/main/java/org/apache/iceberg/spark/actions/NDVSketchGenerator.java: ########## @@ -0,0 +1,169 @@ +/* + * 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.iceberg.spark.actions; + +import java.io.IOException; +import java.nio.ByteBuffer; +import java.util.Iterator; +import java.util.List; +import java.util.Map; +import java.util.UUID; +import org.apache.datasketches.theta.CompactSketch; +import org.apache.datasketches.theta.SetOperationBuilder; +import org.apache.datasketches.theta.UpdateSketch; +import org.apache.iceberg.GenericBlobMetadata; +import org.apache.iceberg.GenericStatisticsFile; +import org.apache.iceberg.HasTableOperations; +import org.apache.iceberg.StatisticsFile; +import org.apache.iceberg.Table; +import org.apache.iceberg.TableOperations; +import org.apache.iceberg.io.FileIO; +import org.apache.iceberg.io.OutputFile; +import org.apache.iceberg.puffin.Blob; +import org.apache.iceberg.puffin.Puffin; +import org.apache.iceberg.puffin.PuffinWriter; +import org.apache.iceberg.puffin.StandardBlobTypes; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableList; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableMap; +import org.apache.iceberg.relocated.com.google.common.collect.Lists; +import org.apache.iceberg.relocated.com.google.common.collect.Maps; +import org.apache.spark.api.java.JavaPairRDD; +import org.apache.spark.api.java.function.Function2; +import org.apache.spark.api.java.function.PairFlatMapFunction; +import org.apache.spark.sql.Dataset; +import org.apache.spark.sql.Row; +import org.apache.spark.sql.SparkSession; +import scala.Tuple2; + +public class NDVSketchGenerator { + + private NDVSketchGenerator() {} + + public static StatisticsFile generateNDV( + SparkSession spark, Table table, String... columnsToBeAnalyzed) throws IOException { + Iterator<Tuple2<String, ThetaSketchJavaSerializable>> tuple2Iterator = + NDVSketchGenerator.computeNDVSketches(spark, table.name(), columnsToBeAnalyzed); + Map<String, ThetaSketchJavaSerializable> sketchMap = Maps.newHashMap(); + + tuple2Iterator.forEachRemaining(tuple -> sketchMap.put(tuple._1, tuple._2)); + return writeToPuffin(table, Lists.newArrayList(columnsToBeAnalyzed), sketchMap); + } + + private static StatisticsFile writeToPuffin( + Table table, List<String> columns, Map<String, ThetaSketchJavaSerializable> sketchMap) + throws IOException { + int columnSizes = columns.size(); + TableOperations operations = ((HasTableOperations) table).operations(); + FileIO fileIO = ((HasTableOperations) table).operations().io(); + String path = operations.metadataFileLocation(String.format("%s.stats", UUID.randomUUID())); + OutputFile outputFile = fileIO.newOutputFile(path); + try (PuffinWriter writer = + Puffin.write(outputFile).createdBy("Spark DistinctCountProcedure").build()) { + for (int i = 0; i < columnSizes; i++) { + writer.add( + new Blob( + StandardBlobTypes.APACHE_DATASKETCHES_THETA_V1, + ImmutableList.of(table.schema().findField(columns.get(i)).fieldId()), + table.currentSnapshot().snapshotId(), + table.currentSnapshot().sequenceNumber(), + ByteBuffer.wrap(sketchMap.get(columns.get(i)).getSketch().toByteArray()), + null, + ImmutableMap.of())); + } + writer.finish(); + + return new GenericStatisticsFile( + table.currentSnapshot().snapshotId(), + path, + writer.fileSize(), + writer.footerSize(), + writer.writtenBlobsMetadata().stream() + .map(GenericBlobMetadata::from) + .collect(ImmutableList.toImmutableList())); + + } catch (IOException e) { + throw e; + } + } + + public static Iterator<Tuple2<String, ThetaSketchJavaSerializable>> computeNDVSketches( + SparkSession spark, String tableName, String... columns) { + String sql = String.format("select %s from %s", String.join(",", columns), tableName); Review Comment: I think we should also think about incremental update and update sketches from previous checkpoint. Querying whole table maybe not efficient. -- 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: issues-unsubscr...@iceberg.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@iceberg.apache.org For additional commands, e-mail: issues-h...@iceberg.apache.org
