Skip to content
ClickHouse Docs
ClickHouse DocsClickHouse Docs

Development and Contributing

In this section of the docs you will find the following pages:

Page Description
Developer Prerequisites Prerequisites and setup instructions for ClickHouse development
How to Build ClickHouse on Linux Step-by-step guide for building ClickHouse from source on Linux systems
Build on macOS for macOS Guide for building ClickHouse from source on macOS systems
Build on Linux for macOS Guide for cross-compiling ClickHouse from Linux for macOS systems
How to Build ClickHouse on Linux for AARCH64 Guide for building ClickHouse from source for the AARCH64 architecture
How to Build ClickHouse on Linux for RISC-V 64 Guide for building ClickHouse from source for the RISC-V 64 architecture
Build on Linux for s390x (zLinux) Guide for building ClickHouse from source for the s390x architecture
Build on Linux for E2K Guide for building ClickHouse from source for the E2K architecture
Build on Linux for LoongArch64 Guide for building ClickHouse from source for the LoongArch64 architecture
Basics Native protocol fundamentals.
Native client packets Native protocol packets sent by clients.
Server packets Native protocol packets sent by the server.
Native protocol column types Column types in the native protocol.
CityHash Hashing used by the native protocol.
Testing ClickHouse Guide to testing ClickHouse and running the test suite
Architecture Overview A comprehensive overview of ClickHouse architecture and its column-oriented design
Continuous Integration (CI) Overview of the ClickHouse continuous integration system
Backport System Overview of the ClickHouse backport policy and automation
Third-Party Libraries Page describing ClickHouse third-party usage and how to add and maintain third-party libraries.
C++ Style Guide Coding style guidelines for ClickHouse C++ development
Integrating Rust Libraries Guide for integrating Rust libraries into ClickHouse
Run Benchmark with DEFLATE_QPL Build and benchmark the DEFLATE_QPL integration.
Profile guided optimization Profile-guided optimization for ClickHouse builds.
Building integrations with ClickHouse Build an integration with ClickHouse.
Testing your ClickHouse integration Test an integration with ClickHouse.
Documenting your ClickHouse integration Document an integration with ClickHouse.
Roadmap ClickHouse development roadmap.
Navigation