Skip to content

Commit fbe9546

Browse files
authored
Merge branch 'main' into autogenerate_mergetree_settings
2 parents 59c6219 + 60eb5ea commit fbe9546

File tree

36 files changed

+1103
-152
lines changed

36 files changed

+1103
-152
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,12 @@ Check out the GitHub docs for a refresher on [how to create a pull request](http
134134
135135
### Style guidelines
136136
137-
For style guidelines, see ["Style guide"](/contribute/style-guide.md).
137+
For documentation style guidelines, see ["Style guide"](/contribute/style-guide.md).
138+
139+
### Generating documentation from source code
140+
141+
For an overview of how reference documentation such as settings, system tables
142+
and functions are generated from the source code, see ["Generating documentation from source code"](/contribute/autogenerated-documentation-from-source.md)
138143
139144
### Tests and CI/CD {#tests-and-cicd}
140145
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Generating documentation from source code
2+
3+
A [script in our docs repo](https://github.com/ClickHouse/clickhouse-docs/blob/main/scripts/settings/autogenerate-settings.sh)
4+
extracts setting names, descriptions, default values, etc. from ClickHouse's source code.
5+
6+
## Session settings
7+
8+
Documentation for session settings are extracted from [`src/Core/Settings.cpp`](https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/Settings.cpp).
9+
10+
## Format settings
11+
12+
Documentation for session settings are extracted from [`src/Core/FormatFactorySettings.h`](https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/FormatFactorySettings.h).
13+
14+
## Server settings
15+
16+
Documentation for session settings are extracted from [`src/Core/ServerSettings.cpp`](https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/ServerSettings.cpp).
17+
18+
Note that this file contains only a fraction of all server settings.
19+
The reason is that server settings can be nested and `system.server_settings`
20+
(which is built from `src/Core/ServerSettings.cpp`) and cannot represent nested
21+
settings.
22+
23+
Example:
24+
25+
```yaml
26+
<query_cache>
27+
<max_size_in_bytes>1073741824</max_size_in_bytes>
28+
<max_entries>1024</max_entries>
29+
<max_entry_size_in_bytes>1048576</max_entry_size_in_bytes>
30+
<max_entry_size_in_rows>30000000</max_entry_size_in_rows>
31+
</query_cache>
32+
```
33+
As a result of the above, you will find the server settings which are not found
34+
in `system.server_settings` documented in file `_server_settings_outside_source.md`
35+
36+
The auto-generation script reads these in, combines them with the ones from
37+
`system.settings` and appends the formatted settings to `settings.md`.
38+
39+
**As such, if you need to make a change to the settings you see on the
40+
[server settings](clickhouse.com/docs/operations/server-configuration-parameters/)
41+
page, you will need to check if the setting is in `system.server_settings`.
42+
If it is, then please edit the setting description in the source code documentation
43+
in [`ServerSettings.cpp`](https://github.com/ClickHouse/ClickHouse/blob/master/src/Core/ServerSettings.cpp)
44+
or else edit `_server_settings_outside_source.md`.**
45+
46+
## System tables
47+
48+
## Functions

docs/about-us/adopters.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,7 @@ The following list of companies using ClickHouse and their success stories is as
7979
| [Bloxy](https://bloxy.info) | Blockchain | Analytics ||| [Slides in Russian, August 2018](https://github.com/ClickHouse/clickhouse-presentations/blob/master/meetup17/4_bloxy.pptx) |
8080
| [Bonree](https://www.bonree.com/) | Software & Technology | Performance Monitoring & Observability ||| ClickHouse Meetup in Hangzhou, May 2024 |
8181
| [Bonside](https://www.bonside.com/) | FinTech | - ||| [Hacker News, July 2023](https://news.ycombinator.com/item?id=36619722) |
82+
| [BoundaryML](https://www.boundaryml.com/)| Software Development | AI Platform||| [Meetup, March 2025](https://youtu.be/DV-zkQUvuPc) |
8283
| [Botify](https://www.botify.com/) | SaaS | SEO ||| [Blog Article, September 2022](https://tech.marksblogg.com/billion-taxi-rides-doublecloud-clickhouse.html) |
8384
| [Braintrust](https://www.usebraintrust.com/) | Software & Technology | Real-time Analytics ||| [Written Blog from Meetup Video, July 2024](https://clickhouse.com/blog/building-better-ai-products-faster-how-braintrust-uses-clickhouse-for-real-time-data-analysis) |
8485
| [Buildkite](https://buildkite.com/)| Software & Technology | Real-time analytics ||| [Wellington meetup, February 2025](https://clickhouse.com/videos/wellington-meetup-buildkite-clickhouse-test-analytics) |
@@ -268,6 +269,7 @@ The following list of companies using ClickHouse and their success stories is as
268269
| [Kyligence](https://kyligence.io/) | Managed Service | Main Product ||| [Website](https://kyligence.io/all-inclusive-olap/) |
269270
| [LANCOM Systems](https://www.lancom-systems.com/) | Network Solutions | Traffic analysis | - | - | [ClickHouse Operator for Kubernetes](https://www.lancom-systems.com/), [Hacker News post](https://news.ycombinator.com/item?id=29413660) |
270271
| [Langchain](https://www.langchain.com/) | Software & Technology | LLM Monitoring | - | - | [Blog, Apr 2024](https://clickhouse.com/blog/langchain-why-we-choose-clickhouse-to-power-langchain) |
272+
| [LangFuse](https://langfuse.com/) | Software & Technology | LLM Monitoring | - | - | [Meetup, March 2025](https://youtu.be/AnghkoucpN0) |
271273
| [Langtrace AI](https://www.langtrace.ai/) | Software & Technology | LLM Monitoring | - | - | [Twitter, May 2024](https://x.com/karthikkalyan90/status/1790483625743716703) |
272274
| [Lago](https://www.getlago.com/) | Billing automation | - ||| [GitHub Wiki post](https://github.com/getlago/lago/wiki/How-ClickHouse-saved-our-events-engine-problem) |
273275
| [Lagon](https://lagon.app/) | Software Development | Serverless Functions ||| [Twitter, 2023](https://twitter.com/tomlienard/status/1702759256909394010) |
@@ -325,7 +327,7 @@ The following list of companies using ClickHouse and their success stories is as
325327
| [Neocom](https://www.neocom.ai/) | Software & Technology | Sales Platform ||| [Hacker News, September 2023](https://news.ycombinator.com/item?id=37359122) |
326328
| [NeonDB](https://neon.tech/) | Cloud | Postgres management | - | - | [Blog, 2024](https://double.cloud/resources/case-studies/neon-increases-data-granularity-with-managed-clickhouse/) |
327329
| [NetMeta](https://github.com/monogon-dev/NetMeta/blob/main/README.md) | Observability | Main Product ||| [Twitter, December 2022](https://twitter.com/leolukde/status/1605643470239977475) |
328-
| [Netflix](https://www.netflix.com/) | Software & Technology | Video Streaming ||| [Twitter, June 2023](https://twitter.com/clickhousedb/status/1673803621220360193) |
330+
| [Netflix](https://www.netflix.com/) | Software & Technology | Video Streaming ||| [Meetup, March 2025](https://youtu.be/64TFG_Qt5r4) |
329331
| [Netskope](https://www.netskope.com/) | Network Security |||| [Job advertisement, March 2021](https://www.mendeley.com/careers/job/senior-software-developer-backend-developer-1346348) |
330332
| [Nexpath Networks](https://www.nexpath.net/) | Software & Technology | Network Analysis ||| [Slides, September 2021](https://opensips.org/events/Summit-2021Distributed/assets/presentations/2021-jon-abrams-big-telco-data-with-clickhouse.pdf) [Video, September 2021](https://www.youtube.com/watch?v=kyu_wDcO0S4&t=3840s) |
331333
| [NineData](https://www.ninedata.cloud/) | Software & Technology | DMaaS ||| ClickHouse Meetup in Hangzhou, May 2024 |

docs/cloud/bestpractices/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
slug: /cloud/bestpractices
3-
keywords: ['Cloud', 'Best Practices', 'Bulk Inserts', 'Asynchronous Inserts', 'Avoid Mutations', 'Avoid Nullable Columns', 'Avoid Optimize Final', 'Low Cardinality Partitioning Key']
3+
keywords: ['Cloud', 'Best Practices', 'Bulk Inserts', 'Asynchronous Inserts', 'Avoid Mutations', 'Avoid Nullable Columns', 'Avoid Optimize Final', 'Low Cardinality Partitioning Key', 'Multi Tenancy']
44
title: 'Overview'
55
hide_title: true
66
description: 'Landing page for Best Practices section in ClickHouse'
@@ -18,4 +18,5 @@ This section provides six best practices you will want to follow to get the most
1818
| [Avoid Nullable Columns](/cloud/bestpractices/avoid-nullable-columns) | Learn why you should ideally avoid Nullable columns |
1919
| [Avoid Optimize Final](/cloud/bestpractices/avoid-optimize-final) | Learn why you should avoid `OPTIMIZE TABLE ... FINAL` |
2020
| [Choose a Low Cardinality Partitioning Key](/cloud/bestpractices/low-cardinality-partitioning-key) | Learn how to choose a low cardinality partitioning key. |
21-
| [Usage Limits](/cloud/bestpractices/usage-limits)| Explore the limits of ClickHouse. |
21+
| [Usage Limits](/cloud/bestpractices/usage-limits)| Explore the limits of ClickHouse. |
22+
| [Multi tenancy](/cloud/bestpractices/multi-tenancy)| Learn about different strategies to implement multi-tenancy. |

0 commit comments

Comments
 (0)