创建加密模式

创建加密模式。

包含一个带有嵌套fields大量的 encryptedFieldsObject ：

const encryptedFieldsObject = {
   fields: []
}

指定要加密的字段。

1. 将path和bsonType字符串添加到文档的字段大量中：

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

   重要

   您可以指定除 _id 字段之外的任何字段进行加密。

2. （可选）设立具有 DEK ID的 keyId字段。

   重要

   密钥 ID 必须是唯一的，否则服务器会返回错误。

   通过在客户端上配置 AutoEncryptionSettings，您可以使用 createEncryptedCollection 辅助方法自动创建密钥。

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

对所需字段启用相等查询。

这样就可以使用$eq 、 $ne 、 $in和$nin操作符进行查询。

添加queries对象设立queryType设置为"equality" ：

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

对所需字段启用范围查询。

这样就可以使用$lt 、 $lte 、 $gt和$gte操作符进行查询。

有关以下选项如何影响安全性和性能的详细信息，请参阅配置加密字段以实现最佳搜索和存储。

1. 添加queries对象设立queryType设置为"range" ：

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

2. 设置以下字段：

   字段	类型	说明
   最小值和最大值	与字段相同 bsonType	如果bsonType为decimal或double ，则为必填项。 可选，但如果为int 、 long或date ，则强烈建议使用。 默认为bsonType的最小值和最大值。 在可能的情况下，为查询指定边界可以提高性能。 如果查询的值超出这些包含边界， MongoDB将返回错误。

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

对所需字段启用前缀、后缀或子字符串查询。

这些查询类型仅适用于 string 字段。您可以在同一字段上同时启用prefixPreview 和 suffixPreview，但如果使用 substringPreview，则无法启用任何一个。

• prefixPreview 查询启用$encStrStartsWith 和 $encStrNormalizedEq聚合表达式。

• suffixPreview 查询启用$encStrEndsWith 和 $encStrNormalizedEq聚合表达式。

• substringPreview 查询启用$encStrContains 和 $encStrNormalizedEq聚合表达式。

1. 添加 queries对象并将 queryType设立为 "prefixPreview"、"suffixPreview" 或 "substringPreview"：

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

2. 设置以下字段。

   有关它们如何影响安全和性能的详细信息，请参阅配置加密字段以实现最佳搜索和存储。

   字段	类型	说明
   strMaxLength	整型	substringPreview 仅限查询。子字符串索引字段的最大允许长度。
   strMinQueryLength	整型	允许的最小前缀/后缀/子字符串长度。
   strMaxQueryLength	整型	要查询的最大允许前缀/后缀/子字符串长度。 重要提示：此设置会严重影响查询性能。尽可能限制它。
   caseSensitive	布尔	可选。查询是否区分大小写。默认为 true。
   diacriticSensitive	布尔	可选。查询是否区分变音符号。默认为 true。

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