summaryrefslogtreecommitdiff
path: root/src/mongo/s/type_database.h
blob: cbecfd490f481be6f875e5f430f53ade3732c335 (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
/**
 *    Copyright (C) 2012 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.
 */

#pragma once

#include <boost/optional.hpp>
#include <string>

#include "mongo/db/jsobj.h"

namespace mongo {

    class BSONObj;
    class Status;
    template<typename T> class StatusWith;


    /**
     * This class represents the layout and contents of documents contained in the config.databases
     * collection. All manipulation of documents coming from that collection should be done with
     * this class.
     */
    class DatabaseType {
    public:
        // Name of the databases collection in the config server.
        static const std::string ConfigNS;

        static const BSONField<std::string> name;
        static const BSONField<std::string> primary;
        static const BSONField<bool> sharded;


        DatabaseType();

        /**
         * Constructs a new DatabaseType object from BSON. Also does validation of the contents.
         */
        static StatusWith<DatabaseType> fromBSON(const BSONObj& source);

        /**
         * Returns OK if all fields have been set. Otherwise returns NoSuchKey and information
         * about what is the first field which is missing.
         */
        Status validate() const;

        /**
         * Returns the BSON representation of the entry.
         */
        BSONObj toBSON() const;

        /**
         * Clears the internal state.
         */
        void clear();

        /**
         * Returns a std::string representation of the current internal state.
         */
        std::string toString() const;

        const std::string& getName() const { return _name.get(); }
        void setName(const std::string& name);

        const std::string& getPrimary() const { return _primary.get(); }
        void setPrimary(const std::string& primary);

        bool getSharded() const { return _sharded.get(); }
        void setSharded(bool sharded) { _sharded = sharded; }

    private:
        // Requred database name
        boost::optional<std::string> _name;

        // Required primary shard (must be set even if the database is sharded, because there
        // might be collections, which are unsharded).
        boost::optional<std::string> _primary;

        // Required whether sharding is enabled for this database. Even though this field is of
        // type optional, it is only used as an indicator that the value was explicitly set.
        boost::optional<bool> _sharded;
    };

} // namespace mongo