|
| 1 | +/** |
| 2 | + * Copyright (C) 2019-present MongoDB, Inc. |
| 3 | + * |
| 4 | + * This program is free software: you can redistribute it and/or modify |
| 5 | + * it under the terms of the Server Side Public License, version 1, |
| 6 | + * as published by MongoDB, Inc. |
| 7 | + * |
| 8 | + * This program is distributed in the hope that it will be useful, |
| 9 | + * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 10 | + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 11 | + * Server Side Public License for more details. |
| 12 | + * |
| 13 | + * You should have received a copy of the Server Side Public License |
| 14 | + * along with this program. If not, see |
| 15 | + * <http://www.mongodb.com/licensing/server-side-public-license>. |
| 16 | + * |
| 17 | + * As a special exception, the copyright holders give permission to link the |
| 18 | + * code of portions of this program with the OpenSSL library under certain |
| 19 | + * conditions as described in each individual source file and distribute |
| 20 | + * linked combinations including the program with the OpenSSL library. You |
| 21 | + * must comply with the Server Side Public License in all respects for |
| 22 | + * all of the code used other than as permitted herein. If you modify file(s) |
| 23 | + * with this exception, you may extend this exception to your version of the |
| 24 | + * file(s), but you are not obligated to do so. If you do not wish to do so, |
| 25 | + * delete this exception statement from your version. If you delete this |
| 26 | + * exception statement from all source files in the program, then also delete |
| 27 | + * it in the license file. |
| 28 | + */ |
| 29 | + |
| 30 | +#include "mongo/platform/basic.h" |
| 31 | + |
| 32 | +#include "mongo/db/exec/shard_name.h" |
| 33 | + |
| 34 | +#include <memory> |
| 35 | + |
| 36 | +#include "mongo/db/exec/filter.h" |
| 37 | +#include "mongo/db/exec/scoped_timer.h" |
| 38 | +#include "mongo/db/exec/working_set_common.h" |
| 39 | +#include "mongo/s/shard_key_pattern.h" |
| 40 | + |
| 41 | +namespace mongo { |
| 42 | + |
| 43 | +using std::shared_ptr; |
| 44 | +using std::unique_ptr; |
| 45 | +using std::vector; |
| 46 | +using std::string; |
| 47 | + |
| 48 | +// static |
| 49 | +const char* ShardNameStage::kStageType = "SHARD_NAME"; |
| 50 | + |
| 51 | +ShardNameStage::ShardNameStage(OperationContext* opCtx, |
| 52 | + ScopedCollectionMetadata metadata, |
| 53 | + WorkingSet* ws, |
| 54 | + PlanStage* child) |
| 55 | + : PlanStage(kStageType, opCtx), _ws(ws), _shardNamer(std::move(metadata)) { |
| 56 | + _children.emplace_back(child); |
| 57 | +} |
| 58 | + |
| 59 | +ShardNameStage::~ShardNameStage() {} |
| 60 | + |
| 61 | +bool ShardNameStage::isEOF() { |
| 62 | + return child()->isEOF(); |
| 63 | +} |
| 64 | + |
| 65 | +PlanStage::StageState ShardNameStage::doWork(WorkingSetID* out) { |
| 66 | + // If we've returned as many results as we're limited to, isEOF will be true. |
| 67 | + if (isEOF()) { |
| 68 | + return PlanStage::IS_EOF; |
| 69 | + } |
| 70 | + |
| 71 | + StageState status = child()->work(out); |
| 72 | + |
| 73 | + if (PlanStage::ADVANCED == status) { |
| 74 | + // If we're sharded make sure to add shardName to the output. |
| 75 | + if (_shardNamer.isCollectionSharded()) { |
| 76 | + WorkingSetMember* member = _ws->get(*out); |
| 77 | + const StringData shardName = _shardNamer.shardName(); |
| 78 | + |
| 79 | + // Populate the working set member with the shard name and return it. |
| 80 | + member->metadata().setShardName(shardName); |
| 81 | + } |
| 82 | + |
| 83 | + // If we're here either we have shard state and added the shardName, or we have no shard |
| 84 | + // state. Either way, we advance. |
| 85 | + return status; |
| 86 | + } |
| 87 | + |
| 88 | + return status; |
| 89 | +} |
| 90 | + |
| 91 | +unique_ptr<PlanStageStats> ShardNameStage::getStats() { |
| 92 | + _commonStats.isEOF = isEOF(); |
| 93 | + unique_ptr<PlanStageStats> ret = |
| 94 | + std::make_unique<PlanStageStats>(_commonStats, STAGE_SHARD_NAME); |
| 95 | + ret->children.emplace_back(child()->getStats()); |
| 96 | + return ret; |
| 97 | +} |
| 98 | + |
| 99 | +const SpecificStats* ShardNameStage::getSpecificStats() const { |
| 100 | + // No specific stats are tracked for the shard name stage. |
| 101 | + return nullptr; |
| 102 | +} |
| 103 | + |
| 104 | +} // namespace mongo |
0 commit comments