类：Mongo::Operation::ListCollections::Result

继承：
结果
  • 对象
显示全部
定义于：
构建/ruby-driver-v2.19/lib/ mongo /operation/list_collections/result.rb

Overview

定义使用 listCollections 命令时结果的自定义行为。

由于：

  • 2.0.0

常量摘要

从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、# write_concern_error ？ , #liter_count

构造函数详情

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

实例方法详细信息

# cursor_id = " Integer "

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

注意：

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

获取结果的游标ID。

例子：

获取游标 ID。

result.cursor_id

返回：

  • ( Integer ) —

    游标 ID。

由于：

  • 2.0.0



43
44
45
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/list_collections/result.rb', 第43行

def cursor_id
  cursor_document ? cursor_document[CURSOR_ID] : 超
end

# 个documents ⇒ Array<BSON::Document>

获取 listCollections 结果的文档。 这是 'firstBatch'

field in the 'cursor' field of the first document returned.

例子：

获取文档。

result.documents

返回：

  • ( Array<BSON::Document> ) —

    文档。

由于：

  • 2.0.0



70
71
72
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/list_collections/result.rb', 第70行

def 文档
  cursor_document[FIRST_BATCH]
end

#命名空间⇒ string

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

获取游标的命名空间。

例子：

获取命名空间。

result.namespace

返回：

  • ( string ) —

    命名空间。

由于：

  • 2.0.0



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

def namespace
  cursor_document ? cursor_document[名称空间] : 超
end

# validate! ⇒结果

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

验证结果。 如果未经授权的客户端尝试运行该命令，我们需要生成适当的错误。

例子：

验证结果。

result.validate!

返回：

  • (结果) —

    如果成功，则为 Self。

由于：

  • 2.0.0



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'build/Ruby-driver-v 2.19 /lib/mongo/operation/list_collections/result.rb', 第84行

def validate!
  if 成功？
    self
  else
    提高 错误::OperationFailure.new(
      解析器.message,
      self,
      代码： 解析器.代码,
      code_name: 解析器.code_name,
      标签： 解析器.labels,
      wtimeout: 解析器.wtimeout,
      文档: 解析器.文档,
      server_message: 解析器.server_message,
    )
  end
end