index.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 <chrono>
#include <memory>
 
#include <mongocxx/collection-fwd.hpp>
#include <mongocxx/options/index-fwd.hpp>
 
#include <bsoncxx/document/value.hpp>
#include <bsoncxx/document/view.hpp>
#include <bsoncxx/document/view_or_value.hpp>
#include <bsoncxx/stdx/optional.hpp>
#include <bsoncxx/string/view_or_value.hpp>
 
#include <bsoncxx/config/prelude.hpp>
 
#include <mongocxx/config/prelude.hpp>
 
namespace mongocxx {
namespace v_noabi {
namespace options {
 
class index {
   public:
    BSONCXX_PRIVATE_WARNINGS_PUSH();
    BSONCXX_PRIVATE_WARNINGS_DISABLE(MSVC(4251));
    BSONCXX_PRIVATE_WARNINGS_DISABLE(MSVC(4275));
 
    class MONGOCXX_ABI_EXPORT base_storage_options {
       public:
        virtual ~base_storage_options();
 
        base_storage_options(base_storage_options&&) = default;
        base_storage_options& operator=(base_storage_options&&) = default;
        base_storage_options(base_storage_options const&) = default;
        base_storage_options& operator=(base_storage_options const&) = default;
 
        base_storage_options() = default;
 
       private:
        friend ::mongocxx::v_noabi::options::index;
 
        virtual int type() const = 0;
    };
 
    class MONGOCXX_ABI_EXPORT wiredtiger_storage_options final : public base_storage_options {
       public:
        ~wiredtiger_storage_options() override;
 
        wiredtiger_storage_options(wiredtiger_storage_options&&) = default;
        wiredtiger_storage_options& operator=(wiredtiger_storage_options&&) = default;
        wiredtiger_storage_options(wiredtiger_storage_options const&) = default;
        wiredtiger_storage_options& operator=(wiredtiger_storage_options const&) = default;
 
        wiredtiger_storage_options() = default;
 
        void config_string(bsoncxx::v_noabi::string::view_or_value config_string);
 
        bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value> const& config_string() const;
 
       private:
        friend ::mongocxx::v_noabi::collection;
 
        MONGOCXX_ABI_NO_EXPORT int type() const override;
 
        bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value> _config_string;
    };
 
    BSONCXX_PRIVATE_WARNINGS_POP();
 
    MONGOCXX_ABI_EXPORT_CDECL() index();
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) background(bool background);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool> const&) background() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) unique(bool unique);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool> const&) unique() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) hidden(bool hidden);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool> const&) hidden() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) name(bsoncxx::v_noabi::string::view_or_value name);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value> const&)
    name() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) collation(bsoncxx::v_noabi::document::view collation);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> const&)
    collation() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) sparse(bool sparse);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bool> const&) sparse() const;
 
    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL(index&) storage_options(
        std::unique_ptr<base_storage_options> storage_options);
 
    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL(index&) storage_options(
        std::unique_ptr<wiredtiger_storage_options> storage_options);
 
    MONGOCXX_ABI_EXPORT_CDECL(index&)
    storage_engine(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> storage_engine);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> const&)
    storage_engine() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) expire_after(std::chrono::seconds seconds);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::chrono::seconds> const&)
    expire_after() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) version(std::int32_t v);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::int32_t> const&)
    version() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) weights(bsoncxx::v_noabi::document::view weights);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> const&)
    weights() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&)
    default_language(bsoncxx::v_noabi::string::view_or_value default_language);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value> const&)
    default_language() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&)
    language_override(bsoncxx::v_noabi::string::view_or_value language_override);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value> const&)
    language_override() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&)
    partial_filter_expression(bsoncxx::v_noabi::document::view partial_filter_expression);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> const&)
    partial_filter_expression() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) twod_sphere_version(std::uint8_t twod_sphere_version);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::uint8_t> const&)
    twod_sphere_version() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) twod_bits_precision(std::uint8_t twod_bits_precision);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<std::uint8_t> const&)
    twod_bits_precision() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) twod_location_min(double twod_location_min);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<double> const&)
    twod_location_min() const;
 
    MONGOCXX_ABI_EXPORT_CDECL(index&) twod_location_max(double twod_location_max);
 
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<double> const&)
    twod_location_max() const;
 
    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL(index&) haystack_bucket_size(double haystack_bucket_size);
    MONGOCXX_ABI_EXPORT_CDECL(index&) haystack_bucket_size_deprecated(double haystack_bucket_size);
 
    MONGOCXX_DEPRECATED MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<double> const&)
    haystack_bucket_size() const;
    MONGOCXX_ABI_EXPORT_CDECL(bsoncxx::v_noabi::stdx::optional<double> const&)
    haystack_bucket_size_deprecated() const;
 
    MONGOCXX_ABI_EXPORT_CDECL() operator bsoncxx::v_noabi::document::view_or_value();
 
   private:
    friend ::mongocxx::v_noabi::collection;
 
    bsoncxx::v_noabi::stdx::optional<bool> _background;
    bsoncxx::v_noabi::stdx::optional<bool> _unique;
    bsoncxx::v_noabi::stdx::optional<bool> _hidden;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value> _name;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> _collation;
    bsoncxx::v_noabi::stdx::optional<bool> _sparse;
    std::unique_ptr<base_storage_options> _storage_options;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> _storage_engine;
    bsoncxx::v_noabi::stdx::optional<std::chrono::seconds> _expire_after;
    bsoncxx::v_noabi::stdx::optional<std::int32_t> _version;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> _weights;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value> _default_language;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::string::view_or_value> _language_override;
    bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view> _partial_filter_expression;
    bsoncxx::v_noabi::stdx::optional<std::uint8_t> _twod_sphere_version;
    bsoncxx::v_noabi::stdx::optional<std::uint8_t> _twod_bits_precision;
    bsoncxx::v_noabi::stdx::optional<double> _twod_location_min;
    bsoncxx::v_noabi::stdx::optional<double> _twod_location_max;
    bsoncxx::v_noabi::stdx::optional<double> _haystack_bucket_size;
 
    //
    // Return the current storage_options setting.
    //
    std::unique_ptr<base_storage_options> const& storage_options() const;
};
 
} // namespace options
} // namespace v_noabi
} // namespace mongocxx
 
#include <bsoncxx/config/postlude.hpp>
 
#include <mongocxx/config/postlude.hpp>