1
0
Fork 0
arangodb/arangod/Utils/CollectionNameResolver.h

337 lines
12 KiB
C++

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2014-2016 ArangoDB GmbH, Cologne, Germany
/// Copyright 2004-2014 triAGENS GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
/// http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is ArangoDB GmbH, Cologne, Germany
///
/// @author Jan Steemann
////////////////////////////////////////////////////////////////////////////////
#ifndef ARANGOD_UTILS_COLLECTION_NAME_RESOLVER_H
#define ARANGOD_UTILS_COLLECTION_NAME_RESOLVER_H 1
#include "Basics/Common.h"
#include "Basics/ReadLocker.h"
#include "Basics/StringUtils.h"
#include "Cluster/ClusterInfo.h"
#include "Cluster/ServerState.h"
#include "VocBase/vocbase.h"
namespace arangodb {
class CollectionNameResolver {
public:
//////////////////////////////////////////////////////////////////////////////
/// @brief create the resolver
//////////////////////////////////////////////////////////////////////////////
explicit CollectionNameResolver(TRI_vocbase_t* vocbase)
: _vocbase(vocbase),
_serverRole(ServerState::instance()->getRole()),
_resolvedNames(),
_resolvedIds() {}
//////////////////////////////////////////////////////////////////////////////
/// @brief destroy the resolver
//////////////////////////////////////////////////////////////////////////////
~CollectionNameResolver() = default;
public:
//////////////////////////////////////////////////////////////////////////////
/// @brief look up a collection id for a collection name (local case),
/// use this if you know you are on a single server or on a DBserver
/// and need to look up a local collection name (or shard name).
//////////////////////////////////////////////////////////////////////////////
TRI_voc_cid_t getCollectionIdLocal(std::string const& name) const {
if (name[0] >= '0' && name[0] <= '9') {
// name is a numeric id
return static_cast<TRI_voc_cid_t>(
arangodb::basics::StringUtils::uint64(name));
}
TRI_vocbase_col_t const* collection = getCollectionStruct(name);
if (collection != nullptr) {
return collection->_cid;
}
return 0;
}
//////////////////////////////////////////////////////////////////////////////
/// @brief look up a cluster collection id for a cluster collection name,
/// only use this is in cluster mode on a coordinator or DBserver, in both
/// cases the name is resolved as a cluster wide collection name and the
/// cluster wide collection id is returned.
//////////////////////////////////////////////////////////////////////////////
TRI_voc_cid_t getCollectionIdCluster(std::string const& name) const {
if (!ServerState::isRunningInCluster(_serverRole)) {
return getCollectionIdLocal(name);
}
if (name[0] >= '0' && name[0] <= '9') {
// name is a numeric id
TRI_voc_cid_t cid = static_cast<TRI_voc_cid_t>(arangodb::basics::StringUtils::uint64(name));
// Now validate the cid
TRI_col_type_t type = getCollectionTypeCluster(getCollectionNameCluster(cid));
if (type == TRI_COL_TYPE_UNKNOWN) {
return 0;
}
return cid;
}
// We have to look up the collection info:
ClusterInfo* ci = ClusterInfo::instance();
std::shared_ptr<CollectionInfo> cinfo =
ci->getCollection(DatabaseID(_vocbase->_name), name);
if (cinfo->empty()) {
return 0;
}
return cinfo->id();
}
//////////////////////////////////////////////////////////////////////////////
/// @brief look up a collection id for a collection name, this is the
/// default one to use, which will usually do the right thing. On a
/// single server or DBserver it will use the local lookup and on a
/// coordinator it will use the cluster wide lookup.
//////////////////////////////////////////////////////////////////////////////
TRI_voc_cid_t getCollectionId(std::string const& name) const {
if (!ServerState::isRunningInCluster(_serverRole) ||
ServerState::isDBServer(_serverRole)) {
return getCollectionIdLocal(name);
}
return getCollectionIdCluster(name);
}
//////////////////////////////////////////////////////////////////////////////
/// @brief look up a collection type for a collection name (local case)
//////////////////////////////////////////////////////////////////////////////
TRI_col_type_t getCollectionType(std::string const& name) const {
if (name[0] >= '0' && name[0] <= '9') {
// name is a numeric id
return getCollectionType(getCollectionName(static_cast<TRI_voc_cid_t>(
arangodb::basics::StringUtils::uint64(name))));
}
TRI_vocbase_col_t const* collection = getCollectionStruct(name);
if (collection != nullptr) {
return collection->_type;
}
return TRI_COL_TYPE_UNKNOWN;
}
//////////////////////////////////////////////////////////////////////////////
/// @brief look up a collection struct for a collection name
//////////////////////////////////////////////////////////////////////////////
TRI_vocbase_col_t const* getCollectionStruct(std::string const& name) const {
auto it = _resolvedNames.find(name);
if (it != _resolvedNames.end()) {
return (*it).second;
}
TRI_vocbase_col_t const* collection =
TRI_LookupCollectionByNameVocBase(_vocbase, name);
if (collection != nullptr) {
_resolvedNames.emplace(name, collection);
}
return collection;
}
//////////////////////////////////////////////////////////////////////////////
/// @brief look up a cluster collection type for a cluster collection name on
/// the
/// coordinator and for a shard name on the db server
//////////////////////////////////////////////////////////////////////////////
TRI_col_type_t getCollectionTypeCluster(std::string const& name) const {
// This fires in Single server case as well
if (!ServerState::isCoordinator(_serverRole)) {
return getCollectionType(name);
}
if (name[0] >= '0' && name[0] <= '9') {
// name is a numeric id
return getCollectionTypeCluster(
getCollectionName(static_cast<TRI_voc_cid_t>(
arangodb::basics::StringUtils::uint64(name))));
}
// We have to look up the collection info:
ClusterInfo* ci = ClusterInfo::instance();
std::shared_ptr<CollectionInfo> cinfo =
ci->getCollection(DatabaseID(_vocbase->_name), name);
if (cinfo->empty()) {
return TRI_COL_TYPE_UNKNOWN;
}
return cinfo->type();
}
//////////////////////////////////////////////////////////////////////////////
/// @brief look up a collection name for a collection id, this implements
/// some magic in the cluster case: a DBserver in a cluster will automatically
/// translate the local collection ID into a cluster wide collection name.
//////////////////////////////////////////////////////////////////////////////
std::string getCollectionName(TRI_voc_cid_t cid) const {
auto it = _resolvedIds.find(cid);
if (it != _resolvedIds.end()) {
return (*it).second;
}
std::string name = localNameLookup(cid);
_resolvedIds.emplace(cid, name);
return name;
}
//////////////////////////////////////////////////////////////////////////////
/// @brief look up a cluster-wide collection name for a cluster-wide
/// collection id
//////////////////////////////////////////////////////////////////////////////
std::string getCollectionNameCluster(TRI_voc_cid_t cid) const {
// First check the cache:
auto it = _resolvedIds.find(cid);
if (it != _resolvedIds.end()) {
return (*it).second;
}
if (!ServerState::isClusterRole(_serverRole)) {
// This handles the case of a standalone server
return getCollectionName(cid);
}
std::string name;
if (ServerState::isDBServer(_serverRole)) {
// This might be a local system collection:
name = localNameLookup(cid);
if (name != "_unknown") {
_resolvedIds.emplace(cid, name);
return name;
}
}
int tries = 0;
while (tries++ < 2) {
std::shared_ptr<CollectionInfo> ci =
ClusterInfo::instance()->getCollection(
_vocbase->_name, arangodb::basics::StringUtils::itoa(cid));
name = ci->name();
if (name.empty()) {
ClusterInfo::instance()->flush();
continue;
}
_resolvedIds.emplace(cid, name);
return name;
}
LOG(ERR) << "CollectionNameResolver: was not able to resolve id " << cid;
return "_unknown";
}
//////////////////////////////////////////////////////////////////////////////
/// @brief return collection name if given string is either the name or
/// a string with the (numerical) collection id, this returns the cluster
/// wide collection name in the DBserver case
//////////////////////////////////////////////////////////////////////////////
std::string getCollectionName(std::string const& nameOrId) const {
if (!nameOrId.empty() &&
(nameOrId[0] < '0' || nameOrId[0] > '9')) {
return nameOrId;
}
TRI_voc_cid_t tmp = arangodb::basics::StringUtils::uint64(nameOrId);
return getCollectionName(tmp);
}
private:
std::string localNameLookup(TRI_voc_cid_t cid) const {
std::string name;
if (ServerState::isDBServer(_serverRole)) {
READ_LOCKER(readLocker, _vocbase->_collectionsLock);
auto it = _vocbase->_collectionsById.find(cid);
if (it != _vocbase->_collectionsById.end()) {
if ((*it).second->_planId == 0) {
// DBserver local case
name = (*it).second->name();
} else {
// DBserver case of a shard:
name = arangodb::basics::StringUtils::itoa((*it).second->_planId);
std::shared_ptr<CollectionInfo> ci =
ClusterInfo::instance()->getCollection((*it).second->_dbName, name);
name = ci->name(); // can be empty, if collection unknown
}
}
} else {
// exactly as in the non-cluster case
name = TRI_GetCollectionNameByIdVocBase(_vocbase, cid);
}
if (name.empty()) {
name = "_unknown";
}
return name;
}
private:
//////////////////////////////////////////////////////////////////////////////
/// @brief vocbase base pointer
//////////////////////////////////////////////////////////////////////////////
TRI_vocbase_t* _vocbase;
//////////////////////////////////////////////////////////////////////////////
/// @brief role of server in cluster
//////////////////////////////////////////////////////////////////////////////
ServerState::RoleEnum _serverRole;
//////////////////////////////////////////////////////////////////////////////
/// @brief collection id => collection struct map
//////////////////////////////////////////////////////////////////////////////
mutable std::unordered_map<std::string, TRI_vocbase_col_t const*>
_resolvedNames;
//////////////////////////////////////////////////////////////////////////////
/// @brief collection id => collection name map
//////////////////////////////////////////////////////////////////////////////
mutable std::unordered_map<TRI_voc_cid_t, std::string> _resolvedIds;
};
}
#endif