table.h

/* Copyright (c) 2021 Xie Meiyi(xiemeiyi@hust.edu.cn) and 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. */
 
//
// Created by Meiyi & Wangyunlai on 2021/5/12.
//
 
#pragma once
 
#include "storage/table/table_meta.h"
#include "storage/table/table_engine.h"
#include "storage/common/chunk.h"
#include "storage/record/lob_handler.h"
#include "common/types.h"
#include "common/lang/span.h"
#include "common/lang/functional.h"
 
struct RID;
class Record;
class DiskBufferPool;
class RecordFileHandler;
class RecordScanner;
class ChunkFileScanner;
class ConditionFilter;
class DefaultConditionFilter;
class Index;
class IndexScanner;
class RecordDeleter;
class Trx;
class Db;
 
class Table
{
public:
  Table() = default;
  ~Table();
 
  // TODO: use TableEngine replace Table
  friend class TableEngine;
  friend class HeapTableEngine;
 
  RC create(Db *db, int32_t table_id, const char *path, const char *name, const char *base_dir,
      span<const AttrInfoSqlNode> attributes, const vector<string> &primary_keys, StorageFormat storage_format,
      StorageEngine storage_engine);
 
  RC open(Db *db, const char *meta_file, const char *base_dir);
 
  RC make_record(int value_num, const Value *values, Record &record);
 
  RC insert_record(Record &record);
 
  RC insert_chunk(const Chunk &chunk);
  RC delete_record(const Record &record);
 
  RC insert_record_with_trx(Record &record, Trx *trx);
  RC delete_record_with_trx(const Record &record, Trx *trx);
  RC update_record_with_trx(const Record &old_record, const Record &new_record, Trx *trx);
  RC get_record(const RID &rid, Record &record);
 
  // TODO refactor
  RC create_index(Trx *trx, const FieldMeta *field_meta, const char *index_name);
 
  RC get_record_scanner(RecordScanner *&scanner, Trx *trx, ReadWriteMode mode);
 
  RC get_chunk_scanner(ChunkFileScanner &scanner, Trx *trx, ReadWriteMode mode);
 
  RC visit_record(const RID &rid, function<bool(Record &)> visitor);
 
public:
  int32_t     table_id() const { return table_meta_.table_id(); }
  const char *name() const;
 
  Db *db() const { return db_; }
 
  const TableMeta &table_meta() const;
 
  LobFileHandler *lob_handler() const { return lob_handler_; }
 
  RC sync();
 
private:
  RC set_value_to_record(char *record_data, const Value &value, const FieldMeta *field);
 
private:
  // RC init_record_handler(const char *base_dir);
 
public:
  Index *find_index(const char *index_name) const;
  Index *find_index_by_field(const char *field_name) const;
 
private:
  Db       *db_ = nullptr;
  TableMeta table_meta_;
  // DiskBufferPool    *data_buffer_pool_ = nullptr;  /// 数据文件关联的buffer pool
  // RecordFileHandler *record_handler_   = nullptr;  /// 记录操作
  // vector<Index *>    indexes_;
  unique_ptr<TableEngine> engine_      = nullptr;
  LobFileHandler         *lob_handler_ = nullptr;
};