/usr/include/mongo/db/querypattern.h is in mongodb-dev 1:2.4.9-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | // @file querypattern.h - Query pattern matching for selecting similar plans given similar queries.
/* Copyright 2011 10gen Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#pragma once
#include "jsobj.h"
namespace mongo {
class FieldRangeSet;
/**
* Implements query pattern matching, used to determine if a query is
* similar to an earlier query and should use the same plan.
*
* Two queries will generate the same QueryPattern, and therefore match each
* other, if their fields have the same Types and they have the same sort
* spec.
*/
class QueryPattern {
public:
QueryPattern( const FieldRangeSet &frs, const BSONObj &sort );
enum Type {
Empty,
Equality,
LowerBound,
UpperBound,
UpperAndLowerBound,
ConstraintPresent
};
bool operator<( const QueryPattern &other ) const;
/** for testing only */
bool operator==( const QueryPattern &other ) const;
/** for testing only */
bool operator!=( const QueryPattern &other ) const;
/** for development / debugging */
string toString() const;
private:
void setSort( const BSONObj sort );
static BSONObj normalizeSort( const BSONObj &spec );
map<string,Type> _fieldTypes;
BSONObj _sort;
};
/** Summarizes the candidate plans that may run for a query. */
class CandidatePlanCharacter {
public:
CandidatePlanCharacter( bool mayRunInOrderPlan, bool mayRunOutOfOrderPlan ) :
_mayRunInOrderPlan( mayRunInOrderPlan ),
_mayRunOutOfOrderPlan( mayRunOutOfOrderPlan ) {
}
CandidatePlanCharacter() :
_mayRunInOrderPlan(),
_mayRunOutOfOrderPlan() {
}
bool mayRunInOrderPlan() const { return _mayRunInOrderPlan; }
bool mayRunOutOfOrderPlan() const { return _mayRunOutOfOrderPlan; }
bool valid() const { return mayRunInOrderPlan() || mayRunOutOfOrderPlan(); }
bool hybridPlanSet() const { return mayRunInOrderPlan() && mayRunOutOfOrderPlan(); }
private:
bool _mayRunInOrderPlan;
bool _mayRunOutOfOrderPlan;
};
/** Information about a query plan that ran successfully for a QueryPattern. */
class CachedQueryPlan {
public:
CachedQueryPlan() :
_nScanned() {
}
CachedQueryPlan( const BSONObj &indexKey, long long nScanned,
CandidatePlanCharacter planCharacter );
BSONObj indexKey() const { return _indexKey; }
long long nScanned() const { return _nScanned; }
CandidatePlanCharacter planCharacter() const { return _planCharacter; }
private:
BSONObj _indexKey;
long long _nScanned;
CandidatePlanCharacter _planCharacter;
};
inline bool QueryPattern::operator<( const QueryPattern &other ) const {
map<string,Type>::const_iterator i = _fieldTypes.begin();
map<string,Type>::const_iterator j = other._fieldTypes.begin();
while( i != _fieldTypes.end() ) {
if ( j == other._fieldTypes.end() )
return false;
if ( i->first < j->first )
return true;
else if ( i->first > j->first )
return false;
if ( i->second < j->second )
return true;
else if ( i->second > j->second )
return false;
++i;
++j;
}
if ( j != other._fieldTypes.end() )
return true;
return _sort.woCompare( other._sort ) < 0;
}
} // namespace mongo
|