summaryrefslogtreecommitdiff
path: root/src/mongo/db/query/query_planner_common.h
blob: e1c858ab98c5137bf76bc33300a3a58e67c553a7 (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
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
/**
 *    Copyright (C) 2013 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/db/jsobj.h"
#include "mongo/db/matcher/expression.h"
#include "mongo/db/query/query_solution.h"
#include "mongo/db/query/qlog.h"

namespace mongo {

    /**
     * Methods used by several parts of the planning process.
     */
    class QueryPlannerCommon {
    public:
        /**
         * Does the tree rooted at 'root' have a node with matchType 'type'?
         *
         * If 'out' is not NULL, sets 'out' to the first node of type 'type' encountered.
         */
        static bool hasNode(MatchExpression* root, MatchExpression::MatchType type,
                            MatchExpression** out = NULL) {
            if (type == root->matchType()) {
                if (NULL != out) {
                    *out = root;
                }
                return true;
            }

            for (size_t i = 0; i < root->numChildren(); ++i) {
                if (hasNode(root->getChild(i), type, out)) {
                    return true;
                }
            }
            return false;
        }

        /**
         * Assumes the provided BSONObj is of the form {field1: -+1, ..., field2: -+1}
         * Returns a BSONObj with the values negated.
         */
        static BSONObj reverseSortObj(const BSONObj& sortObj) {
            BSONObjBuilder reverseBob;
            BSONObjIterator it(sortObj);
            while (it.more()) {
                BSONElement elt = it.next();
                reverseBob.append(elt.fieldName(), elt.numberInt() * -1);
            }
            return reverseBob.obj();
        }

        /**
         * Traverses the tree rooted at 'node'.  For every STAGE_IXSCAN encountered, reverse
         * the scan direction and index bounds.
         */
        static void reverseScans(QuerySolutionNode* node) {
            StageType type = node->getType();

            if (STAGE_IXSCAN == type) {
                IndexScanNode* isn = static_cast<IndexScanNode*>(node);
                isn->direction *= -1;

                if (isn->bounds.isSimpleRange) {
                    std::swap(isn->bounds.startKey, isn->bounds.endKey);
                    // XXX: Not having a startKeyInclusive means that if we reverse a max/min query
                    // we have different results with and without the reverse...
                    isn->bounds.endKeyInclusive = true;
                }
                else {
                    for (size_t i = 0; i < isn->bounds.fields.size(); ++i) {
                        vector<Interval>& iv = isn->bounds.fields[i].intervals;
                        // Step 1: reverse the list.
                        std::reverse(iv.begin(), iv.end());
                        // Step 2: reverse each interval.
                        for (size_t j = 0; j < iv.size(); ++j) {
                            iv[j].reverse();
                        }
                    }
                }

                if (!isn->bounds.isValidFor(isn->indexKeyPattern, isn->direction)) {
                    QLOG() << "Invalid bounds: " << isn->bounds.toString() << endl;
                    verify(0);
                }

                // TODO: we can just negate every value in the already computed properties.
                isn->computeProperties();
            }
            else if (STAGE_SORT_MERGE == type) {
                // reverse direction of comparison for merge
                MergeSortNode* msn = static_cast<MergeSortNode*>(node);
                msn->sort = reverseSortObj(msn->sort);
            }
            else {
                verify(STAGE_SORT != type);
                // This shouldn't be here...
            }

            for (size_t i = 0; i < node->children.size(); ++i) {
                reverseScans(node->children[i]);
            }
        }
    };

}  // namespace mongo