2
* Copyright (C) 2013 10gen Inc.
4
* This program is free software: you can redistribute it and/or modify
5
* it under the terms of the GNU Affero General Public License, version 3,
6
* as published by the Free Software Foundation.
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
* GNU Affero General Public License for more details.
13
* You should have received a copy of the GNU Affero General Public License
14
* along with this program. If not, see <http://www.gnu.org/licenses/>.
16
* As a special exception, the copyright holders give permission to link the
17
* code of portions of this program with the OpenSSL library under certain
18
* conditions as described in each individual source file and distribute
19
* linked combinations including the program with the OpenSSL library. You
20
* must comply with the GNU Affero General Public License in all respects for
21
* all of the code used other than as permitted herein. If you modify file(s)
22
* with this exception, you may extend this exception to your version of the
23
* file(s), but you are not obligated to do so. If you do not wish to do so,
24
* delete this exception statement from your version. If you delete this
25
* exception statement from all source files in the program, then also delete
26
* it in the license file.
29
#include "mongo/db/index/s2_access_method.h"
33
#include "mongo/base/status.h"
34
#include "mongo/db/geo/geoconstants.h"
35
#include "mongo/db/geo/geoparser.h"
36
#include "mongo/db/geo/geoquery.h"
37
#include "mongo/db/geo/s2.h"
38
#include "mongo/db/geo/s2common.h"
39
#include "mongo/db/index/expression_params.h"
40
#include "mongo/db/index/s2_key_generator.h"
41
#include "mongo/db/index_names.h"
42
#include "mongo/db/jsobj.h"
44
#include "third_party/s2/s2cell.h"
45
#include "third_party/s2/s2regioncoverer.h"
49
static const string kIndexVersionFieldName("2dsphereIndexVersion");
51
S2AccessMethod::S2AccessMethod(IndexCatalogEntry* btreeState)
52
: BtreeBasedAccessMethod(btreeState) {
54
const IndexDescriptor* descriptor = btreeState->descriptor();
56
ExpressionParams::parse2dsphereParams(descriptor->infoObj(),
59
_keyGenerator.reset( new S2KeyGenerator( descriptor->keyPattern(), _params ) );
63
// Categorize the fields we're indexing and make sure we have a geo field.
64
BSONObjIterator i(descriptor->keyPattern());
66
BSONElement e = i.next();
67
if (e.type() == String && IndexNames::GEO_2DSPHERE == e.String() ) {
71
// We check for numeric in 2d, so that's the check here
72
uassert( 16823, (string)"Cannot use " + IndexNames::GEO_2DSPHERE +
73
" index with other special index types: " + e.toString(),
78
uassert(16750, "Expect at least one geo field, spec=" + descriptor->keyPattern().toString(),
81
if (descriptor->isSparse()) {
82
warning() << "Sparse option ignored for index spec "
83
<< descriptor->keyPattern().toString() << "\n";
88
BSONObj S2AccessMethod::fixSpec(const BSONObj& specObj) {
89
// If the spec object has the field "2dsphereIndexVersion", validate it. If it doesn't, add
90
// {2dsphereIndexVersion: 2}, which is the default for newly-built indexes.
92
BSONElement indexVersionElt = specObj[kIndexVersionFieldName];
93
if (indexVersionElt.eoo()) {
95
bob.appendElements(specObj);
96
bob.append(kIndexVersionFieldName, S2_INDEX_VERSION_2);
100
const int indexVersion = indexVersionElt.numberInt();
102
str::stream() << "unsupported geo index version { " << kIndexVersionFieldName
103
<< " : " << indexVersionElt << " }, only support versions: ["
104
<< S2_INDEX_VERSION_1 << "," << S2_INDEX_VERSION_2 << "]",
105
indexVersionElt.isNumber() && (indexVersion == S2_INDEX_VERSION_2
106
|| indexVersion == S2_INDEX_VERSION_1));
110
void S2AccessMethod::getKeys(const BSONObj& obj, BSONObjSet* keys) {
111
return _keyGenerator->getKeys( obj, keys );