Skip to main content

How to Build ClickHouse on Linux

Supported platforms:

  • x86_64
  • AArch64
  • Power9 (experimental)

Normal Build for Development on Ubuntu

The following tutorial is based on the Ubuntu Linux system. With appropriate changes, it should also work on any other Linux distribution.

Install Git, CMake, Python and Ninja

sudo apt-get install git cmake ccache python3 ninja-build

Or cmake3 instead of cmake on older systems.

On Ubuntu/Debian you can use the automatic installation script (check official webpage)

sudo bash -c "$(wget -O - https://apt.llvm.org/llvm.sh)"

For other Linux distribution - check the availability of the prebuild packages or build clang from sources.

Use the latest clang for Builds

export CC=clang-15
export CXX=clang++-15

In this example we use version 15 that is the latest as of Sept 2022.

Gcc cannot be used.

Checkout ClickHouse Sources

git clone --recursive [email protected]:ClickHouse/ClickHouse.git

or

git clone --recursive https://github.com/ClickHouse/ClickHouse.git

Build ClickHouse

cd ClickHouse
mkdir build
cd build
cmake ..
ninja

To create an executable, run ninja clickhouse. This will create the programs/clickhouse executable, which can be used with client or server arguments.

How to Build ClickHouse on Any Linux

The build requires the following components:

  • Git (is used only to checkout the sources, it’s not needed for the build)
  • CMake 3.15 or newer
  • Ninja
  • C++ compiler: clang-14 or newer
  • Linker: lld

If all the components are installed, you may build in the same way as the steps above.

Example for Ubuntu Eoan:

sudo apt update
sudo apt install git cmake ninja-build clang++ python
git clone --recursive https://github.com/ClickHouse/ClickHouse.git
mkdir build && cd build
cmake ../ClickHouse
ninja

Example for OpenSUSE Tumbleweed:

sudo zypper install git cmake ninja clang-c++ python lld
git clone --recursive https://github.com/ClickHouse/ClickHouse.git
mkdir build && cd build
cmake ../ClickHouse
ninja

Example for Fedora Rawhide:

sudo yum update
sudo yum --nogpg install git cmake make clang python3 ccache
git clone --recursive https://github.com/ClickHouse/ClickHouse.git
mkdir build && cd build
cmake ../ClickHouse
make -j $(nproc)

Here is an example of how to build clang and all the llvm infrastructure from sources:

git clone [email protected]:llvm/llvm-project.git
mkdir llvm-build && cd llvm-build
cmake -DCMAKE_BUILD_TYPE:STRING=Release -DLLVM_ENABLE_PROJECTS=all ../llvm-project/llvm/
make -j16
sudo make install
hash clang
clang --version

You can install the older clang like clang-11 from packages and then use it to build the new clang from sources.

Here is an example of how to install the new cmake from the official website:

wget https://github.com/Kitware/CMake/releases/download/v3.22.2/cmake-3.22.2-linux-x86_64.sh
chmod +x cmake-3.22.2-linux-x86_64.sh
./cmake-3.22.2-linux-x86_64.sh
export PATH=/home/milovidov/work/cmake-3.22.2-linux-x86_64/bin/:${PATH}
hash cmake

You Don’t Have to Build ClickHouse

ClickHouse is available in pre-built binaries and packages. Binaries are portable and can be run on any Linux flavour.

Binaries are built for stable and LTS releases and also every commit to master for each pull request.

To find the freshest build from master, go to commits page, click on the first green check mark or red cross near commit, and click to the “Details” link right after “ClickHouse Build Check”.