arangodb/arangod/IResearch/IResearchViewDBServer.h

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2018 ArangoDB 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 Andrey Abramov
/// @author Vasiliy Nabatchikov
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGOD_IRESEARCH__IRESEARCH_VIEW_DBSERVER_H
#define ARANGOD_IRESEARCH__IRESEARCH_VIEW_DBSERVER_H 1

#include "utils/async_utils.hpp"

#include "Transaction/Status.h"
#include "velocypack/Builder.h"
#include "VocBase/LogicalView.h"

namespace arangodb {

class DatabasePathFeature;
class TransactionState;
class CollectionNameResolver;

namespace transaction {

class Methods; // forward declaration

} // transaction

} // arangodb

namespace arangodb {
namespace iresearch {

class AsyncMeta;
class PrimaryKeyIndexReader;

class IResearchViewDBServer final: public arangodb::LogicalViewClusterInfo {
 public:
  virtual ~IResearchViewDBServer();

  /// @return success
  virtual arangodb::Result drop() override;

  //////////////////////////////////////////////////////////////////////////////
  /// @brief drop the view association for the specified 'cid'
  /// @return if an association was removed
  //////////////////////////////////////////////////////////////////////////////
  arangodb::Result drop(TRI_voc_cid_t cid) noexcept;

  //////////////////////////////////////////////////////////////////////////////
  /// @brief ensure there is a view instance for the specified 'cid'
  /// @param force creation of a new instance if none is available in vocbase
  /// @return an existing instance or create a new instance if none is registred
  ///         on ptr reset the view will be dropped if it has no collections
  /// @note view created in vocbase() to match callflow during regular startup
  //////////////////////////////////////////////////////////////////////////////
  std::shared_ptr<arangodb::LogicalView> ensure(
      TRI_voc_cid_t cid,
      bool create = true
  );

  ///////////////////////////////////////////////////////////////////////////////
  /// @brief view factory
  /// @returns initialized view object
  ///////////////////////////////////////////////////////////////////////////////
  static std::shared_ptr<LogicalView> make(
    TRI_vocbase_t& vocbase,
    arangodb::velocypack::Slice const& info,
    bool isNew,
    uint64_t planVersion,
    LogicalView::PreCommitCallback const& preCommit = {}
  );

  virtual void open() override;
  virtual arangodb::Result rename(std::string&& newName, bool doSync) override;

  ////////////////////////////////////////////////////////////////////////////////
  /// @return pointer to an index reader containing the datastore record snapshot
  ///         associated with 'state'
  ///         (nullptr == no view snapshot associated with the specified state)
  ///         if force == true && no snapshot -> associate current snapshot
  ////////////////////////////////////////////////////////////////////////////////
  PrimaryKeyIndexReader* snapshot(
    transaction::Methods& trx,
    std::vector<std::string> const& shards,
    bool force = false
  ) const;

  virtual arangodb::Result updateProperties(
    arangodb::velocypack::Slice const& properties,
    bool partialUpdate,
    bool doSync
  ) override;
  virtual bool visitCollections(
    CollectionVisitor const& visitor
  ) const override;

 protected:
  virtual arangodb::Result appendVelocyPackDetailed(
    arangodb::velocypack::Builder& builder,
    bool forPersistence
  ) const override;

 private:
  std::map<TRI_voc_cid_t, std::shared_ptr<arangodb::LogicalView>> _collections;
  std::shared_ptr<AsyncMeta> _meta; // the shared view configuration (never null!!!)
  mutable irs::async_utils::read_write_mutex _mutex; // for use with members

  IResearchViewDBServer(
    TRI_vocbase_t& vocbase,
    arangodb::velocypack::Slice const& info,
    arangodb::DatabasePathFeature const& dbPathFeature,
    uint64_t planVersion
  );
};

} // iresearch
} // arangodb

#endif