Skip to content

Fix header casing -> sentence case #3938

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 27 commits into from
Jul 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
42c2a20
headings to sentence case
Blargian Jun 12, 2025
08231d3
remove uneeded file
Blargian Jun 12, 2025
dd2fba2
remove unneeded files from PR
Blargian Jun 12, 2025
c93bc75
Merge branch 'main' into fix_vale_errors
Blargian Jun 15, 2025
21610a5
fix more headers
Blargian Jun 15, 2025
62c77a4
fix more headers
Blargian Jun 15, 2025
b37ed75
use claude to fix heading violations in docs/cloud
Blargian Jun 17, 2025
040e94f
use claude to fix more heading style violations
Blargian Jun 17, 2025
4be4831
fix more headings
Blargian Jun 27, 2025
45f4a2d
Fix header casing
Blargian Jun 29, 2025
93380d1
Fix header casing
Blargian Jun 29, 2025
db819c6
Fix header casing
Blargian Jun 29, 2025
62db487
fix more headers
Blargian Jul 13, 2025
baf1b9a
merge main into branch
Blargian Jul 13, 2025
d50993b
Update beta-and-experimental-features.md
Blargian Jul 13, 2025
600587c
fix issues
Blargian Jul 13, 2025
f83175f
Merge branch 'fix_vale_errors' of github.com:Blargian/clickhouse-docs…
Blargian Jul 13, 2025
f031e26
fix vale violations
Blargian Jul 13, 2025
a5ac8f4
fix vale violation
Blargian Jul 13, 2025
79b4e14
fix vale violation
Blargian Jul 13, 2025
f901d6d
fix docs build
Blargian Jul 13, 2025
84e6f95
Apply suggestions from code review
Blargian Jul 13, 2025
977d859
Update docs/native-protocol/columns.md
Blargian Jul 13, 2025
271acfa
Update docs/guides/sre/keeper/index.md
Blargian Jul 13, 2025
0fb05df
Update docs/guides/sre/configuring-ssl.md
Blargian Jul 13, 2025
8b4a899
Update docs/managing-data/updating-data/overview.md
Blargian Jul 13, 2025
bbd6d7e
remove nonsense exceptions
Blargian Jul 13, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion contribute/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,7 @@ When using URL parameters to control which version of documentation is displayed
there are conventions to follow for reliable functionality.
Here's how the `?v=v08` parameter relates to the snippet selection:

#### How It Works
#### How it works

The URL parameter acts as a selector that matches against the `version` property
in your component configuration. For example:
Expand Down Expand Up @@ -393,3 +393,22 @@ show_related_blogs: true

This will show it on the page, assuming there is a matching blog. If there is no
match then it remains hidden.

## Vale

Vale is a command-line tool that brings code-like linting to prose.
We have a number of rules set up to ensure that our documentation is
consistent in style.

The style rules are located at `/styles/ClickHouse`, and largely based
off of the Google styleset, with some ClickHouse specific adaptions.
If you want to check only a specific rule locally, you
can run:

```bash
vale --filter='.Name == "ClickHouse.Headings"' docs/integrations
```

This will run only the rule named `Headings` on
the `docs/integrations` directory. Specifying a specific markdown
file is also possible.
2 changes: 1 addition & 1 deletion docs/_snippets/_GCS_authentication_and_bucket.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import Image from '@theme/IdealImage';

<Image size="md" img={GCS_bucket_2} alt="Creating a GCS bucket in US East 4" border />

### Generate an Access key {#generate-an-access-key}
### Generate an access key {#generate-an-access-key}

### Create a service account HMAC key and secret {#create-a-service-account-hmac-key-and-secret}

Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/_add_superset_detail.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ There are a few tasks to be done before running `docker compose`:
The commands below are to be run from the top level of the GitHub repo, `superset`.
:::

## Official ClickHouse Connect driver {#official-clickhouse-connect-driver}
## Official ClickHouse connect driver {#official-clickhouse-connect-driver}

To make the ClickHouse Connect driver available in the Superset deployment add it to the local requirements file:

Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/_users-and-roles-common.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ Roles are used to define groups of users for certain privileges instead of manag
Verify that only the above two rows are returned, rows with the value `B` in `column1` should be excluded.
:::

## Modifying Users and Roles {#modifying-users-and-roles}
## Modifying users and roles {#modifying-users-and-roles}

Users can be assigned multiple roles for a combination of privileges needed. When using multiple roles, the system will combine the roles to determine privileges, the net effect will be that the role permissions will be cumulative.

Expand Down
4 changes: 2 additions & 2 deletions docs/about-us/beta-and-experimental-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Due to the uncertainty of when features are classified as generally available, w

The sections below explicitly describe the properties of **Beta** and **Experimental** features:

## Beta Features {#beta-features}
## Beta features {#beta-features}

- Under active development to make them generally available (GA)
- Main known issues can be tracked on GitHub
Expand All @@ -26,7 +26,7 @@ You can find below the features considered Beta in ClickHouse Cloud and are avai

Note: please be sure to be using a current version of the ClickHouse [compatibility](/operations/settings/settings#compatibility) setting to be using a recently introduced feature.

## Experimental Features {#experimental-features}
## Experimental features {#experimental-features}

- May never become GA
- May be removed
Expand Down
32 changes: 16 additions & 16 deletions docs/about-us/distinctive-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,81 +7,81 @@ title: 'Distinctive Features of ClickHouse'
keywords: ['compression', 'secondary-indexes','column-oriented']
---

# Distinctive Features of ClickHouse
# Distinctive features of ClickHouse

## True Column-Oriented Database Management System {#true-column-oriented-database-management-system}
## True column-oriented database management system {#true-column-oriented-database-management-system}

In a real column-oriented DBMS, no extra data is stored with the values. This means that constant-length values must be supported to avoid storing their length "number" next to the values. For example, a billion UInt8-type values should consume around 1 GB uncompressed, or this strongly affects the CPU use. It is essential to store data compactly (without any "garbage") even when uncompressed since the speed of decompression (CPU usage) depends mainly on the volume of uncompressed data.

This is in contrast to systems that can store values of different columns separately, but that cannot effectively process analytical queries due to their optimization for other scenarios, such as HBase, Bigtable, Cassandra, and Hypertable. You would get throughput around a hundred thousand rows per second in these systems, but not hundreds of millions of rows per second.

Finally, ClickHouse is a database management system, not a single database. It allows creating tables and databases in runtime, loading data, and running queries without reconfiguring and restarting the server.

## Data Compression {#data-compression}
## Data compression {#data-compression}

Some column-oriented DBMSs do not use data compression. However, data compression plays a key role in achieving excellent performance.

In addition to efficient general-purpose compression codecs with different trade-offs between disk space and CPU consumption, ClickHouse provides [specialized codecs](/sql-reference/statements/create/table.md#specialized-codecs) for specific kinds of data, which allow ClickHouse to compete with and outperform more niche databases, like time-series ones.

## Disk Storage of Data {#disk-storage-of-data}
## Disk storage of data {#disk-storage-of-data}

Keeping data physically sorted by primary key makes it possible to extract data based on specific values or value ranges with low latency in less than a few dozen milliseconds. Some column-oriented DBMSs, such as SAP HANA and Google PowerDrill, can only work in RAM. This approach requires allocation of a larger hardware budget than necessary for real-time analysis.

ClickHouse is designed to work on regular hard drives, which means the cost per GB of data storage is low, but SSD and additional RAM are also fully used if available.

## Parallel Processing on Multiple Cores {#parallel-processing-on-multiple-cores}
## Parallel processing on multiple cores {#parallel-processing-on-multiple-cores}

Large queries are parallelized naturally, taking all the necessary resources available on the current server.

## Distributed Processing on Multiple Servers {#distributed-processing-on-multiple-servers}
## Distributed processing on multiple servers {#distributed-processing-on-multiple-servers}

Almost none of the columnar DBMSs mentioned above have support for distributed query processing.

In ClickHouse, data can reside on different shards. Each shard can be a group of replicas used for fault tolerance. All shards are used to run a query in parallel, transparently for the user.

## SQL Support {#sql-support}
## SQL support {#sql-support}

ClickHouse supports [SQL language](/sql-reference/) that is mostly compatible with the ANSI SQL standard.

Supported queries include [GROUP BY](../sql-reference/statements/select/group-by.md), [ORDER BY](../sql-reference/statements/select/order-by.md), subqueries in [FROM](../sql-reference/statements/select/from.md), [JOIN](../sql-reference/statements/select/join.md) clause, [IN](../sql-reference/operators/in.md) operator, [window functions](../sql-reference/window-functions/index.md) and scalar subqueries.

Correlated (dependent) subqueries are not supported at the time of writing but might become available in the future.

## Vector Computation Engine {#vector-engine}
## Vector computation engine {#vector-engine}

Data is not only stored by columns but is processed by vectors (parts of columns), which allows achieving high CPU efficiency.

## Real-Time Data Inserts {#real-time-data-updates}
## Real-time data inserts {#real-time-data-updates}

ClickHouse supports tables with a primary key. To quickly perform queries on the range of the primary key, the data is sorted incrementally using the merge tree. Due to this, data can continually be added to the table. No locks are taken when new data is ingested.

## Primary Indexes {#primary-index}
## Primary indexes {#primary-index}

Having data physically sorted by primary key makes it possible to extract data based on specific values or value ranges with low latency in less than a few dozen milliseconds.

## Secondary Indexes {#secondary-indexes}
## Secondary indexes {#secondary-indexes}

Unlike other database management systems, secondary indexes in ClickHouse do not point to specific rows or row ranges. Instead, they allow the database to know in advance that all rows in some data parts would not match the query filtering conditions and do not read them at all, thus they are called [data skipping indexes](../engines/table-engines/mergetree-family/mergetree.md#table_engine-mergetree-data_skipping-indexes).

## Suitable for Online Queries {#suitable-for-online-queries}
## Suitable for online queries {#suitable-for-online-queries}

Most OLAP database management systems do not aim for online queries with sub-second latencies. In alternative systems, report building time of tens of seconds or even minutes is often considered acceptable. Sometimes it takes even more time, which forces systems to prepare reports offline (in advance or by responding with "come back later").

In ClickHouse "low latency" means that queries can be processed without delay and without trying to prepare an answer in advance, right at the same moment as the user interface page is loading. In other words, online.

## Support for Approximated Calculations {#support-for-approximated-calculations}
## Support for approximated calculations {#support-for-approximated-calculations}

ClickHouse provides various ways to trade accuracy for performance:

1. Aggregate functions for approximated calculation of the number of distinct values, medians, and quantiles.
2. Running a query based on a part ([SAMPLE](../sql-reference/statements/select/sample.md)) of data and getting an approximated result. In this case, proportionally less data is retrieved from the disk.
3. Running an aggregation for a limited number of random keys, instead of for all keys. Under certain conditions for key distribution in the data, this provides a reasonably accurate result while using fewer resources.

## Adaptive Join Algorithm {#adaptive-join-algorithm}
## Adaptive join algorithm {#adaptive-join-algorithm}

ClickHouse adaptively chooses how to [JOIN](../sql-reference/statements/select/join.md) multiple tables, by preferring hash-join algorithm and falling back to the merge-join algorithm if there's more than one large table.

## Data Replication and Data Integrity Support {#data-replication-and-data-integrity-support}
## Data replication and data integrity support {#data-replication-and-data-integrity-support}

ClickHouse uses asynchronous multi-master replication. After being written to any available replica, all the remaining replicas retrieve their copy in the background. The system maintains identical data on different replicas. Recovery after most failures is performed automatically, or semi-automatically in complex cases.

Expand All @@ -91,7 +91,7 @@ For more information, see the section [Data replication](../engines/table-engine

ClickHouse implements user account management using SQL queries and allows for [role-based access control configuration](/guides/sre/user-management/index.md) similar to what can be found in ANSI SQL standard and popular relational database management systems.

## Features that Can Be Considered Disadvantages {#clickhouse-features-that-can-be-considered-disadvantages}
## Features that can be considered disadvantages {#clickhouse-features-that-can-be-considered-disadvantages}

1. No full-fledged transactions.
2. Lack of ability to modify or delete already inserted data with a high rate and low latency. There are batch deletes and updates available to clean up or modify data, for example, to comply with [GDPR](https://gdpr-info.eu).
Expand Down
6 changes: 3 additions & 3 deletions docs/about-us/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@ keywords: ['history','development','Metrica']
title: 'ClickHouse History'
---

# ClickHouse History {#clickhouse-history}
# ClickHouse history {#clickhouse-history}

ClickHouse was initially developed to power [Yandex.Metrica](https://metrica.yandex.com/), [the second largest web analytics platform in the world](http://w3techs.com/technologies/overview/traffic_analysis/all), and continues to be its core component. With more than 13 trillion records in the database and more than 20 billion events daily, ClickHouse allows generating custom reports on the fly directly from non-aggregated data. This article briefly covers the goals of ClickHouse in the early stages of its development.

Yandex.Metrica builds customized reports on the fly based on hits and sessions, with arbitrary segments defined by the user. Doing so often requires building complex aggregates, such as the number of unique users, with new data for building reports arriving in real-time.

As of April 2014, Yandex.Metrica was tracking about 12 billion events (page views and clicks) daily. All these events needed to be stored, in order to build custom reports. A single query may have required scanning millions of rows within a few hundred milliseconds, or hundreds of millions of rows in just a few seconds.

## Usage in Yandex.Metrica and Other Yandex Services {#usage-in-yandex-metrica-and-other-yandex-services}
## Usage in Yandex.Metrica and other Yandex services {#usage-in-yandex-metrica-and-other-yandex-services}

ClickHouse serves multiple purposes in Yandex.Metrica.
Its main task is to build reports in online mode using non-aggregated data. It uses a cluster of 374 servers, which store over 20.3 trillion rows in the database. The volume of compressed data is about 2 PB, without accounting for duplicates and replicas. The volume of uncompressed data (in TSV format) would be approximately 17 PB.
Expand All @@ -30,7 +30,7 @@ ClickHouse also plays a key role in the following processes:

Nowadays, there are a multiple dozen ClickHouse installations in other Yandex services and departments: search verticals, e-commerce, advertisement, business analytics, mobile development, personal services, and others.

## Aggregated and Non-aggregated Data {#aggregated-and-non-aggregated-data}
## Aggregated and non-aggregated data {#aggregated-and-non-aggregated-data}

There is a widespread opinion that to calculate statistics effectively, you must aggregate data since this reduces the volume of data.

Expand Down
16 changes: 8 additions & 8 deletions docs/about-us/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ description: 'Landing page for About ClickHouse'
In this section of the docs you'll find information about ClickHouse. Refer to
the table of contents below for a list of pages in this section of the docs.

| Page | Description |
|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [What is ClickHouse](/about-clickhouse) | Introduces ClickHouse's core features, architecture, and uses, providing a concise overview for new users. |
| [Adopters](/about-us/adopters) | A list of companies using ClickHouse and their success stories, assembled from public sources |
| [Support](/about-us/support) | An introduction to ClickHouse Cloud Support Services and their mission. |
| [Beta Features and Experimental](/beta-and-experimental-features) | Learn about how ClickHouse uses "Beta" and "Experimental" labels to distinguish between officially supported and early-stage, unsupported features due to varied development speeds from community contributions. |
| [Cloud Service](/about-us/cloud) | Discover ClickHouse Cloud - a fully managed service that allows users to spin up open-source ClickHouse databases and offers benefits like fast time to value, seamless scaling, and serverless operations. |
| [ClickHouse History](/about-us/history) | Learn more about the history of ClickHouse. |
| Page | Description |
|----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [What is ClickHouse](/about-clickhouse) | Introduces ClickHouse's core features, architecture, and uses, providing a concise overview for new users. |
| [Adopters](/about-us/adopters) | A list of companies using ClickHouse and their success stories, assembled from public sources |
| [Support](/about-us/support) | An introduction to ClickHouse Cloud support services and their mission. |
| [Beta features and experimental features](/beta-and-experimental-features) | Learn about how ClickHouse uses "Beta" and "Experimental" labels to distinguish between officially supported and early-stage, unsupported features due to varied development speeds from community contributions. |
| [Cloud service](/about-us/cloud) | Discover ClickHouse Cloud - a fully managed service that allows users to spin up open-source ClickHouse databases and offers benefits like fast time to value, seamless scaling, and serverless operations. |
| [ClickHouse history](/about-us/history) | Learn more about the history of ClickHouse. |
4 changes: 2 additions & 2 deletions docs/about-us/support.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
slug: /about-us/support
sidebar_label: 'Support'
title: 'ClickHouse Cloud Support Services'
title: 'ClickHouse Cloud support services'
sidebar_position: 30
description: 'Information on ClickHouse Cloud support services'
---

# ClickHouse Cloud Support Services
# ClickHouse Cloud support services

ClickHouse provides Support Services for our ClickHouse Cloud users and customers. Our objective is a Support Services team that represents the ClickHouse product – unparalleled performance, ease of use, and exceptionally fast, high-quality results. For details, [visit our ClickHouse Support Program](https://clickhouse.com/support/program/) page.

Expand Down
Loading