database.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/database-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/document/value-fwd.hpp>
 
#include <mongocxx/v1/client_session-fwd.hpp>
#include <mongocxx/v1/collection-fwd.hpp>
#include <mongocxx/v1/cursor-fwd.hpp>
#include <mongocxx/v1/pipeline-fwd.hpp>
#include <mongocxx/v1/read_concern-fwd.hpp>
#include <mongocxx/v1/read_preference-fwd.hpp>
 
#include <bsoncxx/v1/document/view.hpp>
#include <bsoncxx/v1/stdx/optional.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
 
#include <mongocxx/v1/aggregate_options.hpp>
#include <mongocxx/v1/change_stream.hpp>
#include <mongocxx/v1/config/export.hpp>
#include <mongocxx/v1/gridfs/bucket.hpp>
#include <mongocxx/v1/write_concern.hpp>
 
#include <cstdint>
#include <string>
#include <system_error>
#include <vector>
 
namespace mongocxx {
namespace v1 {

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

    MONGOCXX_ABI_EXPORT_CDECL() database(database&& other) noexcept;

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

    MONGOCXX_ABI_EXPORT_CDECL() database(database const& other);

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

    MONGOCXX_ABI_EXPORT_CDECL() database();

    explicit MONGOCXX_ABI_EXPORT_CDECL() operator bool() const;

    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor) aggregate(
        v1::pipeline const& pipeline,
        v1::aggregate_options const& opts = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor)
    aggregate(v1::client_session const& session, v1::pipeline const& pipeline, v1::aggregate_options const& opts = {});

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::value) run_command(bsoncxx::v1::document::view command);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::value) run_command(
        v1::client_session const& session,
        bsoncxx::v1::document::view command);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::value) run_command(
        bsoncxx::v1::document::view command,
        std::uint32_t server_id);

    MONGOCXX_ABI_EXPORT_CDECL(v1::collection) create_collection(
        bsoncxx::v1::stdx::string_view name,
        bsoncxx::v1::document::view opts = {},
        bsoncxx::v1::stdx::optional<v1::write_concern> const& wc = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::collection) create_collection(
        v1::client_session const& session,
        bsoncxx::v1::stdx::string_view name,
        bsoncxx::v1::document::view opts = {},
        bsoncxx::v1::stdx::optional<v1::write_concern> const& wc = {});

    MONGOCXX_ABI_EXPORT_CDECL(void) drop(bsoncxx::v1::stdx::optional<v1::write_concern> const& wc = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(void) drop(
        v1::client_session const& session,
        bsoncxx::v1::stdx::optional<v1::write_concern> const& wc = {});

    MONGOCXX_ABI_EXPORT_CDECL(bool) has_collection(bsoncxx::v1::stdx::string_view name);

    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor) list_collections(bsoncxx::v1::document::view filter = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor) list_collections(
        v1::client_session const& session,
        bsoncxx::v1::document::view filter = {});

    MONGOCXX_ABI_EXPORT_CDECL(std::vector<std::string>) list_collection_names(bsoncxx::v1::document::view filter = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(std::vector<std::string>) list_collection_names(
        v1::client_session const& session,
        bsoncxx::v1::document::view filter = {});

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::string_view) name() const;

    MONGOCXX_ABI_EXPORT_CDECL(void) read_concern(v1::read_concern const& rc);

    MONGOCXX_ABI_EXPORT_CDECL(v1::read_concern) read_concern() const;

    MONGOCXX_ABI_EXPORT_CDECL(void) read_preference(v1::read_preference const& rp);

    MONGOCXX_ABI_EXPORT_CDECL(v1::read_preference) read_preference() const;

    MONGOCXX_ABI_EXPORT_CDECL(void) write_concern(v1::write_concern const& wc);

    MONGOCXX_ABI_EXPORT_CDECL(v1::write_concern) write_concern() const;

    MONGOCXX_ABI_EXPORT_CDECL(v1::collection) collection(bsoncxx::v1::stdx::string_view name) const;

    MONGOCXX_ABI_EXPORT_CDECL(v1::collection) operator[](bsoncxx::v1::stdx::string_view name) const;

    MONGOCXX_ABI_EXPORT_CDECL(v1::gridfs::bucket) gridfs_bucket(v1::gridfs::bucket::options const& opts = {}) const;

    MONGOCXX_ABI_EXPORT_CDECL(v1::change_stream) watch(v1::change_stream::options const& opts = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::change_stream) watch(
        v1::client_session const& session,
        v1::change_stream::options const& opts = {});

    MONGOCXX_ABI_EXPORT_CDECL(v1::change_stream) watch(
        v1::pipeline const& pipeline,
        v1::change_stream::options const& opts = {});
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::change_stream)
    watch(v1::client_session const& session, v1::pipeline const& pipeline, v1::change_stream::options const& opts = {});

    enum class errc {
        zero,                    
        invalid_collection_name, 
    };

    static MONGOCXX_ABI_EXPORT_CDECL(std::error_category const&) error_category();

    friend std::error_code make_error_code(errc v) {
        return {static_cast<int>(v), error_category()};
    }
 
    class internal;
 
   private:
    /* explicit(false) */ database(void* impl);
};
 
} // namespace v1
} // namespace mongocxx
 
namespace std {
 
template <>
struct is_error_code_enum<mongocxx::v1::database::errc> : true_type {};
 
} // namespace std
 
#include <mongocxx/v1/detail/postlude.hpp>