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

继承：
操作::结果
  • 对象
显示全部
定义于：
lib/ Mongo/operation/aggregate/result.rb

Overview

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

由于：

  • 2.0.0

常量摘要折叠

EXPLAIN =

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

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

由于：

  • 2.0.5

'阶段'
EXPLAIN_LEGACY =

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

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

由于：

  • 2.0.5

'serverPipeline'

实例方法摘要折叠

实例方法详细信息

# cursor_id = " Integer "

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

注意：

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

获取结果的游标ID。

例子：

获取游标 ID。

result.cursor_id

返回：

  • ( Integer ) —

    游标 ID。

由于：

  • 2.0.0



51
52
53
 
# File 'lib/ Mongo/operation/aggregate/result.rb', line 51

def cursor_id
  cursor_document ? cursor_document[CURSOR_ID] : 0
end

# 个documents ⇒ Array<BSON::Document>

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

例子：

获取文档。

result.documents

返回：

  • ( Array<BSON::Document> ) —

    文档。

由于：

  • 2.0.0



76
77
78
79
80
81
 
# File 'lib/ Mongo/operation/aggregate/result.rb', line 76

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



60
61
62
 
# File 'lib/ Mongo/operation/aggregate/result.rb', line 60

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