Class: Mongo::Protocol::Query::Upconverter

継承:
オブジェクト
  • オブジェクト
すべて表示
定義:
lib/mongo/プロトコル/query.rb

Overview

レガシークエリ メッセージを適切な OP_COMMAND スタイルのメッセージに変換します。

以来

  • 2.1.0

定数の概要の削減

OPTION_MAPPINGS =

オプションを find コマンド オプションにマッピングします。

以来

  • 2.1.0

{
  プロジェクト: 「プロジェクション」,
  skip: 'skip',
  limit: 'limit',
  batch_size: ' batchSize '
}.freeze
特別な_FILD_MAPます。

以来

  • 2.1.0

{
  :$readPreference => ' $readPreference ',
  :$orderby => 'sort',
  :$hint => 'hint',
  :$comment => 'comment',
  :$returnKey => 'returnKey',
  :$snapshot => 'スナップショット',
  :$maxScan => 'maxScan',
  :$max => 'max',
  :$min => 'min',
  :$maxTimeMS => 'maxTimeMS',
  :$showDiskLoc => ' showRecordId ',
  :$explain => ' explain '
}.freeze
FLAG_MAPMAPINGS =

コマンド オプションを見つけるためのフラグのマッピング。

以来

  • 2.1.0

{
  tailable_cursor: ' tailable ',
  oplog_replace: 'oplogReplay',
  no_cursor_timeout: 'noCursorTimeout',
  await_data: 'awaitData',
  部分的: ' allowPartialResults '
}.freeze

インスタンス属性の概要を折りたたむ

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

コンストラクターの詳細

#初期化（コレクション、フィルター、オプション、フラグ） = アップ変換

アップコンバーターをインスタンス化します。

例:

アップコンバーターをインスタンス化します。

Upconverter.new('users', { name: 'test' }, { skip: 10 })

パラメーター:

  • コレクション ( string ) —

    コレクションの名前。

  • フィルター （ BSON::Document 、 Hash ） —

    フィルターまたは コマンド。

  • options （ BSON::Document 、 Hash ） —

    オプション。

  • flags （配列未満

    フラグ。

次の値が発生します。

  • (ArgumentError)

以来

  • 2.1.0



279
280
281
282
283
284
285
286
287
288
289
290
 
# ファイル 'lib/mongo/プロトコル/query.rb', 行 279

デフォルト 初期化(コレクション, フィルター, options, flags)
  # ドキュメント文字列はハッシュと BSON:Documents の両方を要求しますが、
  は受け入れられますが、このクラスではフィルターとオプションが次のようにされることを想定しています。
  # には、操作層が生成するものではないシンボル キーが含まれています。
  発生 ArgumentError, 'フィルターは、異なるアクセスを提供する必要があります' ただし、 フィルター.is_a?(BSON::ドキュメント)
  発生 ArgumentError, 'オプションは異なるアクセスを提供する必要があります' ただし、 options.is_a?(BSON::ドキュメント)

  @collection = コレクション
  @filter = フィルター
  @options = options
  @flags = flags
end

インスタンス属性の詳細

#コレクション= string （読み取り専用）

コレクションの名前を返します。

次の値を返します。

  • ( string ) —

    collection コレクションの名前。

以来

  • 2.1.0



257
258
259
 
# ファイル 'lib/mongo/プロトコル/query.rb', 行 257

デフォルト コレクション
  @collection
end

#フィルター= BSON::Document 、ハッシュ（読み取り専用）

フィルター のクエリフィルター、または コマンドを返します。

次の値を返します。

  • （ BSON::Document 、 Hash ） —

    filter クエリフィルターまたは コマンド。

以来

  • 2.1.0



260
261
262
 
# ファイル 'lib/mongo/プロトコル/query.rb', 行 260

デフォルト フィルター
  @filter
end

#フラグ=配列 < Symbol > （読み取り専用）

フラグを フラグを返します。

次の値を返します。

  • （配列未満

    詳細は、 フラグをご覧ください。

以来

  • 2.1.0



266
267
268
 
# ファイル 'lib/mongo/プロトコル/query.rb', 行 266

デフォルト flags
  @flags
end

オプション= BSON::Document 、ハッシュ（読み取り専用）

オプション オプションを返します。

次の値を返します。

  • （ BSON::Document 、 Hash ） —

    options のオプション。

以来

  • 2.1.0



263
264
265
 
# ファイル 'lib/mongo/プロトコル/query.rb', 行 263

デフォルト options
  @options
end

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

#command ⇒ BSON::Document

アップ変換された コマンドを取得します。

例:

コマンドを取得します。

upconverter.command

次の値を返します。

  • （ BSON::Document ） —

    アップ変換された コマンド。

以来

  • 2.1.0



300
301
302
 
# ファイル 'lib/mongo/プロトコル/query.rb', 行 300

デフォルト コマンド
  コマンドは？ ? op_command : find_command
end

# command_name = string

コマンドの名前を取得します。コレクションが $cmd の場合は、フィルター内の最初のキーであり、それ以外の場合は find になります。

例:

コマンド名を取得します。

upconverter.command_name

次の値を返します。

  • ( string ) —

    コマンド名。

以来

  • 2.1.0



313
314
315
 
# ファイル 'lib/mongo/プロトコル/query.rb', 行 313

デフォルト command_name
  ((フィルター[:$query] || !コマンドは？) ? :find : フィルター.キー.最初に).to_s
end