[DRIVERS-2311] Provide FLE 2.0 API example for docs team Created: 04/May/22  Updated: 22/Feb/23  Resolved: 22/Feb/23

Status: Closed
Project: Drivers
Component/s: Client Side Encryption
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Martin Bajana Assignee: Kevin Albertson
Resolution: Done Votes: 0
Labels: phase2
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Initiative
Issue split
split to CDRIVER-4379 Provide Queryable Encryption API exam... Closed
split to CSHARP-4164 Provide FLE 2.0 API example for docs ... Closed
split to CXX-2505 Provide Queryable Encryption API exam... Closed
split to GODRIVER-2406 Provide Queryable Encryption API exam... Closed
split to JAVA-4600 Create queryable encryption example code Closed
split to MOTOR-956 Provide FLE 2.0 API example for docs ... Closed
split to NODE-4227 Implement CSFLE Prose Tests #12 Closed
split to PHPLIB-863 Provide queryable encryption example ... Closed
split to PYTHON-3253 Provide FLE 2.0 API example for docs ... Closed
split to RUBY-2986 Provide FLE 2.0 API example for docs ... Closed
split to RUST-1310 Provide FLE 2.0 API example for docs ... Closed
Epic Link: DRIVERS-1949
Driver Changes: Needed
Quarter: FY23Q2
Downstream Changes Summary:

Add example code for FLE 2 Automatic Encryption:

  • Create an encryptedFieldsMap with an indexed and unindexed field.
  • Create an FLE 2 collection.
  • Auto encrypt an insert and find with "Indexed" and "Unindexed" encrypted fields.

Please use the example in the Go driver as a reference.

Provide a link to the specification test: Explicit Encryption.

Driver Compliance:
Key Status/Resolution FixVersion
CDRIVER-4379 Fixed 1.22.0
CXX-2505 Done 3.8.0
CSHARP-4164 Fixed 2.17.0
GODRIVER-2406 Fixed 1.10.0, 1.10.0-beta1
JAVA-4600 Fixed 4.7.0
NODE-4227 Fixed 4.8.0
MOTOR-956 Fixed 3.1
PYTHON-3253 Fixed 4.2
PHPLIB-863 Fixed 1.13.0
RUBY-2986 Fixed 2.18.0
RUST-1310 Fixed 2.4.0
SWIFT-1561 Won't Do

 Description   

Summary

Add example code for FLE 2 Automatic Encryption:

  • Create an encryptedFieldsMap with an indexed and unindexed field.
  • Create an FLE 2 collection.
  • Auto encrypt an insert and find with "Indexed" and "Unindexed" encrypted fields.

Please use the example in the Go driver as a reference.

Provide a link to the specification test: Explicit Encryption.

Background & Motivation

This is requested from the docs team to give an example of FLE 2 usage to make it easier to write docs examples.

The example code is not intended to be automatically scraped.
 


Generated at Thu Feb 08 08:25:15 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.