Skip to content

Commit c0b0b90

Browse files
committed
encrypt fields embeddings
(cherry picked from commit 3e60fd1)
1 parent c5b552d commit c0b0b90

File tree

6 files changed

+54
-0
lines changed

6 files changed

+54
-0
lines changed

snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,4 @@ core-api = "{+java-api+}/apidocs/mongodb-driver-core"
3535
kotlin-docs = "https://kotlinlang.org"
3636
serialization-version = "1.5.1"
3737
kotlinx-dt-version = "0.6.1"
38+
mongocrypt-version = "{+full-version+}"

source/encrypt-fields.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _kotlin-sync-fle:
2+
3+
.. sharedinclude:: dbx/encrypt-fields.rst
4+
5+
.. replacement:: driver-specific-content
6+
7+
.. important:: Compatible Encryption Library Version
8+
9+
The {+driver-short+} uses the `mongodb-crypt
10+
<https://mvnrepository.com/artifact/org.mongodb/mongodb-crypt>`__
11+
encryption library for in-use encryption. This driver version
12+
is compatible with ``mongodb-crypt`` v{+mongocrypt-version+}.
13+
14+
Select from the following :guilabel:`Maven` and
15+
:guilabel:`Gradle` tabs to see how to add the ``mongodb-crypt``
16+
dependency to your project by using the specified manager:
17+
18+
.. tabs::
19+
20+
.. tab:: Maven
21+
:tabid: maven-dependency
22+
23+
.. include:: /includes/security/crypt-gradle-versioned.rst
24+
25+
.. tab:: Gradle
26+
:tabid: gradle-dependency
27+
28+
.. include:: /includes/security/crypt-gradle-versioned.rst
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. code-block:: groovy
2+
3+
dependencies {
4+
implementation("org.mongodb:mongodb-crypt:{+mongocrypt-version+}")
5+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. code-block:: xml
2+
3+
<dependencies>
4+
<dependency>
5+
<groupId>org.mongodb</groupId>
6+
<artifactId>mongodb-crypt</artifactId>
7+
<version>{+mongocrypt-version+}</version>
8+
</dependency>
9+
</dependencies>

source/index.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
Use Aggregation Expression Operations </agg-exp-ops>
2323
/data-formats
2424
/builders
25+
/encrypt-fields
2526
/compatibility
2627
Validate Driver Artifact Signatures </validate-signatures>
2728
/whats-new
@@ -100,6 +101,12 @@ Use Builders API
100101

101102
Learn how to work with the builder operation helpers in the :ref:`kotlin-sync-builders` section.
102103

104+
In-Use Encryption
105+
-----------------
106+
107+
Learn how to use in-use encryption to encrypt your MongoDB data in the
108+
:ref:`In-Use Encryption <kotlin-sync-fle>` section.
109+
103110
.. TODO: Uncomment when pages are created
104111
.. FAQ
105112
.. ---

source/whats-new.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ improvements, and fixes:
3333

3434
the :ref:`kotlin-sync-search-avs-indexes` guide
3535

36+
.. replacement:: encrypt-link
37+
38+
the :ref:`In-Use Encryption <kotlin-sync-fle>` guide
39+
3640
.. replacement:: vector-search-link
3741

3842
the :atlas:`Atlas Vector Search Quick Start

0 commit comments

Comments
 (0)