index.hpp

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