index_view.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/index_view-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/indexes.hpp> // IWYU pragma: export
 
#include <string>
#include <utility>
#include <vector>
 
#include <mongocxx/collection-fwd.hpp> // IWYU pragma: keep: backward compatibility, to be removed.
 
#include <bsoncxx/document/value.hpp>
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
#include <bsoncxx/stdx/string_view.hpp>
 
#include <mongocxx/client_session.hpp>
#include <mongocxx/cursor.hpp>
#include <mongocxx/index_model.hpp>
#include <mongocxx/options/index_view.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {

class index_view {
   private:
    v1::indexes _indexes;
 
   public:
    index_view(index_view&& other) noexcept = default;
    index_view& operator=(index_view&& other) noexcept = default;
 
    ~index_view() = default;
 
    index_view(index_view const& other) = delete;
    index_view& operator=(index_view const& other) = delete;

    /* explicit(false) */ index_view(v1::indexes indexes) : _indexes{std::move(indexes)} {}

    explicit operator v1::indexes() && {
        return std::move(_indexes);
    }

    explicit operator v1::indexes() const& {
        return _indexes;
    }

    MONGOCXX_ABI_EXPORT_CDECL(v_noabi::cursor) list();

    MONGOCXX_ABI_EXPORT_CDECL(v_noabi::cursor) list(v_noabi::client_session const& session);

    bsoncxx::v_noabi::stdx::optional<std::string> create_one(
        bsoncxx::v_noabi::document::view_or_value const& keys,
        bsoncxx::v_noabi::document::view_or_value const& index_options = {},
        v_noabi::options::index_view const& options = {}) {
        return this->create_one(v_noabi::index_model{keys, index_options}, options);
    }

    bsoncxx::v_noabi::stdx::optional<std::string> create_one(
        v_noabi::client_session const& session,
        bsoncxx::v_noabi::document::view_or_value const& keys,
        bsoncxx::v_noabi::document::view_or_value const& index_options = {},
        v_noabi::options::index_view const& options = {}) {
        return this->create_one(session, v_noabi::index_model{keys, index_options}, options);
    }

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::string>)
    create_one(v_noabi::index_model const& index, v_noabi::options::index_view const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::string>)
    create_one(
        v_noabi::client_session const& session,
        index_model const& index,
        v_noabi::options::index_view const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::value)
    create_many(std::vector<v_noabi::index_model> const& indexes, v_noabi::options::index_view const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::value)
    create_many(
        v_noabi::client_session const& session,
        std::vector<v_noabi::index_model> const& indexes,
        v_noabi::options::index_view const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_one(bsoncxx::v_noabi::stdx::string_view name, v_noabi::options::index_view const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_one(
        v_noabi::client_session const& session,
        bsoncxx::v_noabi::stdx::string_view name,
        v_noabi::options::index_view const& options = {});

    void drop_one(
        bsoncxx::v_noabi::document::view_or_value const& keys,
        bsoncxx::v_noabi::document::view_or_value const& index_options = {},
        v_noabi::options::index_view const& options = {}) {
        return this->drop_one(v_noabi::index_model{std::move(keys), std::move(index_options)}, options);
    }

    void drop_one(
        v_noabi::client_session const& session,
        bsoncxx::v_noabi::document::view_or_value const& keys,
        bsoncxx::v_noabi::document::view_or_value const& index_options = {},
        v_noabi::options::index_view const& options = {}) {
        return this->drop_one(session, v_noabi::index_model{std::move(keys), std::move(index_options)}, options);
    }

    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_one(v_noabi::index_model const& index, v_noabi::options::index_view const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_one(client_session const& session, index_model const& index, v_noabi::options::index_view const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_all(options::index_view const& options = {});

    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_all(v_noabi::client_session const& session, v_noabi::options::index_view const& options = {});
};
 
} // namespace v_noabi
} // namespace mongocxx
 
namespace mongocxx {
namespace v_noabi {

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

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