类：Mongo::Collection::View

继承：
对象
  • 对象
显示全部
扩展方式：
可转发
包括：
可枚举、可解释、不可变、可迭代、可读、可写
定义于：
lib/ Mongo/ 集合/view.rb ,
lib/ Mongo/
集合/view/iterable.rb,
lib/ Mongo/ 集合/view/readable.rb,
lib/ Mongo/ 集合/view/writable.rb,
lib/ Mongo/ 集合/view/immutable.rb,
lib/ Mongo/ 集合/view/map_reduce.rb,
lib/ Mongo/ 集合/view/ 聚合.rb,
lib/
Mongo/ 集合/view/explainable.rb, lib/ Mongo/ 集合/ view/change_stream.rb,
lib/ Mongo/ 集合/view/builder/map_reduce.rb,
lib/ Mongo/ 集合/view/builder/ 聚合.rb,
lib/ Mongo/ 集合/view/ 聚合/behavior.rb, lib/ Mongo/ 集合/view/change_stream/retryable.rb 更多...

Overview

注意：

View API 是半公开的。

生成文档结果设立的查询和选项的表示形式。

可以使用助手来修改View 。 助手可以链式运行，因为如果提供了参数，每个助手都会返回View 。

调用“终结器”时，会将查询消息发送到服务器。 例如，当在View上调用 #each 时，会创建一个游标对象，然后该对象会将查询发送到服务器。

View不是由用户直接创建的。 相反， View会在调用 CRUD 操作时创建View ，并将其返回给用户进行交互。

由于：

  • 2.0.0

在命名空间下定义

模块： Builder 、 Explainable 、 Immutable 、 Iterable 、 Readable 、 Writable类： Aggregation 、 ChangeStream 、 MapReduce

常量摘要

Writable中包含的常量

Writable::ARRAY_FILTERS

可解释性中包含的常量

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

实例属性摘要折叠

Mongo::CursorHost 中包含的属性

#cursor, #timeout_mode

包含在Immutable中的属性

#options

实例方法摘要折叠

从Writable中包含的方法

#delete_many 、# delete_one 、# find_one_and_delete 、# find_one_and_replace 、 #find_one_and_update 、#replace_one、 #update_many 、 # update_one

方法包含在可解释

#explain

Readable中包含的方法

#aggregate、#allow_disk_use、#allow_partial_results、#await_data、#batch_size、#comment、#count、#count_documents、#cursor_type、#distinct、#estimated_document_count、#hint、#limit、#map_reduce、#max_await_time_ms、#max_scan、#max_time_ms , #max_value , #min_value , #modifiers , #no_cursor_timeout , #parallel_scan , 投影 , #read , #read_concern , #read_preference , #return_key , #show_disk_loc , #skip , # 快照 , #sort

从Iterable包含的方法

#close_query , #each

Mongo::CursorHost 中包含的方法

#validate_timeout_mode!

构造函数详情

#initialize (集合, 过滤 = {}, options = {}) ⇒查看

创建一个新的View 。

例子：

查找名为 Emily 的所有用户。

View.new(collection, {:name => 'Emily'})

查找所有名为 Emily 跳过5并返回10的用户。

View.new(collection, {:name => 'Emily'}, :skip => 5, :limit => 10)

使用特定读取偏好（read preference）查找名为 Emily 的所有用户。

View.new(collection, {:name => 'Emily'}, :read => :secondary_preferred)

参数：

  • 集合 ( Collection ) —

    要查询的Collection 。

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

    查询筛选器。

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

    其他查询选项。

选项哈希 ( options )：

  • :allow_disk_use ( true , false ) —

    设置为 true 时，服务器可以在执行查找操作时将临时数据写入磁盘。 此选项仅在 MongoDB Server 4.4 及更高版本上可用。

  • :batch_size （整数） —

    MongoDB每次响应中要返回的文档数量。

  • :collation （哈希） —

    要使用的排序规则。

  • :comment （ string ） —

    将注释与查询关联。

  • :cursor_type ( :tailable , :tailable_await ) —

    要使用的游标类型。

  • :explain （哈希） —

    使用提供的解释选项（已知选项包括 :verbose 和 :verbosity）执行解释，而不是查找。

  • :hint （哈希） —

    覆盖默认索引选择并强制 MongoDB 使用特定索引进行查询。

  • :limit （整数） —

    要返回的最大文档数。

  • :max_scan （整数） —

    将查询限制为仅扫描指定数量的文档。 用于防止查询运行时间过长。 自MongoDB服务器版本4.0起已弃用。

  • :projection （哈希） —

    要在返回的文档中包含或排除的字段。

  • :read （哈希） —

    用于查询的读取偏好（read preference）。 如果未提供任何内容，则使用集合的默认读取偏好（read preference）。

  • :read_concern （哈希） —

    用于查询的读关注。

  • :show_disk_loc ( true | false ) —

    将磁盘位置信息作为每个文档中的字段返回。

  • :skip （整数） —

    要跳过的文档数量。

  • ：快照 ( true | false ) —

    防止多次返回一个文档。 自 MongoDB 服务器版本4.0起已弃用。

  • :sort （哈希） —

    用于对结果进行排序的键和方向对。

  • :timeout_mode ( :cursor_lifetime | :iteration ) —

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

  • :timeout_ms （整数） —

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

由于：

  • 2.0.0

[查看源代码]

169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/ Mongo/ 集合/view.rb', line 169

def 初始化(集合, 筛选器 = {}, 选项 = {})
  validate_doc!(筛选器)

  筛选器 = BSON::文档.new(筛选器)
  选项 = BSON::文档.new(选项)

  @collection = 集合
  @operation_timeout_ms = 选项.删除(:timeout_ms)

  validate_timeout_mode!(选项)

  # 这是用户在过滤和其他修饰符中传递 $ 查询的时间
  # 并排？
  查询 = 筛选器.删除(:$query)
  # 这会使修饰符包含筛选器（如果筛选器不是
  # 通过 $query 给出，但可能是作为顶级键
  # 下游代码会忽略修饰符中的非修饰键吗？
  modifiers = 筛选器.合并(merge)(选项.删除(:modifiers) || {})
  @filter = (查询 || 筛选器).冻结
  @options = 操作::find::生成器::Modifiers.map_driver_options(modifiers).合并！(选项).冻结
end

实例属性详细信息

# collection =" Collection " （只读）

返回要查询的Collection 。

返回：

由于：

  • 2.0.0


56
57
58
 
# File 'lib/ Mongo/ 集合/view.rb', line 56

def 集合
  @collection
end

# filter ⇒ Hash (readonly)也称为：选择器

返回查询过滤。

返回：

  • (哈希) —

    查询筛选器。

由于：

  • 2.0.0


59
60
61
 
# File 'lib/ Mongo/ 集合/view.rb', line 59

def 筛选器
  @filter
end

# operation_timeout_ms ⇒ Integer | nil |作为选项传递给视图的 timeout_ms 值。（只读）

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

返回整数 | nil |作为选项传递给视图的 timeout_ms 值。

返回：

  • （Integer | nil | 作为选项传递给视图的 timeout_ms 值。）—

    整数 | nil |作为选项传递给视图的 timeout_ms 值。

由于：

  • 2.0.0


81
82
83
 
# File 'lib/ Mongo/ 集合/view.rb', line 81

def operation_timeout_ms
  @operation_timeout_ms
end

实例方法详细信息

# == (other) ⇒ true , false也称为： eql?

比较两个View对象。

例子：

将视图与另一个对象进行比较。

view == other

返回：

  • ( true , false ) —

    如果两个View的集合、 过滤和 options 匹配，则相等。

由于：

  • 2.0.0

[查看源代码]

92
93
94
95
96
97
 
# File 'lib/ Mongo/ 集合/view.rb', line 92

def ==(其他)
  return false 除非 其他.is_a?(查看)
  集合 == 其他.集合 &&
      筛选器 == 其他.筛选器 &&
      选项 == 其他.选项
end

#哈希⇒整数

View的哈希值由集合命名空间、选项哈希和筛选器哈希组成。

例子：

获取哈希值。

view.hash

返回：

  • ( Integer ) —

    View对象的哈希值。

由于：

  • 2.0.0

[查看源代码]

109
110
111
 
# File 'lib/ Mongo/ 集合/view.rb', line 109

def 哈希
  [ 集合.namespace, 选项.哈希, 筛选器.哈希 ].哈希
end

#检查⇒ string

获取 View 的人类可读string表示形式。

例子：

进行检查。

view.inspect

返回：

  • ( string ) —

    View 实例的string表示形式。

由于：

  • 2.0.0

[查看源代码]

207
208
209
210
 
# File 'lib/ Mongo/ 集合/view.rb', line 207

def 检查
  " #<Mongo::Collection::View:0 x #{ object_id} 命名空间 =' #{ 集合 .namespace} ' " +
      " @filter = #{ 过滤 . to_s } @options= #{ options . to_s } > "
end

# operation_timeups (opts = {}) ⇒ 哈希

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

返回在操作级别（如果有）上设立的timeout_ms 值，和/或在集合/数据库/客户端级别上设立的timeout_ms（如果有）。

返回：

  • (哈希) —

    在操作级别上设立的timeout_ms 值（如果有），和/或在集合/数据库/客户端级别上设立的timeout_ms（如果有）。

由于：

  • 2.0.0

[查看源代码]

228
229
230
231
232
233
234
235
236
 
# File 'lib/ Mongo/ 集合/view.rb', line 228

def operation_timeups(opts = {})
  {}.点击 do |结果|
    if opts[:timeout_ms] || operation_timeout_ms
      结果[:operation_timeout_ms] = opts[:timeout_ms] || operation_timeout_ms
    else
      结果[:inherited_timeout_ms] = 集合.timeout_ms
    end
  end
end

#timeout_ms ⇒ Integer | nil

用于此操作的 timeout_ms 值；指定为视图的选项，或从集合继承。

返回：

  • ( Integer | nil ) —

    此操作的 timeout_ms

由于：

  • 2.0.0

[查看源代码]

195
196
197
 
# File 'lib/ Mongo/ 集合/view.rb', line 195

def timeout_ms
  operation_timeout_ms || 集合.timeout_ms
end

# write_concern ⇒ Mongo::WriteConcern

获取此View上的写关注（write concern）。

例子：

获取写关注（write concern）。

view.write_concern

返回：

由于：

  • 2.0.0

[查看源代码]

220
221
222
 
# File 'lib/ Mongo/ 集合/view.rb', line 220

def write_concern
  writeConcern.获取(选项[:write_concern] || 选项[:write] || 集合.write_concern)
end