Skip to content

Commit 81243e7

Browse files
authored
Merge pull request #3938 from Blargian/fix_vale_errors
Fix header casing -> sentence case
2 parents d6c0fba + bbd6d7e commit 81243e7

File tree

279 files changed

+1907
-1035
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

279 files changed

+1907
-1035
lines changed

contribute/style-guide.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ When using URL parameters to control which version of documentation is displayed
340340
there are conventions to follow for reliable functionality.
341341
Here's how the `?v=v08` parameter relates to the snippet selection:
342342

343-
#### How It Works
343+
#### How it works
344344

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

394394
This will show it on the page, assuming there is a matching blog. If there is no
395395
match then it remains hidden.
396+
397+
## Vale
398+
399+
Vale is a command-line tool that brings code-like linting to prose.
400+
We have a number of rules set up to ensure that our documentation is
401+
consistent in style.
402+
403+
The style rules are located at `/styles/ClickHouse`, and largely based
404+
off of the Google styleset, with some ClickHouse specific adaptions.
405+
If you want to check only a specific rule locally, you
406+
can run:
407+
408+
```bash
409+
vale --filter='.Name == "ClickHouse.Headings"' docs/integrations
410+
```
411+
412+
This will run only the rule named `Headings` on
413+
the `docs/integrations` directory. Specifying a specific markdown
414+
file is also possible.

docs/_snippets/_GCS_authentication_and_bucket.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import Image from '@theme/IdealImage';
1919

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

22-
### Generate an Access key {#generate-an-access-key}
22+
### Generate an access key {#generate-an-access-key}
2323

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

docs/_snippets/_add_superset_detail.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ There are a few tasks to be done before running `docker compose`:
1313
The commands below are to be run from the top level of the GitHub repo, `superset`.
1414
:::
1515

16-
## Official ClickHouse Connect driver {#official-clickhouse-connect-driver}
16+
## Official ClickHouse connect driver {#official-clickhouse-connect-driver}
1717

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

docs/_snippets/_users-and-roles-common.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ Roles are used to define groups of users for certain privileges instead of manag
269269
Verify that only the above two rows are returned, rows with the value `B` in `column1` should be excluded.
270270
:::
271271

272-
## Modifying Users and Roles {#modifying-users-and-roles}
272+
## Modifying users and roles {#modifying-users-and-roles}
273273

274274
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.
275275

docs/about-us/beta-and-experimental-features.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Due to the uncertainty of when features are classified as generally available, w
1414

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

17-
## Beta Features {#beta-features}
17+
## Beta features {#beta-features}
1818

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

2727
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.
2828

29-
## Experimental Features {#experimental-features}
29+
## Experimental features {#experimental-features}
3030

3131
- May never become GA
3232
- May be removed

docs/about-us/distinctive-features.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,81 +7,81 @@ title: 'Distinctive Features of ClickHouse'
77
keywords: ['compression', 'secondary-indexes','column-oriented']
88
---
99

10-
# Distinctive Features of ClickHouse
10+
# Distinctive features of ClickHouse
1111

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

1414
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.
1515

1616
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.
1717

1818
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.
1919

20-
## Data Compression {#data-compression}
20+
## Data compression {#data-compression}
2121

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

2424
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.
2525

26-
## Disk Storage of Data {#disk-storage-of-data}
26+
## Disk storage of data {#disk-storage-of-data}
2727

2828
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.
2929

3030
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.
3131

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

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

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

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

4040
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.
4141

42-
## SQL Support {#sql-support}
42+
## SQL support {#sql-support}
4343

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

4646
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.
4747

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

50-
## Vector Computation Engine {#vector-engine}
50+
## Vector computation engine {#vector-engine}
5151

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

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

5656
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.
5757

58-
## Primary Indexes {#primary-index}
58+
## Primary indexes {#primary-index}
5959

6060
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.
6161

62-
## Secondary Indexes {#secondary-indexes}
62+
## Secondary indexes {#secondary-indexes}
6363

6464
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).
6565

66-
## Suitable for Online Queries {#suitable-for-online-queries}
66+
## Suitable for online queries {#suitable-for-online-queries}
6767

6868
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").
6969

7070
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.
7171

72-
## Support for Approximated Calculations {#support-for-approximated-calculations}
72+
## Support for approximated calculations {#support-for-approximated-calculations}
7373

7474
ClickHouse provides various ways to trade accuracy for performance:
7575

7676
1. Aggregate functions for approximated calculation of the number of distinct values, medians, and quantiles.
7777
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.
7878
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.
7979

80-
## Adaptive Join Algorithm {#adaptive-join-algorithm}
80+
## Adaptive join algorithm {#adaptive-join-algorithm}
8181

8282
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.
8383

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

8686
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.
8787

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

9292
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.
9393

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

9696
1. No full-fledged transactions.
9797
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).

docs/about-us/history.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ keywords: ['history','development','Metrica']
77
title: 'ClickHouse History'
88
---
99

10-
# ClickHouse History {#clickhouse-history}
10+
# ClickHouse history {#clickhouse-history}
1111

1212
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.
1313

1414
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.
1515

1616
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.
1717

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

2020
ClickHouse serves multiple purposes in Yandex.Metrica.
2121
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.
@@ -30,7 +30,7 @@ ClickHouse also plays a key role in the following processes:
3030

3131
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.
3232

33-
## Aggregated and Non-aggregated Data {#aggregated-and-non-aggregated-data}
33+
## Aggregated and non-aggregated data {#aggregated-and-non-aggregated-data}
3434

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

docs/about-us/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ description: 'Landing page for About ClickHouse'
99
In this section of the docs you'll find information about ClickHouse. Refer to
1010
the table of contents below for a list of pages in this section of the docs.
1111

12-
| Page | Description |
13-
|------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
14-
| [What is ClickHouse](/about-clickhouse) | Introduces ClickHouse's core features, architecture, and uses, providing a concise overview for new users. |
15-
| [Adopters](/about-us/adopters) | A list of companies using ClickHouse and their success stories, assembled from public sources |
16-
| [Support](/about-us/support) | An introduction to ClickHouse Cloud Support Services and their mission. |
17-
| [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. |
18-
| [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. |
19-
| [ClickHouse History](/about-us/history) | Learn more about the history of ClickHouse. |
12+
| Page | Description |
13+
|----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
14+
| [What is ClickHouse](/about-clickhouse) | Introduces ClickHouse's core features, architecture, and uses, providing a concise overview for new users. |
15+
| [Adopters](/about-us/adopters) | A list of companies using ClickHouse and their success stories, assembled from public sources |
16+
| [Support](/about-us/support) | An introduction to ClickHouse Cloud support services and their mission. |
17+
| [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. |
18+
| [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. |
19+
| [ClickHouse history](/about-us/history) | Learn more about the history of ClickHouse. |

docs/about-us/support.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
slug: /about-us/support
33
sidebar_label: 'Support'
4-
title: 'ClickHouse Cloud Support Services'
4+
title: 'ClickHouse Cloud support services'
55
sidebar_position: 30
66
description: 'Information on ClickHouse Cloud support services'
77
---
88

9-
# ClickHouse Cloud Support Services
9+
# ClickHouse Cloud support services
1010

1111
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.
1212

0 commit comments

Comments
 (0)