ClickHouse/docs/en/development/build.md
Mike Kot 444f3aa2ac
Add --shallow-submodules version
For recent Git, this options changes checkout time drastically
2023-02-16 20:44:01 +03:00

4.6 KiB
Raw Blame History

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)

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 Prerequisites

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

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)"

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 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 --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
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, its not needed for the build)
  • CMake 3.15 or newer
  • Ninja
  • C++ compiler: clang-14 or newer
  • Linker: lld
  • Yasm
  • Gawk

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 yasm gawk
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 yasm gawk
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 yasm gawk
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 git@github.com: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 Dont Have to Build ClickHouse

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

The CI checks build the binaries on each commit to ClickHouse. To download them:

  1. Open the commits list
  2. Choose a Merge pull request commit that includes the new feature, or was added after the new feature
  3. Click the status symbol (yellow dot, red x, green check) to open the CI check list
  4. Scroll through the list until you find ClickHouse build check x/x artifact groups are OK
  5. Click Details
  6. Find the type of package for your operating system that you need and download the files.

build artifact check