#include <mongocxx/v_noabi/mongocxx/options/range.hpp>

Description

RangeOpts specifies index options for a Queryable Encryption field supporting "range" queries.

Note: min, max, trimFactor, sparsity, and precision must match the values set in the encryptedFields of the destination collection.; For double and decimal128, min, max, and precision must all be set, or all be unset.

Public Member Functions
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > &	max () const
	Gets `RangeOpts.max`.

range &	max (bsoncxx::v_noabi::types::bson_value::view_or_value value)
	Sets `RangeOpts.max`.

const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > &	min () const
	Gets `RangeOpts.min`.

range &	min (bsoncxx::v_noabi::types::bson_value::view_or_value value)
	Sets `RangeOpts.min`.

const stdx::optional< std::int32_t > &	precision () const
	Gets `RangeOpts.precision`.

range &	precision (std::int32_t value)
	Sets `RangeOpts.precision`.

const stdx::optional< std::int64_t > &	sparsity () const
	Gets `RangeOpts.sparsity`.

range &	sparsity (std::int64_t value)
	Sets `RangeOpts.sparsity`.

const stdx::optional< std::int32_t > &	trim_factor () const
	Gets `RangeOpts.trimFactor`.

range &	trim_factor (std::int32_t value)
	Sets `RangeOpts.trimFactor`.

Member Function Documentation

◆ max() [1/2]

const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > & mongocxx::v_noabi::options::range::max ( ) const

Gets RangeOpts.max.

Note: Required if precision is set.

◆ max() [2/2]

range & mongocxx::v_noabi::options::range::max ( bsoncxx::v_noabi::types::bson_value::view_or_value value )

Sets RangeOpts.max.

Note: Required if precision is set.

◆ min() [1/2]

const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > & mongocxx::v_noabi::options::range::min ( ) const

Gets RangeOpts.min.

Note: Required if precision is set.

◆ min() [2/2]

range & mongocxx::v_noabi::options::range::min ( bsoncxx::v_noabi::types::bson_value::view_or_value value )

Sets RangeOpts.min.

Note: Required if precision is set.

◆ precision() [1/2]

const stdx::optional< std::int32_t > & mongocxx::v_noabi::options::range::precision ( ) const

Gets RangeOpts.precision.

Note: May only be set for double or decimal128.

◆ precision() [2/2]

range & mongocxx::v_noabi::options::range::precision ( std::int32_t value )

Sets RangeOpts.precision.

Note: May only be set for double or decimal128.

◆ sparsity() [1/2]

const stdx::optional< std::int64_t > & mongocxx::v_noabi::options::range::sparsity ( ) const

Gets RangeOpts.sparsity.

◆ sparsity() [2/2]

range & mongocxx::v_noabi::options::range::sparsity ( std::int64_t value )

Sets RangeOpts.sparsity.

◆ trim_factor() [1/2]

const stdx::optional< std::int32_t > & mongocxx::v_noabi::options::range::trim_factor ( ) const

Gets RangeOpts.trimFactor.

◆ trim_factor() [2/2]

range & mongocxx::v_noabi::options::range::trim_factor ( std::int32_t value )

Sets RangeOpts.trimFactor.

The documentation for this class was generated from the following file:

mongocxx/v_noabi/mongocxx/options/range.hpp