MongoDB\Driver\ClientEncryption::encrypt

參數

value

要加密的值。任何可以插入 MongoDB 的值都可以使用此方法加密。

options

加密選項

選項	型別	描述
algorithm	字串	要使用的加密演算法。此選項為必填。指定下列其中一個ClientEncryption 常數 MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_DETERMINISTIC MongoDB\Driver\ClientEncryption::AEAD_AES_256_CBC_HMAC_SHA_512_RANDOM MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED MongoDB\Driver\ClientEncryption::ALGORITHM_UNINDEXED MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE
contentionFactor	整數	用於評估具有索引加密 payload 的查詢的競爭因素。 僅當 algorithm 為 MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED 或 MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE 時，才適用此選項且只能指定此選項。
keyAltName	字串	透過 keyAltName 識別 key vault 集合文件。此選項與 keyId 互斥，且必須指定其中一個。
keyId	MongoDB\BSON\Binary	透過 _id 識別資料金鑰。值為 UUID (二進位子型別 4)。此選項與 keyAltName 互斥，且必須指定其中一個。
queryType	字串	用於評估具有索引加密 payload 的查詢的查詢類型。指定下列其中一個ClientEncryption 常數 MongoDB\Driver\ClientEncryption::QUERY_TYPE_EQUALITY MongoDB\Driver\ClientEncryption::QUERY_TYPE_RANGE 僅當 algorithm 為 MongoDB\Driver\ClientEncryption::ALGORITHM_INDEXED 或 MongoDB\Driver\ClientEncryption::ALGORITHM_RANGE 時，才適用此選項且只能指定此選項。
rangeOpts	陣列	支援「範圍」查詢的可查詢加密欄位的索引選項。以下選項必須與目標集合的 encryptedFields 中設定的值一致。對於 double 和 decimal128 BSON 欄位類型，min、max 和 precision 必須全部設定或全部不設定。 範圍索引選項 選項 型別 描述 min 混合 如果設定 precision，則為必填。範圍的最小 BSON 值。 max 混合 如果設定 precision，則為必填。範圍的最大 BSON 值。 sparsity 整數 選用。正 64 位元整數。 precision 整數 選用。正 32 位元整數，指定用於明確加密的精度。只能為 double 或 decimal128 BSON 欄位類型設定。 trimFactor 整數 選用。正 32 位元整數。