Scroll to navigation

MONGOC_CLIENT_ENCRYPTION_ENCRYPT_RANGE_OPTS_SET_MAX(3) libmongoc MONGOC_CLIENT_ENCRYPTION_ENCRYPT_RANGE_OPTS_SET_MAX(3)

SYNOPSIS

void
mongoc_client_encryption_encrypt_range_opts_set_max (


     mongoc_client_encryption_encrypt_range_opts_t *range_opts,


     const bson_value_t *max);


IMPORTANT:

The Range algorithm is experimental only and not intended for public use. It is subject to breaking changes. This API is part of the experimental Queryable Encryption API and may be subject to breaking changes in future releases.


New in version 1.24.0.

Sets the maximum value of the range for explicit encryption. Only applies when the algorithm set by mongoc_client_encryption_encrypt_opts_set_algorithm() is "RangePreview". It is an error to set maximum when algorithm is not "RangePreview".

The maximum must match the value set in the encryptedFields of the destination collection. It is an error to set a different value.

For double and decimal128 fields, max/max/precision must all be set, or all be unset.

PARAMETERS

  • range_opts: A mongoc_client_encryption_encrypt_range_opts_t
  • max: The maximum bson value of the range.

SEE ALSO:

mongoc_client_encryption_encrypt_range_opts_set_precision()
mongoc_client_encryption_encrypt_range_opts_set_min()
mongoc_client_encryption_encrypt_range_opts_t



AUTHOR

MongoDB, Inc

COPYRIGHT

2017-present, MongoDB, Inc

February 25, 2024 1.26.0