Skip to content

Commit 3ed247c

Browse files
authored
DOCSP-25571 adds QE with Azure tutorial (#1957) (#1969)
1 parent ee70e32 commit 3ed247c

File tree

6 files changed

+140
-0
lines changed

6 files changed

+140
-0
lines changed

source/core/queryable-encryption/tutorials/azure/azure-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/azure/reader/>`__
44+
4045
.. tab:: Node.js
4146
:tabid: nodejs
4247

@@ -97,6 +102,12 @@ Create the Application
97102

98103
.. tabs-drivers::
99104

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

@@ -140,6 +151,12 @@ Create the Application
140151

141152
.. tabs-drivers::
142153

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

@@ -179,6 +196,12 @@ Create the Application
179196

180197
.. tabs-drivers::
181198

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

source/includes/queryable-encryption/tutorials/automatic/azure/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/azure/reader/insert_encrypted_document.js
15+
:start-after: start-key-vault
16+
:end-before: end-key-vault
17+
:language: javascript
18+
:dedent:
19+
:caption: insert_encrypted_document.js
20+
1121
.. tab::
1222
:tabid: nodejs
1323

@@ -65,6 +75,16 @@
6575

6676
.. tabs-drivers::
6777

78+
.. tab::
79+
:tabid: shell
80+
81+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/azure/reader/insert_encrypted_document.js
82+
:start-after: start-kmsproviders
83+
:end-before: end-kmsproviders
84+
:language: javascript
85+
:dedent:
86+
:caption: insert_encrypted_document.js
87+
6888
.. tab::
6989
:tabid: nodejs
7090

@@ -119,6 +139,16 @@
119139

120140
.. tabs-drivers::
121141

142+
.. tab::
143+
:tabid: shell
144+
145+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/azure/reader/insert_encrypted_document.js
146+
:start-after: start-schema
147+
:end-before: end-schema
148+
:language: javascript
149+
:dedent:
150+
:caption: insert_encrypted_document.js
151+
122152
.. tab::
123153
:tabid: nodejs
124154

@@ -173,6 +203,14 @@
173203

174204
.. tabs-drivers::
175205

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

@@ -232,6 +270,16 @@
232270

233271
.. tabs-drivers::
234272

273+
.. tab::
274+
:tabid: shell
275+
276+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/azure/reader/insert_encrypted_document.js
277+
:start-after: start-client
278+
:end-before: end-client
279+
:language: javascript
280+
:dedent:
281+
:caption: insert_encrypted_document.js
282+
235283
.. tab::
236284
:tabid: nodejs
237285

source/includes/queryable-encryption/tutorials/automatic/azure/dek.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@
1818

1919
.. tabs-drivers::
2020

21+
.. tab::
22+
:tabid: shell
23+
24+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/azure/reader/make_data_key.js
25+
:start-after: start-kmsproviders
26+
:end-before: end-kmsproviders
27+
:language: javascript
28+
:dedent:
29+
:caption: make_data_key.js
30+
2131
.. tab::
2232
:tabid: nodejs
2333

@@ -85,6 +95,15 @@
8595

8696
.. tabs-drivers::
8797

98+
.. tab::
99+
:tabid: shell
100+
101+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/azure/reader/make_data_key.js
102+
:start-after: start-datakeyopts
103+
:end-before: end-datakeyopts
104+
:language: javascript
105+
:dedent:
106+
:caption: make_data_key.js
88107

89108
.. tab::
90109
:tabid: nodejs
@@ -152,6 +171,16 @@
152171

153172
.. tabs-drivers::
154173

174+
.. tab::
175+
:tabid: shell
176+
177+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/azure/reader/make_data_key.js
178+
:start-after: start-create-dek
179+
:end-before: end-create-dek
180+
:language: javascript
181+
:dedent:
182+
:caption: make_data_key.js
183+
155184
.. tab::
156185
:tabid: nodejs
157186

@@ -209,6 +238,16 @@
209238

210239
.. tabs-drivers::
211240

241+
.. tab::
242+
:tabid: shell
243+
244+
.. literalinclude:: /includes/generated/in-use-encryption/queryable-encryption/mongosh/azure/reader/make_data_key.js
245+
:start-after: start-create-enc-collection
246+
:end-before: end-create-enc-collection
247+
:language: javascript
248+
:dedent:
249+
:caption: make_data_key.js
250+
212251
.. tab::
213252
:tabid: nodejs
214253

source/includes/queryable-encryption/tutorials/automatic/azure/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/azure/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/azure/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/azure/reader/insert_encrypted_document.js
14+
:start-after: start-insert
15+
:end-before: end-insert
16+
:language: javascript
17+
:dedent:
18+
:caption: insert_encrypted_document.js
19+
1020
.. tab::
1121
:tabid: nodejs
1222

source/includes/queryable-encryption/tutorials/automatic/azure/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/azure/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)