类:Mongo::BulkWrite::Result

继承:
对象
  • 对象
显示全部
定义于:
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

'更新或插入'
UPSERTED_COUNT =

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

由于:

  • 2.1.0

'n_upserted'
UPSERTED_IDS =

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

由于:

  • 2.1.0

'upserted_id'
字段 =

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

由于:

  • 2.1.0 .

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

实例属性摘要折叠

实例方法摘要折叠

构造函数详情

#初始化(结果,已确认,server_addresses = []) ⇒ 结果

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

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

例子:

创建新结果。

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

参数:

  • 结果 ( BSON::Document , Hash )

    结果文档。

  • 已确认 ( Boolean )

    是否已确认结果?

  • server_addresses ( Array<String> ) (默认为: []

    生成根本的操作结果的服务器的去重复"托管:port"地址。

由于:

  • 2.1.0



111
112
113
114
115
# File 'lib/ Mongo/bulk_write/result.rb', line 111

def 初始化(结果, 已确认, server_addresses = [])
  @results = 结果
  @acknowledged = 已确认
  @server_addresses = 阵列(server_addresses).compact.uniq
end

实例属性详细信息

#server_addresses数组<String> (只读)

返回生成此批量写入操作的服务器的去重复“托管:端口”地址列表。

返回:

  • ( Array<String> )

    生成此批量写入操作的服务器的“托管:端口”地址的去重复列表。

由于:

  • 2.0.6



30
31
32
# File 'lib/ Mongo/bulk_write/result.rb', line 30

def server_addresses
  @server_addresses
end

实例方法详细信息

#已确认?布尔

返回结果是否已确认?

返回:

  • ( Boolean )

    是否已确认结果?

由于:

  • 2.0.6



24
25
26
# File 'lib/ Mongo/bulk_write/result.rb', line 24

def 已确认?
  @acknowledged
end

# Deleted_count =" Integer "

返回已删除的文档数。

例子:

获取已删除文档的数量。

result.deleted_count

返回:

  • ( Integer )

    已删除号码。

由于:

  • 2.1.0



93
94
95
# File 'lib/ Mongo/bulk_write/result.rb', line 93

def Deleted_Count
  @results[REMOVED_COUNT]
end

#inserted_countInteger

返回插入的文档数。

例子:

获取已插入文档的数量。

result.inserted_count

返回:

  • ( Integer )

    插入的数字。

由于:

  • 2.1.0



125
126
127
# File 'lib/ Mongo/bulk_write/result.rb', line 125

def Inserted_Count
  @results[INSERTED_COUNT]
end

#inserted_idsArray<BSON::ObjectId>

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

例子:

获取插入的 id。

result.inserted_ids

返回:

  • ( Array<BSON::ObjectId> )

    插入的 id。

由于:

  • 2.1.0



137
138
139
# File 'lib/ Mongo/bulk_write/result.rb', line 137

def Inserted_Ids
  @results[INSERTED_IDS]
end

#matched_count整数

返回匹配的文档数。

例子:

获取匹配文档的数量。

result.matched_count

返回:

  • ( Integer )

    号码匹配。

由于:

  • 2.1.0



149
150
151
# File 'lib/ Mongo/bulk_write/result.rb', line 149

def 匹配计数
  @results[MATCHED_COUNT]
end

# Modified_count =" Integer "(整数)

返回已修改的文档数。

例子:

获取已修改文档的数量。

result.modified_count

返回:

  • ( Integer )

    修改后的数字。

由于:

  • 2.1.0



161
162
163
# File 'lib/ Mongo/bulk_write/result.rb', line 161

def Modified_count
  @results[MODIFIED_COUNT]
end

#upserted_countInteger

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

例子:

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

result.upserted_count

返回:

  • ( Integer )

    更新或插入的数字。

由于:

  • 2.1.0



173
174
175
# File 'lib/ Mongo/bulk_write/result.rb', line 173

def upserted_count
  @results[UPSERTED_COUNT]
end

# upserted_idsArray<BSON::ObjectId>

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

例子:

获取更新或插入的 ID。

result.upserted_ids

返回:

  • ( Array<BSON::ObjectId> )

    已更新或插入的 ID。

由于:

  • 2.1.0



185
186
187
# File 'lib/ Mongo/bulk_write/result.rb', line 185

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

# validate!结果

验证批量写入结果。

例子:

验证结果。

result.validate!

返回:

引发:

由于:

  • 2.1.0



199
200
201
202
203
# File 'lib/ Mongo/bulk_write/result.rb', line 199

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

  self
end