Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-2927

Document trimFactor and sparsity and make optional

    • Needed

      Summary

      • Document the purpose of trimFactor and sparsity.
      • Make trimFactor and sparsity optional. Apply defaults chosen in SERVER-91077 in libmongocrypt.
      • Verify server default min/max values added in SERVER-91075 are applied client-side in libmongocrypt.

      Motivation

      trimFactor and sparsity are currently specified as required arguments in RangeOpts. trimFactor and sparsity are expected to be advanced configuration that most users would not know how to meaningfully change (see slack thread). Making them optional may ease usage. Documentation may help clarify that most users can leave these unset.

      trimFactor is documented here:

      Is this issue urgent?

      Yes. Should be done before Range GA (DRIVERS-2776).

            Assignee:
            Unassigned Unassigned
            Reporter:
            kevin.albertson@mongodb.com Kevin Albertson
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated: