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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
|
/**
* 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/algorithm/string/predicate.hpp>
#include <boost/optional.hpp>
#include <string>
#include "mongo/base/string_data.h"
#include "mongo/db/tenant_id.h"
#include "mongo/logv2/log_attr.h"
#include "mongo/util/static_immortal.h"
namespace mongo {
/**
* A DatabaseName is a unique name for database.
* It holds a database name and tenant id, if one exists. In a serverless environment, a tenant id
* is expected to exist so that a database can be uniquely identified.
*/
class DatabaseName {
public:
/**
* Used to create `constexpr` reserved DatabaseName constants. See
* NamespaceString::ConstantProxy in namespace_string.h for more details.
*/
class ConstantProxy {
public:
class SharedState {
public:
explicit constexpr SharedState(StringData db) : _db{db} {}
const DatabaseName& get() const {
std::call_once(_once, [this] {
_dbName = new DatabaseName{TenantId::systemTenantId(), _db};
});
return *_dbName;
}
private:
StringData _db;
mutable std::once_flag _once;
mutable const DatabaseName* _dbName = nullptr;
};
constexpr explicit ConstantProxy(const SharedState* sharedState)
: _sharedState{sharedState} {}
operator const DatabaseName&() const {
return _get();
}
decltype(auto) db() const {
return _get().db();
}
decltype(auto) tenantId() const {
return _get().tenantId();
}
decltype(auto) toString() const {
return _get().toString();
}
friend std::ostream& operator<<(std::ostream& stream, const ConstantProxy& dbName) {
return stream << dbName.toString();
}
friend StringBuilder& operator<<(StringBuilder& builder, const ConstantProxy& dbName) {
return builder << dbName.toString();
}
private:
const DatabaseName& _get() const {
return _sharedState->get();
}
const SharedState* _sharedState;
};
#define DBNAME_CONSTANT(id, db) static const ConstantProxy id;
#include "database_name_reserved.def.h"
#undef DBNAME_CONSTANT
/**
* Constructs an empty DatabaseName.
*/
DatabaseName() = default;
/**
* Constructs a DatabaseName 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.
*/
DatabaseName(boost::optional<TenantId> tenantId, StringData dbString)
: _tenantId(std::move(tenantId)), _dbString(dbString.toString()) {
uassert(ErrorCodes::InvalidNamespace,
"'.' is an invalid character in a db name: " + _dbString,
dbString.find('.') == std::string::npos);
uassert(ErrorCodes::InvalidNamespace,
"database names cannot have embedded null characters",
dbString.find('\0') == std::string::npos);
}
/**
* Prefer to use the constructor above.
* TODO SERVER-65456 Remove this constructor.
*/
DatabaseName(StringData dbName, boost::optional<TenantId> tenantId = boost::none)
: DatabaseName(std::move(tenantId), dbName) {}
const boost::optional<TenantId>& tenantId() const {
return _tenantId;
}
const std::string& db() const {
return _dbString;
}
const std::string& toString() const {
return db();
}
std::string toStringWithTenantId() const {
if (_tenantId)
return str::stream() << *_tenantId << '_' << _dbString;
return _dbString;
}
bool equalCaseInsensitive(const DatabaseName& other) const {
return (_tenantId == other._tenantId) && boost::iequals(toString(), other.toString());
}
template <typename H>
friend H AbslHashValue(H h, const DatabaseName& obj) {
if (obj._tenantId) {
return H::combine(std::move(h), obj._tenantId.get(), obj._dbString);
}
return H::combine(std::move(h), obj._dbString);
}
friend auto logAttrs(const DatabaseName& obj) {
return "databaseName"_attr = obj;
}
private:
boost::optional<TenantId> _tenantId = boost::none;
std::string _dbString;
};
inline std::ostream& operator<<(std::ostream& stream, const DatabaseName& tdb) {
return stream << tdb.toString();
}
inline StringBuilder& operator<<(StringBuilder& builder, const DatabaseName& tdb) {
return builder << tdb.toString();
}
inline bool operator==(const DatabaseName& lhs, const DatabaseName& rhs) {
return (lhs.tenantId() == rhs.tenantId()) && (lhs.db() == rhs.db());
}
inline bool operator!=(const DatabaseName& lhs, const DatabaseName& rhs) {
return !(lhs == rhs);
}
inline bool operator<(const DatabaseName& lhs, const DatabaseName& rhs) {
if (lhs.tenantId() != rhs.tenantId()) {
return lhs.tenantId() < rhs.tenantId();
}
return lhs.db() < rhs.db();
}
inline bool operator>(const DatabaseName& lhs, const DatabaseName& rhs) {
if (lhs.tenantId() != rhs.tenantId()) {
return lhs.tenantId() > rhs.tenantId();
}
return lhs.db() > rhs.db();
}
inline bool operator<=(const DatabaseName& lhs, const DatabaseName& rhs) {
return !(lhs > rhs);
}
inline bool operator>=(const DatabaseName& lhs, const DatabaseName& rhs) {
return !(lhs < rhs);
}
// The `constexpr` definitions for `DatabaseName::ConstantProxy` static data members are below. See
// `constexpr` definitions for the `NamespaceString::ConstantProxy` static data members of NSS in
// namespace_string.h for more details.
namespace dbname_detail::const_proxy_shared_states {
#define DBNAME_CONSTANT(id, db) constexpr inline DatabaseName::ConstantProxy::SharedState id{db};
#include "database_name_reserved.def.h"
#undef DBNAME_CONSTANT
} // namespace dbname_detail::const_proxy_shared_states
#define DBNAME_CONSTANT(id, db) \
constexpr inline DatabaseName::ConstantProxy DatabaseName::id{ \
&dbname_detail::const_proxy_shared_states::id};
#include "database_name_reserved.def.h"
#undef DBNAME_CONSTANT
} // namespace mongo
|
