-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
MapReduceOperationBase.cs
259 lines (241 loc) · 8.92 KB
/
MapReduceOperationBase.cs
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
/* Copyright 2013-present 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.
*/
using System;
using MongoDB.Bson;
using MongoDB.Driver.Core.Bindings;
using MongoDB.Driver.Core.Connections;
using MongoDB.Driver.Core.Misc;
using MongoDB.Driver.Core.WireProtocol.Messages.Encoders;
using MongoDB.Shared;
namespace MongoDB.Driver.Core.Operations
{
/// <summary>
/// Represents a base class for map-reduce operations.
/// </summary>
[Obsolete("Use Aggregation pipeline instead.")]
public abstract class MapReduceOperationBase
{
// fields
private Collation _collation;
private readonly CollectionNamespace _collectionNamespace;
private BsonDocument _filter;
private BsonJavaScript _finalizeFunction;
private bool? _javaScriptMode;
private long? _limit;
private readonly BsonJavaScript _mapFunction;
private TimeSpan? _maxTime;
private readonly MessageEncoderSettings _messageEncoderSettings;
private readonly BsonJavaScript _reduceFunction;
private BsonDocument _scope;
private BsonDocument _sort;
private bool? _verbose;
// constructors
/// <summary>
/// Initializes a new instance of the <see cref="MapReduceOperationBase"/> class.
/// </summary>
/// <param name="collectionNamespace">The collection namespace.</param>
/// <param name="mapFunction">The map function.</param>
/// <param name="reduceFunction">The reduce function.</param>
/// <param name="messageEncoderSettings">The message encoder settings.</param>
protected MapReduceOperationBase(CollectionNamespace collectionNamespace, BsonJavaScript mapFunction, BsonJavaScript reduceFunction, MessageEncoderSettings messageEncoderSettings)
{
_collectionNamespace = Ensure.IsNotNull(collectionNamespace, nameof(collectionNamespace));
_mapFunction = Ensure.IsNotNull(mapFunction, nameof(mapFunction));
_reduceFunction = Ensure.IsNotNull(reduceFunction, nameof(reduceFunction));
_messageEncoderSettings = Ensure.IsNotNull(messageEncoderSettings, nameof(messageEncoderSettings));
}
// properties
/// <summary>
/// Gets or sets the collation.
/// </summary>
/// <value>
/// The collation.
/// </value>
public Collation Collation
{
get { return _collation; }
set { _collation = value; }
}
/// <summary>
/// Gets the collection namespace.
/// </summary>
/// <value>
/// The collection namespace.
/// </value>
public CollectionNamespace CollectionNamespace
{
get { return _collectionNamespace; }
}
/// <summary>
/// Gets or sets the filter.
/// </summary>
/// <value>
/// The filter.
/// </value>
public BsonDocument Filter
{
get { return _filter; }
set { _filter = value; }
}
/// <summary>
/// Gets or sets the finalize function.
/// </summary>
/// <value>
/// The finalize function.
/// </value>
public BsonJavaScript FinalizeFunction
{
get { return _finalizeFunction; }
set { _finalizeFunction = value; }
}
/// <summary>
/// Gets or sets a value indicating whether objects emitted by the map function remain as JavaScript objects.
/// </summary>
/// <value>
/// <remarks>
/// Setting this value to true can result in faster execution, but requires more memory on the server, and if
/// there are too many emitted objects the map-reduce operation may fail.
/// </remarks>
/// <c>true</c> if objects emitted by the map function remain as JavaScript objects; otherwise, <c>false</c>.
/// </value>
[Obsolete("JavaScriptMode is ignored by server versions 4.4.0 and newer.")]
public bool? JavaScriptMode
{
get { return _javaScriptMode; }
set { _javaScriptMode = value; }
}
/// <summary>
/// Gets or sets the maximum number of documents to pass to the map function.
/// </summary>
/// <value>
/// The maximum number of documents to pass to the map function.
/// </value>
public long? Limit
{
get { return _limit; }
set { _limit = value; }
}
/// <summary>
/// Gets the map function.
/// </summary>
/// <value>
/// The map function.
/// </value>
public BsonJavaScript MapFunction
{
get { return _mapFunction; }
}
/// <summary>
/// Gets or sets the maximum time the server should spend on this operation.
/// </summary>
/// <value>
/// The maximum time the server should spend on this operation.
/// </value>
public TimeSpan? MaxTime
{
get { return _maxTime; }
set { _maxTime = Ensure.IsNullOrInfiniteOrGreaterThanOrEqualToZero(value, nameof(value)); }
}
/// <summary>
/// Gets the message encoder settings.
/// </summary>
/// <value>
/// The message encoder settings.
/// </value>
public MessageEncoderSettings MessageEncoderSettings
{
get { return _messageEncoderSettings; }
}
/// <summary>
/// Gets the reduce function.
/// </summary>
/// <value>
/// The reduce function.
/// </value>
public BsonJavaScript ReduceFunction
{
get { return _reduceFunction; }
}
/// <summary>
/// Gets or sets the scope document.
/// </summary>
/// <remarks>
/// The scode document defines global variables that are accessible from the map, reduce and finalize functions.
/// </remarks>
/// <value>
/// The scope document.
/// </value>
public BsonDocument Scope
{
get { return _scope; }
set { _scope = value; }
}
/// <summary>
/// Gets or sets the sort specification.
/// </summary>
/// <value>
/// The sort specification.
/// </value>
public BsonDocument Sort
{
get { return _sort; }
set { _sort = value; }
}
/// <summary>
/// Gets or sets a value indicating whether to include extra information, such as timing, in the result.
/// </summary>
/// <value>
/// <c>true</c> if extra information, such as timing, should be included in the result; otherwise, <c>false</c>.
/// </value>
public bool? Verbose
{
get { return _verbose; }
set { _verbose = value; }
}
// methods
/// <summary>
/// Creates the command.
/// </summary>
/// <param name="session">The session.</param>
/// <param name="connectionDescription">The connection description.</param>
/// <returns>
/// The command.
/// </returns>
protected internal virtual BsonDocument CreateCommand(ICoreSessionHandle session, ConnectionDescription connectionDescription)
{
return new BsonDocument
{
{ "mapReduce", _collectionNamespace.CollectionName },
{ "map", _mapFunction },
{ "reduce", _reduceFunction },
{ "out" , CreateOutputOptions() },
{ "query", _filter, _filter != null },
{ "sort", _sort, _sort != null },
{ "limit", () => _limit.Value, _limit.HasValue },
{ "finalize", _finalizeFunction, _finalizeFunction != null },
{ "scope", _scope, _scope != null },
{ "jsMode", () => _javaScriptMode.Value, _javaScriptMode.HasValue },
{ "verbose", () => _verbose.Value, _verbose.HasValue },
{ "maxTimeMS", () => MaxTimeHelper.ToMaxTimeMS(_maxTime.Value), _maxTime.HasValue },
{ "collation", () => _collation.ToBsonDocument(), _collation != null }
};
}
/// <summary>
/// Creates the output options.
/// </summary>
/// <returns>The output options.</returns>
protected abstract BsonDocument CreateOutputOptions();
}
}