summaryrefslogtreecommitdiff
path: root/src/mongo/db/tenant_database_name.h
blob: 615e832c735057c1d7a99af0520d249df9ec94af (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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
/**
 *    Copyright (C) 2022-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 <algorithm>
#include <boost/optional.hpp>
#include <string>

#include "mongo/base/string_data.h"
#include "mongo/db/server_feature_flags_gen.h"
#include "mongo/db/tenant_id.h"

namespace mongo {
class TenantDatabaseName {
public:
    /**
     * Constructs a TenantDatabaseName from the given tenantId and database name.
     * "dbName" is expected only consist of a db name. It is the caller's responsibility to ensure
     * the dbName is a valid db name.
     *
     * If featureFlagRequireTenantID is set, tenantId is required.
     */
    TenantDatabaseName(boost::optional<TenantId> tenantId, StringData dbName) {
        // TODO SERVER-62114 Check instead if gMultitenancySupport is enabled.
        if (gFeatureFlagRequireTenantID.isEnabledAndIgnoreFCV())
            invariant(tenantId);

        _tenantId = tenantId;
        _dbName = dbName.toString();

        _tenantDbName =
            _tenantId ? boost::make_optional(_tenantId->toString() + "_" + _dbName) : boost::none;
    }

    const boost::optional<TenantId> tenantId() const {
        return _tenantId;
    }

    const std::string& dbName() const {
        return _dbName;
    }

    const std::string& fullName() const {
        if (_tenantDbName)
            return *_tenantDbName;

        invariant(!_tenantId);
        return _dbName;
    }

    const std::string& toString() const {
        return fullName();
    }

    /**
     * Returns -1, 0, or 1 if 'this' is less, equal, or greater than 'other' in
     * lexicographical order.
     */
    int compare(const TenantDatabaseName& other) const {
        return fullName().compare(other.fullName());
    }

    template <typename H>
    friend H AbslHashValue(H h, const TenantDatabaseName& obj) {
        return H::combine(std::move(h), obj.fullName());
    }

    friend auto logAttrs(const TenantDatabaseName& obj) {
        return "tenantDatabaseName"_attr = obj;
    }

private:
    boost::optional<TenantId> _tenantId;
    std::string _dbName;
    boost::optional<std::string> _tenantDbName;
};

inline bool operator==(const TenantDatabaseName& lhs, const TenantDatabaseName& rhs) {
    return lhs.compare(rhs) == 0;
}

inline bool operator!=(const TenantDatabaseName& lhs, const TenantDatabaseName& rhs) {
    return !(lhs == rhs);
}

inline bool operator<(const TenantDatabaseName& lhs, const TenantDatabaseName& rhs) {
    return lhs.compare(rhs) < 0;
}

inline bool operator>(const TenantDatabaseName& lhs, const TenantDatabaseName& rhs) {
    return rhs < lhs;
}

inline bool operator<=(const TenantDatabaseName& lhs, const TenantDatabaseName& rhs) {
    return !(lhs > rhs);
}

inline bool operator>=(const TenantDatabaseName& lhs, const TenantDatabaseName& rhs) {
    return !(lhs < rhs);
}

}  // namespace mongo