クラス: Mongo::Database::CursorCommandView Private

継承:
オブジェクト
  • オブジェクト
すべて表示
定義:
lib/mongo/データベース/cursor_command_view.rb

Overview

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

コレクション クエリからではなく、任意のコマンド応答からビルドされる場合にカーソルが必要とする最小限のビュー。

getMore 固有のオプション (batchSize、maxTimeMS、comment)、カーソルのタイプ、タイムアウト モードを持ち、カーソル がビューから読み取るいくつかのメソッドに答えます。

以来

  • 2.0.0

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

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

コンストラクターの詳細

#initialize(database, options = {}) ⇒ CursorCommandView

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

CursorCommandView の新しいインスタンスを返します。

パラメーター:

  • database （ Mongo::Database ） —

    コマンドが実行されたデータベース。

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

    getMore オプションとタイムアウト オプション。

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

  • :batch_size （整数） —

    getMores の batchSize。

  • :max_time_ms （整数） —

    getMores の maxTimeMS。

  • :comment （オブジェクト） —

    getMores のコメント。

  • : cursor_type （記号） —

    :tailable または :tailable_await。

  • :timeout_mode （記号） —

    :cursor_lifetime または :iteration。

以来

  • 2.0.0



36
37
38
39
 
# ファイル 'lib/mongo/データベース/cursor_command_view.rb', 行 36

デフォルト 初期化(database, options = {})
  @database = database
  @options = options
end

インスタンス属性の詳細

#database ⇒ Mongo::Database (readonly)

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

返り値: コマンドが実行されたデータベース。

次の値を返します。

  • （ Mongo::Database ） —

    コマンドが実行されたデータベース。

以来

  • 2.0.0



42
43
44
 
# ファイル 'lib/mongo/データベース/cursor_command_view.rb', 行 42

デフォルト database
  @database
end

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

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

ビュー オプションを返します。カーソルによって getMore コメントを読み取るために使用されます。

次の値を返します。

  • （ハッシュ） —

    表示オプション。カーソルによって getMore コメントを読み取るために使用されます。

以来

  • 2.0.0



46
47
48
 
# ファイル 'lib/mongo/データベース/cursor_command_view.rb', 行 46

デフォルト options
  @options
end

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

#batch_size ⇒ Integer | nil

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

getMore コマンドで送信された batchSize を返します。

次の値を返します。

  • (Integer | nil) —

    getMore コマンドで送信される batchSize。

以来

  • 2.0.0



63
64
65
 
# ファイル 'lib/mongo/データベース/cursor_command_view.rb', 行 63

デフォルト batch_size
  options[:batch_size]
end

#クライアント ⇒ Mongo::Client

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

クライアントを返します。

次の値を返します。

以来

  • 2.0.0



49
50
51
 
# ファイル 'lib/mongo/データベース/cursor_command_view.rb', 行 49

デフォルト クライアント
  database.クライアント
end

#コレクション Mongo::Collection

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

カーソルがクライアントとデータベースにアクセスできるようにのみ使用されるプレースホルダー コレクション。getMore と killCursors の実際の名前空間は、このコレクションからではなく、コマンド応答から取得されます。

次の値を返します。

以来

  • 2.0.0



58
59
60
 
# ファイル 'lib/mongo/データベース/cursor_command_view.rb', 行 58

デフォルト コレクション
  @collection ||= コレクション.新着情報(database, '$cmd')
end

#cursor_type ⇒ Symbol | nil

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

戻り値 カーソルの種類。

次の値を返します。

  • (Symbol | nil) —

    カーソルの種類。

以来

  • 2.0.0



73
74
75
 
# ファイル 'lib/mongo/データベース/cursor_command_view.rb', 行 73

デフォルト cursor_type
  options[: cursor_type]
end

#limit ⇒ Object

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

カーソルは、コマンド応答からビルドされた場合、制限をサポートしません。

以来

  • 2.0.0



90
91
92
 
# ファイル 'lib/mongo/データベース/cursor_command_view.rb', 行 90

デフォルト limit
  nil
end

#max_time_ms_for_get_more = 整数 | nil

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

getMore コマンドで送信された maxTimeMS を返します。

次の値を返します。

  • (Integer | nil) —

    getMore コマンドで送信される maxTimeMS。

以来

  • 2.0.0



68
69
70
 
# ファイル 'lib/mongo/データベース/cursor_command_view.rb', 行 68

デフォルト max_time_ms_for_get_more
  options[:max_time_ms]
end

# operation_timeouts（opts = {}） = ハッシュ

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

操作コンテキストのタイムアウト値を返します。

次の値を返します。

  • （ハッシュ） —

    操作コンテキストのタイムアウト値。

以来

  • 2.0.0



83
84
85
 
# ファイル 'lib/mongo/データベース/cursor_command_view.rb', 行 83

デフォルト operation_timeouts(ops = {})
  database.operation_timeouts(ops)
end

#timeout_mode ⇒ Symbol | nil

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

返り値: タイムアウト モード。

次の値を返します。

  • (Symbol | nil) —

    タイムアウト モード。

以来

  • 2.0.0



78
79
80
 
# ファイル 'lib/mongo/データベース/cursor_command_view.rb', 行 78

デフォルト timeout_mode
  options[:timeout_mode]
end