client.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-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/document/view-fwd.hpp>
 
#include <mongocxx/v1/apm-fwd.hpp>
#include <mongocxx/v1/auto_encryption_options-fwd.hpp>
#include <mongocxx/v1/client_bulk_write-fwd.hpp>
#include <mongocxx/v1/cursor-fwd.hpp>
#include <mongocxx/v1/database-fwd.hpp>
#include <mongocxx/v1/pipeline-fwd.hpp>
#include <mongocxx/v1/server_api-fwd.hpp>
#include <mongocxx/v1/tls-fwd.hpp>
#include <mongocxx/v1/uri-fwd.hpp>
 
#include <bsoncxx/v1/stdx/optional.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
 
#include <mongocxx/v1/change_stream.hpp>
#include <mongocxx/v1/client_session.hpp>
#include <mongocxx/v1/config/export.hpp>
#include <mongocxx/v1/oidc_callback.hpp>
 
#include <string>
#include <system_error>
#include <type_traits>
#include <vector>
 
namespace mongocxx {
namespace v1 {

class client {
   private:
    class impl;
    void* _impl;
 
   public:
    class options;

    MONGOCXX_ABI_EXPORT_CDECL() ~client();

    MONGOCXX_ABI_EXPORT_CDECL() client(client&& other) noexcept;

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

    client(client const& other) = delete;

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

    MONGOCXX_ABI_EXPORT_CDECL() client(v1::uri uri, options opts);
 
    /* explicit(false) */ MONGOCXX_ABI_EXPORT_CDECL() client(v1::uri uri);

    MONGOCXX_ABI_EXPORT_CDECL() client();

    explicit MONGOCXX_ABI_EXPORT_CDECL() operator bool() const;

    MONGOCXX_ABI_EXPORT_CDECL(v1::uri) uri() const;

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

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

    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor) list_databases();
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor) list_databases(v1::client_session const& session);
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor) list_databases(bsoncxx::v1::document::view opts);
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor) list_databases(
        v1::client_session const& session,
        bsoncxx::v1::document::view opts);

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

    MONGOCXX_ABI_EXPORT_CDECL(v1::client_session) start_session(v1::client_session::options const& opts);
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::client_session) start_session();

    MONGOCXX_ABI_EXPORT_CDECL(v1::change_stream) watch(v1::change_stream::options const& opts);
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::change_stream) watch();
 
    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::client_session const& session);

    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);
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::change_stream) watch(v1::pipeline const& pipeline);
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::change_stream) watch(v1::client_session const& session, v1::pipeline const& pipeline);

    MONGOCXX_ABI_EXPORT_CDECL(v1::client_bulk_write) create_bulk_write();
 
    MONGOCXX_ABI_EXPORT_CDECL(v1::client_bulk_write) create_bulk_write(v1::client_session& session);

    MONGOCXX_ABI_EXPORT_CDECL(void)
    append_metadata(
        bsoncxx::v1::stdx::string_view name,
        bsoncxx::v1::stdx::optional<bsoncxx::v1::stdx::string_view> version = {},
        bsoncxx::v1::stdx::optional<bsoncxx::v1::stdx::string_view> platform = {});

    MONGOCXX_ABI_EXPORT_CDECL(void) reset();

    enum class errc {
        zero,                    
        tls_not_enabled,         
        tls_not_supported,       
        append_metadata_failure, 
        invalid_database_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) */ client(void* impl);
};

class client::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&) tls_opts(v1::tls v);

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

    MONGOCXX_ABI_EXPORT_CDECL(options&) auto_encryption_opts(v1::auto_encryption_options v);

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

    MONGOCXX_ABI_EXPORT_CDECL(options&) apm_opts(v1::apm v);

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

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

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

    MONGOCXX_ABI_EXPORT_CDECL(options&) server_api_opts(v1::server_api v);

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::stdx::optional<v1::server_api>) server_api_opts() const;
 
    class internal;
};
 
} // namespace v1
} // namespace mongocxx
 
namespace std {
 
template <>
struct is_error_code_enum<mongocxx::v1::client::errc> : true_type {};
 
} // namespace std
 
#include <mongocxx/v1/detail/postlude.hpp>