-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
AggregateArgs.cs
134 lines (124 loc) · 4 KB
/
AggregateArgs.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
/* Copyright 2010-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 System.Collections.Generic;
using System.Linq;
using MongoDB.Bson;
using MongoDB.Driver.Core.Misc;
namespace MongoDB.Driver
{
/// <summary>
/// Represents the output mode for an aggregate operation.
/// </summary>
[Obsolete("Server versions 3.6 and newer always use a cursor.")]
public enum AggregateOutputMode
{
/// <summary>
/// The output of the aggregate operation is returned inline.
/// </summary>
Inline,
/// <summary>
/// The output of the aggregate operation is returned using a cursor.
/// </summary>
Cursor
}
/// <summary>
/// Represents options for the Aggregate command.
/// </summary>
public class AggregateArgs
{
// private fields
private bool? _allowDiskUse;
private int? _batchSize;
private bool? _bypassDocumentValidation;
private Collation _collation;
private TimeSpan? _maxTime;
#pragma warning disable 618
private AggregateOutputMode _outputMode = AggregateOutputMode.Inline;
#pragma warning restore 618
private IEnumerable<BsonDocument> _pipeline;
// public properties
/// <summary>
/// Gets or sets a value indicating whether disk use is allowed.
/// </summary>
public bool? AllowDiskUse
{
get { return _allowDiskUse; }
set { _allowDiskUse = value; }
}
/// <summary>
/// Gets or sets the size of a batch when using a cursor.
/// </summary>
public int? BatchSize
{
get { return _batchSize; }
set
{
if (value.HasValue && value.Value < 0)
{
throw new ArgumentException("BatchSize cannot be negative.", "value");
}
_batchSize = value;
}
}
/// <summary>
/// Gets or sets a value indicating whether to bypass document validation.
/// </summary>
/// <value>
/// A value indicating whether to bypass document validation.
/// </value>
public bool? BypassDocumentValidation
{
get { return _bypassDocumentValidation; }
set { _bypassDocumentValidation = value; }
}
/// <summary>
/// Gets or sets the collation.
/// </summary>
/// <value>
/// The collation.
/// </value>
public Collation Collation
{
get { return _collation; }
set { _collation = value; }
}
/// <summary>
/// Gets or sets the max time the server should spend on the aggregation command.
/// </summary>
public TimeSpan? MaxTime
{
get { return _maxTime; }
set { _maxTime = Ensure.IsNullOrInfiniteOrGreaterThanOrEqualToZero(value, nameof(value)); }
}
/// <summary>
/// Gets or sets the output mode.
/// </summary>
[Obsolete("Server versions 3.6 and newer always use a cursor.")]
public AggregateOutputMode OutputMode
{
get { return _outputMode; }
set { _outputMode = value; }
}
/// <summary>
/// Gets or sets the pipeline.
/// </summary>
public IEnumerable<BsonDocument> Pipeline
{
get { return _pipeline; }
set { _pipeline = value.ToList(); }
}
}
}