summaryrefslogtreecommitdiff
path: root/src/mongo/db/index/s2_access_method.cpp
blob: 50df4f347117b5d117fe626212445ff2ef8d96f5 (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
/**
*    Copyright (C) 2013 10gen 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.
*/

#include "mongo/db/index/s2_access_method.h"

#include <vector>

#include "mongo/base/status.h"
#include "mongo/db/geo/geoconstants.h"
#include "mongo/db/geo/geoparser.h"
#include "mongo/db/geo/geoquery.h"
#include "mongo/db/geo/s2.h"
#include "mongo/db/geo/s2common.h"
#include "mongo/db/index/expression_params.h"
#include "mongo/db/index/s2_key_generator.h"
#include "mongo/db/index_names.h"
#include "mongo/db/jsobj.h"

#include "third_party/s2/s2cell.h"
#include "third_party/s2/s2regioncoverer.h"

namespace mongo {

    static const string kIndexVersionFieldName("2dsphereIndexVersion");

    S2AccessMethod::S2AccessMethod(IndexCatalogEntry* btreeState)
        : BtreeBasedAccessMethod(btreeState) {

        const IndexDescriptor* descriptor = btreeState->descriptor();

        ExpressionParams::parse2dsphereParams(descriptor->infoObj(),
                                              &_params);

        _keyGenerator.reset( new S2KeyGenerator( descriptor->keyPattern(), _params ) );

        int geoFields = 0;

        // Categorize the fields we're indexing and make sure we have a geo field.
        BSONObjIterator i(descriptor->keyPattern());
        while (i.more()) {
            BSONElement e = i.next();
            if (e.type() == String && IndexNames::GEO_2DSPHERE == e.String() ) {
                ++geoFields;
            }
            else {
                // We check for numeric in 2d, so that's the check here
                uassert( 16823, (string)"Cannot use " + IndexNames::GEO_2DSPHERE +
                                    " index with other special index types: " + e.toString(),
                         e.isNumber() );
            }
        }

        uassert(16750, "Expect at least one geo field, spec=" + descriptor->keyPattern().toString(),
                geoFields >= 1);

        if (descriptor->isSparse()) {
            warning() << "Sparse option ignored for index spec "
                      << descriptor->keyPattern().toString() << "\n";
        }
    }

    // static
    BSONObj S2AccessMethod::fixSpec(const BSONObj& specObj) {
        // If the spec object has the field "2dsphereIndexVersion", validate it.  If it doesn't, add
        // {2dsphereIndexVersion: 2}, which is the default for newly-built indexes.

        BSONElement indexVersionElt = specObj[kIndexVersionFieldName];
        if (indexVersionElt.eoo()) {
            BSONObjBuilder bob;
            bob.appendElements(specObj);
            bob.append(kIndexVersionFieldName, S2_INDEX_VERSION_2);
            return bob.obj();
        }

        const int indexVersion = indexVersionElt.numberInt();
        uassert(17394,
                str::stream() << "unsupported geo index version { " << kIndexVersionFieldName
                              << " : " << indexVersionElt << " }, only support versions: ["
                              << S2_INDEX_VERSION_1 << "," << S2_INDEX_VERSION_2 << "]",
                indexVersionElt.isNumber() && (indexVersion == S2_INDEX_VERSION_2
                                               || indexVersion == S2_INDEX_VERSION_1));
        return specObj;
    }

    void S2AccessMethod::getKeys(const BSONObj& obj, BSONObjSet* keys) {
        return _keyGenerator->getKeys( obj, keys );
    }

}  // namespace mongo