summaryrefslogtreecommitdiff
path: root/src/mongo/db/tenant_namespace.h
blob: 1e70d99a55a5644c892643c4951e59b9f4815bb1 (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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/**
 *    Copyright (C) 2021-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 <iosfwd>
#include <string>

#include "mongo/base/string_data.h"
#include "mongo/bson/util/builder.h"
#include "mongo/db/namespace_string.h"
#include "mongo/db/tenant_id.h"
#include "mongo/logv2/log_attr.h"

namespace mongo {

class TenantNamespace {
public:
    TenantNamespace(const TenantNamespace& tenantNs)
        : _tenantId(tenantNs.tenantId()),
          _nss(tenantNs.getNss()),
          _tenantNsStr(tenantNs.toString()) {}

    /**
     * Constructs an empty TenantNamespace.
     */
    TenantNamespace() : _tenantId(boost::none), _nss(), _tenantNsStr() {}

    /**
     * Constructs a TenantNamespace from the given tenantId and NamespaceString.
     *
     * If featureFlagRequireTenantID is set, tenantId is required.
     */
    TenantNamespace(boost::optional<mongo::TenantId> tenantId, NamespaceString nss);

    /**
     * Constructs a TenantNamespace from the string "ns". When the server parameter
     * "multitenancySupport” is enabled, the tenantId will be parsed separately from the database
     * name. If it is disabled, the tenantId will be parsed as a prefix of the database name, and
     * the tenantId field will be empty. For example:
     * if “multitenancySupport” is enabled, "tenant1_dbA.collA" will be parsed as:
     * _tenantId = tenant1
     * _nss = NamespaceString(dbA.collA)
     *
     * if “multitenancySupport” is disabled, "tenant1_dbA.collA" will be parsed as:
     * _tenantId = boost::none
     * _nss = NamespaceString(tenant1_dbA.collA), and the _nss,db()
     *
     * This method should only be used when reading a namespace from disk. To construct a
     * TenantNamespace otherwise, use the standard constructor above.
     *
     * If featureFlagRequireTenantID is set, tenantId is required.
     */
    static TenantNamespace parseTenantNamespaceFromDisk(StringData ns);

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

    StringData db() const {
        return _nss.db();
    }

    StringData coll() const {
        return _nss.coll();
    }

    const NamespaceString& getNss() const {
        return _nss;
    }

    std::string toString() const {
        if (_tenantNsStr)
            return *_tenantNsStr;

        invariant(!_tenantId);
        return _nss.ns();
    }

    // Relops among `TenantNamespace`.
    friend bool operator==(const TenantNamespace& a, const TenantNamespace& b) {
        return a.toString() == b.toString();
    }
    friend bool operator!=(const TenantNamespace& a, const TenantNamespace& b) {
        return a.toString() != b.toString();
    }
    friend bool operator<(const TenantNamespace& a, const TenantNamespace& b) {
        return a.toString() < b.toString();
    }
    friend bool operator>(const TenantNamespace& a, const TenantNamespace& b) {
        return a.toString() > b.toString();
    }
    friend bool operator<=(const TenantNamespace& a, const TenantNamespace& b) {
        return a.toString() <= b.toString();
    }
    friend bool operator>=(const TenantNamespace& a, const TenantNamespace& b) {
        return a.toString() >= b.toString();
    }

    template <typename H>
    friend H AbslHashValue(H h, const TenantNamespace& tenantNs) {
        return H::combine(std::move(h), tenantNs.toString());
    }

    friend auto logAttrs(const TenantNamespace& nss) {
        return "namespace"_attr = nss;
    }

private:
    boost::optional<TenantId> _tenantId;
    NamespaceString _nss;
    boost::optional<std::string> _tenantNsStr;  // Only set if _tenantId exists
};

std::ostream& operator<<(std::ostream& stream, const TenantNamespace& tenantNs);
StringBuilder& operator<<(StringBuilder& builder, const TenantNamespace& tenantNs);

}  // namespace mongo