4.1.0/api-reference/_store_8hpp_source.html

#ifndef _DITTO_STORE_

#define _DITTO_STORE_


#include "Collection.hpp"

#include "DiskUsage.hpp"

#include "PendingCollectionsOperation.hpp"

#include "WriteTransaction.hpp"

#include "WriteTransactionResult.hpp"


#include <functional>

#include <memory>

#include <string>

#include <vector>


namespace ditto {

class DittoHandleWrapper;


class Store {

  friend class Ditto;


  std::shared_ptr<DittoHandleWrapper> ditto_handle_wrapper;

  DiskUsage disk_usage;

  Store(std::shared_ptr<DittoHandleWrapper> ditto_handle_wrapper);


public:

  Store();


  Collection collection(std::string name) const;


  std::vector<std::unique_ptr<WriteTransactionResult>>

  write(std::function<void(WriteTransaction &)> fn) const;


  PendingCollectionsOperation collections() const;


  DiskUsage get_disk_usage() const;

};

} // namespace ditto

#endif

ditto::Collection
A reference to a collection in a Store.
Definition: Collection.hpp:26

ditto::DiskUsage
Provides an interface to be able to monitor local files.
Definition: DiskUsage.hpp:65

ditto::Ditto
The entrypoint to the Ditto SDK.
Definition: Ditto.hpp:28

ditto::PendingCollectionsOperation
These objects are returned when calling collections() on Store objects.
Definition: PendingCollectionsOperation.hpp:58

ditto::Store
Provides access to Collections and a write transaction API.
Definition: Store.hpp:21

ditto::Store::get_disk_usage
DiskUsage get_disk_usage() const
Provides access to the Store's disk usage.
Definition: Store.cpp:26

ditto::Store::write
std::vector< std::unique_ptr< WriteTransactionResult > > write(std::function< void(WriteTransaction &)> fn) const
Allows you to group multiple operations together that affect multiple documents, potentially across m...
Definition: Store.cpp:29

ditto::Store::collections
PendingCollectionsOperation collections() const
Returns an object that lets you fetch or observe the collections in the store.
Definition: Store.cpp:22

ditto::Store::collection
Collection collection(std::string name) const
Returns a Collection with the provided name.
Definition: Store.cpp:18

ditto::WriteTransaction
WriteTransaction exposes functionality that allows you to perform multiple operations on the store wi...
Definition: WriteTransaction.hpp:25