Collection.hpp

#ifndef DITTO_COLLECTION_H
#define DITTO_COLLECTION_H
 
#include "Attachment.hpp"
#include "AttachmentFetchEvent.hpp"
#include "AttachmentFetcher.hpp"
#include "AttachmentToken.hpp"
#include "DocumentId.hpp"
#include "Helpers.hpp"
#include "PendingCursorOperation.hpp"
#include "PendingIDSpecificOperation.hpp"
#include "WriteStrategy.hpp"
 
#include "json.hpp"
 
#include <map>
#include <memory>
#include <string>
 
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") Collection {
  DITTO_DISABLE_DEPRECATED_WARNINGS("The legacy query API is deprecated")
 
private:
  friend class DocumentHelpers;
  friend class ScopedWriteTransaction;
  friend class Store;
 
  std::shared_ptr<DittoHandleWrapper> ditto_handle_wrapper;
 
  struct private_ctor {};
 
  Collection(std::shared_ptr<DittoHandleWrapper> ditto_handle_wrapper,
             std::string name);
 
  DocumentId upsert(nlohmann::json content, WriteStrategy write_strategy,
                    CWriteTransaction *txn) const;
 
public:
  // Indirect (because of `private_ctor`) private constructor
  Collection(std::shared_ptr<DittoHandleWrapper> ditto_handle_wrapper,
             std::string name, private_ctor &&);

  // NOLINTBEGIN(cppcoreguidelines-non-private-member-variables-in-classes)
  // NOLINTBEGIN(misc-non-private-member-variables-in-classes)
  std::string name; // TODO(v5): make this private and provide get_name()?
  // NOLINTEND(misc-non-private-member-variables-in-classes)
  // NOLINTEND(cppcoreguidelines-non-private-member-variables-in-classes)

  DocumentId upsert(nlohmann::json content,
                    WriteStrategy write_strategy = WriteStrategy::merge) const;

  PendingIDSpecificOperation find_by_id(DocumentId id) const;

  PendingCursorOperation find_all() const;

  PendingCursorOperation find(std::string query) const;

  PendingCursorOperation find(std::string query,
                              nlohmann::json query_args) const;

  DITTO_DEPRECATED Attachment new_attachment(
      std::string path, std::map<std::string, std::string> metadata =
                            std::map<std::string, std::string>()) const;

  DITTO_DEPRECATED std::shared_ptr<AttachmentFetcher>
  fetch_attachment(std::shared_ptr<AttachmentToken> token,
                   AttachmentFetcherEventHandler event_handler) const;
 
  DITTO_REENABLE_WARNINGS
};
} // namespace ditto
#endif