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) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* 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 Server Side 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.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kQuery
#include "mongo/platform/basic.h"
#include "mongo/db/exec/shard_filter.h"
#include <memory>
#include "mongo/db/exec/filter.h"
#include "mongo/db/exec/scoped_timer.h"
#include "mongo/db/exec/working_set_common.h"
#include "mongo/logv2/log.h"
#include "mongo/s/shard_key_pattern.h"
namespace mongo {
using std::shared_ptr;
using std::unique_ptr;
using std::vector;
// static
const char* ShardFilterStage::kStageType = "SHARDING_FILTER";
ShardFilterStage::ShardFilterStage(ExpressionContext* expCtx,
ScopedCollectionFilter collectionFilter,
WorkingSet* ws,
std::unique_ptr<PlanStage> child)
: PlanStage(kStageType, expCtx), _ws(ws), _shardFilterer(std::move(collectionFilter)) {
_children.emplace_back(std::move(child));
}
ShardFilterStage::~ShardFilterStage() {}
bool ShardFilterStage::isEOF() {
return child()->isEOF();
}
PlanStage::StageState ShardFilterStage::doWork(WorkingSetID* out) {
// If we've returned as many results as we're limited to, isEOF will be true.
if (isEOF()) {
return PlanStage::IS_EOF;
}
StageState status = child()->work(out);
if (PlanStage::ADVANCED == status) {
// If we're sharded make sure that we don't return data that is not owned by us,
// including pending documents from in-progress migrations and orphaned documents from
// aborted migrations
if (_shardFilterer.isCollectionSharded()) {
WorkingSetMember* member = _ws->get(*out);
ShardFilterer::DocumentBelongsResult res = _shardFilterer.documentBelongsToMe(*member);
if (res != ShardFilterer::DocumentBelongsResult::kBelongs) {
if (res == ShardFilterer::DocumentBelongsResult::kNoShardKey) {
// We can't find a shard key for this working set member - this should never
// happen with a non-fetched result unless our query planning is screwed up
invariant(member->hasObj());
// Skip this working set member with a warning - no shard key should not be
// possible unless manually inserting data into a shard
LOGV2_WARNING(
23787,
"no shard key found in document {member_doc_value_toBson} for shard key "
"pattern {shardFilterer_getKeyPattern}, document may have been inserted "
"manually into shard",
"member_doc_value_toBson"_attr = redact(member->doc.value().toBson()),
"shardFilterer_getKeyPattern"_attr = _shardFilterer.getKeyPattern());
} else {
invariant(res == ShardFilterer::DocumentBelongsResult::kDoesNotBelong);
}
// If the document had no shard key, or doesn't belong to us, skip it.
_ws->free(*out);
++_specificStats.chunkSkips;
return PlanStage::NEED_TIME;
}
}
// If we're here either we have shard state and our doc passed, or we have no shard
// state. Either way, we advance.
return status;
}
return status;
}
unique_ptr<PlanStageStats> ShardFilterStage::getStats() {
_commonStats.isEOF = isEOF();
unique_ptr<PlanStageStats> ret =
std::make_unique<PlanStageStats>(_commonStats, STAGE_SHARDING_FILTER);
ret->children.emplace_back(child()->getStats());
ret->specific = std::make_unique<ShardingFilterStats>(_specificStats);
return ret;
}
const SpecificStats* ShardFilterStage::getSpecificStats() const {
return &_specificStats;
}
} // namespace mongo
|