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
|
/**
* Copyright (C) 2015 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include <boost/optional.hpp>
#include <string>
#include "mongo/db/jsobj.h"
namespace mongo {
template <typename T>
class StatusWith;
/**
* A description of a request for a count operation. Copyable.
*/
class CountRequest {
public:
/**
* Construct an empty request.
*/
CountRequest(const std::string& fullNs, BSONObj query);
const std::string& getNs() const {
return _fullNs;
}
const BSONObj getQuery() const {
return _query;
}
long long getLimit() const {
return _limit.value_or(0);
}
void setLimit(long long limit) {
_limit = limit;
}
long long getSkip() const {
return _skip.value_or(0);
}
void setSkip(long long skip) {
_skip = skip;
}
const BSONObj getHint() const {
return _hint.value_or(BSONObj());
}
void setHint(BSONObj hint);
/**
* Constructs a BSON representation of this request, which can be used for sending it in
* commands.
*/
BSONObj toBSON() const;
/**
* Construct a CountRequest from the command specification and db name.
*/
static StatusWith<CountRequest> parseFromBSON(const std::string& dbname, const BSONObj& cmdObj);
private:
// Namespace to operate on (e.g. "foo.bar").
const std::string _fullNs;
// A predicate describing the set of documents to count.
const BSONObj _query;
// Optional. An integer limiting the number of documents to count.
boost::optional<long long> _limit;
// Optional. An integer indicating to not include the first n documents in the count.
boost::optional<long long> _skip;
// Optional. Indicates to the query planner that it should generate a count plan using a
// particular index.
boost::optional<BSONObj> _hint;
};
} // namespace mongo
|
