project-tsurugi / mizugaki

SQL compiler front-end for tsurugidb

Mizugaki - A SQL compiler front end

Requirements

• CMake >= 3.16
• C++ Compiler >= C++17
• and see Dockerfile section

# retrieve third party modules
git submodule update --init --recursive

Dockerfile

FROM ubuntu:22.04

RUN apt update -y && apt install -y git build-essential cmake flex libfl-dev libgflags-dev ninja-build

optional packages:

• bison (only >= 3.6)
• doxygen
• graphviz
• clang-tidy-14

Install modules

tsurugidb modules

This requires below tsurugidb modules to be installed.

• yugawara

third_party/hopscotch-map

NOTE: hopscotch-map will be already installed because yugawara also requires it.

mkdir -p build-third_party/hopscotch-map
cd build-third_party/hopscotch-map
cmake -G Ninja -DCMAKE_INSTALL_PREFIX=[/path/to/install-prefix] ../../third_party/hopscotch-map
cmake --build . --target install

see https://github.com/Tessil/hopscotch-map

GNU Bison >= 3.6

This project requires GNU Bison >= 3.6. Please run bison --version and check the printed version.

# install packages to build bison
sudo apt update -y
sudo apt install -y curl m4

curl http://ftp.jaist.ac.jp/pub/GNU/bison/bison-3.6.4.tar.gz | tar zxv
cd bison-3.6.4
./configure --prefix=/path/to/install
make -j4
make install # or sudo make install

If you install the above to a non-standard path, please specify -DCMAKE_PREFIX_PATH=</path/to/install> to cmake.

How to build

mkdir -p build
cd build
cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ..
cmake --build .

available options:

• -DCMAKE_INSTALL_PREFIX=/path/to/install-root - change install location
• -DCMAKE_PREFIX_PATH=/path/to/install-root - add installation search path (including bison command)
• -DBUILD_SHARED_LIBS=OFF - create static libraries instead of shared libraries
• -DBUILD_TESTS=OFF - don't build test programs
• -DBUILD_DOCUMENTS=OFF - don't build documents by doxygen
• -DBUILD_EXAMPLES=OFF - don't build example applications
• -DINSTALL_EXAMPLES=ON - also install example applications
• -DFORCE_INSTALL_RPATH=ON - automatically configure INSTALL_RPATH for non-default library paths

install

cmake --build . --target install

run tests

ctest

generate documents

cmake --build . --target doxygen

License

Apache License, Version 2.0