Cleaned feature branch

Author: nvillahermosa-mdb

snooty.toml

@@ -256,6 +256,11 @@ fts = "Atlas Search"
 # In Use Encryption Constants
 csfle = "Client-Side Field Level Encryption"
 csfle-abbrev = "CSFLE"
+qe = "Queryable Encryption"
+qe-abbr = ":abbr:`QE (Queryable Encryption)`"
+qe-preview = "{+qe+} Public Preview"
+qe-framework = "{+qe+} framework"
+qe-equality-ga = "{+qe-framework+} with equality search"
 in-use-doc = "document with encrypted fields"
 in-use-doc-title = "Document with Encrypted Fields"
 in-use-docs = "documents with encrypted fields"
@@ -289,8 +294,6 @@ libmongocrypt-version = "1.8"
 mongodb-crypt-version = "1.7.3"
 sample-app-url-csfle = "https://github.com/mongodb-university/docs-in-use-encryption-examples/tree/main/csfle"
 sample-app-url-qe = "https://github.com/mongodb-university/docs-in-use-encryption-examples/tree/main/queryable-encryption"
-qe = "Queryable Encryption"
-qe-abbr = ":abbr:`QE (Queryable Encryption)`"
 enc-fields-map = "encrypted fields map"
 enc-fields-map-title = "Encrypted Fields Map"
 shared-library = "Automatic Encryption Shared Library"
@@ -328,23 +331,21 @@ targets = [
     "core/queryable-encryption/*/*.txt",
 ]
 
-variant = "danger"
+variant = "warning"
 value = """
-    Queryable Encryption is in Public Preview and available for \
-    evaluation purposes. Public Preview is not recommended for \
-    production deployments as breaking changes may be introduced. \
-    To learn more about the Preview please see the \
-    `Queryable Encryption Preview <https://www.mongodb.com/blog/post/mongodb-releases-queryable-encryption-preview/>`__ \
-    blog post.
+    {+qe-equality-ga+} is generally available (GA) in \
+    MongoDB 7.0 and later. Data encrypted using the {+qe-preview+} \ 
+    from earlier versions is incompatible with the GA. \
+    For more information, see :ref:`7.0-compatibility`.
     """
 
 [[banners]]
 targets = ["core/csfle.txt", "core/csfle/*.txt", "core/csfle/*/*.txt"]
 
 variant = "tip"
 value = """
-    The next-generation Queryable Encryption feature is now in Public Preview. \
-    To learn more about Queryable Encryption, see :ref:`qe-manual-feature-qe`.
+    {+qe-equality-ga+} is now available. \
+    To learn more about {+qe+}, see :ref:`qe-manual-feature-qe`.
     """
 
 [bundle]

source/core/queryable-encryption/fundamentals/manage-collections.txt

@@ -12,8 +12,12 @@ Encrypted Collection Management
    :depth: 2
    :class: singlecol
 
-In this guide, you can learn how to manage your encrypted collections,
-and the storage and write costs of {+qe+}.
+Every encrypted field in a collection adds writes to insert,
+update, and delete operations. It also requires additional storage,
+since MongoDB maintains an index of encrypted fields. This section
+lists the writes per operation and explains how to compact encrypted
+collection indexes, so that you can plan accordingly to minimize write
+and storage costs.
 
 Overview
 --------
@@ -24,9 +28,9 @@ fields.
 
 With {+qe+}, a given plaintext value always encrypts to a different
 ciphertext, while still remaining queryable. To enable
-this functionality, {+qe+} uses four data structures:
+this functionality, {+qe+} uses three data structures:
 
-- Three metadata collections
+- Two metadata collections
 - A field in every document in the encrypted collection called ``__safeContent__``
 
 .. important::
@@ -37,11 +41,10 @@ this functionality, {+qe+} uses four data structures:
 Metadata Collections
 --------------------
 
-When you create an encrypted collection using {+qe+}, MongoDB creates three
+When you create an encrypted collection, MongoDB creates two
 metadata collections:
 
 - ``enxcol_.<collectionName>.esc``, referred to as ``ESC``
-- ``enxcol_.<collectionName>.ecc``, referred to as ``ECC``
 - ``enxcol_.<collectionName>.ecoc``, referred to as ``ECOC``
 
 .. example::
@@ -50,29 +53,25 @@ metadata collections:
    following metadata collections:
 
    - ``enxcol_.patients.esc``
-   - ``enxcol_.patients.ecc``
    - ``enxcol_.patients.ecoc``
 
 
-When you insert documents with encrypted fields that you wish to query on,
+When you insert documents with a queryable encrypted field,
 MongoDB updates the metadata collections to maintain an index
-that enables you to query. MongoDB refers to this as "indexed field". This
-comes at a cost in storage and write speed.
+that enables querying. The field becomes an "indexed field". This
+comes at a cost in storage and write speed for every such field.
 
 Storage Costs
 -------------
 
 Storage and write costs increase based on the number of indexed fields
 per document.
 
-.. important:: Technical Preview
-
-   MongoDB's guidance during the technical preview is to expect two to
-   three times the storage requirement for a {+qe+} collection and
-   associated metadata collections. For example, a 1 GB collection may
-   have a storage requirement of 2-3 GB for associated metadata collections.
+.. important::
 
-   This guidance will be tuned in a future release.
+   Expect a {+qe+} collection to have 2-3 times the storage requirements
+   of the documents, to account for metadata collections. For example, a
+   1 GB collection may have a storage requirement of 2-3 GB.
 
 Write Costs
 -----------
@@ -97,11 +96,10 @@ metadata collections.
 Update Operations
 ~~~~~~~~~~~~~~~~~
 
-When updating a document, each indexed field requires four writes to
+When updating a document, each indexed field requires three writes to
 metadata collections.
 
 - One write to ``ESC``
-- One write to ``ECC``
 - Two writes to ``ECOC``
 
 
@@ -110,45 +108,44 @@ metadata collections.
    Updating a document with two indexed fields requires:
 
    - One write to the encrypted collection.
-   - Eight writes to the metadata collections.
+   - Six writes to the metadata collections.
 
 
 Delete Operations
 ~~~~~~~~~~~~~~~~~
 
-When deleting a document, each indexed field requires two writes to the
+When deleting a document, each indexed field requires one write to the
 metadata collections.
 
-- One write to ``ECC``
 - One write to ``ECOC``
 
 
 .. example::
 
    Deleting a document with two indexed fields requires:
 
-   - One write into the encrypted collection.
-   - Four writes to the metadata collections.
+   - One write to the encrypted collection.
+   - Two writes to the metadata collections.
 
 
 .. _qe-index-compaction:
 
 Index Compaction
 ----------------
 
-.. important:: Technical Preview
+.. important::
 
-   You are required to run index compaction during the technical preview.
-   MongoDB plans to automatically run index compaction in a future release.
+   You must manually run index compaction. MongoDB will automatically 
+   run index compaction in a future release.
 
 As you insert, update, and delete documents, the metadata collections
-change and grow. Index compaction is a process that prunes the metadata
-collections and reduces their size.
+change and grow. Index compaction prunes the metadata collections and 
+reduces their size.
 
-You should run index compaction when the size of ``ECOC`` exceeds 1 GB.
+Run index compaction when the size of ``ECOC`` exceeds 1 GB.
 
 You can check the size of your collections using :binary:`~bin.mongosh`
-and issuing the ``db.collection.totalSize()`` command.
+and issuing the :method:`db.collection.totalSize()` command.
 
 .. example::
 

source/release-notes/7.0-compatibility.txt

@@ -12,5 +12,56 @@ Compatibility Changes in MongoDB 7.0
    :depth: 1
    :class: singlecol
 
+<<<<<<< HEAD
 This page describes changes introduced in MongoDB 7.0 that can affect
 compatibility with older versions of MongoDB.
+=======
+.. |version| replace:: 7.0
+.. include:: /includes/rapid-release.rst
+
+This page describes changes introduced in MongoDB 7.0 that can affect
+compatibility with older versions of MongoDB.
+
+Queryable Encryption General Availability
+-----------------------------------------
+
+Starting in MongoDB 7.0, the {+qe-equality-ga+} is generally
+available (GA). Improvements in the GA make it
+incompatible with the {+qe-preview+}.
+
+Driver Compatibility
+~~~~~~~~~~~~~~~~~~~~
+
+To use the {+qe-equality-ga+}, MongoDB server and drivers must both be
+version 7.0 or later. If you are still using the {+qe-preview+} included
+with MongoDB 6.x, both the server and drivers must remain on version
+6.x. You cannot use MongoDB 6.x drivers with a 7.0 server, or 7.0
+drivers with a 6.x server.
+
+To make upgrading easier, MongoDB 7.0 drivers can decrypt data
+created with MongoDB 6.x drivers. See the following section for
+migration steps if you need to upgrade and then carry over existing
+encrypted data.
+
+On-Disk Storage Format Changes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The on-disk storage format in the {+qe-framework+} GA is
+incompatible with the format used for the {+qe-preview+}. MongoDB 7.0
+drivers can decrypt documents created with MongoDB 6.x drivers, but
+can't query encrypted fields or insert data.
+
+If you encrypted data using the {+qe-preview+}:
+
+# Upgrade MongoDB server and drivers to 7.0
+# Query each encrypted collection from a 7.0 driver to decrypt it. 
+# Save the output locally. 
+# Configure a new encrypted collection and ingest the data.
+
+.. warning::
+   * The :binary:`~bin.mongoexport` and :binary:`~bin.mongodump` 
+     operations do not decrypt the collection. You must query the 
+     collection from a driver to output the decrypted data. 
+   * MongoDB 7.0 drivers can't query encrypted fields on data encrypted 
+     with MongoDB 6.x drivers, so you must query the entire collection.
+>>>>>>> 3f72852ce (Cleaned feature branch)