-
Notifications
You must be signed in to change notification settings - Fork 113
feat: add ReplacePartitions core class (PR1 of 2 for #637) #776
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
12dc230
90ae61d
c2a4a5f
d000927
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| #include "iceberg/update/replace_partitions.h" | ||
|
|
||
| #include "iceberg/expression/expressions.h" | ||
| #include "iceberg/partition_spec.h" | ||
| #include "iceberg/snapshot.h" | ||
| #include "iceberg/table.h" // IWYU pragma: keep | ||
| #include "iceberg/table_metadata.h" | ||
| #include "iceberg/transaction.h" | ||
| #include "iceberg/util/error_collector.h" | ||
| #include "iceberg/util/macros.h" | ||
|
|
||
| namespace iceberg { | ||
|
|
||
| Result<std::unique_ptr<ReplacePartitions>> ReplacePartitions::Make( | ||
| std::string table_name, std::shared_ptr<TransactionContext> ctx) { | ||
| ICEBERG_PRECHECK(!table_name.empty(), "Table name cannot be empty"); | ||
| ICEBERG_PRECHECK(ctx != nullptr, "Cannot create ReplacePartitions without a context"); | ||
| return std::unique_ptr<ReplacePartitions>( | ||
| new ReplacePartitions(std::move(table_name), std::move(ctx))); | ||
| } | ||
|
|
||
| ReplacePartitions::ReplacePartitions(std::string table_name, | ||
| std::shared_ptr<TransactionContext> ctx) | ||
| : MergingSnapshotUpdate(std::move(table_name), std::move(ctx)) { | ||
| SetSummaryProperty(SnapshotSummaryFields::kReplacePartitions, "true"); | ||
| } | ||
|
|
||
| ReplacePartitions& ReplacePartitions::AddFile(const std::shared_ptr<DataFile>& file) { | ||
| ICEBERG_BUILDER_CHECK(file != nullptr, "Invalid data file: null"); | ||
| ICEBERG_BUILDER_CHECK(file->partition_spec_id.has_value(), | ||
| "Data file must have partition spec ID"); | ||
|
|
||
| int32_t spec_id = file->partition_spec_id.value(); | ||
| ICEBERG_BUILDER_ASSIGN_OR_RETURN(auto spec, base().PartitionSpecById(spec_id)); | ||
|
|
||
| ICEBERG_BUILDER_RETURN_IF_ERROR(AddDataFile(file)); | ||
| if (spec->fields().empty()) { | ||
| // Unpartitioned spec: Java's BaseReplacePartitions treats this as a | ||
| // table-wide replace rather than a spec-scoped DropPartition with empty | ||
| // partition values. Mirror that so every existing data file is dropped | ||
| // and conflict validation runs against AlwaysTrue. | ||
| ICEBERG_BUILDER_RETURN_IF_ERROR(DeleteByRowFilter(Expressions::AlwaysTrue())); | ||
| replace_by_row_filter_ = true; | ||
| } else { | ||
| ICEBERG_BUILDER_RETURN_IF_ERROR(DropPartition(spec_id, file->partition)); | ||
| replaced_partitions_.add(spec_id, file->partition); | ||
| } | ||
| return *this; | ||
| } | ||
|
|
||
| ReplacePartitions& ReplacePartitions::ValidateAppendOnly() { | ||
| FailAnyDelete(); | ||
| return *this; | ||
| } | ||
|
|
||
| ReplacePartitions& ReplacePartitions::ValidateFromSnapshot(int64_t snapshot_id) { | ||
| starting_snapshot_id_ = snapshot_id; | ||
| return *this; | ||
| } | ||
|
|
||
| ReplacePartitions& ReplacePartitions::ValidateNoConflictingData() { | ||
| validate_conflicting_data_ = true; | ||
| return *this; | ||
| } | ||
|
|
||
| ReplacePartitions& ReplacePartitions::ValidateNoConflictingDeletes() { | ||
| validate_conflicting_deletes_ = true; | ||
| return *this; | ||
| } | ||
|
|
||
| std::string ReplacePartitions::operation() { return DataOperation::kOverwrite; } | ||
|
|
||
| Status ReplacePartitions::Validate(const TableMetadata& current_metadata, | ||
| const std::shared_ptr<Snapshot>& snapshot) { | ||
| // Match Java BaseReplacePartitions: require at least one staged data file. | ||
| // Use the flags AddFile() sets — `DataSpec()` would also error on multi-spec | ||
| // stages and is not the guard we want here. | ||
| if (!replace_by_row_filter_ && replaced_partitions_.empty()) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Java still calls |
||
| return InvalidArgument( | ||
| "ReplacePartitions requires at least one data file; call AddFile() first"); | ||
| } | ||
|
|
||
| if (snapshot == nullptr) { | ||
| return {}; | ||
| } | ||
|
|
||
| auto io = ctx_->table->io(); | ||
| if (validate_conflicting_data_) { | ||
| if (replace_by_row_filter_) { | ||
| ICEBERG_RETURN_UNEXPECTED(ValidateAddedDataFiles( | ||
| current_metadata, starting_snapshot_id_, Expressions::AlwaysTrue(), snapshot, | ||
| io, IsCaseSensitive())); | ||
| } else { | ||
| ICEBERG_RETURN_UNEXPECTED(ValidateAddedDataFiles( | ||
| current_metadata, starting_snapshot_id_, replaced_partitions_, snapshot, io)); | ||
| } | ||
| } | ||
| if (validate_conflicting_deletes_) { | ||
| // Java's BaseReplacePartitions.validate gates both ValidateNoNewDeleteFiles | ||
| // and ValidateDeletedDataFiles on the same validateNewDeletes flag. The | ||
| // second check rejects concurrent overwrite/delete commits in the replaced | ||
| // partitions; without it a concurrent delete in a replaced partition would | ||
| // commit silently. | ||
| if (replace_by_row_filter_) { | ||
| ICEBERG_RETURN_UNEXPECTED(ValidateNoNewDeleteFiles( | ||
| current_metadata, starting_snapshot_id_, Expressions::AlwaysTrue(), snapshot, | ||
| io, IsCaseSensitive())); | ||
| ICEBERG_RETURN_UNEXPECTED(ValidateDeletedDataFiles( | ||
| current_metadata, starting_snapshot_id_, Expressions::AlwaysTrue(), snapshot, | ||
| io, IsCaseSensitive())); | ||
| } else { | ||
| ICEBERG_RETURN_UNEXPECTED(ValidateNoNewDeleteFiles( | ||
| current_metadata, starting_snapshot_id_, replaced_partitions_, snapshot, io)); | ||
| ICEBERG_RETURN_UNEXPECTED(ValidateDeletedDataFiles( | ||
| current_metadata, starting_snapshot_id_, replaced_partitions_, snapshot, io)); | ||
| } | ||
| } | ||
| return {}; | ||
| } | ||
|
|
||
| } // namespace iceberg | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
| */ | ||
|
|
||
| #pragma once | ||
|
|
||
| /// \file iceberg/update/replace_partitions.h | ||
|
|
||
| #include <cstdint> | ||
| #include <memory> | ||
| #include <optional> | ||
| #include <string> | ||
|
|
||
| #include "iceberg/iceberg_export.h" | ||
| #include "iceberg/result.h" | ||
| #include "iceberg/type_fwd.h" | ||
| #include "iceberg/update/merging_snapshot_update.h" | ||
| #include "iceberg/util/partition_value_util.h" | ||
|
|
||
| namespace iceberg { | ||
|
|
||
| /// \brief Replaces partitions in a table with new data files. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Do we need to mention
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Changed to '/// \note This is provided to implement SQL compatible with Hive table operations but is not recommended. Instead, use OverwriteFiles to explicitly overwrite data.' |
||
| /// | ||
| /// ReplacePartitions dynamically identifies which partitions to overwrite based | ||
| /// on the data files added via AddFile(). All existing data files in each | ||
| /// touched partition are marked DELETED, and the new files are written as the | ||
| /// sole data in those partitions. Partitions not referenced by any added file | ||
| /// are left unchanged. | ||
| /// | ||
| /// This operation produces a snapshot with operation="overwrite" and | ||
| /// "replace-partitions"="true" in the summary. For unpartitioned tables, all | ||
| /// existing files are replaced. | ||
| /// | ||
| /// When committing, these changes are applied to the latest table snapshot. | ||
| /// Commit conflicts are resolved by re-applying to the new latest snapshot | ||
| /// and reattempting the commit. | ||
| /// | ||
| /// \note This is provided to implement SQL compatible with Hive table | ||
| /// operations but is not recommended. Instead, use OverwriteFiles to | ||
| /// explicitly overwrite data. | ||
| class ICEBERG_EXPORT ReplacePartitions : public MergingSnapshotUpdate { | ||
| public: | ||
| /// \brief Create a new ReplacePartitions instance. | ||
| /// | ||
| /// \param table_name The name of the table | ||
| /// \param ctx The transaction context | ||
| /// \return A Result containing the ReplacePartitions instance or an error | ||
| static Result<std::unique_ptr<ReplacePartitions>> Make( | ||
| std::string table_name, std::shared_ptr<TransactionContext> ctx); | ||
|
|
||
| /// \brief Add a data file and mark its partition for replacement. | ||
| /// | ||
| /// Each call registers the file's partition so all existing data files in | ||
| /// that partition are replaced. Duplicate files (same path) are ignored. | ||
| /// | ||
| /// \param file The data file to add (must have partition_spec_id set) | ||
| /// \return Reference to this for method chaining | ||
| ReplacePartitions& AddFile(const std::shared_ptr<DataFile>& file); | ||
|
|
||
| /// \brief Fail the commit if any existing data file would be deleted. | ||
| /// | ||
| /// This validation is useful to ensure the operation is only applied to | ||
| /// tables where no data currently exists in the affected partitions. | ||
| /// | ||
| /// \return Reference to this for method chaining | ||
| ReplacePartitions& ValidateAppendOnly(); | ||
|
|
||
| /// \brief Set the snapshot ID used as the baseline for conflict validation. | ||
| /// | ||
| /// Validations check changes that occurred after this snapshot ID. If not | ||
| /// set, all ancestor snapshots through the initial snapshot are validated. | ||
| /// | ||
| /// \param snapshot_id A snapshot ID | ||
| /// \return Reference to this for method chaining | ||
| ReplacePartitions& ValidateFromSnapshot(int64_t snapshot_id); | ||
|
|
||
| /// \brief Enable validation that no conflicting data files were added concurrently. | ||
| /// | ||
| /// Fails the commit if a concurrent operation added a data file in any of | ||
| /// the partitions being replaced after the snapshot set by | ||
| /// ValidateFromSnapshot(). | ||
| /// | ||
| /// \return Reference to this for method chaining | ||
| ReplacePartitions& ValidateNoConflictingData(); | ||
|
|
||
| /// \brief Enable validation that no conflicting delete files were added concurrently. | ||
| /// | ||
| /// Fails the commit if a concurrent operation added a delete file covering | ||
| /// any of the partitions being replaced after the snapshot set by | ||
| /// ValidateFromSnapshot(). | ||
| /// | ||
| /// \return Reference to this for method chaining | ||
| ReplacePartitions& ValidateNoConflictingDeletes(); | ||
|
|
||
| std::string operation() override; | ||
|
|
||
| protected: | ||
| Status Validate(const TableMetadata& current_metadata, | ||
| const std::shared_ptr<Snapshot>& snapshot) override; | ||
|
|
||
| private: | ||
| explicit ReplacePartitions(std::string table_name, | ||
| std::shared_ptr<TransactionContext> ctx); | ||
|
|
||
| std::optional<int64_t> starting_snapshot_id_; | ||
| bool validate_conflicting_data_{false}; | ||
| bool validate_conflicting_deletes_{false}; | ||
| // True once an AddFile() call has staged a file whose partition spec is | ||
| // unpartitioned. Java's BaseReplacePartitions treats this case as a | ||
| // table-wide replace (DeleteByRowFilter(AlwaysTrue())) and runs conflict | ||
| // validation against AlwaysTrue rather than a partition set — mirror that. | ||
| bool replace_by_row_filter_{false}; | ||
| // Partitions touched by AddFile() in partitioned specs. Used to scope | ||
| // conflict validation to the overwritten partitions in the partitioned | ||
| // case; ignored when replace_by_row_filter_ is true. | ||
| PartitionSet replaced_partitions_; | ||
| }; | ||
|
|
||
| } // namespace iceberg | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Java's
PartitionSpec.isUnpartitioned()returns true not only for an empty field list but also for specs where all partition transforms arevoid/alwaysNull. With an all-void partition spec,BaseReplacePartitions.applygoes through the unpartitioned path and deletes byalwaysTrue(), replacing the whole table. This check only looks atfields().empty(), so C++ will treat an all-void spec as partitioned and callDropPartition, leaving files from other equivalent unpartitioned/all-void specs instead of doing the table-wide replace.