search_indexes.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/search_indexes-fwd.hpp> // IWYU pragma: export
 
//
 
#include <mongocxx/v1/detail/prelude.hpp>
 
#include <bsoncxx/v1/document/value-fwd.hpp>
#include <bsoncxx/v1/document/view-fwd.hpp>
 
#include <mongocxx/v1/client_session-fwd.hpp>
#include <mongocxx/v1/cursor-fwd.hpp>
 
#include <bsoncxx/v1/stdx/optional.hpp>
#include <bsoncxx/v1/stdx/string_view.hpp>
 
#include <mongocxx/v1/aggregate_options.hpp>
#include <mongocxx/v1/config/export.hpp>
 
#include <string>
#include <vector>
 
namespace mongocxx {
namespace v1 {

class search_indexes {
   private:
    class impl;
    void* _impl;
 
   public:
    class model;

    MONGOCXX_ABI_EXPORT_CDECL() ~search_indexes();

    MONGOCXX_ABI_EXPORT_CDECL() search_indexes(search_indexes&& other) noexcept;

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

    MONGOCXX_ABI_EXPORT_CDECL() search_indexes(search_indexes const& other);

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

    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor) list(v1::aggregate_options const& opts = {});

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

    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor) list(
        bsoncxx::v1::stdx::string_view name,
        v1::aggregate_options const& opts = {});

    MONGOCXX_ABI_EXPORT_CDECL(v1::cursor)
    list(
        v1::client_session const& session,
        bsoncxx::v1::stdx::string_view name,
        v1::aggregate_options const& opts = {});

    MONGOCXX_ABI_EXPORT_CDECL(std::string) create_one(bsoncxx::v1::document::view definition);

    MONGOCXX_ABI_EXPORT_CDECL(std::string) create_one(
        v1::client_session const& session,
        bsoncxx::v1::document::view definition);

    MONGOCXX_ABI_EXPORT_CDECL(std::string) create_one(
        bsoncxx::v1::stdx::string_view name,
        bsoncxx::v1::document::view definition);

    MONGOCXX_ABI_EXPORT_CDECL(std::string)
    create_one(
        v1::client_session const& session,
        bsoncxx::v1::stdx::string_view name,
        bsoncxx::v1::document::view definition);

    MONGOCXX_ABI_EXPORT_CDECL(std::string) create_one(model const& index);

    MONGOCXX_ABI_EXPORT_CDECL(std::string) create_one(v1::client_session const& session, model const& index);

    MONGOCXX_ABI_EXPORT_CDECL(std::vector<std::string>) create_many(std::vector<model> const& indexes);

    MONGOCXX_ABI_EXPORT_CDECL(std::vector<std::string>) create_many(
        v1::client_session const& session,
        std::vector<model> const& indexes);

    MONGOCXX_ABI_EXPORT_CDECL(void) drop_one(bsoncxx::v1::stdx::string_view name);

    MONGOCXX_ABI_EXPORT_CDECL(void) drop_one(v1::client_session const& session, bsoncxx::v1::stdx::string_view name);

    MONGOCXX_ABI_EXPORT_CDECL(void) update_one(
        bsoncxx::v1::stdx::string_view name,
        bsoncxx::v1::document::view definition);

    MONGOCXX_ABI_EXPORT_CDECL(void)
    update_one(
        v1::client_session const& session,
        bsoncxx::v1::stdx::string_view name,
        bsoncxx::v1::document::view definition);
 
    class internal;
 
   private:
    /* explicit(false) */ search_indexes(void* impl);
};

class search_indexes::model {
    // This class implements both `SearchIndexModel` and `SearchIndexOptions` ("Index View API"):
    //  - https://specifications.readthedocs.io/en/latest/index-management/index-management/
 
   private:
    class impl;
    void* _impl;
 
   public:
    MONGOCXX_ABI_EXPORT_CDECL() ~model();

    MONGOCXX_ABI_EXPORT_CDECL() model(model&& other) noexcept;

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

    MONGOCXX_ABI_EXPORT_CDECL() model(model const& other);

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

    MONGOCXX_ABI_EXPORT_CDECL()
    model(std::string name, bsoncxx::v1::document::value definition);

    MONGOCXX_ABI_EXPORT_CDECL()
    model(bsoncxx::v1::document::value definition);

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

    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v1::document::view) definition() const;

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

    MONGOCXX_ABI_EXPORT_CDECL(model&) type(std::string type);
 
    class internal;
};
 
} // namespace v1
} // namespace mongocxx
 
#include <mongocxx/v1/detail/postlude.hpp>