summaryrefslogtreecommitdiff
path: root/src/mongo/s/query/document_source_router_adapter.h
blob: 5c1a6a0935c72deff88f4195a69d509a2c4aa96e (plain)
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
/**
 * Copyright (C) 2017 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 "mongo/s/query/router_exec_stage.h"

#include "mongo/db/pipeline/document_source.h"
#include "mongo/db/pipeline/pipeline.h"

namespace mongo {
/**
 * A class that acts as an adapter between the RouterExecStage and DocumentSource interfaces,
 * translating results from an input RouterExecStage into DocumentSource::GetNextResults.
 */
class DocumentSourceRouterAdapter final : public DocumentSource {
public:
    static boost::intrusive_ptr<DocumentSourceRouterAdapter> create(
        const boost::intrusive_ptr<ExpressionContext>& expCtx,
        std::unique_ptr<RouterExecStage> childStage);

    StageConstraints constraints(Pipeline::SplitState pipeState) const final {
        return {StreamType::kStreaming,
                PositionRequirement::kFirst,
                HostTypeRequirement::kMongoS,
                DiskUseRequirement::kNoDiskUse,
                FacetRequirement::kNotAllowed,
                TransactionRequirement::kAllowed};
    }

    GetNextResult getNext() final;
    void doDispose() final;
    void reattachToOperationContext(OperationContext* opCtx) final;
    void detachFromOperationContext() final;
    Value serialize(boost::optional<ExplainOptions::Verbosity> explain) const final;
    bool remotesExhausted();

    void setExecContext(RouterExecStage::ExecContext execContext) {
        _execContext = execContext;
    }

    Status setAwaitDataTimeout(Milliseconds awaitDataTimeout) const {
        return _child->setAwaitDataTimeout(awaitDataTimeout);
    }

private:
    DocumentSourceRouterAdapter(const boost::intrusive_ptr<ExpressionContext>& expCtx,
                                std::unique_ptr<RouterExecStage> childStage);

    std::unique_ptr<RouterExecStage> _child;
    RouterExecStage::ExecContext _execContext;
};
}  // namespace mongo