Remove "preview" from QE prefix+suffix, and rename "text" to "string"

XMLWordPrintableJSON

    • Type: Task
    • Resolution: Unresolved
    • Priority: Major - P3
    • None
    • Affects Version/s: None
    • Component/s: None
    • Hide

      DRIVERS-3321:
      Summary of necessary driver changes

      • Rename QE "text" APIs to "string" and document as stable
        • rename TextOpts to StringOpts
        • replace "prefixPreview" queryType with "prefix"
        • replace "suffixPreview" queryType with "suffix"
        • replace "TextPreview" algorithm with "String"
      • Update spec and prose tests for the new names.
      • Upgrade to libmongocrypt 1.19.0+ to support the new names.

      "substringPreview" remains experimental API and is pending. If decided as GA, "substringPreview" will be renamed to "substring" as part of DRIVERS-3540.

      This is expected break compatibility of experimental QE APIs. This is expected to be OK in a minor release since APIs were documented as "unstable API and subject to backwards breaking changes".

      Commits for syncing spec/prose tests

      Show
      DRIVERS-3321 : Summary of necessary driver changes Rename QE "text" APIs to "string" and document as stable rename TextOpts to StringOpts replace "prefixPreview" queryType with "prefix" replace "suffixPreview" queryType with "suffix" replace "TextPreview" algorithm with "String" Update spec and prose tests for the new names. Upgrade to libmongocrypt 1.19.0+ to support the new names. "substringPreview" remains experimental API and is pending. If decided as GA, "substringPreview" will be renamed to "substring" as part of DRIVERS-3540 . This is expected break compatibility of experimental QE APIs. This is expected to be OK in a minor release since APIs were documented as "unstable API and subject to backwards breaking changes". Commits for syncing spec/prose tests https://github.com/mongodb/specifications/commit/c9b3ee0af76537b37a1a95e8025811f0337e468c
    • None
    • None
    • None
    • None
    • None
    • None
    • None

      This ticket was split from DRIVERS-3321, please see that ticket for a detailed description.

      Dev note: Bump to 1.19 is done as part of GODRIVER-3904

            Assignee:
            Unassigned
            Reporter:
            TPM Jira Automations Bot
            None
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated: