mirror of https://gitee.com/bigwinds/arangodb
130 lines
4.3 KiB
C++
130 lines
4.3 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_GUARD_H
|
|
#define ARANGOD_UTILS_COLLECTION_GUARD_H 1
|
|
|
|
#include "Basics/Common.h"
|
|
#include "Basics/Exceptions.h"
|
|
#include "Basics/NumberUtils.h"
|
|
#include "Basics/StringUtils.h"
|
|
#include "VocBase/vocbase.h"
|
|
|
|
namespace arangodb {
|
|
|
|
class CollectionGuard {
|
|
public:
|
|
CollectionGuard(CollectionGuard const&) = delete;
|
|
CollectionGuard& operator=(CollectionGuard const&) = delete;
|
|
|
|
CollectionGuard(CollectionGuard&& other)
|
|
: _vocbase(other._vocbase),
|
|
_collection(std::move(other._collection)),
|
|
_originalStatus(other._originalStatus),
|
|
_restoreOriginalStatus(other._restoreOriginalStatus) {
|
|
other._collection.reset();
|
|
other._vocbase = nullptr;
|
|
}
|
|
|
|
/// @brief create the guard, using a collection id
|
|
CollectionGuard(TRI_vocbase_t* vocbase, TRI_voc_cid_t cid, bool restoreOriginalStatus = false)
|
|
: _vocbase(vocbase),
|
|
_originalStatus(TRI_VOC_COL_STATUS_CORRUPTED),
|
|
_restoreOriginalStatus(restoreOriginalStatus) {
|
|
_collection = _vocbase->useCollection(cid, _originalStatus);
|
|
|
|
if (_collection == nullptr) {
|
|
THROW_ARANGO_EXCEPTION(TRI_ERROR_ARANGO_DATA_SOURCE_NOT_FOUND);
|
|
}
|
|
}
|
|
|
|
/// @brief create the guard, using a collection name
|
|
CollectionGuard(TRI_vocbase_t* vocbase, std::string const& name)
|
|
: _vocbase(vocbase),
|
|
_originalStatus(TRI_VOC_COL_STATUS_CORRUPTED),
|
|
_restoreOriginalStatus(false) {
|
|
if (!name.empty() && name[0] >= '0' && name[0] <= '9') {
|
|
TRI_voc_cid_t id =
|
|
NumberUtils::atoi_zero<TRI_voc_cid_t>(name.data(), name.data() + name.size());
|
|
_collection = _vocbase->useCollection(id, _originalStatus);
|
|
} else {
|
|
_collection = _vocbase->useCollection(name, _originalStatus);
|
|
}
|
|
|
|
if (_collection == nullptr) {
|
|
THROW_ARANGO_EXCEPTION(TRI_ERROR_ARANGO_DATA_SOURCE_NOT_FOUND);
|
|
}
|
|
}
|
|
|
|
CollectionGuard(TRI_vocbase_t* vocbase, std::shared_ptr<LogicalCollection> const& collection)
|
|
: _vocbase(vocbase),
|
|
_collection(collection),
|
|
_originalStatus(TRI_VOC_COL_STATUS_CORRUPTED),
|
|
_restoreOriginalStatus(false) {
|
|
int res = _vocbase->useCollection(collection.get(), _originalStatus);
|
|
if (res != TRI_ERROR_NO_ERROR) {
|
|
THROW_ARANGO_EXCEPTION(TRI_ERROR_ARANGO_DATA_SOURCE_NOT_FOUND);
|
|
}
|
|
}
|
|
|
|
/// @brief destroy the guard
|
|
~CollectionGuard() {
|
|
if (_collection != nullptr) {
|
|
_vocbase->releaseCollection(_collection.get());
|
|
|
|
if (_restoreOriginalStatus && (_originalStatus == TRI_VOC_COL_STATUS_UNLOADING ||
|
|
_originalStatus == TRI_VOC_COL_STATUS_UNLOADED)) {
|
|
// re-unload the collection
|
|
_vocbase->unloadCollection(_collection.get(), false);
|
|
}
|
|
}
|
|
}
|
|
|
|
public:
|
|
/// @brief return the collection pointer
|
|
inline arangodb::LogicalCollection* collection() const {
|
|
return _collection.get();
|
|
}
|
|
|
|
/// @brief return the status of the collection at the time of using the guard
|
|
inline TRI_vocbase_col_status_e originalStatus() const {
|
|
return _originalStatus;
|
|
}
|
|
|
|
private:
|
|
/// @brief pointer to vocbase
|
|
TRI_vocbase_t* _vocbase;
|
|
|
|
/// @brief pointer to collection
|
|
std::shared_ptr<arangodb::LogicalCollection> _collection;
|
|
|
|
/// @brief status of collection when invoking the guard
|
|
TRI_vocbase_col_status_e _originalStatus;
|
|
|
|
/// @brief whether or not to restore the original collection status
|
|
bool _restoreOriginalStatus;
|
|
};
|
|
} // namespace arangodb
|
|
|
|
#endif
|