mirror of https://gitee.com/bigwinds/arangodb
181 lines
8.8 KiB
C++
181 lines
8.8 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/ReadWriteLock.h"
|
|
#include "Cluster/ServerState.h"
|
|
#include "VocBase/voc-types.h"
|
|
|
|
enum TRI_col_type_e : uint32_t;
|
|
|
|
namespace arangodb {
|
|
|
|
class LogicalCollection;
|
|
class LogicalDataSource;
|
|
class LogicalView; // forward declaration
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief data-source id/name resolver and cache (single-server and cluster)
|
|
/// @note not thread-safe
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
class CollectionNameResolver {
|
|
public:
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief create the resolver
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
explicit CollectionNameResolver(TRI_vocbase_t& vocbase)
|
|
: _vocbase(vocbase),
|
|
_serverRole(ServerState::instance()->getRole()) {}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief destroy the resolver
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
~CollectionNameResolver() = default;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief look up a collection struct for a collection id
|
|
/// @return the local collection on dbserver / standalone
|
|
/// the cluster collection on coordinator
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
std::shared_ptr<LogicalCollection> getCollection(TRI_voc_cid_t id) const;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief look up a collection struct for a
|
|
/// collection name, stringified id (or uuid for dbserver / standalone)
|
|
/// @return the local collection on dbserver / standalone
|
|
/// the cluster collection on coordinator
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
std::shared_ptr<LogicalCollection> getCollection(std::string const& nameOrId) const;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @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;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @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;
|
|
|
|
std::shared_ptr<LogicalCollection> getCollectionStructCluster(std::string const& name) const;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @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;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @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;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief look up a cluster-wide collection name for a cluster-wide
|
|
/// collection id
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
std::string getCollectionNameCluster(TRI_voc_cid_t cid) const;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @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;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief look up a data-source struct for a data-source id
|
|
/// @return the local data-source on dbserver / standalone
|
|
/// the cluster data-source on coordinator
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
std::shared_ptr<LogicalDataSource> getDataSource(TRI_voc_cid_t id) const;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief look up a data-source struct for a
|
|
/// data-source name, stringified id (or uuid for dbserver/standalone)
|
|
/// @return the local data-source on dbserver / standalone
|
|
/// the cluster data-source on coordinator
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
std::shared_ptr<LogicalDataSource> getDataSource(std::string const& nameOrId) const;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief look up a view struct for a view id
|
|
/// @return the local view on dbserver / standalone
|
|
/// the cluster view on coordinator
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
std::shared_ptr<LogicalView> getView(TRI_voc_cid_t id) const;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief look up a view struct for a
|
|
/// view name, stringified id (or uuid for dbserver / standalone)
|
|
/// @return the local view on dbserver / standalone
|
|
/// the cluster view on coordinator
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
std::shared_ptr<LogicalView> getView(std::string const& nameOrId) const;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief the vocbase instance this resolver instance uses
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
TRI_vocbase_t& vocbase() const { return _vocbase; }
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief invoke visitor on all collections that map to the specified 'id'
|
|
/// @return visitation was successful
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
bool visitCollections(std::function<bool(LogicalCollection&)> const& visitor,
|
|
TRI_voc_cid_t id) const;
|
|
|
|
private:
|
|
mutable std::unordered_map<TRI_voc_cid_t, std::shared_ptr<LogicalDataSource>> _dataSourceById; // cached data-source by id
|
|
mutable std::unordered_map<std::string, std::shared_ptr<LogicalDataSource>> _dataSourceByName; // cached data-source by name
|
|
|
|
std::string lookupName(TRI_voc_cid_t cid) const;
|
|
|
|
/// @brief vocbase base pointer
|
|
TRI_vocbase_t& _vocbase;
|
|
|
|
/// @brief role of server in cluster
|
|
ServerState::RoleEnum const _serverRole;
|
|
|
|
/// @brief lock protecting _resolvedIds
|
|
mutable basics::ReadWriteLock _idLock;
|
|
|
|
/// @brief collection id => collection name map
|
|
mutable std::unordered_map<TRI_voc_cid_t, std::string> _resolvedIds;
|
|
};
|
|
|
|
} // namespace arangodb
|
|
|
|
#endif
|