mirror of https://gitee.com/bigwinds/arangodb
285 lines
10 KiB
C++
285 lines
10 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_VOCBASE_LOGICAL_VIEW_H
|
|
#define ARANGOD_VOCBASE_LOGICAL_VIEW_H 1
|
|
|
|
#include "LogicalDataSource.h"
|
|
#include "Basics/Common.h"
|
|
#include "Basics/Result.h"
|
|
#include "Basics/ReadWriteLock.h"
|
|
#include "Meta/utility.h"
|
|
#include "VocBase/voc-types.h"
|
|
#include "Logger/Logger.h"
|
|
#include "Logger/LogMacros.h"
|
|
|
|
#include <velocypack/Buffer.h>
|
|
|
|
namespace arangodb {
|
|
|
|
namespace velocypack {
|
|
class Slice;
|
|
class Builder;
|
|
}
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @class LogicalView
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
class LogicalView : public LogicalDataSource {
|
|
public:
|
|
typedef std::shared_ptr<LogicalView> ptr;
|
|
typedef std::function<bool(TRI_voc_cid_t)> CollectionVisitor;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief casts a specified 'LogicalView' to a provided Target type
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
template<typename Target, typename Source>
|
|
inline static typename meta::adjustConst<Source, Target>::reference cast(
|
|
Source& view
|
|
) noexcept {
|
|
typedef typename meta::adjustConst<
|
|
Source,
|
|
typename std::enable_if<
|
|
std::is_base_of<LogicalView, Target>::value
|
|
&& std::is_same<typename std::remove_const<Source>::type,
|
|
LogicalView
|
|
>::value, Target>::type
|
|
> target_type_t;
|
|
|
|
#ifdef ARANGODB_ENABLE_MAINTAINER_MODE
|
|
// do not use dynamic_cast<typename target_type_t::reference>(view)
|
|
// to explicitly expose our intention to fail in 'noexcept' function
|
|
// in case of wrong type
|
|
auto impl = dynamic_cast<typename target_type_t::pointer>(&view);
|
|
|
|
if (!impl) {
|
|
LOG_TOPIC(ERR, Logger::VIEWS)
|
|
<< "invalid convertion attempt from '" << typeid(Source).name() << "'"
|
|
<< " to '" << typeid(typename target_type_t::value_type).name() << "'";
|
|
TRI_ASSERT(false);
|
|
}
|
|
|
|
return *impl;
|
|
#else
|
|
return static_cast<typename target_type_t::reference>(view);
|
|
#endif
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief casts a specified 'LogicalView' to a provided Target type
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
template<typename Target, typename Source>
|
|
inline static typename meta::adjustConst<Source, Target>::pointer cast(
|
|
Source* view
|
|
) noexcept {
|
|
typedef typename meta::adjustConst<
|
|
Source,
|
|
typename std::enable_if<
|
|
std::is_base_of<LogicalView, Target>::value
|
|
&& std::is_same<typename std::remove_const<Source>::type,
|
|
LogicalView
|
|
>::value, Target>::type
|
|
>::pointer target_type_t;
|
|
|
|
#ifdef ARANGODB_ENABLE_MAINTAINER_MODE
|
|
return dynamic_cast<target_type_t>(view);
|
|
#else
|
|
return static_cast<target_type_t>(view);
|
|
#endif
|
|
}
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief the category representing a logical view
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
static Category const& category() noexcept;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief creates a new view according to a definition
|
|
/// @param view out-param for created view on success
|
|
/// on success non-null, on failure undefined
|
|
/// @param vocbase database where the view resides
|
|
/// @param definition the view definition
|
|
/// @return success and sets 'view' or failure
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
static Result create(
|
|
LogicalView::ptr& view,
|
|
TRI_vocbase_t& vocbase,
|
|
velocypack::Slice definition
|
|
);
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief instantiates an existing view according to a definition
|
|
/// @param vocbase database where the view resides
|
|
/// @param definition the view definition
|
|
/// @return view instance or nullptr on error
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
static Result instantiate(
|
|
LogicalView::ptr& view,
|
|
TRI_vocbase_t& vocbase,
|
|
velocypack::Slice definition,
|
|
uint64_t planVersion = 0 // '0' by default for non-cluster
|
|
);
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief opens an existing view when the server is restarted
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
virtual void open() = 0;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief drop an existing view
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
virtual arangodb::Result drop() override = 0;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief renames an existing view
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
virtual Result rename(
|
|
std::string&& newName,
|
|
bool doSync
|
|
) override = 0;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief updates properties of an existing view
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
virtual arangodb::Result updateProperties(
|
|
velocypack::Slice const& properties,
|
|
bool partialUpdate,
|
|
bool doSync
|
|
) = 0;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief invoke visitor on all collections that a view will return
|
|
/// @return visitation was successful
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
virtual bool visitCollections(CollectionVisitor const& visitor) const = 0;
|
|
|
|
protected:
|
|
LogicalView(
|
|
TRI_vocbase_t& vocbase,
|
|
velocypack::Slice const& definition,
|
|
uint64_t planVersion
|
|
);
|
|
|
|
private:
|
|
// FIXME seems to be ugly
|
|
friend struct ::TRI_vocbase_t;
|
|
|
|
// ensure LogicalDataSource members (e.g. _deleted/_name) are not modified asynchronously
|
|
mutable basics::ReadWriteLock _lock;
|
|
}; // LogicalView
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief a LogicalView base class for ClusterInfo view implementations
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
class LogicalViewClusterInfo: public LogicalView {
|
|
public:
|
|
virtual Result drop() override final;
|
|
|
|
/*FIXME TODO add to trigger rename via vocbase or cluster-info
|
|
virtual Result rename(std::string&& newName, bool doSync) override final;
|
|
*/
|
|
|
|
protected:
|
|
LogicalViewClusterInfo(
|
|
TRI_vocbase_t& vocbase,
|
|
velocypack::Slice const& definition,
|
|
uint64_t planVersion
|
|
);
|
|
|
|
virtual Result appendVelocyPack(
|
|
arangodb::velocypack::Builder& builder,
|
|
bool detailed,
|
|
bool forPersistence
|
|
) const override final;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief fill and return a jSON description of a View object implementation
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
virtual arangodb::Result appendVelocyPackDetailed(
|
|
velocypack::Builder& builder,
|
|
bool forPersistence
|
|
) const = 0;
|
|
|
|
protected:
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief drop implementation-specific parts of an existing view
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
virtual arangodb::Result dropImpl() = 0;
|
|
};
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
/// @brief a LogicalView base class for StorageEngine view implementations
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
class LogicalViewStorageEngine: public LogicalView {
|
|
public:
|
|
~LogicalViewStorageEngine() override;
|
|
|
|
virtual Result drop() override final;
|
|
|
|
// FIXME TODO rename via vocbase or cluster-info
|
|
virtual Result rename(std::string&& newName, bool doSync) override final;
|
|
|
|
arangodb::Result updateProperties(
|
|
velocypack::Slice const& properties,
|
|
bool partialUpdate,
|
|
bool doSync
|
|
) override final;
|
|
|
|
protected:
|
|
LogicalViewStorageEngine(
|
|
TRI_vocbase_t& vocbase,
|
|
velocypack::Slice const& definition,
|
|
uint64_t planVersion
|
|
);
|
|
|
|
virtual Result appendVelocyPack(
|
|
arangodb::velocypack::Builder& builder,
|
|
bool detailed,
|
|
bool forPersistence
|
|
) const override final;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief fill and return a jSON description of a View object implementation
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
virtual arangodb::Result appendVelocyPackDetailed(
|
|
velocypack::Builder& builder,
|
|
bool forPersistence
|
|
) const = 0;
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
/// @brief drop implementation-specific parts of an existing view
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
virtual arangodb::Result dropImpl() = 0;
|
|
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
/// @brief called when a view's properties are updated (i.e. delta-modified)
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
virtual arangodb::Result updateProperties(
|
|
velocypack::Slice const& slice,
|
|
bool partialUpdate
|
|
) = 0;
|
|
};
|
|
|
|
} // namespace arangodb
|
|
|
|
#endif |