(DOCSP-21791) Add Find Steps (#1194)

* add find steps

* add find step to qs + tuts

* add retrieve step to guide

* build error

* build error

* ja - suggestions

Author: biniona-mongodb

source/core/csfle/quick-start.txt

@@ -175,6 +175,45 @@ Procedure
                To view the complete code for inserting an encrypted document, see
                `our Github repository <{+sample-app-url+}go/local/reader/insert-encrypted-document.go>`__.
 
+   .. step:: Retrieve Your Encrypted Document
+
+      .. include:: /includes/quick-start/find.rst
+
+      .. see:: Complete Code
+
+         .. tabs-drivers::
+
+            .. tab::
+               :tabid: java-sync
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}java/local/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java>`__.
+
+            .. tab::
+               :tabid: nodejs
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}node/local/reader/insert_encrypted_document.js>`__.
+
+            .. tab::
+               :tabid: python
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}python/local/reader/insert_encrypted_document.py>`__.
+
+            .. tab::
+               :tabid: csharp
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}dotnet/local/reader/CSFLE/InsertEncryptedDocument.cs>`__
+
+            .. tab::
+               :tabid: go
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}go/local/reader/insert-encrypted-document.go>`__.
+
+
 Learn More
 ----------
 

source/core/csfle/tutorials/aws/aws-automatic.txt

@@ -136,7 +136,7 @@ Create the Application
 
    .. step:: Insert a Document with Encrypted Fields
 
-      .. include:: /includes/quick-start/insert.rst
+      .. include:: /includes/tutorials/automatic/aws/insert.rst
 
       .. see:: Complete Code
 
@@ -172,6 +172,45 @@ Create the Application
                To view the complete code for inserting an encrypted document, see
                `our Github repository <{+sample-app-url+}go/aws/reader/insert-encrypted-document.go>`__.
 
+   .. step:: Retrieve Your Encrypted Document
+
+      .. include:: /includes/tutorials/automatic/aws/find.rst
+
+      .. see:: Complete Code
+
+         .. tabs-drivers::
+
+            .. tab::
+               :tabid: java-sync
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}java/aws/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java>`__.
+
+            .. tab::
+               :tabid: nodejs
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}node/aws/reader/insert_encrypted_document.js>`__.
+
+            .. tab::
+               :tabid: python
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}python/aws/reader/insert_encrypted_document.py>`__.
+
+            .. tab::
+               :tabid: csharp
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}dotnet/aws/reader/CSFLE/InsertEncryptedDocument.cs>`__
+
+            .. tab::
+               :tabid: go
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}go/aws/reader/insert-encrypted-document.go>`__.
+
+
 Learn More
 ----------
 

source/core/csfle/tutorials/azure/azure-automatic.txt

@@ -134,7 +134,7 @@ Create the Application
 
    .. step:: Insert a Document with Encrypted Fields
 
-      .. include:: /includes/quick-start/insert.rst
+      .. include:: /includes/tutorials/automatic/azure/insert.rst
 
       .. see:: Complete Code
 
@@ -170,6 +170,45 @@ Create the Application
                To view the complete code for inserting an encrypted document, see
                `our Github repository <{+sample-app-url+}go/azure/reader/insert-encrypted-document.go>`__.
 
+   .. step:: Retrieve Your Encrypted Document
+
+      .. include:: /includes/tutorials/automatic/azure/find.rst
+
+      .. see:: Complete Code
+
+         .. tabs-drivers::
+
+            .. tab::
+               :tabid: java-sync
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}java/azure/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java>`__.
+
+            .. tab::
+               :tabid: nodejs
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}node/azure/reader/insert_encrypted_document.js>`__.
+
+            .. tab::
+               :tabid: python
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}python/azure/reader/insert_encrypted_document.py>`__.
+
+            .. tab::
+               :tabid: csharp
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}dotnet/azure/reader/CSFLE/InsertEncryptedDocument.cs>`__
+
+            .. tab::
+               :tabid: go
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}go/azure/reader/insert-encrypted-document.go>`__.
+
+
 Learn More
 ----------
 

source/core/csfle/tutorials/gcp/gcp-automatic.txt

@@ -137,7 +137,7 @@ your application to see relevant code samples.
 
    .. step:: Insert a Document with Encrypted Fields
 
-      .. include:: /includes/quick-start/insert.rst
+      .. include:: /includes/tutorials/automatic/gcp/insert.rst
 
       .. see:: Complete Code
 
@@ -173,6 +173,45 @@ your application to see relevant code samples.
                To view the complete code for inserting an encrypted document, see
                `our Github repository <{+sample-app-url+}go/gcp/reader/insert-encrypted-document.go>`__.
 
+   .. step:: Retrieve Your Encrypted Document
+
+      .. include:: /includes/tutorials/automatic/gcp/find.rst
+
+      .. see:: Complete Code
+
+         .. tabs-drivers::
+
+            .. tab::
+               :tabid: java-sync
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}java/gcp/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java>`__.
+
+            .. tab::
+               :tabid: nodejs
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}node/gcp/reader/insert_encrypted_document.js>`__.
+
+            .. tab::
+               :tabid: python
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}python/gcp/reader/insert_encrypted_document.py>`__.
+
+            .. tab::
+               :tabid: csharp
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}dotnet/gcp/reader/CSFLE/InsertEncryptedDocument.cs>`__
+
+            .. tab::
+               :tabid: go
+
+               To view the complete code for finding an encrypted document, see
+               `our Github repository <{+sample-app-url+}go/gcp/reader/insert-encrypted-document.go>`__.
+
+
 Learn More
 ----------
 

source/includes/quick-start/find-output.out

@@ -0,0 +1,26 @@
+Finding a document with regular (non-encrypted) client.
+
+{
+  _id: new ObjectId("629a452e0861b3130887103a"),
+  name: 'Jon Doe',
+  ssn: new Binary(Buffer.from("0217482732d8014cdd9ffdd6e2966e5e7910c20697e5f4fa95710aafc9153f0a3dc769c8a132a604b468732ff1f4d8349ded3244b59cbfb41444a210f28b21ea1b6c737508d9d30e8baa30c1d8070c4d5e26", "hex"), 6),
+  bloodType: new Binary(Buffer.from("0217482732d8014cdd9ffdd6e2966e5e79022e238536dfd8caadb4d7751ac940e0f195addd7e5c67b61022d02faa90283ab69e02303c7e4001d1996128428bf037dea8bbf59fbb20c583cbcff2bf3e2519b4", "hex"), 6),
+  'key-id': 'demo-data-key',
+  medicalRecords: new Binary(Buffer.from("0217482732d8014cdd9ffdd6e2966e5e790405163a3207cff175455106f57eef14e5610c49a99bcbd14a7db9c5284e45e3ee30c149354015f941440bf54725d6492fb3b8704bc7c411cff6c868e4e13c58233c3d5ed9593eca4e4d027d76d3705b6d1f3b3c9e2ceee195fd944b553eb27eee69e5e67c338f146f8445995664980bf0", "hex"), 6),
+  insurance: {
+    policyNumber: new Binary(Buffer.from("0217482732d8014cdd9ffdd6e2966e5e79108decd85c05be3fec099e015f9d26d9234605dc959cc1a19b63072f7ffda99db38c7b487de0572a03b2139ac3ee163bcc40c8508f366ce92a5dd36e38b3c742f7", "hex"), 6),
+    provider: 'MaestCare'
+  }
+}
+
+Finding a document with encrypted client, searching on an encrypted field
+
+{
+  _id: new ObjectId("629a452e0861b3130887103a"),
+  name: 'Jon Doe',
+  ssn: 241014209,
+  bloodType: 'AB+',
+  'key-id': 'demo-data-key',
+  medicalRecords: [ { weight: 180, bloodPressure: '120/80' } ],
+  insurance: { policyNumber: 123142, provider: 'MaestCare' }
+}

source/includes/quick-start/find.rst

@@ -0,0 +1,64 @@
+Retrieve the encrypted document you inserted in the
+:ref:`Insert a Document with Encrypted Fields <csfle-quick-start-insert>`
+step of this guide.
+
+To show the functionality of {+csfle-abbrev+}, the following code snippet queries for
+your document with a client configured for automatic {+csfle-abbrev+} as well as
+a client that is not configured for automatic {+csfle-abbrev+}.
+
+.. tabs-drivers::
+
+   .. tab::
+      :tabid: java-sync
+
+      .. literalinclude:: /includes/sample_apps/csfle/build/java/local/reader/src/main/java/com/mongodb/csfle/insertEncryptedDocument.java
+         :start-after: start-find
+         :end-before: end-find
+         :language: java
+         :dedent:
+         :caption: insertEncryptedDocument.java
+
+   .. tab::
+      :tabid: nodejs
+
+      .. literalinclude:: /includes/sample_apps/csfle/build/node/local/reader/insert_encrypted_document.js
+         :start-after: start-find
+         :end-before: end-find
+         :language: javascript
+         :dedent:
+         :caption: insert_encrypted_document.js
+
+   .. tab::
+      :tabid: python
+
+      .. literalinclude:: /includes/sample_apps/csfle/build/python/local/reader/insert_encrypted_document.py
+         :start-after: start-find
+         :end-before: end-find
+         :language: python
+         :dedent:
+         :caption: insert_encrypted_document.py
+
+   .. tab::
+      :tabid: csharp
+
+      .. literalinclude:: /includes/sample_apps/csfle/build/dotnet/local/reader/CSFLE/InsertEncryptedDocument.cs
+         :start-after: start-find
+         :end-before: end-find
+         :language: csharp
+         :dedent:
+         :caption: InsertEncryptedDocument.cs
+
+   .. tab::
+      :tabid: go
+
+      .. literalinclude:: /includes/sample_apps/csfle/build/go/local/reader/insert-encrypted-document.go
+         :start-after: start-find
+         :end-before: end-find
+         :language: go
+         :dedent:
+         :caption: insert-encrypted-document.go
+
+The output of the preceding code snippet should look like this:
+
+.. literalinclude:: /includes/quick-start/find-output.out
+   :language: json

source/includes/quick-start/insert.rst

@@ -1,3 +1,5 @@
+.. _csfle-quick-start-insert:
+
 Use your {+csfle-abbrev+}-enabled
 ``MongoClient`` instance to insert an encrypted document into the
 ``medicalRecords.patients`` namespace using the following code

source/includes/sample_apps/csfle/build/dotnet/aws/reader/CSFLE/InsertEncryptedDocument.cs

@@ -118,6 +118,10 @@ public static void Insert()
             };
             // end-extra-options
 
+            var regularClientSettings = MongoClientSettings.FromConnectionString(connectionString);
+            var regularClient = new MongoClient(regularClientSettings);
+            var regularCollection = regularClient.GetDatabase(db).GetCollection<BsonDocument>(coll);
+
             // start-client
             var clientSettings = MongoClientSettings.FromConnectionString(connectionString);
             var autoEncryptionOptions = new AutoEncryptionOptions(
@@ -126,7 +130,7 @@ public static void Insert()
                 schemaMap: schemaMap,
                 extraOptions: extraOptions);
             clientSettings.AutoEncryptionOptions = autoEncryptionOptions;
-            var client = new MongoClient(clientSettings);
+            var secureClient = new MongoClient(clientSettings);
             // end-client
 
             // start-insert
@@ -152,14 +156,21 @@ public static void Insert()
             };
 
             // Construct an auto-encrypting client
-            var collection = client.GetDatabase(db).GetCollection<BsonDocument>(coll);
+            var secureCollection = secureClient.GetDatabase(db).GetCollection<BsonDocument>(coll);
 
             // Insert a document into the collection
-            collection.InsertOne(sampleDocFields);
-            var result = collection.Find(FilterDefinition<BsonDocument>.Empty).Limit(1).ToList()[0];
-            Console.WriteLine("Successfully upserted the sample document!");
-            Console.WriteLine($"Encrypted client query by the SSN (deterministically-encrypted) field:\n {result}\n");
+            secureCollection.InsertOne(sampleDocFields);
             // end-insert
+            // start-find
+            Console.WriteLine("Finding a document with regular (non-encrypted) client.");
+            var filter = Builders<BsonDocument>.Filter.Eq("name", "Jon Doe");
+            var regularResult = regularCollection.Find(filter).Limit(1).ToList()[0];
+            Console.WriteLine($"\n{regularResult}\n");
+            Console.WriteLine("Finding a document with encrypted client, searching on an encrypted field");
+            var ssnFilter = Builders<BsonDocument>.Filter.Eq("ssn", 145014000);
+            var secureResult = secureCollection.Find(ssnFilter).Limit(1).ToList()[0];
+            Console.WriteLine($"\n{secureResult}\n");
+            // end-find
         }
     }
 }