クラス: 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

'inserts_ids'
MATCHED_COUNT =

一致した数値の定数。

以来

  • 2.1.0

'n_matched'
MONGOUNT =

変更された数値の定数。

以来

  • 2.1.0

'n_modified'
アップサート =

アップサートの 定数。

以来

  • 2.1.0

'アップサート'
UPSERTED_COUNT =

アップサートされた数値の定数。

以来

  • 2.1.0

'n_upserted'
UPSERTED_IDS =

アップサートされた ID の定数。

以来

  • 2.1.0

'upserted_ids'
FIELDS =

操作の実行によって返された結果ドキュメントに含まれるフィールド。

以来

  • 2.1.0.

[
  Inserted_COUNT,
  REMOVED_COUNT,
  MONGOUNT,
  UPSERTED_COUNT,
  MATCHED_COUNT,
  操作::結果::N
].freeze

インスタンス属性の概要を折りたたむ

インスタンス メソッドの概要を折りたたむ

コンストラクターの詳細

#初期化(results, acknowledged, server_addresses = []) =結果

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

結果ドキュメントから新しい結果オブジェクトを作成します。

例:

新しい結果を作成します。

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

パラメーター:

  • 結果 （ BSON::Document 、 Hash ） —

    結果ドキュメント。

  • 確認済み （ブール値） —

    結果は確認されましたか。

  • server_addresses （配列<String> ） （デフォルトは[] ） —

    基礎の操作結果を生成したサーバーの重複のない "ホストする:port" アドレス。

以来

  • 2.1.0



111
112
113
114
115
 
# ファイル 'lib/mongo/bulk_write/result.rb' 行 111

デフォルト 初期化(結果, 確認済み, server_addresses = [])
  @results = 結果
  @acknowledged = 確認済み
  @server_addresses = 配列(server_addresses).compact.一意
end

インスタンス属性の詳細

#server_addresses ⇒ 配列<String> (読み取り専用)

このバルク書き込み (write)の操作を生成したサーバーの"ホストする:ポート"アドレスの重複ないリストを返します。

次の値を返します。

  • （ <String>配列未満

    このバルク書き込み (write)の操作を生成したサーバーの "ホストする:ポート" アドレスの重複ないリスト。

以来

  • 2.0.6



30
31
32
 
# ファイル 'lib/mongo/bulk_write/result.rb' 行 30

デフォルト server_addresses
  @server_addresses
end

インスタンス メソッドの詳細

確認済みの# =ブール値

結果は確認済みか を返します。

次の値を返します。

  • （ブール値） —

    結果は確認されましたか。

以来

  • 2.0.6



24
25
26
 
# ファイル 'lib/mongo/bulk_write/result.rb' 行 24

デフォルト 確認済み?
  @acknowledged
end

# delete_count =整数

削除されたドキュメントの数を返します。

例:

削除されたドキュメントの数を取得します。

result.deleted_count

次の値を返します。

  • (整数) —

    削除された番号。

以来

  • 2.1.0



93
94
95
 
# ファイル 'lib/mongo/bulk_write/result.rb' 行 93

デフォルト delete_count
  @results[REMOVED_COUNT]
end

#inserted_count ⇒ Integer

挿入されたドキュメントの数を返します。

例:

挿入されたドキュメントの数を取得します。

result.inserted_count

次の値を返します。

  • (整数) —

    挿入された番号。

以来

  • 2.1.0



125
126
127
 
# ファイル 'lib/mongo/bulk_write/result.rb' 行 125

デフォルト inserts_count
  @results[Inserted_COUNT]
end

#inserted_ids ⇒ Array<BSON::ObjectId>

操作に挿入がある場合は、挿入されたドキュメント ID を取得します。

例:

挿入された ID を取得します。

result.inserted_ids

次の値を返します。

  • （配列<BSON::ObjectId> ） —

    挿入された ID。

以来

  • 2.1.0



137
138
139
 
# ファイル 'lib/mongo/bulk_write/result.rb' 行 137

デフォルト inserts_ids
  @results[Inserted_IDS]
end

#matched_count =整数

一致したドキュメントの数を返します。

例:

一致したドキュメントの数を取得します。

result.matched_count

次の値を返します。

  • (整数) —

    一致した数値。

以来

  • 2.1.0



149
150
151
 
# ファイル 'lib/mongo/bulk_write/result.rb' 行 149

デフォルト matched_count
  @results[MATCHED_COUNT]
end

#modified_count ⇒ Integer

変更されたドキュメントの数を返します。

例:

変更されたドキュメントの数を取得します。

result.modified_count

次の値を返します。

  • (整数) —

    変更された数値。

以来

  • 2.1.0



161
162
163
 
# ファイル 'lib/mongo/bulk_write/result.rb' 行 161

デフォルト moded_count
  @results[MONGOUNT]
end

#upserted_count ⇒ Integer

アップサートされたドキュメントの数を返します。

例:

アップサートされたドキュメントの数を取得します。

result.upserted_count

次の値を返します。

  • (整数) —

    アップサートされた数。

以来

  • 2.1.0



173
174
175
 
# ファイル 'lib/mongo/bulk_write/result.rb' 行 173

デフォルト upserted_count
  @results[UPSERTED_COUNT]
end

# upserted_ids =配列<BSON::ObjectId>

操作に挿入がある場合は、アップサートされたドキュメントの ID を取得します。

例:

アップサートされた ID を取得します。

result.upserted_ids

次の値を返します。

  • （配列<BSON::ObjectId> ） —

    アップサートされた ID。

以来

  • 2.1.0



185
186
187
 
# ファイル 'lib/mongo/bulk_write/result.rb' 行 185

デフォルト upserted_ids
  @results[UPSERTED_IDS] || []
end

#validate! ⇒ Result

一括書込みの結果を検証します。

例:

結果を検証します。

result.validate!

次の値を返します。

次の値が発生します。

以来

  • 2.1.0



199
200
201
202
203
 
# ファイル 'lib/mongo/bulk_write/result.rb' 行 199

デフォルト validate!
  発生 エラー::BulkWriteError.新着情報(@results, server_addresses: @server_addresses) 場合 @results[' writeErrors '] || @results[' writeConcernErrors ']

  自己
end