“文档” 菜单

/

/

/

客户端字段级加密方法客户端

注意

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

mongosh客户端字段级加密方法需要启用客户端字段级加密的数据库连接。如果当前数据库连接不是在启用客户端字段级加密的情况下启动的，则：

使用Mongo() 中的mongosh 构造函数与所需的客户端字段级加密选项建立连接。Mongo() 方法支持以下用于客户主密钥 (CMK) 管理的密钥管理服务 (KMS) 提供商：
或是
使用 mongosh 命令行选项，用所需选项建立连接。命令行选项仅支持用于 CMK 管理的 Amazon Web Services KMS 提供商。

以下方法mongosh 仅适用于 。有关使用 MongoDB 驱动程序实施客户端字段级加密的说明，请参阅驱动程序文档。有关支持客户端字段级加密的兼容驱动程序的完整列表，请参阅 CSFLE 兼容性。

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

← SessionOptions

getKeyVault() →