WriteTransactionPendingIDSpecificOperation.hpp

#ifndef DITTO_WRITE_TRANSACTION_PENDING_ID_SPECIFIC_OPERATION_H
#define DITTO_WRITE_TRANSACTION_PENDING_ID_SPECIFIC_OPERATION_H
 
#include "Document.hpp"
#include "DocumentId.hpp"
#include "MutableDocument.hpp"
#include "UpdateResult.hpp"
#include "WriteTransaction.hpp"
 
#include <functional>
#include <memory>
#include <string>
#include <vector>
 
namespace ditto {
class DittoHandleWrapper;

class DITTO_DEPRECATED_BECAUSE(
    "Use DQL (Ditto Query Language) instead. For more information see: "
    "https://ditto.com/link/legacy-to-dql-guide")
    WriteTransactionPendingIDSpecificOperation {
  DITTO_DISABLE_DEPRECATED_WARNINGS("The legacy query API is deprecated")
 
  friend class ScopedWriteTransaction;
 
  std::shared_ptr<DittoHandleWrapper> ditto_handle_wrapper;
  // NOLINTNEXTLINE(cppcoreguidelines-avoid-const-or-ref-data-members)
  WriteTransaction &base_transaction;
 
  WriteTransactionPendingIDSpecificOperation(
      std::string collection_name, DocumentId document_id,
      std::shared_ptr<DittoHandleWrapper> ditto_handle_wrapper,
      WriteTransaction &base_transaction);
 
public:
  // TODO(v5): make collection_name private and provide a getter
  std::string collection_name; // NOLINT

  // TODO(v5): make document_id private and provide a getter
  DocumentId document_id; // NOLINT

  std::shared_ptr<Document> exec() const;

  DITTO_DEPRECATED_BECAUSE("Use `update_v2` instead.")
  std::vector<std::unique_ptr<UpdateResult>>
  update(std::function<void(MutableDocument &)> fn) const;

  std::vector<std::unique_ptr<UpdateResult>>
  update_v2(std::function<void(MutableDocument *)> fn) const;

  bool remove() const;

  bool evict() const;
 
  DITTO_REENABLE_WARNINGS
};
} // namespace ditto
#endif