PendingCursorOperation.hpp

#ifndef DITTO_PENDING_CURSOR_OPERATION_H
#define DITTO_PENDING_CURSOR_OPERATION_H
 
#include "Document.hpp"
#include "DocumentId.hpp"
#include "Helpers.hpp"
#include "LiveQuery.hpp"
#include "MutableDocument.hpp"
#include "SortDirection.hpp"
#include "Subscription.hpp"
#include "UpdateResult.hpp"
#include "json.hpp"
 
#include <functional>
#include <memory>
#include <string>
#include <unordered_map>
#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") PendingCursorOperation {
  DITTO_DISABLE_DEPRECATED_WARNINGS("The legacy query API is deprecated")
 
  friend class Collection;
  friend class PendingCollectionsOperation;
 
  nlohmann::json query_args;
  uint32_t _offset = 0;
  int32_t _limit = -1;
 
  PendingCursorOperation(
      std::shared_ptr<DittoHandleWrapper> ditto_handle_wrapper,
      std::string collection_name, std::string query_str,
      nlohmann::json query_args);
 
  PendingCursorOperation() = default;
  PendingCursorOperation(PendingCursorOperation &&other) noexcept;
  PendingCursorOperation(const PendingCursorOperation &other);
  PendingCursorOperation &operator=(PendingCursorOperation other);
 
  class Impl;
  std::unique_ptr<Impl> impl_;
 
public:
  // TODO(v5): make collection_name private and provide a get_collection_name()
  std::string collection_name; // NOLINT

  // TODO(v5): make query private and provide a get_query() function
  std::string query; // NOLINT
 
  ~PendingCursorOperation();
 
  // Follows the copy-and-swap idiom as described here:
  // https://stackoverflow.com/a/3279550/2041080
  friend void swap(PendingCursorOperation &first,
                   PendingCursorOperation &second) noexcept {
    using std::swap;
 
    swap(first.collection_name, second.collection_name);
    swap(first.query, second.query);
    swap(first.query_args, second.query_args);
    swap(first._offset, second._offset);
    swap(first._limit, second._limit);
    swap(first.impl_, second.impl_);
  }

  PendingCursorOperation &limit(uint32_t limit);

  PendingCursorOperation &offset(uint32_t offset);

  PendingCursorOperation &sort(std::string query, SortDirection direction);

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

  std::unordered_map<DocumentId, std::vector<std::unique_ptr<UpdateResult>>,
                     DocumentIdHasher>
  update(std::function<void(std::vector<MutableDocument> &)> fn);

  std::vector<DocumentId> remove() const;

  std::vector<DocumentId> evict() const;

  std::shared_ptr<Subscription> subscribe() const;

  std::shared_ptr<LiveQuery>
  observe_local(LiveQueryEventCallback event_callback) const;

  std::shared_ptr<LiveQuery> observe_local_with_next_signal(
      LiveQueryEventWithNextSignalCallback event_callback) const;
 
  DITTO_REENABLE_WARNINGS
};
} // namespace ditto
#endif