Click or drag to resize

RangeOptions Class

Range options.
Inheritance Hierarchy
SystemObject
  MongoDB.Driver.EncryptionRangeOptions

Namespace:  MongoDB.Driver.Encryption
Assembly:  MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.20.0+ee01960089f28ea1b501690df5fc9f6318a70242
Syntax
public sealed class RangeOptions

The RangeOptions type exposes the following members.

Constructors
  NameDescription
Public methodRangeOptions
Initializes a new instance of the RangeOptions class.
Top
Properties
  NameDescription
Public propertyMax
Maximum value.
Public propertyMin
Minimum value.
Public propertyPrecision
Gets the precision.
Public propertySparsity
Gets the sparsity.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Extension Methods
  NameDescription
Public Extension MethodToBson
Serializes an object to a BSON byte array.
(Defined by BsonExtensionMethods.)
Public Extension MethodToBsonDocument
Serializes an object to a BsonDocument.
(Defined by BsonExtensionMethods.)
Public Extension MethodToJson
Serializes an object to a JSON string.
(Defined by BsonExtensionMethods.)
Top
Remarks
The Range algorithm is experimental only. It is not intended for public use. RangeOpts specifies index options for a Queryable Encryption field supporting "rangePreview" queries. min, max, sparsity, and range must match the values set in the encryptedFields of the destination collection. For double and decimal128, min/max/precision must all be set, or all be unset. RangeOptions only applies when algorithm is "rangePreview".
See Also