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

66 lines
2.0 KiB
C++

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2014-2017 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_DATABASE_GUARD_H
#define ARANGOD_UTILS_DATABASE_GUARD_H 1
#include "Basics/Common.h"
#include "VocBase/vocbase.h"
namespace arangodb {
/// @brief Scope guard for a database, ensures that it is not
/// dropped while still using it.
class DatabaseGuard {
public:
DatabaseGuard(DatabaseGuard&&) = delete;
DatabaseGuard(DatabaseGuard const&) = delete;
DatabaseGuard& operator=(DatabaseGuard const&) = delete;
/// @brief create guard on existing db
explicit DatabaseGuard(TRI_vocbase_t& vocbase);
/// @brief create the guard, using a database id
explicit DatabaseGuard(TRI_voc_tick_t id);
/// @brief create the guard, using a database name
explicit DatabaseGuard(std::string const& name);
/// @brief destroy the guard
~DatabaseGuard() {
TRI_ASSERT(!_vocbase.isDangling());
_vocbase.release();
}
/// @brief return the database pointer
inline TRI_vocbase_t& database() const { return _vocbase; }
private:
/// @brief pointer to database
TRI_vocbase_t& _vocbase;
};
} // namespace arangodb
#endif