Skip to content

Related blog component #3768

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

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
16 changes: 16 additions & 0 deletions contribute/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -376,3 +376,19 @@ logic might fail.
1. Keep version strings in consistent formats for predictable results.

2. Use simplified version parameters in URLs (e.g., `v08` instead of `v0.8.x`).

## Related blog component

Each page has a "Related blogs" component which displays recent blogs which are
related to the keywords or title of the document.

If you would like to hide it from a page, add the following property to the
front matter:

```yaml
---
show_related_blogs: false
---
```

This will hide it from the page.
1 change: 1 addition & 0 deletions docs/about-us/distinctive-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Why is ClickHouse unique?'
sidebar_position: 50
description: 'Understand what makes ClickHouse stand apart from other database management systems'
title: 'Distinctive Features of ClickHouse'
keywords: ['compression', 'secondary-indexes','column-oriented']
---

# Distinctive Features of ClickHouse
Expand Down
5 changes: 3 additions & 2 deletions docs/best-practices/avoid_mutations.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
slug: /best-practices/avoid-mutations
sidebar_position: 10
sidebar_label: 'Avoid Mutations'
title: 'Avoid Mutations'
sidebar_label: 'Avoid mutations'
title: 'Avoid mutations'
description: 'Page describing why to avoid mutations in ClickHouse'
keywords: ['mutations']
---

import Content from '@site/docs/best-practices/_snippets/_avoid_mutations.md';
Expand Down
5 changes: 3 additions & 2 deletions docs/best-practices/avoid_optimize_final.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
slug: /best-practices/avoid-optimize-final
sidebar_position: 10
sidebar_label: 'Avoid Optimize Final'
title: 'Avoid Optimize Final'
description: 'Page describing why to avoid Optimize Final in ClickHouse'
title: 'Avoid OPTIMIZE FINAL'

Check notice on line 5 in docs/best-practices/avoid_optimize_final.md

View workflow job for this annotation

GitHub Actions / vale

ClickHouse.Uppercase

Suggestion: Instead of uppercase for 'FINAL', use lowercase or backticks (`) if possible. Otherwise, ask a Technical Writer to add this word or acronym to the rule's exception list.
description: 'Page describing why you should avoid the OPTIMIZE FINAL clause in ClickHouse'
keywords: ['avoid OPTIMIZE FINAL', 'background merges']
---

import Content from '@site/docs/best-practices/_snippets/_avoid_optimize_final.md';
Expand Down
1 change: 1 addition & 0 deletions docs/best-practices/choosing_a_primary_key.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_position: 10
sidebar_label: 'Choosing a Primary Key'
title: 'Choosing a Primary Key'
description: 'Page describing how to choose a primary key in ClickHouse'
keywords: ['primary key']
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/best-practices/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ keywords: ['Cloud', 'Primary key', 'Ordering key', 'Materialized Views', 'Best P
title: 'Overview'
hide_title: true
description: 'Landing page for Best Practices section in ClickHouse'
show_related_blogs: false
---

# Best Practices in ClickHouse {#best-practices-in-clickhouse}
Expand Down
1 change: 1 addition & 0 deletions docs/best-practices/json_type.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_position: 10
sidebar_label: 'Using JSON'
title: 'Use JSON where appropriate'
description: 'Page describing when to use JSON'
keywords: ['JSON']
---

ClickHouse now offers a native JSON column type designed for semi-structured and dynamic data. It's important to clarify that **this is a column type, not a data format**—you can insert JSON into ClickHouse as a string or via supported formats like [JSONEachRow](/docs/interfaces/formats/JSONEachRow), but that does not imply using the JSON column type. Users should only use the JSON type when the structure of their data is dynamic, not when they simply happen to store JSON.
Expand Down
5 changes: 2 additions & 3 deletions docs/best-practices/minimize_optimize_joins.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@
slug: /best-practices/minimize-optimize-joins
sidebar_position: 10
sidebar_label: 'Minimize and Optimize JOINs'
title: 'Minimize and Optimize JOINs'
title: 'Minimize and optimize JOINs'
description: 'Page describing best practices for JOINs'
keywords: ['joins', 'join algorithm']
---

import Image from '@theme/IdealImage';
import joins from '@site/static/images/bestpractices/joins-speed-memory.png';



ClickHouse supports a wide variety of JOIN types and algorithms, and JOIN performance has improved significantly in recent releases. However, JOINs are inherently more expensive than querying from a single, denormalized table. Denormalization shifts computational work from query time to insert or pre-processing time, which often results in significantly lower latency at runtime. For real-time or latency-sensitive analytical queries, **denormalization is strongly recommended**.

In general, denormalize when:
Expand Down
1 change: 1 addition & 0 deletions docs/best-practices/partionning_keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_position: 10
sidebar_label: 'Choosing a Partitioning Key'
title: 'Choosing a Partitioning Key'
description: 'Page describing how to choose a partitioning key'
keywords: ['partitioning key']
---

import Image from '@theme/IdealImage';
Expand Down
5 changes: 3 additions & 2 deletions docs/best-practices/select_data_type.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
slug: /best-practices/select-data-types
sidebar_position: 10
sidebar_label: 'Select Data Types'
title: 'Select Data Types'
sidebar_label: 'Selecting data Types'
title: 'Selecting data Types'
description: 'Page describing how to choose data types in ClickHouse'
keywords: ['data types']
---

import NullableColumns from '@site/docs/best-practices/_snippets/_avoid_nullable_columns.md';
Expand Down
5 changes: 3 additions & 2 deletions docs/best-practices/selecting_an_insert_strategy.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
---
slug: /best-practices/selecting-an-insert-strategy
sidebar_position: 10
sidebar_label: 'Selecting an Insert Strategy'
title: 'Selecting an Insert Strategy'
sidebar_label: 'Selecting an insert strategy'
title: 'Selecting an insert strategy'
description: 'Page describing how to choose an insert strategy in ClickHouse'
keywords: ['INSERT', 'asynchronous inserts', 'compression', 'batch inserts']
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/best-practices/use_materialized_views.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_position: 10
sidebar_label: 'Use Materialized Views'
title: 'Use Materialized Views'
description: 'Page describing Materialized Views'
keywords: ['materialized views', 'medallion architecture']
---

import Image from '@theme/IdealImage';
Expand Down
3 changes: 2 additions & 1 deletion docs/best-practices/using_data_skipping_indices.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
slug: /best-practices/use-data-skipping-indices-where-appropriate
sidebar_position: 10
sidebar_label: 'Data Skipping Indices'
title: 'Use Data Skipping Indices where Appropriate'
title: 'Use data skipping indices where appropriate'
description: 'Page describing how and when to use data skipping indices'
keywords: ['data skipping index', 'skip index']
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ keywords: ['AWS', 'Cloud', 'serverless']
title: 'Overview'
hide_title: true
description: 'Overview page for Cloud'
show_related_blogs: false
---

import Content from '@site/docs/about-us/cloud.md';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/bestpractices/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ keywords: ['Cloud', 'Best Practices', 'Bulk Inserts', 'Asynchronous Inserts', 'A
title: 'Overview'
hide_title: true
description: 'Landing page for Best Practices section in ClickHouse Cloud'
show_related_blogs: false
---

# Best Practices in ClickHouse Cloud {#best-practices-in-clickhouse-cloud}
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/changelogs/changelog-24-10.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: 'v24.10 Changelog for Cloud'
description: 'Fast release changelog for v24.10'
keywords: ['changelog', 'cloud']
sidebar_label: 'v24.10'
show_related_blogs: false
---

Relevant changes for ClickHouse Cloud services based on the v24.10 release.
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/changelogs/changelog-24-12.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: 'v24.12 Changelog for Cloud'
description: 'Fast release changelog for v24.12'
keywords: ['changelog', 'cloud']
sidebar_label: 'v24.12'
show_related_blogs: false
---

Relevant changes for ClickHouse Cloud services based on the v24.12 release.
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/changelogs/changelog-24-5.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: 'v24.5 Changelog for Cloud'
description: 'Fast release changelog for v24.5'
keywords: ['changelog', 'cloud']
sidebar_label: 'v24.5'
show_related_blogs: false
---

# v24.5 Changelog for Cloud
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/changelogs/changelog-24-6.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: 'v24.6 Changelog for Cloud'
description: 'Fast release changelog for v24.6'
keywords: ['changelog', 'cloud']
sidebar_label: 'v24.6'
show_related_blogs: false
---

# v24.6 Changelog for Cloud
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/changelogs/changelog-24-8.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: 'v24.8 Changelog for Cloud'
description: 'Fast release changelog for v24.8'
keywords: ['changelog', 'cloud']
sidebar_label: 'v24.8'
show_related_blogs: false
---

Relevant changes for ClickHouse Cloud services based on the v24.8 release.
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/changelogs/changelog-25_1-25_4.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: 'v25.4 Changelog for Cloud'
description: 'Changelog for v25.4'
keywords: ['changelog', 'cloud']
sidebar_label: 'v25.4'
show_related_blogs: false
---

## Backward Incompatible Changes {#backward-incompatible-changes}
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/changelogs/fast-release-24-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: 'v24.2 Changelog'
description: 'Fast release changelog for v24.2'
keywords: ['changelog']
sidebar_label: 'v24.2'
show_related_blogs: false
---

### ClickHouse release tag: 24.2.2.15987 {#clickhouse-release-tag-242215987}
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/get-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /cloud/get-started
title: 'Get Started'
description: 'Get Started Table Of Contents'
keywords: ['Cloud Quick Start', 'SQL Console', 'Query Insights', 'Query API Endpoints', 'Dashboards', 'Cloud Support']
show_related_blogs: false
---

Welcome to ClickHouse Cloud! Explore the pages below to learn more about what ClickHouse Cloud has to offer.
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'Cloud API'
slug: /cloud/manage/cloud-api
description: 'Landing page for the Cloud API section'
show_related_blogs: false
---

This section contains reference documentation for Cloud API and contains the following pages:
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/backups/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /cloud/manage/backups
title: 'Backups'
description: 'Table of contents page for backups.'
keywords: ['backups', 'configurable backups', 'export backups to own cloud']
show_related_blogs: false
---

| Page | Description |
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/backups/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ slug: /cloud/manage/backups/overview
title: 'Overview'
keywords: ['backups', 'cloud backups', 'restore']
description: 'Provides an overview of backups in ClickHouse Cloud'
show_related_blogs: true
---

import CloudNotSupportedBadge from '@theme/badges/CloudNotSupportedBadge';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/billing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /cloud/manage/billing
title: 'Billing'
description: 'Table of contents page for billing.'
keywords: ['billing', 'payment thresholds', 'trouble shooting', 'marketplace']
show_related_blogs: false
---

This section of the documentation covers topics related to billing, and contains the following pages:
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/billing/marketplace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /cloud/manage/marketplace/
title: 'Market Place'
description: 'Market Place Table of Contents page'
keywords: ['Marketplace Billing', 'AWS', 'GCP']
show_related_blogs: false
---

This section details billing related topics for Marketplace.
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ keywords: ['AWS', 'Cloud', 'serverless', 'management']
title: 'Overview'
hide_title: true
description: 'Overview page for Managing Cloud'
show_related_blogs: false
---

# Managing Cloud
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/manage/jan2025_faq/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: 'Jan 2025 Changes FAQ'
slug: /cloud/manage/jan-2025-faq
description: 'Index page for new pricing FAQ'
keywords: ['new pricing', 'faq']
show_related_blogs: false
---

<!--
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/reference/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /whats-new/cloud
sidebar_label: 'Cloud Changelog'
title: 'Cloud Changelog'
description: 'ClickHouse Cloud changelog providing descriptions of what is new in each ClickHouse Cloud release'
show_related_blogs: false
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/reference/changelogs-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
slug: /cloud/reference/changelogs
title: 'Changelogs'
description: 'Landing page for Cloud changelogs'
show_related_blogs: false
---

| Page | Description |
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/reference/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ keywords: ['Cloud', 'reference', 'architecture', 'SharedMergeTree', 'Compute-Com
title: 'Overview'
hide_title: true
description: 'Landing page for the Cloud reference section'
show_related_blogs: false
---

# Cloud Reference
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/security/cloud-access-management/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
slug: /cloud/security/cloud-access-management
title: 'Cloud Access Management'
description: 'Cloud Access Management Table Of Contents'
show_related_blogs: false
---

| Page | Description |
Expand Down
1 change: 1 addition & 0 deletions docs/cloud/security/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ keywords: ['Cloud', 'Security']
title: 'Overview'
hide_title: true
description: 'Landing page for ClickHouse Cloud Security'
show_related_blogs: false
---

# ClickHouse Cloud Security
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ sidebar_label: 'Glossary'
description: 'This page contains a list of commonly used words and phrases regarding ClickHouse, as well as their definitions.'
title: 'Glossary'
slug: /concepts/glossary
show_related_blogs: false
---

# Glossary
Expand Down
2 changes: 2 additions & 0 deletions docs/concepts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ slug: /concepts
description: 'Landing page for concepts'
pagination_next: null
pagination_prev: null
keywords: ['concepts', 'OLAP', 'fast']
show_related_blogs: false
---

In this section of the docs we'll dive into the concepts around what makes ClickHouse so fast and efficient.
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/olap.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'What is OLAP?'
description: 'OLAP stands for Online Analytical Processing. It is a broad term that can be looked at from two perspectives: technical and business.'
title: 'What is OLAP?'
slug: /concepts/olap
keywords: ['OLAP']
---

# What is OLAP?
Expand Down
1 change: 1 addition & 0 deletions docs/concepts/why-clickhouse-is-so-fast.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Why is ClickHouse so Fast?'
description: 'It was designed to be fast. Query execution performance has always been a top priority during the development process, but other important characteristics like user-friendliness, scalability, and security were also considered so ClickHouse could become a real production system.'
title: 'Why is ClickHouse so fast?'
slug: /concepts/why-clickhouse-is-so-fast
keywords: ['speed', 'fast']
---

# Why is ClickHouse so fast? {#why-clickhouse-is-so-fast}
Expand Down
1 change: 1 addition & 0 deletions docs/deployment-modes.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /deployment-modes
sidebar_label: 'Deployment modes'
description: 'ClickHouse offers four deployment options that all use the same powerful database engine, just packaged differently to suit your specific needs.'
title: 'Deployment modes'
keywords: ['chDB', 'clickhouse-local', 'ClickHouse Cloud']
---

import chServer from '@site/static/images/deployment-modes/ch-server.png';
Expand Down
3 changes: 2 additions & 1 deletion docs/faq/general/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
slug: /faq/general/
sidebar_position: 1
sidebar_label: 'General Questions about ClickHouse'
keywords: ['clickhouse', 'faq', 'questions', 'what is']
keywords: ['faq', 'questions', 'what is']
title: 'General Questions About ClickHouse'
description: 'Index page listing general questions about ClickHouse'
show_related_blogs: false
---

# General Questions About ClickHouse
Expand Down
1 change: 1 addition & 0 deletions docs/faq/general/mapreduce.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: 'Why not use something like MapReduce?'
toc_hidden: true
toc_priority: 110
description: 'This page explains why you would use ClickHouse over MapReduce'
keywords: ['MapReduce']
---

# Why Not Use Something Like MapReduce? {#why-not-use-something-like-mapreduce}
Expand Down
1 change: 1 addition & 0 deletions docs/faq/general/ne-tormozit.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: 'What does “не тормозит” mean?'
toc_hidden: true
toc_priority: 11
description: 'This page explains what "Не тормозит" means'
keywords: ['Yandex']
---

# What Does "Не тормозит" Mean? {#what-does-ne-tormozit-mean}
Expand Down
Loading