arangodb/arangod/RocksDBEngine/RocksDBMethods.h

////////////////////////////////////////////////////////////////////////////////
/// DISCLAIMER
///
/// Copyright 2017 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 Simon Grätzer
////////////////////////////////////////////////////////////////////////////////

#ifndef ARANGOD_ROCKSDB_ROCKSDB_METHODS_H
#define ARANGOD_ROCKSDB_ROCKSDB_METHODS_H 1

#include "Basics/Result.h"
#include "RocksDBColumnFamily.h"
#include "RocksDBCommon.h"

namespace rocksdb {
class Transaction;
class Slice;
class Iterator;
class TransactionDB;
class WriteBatchWithIndex;
class Comparator;
struct ReadOptions;
}  // namespace rocksdb

namespace arangodb {

class RocksDBKey;
class RocksDBMethods;
class RocksDBTransactionState;

class RocksDBSavePoint {
 public:
  RocksDBSavePoint(RocksDBMethods* trx, bool handled);
  ~RocksDBSavePoint();

  void commit();

 private:
  void rollback();

 private:
  RocksDBMethods* _trx;
  bool _handled;
};

class RocksDBMethods {
 public:
  explicit RocksDBMethods(RocksDBTransactionState* state) : _state(state) {}
  virtual ~RocksDBMethods() {}

  rocksdb::ReadOptions const& readOptions();

  // the default implementation is to do nothing
  virtual void DisableIndexing() {}
  
  // the default implementation is to do nothing
  virtual void EnableIndexing() {}

  virtual bool Exists(rocksdb::ColumnFamilyHandle*, RocksDBKey const&) = 0;
  virtual arangodb::Result Get(rocksdb::ColumnFamilyHandle*, rocksdb::Slice const&,
                               std::string*) = 0;
  virtual arangodb::Result Put(
      rocksdb::ColumnFamilyHandle*, RocksDBKey const&, rocksdb::Slice const&,
      rocksutils::StatusHint hint = rocksutils::StatusHint::none) = 0;
  
  virtual arangodb::Result Delete(rocksdb::ColumnFamilyHandle*,
                                  RocksDBKey const&) = 0;

  std::unique_ptr<rocksdb::Iterator> NewIterator(
      rocksdb::ColumnFamilyHandle* cf) {
    return this->NewIterator(this->readOptions(), cf);
  }
  virtual std::unique_ptr<rocksdb::Iterator> NewIterator(
      rocksdb::ReadOptions const&, rocksdb::ColumnFamilyHandle*) = 0;

  virtual void SetSavePoint() = 0;
  virtual arangodb::Result RollbackToSavePoint() = 0;
  
  // convenience and compatibility method
  arangodb::Result Get(rocksdb::ColumnFamilyHandle*, RocksDBKey const&,
                       std::string*);


#ifdef ARANGODB_ENABLE_MAINTAINER_MODE
  std::size_t countInBounds(RocksDBKeyBounds const& bounds, bool isElementInRange = false);
#endif
  
 protected:
  RocksDBTransactionState* _state;
};

// only implements GET and NewIterator
class RocksDBReadOnlyMethods final : public RocksDBMethods {
 public:
  explicit RocksDBReadOnlyMethods(RocksDBTransactionState* state);

  bool Exists(rocksdb::ColumnFamilyHandle*, RocksDBKey const&) override;
  arangodb::Result Get(rocksdb::ColumnFamilyHandle*, rocksdb::Slice const& key,
                       std::string* val) override;
  arangodb::Result Put(
      rocksdb::ColumnFamilyHandle*, RocksDBKey const& key,
      rocksdb::Slice const& val,
      rocksutils::StatusHint hint = rocksutils::StatusHint::none) override;
  arangodb::Result Delete(rocksdb::ColumnFamilyHandle*,
                          RocksDBKey const& key) override;

  std::unique_ptr<rocksdb::Iterator> NewIterator(
      rocksdb::ReadOptions const&, rocksdb::ColumnFamilyHandle*) override;

  void SetSavePoint() override {}
  arangodb::Result RollbackToSavePoint() override { return arangodb::Result(); }

 private:
  rocksdb::TransactionDB* _db;
};

/// transaction wrapper, uses the current rocksdb transaction
class RocksDBTrxMethods : public RocksDBMethods {
 public:
  explicit RocksDBTrxMethods(RocksDBTransactionState* state);
  
  void DisableIndexing() override;
  
  void EnableIndexing() override;

  bool Exists(rocksdb::ColumnFamilyHandle*, RocksDBKey const&) override;
  arangodb::Result Get(rocksdb::ColumnFamilyHandle*, rocksdb::Slice const& key,
                       std::string* val) override;

  arangodb::Result Put(
      rocksdb::ColumnFamilyHandle*, RocksDBKey const& key,
      rocksdb::Slice const& val,
      rocksutils::StatusHint hint = rocksutils::StatusHint::none) override;
  arangodb::Result Delete(rocksdb::ColumnFamilyHandle*,
                          RocksDBKey const& key) override;

  std::unique_ptr<rocksdb::Iterator> NewIterator(
      rocksdb::ReadOptions const&, rocksdb::ColumnFamilyHandle*) override;

  void SetSavePoint() override;
  arangodb::Result RollbackToSavePoint() override;
};

/// transaction wrapper, uses the current rocksdb transaction and non-tracking methods
class RocksDBTrxUntrackedMethods final : public RocksDBTrxMethods {
 public:
  explicit RocksDBTrxUntrackedMethods(RocksDBTransactionState* state);
  
  arangodb::Result Put(
      rocksdb::ColumnFamilyHandle*, RocksDBKey const& key,
      rocksdb::Slice const& val,
      rocksutils::StatusHint hint = rocksutils::StatusHint::none) override;
  arangodb::Result Delete(rocksdb::ColumnFamilyHandle*,
                          RocksDBKey const& key) override;
};

/// wraps a writebatch - non transactional
class RocksDBBatchedMethods final : public RocksDBMethods {
 public:
  RocksDBBatchedMethods(RocksDBTransactionState*,
                        rocksdb::WriteBatchWithIndex*);

  bool Exists(rocksdb::ColumnFamilyHandle*, RocksDBKey const&) override;
  arangodb::Result Get(rocksdb::ColumnFamilyHandle*, rocksdb::Slice const& key,
                       std::string* val) override;
  arangodb::Result Put(
      rocksdb::ColumnFamilyHandle*, RocksDBKey const& key,
      rocksdb::Slice const& val,
      rocksutils::StatusHint hint = rocksutils::StatusHint::none) override;
  arangodb::Result Delete(rocksdb::ColumnFamilyHandle*,
                          RocksDBKey const& key) override;
  std::unique_ptr<rocksdb::Iterator> NewIterator(
      rocksdb::ReadOptions const&, rocksdb::ColumnFamilyHandle*) override;

  void SetSavePoint() override {}
  arangodb::Result RollbackToSavePoint() override { return arangodb::Result(); }

 private:
  rocksdb::TransactionDB* _db;
  rocksdb::WriteBatchWithIndex* _wb;
};

}  // namespace arangodb

#endif