client_bulk_write.hpp

Go to the documentation of this file.

// Copyright 2009-present MongoDB, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#pragma once
 
#include <mongocxx/v1/client_bulk_write-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/array/view-fwd.hpp>
#include <bsoncxx/v1/document/view-fwd.hpp>
 
#include <mongocxx/v1/hint-fwd.hpp>
#include <mongocxx/v1/pipeline-fwd.hpp>
#include <mongocxx/v1/write_concern-fwd.hpp>
 
#include <bsoncxx/v1/array/value.hpp>
#include <bsoncxx/v1/detail/macros.hpp>
#include <bsoncxx/v1/document/value.hpp>
#include <bsoncxx/v1/stdx/optional.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
#include <bsoncxx/v1/types/value.hpp>
 
#include <mongocxx/v1/config/export.hpp>
#include <mongocxx/v1/exception.hpp>
 
#include <cstdint>
#include <memory>
 
namespace mongocxx {
namespace v1 {

class client_bulk_write {
   private:
    class impl;
    void* _impl;
 
   public:
    class options;
    class result;
    class MONGOCXX_ABI_EXPORT exception;
 
    class insert_one_options;
    class update_one_options;
    class update_many_options;
    class replace_one_options;
    class delete_one_options;
    class delete_many_options;

    MONGOCXX_ABI_EXPORT_CDECL() ~client_bulk_write();

    MONGOCXX_ABI_EXPORT_CDECL() client_bulk_write(client_bulk_write&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(client_bulk_write&) operator=(client_bulk_write&& other) noexcept;

    client_bulk_write(client_bulk_write const& other) = delete;

    client_bulk_write& operator=(client_bulk_write const& other) = delete;

    MONGOCXX_ABI_EXPORT_CDECL(client_bulk_write&)
    append(bsoncxx::v1::stdx::string_view ns, bsoncxx::v1::document::view document, insert_one_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(client_bulk_write&) append(
        bsoncxx::v1::stdx::string_view ns,
        bsoncxx::v1::document::view filter,
        bsoncxx::v1::document::view update,
        update_one_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(client_bulk_write&) append(
        bsoncxx::v1::stdx::string_view ns,
        bsoncxx::v1::document::view filter,
        v1::pipeline const& update,
        update_one_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(client_bulk_write&) append(
        bsoncxx::v1::stdx::string_view ns,
        bsoncxx::v1::document::view filter,
        bsoncxx::v1::document::view update,
        update_many_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(client_bulk_write&) append(
        bsoncxx::v1::stdx::string_view ns,
        bsoncxx::v1::document::view filter,
        v1::pipeline const& update,
        update_many_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(client_bulk_write&) append(
        bsoncxx::v1::stdx::string_view ns,
        bsoncxx::v1::document::view filter,
        bsoncxx::v1::document::view replacement,
        replace_one_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(client_bulk_write&)
    append(bsoncxx::v1::stdx::string_view ns, bsoncxx::v1::document::view filter, delete_one_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(client_bulk_write&)
    append(bsoncxx::v1::stdx::string_view ns, bsoncxx::v1::document::view filter, delete_many_options const& opts);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<result>) execute(options const& opts);
 
    class internal;
 
   private:
    /* explicit(false) */ client_bulk_write(void* bulk);
};

class client_bulk_write::options {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~options();

    MONGOCXX_ABI_EXPORT_CDECL() options(options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(options&) operator=(options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL() options(options const& other);

    MONGOCXX_ABI_EXPORT_CDECL(options&) operator=(options const& other);

    MONGOCXX_ABI_EXPORT_CDECL() options();

    MONGOCXX_ABI_EXPORT_CDECL(options&) bypass_document_validation(bool v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bool>) bypass_document_validation() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) comment(bsoncxx::v1::types::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::types::view>) comment() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) let(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) let() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) ordered(bool v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bool>) ordered() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) verbose_results(bool v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bool>) verbose_results() const;

    MONGOCXX_ABI_EXPORT_CDECL(options&) write_concern(v1::write_concern v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<v1::write_concern>) write_concern() const;
 
    class internal;
};

class client_bulk_write::result {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~result();

    MONGOCXX_ABI_EXPORT_CDECL() result(result&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(result&) operator=(result&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL() result(result const& other);

    MONGOCXX_ABI_EXPORT_CDECL(result&) operator=(result const& other);

    MONGOCXX_ABI_EXPORT_CDECL(std::int64_t) inserted_count() const;

    MONGOCXX_ABI_EXPORT_CDECL(std::int64_t) upserted_count() const;

    MONGOCXX_ABI_EXPORT_CDECL(std::int64_t) matched_count() const;

    MONGOCXX_ABI_EXPORT_CDECL(std::int64_t) modified_count() const;

    MONGOCXX_ABI_EXPORT_CDECL(std::int64_t) deleted_count() const;

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) insert_results() const;

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) update_results() const;

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) delete_results() const;
 
    class internal;
 
   private:
    /* explicit(false) */ result(void* impl);
};
 
BSONCXX_PRIVATE_WARNINGS_PUSH();
BSONCXX_PRIVATE_WARNINGS_DISABLE(MSVC(4251));
BSONCXX_PRIVATE_WARNINGS_DISABLE(MSVC(4275));

class client_bulk_write::exception : public v1::exception {
   private:
    class impl;
    std::shared_ptr<impl> _impl;
 
   public:
    bsoncxx::v1::document::view MONGOCXX_ABI_CDECL write_errors() const;

    bsoncxx::v1::array::view MONGOCXX_ABI_CDECL write_concern_errors() const;

    bsoncxx::v1::document::view MONGOCXX_ABI_CDECL error_reply() const;

    bsoncxx::v1::stdx::optional<result> MONGOCXX_ABI_CDECL partial_result() const;
 
    class internal;
 
   private:
    MONGOCXX_ABI_NO_EXPORT /* explicit(false) */
    exception(v1::exception e, std::unique_ptr<impl> impl);
 
    MONGOCXX_ABI_NO_EXPORT void key_function() const override;
};
 
BSONCXX_PRIVATE_WARNINGS_POP();
 
BSONCXX_PRIVATE_WARNINGS_PUSH();
BSONCXX_PRIVATE_WARNINGS_DISABLE(Clang("-Wunused-private-field"));

class client_bulk_write::insert_one_options {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~insert_one_options();

    MONGOCXX_ABI_EXPORT_CDECL() insert_one_options(insert_one_options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(insert_one_options&) operator=(insert_one_options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL() insert_one_options(insert_one_options const& other);

    MONGOCXX_ABI_EXPORT_CDECL(insert_one_options&) operator=(insert_one_options const& other);

    MONGOCXX_ABI_EXPORT_CDECL() insert_one_options();
};
 
BSONCXX_PRIVATE_WARNINGS_POP();

class client_bulk_write::update_one_options {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~update_one_options();

    MONGOCXX_ABI_EXPORT_CDECL() update_one_options(update_one_options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(update_one_options&) operator=(update_one_options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL() update_one_options(update_one_options const& other);

    MONGOCXX_ABI_EXPORT_CDECL(update_one_options&) operator=(update_one_options const& other);

    MONGOCXX_ABI_EXPORT_CDECL() update_one_options();

    MONGOCXX_ABI_EXPORT_CDECL(update_one_options&) array_filters(bsoncxx::v1::array::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::array::view>) array_filters() const;

    MONGOCXX_ABI_EXPORT_CDECL(update_one_options&) collation(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) collation() const;

    MONGOCXX_ABI_EXPORT_CDECL(update_one_options&) hint(v1::hint v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<v1::hint>) hint() const;

    MONGOCXX_ABI_EXPORT_CDECL(update_one_options&) sort(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) sort() const;

    MONGOCXX_ABI_EXPORT_CDECL(update_one_options&) upsert(bool v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bool>) upsert() const;
 
    class internal;
};

class client_bulk_write::update_many_options {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~update_many_options();

    MONGOCXX_ABI_EXPORT_CDECL() update_many_options(update_many_options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(update_many_options&) operator=(update_many_options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL() update_many_options(update_many_options const& other);

    MONGOCXX_ABI_EXPORT_CDECL(update_many_options&) operator=(update_many_options const& other);

    MONGOCXX_ABI_EXPORT_CDECL() update_many_options();

    MONGOCXX_ABI_EXPORT_CDECL(update_many_options&) array_filters(bsoncxx::v1::array::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::array::view>) array_filters() const;

    MONGOCXX_ABI_EXPORT_CDECL(update_many_options&) collation(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) collation() const;

    MONGOCXX_ABI_EXPORT_CDECL(update_many_options&) hint(v1::hint v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<v1::hint>) hint() const;

    MONGOCXX_ABI_EXPORT_CDECL(update_many_options&) upsert(bool v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bool>) upsert() const;
 
    class internal;
};

class client_bulk_write::replace_one_options {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~replace_one_options();

    MONGOCXX_ABI_EXPORT_CDECL() replace_one_options(replace_one_options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(replace_one_options&) operator=(replace_one_options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL() replace_one_options(replace_one_options const& other);

    MONGOCXX_ABI_EXPORT_CDECL(replace_one_options&) operator=(replace_one_options const& other);

    MONGOCXX_ABI_EXPORT_CDECL() replace_one_options();

    MONGOCXX_ABI_EXPORT_CDECL(replace_one_options&) collation(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) collation() const;

    MONGOCXX_ABI_EXPORT_CDECL(replace_one_options&) hint(v1::hint v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<v1::hint>) hint() const;

    MONGOCXX_ABI_EXPORT_CDECL(replace_one_options&) sort(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) sort() const;

    MONGOCXX_ABI_EXPORT_CDECL(replace_one_options&) upsert(bool v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bool>) upsert() const;
 
    class internal;
};

class client_bulk_write::delete_one_options {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~delete_one_options();

    MONGOCXX_ABI_EXPORT_CDECL() delete_one_options(delete_one_options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(delete_one_options&) operator=(delete_one_options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL() delete_one_options(delete_one_options const& other);

    MONGOCXX_ABI_EXPORT_CDECL(delete_one_options&) operator=(delete_one_options const& other);

    MONGOCXX_ABI_EXPORT_CDECL() delete_one_options();

    MONGOCXX_ABI_EXPORT_CDECL(delete_one_options&) collation(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) collation() const;

    MONGOCXX_ABI_EXPORT_CDECL(delete_one_options&) hint(v1::hint v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<v1::hint>) hint() const;
 
    class internal;
};

class client_bulk_write::delete_many_options {
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~delete_many_options();

    MONGOCXX_ABI_EXPORT_CDECL() delete_many_options(delete_many_options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL(delete_many_options&) operator=(delete_many_options&& other) noexcept;

    MONGOCXX_ABI_EXPORT_CDECL() delete_many_options(delete_many_options const& other);

    MONGOCXX_ABI_EXPORT_CDECL(delete_many_options&) operator=(delete_many_options const& other);

    MONGOCXX_ABI_EXPORT_CDECL() delete_many_options();

    MONGOCXX_ABI_EXPORT_CDECL(delete_many_options&) collation(bsoncxx::v1::document::value v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<bsoncxx::v1::document::view>) collation() const;

    MONGOCXX_ABI_EXPORT_CDECL(delete_many_options&) hint(v1::hint v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<v1::hint>) hint() const;
 
    class internal;
};
 
} // namespace v1
} // namespace mongocxx
 
#include <mongocxx/v1/detail/postlude.hpp>