正在使用的加密方法

注意

有关特定方法（包括事务语法和示例）的详细信息，请单击该方法的参考页面链接。

mongosh ClientEncryption 方法需要启用正在使用的加密的数据库连接。如果当前数据库连接不是在启用正在使用的加密的情况下启动的，则：

使用 Mongo() 中的 mongosh 构造函数与所需的正在使用的加密选项建立连接。Mongo() 方法支持以下用于客户主密钥(集合扫描)管理的KMS (KMS ) 提供商：
or
使用 mongosh 命令行选项，用所需选项建立连接。命令行选项仅支持用于 CMK 管理的 Amazon Web Services KMS 提供商。

以下方法仅适用于 mongosh 。有关使用MongoDB驾驶员实施客户端字段级加密(CSFLE) 或Queryable Encryption(QE) 的说明，请参阅驾驶员文档。有关支持的驱动程序，请参阅客户端字段级加密兼容性或Queryable Encryption兼容性。

带别名的命令被分组在一起。

名称	CSFLE	量化宽松	说明
`getKeyVault()`	✓	✓	返回当前 MongoDB 连接的密钥保管库对象。
`KeyVault.createKey()` `KeyVault.createDataKey()`	✓	✓	创建数据加密密钥，用于客户端字段级加密。
`KeyVault.deleteKey()`	✓	✓	从密钥保管库中删除指定的数据加密密钥。
`KeyVault.getKey()`	✓	✓	从密钥保管库中检索指定的数据加密密钥。
`KeyVault.getKeys()`	✓	✓	检索密钥保管库中的所有密钥。
`KeyVault.addKeyAlternateName()` `KeyVault.addKeyAltName()`	✓	✓	将密钥备用名称与指定的数据加密密钥关联。
`KeyVault.removeKeyAlternateName()` `KeyVault.removeKeyAltName()`	✓	✓	从指定的数据加密密钥中删除密钥备用名称。
`KeyVault.getKeyByAltName()`	✓	✓	检索具有指定密钥替代名称的密钥。
`KeyVault.rewrapManyDataKey()`	✓	✓	解密多个数据密钥，并使用新的主密钥对其重新加密。
`getClientEncryption()`	✓	✓	返回客户端加密对象，以支持字段的显式加密/解密。
`ClientEncryption.createEncryptedCollection()`	✓	✓	创建包含加密字段的集合。
`ClientEncryption.encrypt()`	✓	✓	使用指定的数据加密密钥和加密算法对字段进行加密。
`ClientEncryption.encryptExpression()`		✓	使用指定的数据加密密钥和加密选项对查询表达式进行加密。
`ClientEncryption.decrypt()`	✓	✓	使用关联的数据加密密钥和加密算法对字段进行解密。

后退

SessionOptions

来年

ClientEncryption.createEncryptedCollection