类：Mongo::Operation::Indexes::Result

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

Overview

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

由于：

  • 2.0.0

实例方法摘要折叠

实例方法详细信息

# cursor_id = " Integer "

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

注意：

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

获取结果的游标ID。

例子：

获取游标 ID。

result.cursor_id

返回：

  • ( Integer ) —

    游标 ID。

由于：

  • 2.0.0



40
41
42
 
# File 'lib/ Mongo/operation/indexes/result.rb', line 40

def cursor_id
  cursor_document ? cursor_document[CURSOR_ID] : 超
end

# 个documents ⇒ Array<BSON::Document>

获取 listIndexes 结果的文档。这是返回的第一个文档的“ 游标”字段中的“ firstBatch ”字段。

例子：

获取文档。

result.documents

返回：

  • ( Array<BSON::Document> ) —

    文档。

由于：

  • 2.0.0



67
68
69
 
# File 'lib/ Mongo/operation/indexes/result.rb', line 67

def 文档
  cursor_document[FIRST_BATCH]
end

#命名空间⇒ string

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

获取游标的命名空间。

例子：

获取命名空间。

result.namespace

返回：

  • ( string ) —

    命名空间。

由于：

  • 2.0.0



53
54
55
 
# File 'lib/ Mongo/operation/indexes/result.rb', line 53

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

# validate! ⇒结果

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

验证结果。如果服务器上不存在该数据库或集合，则会收到错误消息，在发生错误时，最好在此处引发有意义的异常，而不是产生不明确的异常。

例子：

验证结果。

result.validate!

返回：

  • (结果) —

    如果成功，则为 Self。

引发：

  • (NoNamespace) —

    如果 ns 不存在。

由于：

  • 2.0.0



85
86
87
 
# File 'lib/ Mongo/operation/indexes/result.rb', line 85

def validate!
  成功？ ? self : Raise_operation_failure
end