summaryrefslogtreecommitdiff
path: root/src/mongo/db/index_legacy.h
blob: f72ea99fbb3abfb2020a283a6302df7b3cd294f0 (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


/**
 *    Copyright (C) 2018-present MongoDB, Inc.
 *
 *    This program is free software: you can redistribute it and/or modify
 *    it under the terms of the Server Side Public License, version 1,
 *    as published by MongoDB, Inc.
 *
 *    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
 *    Server Side Public License for more details.
 *
 *    You should have received a copy of the Server Side Public License
 *    along with this program. If not, see
 *    <http://www.mongodb.com/licensing/server-side-public-license>.
 *
 *    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 Server Side 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/base/status_with.h"
#include "mongo/db/jsobj.h"

namespace mongo {

class Collection;
class IndexDescriptor;
class OperationContext;

/**
 * There has been some behavior concerning indexed access patterns -- both pre and post-index
 * construction -- that does not quite fit in the access pattern model implemented in
 * index/index_access_pattern.h. Such behavior can't be changed in the current implementation of
 * the code.
 *
 * We grouped such exception/legacy behavior here.
 */
class IndexLegacy {
public:
    /**
     * Adjust the provided index spec BSONObj depending on the type of index obj describes.
     *
     * This is a no-op unless the object describes a TEXT or a GEO_2DSPHERE index.  TEXT and
     * GEO_2DSPHERE provide additional validation on the index spec, and tweak the index spec
     * object to conform to their expected format.
     */
    static StatusWith<BSONObj> adjustIndexSpecObject(const BSONObj& obj);

    /**
     * Returns the BSONObj that is inserted into an index when the object is missing the keys
     * the index is over.
     *
     * For every index *except hash*, this is the BSON equivalent of jstNULL.
     * For the hash index, it's the hash of BSON("" << BSONNULL).
     *
     * s/d_split.cpp needs to know this.
     *
     * This is a significant leak of index functionality out of the index layer.
     */
    static BSONObj getMissingField(Collection* collection, const BSONObj& infoObj);
};

}  // namespace mongo