1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
# Copyright (C) 2015-2017 MongoDB, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module Mongo
class BulkWrite
# Wraps a series of bulk write operations in a result object.
#
# @since 2.0.6
class Result
# Constant for number removed.
#
# @since 2.1.0
REMOVED_COUNT = 'n_removed'.freeze
# Constant for number inserted.
#
# @since 2.1.0
INSERTED_COUNT = 'n_inserted'.freeze
# Constant for inserted ids.
#
# @since 2.1.0
INSERTED_IDS = 'inserted_ids'.freeze
# Constant for number matched.
#
# @since 2.1.0
MATCHED_COUNT = 'n_matched'.freeze
# Constant for number modified.
#
# @since 2.1.0
MODIFIED_COUNT = 'n_modified'.freeze
# Constant for upserted.
#
# @since 2.1.0
UPSERTED = 'upserted'.freeze
# Constant for number upserted.
#
# @since 2.1.0
UPSERTED_COUNT = 'n_upserted'.freeze
# Constant for upserted ids.
#
# @since 2.1.0
UPSERTED_IDS = 'upserted_ids'.freeze
# The fields contained in the result document returned from executing the
# operations.
#
# @since 2.1.0.
FIELDS = [
INSERTED_COUNT,
REMOVED_COUNT,
MODIFIED_COUNT,
UPSERTED_COUNT,
MATCHED_COUNT,
Operation::Result::N
].freeze
# Returns the number of documents deleted.
#
# @example Get the number of deleted documents.
# result.deleted_count
#
# @return [ Integer ] The number deleted.
#
# @since 2.1.0
def deleted_count
@results[REMOVED_COUNT]
end
# Create the new result object from the results document.
#
# @example Create the new result.
# Result.new({ 'n_inserted' => 10 })
#
# @param [ BSON::Document, Hash ] results The results document.
#
# @since 2.1.0
def initialize(results)
@results = results
end
# Returns the number of documents inserted.
#
# @example Get the number of inserted documents.
# result.inserted_count
#
# @return [ Integer ] The number inserted.
#
# @since 2.1.0
def inserted_count
@results[INSERTED_COUNT]
end
# Get the inserted document ids, if the operation has inserts.
#
# @example Get the inserted ids.
# result.inserted_ids
#
# @return [ Array<BSON::ObjectId> ] The inserted ids.
#
# @since 2.1.0
def inserted_ids
@results[INSERTED_IDS]
end
# Returns the number of documents matched.
#
# @example Get the number of matched documents.
# result.matched_count
#
# @return [ Integer ] The number matched.
#
# @since 2.1.0
def matched_count
@results[MATCHED_COUNT]
end
# Returns the number of documents modified.
#
# @example Get the number of modified documents.
# result.modified_count
#
# @return [ Integer ] The number modified.
#
# @since 2.1.0
def modified_count
@results[MODIFIED_COUNT]
end
# Returns the number of documents upserted.
#
# @example Get the number of upserted documents.
# result.upserted_count
#
# @return [ Integer ] The number upserted.
#
# @since 2.1.0
def upserted_count
@results[UPSERTED_COUNT]
end
# Get the upserted document ids, if the operation has inserts.
#
# @example Get the upserted ids.
# result.upserted_ids
#
# @return [ Array<BSON::ObjectId> ] The upserted ids.
#
# @since 2.1.0
def upserted_ids
@results[UPSERTED_IDS] || []
end
# Validates the bulk write result.
#
# @example Validate the result.
# result.validate!
#
# @raise [ Error::BulkWriteError ] If the result contains errors.
#
# @return [ Result ] The result.
#
# @since 2.1.0
def validate!
if @results[Error::WRITE_ERRORS] || @results[Error::WRITE_CONCERN_ERRORS]
raise Error::BulkWriteError.new(@results)
else
self
end
end
end
end
end
|
