类：Mongo::Protocol::Reply

继承：
message
  • 对象
显示全部
定义于：
build/Ruby-driver-v 2.19 /lib/mongo/protocol/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)

在命名空间下定义

类： 上转换器

常量摘要

从Message继承的常量

Message::BATCH_SIZE 、 Message::COLLECTION 、 Message::LIMIT 、 Message::MAX_MESSAGE_SIZE 、 Message::ORDERED 、 Message::Q

实例属性摘要折叠

从Message继承的属性

#request_id

实例方法摘要折叠

从Message继承的方法

#== 、 deserialize 、 #hash 、 #initialize 、 # 屈指可数 ？ 、 #serialize 、 #set_request_id

ID中包含的方法

包含

构造函数详情

该类从Mongo::Protocol::Message继承了一个构造函数

实例属性详细信息

#cursor_id ⇒ Fixnum

返回 此响应的游标ID。 如果没有其他结果，则为零。

返回：

  • (Fixnum) —

    此响应的游标ID。 如果没有其他结果，则为零。



103
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/protocol/reply.rb', 第103行

字段 :cursor_id, Int64

# 个文档⇒ Array<Hash>

返回此回复中的文档。

返回：

  • ( Array<Hash> ) —

    本回复中的文档。



115
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/protocol/reply.rb', 第115行

字段 :documents, 文档, :@number_returned

#flags ⇒ Array<Symbol>

返回 此回复的标志。

支持的标志： :cursor_not_found 、 :query_failure 、 :shard_config_stale 、 :await_capable 。

返回：

  • ( Array< Symbol > ) —

    此回复的标志。

    支持的标志： :cursor_not_found 、 :query_failure 、 :shard_config_stale 、 :await_capable



98
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/protocol/reply.rb', 第98行

字段 :flags, BitVector.new(标记)

# number_returned =" Fixnum "

返回此回复中的文档数。

返回：

  • (Fixnum) —

    此回复中的文档数。



111
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/protocol/reply.rb', 第111行

字段 :number_returned, Int32

# startup_from =" Fixnum "

返回 此回复的游标的起始位置。

返回：

  • (Fixnum) —

    此回复的游标起始位置。



107
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/protocol/reply.rb', 第107行

字段 :starting_from, Int32

实例方法详细信息

# cursor_not_Found? ⇒ true , false

确定回复是否具有未找到游标标志。

例子：

回复是否有未找到游标标志。

reply.cursor_not_found?

返回：

  • ( true , false ) —

    如果未找到查询游标。

由于：

  • 2.2.3



52
53
54
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/protocol/reply.rb', 第52行

def cursor_not_Found?
  flags.包括？(:cursor_not_Found)
end

#有效负载⇒ BSON::Document

返回用于监控的事件负载。

例子：

返回事件有效负载。

message.payload

返回：

  • ( BSON::Document ) —

    事件有效负载。

由于：

  • 2.1.0



64
65
66
67
68
69
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/protocol/reply.rb', 第64行

def 有效负载
  BSON::文档.new(
    回复： 上转换器.命令,
    request_id: request_id
  )
end

# query_failure? ⇒ true , false

确定回复是否具有查询失败标志。

例子：

回复是否有查询失败。

reply.query_failure?

返回：

  • ( true , false ) —

    如果查询失败。

由于：

  • 2.0.5



40
41
42
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/protocol/reply.rb', 第40行

def query_failure?
  flags.包括？(:query_failure)
end