src/iceberg/update/update_properties.h

/*
 * 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 <unordered_set>

#include "iceberg/iceberg_export.h"
#include "iceberg/result.h"
#include "iceberg/type_fwd.h"
#include "iceberg/update/pending_update.h"

/// \file iceberg/update/update_properties.h
/// \brief Updates table properties.

namespace iceberg {

/// \brief Updates table properties.
class ICEBERG_EXPORT UpdateProperties : public PendingUpdate {
 public:
  static Result<std::shared_ptr<UpdateProperties>> Make(
      std::shared_ptr<TransactionContext> ctx);

  ~UpdateProperties() override;

  struct ApplyResult {
    std::unordered_map<std::string, std::string> updates;
    std::unordered_set<std::string> removals;
    std::optional<int8_t> format_version;
  };

  /// \brief Sets a property key to a specified value.
  ///
  /// The key must not have been previously marked for removal and must not be a
  /// reserved property key (except `format-version`). Setting a reserved property
  /// will result in a validation error at Apply() time.
  ///
  /// \param key The property key to set
  /// \param value The property value to set
  /// \return Reference to this UpdateProperties for chaining
  UpdateProperties& Set(const std::string& key, const std::string& value);

  /// \brief Marks a property for removal.
  ///
  /// \param key The property key to remove
  /// \return Reference to this UpdateProperties for chaining
  UpdateProperties& Remove(const std::string& key);

  Kind kind() const final { return Kind::kUpdateProperties; }
  bool IsRetryable() const override { return true; }

  /// \brief Apply the pending changes and return the updates and removals.
  Result<ApplyResult> Apply();

 private:
  explicit UpdateProperties(std::shared_ptr<TransactionContext> ctx);

  std::unordered_map<std::string, std::string> updates_;
  std::unordered_set<std::string> removals_;
};

}  // namespace iceberg