Jinchul81 commented on code in PR #334: URL: https://github.com/apache/iceberg-cpp/pull/334#discussion_r2553295651
########## src/iceberg/pending_update.h: ########## @@ -0,0 +1,75 @@ +/* + * 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/pending_update.h +/// API for table changes using builder pattern + +#include "iceberg/iceberg_export.h" +#include "iceberg/result.h" +#include "iceberg/type_fwd.h" + +namespace iceberg { + +/// \brief Base class for table metadata changes using builder pattern +/// +/// PendingUpdate represents an API for building and committing changes to an +/// Iceberg table. Subclasses implement specific types of table updates such as +/// schema changes, property updates, or snapshot-producing operations like +/// appends and deletes. +/// +/// Apply() can be used to validate and inspect the uncommitted changes before +/// committing. Commit() applies the changes and commits them to the table. +/// +/// \tparam T The type of result returned by Apply() +template <typename T> +class ICEBERG_EXPORT PendingUpdate { + public: + virtual ~PendingUpdate() = default; + + /// \brief Apply the pending changes and return the uncommitted result + /// + /// This does not result in a permanent update. + /// + /// \return the uncommitted changes that would be committed, or an error if + /// the pending changes cannot be applied to the current table metadata + virtual Result<T> Apply() = 0; + + /// \brief Apply and commit the pending changes to the table + /// + /// Changes are committed by calling the underlying table's commit operation. + /// + /// Once the commit is successful, the updated table will be refreshed. + /// + /// \return Status::OK if the commit was successful, or an error status if + /// validation failed or the commit encountered conflicts + virtual Status Commit() = 0; + + protected: + PendingUpdate() = default; + + // Non-copyable, movable + PendingUpdate(const PendingUpdate&) = delete; + PendingUpdate& operator=(const PendingUpdate&) = delete; Review Comment: Please move it to the public space. ########## src/iceberg/pending_update.h: ########## @@ -28,48 +28,67 @@ namespace iceberg { -/// \brief Base class for table metadata changes using builder pattern Review Comment: I don't prefer you to delete the context that you're using builder pattern. This is the reason why the ctors of this class are in the protected region, right? ########## src/iceberg/pending_update.h: ########## @@ -0,0 +1,75 @@ +/* + * 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/pending_update.h +/// API for table changes using builder pattern + +#include "iceberg/iceberg_export.h" +#include "iceberg/result.h" +#include "iceberg/type_fwd.h" + +namespace iceberg { + +/// \brief Base class for table metadata changes using builder pattern +/// +/// PendingUpdate represents an API for building and committing changes to an +/// Iceberg table. Subclasses implement specific types of table updates such as +/// schema changes, property updates, or snapshot-producing operations like +/// appends and deletes. +/// +/// Apply() can be used to validate and inspect the uncommitted changes before +/// committing. Commit() applies the changes and commits them to the table. +/// +/// \tparam T The type of result returned by Apply() +template <typename T> +class ICEBERG_EXPORT PendingUpdate { + public: + virtual ~PendingUpdate() = default; + + /// \brief Apply the pending changes and return the uncommitted result + /// + /// This does not result in a permanent update. + /// + /// \return the uncommitted changes that would be committed, or an error if + /// the pending changes cannot be applied to the current table metadata + virtual Result<T> Apply() = 0; + + /// \brief Apply and commit the pending changes to the table + /// + /// Changes are committed by calling the underlying table's commit operation. + /// + /// Once the commit is successful, the updated table will be refreshed. + /// + /// \return Status::OK if the commit was successful, or an error status if + /// validation failed or the commit encountered conflicts + virtual Status Commit() = 0; + + protected: + PendingUpdate() = default; + + // Non-copyable, movable + PendingUpdate(const PendingUpdate&) = delete; Review Comment: Please move it to the public space. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
