跳转至

实验配置

概述

本课程实验均在 HuaDB 上进行,HuaDB 数据库系统由 C++ 语言编写,支持基础的页面存储、故障恢复、缓存管理、查询解析、查询优化、查询处理等功能。课程提供 HuaDB 的基础实验框架,每次实验中,你需要在框架中填充相应的函数实现代码,使之通过该次实验的所有测例。

环境配置

HuaDB 使用了 C++17 标准,开始实验前,请确保你的开发环境支持 C++17 标准。

目前 HuaDB 仅支持 macOS 和 Linux 操作系统,使用 Windows 的同学建议使用虚拟机进行实验。

HuaDB 代码下载与提交需要使用 git 工具,代码编译需要使用 CMakeMake 工具,且需要安装 gccclang 编译器。此外,代码调试中可能会用到调试器 gdblldb。开始实验前,请确保你的开发环境安装了这些工具并可以正常使用,如没有,请根据你使用的操作系统选择对应的命令进行环境配置:

Debian/Ubuntu

sudo apt install git g++ make cmake gdb

macOS

macOS 的开发者工具已包含 clang 编译器、lldb 调试器以及 git 和 Make 工具,仅需安装 CMake 即可。

首先安装 homebrew,安装后运行:

brew install cmake

实验框架支持以下操作系统(发行版)版本:

  1. Ubuntu 20.04 及以上
  2. Debian 10 及以上
  3. macOS Monterey 及以上

在其他的环境(如 WSL, BSD 等)也可能可以编译和运行,但并未进行充分的测试,不保证可以正常工作。

评测机详情

对于选课同学,了解评测机环境配置将有助于你在本地测试结果与 CI 测试结果不一致时排查问题。评测机操作系统为 Ubuntu 22.04,相关编译构建工具版本如下:

cmake 3.22.1
make 4.3
g++ 11.4.0

虽然 HuaDB 同时支持 macOS 和 Linux 操作系统,也同时支持 gcc 和 clang 编译器,但对于一些特殊情况(如未初始化的变量)不同的环境可能会有不同的处理方式,这将可能导致你在本地可以通过测试,而在评测机的 CI 测试中失败。建议选课的同学准备一套与评测机一致的环境,在出现上述情况时帮助定位问题。我们也准备了一个与评测机环境一致的 docker 镜像,Docker Hub 标签为 hnjylwb/dbtrain,需要的同学可以使用。

开始前的工作

仓库克隆与更新

  • 对于选课同学:

首先,你需要使用 git 将 HuaDB 代码仓库克隆到你的开发机上,助教已经在 GitLab 上为你创建好仓库,使用如下命令进行克隆 (将 202x 改为你的选修年份,20xxxxxxxx 改为你的学号,克隆前请在 GitLab 上添加你的 SSH Key):

git clone git@git.tsinghua.edu.cn:dbtrain/202x/dbtrain-20xxxxxxxx.git

HuaDB 代码随时可能会有更新,发布重要更新时我们会在课程微信群内通知,此时你需要将更新的部分同步到你的本地。为了新增一个远程仓库,在你的项目根目录下执行:

git remote add upstream git@git.tsinghua.edu.cn:dbtrain/huadb-template.git

实验代码更新时,执行如下命令将更新的部分合并入你的代码:

git pull upstream main

合并过程中可能产生冲突,冲突时请手动解决所有冲突并执行 git addgit commit 指令完成合并。

我们建议在每次实验开始前进行一次代码同步更新,保持你的代码为最新版本。

  • 对于非选课同学:

你可以从 GitHub 或 Gitee 克隆代码:

git clone git@github.com:thu-db/huadb.git

git clone git@gitee.com:thu-db/huadb.git

GitHub, GiteeGitLab (仅清华同学可访问) 三个仓库的内容是完全一致且保持同步的,根据你的情况任选一个即可。

无论你是否选修本课,请不要将你的代码放到任何公有仓库上

编译及测试

运行 make lab1-debug 即可编译 HuaDB,你也可以通过设置 CMAKE_BUILD_PARALLEL_LEVEL 环境变量来进行多核编译:

CMAKE_BUILD_PARALLEL_LEVEL=$(nproc) make lab1-debug

通过以上指令可以编译出 debug 版本的程序,为便于调试,我们不建议编译 release 版本的程序。

编译生成的文件位于 build/debug 目录,实验过程中只需要关注 build/debug/bin 目录中的可执行程序即可,具体包括:

  1. shell: 数据库程序,运行后可以与数据库进行交互。

  2. sqllogictest: 测试程序,用于批量测试。

  3. huadb-parser: 数据库文件解析器,支持解析数据、日持、控制文件,用于调试。

  4. client 和 server: 实验 3 调试工具,当前无需关注。

运行如下命令来验证你编译出的数据库程序和测试程序可以正常运行:

make lab0

如果产生如下输出:

./build/debug/bin/sqllogictest test/lab{0..0}/*.test
lab0/10-basic.test PASS
lab0/20-expression.test PASS
lab0/30-set_and_show.test PASS
lab0/40-error.test PASS

表示程序正常运行。

如果程序报错,可以根据报错信息对照测试程序输出进行排查。

此外,你可以通过如下命令进入数据库交互界面:

make shell

你可以在交互界面中运行一些基础的 DDL 命令,如:

Welcome to HuaDB. Type "\?" or "\h" for help
huadb=> \?

   \? or \h              show help message
   \c [database_name]    change database
   \d                    show tables
   \d [table_name]       describe table
   \l                    show databases
   \q                    quit

huadb=> \l
+---------------+
| database_name |
+---------------+
| tmp           |
+---------------+
(1 row)

huadb=> create table test(id int, info varchar(10));
 CREATE TABLE
huadb=> \d
+------------+
| table_name |
+------------+
| test       |
+------------+
(1 row)

huadb=> \d test
+------+---------+------+
| name | type    | size |
+------+---------+------+
| id   | int     | 4    |
| info | varchar | 10   |
+------+---------+------+
(2 rows)

huadb=> drop table test;
 DROP TABLE
huadb=> \d
+------------+
| table_name |
+------------+
(0 rows)

huadb=> \q

在完成实验 1 之前,你的程序仅支持在临时数据库 tmp 中创建表、删除表和查看表的结构,还不支持数据库的创建/切换/删除,也不支持在表中插入和读取数据。

至此,环境配置与验证工作已经结束,你可以开始实验,或阅读实验框架介绍