Create an Encryption Schema创建加密架构

Create the encryption schema.创建加密架构。

Include an encryptedFieldsObject with a nested fields array:包含一个带有嵌套fields数组的encryptedFieldsObject：

const encryptedFieldsObject = {
   fields: []
}

Specify fields to encrypt.指定要加密的字段。

1. Add the path and bsonType strings to a document within the fields array:将path和bsonType字符串添加到字段数组中的文档中：

   const encryptedFieldsObject = {
      fields: [
         {
            path: "myDocumentField",
            bsonType: "int"
         }
      ]
   }

   Important

   You can specify any field for encryption except the _id field.您可以指定除_id字段之外的任何加密字段。

2. Optionally, set a keyId field with the DEK ID.（可选）使用DEK ID设置keyId字段。

   Important

   Key IDs must be unique, otherwise the server returns an error.键ID必须是唯一的，否则服务器将返回错误。

   By configuring AutoEncryptionSettings on the client, you can use the createEncryptedCollection helper method to create keys automatically.通过在客户端配置AutoEncryptionSettings，您可以使用createEncryptedCollection辅助方法自动创建键。

   {
      path: "myDocumentField",
      bsonType: "int",
      keyId: "<unique data encryption key>"
   }

Enable equality queries on desired fields.在所需字段上启用相等查询。

This enables querying with the $eq, $ne, $in, and $nin operators.这允许使用$eq、$ne、$in和$nin运算符进行查询。

Add the queries object and set queryType to "equality":添加queries对象并将queryType设置为"equality"：

{
   path: "myDocumentField",
   bsonType: "int",
   queries: { queryType: "equality" }
}

Enable range queries on desired fields.在所需字段上启用范围查询。

This enables querying with the $lt, $lte, $gt, and $gte operators.这允许使用$lt、$lte、$gt和$gte运算符进行查询。

For details on how the following options affect security and performance, see Configure Encrypted Fields for Optimal Search and Storage.有关以下选项如何影响安全性和性能的详细信息，请参阅配置加密字段以实现最佳搜索和存储。

1. Add the queries object and set queryType to "range":添加queries对象并将queryType设置为"range"：

   {
      path: "myDocumentRangeField",
      bsonType: "int",
      queries: { queryType: "range" }
   }

2. Set the following fields:设置以下字段：

   Field字段	Type类型	Description描述
   min and max	Same as field bsonType	Required if bsonType is decimal or double. 如果bsonType为十进制或双精度，则为必填项。Optional but highly recommended if it is int, long, or date. Defaults to the minimum and maximum values of the bsonType.可选，但强烈建议使用int、long或date。默认为bsonType的最小值和最大值。 When possible, specifying bounds on a query improves performance. If querying values outside of these inclusive bounds, MongoDB returns an error.如果可能，在查询上指定边界可以提高性能。如果查询这些包含边界之外的值，MongoDB将返回错误。

   {
      path: "myDocumentRangeField",
      bsonType: "int",
      queries: { queryType: "range",
                 min: 0,
                 max: 1200
      }
   }

Enable prefix, suffix, or substring queries on desired fields.在所需字段上启用前缀、后缀或子字符串查询。

These query types are for string fields only. You can enable both prefixPreview and suffixPreview on the same field, but can't enable either if using substringPreview.这些查询类型仅适用于string字段。您可以在同一字段上同时启用prefixPreview和suffixPreview，但如果使用subscribeReview，则无法启用两者。

• prefixPreview queries enable the 查询启用了$encStrStartsWith and 和$encStrNormalizedEq aggregation expressions.聚合表达式。
• suffixPreview queries enable the 查询启用了$encStrEndsWith and 和$encStrNormalizedEq aggregation expressions.聚合表达式。
• substringPreview queries enable the 查询启用了$encStrContains and 和$encStrNormalizedEq aggregation expressions.聚合表达式。

1. Add the queries object and set queryType to "prefixPreview", "suffixPreview", or "substringPreview":

   {
      path: "myDocumentStringField",
      bsonType: "string",
      queries: { queryType: "substringPreview" }
   }

2. Set the following fields.设置以下字段。

   For details on how they affect security and performance, see Configure Encrypted Fields for Optimal Search and Storage.有关它们如何影响安全性和性能的详细信息，请参阅配置加密字段以实现最佳搜索和存储。

   Field字段	Type类型	Description描述
   strMaxLength	integer整数	substringPreview queries only. The maximum allowed length for a substring-indexed field.仅限查询。子字符串索引字段的最大允许长度。
   strMinQueryLength	integer整数	The minimum allowed prefix/suffix/substring length to query.允许查询的最小前缀/后缀/子字符串长度。
   strMaxQueryLength	integer整数	The maximum allowed prefix/suffix/substring length to query.允许查询的最大前缀/后缀/子字符串长度。 IMPORTANT: This setting strongly impacts query performance. Limit it whenever possible.此设置强烈影响查询性能。尽可能限制它。
   caseSensitive	Boolean布尔值	Optional. 可选。Whether queries are case-sensitive. Defaults to true.查询是否区分大小写。默认为true。
   diacriticSensitive	Boolean布尔值	Optional. 可选。Whether queries are diacritic-sensitive. Defaults to true.查询是否对变音符号敏感。默认为true。

   {
      path: "myDocumentStringField",
      bsonType: "string",
      queries: {
         "queryType": "substringPreview",
         "strMaxLength": 30,
         "strMinQueryLength": 1,
         "strMaxQueryLength": 20,
         "caseSensitive": false
      }
   }