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 <string>
#include <vector>
 
#include <mongocxx/collection-fwd.hpp>
#include <mongocxx/index_view-fwd.hpp>
 
#include <bsoncxx/document/value.hpp>
#include <bsoncxx/stdx/optional.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 {
   public:
    MONGOCXX_ABI_EXPORT_CDECL() index_view(index_view&&) noexcept;
    MONGOCXX_ABI_EXPORT_CDECL(index_view&) operator=(index_view&&) noexcept;
 
    MONGOCXX_ABI_EXPORT_CDECL() ~index_view();
 
    index_view(const index_view&) = delete;
    MONGOCXX_ABI_EXPORT_CDECL(index_view&) operator=(const index_view&) = delete;
 
    MONGOCXX_ABI_EXPORT_CDECL(cursor) list();
 
    MONGOCXX_ABI_EXPORT_CDECL(cursor) list(const client_session& session);
 
    MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<std::string>)
    create_one(const bsoncxx::v_noabi::document::view_or_value& keys,
               const bsoncxx::v_noabi::document::view_or_value& index_options = {},
               const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<std::string>)
    create_one(const client_session& session,
               const bsoncxx::v_noabi::document::view_or_value& keys,
               const bsoncxx::v_noabi::document::view_or_value& index_options = {},
               const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<std::string>)
    create_one(const index_model& index,
               const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(stdx::optional<std::string>)
    create_one(const client_session& session,
               const index_model& index,
               const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::value)
    create_many(const std::vector<index_model>& indexes,
                const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::document::value)
    create_many(const client_session& session,
                const std::vector<index_model>& indexes,
                const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_one(stdx::string_view name, const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_one(const client_session& session,
             stdx::string_view name,
             const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_one(const bsoncxx::v_noabi::document::view_or_value& keys,
             const bsoncxx::v_noabi::document::view_or_value& index_options = {},
             const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_one(const client_session& session,
             const bsoncxx::v_noabi::document::view_or_value& keys,
             const bsoncxx::v_noabi::document::view_or_value& index_options = {},
             const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_one(const index_model& index, const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_one(const client_session& session,
             const index_model& index,
             const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_all(const options::index_view& options = options::index_view{});
 
    MONGOCXX_ABI_EXPORT_CDECL(void)
    drop_all(const client_session& session,
             const options::index_view& options = options::index_view{});
 
   private:
    friend ::mongocxx::v_noabi::collection;
    class impl;
 
    index_view(void* coll, void* client);
 
    impl& _get_impl();
 
   private:
    std::unique_ptr<impl> _impl;
};
 
}  // namespace v_noabi
}  // namespace mongocxx
 
#include <mongocxx/config/postlude.hpp>