MongoDB C++ Driver  mongocxx-3.10.2
Public Member Functions | List of all members
mongocxx::v_noabi::options::range Class Reference

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

#include <range.hpp>

Public Member Functions

rangemin (bsoncxx::v_noabi::types::bson_value::view_or_value value)
 Sets RangeOpts.min. More...
 
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > & min () const
 Gets RangeOpts.min. More...
 
rangemax (bsoncxx::v_noabi::types::bson_value::view_or_value value)
 Sets RangeOpts.max. More...
 
const stdx::optional< bsoncxx::v_noabi::types::bson_value::view_or_value > & max () const
 Gets RangeOpts.max. More...
 
rangesparsity (std::int64_t value)
 Sets RangeOpts.sparsity.
 
const stdx::optional< std::int64_t > & sparsity () const
 Gets RangeOpts.sparsity.
 
rangeprecision (std::int32_t value)
 Sets RangeOpts.precision. More...
 
const stdx::optional< std::int32_t > & precision () const
 Gets RangeOpts.precision. More...
 

Detailed Description

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

Note
min, max, 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.
Warning
The Range algorithm is experimental only. It is not intended for public use. It is subject to breaking changes.

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.

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