类：Mongo::Collection::View::Aggregation

继承：

对象

• 对象
• Mongo::Collection::View::Aggregation

包括：

行为

定义于：

lib/ Mongo/ 集合/view/ 聚合、
lib/ Mongo/ 集合/view/ 聚合/behavior.rb

Overview

在集合视图上提供有关聚合管道的行为。

由于：

• 2.0.0

直接已知子类

变更流

在命名空间下定义

模块： 行为

常量摘要

Loggable中包含的常量

Loggable::PREFIX

可解释性中包含的常量

explainable::ALL_PLANS_EXECUTION 、explainable ::EXECUTION_STATS 、explainable ::QUERY_PLANNER

实例属性摘要

• # 管道 ⇒ Array<Hash> 只读

  管道 聚合管道。

行为中包含的属性

#view

Mongo::CursorHost 中包含的属性

#cursor, #timeout_mode

包含在Immutable中的属性

#options

实例方法摘要

• #initialize (view, pipeline, options = {}) ⇒ 聚合 构造函数

  为所提供的集合视图、管道和选项初始化聚合。

行为中包含的方法

#allow_disk_use , #explain , #timeout_ms , # 写入?

Retryable 中包含的方法

#read_worker 、 #select_server 、 #write_worker

Loggable中包含的方法

#log_debug 、 #log_error 、 #log_ Fatal 、 #log_info 、 #log_warn 、 #logger

方法包含在可解释

#explain

从Iterable包含的方法

#close_query , #each

Mongo::CursorHost 中包含的方法

#validate_timeout_mode!

构造函数详情

#initialize (view, pipeline, options = {}) ⇒聚合

为所提供的集合视图、管道和选项初始化聚合。

例子：

创建新的聚合视图。

Aggregation.view.new(view, pipeline)

参数：

• 查看 ( Collection::View ) —

  集合视图。

• 管道 ( Array<Hash> ) —

  操作管道。

• 选项 （哈希） （默认为： {} ） —

  聚合选项。

选项哈希 ( options )：

• :allow_disk_use ( true , false ) —

  如果在聚合期间允许使用磁盘，则设置为 true。

• :batch_size （整数） —

  批次中要返回的文档数量。

• :bypass_document_validation ( true , false ) —

  是否跳过文档级验证。

• :collation （哈希） —

  要使用的排序规则。

• :comment （对象） —

  用户提供的待附加到该命令的注释。

• :hint （ string ） —

  用于该聚合的索引。

• :let （哈希） —

  映射要在管道中使用的变量。 有关详细信息，请参阅服务器文档。

• :max_time_ms （整数） —

  允许聚合运行的最长时间（以毫秒为单位）。 此选项已弃用，请改用 :timeout_ms。

• :session （会话） —

  要使用的会话。

• :timeout_mode ( :cursor_lifetime | :iteration ) —

  如何解释 :timeout_ms（是应用于游标的生命周期，还是每次迭代）。

• :timeout_ms （整数） —

  操作超时（以毫秒为单位）。 必须是非负整数。 0 的显式值表示无限。 未设置默认值，这意味着该值是从集合、数据库或客户端继承的。

由于：

• 2.0.0

# File 'lib/ Mongo/ 集合/view/ 聚合', line 68

def 初始化(查看, 管道, 选项 = {})
  perper_setup(查看, 选项) do
    管道 = 管道.dup
    除非 mongo.broken_view_aggregate || 查看.筛选器.空？
      管道.unshift(:$match => 查看.筛选器)
    end
  end
end

实例属性详细信息

# 管道 ⇒ Array<Hash> （只读）

返回 pipeline 聚合管道。

返回：

• ( Array<Hash> ) —

  pipeline 聚合管道。

由于：

• 2.0.0

# File 'lib/ Mongo/ 集合/view/ 聚合', line 31

def 管道
  管道
end