ClickHouse/docs/en/development/build.md

slug	sidebar_position	sidebar_label	title	description
/en/development/build	64	Build on Linux	How to Build ClickHouse on Linux	How to build ClickHouse on Linux

Supported platforms:

• x86_64
• AArch64
• Power9 (experimental)

Building in docker

We use the docker image clickhouse/binary-builder for our CI builds. It contains everything necessary to build the binary and packages. There is a script docker/packager/packager to ease the image usage:

# define a directory for the output artifacts
output_dir="build_results"
# a simplest build
./docker/packager/packager --package-type=binary --output-dir "$output_dir"
# build debian packages
./docker/packager/packager --package-type=deb --output-dir "$output_dir"
# by default, debian packages use thin LTO, so we can override it to speed up the build
CMAKE_FLAGS='-DENABLE_THINLTO=' ./docker/packager/packager --package-type=deb --output-dir "$output_dir"

Building on Ubuntu

The following tutorial is based on Ubuntu Linux. With appropriate changes, it should also work on any other Linux distribution. The minimum recommended Ubuntu version for development is 22.04 LTS.

Install Prerequisites

sudo apt-get install git cmake ccache python3 ninja-build nasm yasm gawk lsb-release wget software-properties-common gnupg

Install and Use the Clang compiler

On Ubuntu/Debian you can use LLVM's automatic installation script, see here.

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

Note: in case of troubles, you can also use this:

sudo apt-get install software-properties-common
sudo add-apt-repository -y ppa:ubuntu-toolchain-r/test

For other Linux distribution - check the availability of LLVM's prebuild packages.

As of April 2023, any version of Clang >= 15 will work. GCC as a compiler is not supported. To build with a specific Clang version:

:::tip This is optional, if you are following along and just now installed Clang then check to see what version you have installed before setting this environment variable. :::

export CC=clang-16
export CXX=clang++-16

Checkout ClickHouse Sources

git clone --recursive --shallow-submodules git@github.com:ClickHouse/ClickHouse.git

or

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

Build ClickHouse

cd ClickHouse
mkdir build
cmake -S . -B build
cmake --build build  # or: `cd build; ninja`

To create an executable, run cmake --build build --target clickhouse (or: cd build; ninja clickhouse). This will create executable build/programs/clickhouse which can be used with client or server arguments.

Building on Any Linux

The build requires the following components:

• Git (used to checkout the sources, not needed for the build)
• CMake 3.20 or newer
• Compiler: Clang 15 or newer
• Linker: lld 15 or newer
• Ninja
• Yasm
• Gawk

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

Example for OpenSUSE Tumbleweed:

sudo zypper install git cmake ninja clang-c++ python lld nasm yasm gawk
git clone --recursive https://github.com/ClickHouse/ClickHouse.git
mkdir build
cmake -S . -B build
cmake --build build

Example for Fedora Rawhide:

sudo yum update
sudo yum --nogpg install git cmake make clang python3 ccache nasm yasm gawk
git clone --recursive https://github.com/ClickHouse/ClickHouse.git
mkdir build
cmake -S . -B build
cmake --build build