Drop prefixPreview, suffixPreview, and substringPreview

XMLWordPrintableJSON

    • Type: Spec Change
    • Resolution: Unresolved
    • Priority: Unknown
    • None
    • Component/s: Client Side Encryption
    • None
    • Needed

      Summary

      Drop support for "prefixPreview", "suffixPreview", and "substringPreview". 

      Motivation

      DRIVERS-3321 adds support for "prefix" and "suffix". DRIVERS-3540 intends to add support for "substring".

      DRIVERS-3321 previously proposed dropping "prefixPreview" and "suffixPreview", this was determined to be too-soon (see slack thread). Server 9.0 is not-yet released, so users of preview would lose access.

      Who is the affected end user?

      Users of QE "prefixPreview", "suffixPreview", and "substringPreview".

      How does this affect the end user?

      Dropping preview will require users migrate to the stable "prefix", "suffix", and "substring" and recreate collections on server 9.0.

      How likely is it that this problem or use case will occur?

      Likely? Attempting to use preview on server 9.0 results in a server error:

      Cannot create a collection with an encrypted field with query type prefixPreview, as it is deprecated

      Dropping preview is not strictly needed. Preview can be used on 8.2 and 8.3 servers. Removing preview forces users to migrate to the stable names, and avoids persisting experimental API in drivers.

      If the problem does occur, what are the consequences and how severe are they?

      N/A?

      Is this issue urgent?

      Schedule close to the server 9.0 release to avoid dropping preview too-far in advance of server 9.0.

      Is this ticket required by a downstream team?

      I expect mongosh + Compass.

      Is this ticket only for tests?

      No.

      Acceptance Criteria

      • Drop references to "prefixPreview", "suffixPreview", and "substringPreview" from drivers specifications.

            Assignee:
            Unassigned
            Reporter:
            Kevin Albertson
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: