Skip to content

Commit

Permalink
note source of option validation errors is libmongocrypt
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinAlbs committed Jul 23, 2024
1 parent 7306a8f commit fca78a2
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions source/client-side-encryption/client-side-encryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -1214,8 +1214,8 @@ query. Drivers MUST document the following behavior:

#### contentionFactor

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".
contentionFactor may be used to tune performance. Only applies when algorithm is "Indexed" or "Range". libmongocrypt
returns an error if contentionFactor is set for a non-applicable algorithm.

#### queryType

Expand All @@ -1224,15 +1224,16 @@ One of the strings:
- "equality"
- "range"

queryType only applies when algorithm is "Indexed" or "Range". It is an error to set queryType when algorithm is not
"Indexed" or "Range".
queryType only applies when algorithm is "Indexed" or "Range". libmongocrypt returns an error if queryType is set for a
non-applicable queryType.

> [!NOTE]
> The "range" queryType is currently unstable API and subject to backwards breaking changes.

#### rangeOpts

rangeOpts only applies when algorithm is "range". It is an error to set rangeOpts when algorithm is not "range".
rangeOpts only applies when algorithm is "range". libmongocrypt returns an error if rangeOpts is set for a
non-applicable algorithm.

> [!NOTE]
> rangeOpts is currently unstable API and subject to backwards breaking changes.
Expand Down

0 comments on commit fca78a2

Please sign in to comment.