From 4a807a65c9db5ada0a2ffe2afb61949ad1dd6973 Mon Sep 17 00:00:00 2001 From: Kevin Albertson Date: Tue, 23 Jul 2024 08:33:55 -0400 Subject: [PATCH] briefly describe `min`, `max`, `precision`, and `contentionFactor` More detailed description is deferred to MongoDB docs. --- .../client-side-encryption/client-side-encryption.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/client-side-encryption/client-side-encryption.md b/source/client-side-encryption/client-side-encryption.md index 1827c7d4d0..eadf55f7a2 100644 --- a/source/client-side-encryption/client-side-encryption.md +++ b/source/client-side-encryption/client-side-encryption.md @@ -1168,15 +1168,15 @@ class EncryptOpts { // min, max, trimFactor, sparsity, and precision 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. class RangeOpts { - // min is required if precision is set. + // min is the minimum value for the encrypted index. Required if precision is set. min: Optional, - // max is required if precision is set. + // max is the maximum value for the encrypted index. Required if precision is set. max: Optional, // trimFactor may be used to tune performance. May be omitted to rely on defaults. trimFactor: Optional, // sparsity may be used to tune performance. May be omitted to rely on defaults. sparsity: Optional, - // precision may only be set for double or decimal128. + // precision determines the number of significant digits after the decimal point. May only be set for double or decimal128. precision: Optional } ``` @@ -1214,8 +1214,8 @@ query. Drivers MUST document the following behavior: #### contentionFactor -contentionFactor only applies when algorithm is "Indexed" or "Range". It is an error to set contentionFactor when -algorithm is not "Indexed" or "Range". +contentionFactor may be used to tune performance. Only applies when algorithm is "Indexed" or "Range". It is an error to +set contentionFactor when algorithm is not "Indexed" or "Range". #### queryType