类：Mongo::Operation::Aggregate::Result

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

Overview

定义聚合上下文中结果的自定义行为。

由于：

  • 2.0.0

常量摘要折叠

EXPLAIN =

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

聚合解释信息的字段名称。

由于：

  • 2.0.5

' stages '.冻结
EXPLAIN_LEGACY =

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

聚合解释信息的传统字段名称。

由于：

  • 2.0.5

' serverPipeline '.冻结

从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 , #returned_count , #snapshot_timestamp , # success ? 、 #topology_version 、 #validate! , #write_concern_error? , #liter_count

构造函数详情

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

实例方法详细信息

# cursor_id = " Integer "

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

注意：

尽管传输协议具有适用于所有回复类型消息的 cursor_id字段，但在使用聚合框架时该字段始终为零，并且必须从游标文档本身中检索。 万新！

获取结果的游标ID。

例子：

获取游标 ID。

result.cursor_id

返回：

  • ( Integer ) —

    游标 ID。

由于：

  • 2.0.0



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

def cursor_id
  cursor_document ? cursor_document[CURSOR_ID] : 0
end

# 个documents ⇒ Array<BSON::Document>

获取聚合结果的文档。 它可以是第一个文档的“结果”字段，或者如果选择了游标选项，则它是返回的第一个文档的“游标”字段中的“firstBatch”字段。 否则，它是一个 解释文档。

例子：

获取文档。

result.documents

返回：

  • ( Array<BSON::Document> ) —

    文档。

由于：

  • 2.0.0



79
80
81
82
83
84
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/aggregate/result.rb', 第79行

def 文档
  docs = 回复.文档[0][结果]
  docs ||= cursor_document[FIRST_BATCH] if cursor_document
  docs ||= explain_document
  docs
end

# post_batch_resume_token ⇒ BSON::Document | nil

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

获取结果的帖子批处理恢复令牌

返回：

  • ( BSON::Document | nil ) —

    帖子批处理恢复令牌

由于：

  • 2.0.0



63
64
65
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/aggregate/result.rb', 第63行

def post_batch_resume_token
  cursor_document ? cursor_document['postBatchResumeToken'] : nil
end