mirror of https://gitee.com/bigwinds/arangodb
229 lines
8.4 KiB
C++
229 lines
8.4 KiB
C++
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief Aql, collection
|
|
///
|
|
/// @file
|
|
///
|
|
/// DISCLAIMER
|
|
///
|
|
/// Copyright 2014 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
|
|
/// @author Copyright 2014, ArangoDB GmbH, Cologne, Germany
|
|
/// @author Copyright 2012-2013, triAGENS GmbH, Cologne, Germany
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef ARANGODB_AQL_COLLECTION_H
|
|
#define ARANGODB_AQL_COLLECTION_H 1
|
|
|
|
#include "Basics/Common.h"
|
|
#include "Cluster/ClusterInfo.h"
|
|
#include "Utils/Exception.h"
|
|
#include "VocBase/document-collection.h"
|
|
#include "VocBase/transaction.h"
|
|
#include "VocBase/vocbase.h"
|
|
|
|
namespace triagens {
|
|
namespace aql {
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- struct Collection
|
|
// -----------------------------------------------------------------------------
|
|
|
|
struct Collection {
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- constructors / destructors
|
|
// -----------------------------------------------------------------------------
|
|
|
|
Collection& operator= (Collection const&) = delete;
|
|
Collection (Collection const&) = delete;
|
|
Collection () = delete;
|
|
|
|
Collection (std::string const& name,
|
|
struct TRI_vocbase_s* vocbase,
|
|
TRI_transaction_type_e accessType)
|
|
: name(name),
|
|
currentShard(),
|
|
vocbase(vocbase),
|
|
collection(nullptr),
|
|
accessType(accessType) {
|
|
|
|
TRI_ASSERT(! name.empty());
|
|
TRI_ASSERT(vocbase != nullptr);
|
|
}
|
|
|
|
~Collection () {
|
|
}
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public functions
|
|
// -----------------------------------------------------------------------------
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief set the current shard
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void setCurrentShard (std::string const& shard) {
|
|
currentShard = shard;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief remove the current shard
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
void resetCurrentShard () {
|
|
currentShard = "";
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief get the collection id
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline TRI_voc_cid_t cid () const {
|
|
TRI_ASSERT(collection != nullptr);
|
|
return collection->_cid;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief get the pointer to the document collection
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline TRI_document_collection_t* documentCollection () const {
|
|
TRI_ASSERT(collection != nullptr);
|
|
TRI_ASSERT(collection->_collection != nullptr);
|
|
|
|
return collection->_collection;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief whether or not the collection is an edge collection
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline bool isEdgeCollection () const {
|
|
auto document = documentCollection();
|
|
return (document->_info._type == TRI_COL_TYPE_EDGE);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief whether or not the collection is a document collection
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
inline bool isDocumentCollection () const {
|
|
auto document = documentCollection();
|
|
return (document->_info._type == TRI_COL_TYPE_DOCUMENT);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief count the LOCAL number of documents in the collection
|
|
/// TODO: must be adjusted for clusters
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
size_t count () const {
|
|
if (numDocuments == UNINITIALIZED) {
|
|
auto document = documentCollection();
|
|
// cache the result
|
|
numDocuments = static_cast<int64_t>(document->size(document));
|
|
}
|
|
|
|
return static_cast<size_t>(numDocuments);
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns the shard information for a collection
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::map<std::string, std::string> shardInfo () const {
|
|
auto clusterInfo = triagens::arango::ClusterInfo::instance();
|
|
auto collectionInfo = clusterInfo->getCollection(std::string(vocbase->_name), name);
|
|
if (collectionInfo.get() == nullptr) {
|
|
THROW_ARANGO_EXCEPTION_MESSAGE(TRI_ERROR_INTERNAL, "collection not found");
|
|
}
|
|
|
|
return collectionInfo.get()->shardIds();
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns the shard ids of a collection
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::vector<std::string> shardIds () const {
|
|
auto clusterInfo = triagens::arango::ClusterInfo::instance();
|
|
auto collectionInfo = clusterInfo->getCollection(std::string(vocbase->_name), name);
|
|
if (collectionInfo.get() == nullptr) {
|
|
THROW_ARANGO_EXCEPTION_MESSAGE(TRI_ERROR_INTERNAL, "collection not found");
|
|
}
|
|
|
|
std::vector<std::string> ids;
|
|
for (auto const& it : collectionInfo.get()->shardIds()) {
|
|
ids.emplace_back(it.first);
|
|
}
|
|
return ids;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief returns the name of the collection, translated for the sharding
|
|
/// case
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
|
|
std::string getName () const {
|
|
if (! currentShard.empty()) {
|
|
// sharding case: return the current shard name instead of the collection name
|
|
return currentShard;
|
|
}
|
|
|
|
// non-sharding case: simply return the name
|
|
return name;
|
|
}
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- private variables
|
|
// -----------------------------------------------------------------------------
|
|
|
|
private:
|
|
|
|
std::string const name;
|
|
std::string currentShard;
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- public variables
|
|
// -----------------------------------------------------------------------------
|
|
|
|
public:
|
|
|
|
TRI_vocbase_t* vocbase;
|
|
TRI_vocbase_col_t* collection;
|
|
TRI_transaction_type_e accessType;
|
|
mutable int64_t numDocuments = UNINITIALIZED;
|
|
|
|
static int64_t const UNINITIALIZED = -1;
|
|
};
|
|
|
|
}
|
|
}
|
|
|
|
#endif
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// --SECTION-- END-OF-FILE
|
|
// -----------------------------------------------------------------------------
|
|
|
|
// Local Variables:
|
|
// mode: outline-minor
|
|
// outline-regexp: "/// @brief\\|/// {@inheritDoc}\\|/// @page\\|// --SECTION--\\|/// @\\}"
|
|
// End:
|