bulk_ops.hpp

Go to the documentation of this file.

#pragma once
 
/// @file userver/storages/mongo/bulk_ops.hpp
/// @brief Bulk sub-operation models
 
#include <userver/compiler/select.hpp>
#include <userver/formats/bson/document.hpp>
#include <userver/formats/bson/value.hpp>
#include <userver/storages/mongo/options.hpp>
#include <userver/utils/fast_pimpl.hpp>
 
USERVER_NAMESPACE_BEGIN
 
namespace storages::mongo::operations {
class Bulk;
}  // namespace storages::mongo::operations
 
/// Bulk sub-operations
namespace storages::mongo::bulk_ops {
 
/// Inserts a single document as part of bulk operation
class InsertOne {
public:
    explicit InsertOne(formats::bson::Document document);
    ~InsertOne();
 
    InsertOne(const InsertOne&);
    InsertOne(InsertOne&&) noexcept;
    InsertOne& operator=(const InsertOne&);
    InsertOne& operator=(InsertOne&&) noexcept;
 
    void SetOption() const {}
 
private:
    friend class storages::mongo::operations::Bulk;
 
    class Impl;
    static constexpr std::size_t kSize =
        compiler::SelectSize()  //
            .For64Bit(16)
            .For32Bit(8);
    static constexpr size_t kAlignment = alignof(void*);
    utils::FastPimpl<Impl, kSize, kAlignment, utils::kStrictMatch> impl_;
};
 
/// Replaces a single document as part of bulk operation
class ReplaceOne {
public:
    ReplaceOne(formats::bson::Document selector, formats::bson::Document replacement);
    ~ReplaceOne();
 
    ReplaceOne(const ReplaceOne&);
    ReplaceOne(ReplaceOne&&) noexcept;
    ReplaceOne& operator=(const ReplaceOne&);
    ReplaceOne& operator=(ReplaceOne&&) noexcept;
 
    void SetOption(options::Upsert);
 
private:
    friend class storages::mongo::operations::Bulk;
 
    class Impl;
    static constexpr std::size_t kSize =
        compiler::SelectSize()  //
            .For64Bit(48)
            .For32Bit(24);
    static constexpr size_t kAlignment = alignof(void*);
    utils::FastPimpl<Impl, kSize, kAlignment, utils::kStrictMatch> impl_;
};
 
/// Updates documents as part of bulk operation
class Update {
public:
    enum class Mode { kSingle, kMulti };
 
    Update(Mode mode, formats::bson::Document selector, formats::bson::Document update);
 
    /// @brief Creates an update operation with an aggregation pipeline
    /// @note `update` must be either an update document or an aggregation pipeline array
    /// @note Available starting in MongoDB 4.2
    Update(Mode mode, formats::bson::Document selector, formats::bson::Value update);
 
    ~Update();
 
    Update(const Update&);
    Update(Update&&) noexcept;
    Update& operator=(const Update&);
    Update& operator=(Update&&) noexcept;
 
    void SetOption(options::Upsert);
    void SetOption(const options::ArrayFilters&);
 
    /// @note Available starting in MongoDB 4.2
    void SetOption(const options::Hint&);
 
private:
    friend class storages::mongo::operations::Bulk;
 
    class Impl;
    static constexpr std::size_t kSize =
        compiler::SelectSize()  //
            .For64Bit(56)
            .For32Bit(28);
    static constexpr size_t kAlignment = alignof(void*);
    utils::FastPimpl<Impl, kSize, kAlignment, utils::kStrictMatch> impl_;
};
 
/// Deletes documents as part of bulk operation
class Delete {
public:
    enum class Mode { kSingle, kMulti };
 
    Delete(Mode mode, formats::bson::Document selector);
    ~Delete();
 
    Delete(const Delete&);
    Delete(Delete&&) noexcept;
    Delete& operator=(const Delete&);
    Delete& operator=(Delete&&) noexcept;
 
    /// @note Available starting in MongoDB 4.2
    void SetOption(const options::Hint&);
 
private:
    friend class storages::mongo::operations::Bulk;
 
    class Impl;
    static constexpr std::size_t kSize =
        compiler::SelectSize()  //
            .For64Bit(40)
            .For32Bit(20);
    static constexpr size_t kAlignment = alignof(void*);
    utils::FastPimpl<Impl, kSize, kAlignment, utils::kStrictMatch> impl_;
};
 
}  // namespace storages::mongo::bulk_ops
 
USERVER_NAMESPACE_END