mongoc_client_encryption_encrypt_range_opts_set_sparsity()#

Synopsis#

void
mongoc_client_encryption_encrypt_range_opts_set_sparsity (
     mongoc_client_encryption_encrypt_range_opts_t *range_opts, int64_t sparsity);

New in version 1.24.0.

Sets sparsity for explicit encryption. Only applies when the algorithm set by mongoc_client_encryption_encrypt_opts_set_algorithm() is “Range”. It is an error to set sparsity when algorithm is not “Range”.

Sparsity may be used to tune performance. When omitted, a default value is used.

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

Parameters#

range_opts: A mongoc_client_encryption_encrypt_range_opts_t
sparsity: A non-negative sparsity.