File: result.rb

package info (click to toggle)
ruby-mongo 2.5.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 4,332 kB
  • sloc: ruby: 45,579; makefile: 5
file content (196 lines) | stat: -rw-r--r-- 5,971 bytes parent folder | download | duplicates (3)
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
192
193
194
195
196
# Copyright (C) 2014-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
  module Operation
    module Write
      module Bulk
        class Update

          # Defines custom behaviour of results when updating.
          #
          # @since 2.0.0
          class Result < Operation::Result
            include Mergable

            # The number of modified docs field in the result.
            #
            # @since 2.0.0
            MODIFIED = 'nModified'.freeze

            # The upserted docs field in the result.
            #
            # @since 2.0.0
            UPSERTED = 'upserted'.freeze

            # Gets the number of documents upserted.
            #
            # @example Get the upserted count.
            #   result.n_upserted
            #
            # @return [ Integer ] The number of documents upserted.
            #
            # @since 2.0.0
            def n_upserted
              return 0 unless acknowledged?
              @replies.reduce(0) do |n, reply|
                if upsert?(reply)
                  n += reply.documents.first[UPSERTED].size
                else
                  n
                end
              end
            end

            # Gets the number of documents matched.
            #
            # @example Get the matched count.
            #   result.n_matched
            #
            # @return [ Integer ] The number of documents matched.
            #
            # @since 2.0.0
            def n_matched
              return 0 unless acknowledged?
              @replies.reduce(0) do |n, reply|
                if upsert?(reply)
                  reply.documents.first[N] - n_upserted
                else
                  if reply.documents.first[N]
                    n += reply.documents.first[N]
                  else
                    n
                  end
                end
              end
            end

            # Gets the number of documents modified.
            # Not that in a mixed sharded cluster a call to
            # update could return nModified (>= 2.6) or not (<= 2.4).
            # If any call does not return nModified we can't report
            # a valid final count so set the field to nil.
            #
            # @example Get the modified count.
            #   result.n_modified
            #
            # @return [ Integer ] The number of documents modified.
            #
            # @since 2.0.0
            def n_modified
              return 0 unless acknowledged?
              @replies.reduce(0) do |n, reply|
                if n && reply.documents.first[MODIFIED]
                  n += reply.documents.first[MODIFIED]
                else
                  nil
                end
              end
            end

            # Get the upserted documents.
            #
            # @example Get upserted documents.
            #   result.upserted
            #
            # @return [ Array<BSON::Document> ] The upserted document info
            #
            # @since 2.1.0
            def upserted
              reply.documents.first[UPSERTED] || []
            end

            private

            def upsert?(reply)
              upserted.any?
            end
          end

          # Defines custom behaviour of results when updating.
          # For server versions < 2.5.5 (that don't use write commands).
          #
          # @since 2.0.0
          class LegacyResult < Operation::Result
            include LegacyMergable

            # The updated existing field in the result.
            #
            # @since 2.0.0
            UPDATED_EXISTING = 'updatedExisting'.freeze

            # Gets the number of documents upserted.
            #
            # @example Get the upserted count.
            #   result.n_upserted
            #
            # @return [ Integer ] The number of documents upserted.
            #
            # @since 2.0.0
            def n_upserted
              return 0 unless acknowledged?
              @replies.reduce(0) do |n, reply|
                if upsert?(reply)
                  n += reply.documents.first[N]
                else
                  n
                end
              end
            end

            # Gets the number of documents matched.
            #
            # @example Get the matched count.
            #   result.n_matched
            #
            # @return [ Integer ] The number of documents matched.
            #
            # @since 2.0.0
            def n_matched
              return 0 unless acknowledged?
              @replies.reduce(0) do |n, reply|
                if upsert?(reply)
                  n
                else
                  n += reply.documents.first[N]
                end
              end
            end

            # Gets the number of documents modified.
            #
            # @example Get the modified count.
            #   result.n_modified
            #
            # @return [ Integer ] The number of documents modified.
            #
            # @since 2.2.3
            def n_modified; end

            private

            def upsert?(reply)
              reply.documents.first[BulkWrite::Result::UPSERTED] ||
                (!updated_existing?(reply) && reply.documents.first[N] == 1)
            end

            def updated_existing?(reply)
              reply.documents.first[UPDATED_EXISTING]
            end
          end
        end
      end
    end
  end
end