MongoDB\Driver\ClientEncryption::removeKeyAltName()函数—用法及示例

函数名：MongoDB\Driver\ClientEncryption::removeKeyAltName()

适用版本：MongoDB PHP扩展版本 1.7.0+

用法：此方法用于从客户端加密配置中删除一个密钥的备用名称。

语法：public function removeKeyAltName(string $keyAltName): void

参数：

• $keyAltName：要删除的密钥的备用名称，为一个字符串。

返回值：无返回值。

示例：

<?php
// 创建一个客户端加密配置对象
$encryption = new MongoDB\Driver\ClientEncryption([
    'keyVaultNamespace' => 'encryption.keys',
    'kmsProviders' => [
        'aws' => [
            'accessKeyId' => 'your-access-key-id',
            'secretAccessKey' => 'your-secret-access-key',
        ],
    ],
]);

// 删除密钥的备用名称
$encryption->removeKeyAltName('myKeyAltName');

echo "密钥备用名称已成功删除！";
?>

注意事项：

• 在调用此方法之前，必须先通过MongoDB\Driver\ClientEncryption::createKey()方法创建一个密钥，并将其备用名称添加到客户端加密配置中。
• 如果要删除的备用名称不存在，该方法将不会引发任何错误或异常。
• 删除备用名称后，无法再使用该名称来引用该密钥。
• 删除备用名称不会删除实际的密钥，只是从客户端加密配置中删除对该备用名称的引用。