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()方法建立一個金鑰，並將其備用名稱新增到客戶端加密配置中。
• 如果要刪除的備用名稱不存在，該方法將不會引發任何錯誤或異常。
• 刪除備用名稱後，無法再使用該名稱來引用該金鑰。
• 刪除備用名稱不會刪除實際的金鑰，只是從客戶端加密配置中刪除對該備用名稱的引用。