scan_report.h

Go to the documentation of this file.

/*
 * 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.
 */
 
#pragma once
 
 
#include <memory>
#include <optional>
#include <string>
#include <unordered_map>
#include <vector>
 
#include "iceberg/constants.h"
#include "iceberg/expression/expression.h"
#include "iceberg/iceberg_export.h"
#include "iceberg/metrics/metrics_context.h"
#include "iceberg/metrics/metrics_types.h"
#include "iceberg/metrics/timer.h"
 
namespace iceberg {
 
// Forward declaration: ScanMetrics is defined later in this header.
class ScanMetrics;
 
struct ICEBERG_EXPORT ScanMetricsResult {
  std::optional<TimerResult> total_planning_duration;
  std::optional<CounterResult> result_data_files;
  std::optional<CounterResult> result_delete_files;
  std::optional<CounterResult> scanned_data_manifests;
  std::optional<CounterResult> scanned_delete_manifests;
  std::optional<CounterResult> total_data_manifests;
  std::optional<CounterResult> total_delete_manifests;
  std::optional<CounterResult> total_file_size_in_bytes;
  std::optional<CounterResult> total_delete_file_size_in_bytes;
  std::optional<CounterResult> skipped_data_manifests;
  std::optional<CounterResult> skipped_delete_manifests;
  std::optional<CounterResult> skipped_data_files;
  std::optional<CounterResult> skipped_delete_files;
  std::optional<CounterResult> indexed_delete_files;
  std::optional<CounterResult> equality_delete_files;
  std::optional<CounterResult> positional_delete_files;
  std::optional<CounterResult> dvs;
 
  bool operator==(const ScanMetricsResult&) const = default;
 
  static ScanMetricsResult From(const ScanMetrics& scan_metrics);
};
 
class ICEBERG_EXPORT ScanMetrics {
 public:
  static std::unique_ptr<ScanMetrics> Make(MetricsContext& context);
 
  static std::unique_ptr<ScanMetrics> Noop();
 
  ScanMetricsResult ToResult() const;
 
  std::shared_ptr<Timer> total_planning_duration;
  std::shared_ptr<Counter> result_data_files;
  std::shared_ptr<Counter> result_delete_files;
  std::shared_ptr<Counter> scanned_data_manifests;
  std::shared_ptr<Counter> scanned_delete_manifests;
  std::shared_ptr<Counter> total_data_manifests;
  std::shared_ptr<Counter> total_delete_manifests;
  std::shared_ptr<Counter> total_file_size_in_bytes;
  std::shared_ptr<Counter> total_delete_file_size_in_bytes;
  std::shared_ptr<Counter> skipped_data_manifests;
  std::shared_ptr<Counter> skipped_delete_manifests;
  std::shared_ptr<Counter> skipped_data_files;
  std::shared_ptr<Counter> skipped_delete_files;
  std::shared_ptr<Counter> indexed_delete_files;
  std::shared_ptr<Counter> equality_delete_files;
  std::shared_ptr<Counter> positional_delete_files;
  std::shared_ptr<Counter> dvs;
 
 private:
  ScanMetrics() = default;
};
 
struct ICEBERG_EXPORT ScanReport {
  std::string table_name;
  int64_t snapshot_id = kInvalidSnapshotId;
  std::shared_ptr<Expression> filter;
  int32_t schema_id = kInvalidSchemaId;
  std::vector<int32_t> projected_field_ids;
  std::vector<std::string> projected_field_names;
  ScanMetricsResult scan_metrics;
  std::unordered_map<std::string, std::string> metadata;
};
 
}  // namespace iceberg