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/client-fwd.hpp> // IWYU pragma: export
 
//
 
#include <bsoncxx/v1/stdx/optional.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
 
#include <mongocxx/v1/client.hpp> // IWYU pragma: export
 
#include <list>   // IWYU pragma: keep: backward compatibility, to be removed.
#include <memory> // IWYU pragma: keep: backward compatibility, to be removed.
#include <string>
#include <utility>
#include <vector>
 
#include <mongocxx/change_stream-fwd.hpp>
#include <mongocxx/client_bulk_write-fwd.hpp> // IWYU pragma: export
#include <mongocxx/client_session-fwd.hpp>
#include <mongocxx/collection-fwd.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
#include <mongocxx/cursor-fwd.hpp>
#include <mongocxx/database-fwd.hpp>
#include <mongocxx/options/auto_encryption-fwd.hpp>   // IWYU pragma: keep: backward compatibility, to be removed.
#include <mongocxx/options/client_encryption-fwd.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
#include <mongocxx/pipeline-fwd.hpp>
#include <mongocxx/pool-fwd.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
 
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/string/view_or_value.hpp>
 
#include <mongocxx/client_session.hpp>
#include <mongocxx/database.hpp>
#include <mongocxx/options/change_stream.hpp>
#include <mongocxx/options/client.hpp>
#include <mongocxx/options/client_encryption.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
#include <mongocxx/options/client_session.hpp>
#include <mongocxx/read_concern.hpp>
#include <mongocxx/read_preference.hpp>
#include <mongocxx/uri.hpp>
#include <mongocxx/write_concern.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {

class client {
   private:
    v1::client _client;
 
   public:
    client() noexcept {}

    /* explicit(false) */ client(v1::client client) : _client{std::move(client)} {}

    explicit operator v1::client() && {
        return std::move(_client);
    }

    explicit operator v1::client() const& = delete;

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE() client(
        v_noabi::uri const& mongodb_uri,
        options::client const& options = options::client());

    explicit operator bool() const noexcept {
        return _client.operator bool();
    }

    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(void) read_concern(v_noabi::read_concern rc);
 
    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(void) read_concern_deprecated(v_noabi::read_concern rc);

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::read_concern) read_concern() const;

    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(void) read_preference(v_noabi::read_preference rp);
 
    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(void)
    read_preference_deprecated(v_noabi::read_preference rp);

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::read_preference) read_preference() const;

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::uri) uri() const;

    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(void) write_concern(v_noabi::write_concern wc);
 
    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(void) write_concern_deprecated(v_noabi::write_concern wc);

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::write_concern) write_concern() const;

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::database)
    database(bsoncxx::v_noabi::string::view_or_value name) const&;
 
    v_noabi::database database(bsoncxx::v_noabi::string::view_or_value name) const&& = delete;

    v_noabi::database operator[](bsoncxx::v_noabi::string::view_or_value name) const& {
        return database(name);
    }
 
    v_noabi::database operator[](bsoncxx::v_noabi::string::view_or_value name) const&& = delete;

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::cursor) list_databases() const;

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::cursor) list_databases(v_noabi::client_session const& session) const;

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::cursor)
    list_databases(bsoncxx::v_noabi::document::view_or_value const opts) const;

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::cursor)
    list_databases(v_noabi::client_session const& session, bsoncxx::v_noabi::document::view_or_value const opts) const;

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(std::vector<std::string>)
    list_database_names(bsoncxx::v_noabi::document::view_or_value const filter = {}) const;

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(std::vector<std::string>)
    list_database_names(
        v_noabi::client_session const& session,
        bsoncxx::v_noabi::document::view_or_value const filter = {}) const;

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::client_session)
    start_session(v_noabi::options::client_session const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::change_stream) watch(
        v_noabi::options::change_stream const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::change_stream)
    watch(v_noabi::client_session const& session, v_noabi::options::change_stream const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::change_stream)
    watch(v_noabi::pipeline const& pipe, v_noabi::options::change_stream const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(v_noabi::change_stream)
    watch(
        v_noabi::client_session const& session,
        v_noabi::pipeline const& pipe,
        v_noabi::options::change_stream const& options = {});

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

    MONGOCXX_ABI_EXPORT_CDECL_UNSTABLE(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_UNSTABLE(void) reset();
 
    class internal;
 
   private:
    v_noabi::change_stream _watch(
        v_noabi::client_session const* session,
        v_noabi::pipeline const& pipe,
        v_noabi::options::change_stream const& options);
};
 
} // namespace v_noabi
} // namespace mongocxx
 
namespace mongocxx {
namespace v_noabi {

inline v_noabi::client from_v1(v1::client v) {
    return {std::move(v)};
}

inline v1::client to_v1(v_noabi::client v) {
    return v1::client{std::move(v)};
}
 
} // namespace v_noabi
} // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>