クラス: Mongo::Protocol::Reply

継承:
メッセージ すべて表示
定義:
lib/mongo/プロトコル/reply.rb

Overview

応答を表す MongoDB ワイヤプロトコル メッセージ

例:

socket = TCPSocket.new('localhost', 27017)
query = Protocol::Query.new('xgen', 'users', {:name => 'Tyler'})
socket.write(query)
reply = Protocol::Reply::deserialize(socket)

名前空間で定義済み

クラス: アップ変換

定数の概要

メッセージから継承された定数

メッセージ::バッチ_サイズ、メッセージ::COLLECTION 、メッセージ::LITIT 、メッセージ:MAX_MESSAGE_SIZE 、 メッセージ:: ORDER 、メッセージ::Q

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

メッセージから継承された属性

#request_id

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

メッセージから継承されたメソッド

================================================================================ 、#serialize 、 # set_request_id

IDに含まれるメソッド

次が含まれます:

コンストラクターの詳細

このクラスは、 Mongo::Protocol::Messageからコンストラクターを継承します。

インスタンス属性の詳細

#cursor_id ⇒ Fixnum

この応答のカーソル ID を返します。 追加の結果がない場合は、0 になります。

次の値を返します。

  • (Fixnum) —

    この応答のカーソル ID。 追加の結果がない場合は、0 になります。


103
 
# ファイル 'lib/mongo/プロトコル/reply.rb', 行 103

フィールド :cursor_id, Int64

ドキュメント 数: 配列[Hash]<Hash>

この応答内のドキュメントを返します。

次の値を返します。

  • （ <Hash>配列 ） —

    この応答内のドキュメント。


115
 
# ファイル 'lib/mongo/プロトコル/reply.rb', 行 115

フィールド :documents, ドキュメント, :@number_returned

#flags ⇒ Array<Symbol>

この応答のフラグを返します。

サポートされているフラグ: :cursor_not_found 、 :query_failure 、 :shard_config_stale 、 :await_capable 。

次の値を返します。

  • （配列未満

    この応答のフラグ。

    サポートされているフラグ: :cursor_not_found 、 :query_failure 、 :shard_config_stale 、 :await_capable


98
 
# ファイル 'lib/mongo/プロトコル/reply.rb', 行 98

フィールド :flags, BitVector.新着情報(FLAGS)

# number_returned =修正値

この応答内のドキュメントの数を返します。

次の値を返します。

  • (Fixnum) —

    この応答内のドキュメントの数。


111
 
# ファイル 'lib/mongo/プロトコル/reply.rb', 行 111

フィールド :number_returned, Int32

開始_から = 修正数

この応答のカーソルの開始位置を返します。

次の値を返します。

  • (Fixnum) —

    この応答のカーソルの開始位置。


107
 
# ファイル 'lib/mongo/プロトコル/reply.rb', 行 107

フィールド :starting_from, Int32

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

# cursor_not_ find? = true 、 false

応答に カーソルが見つからない フラグが立てられているかどうかを判断します。

例:

応答に カーソルが見つかりません 。

reply.cursor_not_found?

次の値を返します。

  • （ true 、 false ） —

    クエリ カーソルが見つからなかった場合、

以来

  • 2.2.3

[ソースを表示]

52
53
54
 
# ファイル 'lib/mongo/プロトコル/reply.rb', 行 52

デフォルト cursor_not_ find?
  flags.include?(: cursor_not_ find)
end

ペイロード= BSON::Document

モニタリングのイベント ペイロードを返します。

例:

イベントのペイロードを返します。

message.payload

次の値を返します。

  • （ BSON::Document ） —

    イベントのペイロード。

以来

  • 2.1.0

[ソースを表示]

64
65
66
67
68
69
 
# ファイル 'lib/mongo/プロトコル/reply.rb', 行 64

デフォルト ペイロード
  BSON::ドキュメント.新着情報(
    応答: アップ変換.コマンド,
    request_id: request_id
  )
end

クエリ_失敗 = true 、 false

応答にクエリ失敗フラグがあったかどうかを判断します。

例:

応答でクエリが失敗したか。

reply.query_failure?

次の値を返します。

  • （ true 、 false ） —

    クエリが失敗した場合。

以来

  • 2.0.5

[ソースを表示]

40
41
42
 
# ファイル 'lib/mongo/プロトコル/reply.rb', 行 40

デフォルト query_failure?
  flags.include?(:query_failure)
end