Class: Mongo::BulkWrite::Result

Relationships & Source Files
Inherits:	Object
Defined in:	lib/mongo/bulk_write/result.rb

Overview

Wraps a series of bulk write operations in a result object.

Since:

2.0.6

Constant Summary

FIELDS =

The fields contained in the result document returned from executing the operations.
Since:
- 2.1.0.
# File 'lib/mongo/bulk_write/result.rb', line 72
```
[
  INSERTED_COUNT,
  REMOVED_COUNT,
  MODIFIED_COUNT,
  UPSERTED_COUNT,
  MATCHED_COUNT,
  Operation::Result::N
].freeze
```
INSERTED_COUNT =

Constant for number inserted.
Since:
- 2.1.0
# File 'lib/mongo/bulk_write/result.rb', line 36
```
'n_inserted'
```
INSERTED_IDS =

Constant for inserted ids.
Since:
- 2.1.0
# File 'lib/mongo/bulk_write/result.rb', line 41
```
'inserted_ids'
```
MATCHED_COUNT =

Constant for number matched.
Since:
- 2.1.0
# File 'lib/mongo/bulk_write/result.rb', line 46
```
'n_matched'
```
MODIFIED_COUNT =

Constant for number modified.
Since:
- 2.1.0
# File 'lib/mongo/bulk_write/result.rb', line 51
```
'n_modified'
```
REMOVED_COUNT =

Constant for number removed.
Since:
- 2.1.0
# File 'lib/mongo/bulk_write/result.rb', line 31
```
'n_removed'
```
UPSERTED =

Constant for upserted.
Since:
- 2.1.0
# File 'lib/mongo/bulk_write/result.rb', line 56
```
'upserted'
```
UPSERTED_COUNT =

Constant for number upserted.
Since:
- 2.1.0
# File 'lib/mongo/bulk_write/result.rb', line 61
```
'n_upserted'
```
UPSERTED_IDS =

Constant for upserted ids.
Since:
- 2.1.0
# File 'lib/mongo/bulk_write/result.rb', line 66
```
'upserted_ids'
```

Class Method Summary

.new(results, acknowledged) ⇒ Result constructor Internal use only Internal use only

Create the new result object from the results document.

Instance Attribute Summary

#acknowledged? ⇒ Boolean readonly

Instance Method Summary

#deleted_count ⇒ Integer

Returns the number of documents deleted.
#inserted_count ⇒ Integer

Returns the number of documents inserted.
#inserted_ids ⇒ Array<BSON::ObjectId>

Get the inserted document ids, if the operation has inserts.
#matched_count ⇒ Integer

Returns the number of documents matched.
#modified_count ⇒ Integer

Returns the number of documents modified.
#upserted_count ⇒ Integer

Returns the number of documents upserted.
#upserted_ids ⇒ Array<BSON::ObjectId>

Get the upserted document ids, if the operation has inserts.
#validate! ⇒ Result

Validates the bulk write result.

Instance Attribute Details

#acknowledged? ⇒ `Boolean` (readonly)

Returns:

(Boolean) —

Is the result acknowledged?

Since:

2.0.6

[ GitHub ]

# File 'lib/mongo/bulk_write/result.rb', line 24


def acknowledged?
  @acknowledged
end

Instance Method Details

#deleted_count ⇒ `Integer`

Returns the number of documents deleted.

Examples:

Get the number of deleted documents.

result.deleted_count

Returns:

(Integer) —

The number deleted.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/bulk_write/result.rb', line 89


def deleted_count
  @results[REMOVED_COUNT]
end

#inserted_count ⇒ `Integer`

Returns the number of documents inserted.

Examples:

Get the number of inserted documents.

result.inserted_count

Returns:

(Integer) —

The number inserted.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/bulk_write/result.rb', line 117


def inserted_count
  @results[INSERTED_COUNT]
end

#inserted_ids ⇒ `Array`<`BSON::ObjectId`>

Get the inserted document ids, if the operation has inserts.

Examples:

Get the inserted ids.

result.inserted_ids

Returns:

(Array<BSON::ObjectId>) —

The inserted ids.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/bulk_write/result.rb', line 129


def inserted_ids
  @results[INSERTED_IDS]
end

#matched_count ⇒ `Integer`

Returns the number of documents matched.

Examples:

Get the number of matched documents.

result.matched_count

Returns:

(Integer) —

The number matched.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/bulk_write/result.rb', line 141


def matched_count
  @results[MATCHED_COUNT]
end

#modified_count ⇒ `Integer`

Returns the number of documents modified.

Examples:

Get the number of modified documents.

result.modified_count

Returns:

(Integer) —

The number modified.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/bulk_write/result.rb', line 153


def modified_count
  @results[MODIFIED_COUNT]
end

#upserted_count ⇒ `Integer`

Returns the number of documents upserted.

Examples:

Get the number of upserted documents.

result.upserted_count

Returns:

(Integer) —

The number upserted.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/bulk_write/result.rb', line 165


def upserted_count
  @results[UPSERTED_COUNT]
end

#upserted_ids ⇒ `Array`<`BSON::ObjectId`>

Get the upserted document ids, if the operation has inserts.

Examples:

Get the upserted ids.

result.upserted_ids

Returns:

(Array<BSON::ObjectId>) —

The upserted ids.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/bulk_write/result.rb', line 177


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

#validate! ⇒ `Result`

Validates the bulk write result.

Examples:

Validate the result.

result.validate!

Returns:

(Result) —

The result.

Raises:

(Error::BulkWriteError) —

If the result contains errors.

Since:

2.1.0

[ GitHub ]

# File 'lib/mongo/bulk_write/result.rb', line 191


def validate!
  raise Error::BulkWriteError.new(@results) if @results['writeErrors'] || @results['writeConcernErrors']

  self
end

Class: Mongo::BulkWrite::Result

Overview

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#acknowledged? ⇒ Boolean (readonly)

Instance Method Details

#deleted_count ⇒ Integer

#inserted_count ⇒ Integer

#inserted_ids ⇒ Array<BSON::ObjectId>

#matched_count ⇒ Integer

#modified_count ⇒ Integer

#upserted_count ⇒ Integer

#upserted_ids ⇒ Array<BSON::ObjectId>

#validate! ⇒ Result

#acknowledged? ⇒ `Boolean` (readonly)

#deleted_count ⇒ `Integer`

#inserted_count ⇒ `Integer`

#inserted_ids ⇒ `Array`<`BSON::ObjectId`>

#matched_count ⇒ `Integer`

#modified_count ⇒ `Integer`

#upserted_count ⇒ `Integer`

#upserted_ids ⇒ `Array`<`BSON::ObjectId`>

#validate! ⇒ `Result`