karuppayya commented on code in PR #10288: URL: https://github.com/apache/iceberg/pull/10288#discussion_r1640000931
########## api/src/main/java/org/apache/iceberg/actions/AnalyzeTable.java: ########## @@ -0,0 +1,63 @@ +/* + * 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.actions; + +import java.util.List; +import java.util.Set; + +/** An action that collects statistics of an Iceberg table and writes to Puffin files. */ +public interface AnalyzeTable extends Action<AnalyzeTable, AnalyzeTable.Result> { + /** + * The set of columns to be analyzed + * + * @param columnNames a set of column names to be analyzed + * @return this for method chaining + */ + AnalyzeTable columns(String... columnNames); + + /** + * A set of statistics to be collected + * + * @param types set of statistics to be collected + * @return this for method chaining + */ + AnalyzeTable types(Set<String> types); Review Comment: I think we should use the blob type in Action and stats type in the Procedure(from where we could map stats to its blob type(s)?) For eg: if NDV supports 2 blob types and user wants to generate only one of those, that would still be possible from the actions. ########## api/src/main/java/org/apache/iceberg/actions/AnalyzeTable.java: ########## @@ -0,0 +1,63 @@ +/* + * 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.actions; + +import java.util.List; +import java.util.Set; + +/** An action that collects statistics of an Iceberg table and writes to Puffin files. */ +public interface AnalyzeTable extends Action<AnalyzeTable, AnalyzeTable.Result> { + /** + * The set of columns to be analyzed + * + * @param columnNames a set of column names to be analyzed + * @return this for method chaining + */ + AnalyzeTable columns(String... columnNames); Review Comment: I can see few databases that allow collecting _all_ the stats for given columns. **PostgreSQL** ```ANALYZE table_name (column1, column2);``` **Oracle** ```EXEC DBMS_STATS.GATHER_TABLE_STATS('schema_name', 'table_name', 'method_opt' => 'FOR COLUMNS column1, column2');``` Also looks like most databases dont allow specifying types of stats to be collected. Though we take type as input in the API, we can restrict the usage by not exposing it in the procedure? > correlation blob type for {B,C} together This is the stats on the combined value of B and C. Is my understanding right? Is this a common usecase since i didnt find databases supporting this by default ########## core/src/main/java/org/apache/iceberg/puffin/StandardBlobTypes.java: ########## @@ -26,4 +29,8 @@ private StandardBlobTypes() {} * href="https://datasketches.apache.org/";>Apache DataSketches</a> library */ public static final String APACHE_DATASKETCHES_THETA_V1 = "apache-datasketches-theta-v1"; + + public static Set<String> allStandardBlobTypes() { Review Comment: Removed ########## spark/v3.5/spark/src/main/java/org/apache/iceberg/spark/actions/AnalyzeTableSparkAction.java: ########## @@ -63,97 +78,98 @@ protected AnalyzeTableSparkAction self() { @Override public Result execute() { - if (snapshotId == null) { - snapshotId = table.currentSnapshot().snapshotId(); - } String desc = String.format("Analyzing table %s for snapshot id %s", table.name(), snapshotId); JobGroupInfo info = newJobGroupInfo("ANALYZE-TABLE", desc); return withJobGroupInfo(info, this::doExecute); } private Result doExecute() { - LOG.info("Starting the analysis of {} for snapshot {}", table.name(), snapshotId); - List<AnalysisResult> analysisResults = - types.stream() - .map( - statsName -> { - switch (statsName) { + LOG.info("Starting analysis of {} for snapshot {}", table.name(), snapshotId); + List<AnalysisResult> results = Lists.newArrayList(); + List<Blob> blobs = + blobTypesToAnalyze.stream() + .flatMap( + type -> { + switch (type) { case StandardBlobTypes.APACHE_DATASKETCHES_THETA_V1: - return generateNDVAndCommit(); + try { + return generateNDVBlobs().stream(); + } catch (Exception e) { + LOG.error( + "Error occurred when collecting statistics for blob type {}", type, e); + ImmutableAnalyzeTable.AnalysisResult result = + ImmutableAnalyzeTable.AnalysisResult.builder() + .type(type) + .addErrors(e.getMessage()) + .build(); + results.add(result); + } + break; default: - return ImmutableAnalyzeTable.AnalysisResult.builder() - .type(statsName) - .addAllErrors(Lists.newArrayList("Stats type not supported")) - .build(); + throw new UnsupportedOperationException(); } + return Stream.empty(); }) .collect(Collectors.toList()); - return ImmutableAnalyzeTable.Result.builder().analysisResults(analysisResults).build(); + try { + writeAndCommitPuffin(blobs); + } catch (Exception e) { + throw new RuntimeException(e); + } + return ImmutableAnalyzeTable.Result.builder().analysisResults(results).build(); } - private boolean analyzableTypes(Set<String> columnNames) { - return columnNames.stream() - .anyMatch( - columnName -> { - Types.NestedField field = table.schema().findField(columnName); - if (field == null) { - throw new ValidationException("No column with %s name in the table", columnName); - } - Type.TypeID type = field.type().typeId(); - return type == Type.TypeID.INTEGER - || type == Type.TypeID.LONG - || type == Type.TypeID.STRING - || type == Type.TypeID.DOUBLE; - }); + private void writeAndCommitPuffin(List<Blob> blobs) throws Exception { + TableOperations operations = ((HasTableOperations) table).operations(); + FileIO fileIO = operations.io(); + String path = operations.metadataFileLocation(String.format("%s.stats", UUID.randomUUID())); + OutputFile outputFile = fileIO.newOutputFile(path); + GenericStatisticsFile statisticsFile; + try (PuffinWriter writer = + Puffin.write(outputFile).createdBy("Iceberg Analyze action").build()) { + blobs.forEach(writer::add); + writer.finish(); + statisticsFile = + new GenericStatisticsFile( + snapshotId, + path, + writer.fileSize(), + writer.footerSize(), + writer.writtenBlobsMetadata().stream() + .map(GenericBlobMetadata::from) + .collect(ImmutableList.toImmutableList())); + } + table.updateStatistics().setStatistics(snapshotId, statisticsFile).commit(); } - private AnalysisResult generateNDVAndCommit() { - try { - if (snapshotId == null) { - snapshotId = table.currentSnapshot().snapshotId(); - } - - StatisticsFile statisticsFile = - NDVSketchGenerator.generateNDV( - spark(), table, snapshotId, columns.toArray(new String[0])); - table.updateStatistics().setStatistics(snapshotId, statisticsFile).commit(); - return ImmutableAnalyzeTable.AnalysisResult.builder() - .type(StandardBlobTypes.APACHE_DATASKETCHES_THETA_V1) - .build(); - } catch (IOException ioe) { - List<String> errors = Lists.newArrayList(); - errors.add(ioe.getMessage()); - return ImmutableAnalyzeTable.AnalysisResult.builder() - .type(StandardBlobTypes.APACHE_DATASKETCHES_THETA_V1) - .addAllErrors(errors) - .build(); - } + private List<Blob> generateNDVBlobs() { + return NDVSketchGenerator.generateNDVSketchesAndBlobs(spark(), table, snapshotId, columns); } @Override public AnalyzeTable columns(String... columnNames) { Preconditions.checkArgument( columnNames != null && columnNames.length > 0, "Columns cannot be null/empty"); - Set<String> columnsSet = Sets.newHashSet(Arrays.asList(columnNames)); - Preconditions.checkArgument( - analyzableTypes(columnsSet), - "Cannot be applied to the given columns, since the column's type is not supported"); - this.columns = columnsSet; + for (String columnName : columnNames) { + Types.NestedField field = table.schema().findField(columnName); + if (field == null) { + throw new ValidationException("No column with %s name in the table", columnName); + } + } + this.columns = ImmutableSet.copyOf(columnNames); return this; } @Override - public AnalyzeTable types(Set<String> statisticTypes) { - Preconditions.checkArgument( - Sets.newHashSet(StandardBlobTypes.blobTypes()).containsAll(statisticTypes), - "type not supported"); - this.types = statisticTypes; + public AnalyzeTable blobTypes(Set<String> types) { Review Comment: Renamed ########## spark/v3.5/spark/src/main/java/org/apache/iceberg/spark/actions/AnalyzeTableSparkAction.java: ########## @@ -0,0 +1,159 @@ +/* + * 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.Arrays; +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.base.Preconditions; +import org.apache.iceberg.relocated.com.google.common.collect.ImmutableSet; +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> columns = ImmutableSet.of(); + private Set<String> types = StandardBlobTypes.blobTypes(); + private Long snapshotId; + + AnalyzeTableSparkAction(SparkSession spark, Table table) { + super(spark); + this.table = table; + } + + @Override + protected AnalyzeTableSparkAction self() { + return this; + } + + @Override + public Result execute() { + if (snapshotId == null) { + snapshotId = table.currentSnapshot().snapshotId(); + } + String desc = String.format("Analyzing table %s for snapshot id %s", table.name(), snapshotId); + JobGroupInfo info = newJobGroupInfo("ANALYZE-TABLE", desc); + return withJobGroupInfo(info, this::doExecute); + } + + private Result doExecute() { + LOG.info("Starting the analysis of {} for snapshot {}", table.name(), snapshotId); + List<AnalysisResult> analysisResults = + types.stream() + .map( + statsName -> { + switch (statsName) { + case StandardBlobTypes.APACHE_DATASKETCHES_THETA_V1: + return generateNDVAndCommit(); + default: + return ImmutableAnalyzeTable.AnalysisResult.builder() + .type(statsName) + .addAllErrors(Lists.newArrayList("Stats type not supported")) + .build(); + } + }) + .collect(Collectors.toList()); + return ImmutableAnalyzeTable.Result.builder().analysisResults(analysisResults).build(); + } + + private boolean analyzableTypes(Set<String> columnNames) { + return columnNames.stream() + .anyMatch( + columnName -> { + Types.NestedField field = table.schema().findField(columnName); + if (field == null) { + throw new ValidationException("No column with %s name in the table", columnName); + } + Type.TypeID type = field.type().typeId(); + return type == Type.TypeID.INTEGER + || type == Type.TypeID.LONG + || type == Type.TypeID.STRING + || type == Type.TypeID.DOUBLE; Review Comment: These were the datatypes supported by the sketch lib. I think this no longer relevant with `Conversions.toByteBuffer` ########## spark/v3.5/spark/src/main/java/org/apache/iceberg/spark/actions/AnalyzeTableSparkAction.java: ########## @@ -63,97 +78,98 @@ protected AnalyzeTableSparkAction self() { @Override public Result execute() { - if (snapshotId == null) { - snapshotId = table.currentSnapshot().snapshotId(); - } String desc = String.format("Analyzing table %s for snapshot id %s", table.name(), snapshotId); JobGroupInfo info = newJobGroupInfo("ANALYZE-TABLE", desc); return withJobGroupInfo(info, this::doExecute); } private Result doExecute() { - LOG.info("Starting the analysis of {} for snapshot {}", table.name(), snapshotId); - List<AnalysisResult> analysisResults = - types.stream() - .map( - statsName -> { - switch (statsName) { + LOG.info("Starting analysis of {} for snapshot {}", table.name(), snapshotId); + List<AnalysisResult> results = Lists.newArrayList(); + List<Blob> blobs = + blobTypesToAnalyze.stream() + .flatMap( + type -> { + switch (type) { case StandardBlobTypes.APACHE_DATASKETCHES_THETA_V1: - return generateNDVAndCommit(); + try { + return generateNDVBlobs().stream(); + } catch (Exception e) { + LOG.error( + "Error occurred when collecting statistics for blob type {}", type, e); + ImmutableAnalyzeTable.AnalysisResult result = + ImmutableAnalyzeTable.AnalysisResult.builder() + .type(type) + .addErrors(e.getMessage()) + .build(); + results.add(result); + } + break; default: - return ImmutableAnalyzeTable.AnalysisResult.builder() - .type(statsName) - .addAllErrors(Lists.newArrayList("Stats type not supported")) - .build(); + throw new UnsupportedOperationException(); } + return Stream.empty(); }) .collect(Collectors.toList()); - return ImmutableAnalyzeTable.Result.builder().analysisResults(analysisResults).build(); + try { + writeAndCommitPuffin(blobs); + } catch (Exception e) { + throw new RuntimeException(e); + } + return ImmutableAnalyzeTable.Result.builder().analysisResults(results).build(); } - private boolean analyzableTypes(Set<String> columnNames) { - return columnNames.stream() - .anyMatch( - columnName -> { - Types.NestedField field = table.schema().findField(columnName); - if (field == null) { - throw new ValidationException("No column with %s name in the table", columnName); - } - Type.TypeID type = field.type().typeId(); - return type == Type.TypeID.INTEGER - || type == Type.TypeID.LONG - || type == Type.TypeID.STRING - || type == Type.TypeID.DOUBLE; - }); + private void writeAndCommitPuffin(List<Blob> blobs) throws Exception { + TableOperations operations = ((HasTableOperations) table).operations(); + FileIO fileIO = operations.io(); + String path = operations.metadataFileLocation(String.format("%s.stats", UUID.randomUUID())); + OutputFile outputFile = fileIO.newOutputFile(path); + GenericStatisticsFile statisticsFile; + try (PuffinWriter writer = + Puffin.write(outputFile).createdBy("Iceberg Analyze action").build()) { + blobs.forEach(writer::add); + writer.finish(); + statisticsFile = + new GenericStatisticsFile( + snapshotId, + path, + writer.fileSize(), + writer.footerSize(), + writer.writtenBlobsMetadata().stream() + .map(GenericBlobMetadata::from) + .collect(ImmutableList.toImmutableList())); + } + table.updateStatistics().setStatistics(snapshotId, statisticsFile).commit(); } - private AnalysisResult generateNDVAndCommit() { - try { - if (snapshotId == null) { - snapshotId = table.currentSnapshot().snapshotId(); - } - - StatisticsFile statisticsFile = - NDVSketchGenerator.generateNDV( - spark(), table, snapshotId, columns.toArray(new String[0])); - table.updateStatistics().setStatistics(snapshotId, statisticsFile).commit(); - return ImmutableAnalyzeTable.AnalysisResult.builder() - .type(StandardBlobTypes.APACHE_DATASKETCHES_THETA_V1) - .build(); - } catch (IOException ioe) { - List<String> errors = Lists.newArrayList(); - errors.add(ioe.getMessage()); - return ImmutableAnalyzeTable.AnalysisResult.builder() - .type(StandardBlobTypes.APACHE_DATASKETCHES_THETA_V1) - .addAllErrors(errors) - .build(); - } + private List<Blob> generateNDVBlobs() { + return NDVSketchGenerator.generateNDVSketchesAndBlobs(spark(), table, snapshotId, columns); } @Override public AnalyzeTable columns(String... columnNames) { Preconditions.checkArgument( columnNames != null && columnNames.length > 0, "Columns cannot be null/empty"); - Set<String> columnsSet = Sets.newHashSet(Arrays.asList(columnNames)); - Preconditions.checkArgument( - analyzableTypes(columnsSet), - "Cannot be applied to the given columns, since the column's type is not supported"); - this.columns = columnsSet; + for (String columnName : columnNames) { + Types.NestedField field = table.schema().findField(columnName); + if (field == null) { + throw new ValidationException("No column with %s name in the table", columnName); + } + } + this.columns = ImmutableSet.copyOf(columnNames); return this; } @Override - public AnalyzeTable types(Set<String> statisticTypes) { - Preconditions.checkArgument( - Sets.newHashSet(StandardBlobTypes.blobTypes()).containsAll(statisticTypes), - "type not supported"); - this.types = statisticTypes; + public AnalyzeTable blobTypes(Set<String> types) { + Preconditions.checkArgument(supportedBlobTypes.containsAll(types), "type not supported"); + this.blobTypesToAnalyze = types; return this; } @Override - public AnalyzeTable snapshot(String snapshotIdStr) { - this.snapshotId = Long.parseLong(snapshotIdStr); + public AnalyzeTable snapshot(long snapId) { + this.snapshotId = snapId; Review Comment: renamed -- 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
