NJUDB: A Toy RDBMS for NJU "Introduction to Databases" Course

Introduction

This repository is a toy RDBMS for NJU "Introduction to Databases" course. It is implemented in C++ and supports a subset of SQL queries.

Six Labs are included in this repository, and the details of each lab are as follows:

• Lab01: Buffer Pool - Implement the disk manager and buffer pool manager
• Lab02: Executor Basic - Implement INSERT, UPDATE, DELETE and basic operators (filter, sort, etc.)
• Lab03: Executor Analysis - Implement JOIN and AGGREGATE queries
• Lab04: Index & Storage Index - Implement B+ tree, hash index, and index scan executor
• Lab05: Concurrency - implement SS2PL, lock management and deadlock handling, MVCC.
• Lab06: Logging & Recovery - implement WAL, checkpoints and ARIES-style crash recovery

The project is mostly inspired by Rucbase, and some components follow the design of BusTub, MiniOB. Thanks for their great work!

Lab Configuration System

NJUDB features a flexible configuration system that allows you to choose between compiling labs from source or using pre-compiled gold-standard libraries for each lab individually.

Quick Start

Edit the student configuration block at the top of configure.sh. For example, to work only on Lab05 while using gold libraries for every other lab:

# Inside configure.sh
SOURCE_LABS="05"
ENABLE_LAB05_MVCC=false
ENABLE_LAB06_WAL=false
BUILD_TYPE="Debug"
CLEAN_BUILD=true

Then configure and build:

./configure.sh
cmake --build build -j

Use SOURCE_LABS="all" for all source or SOURCE_LABS="" for all gold. Existing command-line flags remain available as temporary overrides; run ./configure.sh --help to list them.

The project referenced BusTub, Rucbase ,andMiniOB. Thanks for their great work! Other document references: TiDB, Oracle and PostgreSQL.

System requirements

We only tested NJUDB on MacOS and Ubuntu, but if it also works on other systems, please let us know by issuing or pulling requests.

How to build

First clone the repository from github.

$ git clone --recursive https://github.com/nju-websoft/NJU_DBPractice

Install requirments using package manager.

For Ubuntu or Debian:

$ sudo apt install gcc g++ cmake flex bison libreadline-dev

For MacOS:

$ sudo brew install clang cmake flex bison readline

Then edit the student configuration block at the top of configure.sh, run ./configure.sh, and build with cmake --build build -j. Make sure Bison >=3.8 is correctly installed.

About how to change cmake configurations, please refer to their guide.

Tutorial

The Chinese version of the lab tutorial can be found under docs, please read them carefully before coding if you are studying NJU DB course.

Copyright

/*------------------------------------------------------------------------------
 - Copyright (c) 2024. Websoft research group, Nanjing University.
 -
 - This program is free software: you can redistribute it and/or modify
 - it under the terms of the GNU General Public License as published by
 - the Free Software Foundation, either version 3 of the License, or
 - (at your option) any later version.
 -
 - This program is distributed in the hope that it will be useful,
 - but WITHOUT ANY WARRANTY; without even the implied warranty of
 - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 - GNU General Public License for more details.
 -
 - You should have received a copy of the GNU General Public License
 - along with this program.  If not, see <https://www.gnu.org/licenses/>.
 -----------------------------------------------------------------------------*/