heapfile.h

Go to the documentation of this file.

/*
 * SwatDB
 *
 * @authors: See Contributors.doc for code contributors
 *
 * Copyright (c) 2020, 2025 Swarthmore College Computer Science Department
 * Swarthmore PA, Professors Tia Newhall, Ameet Soni
 */
 
// @@@@ SWATDB_ASSIGNMENT: ADDTODODATE
 
#ifndef  _SWATDB_HEAPFILE_H_
#define  _SWATDB_HEAPFILE_H_
 
#include <string>
#include <vector>
#include <mutex>
#include "swatdb_types.h"
#include "relationfile.h" //for inheritance
 
class BufferManager;
class HeapPage;
class HeapPageScanner;
class Schema;
class Record;
 
class HeapFile;
 
// @@@@ SWATDB_ASSIGNMENT: NOTEMSG DO NOT modify this struct definition
struct HeapFileHeader{
 
  PageNum free;
 
  PageNum full;
 
  std::uint32_t free_size;
 
  std::uint32_t full_size;
 
  std::uint64_t num_records;
    
};
 
class HeapFile : public RelationFile {
  friend class Catalog;
  friend class FileManager;
  friend class HeapFileScanner;
  friend class BlockHeapFileScanner;  
 
  public:
 
    HeapFile(Catalog *catalog, BufferManager *buf_mgr, Schema *schema);
 
    ~HeapFile();
 
 
    std::uint32_t getNumPages();
 
    std::uint32_t getNumFullPages();
 
    std::uint64_t getNumRecords();
 
    void createHeader();
 
    void flushHeader();
 
    RecordId insertRecord(Record record);
 
 
    void getRecord(RecordId record_id, Record* record);
 
    void updateRecord(RecordId record_id, Record record);
 
    void deleteRecord(RecordId record_id);
 
    HeapFileHeader getHeader();
 
    std::uint64_t getNumRecs(); 
 
    // @@@@ SWATDB_ASSIGNMENT: CUT_START
    // @@@@ SWATDB_ASSIGNMENT: CUT_END
    // @@@@ SWATDB_ASSIGNMENT: NOTEMSG ignore this method: not part of heapile assn
    PageId anonAppend(PageId orig_pid);
 
    // @@@@ SWATDB_ASSIGNMENT: CUT_START
    // @@@@ SWATDB_ASSIGNMENT: CUT_END
    // @@@@ SWATDB_ASSIGNMENT: NOTEMSG ignore this method: not part of heapile assn
    PageId atomicAppend(PageId orig_pid);  
 
  private:
 
  // @@@@ SWATDB_ASSIGNMENT: NOTEMSG add some private helper methods for good design
  // @@@@ SWATDB_ASSIGNMENT: NOTEMSG you should not need to add any data fields
  // @@@@ SWATDB_ASSIGNMENT: CUT_START
    void _addPage(HeapPage* page, PageId page_id, bool full);
 
    std::mutex *mtx;
 
    void _removePage(HeapPage* page, PageId page_id, bool full);
 
  // @@@@ SWATDB_ASSIGNMENT: CUT_END
 
};
 
#endif