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

Copy

public sealed class RangeOptions

Public NotInheritable Class RangeOptions

[<SealedAttribute>]
type RangeOptions =  class end

The RangeOptions type exposes the following members.

Constructors

	Name	Description
	RangeOptions	Initializes a new instance of the RangeOptions class.

Top

Properties

	Name	Description
	Max	Maximum value.
	Min	Minimum value.
	Precision	Gets the precision.
	Sparsity	Gets the sparsity.

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Extension Methods

	Name	Description
	ToBson	Serializes an object to a BSON byte array. (Defined by BsonExtensionMethods.)
	ToBsonDocument	Serializes an object to a BsonDocument. (Defined by BsonExtensionMethods.)
	ToJson	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".

Reference

MongoDB.Driver.Encryption Namespace