欢迎来到Hyrise

Hyrise是一个内存数据库研究系统，自2009年起由HPI开发，并于2017年完全重写。我们的目标是为内存数据管理领域的研究提供一个干净灵活的平台。其架构允许我们、我们的学生和其他研究人员围绕新的数据管理概念进行实验。为了实现真实的实验，Hyrise具有全面的SQL支持并执行强大的查询计划优化。众所周知的基准测试，如TPC-H或TPC-DS，可以通过单个命令执行，无需任何准备。

本readme文件主要关注存储库的技术方面。有关我们研究的更多背景和出版物列表，请访问Hyrise项目页面。

您仍可以在Github上找到Hyrise的上一个版本（已存档）。

引用

引用此版本的Hyrise时，请使用以下bibtex条目：

@inproceedings{DBLP:conf/edbt/DreselerK0KUP19,
  author    = {Markus Dreseler and
               Jan Kossmann and
               Martin Boissier and
               Stefan Klauck and
               Matthias Uflacker and
               Hasso Plattner},
  editor    = {Melanie Herschel and
               Helena Galhardas and
               Berthold Reinwald and
               Irini Fundulaki and
               Carsten Binnig and
               Zoi Kaoudi},
  title     = {Hyrise Re-engineered: An Extensible Database System for Research in
               Relational In-Memory Data Management},
  booktitle = {Advances in Database Technology - 22nd International Conference on
               Extending Database Technology, {EDBT} 2019, Lisbon, Portugal, March
               26-29, 2019},
  pages     = {313--324},
  publisher = {OpenProceedings.org},
  year      = {2019},
  url       = {https://doi.org/10.5441/002/edbt.2019.28},
  doi       = {10.5441/002/edbt.2019.28},
  timestamp = {Mon, 18 Mar 2019 16:09:00 +0100},
  biburl    = {https://dblp.org/rec/conf/edbt/DreselerK0KUP19.bib},
  bibsource = {dblp computer science bibliography, https://dblp.org}
}

</details>

支持的系统

Hyrise是为Linux（最好是最新的Ubuntu版本）开发的，并针对服务器硬件进行了优化。我们支持Mac以方便Hyrise的本地开发，但不建议用于基准测试。

支持的基准测试

我们开箱即支持多项基准测试。这使得生成性能数据变得容易，无需设置数据生成、加载CSV和寻找查询运行器。您可以使用./hyriseBenchmark*二进制文件运行它们。

请注意，查询计划是在我们的CI管道中生成的，可能有许多并行阶段，不同的CI运行可能在不同的机器上执行。报告的运行时间不应被视为可靠的基准性能数据。

基准测试	注释
TPC-DS	查询计划
TPC-H	查询计划
Join Order	查询计划
Star Schema	查询计划
JCC-H	使用-j标志调用hyriseBenchmarkTPCH二进制文件。
TPC-C	正在开发中，尚未进行适当的优化

入门

请查看我们的贡献指南。

您可以在词汇表中找到代码中使用的大多数术语和缩写的定义。如果找不到您要查找的内容，请随时提出问题。

逐步指南是了解Hyrise的好起点。

原生设置

您可以自行安装依赖项，或使用install_dependencies.sh脚本（推荐），该脚本会安装其中列出的所有依赖项和子模块。安装脚本已在macOS Monterey（12.4）和Ubuntu 22.04上测试过。

有关使用brew install或apt-get install的详细依赖项列表，请参阅依赖项，具体取决于您的平台。作为编译器，我们通常使用clang和gcc（仅限Linux）的最新版本。请确保系统编译器指向最新版本，或相应地使用cmake（见下文）。旧版本可能可以工作，但既未经测试也不受支持。

Nix设置

您可以使用Nix构建Hyrise。首先，在您当前的操作系统上安装Nix。之后，在存储库的根目录下运行以下命令：

nix-shell resources/nix --pure

这将使您进入一个安装了所有依赖项的shell。现在您可以像往常一样构建Hyrise。请注意，建议使用--pure标志，因为它可以避免使用本地系统的依赖项。

有关Nix的更多信息，请参阅Nix软件包。

使用Docker设置

如果您想使用CLion创建基于Docker的开发环境，请查看我们的专门教程。

否则，要将Hyrise的所有依赖项放入Docker镜像，请运行

docker build -t hyrise .

您可以通过以下方式启动容器

docker run -it hyrise

在容器内，您可以然后checkout Hyrise并运行./install_dependencies.sh来下载所需的子模块。

构建和工具

强烈建议执行源外构建，即为构建创建一个单独的目录。该目录的建议名称为 cmake-build-{debug,release}，具体取决于构建类型。在此目录中调用 cmake .. 来配置构建。默认情况下，我们使用非常严格的编译器标志（超过 -Wextra，包括 -Werror）。如果您使用官方支持的环境之一，这应该不是问题。如果您只是想在不同的系统上测试 Hyrise 并遇到问题，可以调用 cmake -DHYRISE_RELAXED_BUILD=On ..，这将禁用这些严格的检查。后续对 CMake 的调用，例如在向构建中添加文件时，将不再需要，生成的 Makefile 会处理这些问题。

编译器选择

CMake 将默认使用系统的默认编译器。要使用不同的编译器，请在一个干净的构建目录中调用 cmake -DCMAKE_C_COMPILER=clang -DCMAKE_CXX_COMPILER=clang++ ..。有关支持的编译器版本，请参阅依赖项。

合一构建

从 cmake 3.16 开始，您可以使用 -DCMAKE_UNITY_BUILD=On 来执行合一构建。对于完整的（重新）构建或需要重建多个文件时，这通常更快，因为启动编译器进程和加载最常见头文件的相对成本降低了。然而，这仅适用于调试构建。有关减少编译时间的详细信息，请参阅我们的博客文章。

ccache

对于开发，您可能想使用 ccache，它可以显著减少重新编译所需的时间。特别是在切换分支时，这可以将重新编译的时间从几分钟减少到一分钟或更少。另一方面，我们在 CI 服务器上看到了随机的构建失败，这就是为什么我们不再推荐 ccache，而仅将其列为一个选项。要使用 ccache，请在 cmake 调用中添加 -DCMAKE_CXX_COMPILER_LAUNCHER=ccache。您需要在环境变量或 ccache 配置中调整一些 ccache 设置，以便 ccache 可以处理预编译头文件。在我们的 CI 服务器上，这对我们有效：CCACHE_SLOPPINESS=file_macro,pch_defines,time_macros CCACHE_DEPEND=1。

构建

只需调用 make -j*，其中 * 表示要使用的线程数。

通常会创建调试二进制文件。要为发布构建配置构建目录，请确保它是空的，并像这样调用 CMake：cmake -DCMAKE_BUILD_TYPE=Release

代码检查

./scripts/lint.sh（对数据库代码使用 Google 的 cpplint。此外，我们使用 flake8 对 /scripts 下的 Python 脚本进行代码检查。）

格式化

./scripts/format.sh（对数据库代码使用 clang-format。我们使用 black 格式化 /scripts 下的 Python 脚本。）

测试

从构建目录调用 make hyriseTest 会构建所有可用的测试。可以使用 ./<YourBuildDirectory>/hyriseTest 执行二进制文件。可以通过 --gtest_filter= 选择所有可用测试的子集。

覆盖率

./scripts/coverage.sh 将在命令行打印摘要，并在 ./coverage/index.html 创建详细的 html 报告

在 macOS 和 Linux 上需要 clang。

地址/未定义行为清理器

cmake -DENABLE_ADDR_UB_LEAK_SANITIZATION=ON 将生成带有 AddressSanitizer、LeakSanitizer 和 Undefined Behavior 选项的 Makefile。像往常一样编译和运行它们 - 如果检测到任何问题，它们将被打印到控制台。它将在检测到第一个错误时失败，并打印摘要。要将地址转换为实际的源代码位置，请确保安装了 llvm-symbolizer（包含在 llvm 包中）并且可在 $PATH 中使用。要指定符号化器的自定义位置，请将 $ASAN_SYMBOLIZER_PATH 设置为可执行文件的路径。这在 macOS 上似乎可以直接使用 - 如果不行，请确保安装了 llvm。可以使用 LSAN_OPTIONS=suppressions=asan-ignore.txt ./<YourBuildDirectory>/hyriseTest 执行二进制文件。

cmake -DENABLE_THREAD_SANITIZATION=ON 将像上面一样工作，但使用 ThreadSanitizer。一些清理器是互斥的，这就是为什么我们为此使用两种配置。