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 (129 lines) | stat: -rw-r--r-- 4,026 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
# 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 Insert

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

            # Get the ids of the inserted documents.
            #
            # @since 2.0.0
            attr_reader :inserted_ids

            # Initialize a new result.
            #
            # @example Instantiate the result.
            #   Result.new(replies, inserted_ids)
            #
            # @param [ Protocol::Message ] replies The wire protocol replies.
            # @param [ Array<Object> ] ids The ids of the inserted documents.
            #
            # @since 2.0.0
            def initialize(replies, ids)
              @replies = [ *replies ] if replies
              @inserted_ids = ids
            end

            # Gets the number of documents inserted.
            #
            # @example Get the number of documents inserted.
            #   result.n_inserted
            #
            # @return [ Integer ] The number of documents inserted.
            #
            # @since 2.0.0
            def n_inserted
              written_count
            end

            # Gets the id of the document inserted.
            #
            # @example Get id of the document inserted.
            #   result.inserted_id
            #
            # @return [ Object ] The id of the document inserted.
            #
            # @since 2.0.0
            def inserted_id
              inserted_ids.first
            end
          end

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

            # Get the ids of the inserted documents.
            #
            # @since 2.0.0
            attr_reader :inserted_ids

            # Initialize a new result.
            #
            # @example Instantiate the result.
            #   Result.new(replies, inserted_ids)
            #
            # @param [ Protocol::Message ] replies The wire protocol replies.
            # @param [ Array<Object> ] ids The ids of the inserted documents.
            #
            # @since 2.0.0
            def initialize(replies, ids)
              @replies = [ *replies ] if replies
              @inserted_ids = ids
            end

            # Gets the number of documents inserted.
            #
            # @example Get the number of documents inserted.
            #   result.n_inserted
            #
            # @return [ Integer ] The number of documents inserted.
            #
            # @since 2.0.0
            def n_inserted
              return 0 unless acknowledged?
              @replies.reduce(0) do |n, reply|
                n += 1 unless reply_write_errors?(reply)
                n
              end
            end

            # Gets the id of the document inserted.
            #
            # @example Get id of the document inserted.
            #   result.inserted_id
            #
            # @return [ Object ] The id of the document inserted.
            #
            # @since 2.0.0
            def inserted_id
              inserted_ids.first
            end
          end
        end
      end
    end
  end
end