クラス: Mongo::Crypt::ExpriteEncryptionContext Private

継承:
Context
  • オブジェクト
すべて表示
定義:
build/ruby-Driver-v 2.19 /lib/mongo/crypt/explit_encryption_context.rb

Overview

このクラスは、プライベート API の一部です。 このクラスは将来削除または変更される可能性があるため、可能な限り使用しないでください。

明示的な暗号化のために初期化された Context オブジェクト

既知のサブクラスを直接確認

ExplainEncryptionExpressionContext

インスタンス属性の概要

コンテキストから継承される属性

#ctx_p

インスタンス メソッドの概要を折りたたむ

Contextから継承されたメソッド

#run_化_マシン 、 #化

コンストラクターの詳細

#初期化（ mongocrypt , io, doc, オプション = {{}） = ExpressEncryptionContext

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

注：

RangePreview アルゴリズムは実験的なもののみです。 対象ではありません

新しい明示的暗号化コンテキスト オブジェクトの作成

パブリックで使用します。

パラメーター:

  • mongocrypt （ Mongo::Crypt::Handle ） —

    新しい mongocrypt_ctx_t の作成に使用される mongocrypt_t オブジェクトをラップするハンドル

  • io （ ClientEncryption::IO ） —

    ステート マシンの実行に必要なドライバー I/O メソッドを実装する IO クラスのインスタンス

  • doc （ BSON::Document ） —

    暗号化するドキュメント

  • options （ハッシュ） （デフォルトは{}です）

オプション ハッシュ（ options ）:

  • :key_id （ BSON::Binary ） —

    暗号化に使用するデータキーの UUID を表す :uuid の BSON::Binary オブジェクト。

  • :key_alt_name （ string ） —

    値を暗号化するために使用されるデータキーの別名。

  • : アルゴリズム （ string ） —

    値を暗号化するために使用されるアルゴリズム。 有効なアルゴリズムは、AEAD_AES_ 256 256 512 512 -Detailinstrict

  • :contention_factor (Integer | nil) —

    暗号化アルゴリズムが インデックス付き に設定されている場合に適用される競合係数。 指定しない場合、デフォルトは0の値になります。 競合係数は、暗号化アルゴリズムが [ Indexed（インデックス付き） ] に設定されている場合にのみ設定する必要があります。

  • query_type （ string | nil ） —

    暗号化アルゴリズムが Indexed または RangePreview に設定されている場合に適用されるクエリ タイプ。 許可される値は "equality" と "rangePreview" です。

  • :range_opts （ハッシュ | nil ） —

    rangePreview クエリをサポートする Queryable Encryption フィールドのインデックス オプションを指定します。 許可されるオプションは次のとおりです。

    • :min

    • :max

    • :sparsity

    • : 精度

    min、max、スパース、および範囲は、宛先コレクションの encryptedField に設定されている値と一致する必要があります。 doubleと decimal128 の場合は、最小値/最大値/精度はすべて設定されるか、すべてが設定されていない必要があります。

次の値が発生します。



66
67
68
69
70
71
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/crypt/explit_encryption_context.rb', 行66

デフォルト 初期化(mongocrypt, io, doc, options = {})
  スーパー(mongocrypt, io)
  set_key_opts(options)
  set_algorithm_opts(options)
  init(doc)
end

インスタンス メソッドの詳細

# init （ドキュメント） =オブジェクト

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。 



73
74
75
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/crypt/explit_encryption_context.rb', 行73

デフォルト init(doc)
  バインディング.ctx_explicit_encrypt_init(自己, doc)
end