KeyVault.deleteKey()
KeyVault.deleteKey(UUID)
指定された UUID を持つデータ暗号化キーを、データベース接続に関連付けられたキーヴォールトから削除します。
deleteKey()
の構文は次のとおりです。keyVault = db.getMongo().getKeyVault() keyVault.deleteKey(UUID("<UUID String>")) UUIDは、サブタイプ
4
を持つ BSONbinary data
オブジェクトです。次の値を返します。 削除されたキーの数を示すドキュメント。
動作
データベース接続にクライアント側のフィールドレベル暗号化を構成する必要があります
mongosh
クライアント側のフィールド レベル暗号化メソッドでは、クライアント側のフィールド レベル暗号化が有効になっているデータベース接続が必要です。現在のデータベース接続がクライアント側のフィールド レベル暗号化を有効にして開始されなかった場合、次のいずれかが発生します。
Mongo()
必要なクライアント側のフィールドレベル暗号化オプションとの接続を確立するには、mongosh
から コンストラクターを使用します。Mongo()
メソッドは、CMK(Customer Master Key)管理のために次のKMS ( KMS )プロバイダーをサポートしています。or
必要なオプションとの接続を確立するには、
mongosh
コマンドライン オプションを使用します。 コマンドライン オプションは、CMK 管理用のAmazon Web Services KMSプロバイダーのみをサポートしています。
例
次の例は、クライアント側のフィールドレベル暗号化の迅速な評価を目的としています。 サポートされている各 KMSKeyVault.deleteKey()
プロバイダーで を使用する具体的な例については、「 データ暗号化キーの削除 」を参照してください。
暗号化されたクライアントの作成
データベース接続を作成するには、クライアント側のフィールドレベル暗号化オプションが構成されたMongo()
コンストラクターを使用します。 mongodb://myMongo.example.net
URI を、ターゲットクラスターの接続string URIに置き換えます。
encryptedClient = Mongo( "mongodb://myMongo.example.net:27017/?replSetName=myMongo", autoEncryptionOpts )
KeyVault
オブジェクトを取得し、 KeyVault.deleteKey()
メソッドを使用してUUID
と一致するデータ暗号化キーを削除します。
keyVault = encryptedClient.getKeyVault() keyVault.deleteKey(UUID("b4b41b33-5c97-412e-a02b-743498346079"))
成功した場合、 deleteKey()
は次のような出力を返します。
{ "acknowledged" : true, "deletedCount" : 1 }