zhjwpku commented on code in PR #60: URL: https://github.com/apache/iceberg-cpp/pull/60#discussion_r2035536424
########## src/iceberg/snapshot.h: ########## @@ -0,0 +1,213 @@ +/* + * 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 <optional> +#include <string> +#include <unordered_map> + +#include "iceberg/iceberg_export.h" +#include "iceberg/util/formattable.h" + +namespace iceberg { + +/// \brief Optional Snapshot Summary Fields +struct SnapshotSummaryFields { + /// \brief The operation field key + constexpr static std::string_view kOperation = "operation"; + + /// Metrics, see https://iceberg.apache.org/spec/#metrics + + /// \brief Number of data files added in the snapshot + constexpr static std::string_view kAddedDataFiles = "added-data-files"; + /// \brief Number of data files deleted in the snapshot + constexpr static std::string_view kDeletedDataFiles = "deleted-data-files"; + /// \brief Total number of live data files in the snapshot + constexpr static std::string_view kTotalDataFiles = "total-data-files"; + /// \brief Number of positional/equality delete files and deletion vectors added in the + /// snapshot + constexpr static std::string_view kAddedDeleteFiles = "added-delete-files"; + /// \brief Number of equality delete files added in the snapshot + constexpr static std::string_view kAddedEqDeleteFiles = "added-equality-delete-files"; + /// \brief Number of equality delete files removed in the snapshot + constexpr static std::string_view kRemovedEqDeleteFiles = + "removed-equality-delete-files"; + /// \brief Number of position delete files added in the snapshot + constexpr static std::string_view kAddedPosDeleteFiles = "added-position-delete-files"; + /// \brief Number of position delete files removed in the snapshot + constexpr static std::string_view kRemovedPosDeleteFiles = + "removed-position-delete-files"; + /// \brief Number of deletion vectors added in the snapshot + constexpr static std::string_view kAddedDVS = "added-dvs"; + /// \brief Number of deletion vectors removed in the snapshot + constexpr static std::string_view kRemovedDVS = "removed-dvs"; + /// \brief Number of positional/equality delete files and deletion vectors removed in + /// the snapshot + constexpr static std::string_view kRemovedDeleteFiles = "removed-delete-files"; + /// \brief Total number of live positional/equality delete files and deletion vectors in + /// the snapshot + constexpr static std::string_view kTotalDeleteFiles = "total-delete-files"; + /// \brief Number of records added in the snapshot + constexpr static std::string_view kAddedRecords = "added-records"; + /// \brief Number of records deleted in the snapshot + constexpr static std::string_view kDeletedRecords = "deleted-records"; + /// \brief Total number of records in the snapshot + constexpr static std::string_view kTotalRecords = "total-records"; + /// \brief The size of files added in the snapshot + constexpr static std::string_view kAddedFileSize = "added-files-size"; + /// \brief The size of files removed in the snapshot + constexpr static std::string_view kRemovedFileSize = "removed-files-size"; + /// \brief Total size of live files in the snapshot + constexpr static std::string_view kTotalFileSize = "total-files-size"; + /// \brief Number of position delete records added in the snapshot + constexpr static std::string_view kAddedPosDeletes = "added-position-deletes"; + /// \brief Number of position delete records removed in the snapshot + constexpr static std::string_view kRemovedPosDeletes = "removed-position-deletes"; + /// \brief Total number of position delete records in the snapshot + constexpr static std::string_view kTotalPosDeletes = "total-position-deletes"; + /// \brief Number of equality delete records added in the snapshot + constexpr static std::string_view kAddedEqDeletes = "added-equality-deletes"; + /// \brief Number of equality delete records removed in the snapshot + constexpr static std::string_view kRemovedEqDeletes = "removed-equality-deletes"; + /// \brief Total number of equality delete records in the snapshot + constexpr static std::string_view kTotalEqDeletes = "total-equality-deletes"; + /// \brief Number of duplicate files deleted (duplicates are files recorded more than + /// once in the manifest) + constexpr static std::string_view kDeletedDuplicatedFiles = "deleted-duplicate-files"; + /// \brief Number of partitions with files added or removed in the snapshot + constexpr static std::string_view kChangedPartitionCountProp = + "changed-partition-count"; + + /// Other Fields, see https://iceberg.apache.org/spec/#other-fields + + /// \brief The Write-Audit-Publish id of a staged snapshot + constexpr static std::string_view kWAPID = "wap.id"; + /// \brief The Write-Audit-Publish id of a snapshot already been published + constexpr static std::string_view kPublishedWAPID = "published-wap-id"; + /// \brief The original id of a cherry-picked snapshot + constexpr static std::string_view kSourceSnapshotID = "source-snapshot-id"; + /// \brief Name of the engine that created the snapshot + constexpr static std::string_view kEngineName = "engine-name"; + /// \brief Version of the engine that created the snapshot + constexpr static std::string_view kEngineVersion = "engine-version"; +}; + +/// \brief Summarises the changes in the snapshot. +class ICEBERG_EXPORT Summary : public iceberg::util::Formattable { + public: + /// \brief The operation field is used by some operations, like snapshot expiration, to + /// skip processing certain snapshots. + enum class Operation { + /// Only data files were added and no files were removed. + kAppend, + /// Data and delete files were added and removed without changing table data; i.e. + /// compaction, change the data file format, or relocating data files. + kReplace, + /// Data and delete files were added and removed in a logical overwrite operation. + kOverwrite, + /// Data files were removed and their contents logically deleted and/or delete files + /// were added to delete rows. + kDelete, + }; + Summary() = default; + /// \brief Construct a summary with the given operation and properties. + Summary(Operation op, std::unordered_map<std::string, std::string> props); + + /// \brief Get the operation type of the snapshot. + Operation operation() const; + + /// \brief Get the additional properties of the snapshot. + const std::unordered_map<std::string, std::string>& properties() const; + + std::string ToString() const override; + + private: + /// The type of operation in the snapshot + Operation operation_{Operation::kAppend}; + /// Other summary data. + std::unordered_map<std::string, std::string> additional_properties_; +}; + +/// \brief A snapshot of the data in a table at a point in time. +/// +/// A snapshot consist of one or more file manifests, and the complete table contents is +/// the union of all the data files in those manifests. +/// +/// Snapshots are created by table operations. +class ICEBERG_EXPORT Snapshot : public iceberg::util::Formattable { Review Comment: changed. -- 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
