Skip to content

Commit f200e49

Browse files
jmd-mongojmd-mongo
authored
DOCSP-25569 QE with AWS tutorial (#1953) (#1972)
* DOCSP-23618 aws tutorial * shell comment * typo
1 parent e12b68e commit f200e49

File tree

8 files changed

+152
-1
lines changed

8 files changed

+152
-1
lines changed

‎source/core/queryable-encryption/quick-start.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Before You Get Started
4646

4747
.. tabs::
4848

49-
.. tab:: mongosh
49+
.. tab:: Mongosh
5050
:tabid: shell
5151

5252
`Complete mongosh Application <{+sample-app-url-qe+}/mongosh/local/reader/>`__

‎source/core/queryable-encryption/tutorials/aws/aws-automatic.txt

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,11 @@ Before You Get Started
3737

3838
.. tabs::
3939

40+
.. tab:: Mongosh
41+
:tabid: shell
42+
43+
`Complete Mongosh Application <{+sample-app-url-qe+}/mongosh/aws/reader/>`__
44+
4045
.. tab:: Node.js
4146
:tabid: nodejs
4247

@@ -98,6 +103,12 @@ Create the Application
98103

99104
.. tabs-drivers::
100105

106+
.. tab::
107+
:tabid: shell
108+
109+
To view the complete code for making a {+dek-long+}, see
110+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/mongosh/aws/reader/make_data_key.js>`__.
111+
101112
.. tab::
102113
:tabid: nodejs
103114

@@ -141,6 +152,12 @@ Create the Application
141152

142153
.. tabs-drivers::
143154

155+
.. tab::
156+
:tabid: shell
157+
158+
To view the complete code for inserting an encrypted document, see
159+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/mongosh/aws/reader/insert_encrypted_document.js>`__.
160+
144161
.. tab::
145162
:tabid: nodejs
146163

@@ -180,6 +197,12 @@ Create the Application
180197

181198
.. tabs-drivers::
182199

200+
.. tab::
201+
:tabid: shell
202+
203+
To view the complete code for finding an encrypted document, see
204+
`the {+qe+} sample application repository <{+sample-app-url-qe+}/mongosh/aws/reader/insert_encrypted_document.js>`__.
205+
183206
.. tab::
184207
:tabid: nodejs
185208

‎source/includes/queryable-encryption/quick-start/dek.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,16 @@
162162

163163
.. tabs-drivers::
164164

165+
.. tab::
166+
:tabid: shell
167+
168+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/local/reader/make_data_key.js
169+
:start-after: start-create-enc-collection
170+
:end-before: end-create-enc-collection
171+
:language: javascript
172+
:dedent:
173+
:caption: make_data_key.js
174+
165175
.. tab::
166176
:tabid: nodejs
167177

‎source/includes/queryable-encryption/tutorials/automatic/aws/client.rst

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@
88

99
.. tabs-drivers::
1010

11+
.. tab::
12+
:tabid: shell
13+
14+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/aws/reader/insert_encrypted_document.js
15+
:start-after: start-key-vault
16+
:end-before: end-key-vault
17+
:language: javascript
18+
:caption: insert_encrypted_document.js
19+
:dedent:
20+
1121
.. tab::
1222
:tabid: nodejs
1323

@@ -67,6 +77,16 @@
6777

6878
.. tabs-drivers::
6979

80+
.. tab::
81+
:tabid: shell
82+
83+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/aws/reader/insert_encrypted_document.js
84+
:start-after: start-kmsproviders
85+
:end-before: end-kmsproviders
86+
:language: javascript
87+
:caption: insert_encrypted_document.js
88+
:dedent:
89+
7090
.. tab::
7191
:tabid: nodejs
7292

@@ -121,6 +141,16 @@
121141

122142
.. tabs-drivers::
123143

144+
.. tab::
145+
:tabid: shell
146+
147+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/aws/reader/insert_encrypted_document.js
148+
:start-after: start-schema
149+
:end-before: end-schema
150+
:language: javascript
151+
:caption: insert_encrypted_document.js
152+
:dedent:
153+
124154
.. tab::
125155
:tabid: nodejs
126156

@@ -175,6 +205,14 @@
175205

176206
.. tabs-drivers::
177207

208+
.. tab::
209+
:tabid: shell
210+
211+
.. code-block:: none
212+
213+
// mongosh does not require you to specify the
214+
// location of the {+shared-library+}
215+
178216
.. tab::
179217
:tabid: nodejs
180218

@@ -234,6 +272,16 @@
234272

235273
.. tabs-drivers::
236274

275+
.. tab::
276+
:tabid: shell
277+
278+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/aws/reader/insert_encrypted_document.js
279+
:start-after: start-client
280+
:end-before: end-client
281+
:language: javascript
282+
:caption: insert_encrypted_document.js
283+
:dedent:
284+
237285
.. tab::
238286
:tabid: nodejs
239287

‎source/includes/queryable-encryption/tutorials/automatic/aws/dek.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,16 @@
1212

1313
.. tabs-drivers::
1414

15+
.. tab::
16+
:tabid: shell
17+
18+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/aws/reader/make_data_key.js
19+
:start-after: start-kmsproviders
20+
:end-before: end-kmsproviders
21+
:language: javascript
22+
:caption: make_data_key.js
23+
:dedent:
24+
1525
.. tab::
1626
:tabid: nodejs
1727

@@ -79,6 +89,16 @@
7989

8090
.. tabs-drivers::
8191

92+
.. tab::
93+
:tabid: shell
94+
95+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/aws/reader/make_data_key.js
96+
:start-after: start-datakeyopts
97+
:end-before: end-datakeyopts
98+
:language: javascript
99+
:caption: make_data_key.js
100+
:dedent:
101+
82102
.. tab::
83103
:tabid: nodejs
84104

@@ -145,6 +165,16 @@
145165

146166
.. tabs-drivers::
147167

168+
.. tab::
169+
:tabid: shell
170+
171+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/aws/reader/make_data_key.js
172+
:start-after: start-create-dek
173+
:end-before: end-create-dek
174+
:language: javascript
175+
:dedent:
176+
:caption: make_data_key.js
177+
148178
.. tab::
149179
:tabid: nodejs
150180

@@ -202,6 +232,16 @@
202232

203233
.. tabs-drivers::
204234

235+
.. tab::
236+
:tabid: shell
237+
238+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/aws/reader/make_data_key.js
239+
:start-after: start-create-enc-collection
240+
:end-before: end-create-enc-collection
241+
:language: javascript
242+
:dedent:
243+
:caption: make_data_key.js
244+
205245
.. tab::
206246
:tabid: nodejs
207247

‎source/includes/queryable-encryption/tutorials/automatic/aws/find.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,16 @@ a client that is not configured for automatic {+qe+}.
88

99
.. tabs-drivers::
1010

11+
.. tab::
12+
:tabid: shell
13+
14+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/aws/reader/insert_encrypted_document.js
15+
:start-after: start-find
16+
:end-before: end-find
17+
:caption: insert_encrypted_document.js
18+
:language: javascript
19+
:dedent:
20+
1121
.. tab::
1222
:tabid: nodejs
1323

‎source/includes/queryable-encryption/tutorials/automatic/aws/insert.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@ snippet:
77

88
.. tabs-drivers::
99

10+
.. tab::
11+
:tabid: shell
12+
13+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/aws/reader/insert_encrypted_document.js
14+
:start-after: start-insert
15+
:end-before: end-insert
16+
:language: javascript
17+
:caption: insert_encrypted_document.js
18+
:dedent:
19+
1020
.. tab::
1121
:tabid: nodejs
1222

‎source/includes/queryable-encryption/tutorials/automatic/aws/key-vault-index.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,16 @@ Create a unique index on the ``keyAltNames`` field in your
55

66
.. tabs-drivers::
77

8+
.. tab::
9+
:tabid: shell
10+
11+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/aws/reader/make_data_key.js
12+
:start-after: start-create-index
13+
:end-before: end-create-index
14+
:caption: make_data_key.js
15+
:language: javascript
16+
:dedent:
17+
818
.. tab::
919
:tabid: nodejs
1020

0 commit comments

Comments
 (0)