クラス: Mongo::BulkWrite::Result

継承:

オブジェクト

• オブジェクト
• 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

インスタンス メソッドの概要を

• 確認済みの# = ブール値

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

• # delete_count =整数

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

• #初期化（結果、確認済み） = 結果 コンストラクター private

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

• #inserted_count ⇒ Integer

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

• #inserted_ids ⇒ Array<BSON::ObjectId>

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

• #matched_count =整数

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

• #modified_count ⇒ Integer

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

• #upserted_count ⇒ Integer

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

• # upserted_ids =配列<BSON::ObjectId>

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

• #validate! ⇒ Result

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

コンストラクターの詳細

#初期化（結果、確認済み） =結果

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

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

例:

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

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

パラメーター:

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

  結果ドキュメント。

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

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

以来

• 2.1.0

# ファイル 'lib/mongo/bulk_write/result.rb' 行 104

デフォルト 初期化(結果, 確認済み)
  @results = 結果
  @acknowledged = 確認済み
end

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

確認済みの# =ブール値

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

次の値を返します。

• （ブール値） —

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

以来

• 2.0.6

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

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

# delete_count =整数

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

例:

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

result.deleted_count

次の値を返します。

• (整数) —

  削除された番号。

以来

• 2.1.0

# ファイル 'lib/mongo/bulk_write/result.rb' 行 89

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

#inserted_count ⇒ Integer

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

例:

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

result.inserted_count

次の値を返します。

• (整数) —

  挿入された番号。

以来

• 2.1.0

# ファイル 'lib/mongo/bulk_write/result.rb' 行 117

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

#inserted_ids ⇒ Array<BSON::ObjectId>

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

例:

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

result.inserted_ids

次の値を返します。

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

  挿入された ID。

以来

• 2.1.0

# ファイル 'lib/mongo/bulk_write/result.rb' 行 129

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

#matched_count =整数

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

例:

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

result.matched_count

次の値を返します。

• (整数) —

  一致した数値。

以来

• 2.1.0

# ファイル 'lib/mongo/bulk_write/result.rb' 行 141

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

#modified_count ⇒ Integer

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

例:

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

result.modified_count

次の値を返します。

• (整数) —

  変更された数値。

以来

• 2.1.0

# ファイル 'lib/mongo/bulk_write/result.rb' 行 153

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

#upserted_count ⇒ Integer

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

例:

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

result.upserted_count

次の値を返します。

• (整数) —

  アップサートされた数。

以来

• 2.1.0

# ファイル 'lib/mongo/bulk_write/result.rb' 行 165

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

# upserted_ids =配列<BSON::ObjectId>

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

例:

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

result.upserted_ids

次の値を返します。

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

  アップサートされた ID。

以来

• 2.1.0

# ファイル 'lib/mongo/bulk_write/result.rb' 行 177

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

#validate! ⇒ Result

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

例:

結果を検証します。

result.validate!

次の値を返します。

• （結果） —

  結果。

次の値が発生します。

• （ Error::BulkWriteError ） —

  結果にエラーが含まれている場合。

以来

• 2.1.0

# ファイル 'lib/mongo/bulk_write/result.rb' 行 191

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

  自己
end