feat(b_plus_tree_printer): add file batch operations (#553)

* feat: support batch operations in b_plus_tree_printer

* fix bugs in switch and add comment for the method

* add space for comment

* update comment for BatchOpsFromFile()

* fix: check-format bugs

---------

Co-authored-by: Alex Chi Z <[email protected]>

Author: xzhseh

src/include/storage/index/b_plus_tree.h

@@ -116,6 +116,17 @@ class BPlusTree {
   // read data from file and remove one by one
   void RemoveFromFile(const std::string &file_name, Transaction *txn = nullptr);
 
+  /**
+   * @brief Read batch operations from input file, below is a sample file format
+   * insert some keys and delete 8, 9 from the tree with one step.
+   * { i1 i2 i3 i4 i5 i6 i7 i8 i9 i10 i30 d8 d9 } //  batch.txt
+   * B+ Tree(4 max leaf, 4 max internal) after processing:
+   *                            (5)
+   *                 (3)                (7)
+   *            (1,2)    (3,4)    (5,6)    (7,10,30) //  The output tree example
+   */
+  void BatchOpsFromFile(const std::string &file_name, Transaction *txn = nullptr);
+
  private:
   /* Debug Routines for FREE!! */
   void ToGraph(page_id_t page_id, const BPlusTreePage *page, std::ofstream &out);

src/storage/index/b_plus_tree.cpp

@@ -145,6 +145,33 @@ void BPLUSTREE_TYPE::RemoveFromFile(const std::string &file_name, Transaction *t
   }
 }
 
+/*
+ * This method is used for test only
+ * Read data from file and insert/remove one by one
+ */
+INDEX_TEMPLATE_ARGUMENTS
+void BPLUSTREE_TYPE::BatchOpsFromFile(const std::string &file_name, Transaction *txn) {
+  int64_t key;
+  char instruction;
+  std::ifstream input(file_name);
+  while (input) {
+    input >> instruction >> key;
+    RID rid(key);
+    KeyType index_key;
+    index_key.SetFromInteger(key);
+    switch (instruction) {
+      case 'i':
+        Insert(index_key, rid, txn);
+        break;
+      case 'd':
+        Remove(index_key, txn);
+        break;
+      default:
+        break;
+    }
+  }
+}
+
 INDEX_TEMPLATE_ARGUMENTS
 void BPLUSTREE_TYPE::Print(BufferPoolManager *bpm) {
   auto root_page_id = GetRootPageId();

tools/b_plus_tree_printer/b_plus_tree_printer.cpp

@@ -35,6 +35,7 @@ auto UsageMessage() -> std::string {
       "\ti <k>  -- Insert <k> (int64_t) as both key and value).\n"
       "\tf <filename>  -- insert multiple keys from reading file.\n"
       "\tc <filename>  -- delete multiple keys from reading file.\n"
+      "\tx <filename>  -- insert or delete multiple keys from reading file.\n"
       "\td <k>  -- Delete key <k> and its associated value.\n"
       "\tg <filename>.dot  -- Output the tree in graph format to a dot file\n"
       "\tp -- Print the B+ tree.\n"
@@ -92,6 +93,10 @@ auto main(int argc, char **argv) -> int {
         std::cin >> filename;
         tree.RemoveFromFile(filename, transaction);
         break;
+      case 'x':
+        std::cin >> filename;
+        tree.BatchOpsFromFile(filename, transaction);
+        break;
       case 'd':
         std::cin >> key;
         index_key.SetFromInteger(key);