类:Mongo::BulkWrite::Result

继承:
对象
  • 对象
显示全部
定义于:
构建/ruby-driver-v2.19/lib/ mongo /bulk_write/result.rb

Overview

将一系列批量写入操作封装在一个结果对象中。

由于:

  • 2.0.6

常量摘要折叠

REMOVED_COUNT =

已删除数字的常量。

由于:

  • 2.1.0

' n_removed '.冻结
INSERTED_COUNT =

插入数字的常量。

由于:

  • 2.1.0

' n_inserted '.冻结
INSERTED_IDS =

插入的 ID 的常量。

由于:

  • 2.1.0

'inserted_ids'.冻结
MATCHED_COUNT =

匹配数字常量。

由于:

  • 2.1.0

' n_matched '.冻结
MODIFIED_COUNT =

已修改数量的常量。

由于:

  • 2.1.0

'n_modified'.冻结
UPSERTED =

用于 upsert 操作的常量。

由于:

  • 2.1.0

' upsert '.冻结
UPSERTED_COUNT =

表示更新或插入的数字常量。

由于:

  • 2.1.0

' n_upserted '.冻结
UPSERTED_IDS =

用于更新或插入的 ID 的常量。

由于:

  • 2.1.0

' upserted_ids '.冻结
字段 =

执行操作返回的结果文档中包含的字段。

由于:

  • 2.1.0 .

[
  INSERTED_COUNT,
  REMOVED_COUNT,
  MODIFIED_COUNT,
  UPSERTED_COUNT,
  MATCHED_COUNT,
  操作::结果::N
].冻结

实例方法摘要折叠

构造函数详情

#初始化(结果,已确认) ⇒结果

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

从结果文档创建新的结果对象。

例子:

创建新结果。

Result.new({ 'n_inserted' => 10 })

参数:

  • 结果 ( BSON::Document , Hash )

    结果文档。

  • 已确认 ( Boolean )

    是否已确认结果?

由于:

  • 2.1.0



107
108
109
110
# File ' 构建/ruby-driver-v2.19/lib/ mongo /bulk_write/result.rb', 第107行

def 初始化(结果, 已确认)
  @results = 结果
  @acknowledged = 已确认
end

实例方法详细信息

#已确认?布尔

返回结果是否已确认?

返回:

  • ( Boolean )

    是否已确认结果?

由于:

  • 2.0.6



27
28
29
# File ' 构建/ruby-driver-v2.19/lib/ mongo /bulk_write/result.rb', 第27行

def 已确认?
  @acknowledged
end

# Deleted_count =" Integer "

返回已删除的文档数。

例子:

获取已删除文档的数量。

result.deleted_count

返回:

  • ( Integer )

    已删除号码。

由于:

  • 2.1.0



92
93
94
# File ' 构建/ruby-driver-v2.19/lib/ mongo /bulk_write/result.rb', 第92行

def Deleted_Count
  @results[REMOVED_COUNT]
end

#inserted_countInteger

返回插入的文档数。

例子:

获取已插入文档的数量。

result.inserted_count

返回:

  • ( Integer )

    插入的数字。

由于:

  • 2.1.0



120
121
122
# File ' 构建/ruby-driver-v2.19/lib/ mongo /bulk_write/result.rb', 第120行

def Inserted_Count
  @results[INSERTED_COUNT]
end

#inserted_idsArray<BSON::ObjectId>

如果该操作有插入,则获取插入的文档 ID。

例子:

获取插入的 id。

result.inserted_ids

返回:

  • ( Array<BSON::ObjectId> )

    插入的 id。

由于:

  • 2.1.0



132
133
134
# File ' 构建/ruby-driver-v2.19/lib/ mongo /bulk_write/result.rb', 第132行

def Inserted_Ids
  @results[INSERTED_IDS]
end

#matched_count整数

返回匹配的文档数。

例子:

获取匹配文档的数量。

result.matched_count

返回:

  • ( Integer )

    号码匹配。

由于:

  • 2.1.0



144
145
146
# File ' 构建/ruby-driver-v2.19/lib/ mongo /bulk_write/result.rb', 第144行

def 匹配计数
  @results[MATCHED_COUNT]
end

# Modified_count =" Integer "(整数)

返回已修改的文档数。

例子:

获取已修改文档的数量。

result.modified_count

返回:

  • ( Integer )

    修改后的数字。

由于:

  • 2.1.0



156
157
158
# File ' 构建/ruby-driver-v2.19/lib/ mongo /bulk_write/result.rb', 第156行

def Modified_count
  @results[MODIFIED_COUNT]
end

#upserted_countInteger

返回已更新或插入的文档数。

例子:

获取已更新或插入的文档数量。

result.upserted_count

返回:

  • ( Integer )

    更新或插入的数字。

由于:

  • 2.1.0



168
169
170
# File ' 构建/ruby-driver-v2.19/lib/ mongo /bulk_write/result.rb', 第168行

def upserted_count
  @results[UPSERTED_COUNT]
end

# upserted_idsArray<BSON::ObjectId>

如果操作包含插入,则获取更新或插入的文档ID。

例子:

获取更新或插入的 ID。

result.upserted_ids

返回:

  • ( Array<BSON::ObjectId> )

    已更新或插入的 ID。

由于:

  • 2.1.0



180
181
182
# File ' 构建/ruby-driver-v2.19/lib/ mongo /bulk_write/result.rb', 第180行

def upserted_id
  @results[UPSERTED_IDS] || []
end

# validate!结果

验证批量写入结果。

例子:

验证结果。

result.validate!

返回:

引发:

由于:

  • 2.1.0



194
195
196
197
198
199
200
# File ' 构建/ruby-driver-v2.19/lib/ mongo /bulk_write/result.rb', 第194行

def validate!
  if @results[' writeErrors '] || @results[' writeConcernErrors ']
    提高 错误::BulkWriteError.new(@results)
  else
    self
  end
end