クライアント側のフィールドレベル暗号化メソッド

注意

構文や例など、特定のメソッドの詳細については、「メソッドの参照ページ」へのリンクをクリックしてください。

mongoshクライアント側のフィールドレベル暗号化メソッドでは、クライアント側のフィールドレベル暗号化が有効になっているデータベース接続が必要です。現在のデータベース接続がクライアント側のフィールドレベル暗号化を有効にして開始されなかった場合、次のいずれかが発生します。

Mongo()必要なクライアント側のフィールドレベル暗号化オプションとの接続を確立するには、mongosh からコンストラクターを使用します。Mongo()メソッドは、CMK（Customer Master Key）管理用に次のKMS （ KMS ）プロバイダーをサポートしています。
or
必要なオプションとの接続を確立するには、 mongoshコマンドラインオプションを使用します。コマンドラインオプションは、CMK 管理用のAmazon Web Services KMSプロバイダーのみをサポートしています。

次のメソッドはmongoshのみのです。 MongoDB ドライバーを使用してクライアント側のフィールドレベル暗号化を実装する手順については、ドライバーのドキュメントを参照してください。クライアント側のフィールドレベル暗号化をサポートするドライバーの完全なリストについては、「クライアント側フィールドレベル暗号化ドライバーの互換性」を参照してください。

名前	説明
`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

ClientEncryption.createEncryptedCollection