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
|
# frozen_string_literal: true
# rubocop:todo all
# Copyright (C) 2014-2020 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
class MapReduce
# Defines custom behavior of results for a map reduce operation.
#
# @since 2.0.0
# @api semiprivate
class Result < Operation::Result
# The counts field for the map/reduce.
#
# @since 2.0.0
# @api private
COUNTS = 'counts'.freeze
# The field name for a result without a cursor.
#
# @since 2.0.0
# @api private
RESULTS = 'results'.freeze
# The time the operation took constant.
#
# @since 2.0.0
# @api private
TIME = 'timeMillis'.freeze
# Gets the map/reduce counts from the reply.
#
# @example Get the counts.
# result.counts
#
# @return [ Hash ] A hash of the result counts.
#
# @since 2.0.0
# @api public
def counts
reply.documents[0][COUNTS]
end
# Get the documents from the map/reduce.
#
# @example Get the documents.
# result.documents
#
# @return [ Array<BSON::Document> ] The documents.
#
# @since 2.0.0
# @api public
def documents
reply.documents[0][RESULTS] || reply.documents[0][RESULT]
end
# If the result was a command then determine if it was considered a
# success.
#
# @note If the write was unacknowledged, then this will always return
# true.
#
# @example Was the command successful?
# result.successful?
#
# @return [ true, false ] If the command was successful.
#
# @since 2.0.0
# @api public
def successful?
!documents.nil?
end
# Get the execution time of the map/reduce.
#
# @example Get the execution time.
# result.time
#
# @return [ Integer ] The executing time in milliseconds.
#
# @since 2.0.0
# @api public
def time
reply.documents[0][TIME]
end
# Validate the result by checking for any errors.
#
# @note This only checks for errors with writes since authentication is
# handled at the connection level and any authentication errors would
# be raised there, before a Result is ever created.
#
# @example Validate the result.
# result.validate!
#
# @raise [ Error::OperationFailure::Family ] If an error is in the result.
#
# @return [ Result ] The result if verification passed.
#
# @since 2.0.0
# @api private
def validate!
documents.nil? ? raise_operation_failure : self
end
# Get the cursor id.
#
# @example Get the cursor id.
# result.cursor_id
#
# @return [ Integer ] Always 0 because map reduce doesn't return a cursor.
#
# @since 2.5.0
# @api private
def cursor_id
0
end
# Get the number of documents returned by the server in this batch.
#
# Map/Reduce operation returns documents inline without using
# cursors; as such, the standard Mongo::Reply#returned_count does
# not work correctly for Map/Reduce.
#
# Note that the Map/Reduce operation is limited to max BSON document
# size (16 MB) in its inline result set.
#
# @return [ Integer ] The number of documents returned.
#
# @api public
def returned_count
reply.documents.length
end
private
def first_document
@first_document ||= reply.documents[0]
end
end
end
end
end
|
