ob_lsm.h

/* Copyright (c) 2021 OceanBase and/or its affiliates. All rights reserved.
miniob is licensed under Mulan PSL v2.
You can use this software according to the terms and conditions of the Mulan PSL v2.
You may obtain a copy of Mulan PSL v2 at:
         http://license.coscl.org.cn/MulanPSL2
THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND,
EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
See the Mulan PSL v2 for more details. */
 
#pragma once
 
#include "common/lang/string.h"
#include "common/lang/string_view.h"
#include "common/sys/rc.h"
#include "common/lang/utility.h"
#include "oblsm/include/ob_lsm_options.h"
#include "oblsm/include/ob_lsm_iterator.h"
 
namespace oceanbase {
 
class ObLsmTransaction;
class ObLsm
{
public:
  static RC open(const ObLsmOptions &options, const string &path, ObLsm **dbptr);
 
  ObLsm() = default;
 
  ObLsm(const ObLsm &) = delete;
 
  ObLsm &operator=(const ObLsm &) = delete;
 
  virtual ~ObLsm() = default;
 
  virtual RC put(const string_view &key, const string_view &value) = 0;
 
  virtual RC get(const string_view &key, string *value) = 0;
 
  virtual RC remove(const string_view &key) = 0;
 
  // TODO: distinguish transaction interface and non-transaction interface, refer to rocksdb
  virtual ObLsmTransaction *begin_transaction() = 0;
 
  virtual ObLsmIterator *new_iterator(ObLsmReadOptions options) = 0;
 
  virtual RC batch_put(const vector<pair<string, string>> &kvs) = 0;
 
  virtual void dump_sstables() = 0;
};
 
}  // namespace oceanbase