类：Mongo::Operation::MapReduce::Result

继承：
结果
  • 对象
显示全部
定义于：
build/Ruby-driver-v 2.19 /lib/mongo/operation/map_reduce/result.rb

Overview

定义 Map Reduce 操作结果的自定义行为。

由于：

  • 2.0.0

常量摘要折叠

COUNTS =

此常量是私有 API 的一部分。 应尽可能避免使用此常量，因为它将来可能会被删除或更改。

map/reduce 的计数字段。

由于：

  • 2.0.0

' counts '.冻结
结果 =

此常量是私有 API 的一部分。 应尽可能避免使用此常量，因为它将来可能会被删除或更改。

不带游标的结果的字段名称。

由于：

  • 2.0.0

' Results '.冻结
TIME =

此常量是私有 API 的一部分。 应尽可能避免使用此常量，因为它将来可能会被删除或更改。

操作花费的时间恒定。

由于：

  • 2.0.0

' timeMillis '.冻结

从Result继承的常量

Result::CURSOR 、 Result::CURSOR_ID 、 Result::FIRST_BATCH 、 Result::N 、 Result::NAMESPACE 、 Result::NEXT_BATCH 、 Result::OK 、 Result::RESULT

实例属性摘要

从Result继承的属性

#connection_description 、 #connection_global_id 、 #replies

实例方法摘要折叠

从Result继承的方法

#acknowledged？ 、#cluster_time、# each 、# error 、# has_cursor_id? , #initialize , #inspect , #labels , 命名空间 , #ok? 、# operation_time 、#reply、#snapshot_timestamp、 #topology_version 、 # write_concern_error ？ , #liter_count

构造函数详情

该类从Mongo::Operation::Result继承了一个构造函数

实例方法详细信息

# counts ⇒哈希

从回复中获取 map/reduce 计数。

例子：

获取计数。

result.counts

返回：

  • (哈希) —

    结果计数的哈希值。

由于：

  • 2.0.0



55
56
57
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/map_reduce/result.rb', 第55行

def counts
  回复.文档[0][COUNTS]
end

# cursor_id = " Integer "

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

获取游标 ID。

例子：

获取游标 ID。

result.cursor_id

返回：

  • ( Integer ) —

    始终0 ，因为 map reduce 不返回游标。

由于：

  • 2.5.0



130
131
132
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/map_reduce/result.rb', 第130行

def cursor_id
  0
end

# 个documents ⇒ Array<BSON::Document>

从 map/reduce 中获取文档。

例子：

获取文档。

result.documents

返回：

  • ( Array<BSON::Document> ) —

    文档。

由于：

  • 2.0.0



68
69
70
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/map_reduce/result.rb', 第68行

def 文档
  回复.文档[0][结果] || 回复.文档[0][结果]
end

# returned_count ⇒整数

获取此批处理中服务器返回的文档数。

Map/Reduce 操作以内联方式返回文档，无需使用游标；因此，标准 Mongo::Reply#returned_count 无法正常用于 Map/Reduce。

请注意，Map/Reduce 操作在内联结果集中受到最大 BSON 文档大小 ( 16 MB) 的限制。

返回：

  • ( Integer ) —

    返回的文档数量。

由于：

  • 2.0.0



146
147
148
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/map_reduce/result.rb', 第146行

def returned_count
  回复.文档.长度
end

#成功？ ⇒ true , false

注意：

如果写入未被确认，则始终返回 true。

如果结果是命令，则确定是否成功。

例子：

命令成功吗？

result.successful?

返回：

  • ( true , false ) —

    如果命令成功。

由于：

  • 2.0.0



85
86
87
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/map_reduce/result.rb', 第85行

def 成功？
  !文档.nil?
end

# time ⇒整数

获取 map/reduce 的执行时间。

例子：

获取执行时间。

result.time

返回：

  • ( Integer ) —

    执行时间（以毫秒为单位）。

由于：

  • 2.0.0



98
99
100
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/map_reduce/result.rb', 第98行

def 时间
  回复.文档[0][时间]
end

# validate! ⇒结果

此方法是私有 API 的一部分。 您应尽可能避免使用此方法，因为它将来可能会被删除或更改。

注意：

这只检查写入错误，因为身份验证是在连接级别处理的，并且在创建结果之前，任何身份验证错误都会在那里引发。

通过检查是否存在任何错误来验证结果。

例子：

验证结果。

result.validate!

返回：

  • (结果) —

    验证通过后的结果。

引发：

由于：

  • 2.0.0



117
118
119
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/map_reduce/result.rb', 第117行

def validate!
  文档.nil? ? Raise_operation_failure : self
end