mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-12-15 10:52:30 +00:00
127 lines
3.6 KiB
Markdown
127 lines
3.6 KiB
Markdown
---
|
||
slug: /en/development/build
|
||
sidebar_position: 64
|
||
sidebar_label: Build on Linux
|
||
title: How to Build ClickHouse on Linux
|
||
description: How to build ClickHouse on Linux
|
||
---
|
||
|
||
|
||
Supported platforms:
|
||
|
||
- x86_64
|
||
- AArch64
|
||
- Power9 (experimental)
|
||
|
||
## 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 {#install-prerequisites}
|
||
|
||
``` bash
|
||
sudo apt-get install git cmake ccache python3 ninja-build nasm yasm gawk
|
||
```
|
||
|
||
### Install and Use the Clang compiler
|
||
|
||
On Ubuntu/Debian you can use LLVM's automatic installation script, see [here](https://apt.llvm.org/).
|
||
|
||
``` bash
|
||
sudo bash -c "$(wget -O - https://apt.llvm.org/llvm.sh)"
|
||
```
|
||
|
||
Note: in case of troubles, you can also use this:
|
||
|
||
```bash
|
||
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](https://releases.llvm.org/download.html).
|
||
|
||
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:
|
||
|
||
``` bash
|
||
export CC=clang-15
|
||
export CXX=clang++-15
|
||
```
|
||
|
||
### Checkout ClickHouse Sources {#checkout-clickhouse-sources}
|
||
|
||
``` bash
|
||
git clone --recursive --shallow-submodules git@github.com:ClickHouse/ClickHouse.git
|
||
```
|
||
|
||
or
|
||
|
||
``` bash
|
||
git clone --recursive --shallow-submodules https://github.com/ClickHouse/ClickHouse.git
|
||
```
|
||
|
||
### Build ClickHouse {#build-clickhouse}
|
||
|
||
``` bash
|
||
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 {#how-to-build-clickhouse-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:
|
||
|
||
``` bash
|
||
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:
|
||
|
||
``` bash
|
||
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
|
||
```
|
||
|
||
## You Don’t Have to Build ClickHouse {#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](https://github.com/clickhouse/clickhouse/). To download them:
|
||
|
||
1. Open the [commits list](https://github.com/ClickHouse/ClickHouse/commits/master)
|
||
1. Choose a **Merge pull request** commit that includes the new feature, or was added after the new feature
|
||
1. Click the status symbol (yellow dot, red x, green check) to open the CI check list
|
||
1. Scroll through the list until you find **ClickHouse build check x/x artifact groups are OK**
|
||
1. Click **Details**
|
||
1. Find the type of package for your operating system that you need and download the files.
|
||
|
||
|