Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
1 change: 1 addition & 0 deletions docs/_placeholders/api/_invitations-api-reference.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_label: Invitations
title: Invitations
doc_type: 'reference'
---

## List all invitations {#list-all-invitations}
Expand Down
1 change: 1 addition & 0 deletions docs/_placeholders/api/_keys-api-reference.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_label: Keys
title: Keys
doc_type: 'reference'
---

## Get list of all keys {#get-list-of-all-keys}
Expand Down
1 change: 1 addition & 0 deletions docs/_placeholders/api/_members-api-reference.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_label: Members
title: Members
doc_type: 'reference'
---

## List organization members {#list-organization-members}
Expand Down
1 change: 1 addition & 0 deletions docs/_placeholders/api/_organizations-api-reference.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_label: Organizations
title: Organizations
doc_type: 'reference'
---

## Get organization details {#get-organization-details}
Expand Down
1 change: 1 addition & 0 deletions docs/_placeholders/api/_services-api-reference.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
sidebar_label: Services
title: Services
doc_type: 'landing-page'
---

## List of organization services {#list-of-organization-services}
Expand Down
1 change: 1 addition & 0 deletions docs/_placeholders/changelog/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ slug: /whats-new/changelog/
sidebar_position: 2
sidebar_label: '2025'
title: '2025 Changelog'
doc_type: 'changelog'
---

22 changes: 0 additions & 22 deletions docs/_snippets/_tabs.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/about-us/about-faq-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'FAQ'
slug: /about-us/faq
description: 'Landing page'
doc_type: 'landing-page'
---

| FAQ |
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/adopters.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Adopters'
title: 'ClickHouse Adopters'
sidebar_position: 60
description: 'A list of companies using ClickHouse and their success stories'
doc_type: 'reference'
---

The following list of companies using ClickHouse and their success stories is assembled from public sources, thus might differ from current reality. We'd appreciate it if you share the story of adopting ClickHouse in your company and [add it to the list](https://github.com/ClickHouse/clickhouse-docs/blob/main/docs/about-us/adopters.md), but please make sure you won't have any NDA issues by doing so. Providing updates with publications from other companies is also useful.
Expand Down
115 changes: 115 additions & 0 deletions docs/about-us/beta-and-experimental-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Beta Features and Experimental'
title: 'Beta and Experimental Features'
description: 'ClickHouse has beta and experimental features. This documentation page discusses definition.'
slug: /beta-and-experimental-features
doc_type: 'reference'
---

Because ClickHouse is open-source, it receives many contributions not only from ClickHouse employees but also from the community. These contributions are often developed at different speeds; certain features may require a lengthy prototyping phase or more time for sufficient community feedback and iteration to be considered generally available (GA).
Expand Down Expand Up @@ -44,4 +45,118 @@ Please note: no additional experimental features are allowed to be enabled in Cl
-->

<!--AUTOGENERATED_START-->
## Beta settings {#beta-settings}

| Name | Default |
|------|--------|
| [geotoh3_argument_order](/operations/settings/settings#geotoh3_argument_order) | `lat_lon` |
| [enable_lightweight_update](/operations/settings/settings#enable_lightweight_update) | `1` |
| [allow_experimental_correlated_subqueries](/operations/settings/settings#allow_experimental_correlated_subqueries) | `1` |
| [allow_experimental_parallel_reading_from_replicas](/operations/settings/settings#allow_experimental_parallel_reading_from_replicas) | `0` |
| [parallel_replicas_mode](/operations/settings/settings#parallel_replicas_mode) | `read_tasks` |
| [parallel_replicas_count](/operations/settings/settings#parallel_replicas_count) | `0` |
| [parallel_replica_offset](/operations/settings/settings#parallel_replica_offset) | `0` |
| [parallel_replicas_custom_key](/operations/settings/settings#parallel_replicas_custom_key) | `` |
| [parallel_replicas_custom_key_range_lower](/operations/settings/settings#parallel_replicas_custom_key_range_lower) | `0` |
| [parallel_replicas_custom_key_range_upper](/operations/settings/settings#parallel_replicas_custom_key_range_upper) | `0` |
| [cluster_for_parallel_replicas](/operations/settings/settings#cluster_for_parallel_replicas) | `` |
| [parallel_replicas_allow_in_with_subquery](/operations/settings/settings#parallel_replicas_allow_in_with_subquery) | `1` |
| [parallel_replicas_for_non_replicated_merge_tree](/operations/settings/settings#parallel_replicas_for_non_replicated_merge_tree) | `0` |
| [parallel_replicas_min_number_of_rows_per_replica](/operations/settings/settings#parallel_replicas_min_number_of_rows_per_replica) | `0` |
| [parallel_replicas_prefer_local_join](/operations/settings/settings#parallel_replicas_prefer_local_join) | `1` |
| [parallel_replicas_mark_segment_size](/operations/settings/settings#parallel_replicas_mark_segment_size) | `0` |
| [parallel_replicas_local_plan](/operations/settings/settings#parallel_replicas_local_plan) | `1` |
| [parallel_replicas_index_analysis_only_on_coordinator](/operations/settings/settings#parallel_replicas_index_analysis_only_on_coordinator) | `1` |
| [parallel_replicas_support_projection](/operations/settings/settings#parallel_replicas_support_projection) | `1` |
| [parallel_replicas_only_with_analyzer](/operations/settings/settings#parallel_replicas_only_with_analyzer) | `1` |
| [parallel_replicas_insert_select_local_pipeline](/operations/settings/settings#parallel_replicas_insert_select_local_pipeline) | `1` |
| [parallel_replicas_connect_timeout_ms](/operations/settings/settings#parallel_replicas_connect_timeout_ms) | `300` |
| [allow_experimental_database_iceberg](/operations/settings/settings#allow_experimental_database_iceberg) | `0` |
| [allow_experimental_database_unity_catalog](/operations/settings/settings#allow_experimental_database_unity_catalog) | `0` |
| [allow_experimental_database_glue_catalog](/operations/settings/settings#allow_experimental_database_glue_catalog) | `0` |
| [session_timezone](/operations/settings/settings#session_timezone) | `` |
| [low_priority_query_wait_time_ms](/operations/settings/settings#low_priority_query_wait_time_ms) | `1000` |
| [allow_experimental_delta_kernel_rs](/operations/settings/settings#allow_experimental_delta_kernel_rs) | `1` |


## Experimental settings {#experimental-settings}

| Name | Default |
|------|--------|
| [allow_experimental_time_time64_type](/operations/settings/settings#allow_experimental_time_time64_type) | `0` |
| [allow_experimental_kafka_offsets_storage_in_keeper](/operations/settings/settings#allow_experimental_kafka_offsets_storage_in_keeper) | `0` |
| [allow_experimental_materialized_postgresql_table](/operations/settings/settings#allow_experimental_materialized_postgresql_table) | `0` |
| [allow_experimental_funnel_functions](/operations/settings/settings#allow_experimental_funnel_functions) | `0` |
| [allow_experimental_nlp_functions](/operations/settings/settings#allow_experimental_nlp_functions) | `0` |
| [allow_experimental_hash_functions](/operations/settings/settings#allow_experimental_hash_functions) | `0` |
| [allow_experimental_object_type](/operations/settings/settings#allow_experimental_object_type) | `0` |
| [allow_experimental_time_series_table](/operations/settings/settings#allow_experimental_time_series_table) | `0` |
| [allow_experimental_codecs](/operations/settings/settings#allow_experimental_codecs) | `0` |
| [throw_on_unsupported_query_inside_transaction](/operations/settings/settings#throw_on_unsupported_query_inside_transaction) | `1` |
| [wait_changes_become_visible_after_commit_mode](/operations/settings/settings#wait_changes_become_visible_after_commit_mode) | `wait_unknown` |
| [implicit_transaction](/operations/settings/settings#implicit_transaction) | `0` |
| [grace_hash_join_initial_buckets](/operations/settings/settings#grace_hash_join_initial_buckets) | `1` |
| [grace_hash_join_max_buckets](/operations/settings/settings#grace_hash_join_max_buckets) | `1024` |
| [join_to_sort_minimum_perkey_rows](/operations/settings/settings#join_to_sort_minimum_perkey_rows) | `40` |
| [join_to_sort_maximum_table_rows](/operations/settings/settings#join_to_sort_maximum_table_rows) | `10000` |
| [allow_experimental_join_right_table_sorting](/operations/settings/settings#allow_experimental_join_right_table_sorting) | `0` |
| [allow_statistics_optimize](/operations/settings/settings#allow_statistics_optimize) | `0` |
| [allow_experimental_statistics](/operations/settings/settings#allow_experimental_statistics) | `0` |
| [allow_experimental_full_text_index](/operations/settings/settings#allow_experimental_full_text_index) | `0` |
| [allow_experimental_live_view](/operations/settings/settings#allow_experimental_live_view) | `0` |
| [live_view_heartbeat_interval](/operations/settings/settings#live_view_heartbeat_interval) | `15` |
| [max_live_view_insert_blocks_before_refresh](/operations/settings/settings#max_live_view_insert_blocks_before_refresh) | `64` |
| [allow_experimental_window_view](/operations/settings/settings#allow_experimental_window_view) | `0` |
| [window_view_clean_interval](/operations/settings/settings#window_view_clean_interval) | `60` |
| [window_view_heartbeat_interval](/operations/settings/settings#window_view_heartbeat_interval) | `15` |
| [wait_for_window_view_fire_signal_timeout](/operations/settings/settings#wait_for_window_view_fire_signal_timeout) | `10` |
| [stop_refreshable_materialized_views_on_startup](/operations/settings/settings#stop_refreshable_materialized_views_on_startup) | `0` |
| [allow_experimental_database_materialized_postgresql](/operations/settings/settings#allow_experimental_database_materialized_postgresql) | `0` |
| [allow_experimental_query_deduplication](/operations/settings/settings#allow_experimental_query_deduplication) | `0` |
| [allow_experimental_database_hms_catalog](/operations/settings/settings#allow_experimental_database_hms_catalog) | `0` |
| [allow_experimental_kusto_dialect](/operations/settings/settings#allow_experimental_kusto_dialect) | `0` |
| [allow_experimental_prql_dialect](/operations/settings/settings#allow_experimental_prql_dialect) | `0` |
| [enable_adaptive_memory_spill_scheduler](/operations/settings/settings#enable_adaptive_memory_spill_scheduler) | `0` |
| [allow_experimental_insert_into_iceberg](/operations/settings/settings#allow_experimental_insert_into_iceberg) | `0` |
| [allow_experimental_iceberg_compaction](/operations/settings/settings#allow_experimental_iceberg_compaction) | `0` |
| [write_full_path_in_iceberg_metadata](/operations/settings/settings#write_full_path_in_iceberg_metadata) | `0` |
| [iceberg_metadata_compression_method](/operations/settings/settings#iceberg_metadata_compression_method) | `` |
| [make_distributed_plan](/operations/settings/settings#make_distributed_plan) | `0` |
| [distributed_plan_execute_locally](/operations/settings/settings#distributed_plan_execute_locally) | `0` |
| [distributed_plan_default_shuffle_join_bucket_count](/operations/settings/settings#distributed_plan_default_shuffle_join_bucket_count) | `8` |
| [distributed_plan_default_reader_bucket_count](/operations/settings/settings#distributed_plan_default_reader_bucket_count) | `8` |
| [distributed_plan_force_exchange_kind](/operations/settings/settings#distributed_plan_force_exchange_kind) | `` |
| [distributed_plan_max_rows_to_broadcast](/operations/settings/settings#distributed_plan_max_rows_to_broadcast) | `20000` |
| [allow_experimental_ytsaurus_table_engine](/operations/settings/settings#allow_experimental_ytsaurus_table_engine) | `0` |
| [allow_experimental_ytsaurus_table_function](/operations/settings/settings#allow_experimental_ytsaurus_table_function) | `0` |
| [allow_experimental_ytsaurus_dictionary_source](/operations/settings/settings#allow_experimental_ytsaurus_dictionary_source) | `0` |
| [distributed_plan_force_shuffle_aggregation](/operations/settings/settings#distributed_plan_force_shuffle_aggregation) | `0` |
| [allow_experimental_time_series_aggregate_functions](/operations/settings/settings#allow_experimental_time_series_aggregate_functions) | `0` |
| [promql_database](/operations/settings/settings#promql_database) | `` |
| [promql_table](/operations/settings/settings#promql_table) | `` |
| [evaluation_time](/operations/settings/settings#evaluation_time) | `auto` |
| [allow_experimental_replacing_merge_with_cleanup](/operations/settings/merge-tree-settings#allow_experimental_replacing_merge_with_cleanup) | `0` |
| [allow_experimental_reverse_key](/operations/settings/merge-tree-settings#allow_experimental_reverse_key) | `0` |
| [allow_remote_fs_zero_copy_replication](/operations/settings/merge-tree-settings#allow_remote_fs_zero_copy_replication) | `0` |
| [enable_replacing_merge_with_cleanup_for_min_age_to_force_merge](/operations/settings/merge-tree-settings#enable_replacing_merge_with_cleanup_for_min_age_to_force_merge) | `0` |
| [force_read_through_cache_for_merges](/operations/settings/merge-tree-settings#force_read_through_cache_for_merges) | `0` |
| [merge_selector_algorithm](/operations/settings/merge-tree-settings#merge_selector_algorithm) | `Simple` |
| [notify_newest_block_number](/operations/settings/merge-tree-settings#notify_newest_block_number) | `0` |
| [part_moves_between_shards_delay_seconds](/operations/settings/merge-tree-settings#part_moves_between_shards_delay_seconds) | `30` |
| [part_moves_between_shards_enable](/operations/settings/merge-tree-settings#part_moves_between_shards_enable) | `0` |
| [remote_fs_zero_copy_path_compatible_mode](/operations/settings/merge-tree-settings#remote_fs_zero_copy_path_compatible_mode) | `0` |
| [remote_fs_zero_copy_zookeeper_path](/operations/settings/merge-tree-settings#remote_fs_zero_copy_zookeeper_path) | `/clickhouse/zero_copy` |
| [remove_rolled_back_parts_immediately](/operations/settings/merge-tree-settings#remove_rolled_back_parts_immediately) | `1` |
| [shared_merge_tree_enable_coordinated_merges](/operations/settings/merge-tree-settings#shared_merge_tree_enable_coordinated_merges) | `0` |
| [shared_merge_tree_enable_keeper_parts_extra_data](/operations/settings/merge-tree-settings#shared_merge_tree_enable_keeper_parts_extra_data) | `0` |
| [shared_merge_tree_merge_coordinator_election_check_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_election_check_period_ms) | `30000` |
| [shared_merge_tree_merge_coordinator_factor](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_factor) | `2` |
| [shared_merge_tree_merge_coordinator_fetch_fresh_metadata_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_fetch_fresh_metadata_period_ms) | `10000` |
| [shared_merge_tree_merge_coordinator_max_merge_request_size](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_max_merge_request_size) | `20` |
| [shared_merge_tree_merge_coordinator_max_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_max_period_ms) | `10000` |
| [shared_merge_tree_merge_coordinator_merges_prepare_count](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_merges_prepare_count) | `100` |
| [shared_merge_tree_merge_coordinator_min_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_min_period_ms) | `1` |
| [shared_merge_tree_merge_worker_fast_timeout_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_worker_fast_timeout_ms) | `100` |
| [shared_merge_tree_merge_worker_regular_timeout_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_worker_regular_timeout_ms) | `10000` |
| [shared_merge_tree_virtual_parts_discovery_batch](/operations/settings/merge-tree-settings#shared_merge_tree_virtual_parts_discovery_batch) | `1` |
<!--AUTOGENERATED_END-->
1 change: 1 addition & 0 deletions docs/about-us/cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Cloud Service'
sidebar_position: 10
description: 'ClickHouse Cloud'
title: 'ClickHouse Cloud'
doc_type: 'reference'
---

# ClickHouse Cloud
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/distinctive-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ 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']
doc_type: 'guide'
---

# Distinctive features of ClickHouse
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sidebar_position: 40
description: 'History of ClickHouse development'
keywords: ['history','development','Metrica']
title: 'ClickHouse History'
doc_type: 'reference'
---

# ClickHouse history {#clickhouse-history}
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
slug: /about
title: 'About ClickHouse'
description: 'Landing page for About ClickHouse'
doc_type: 'landing-page'
---

# About ClickHouse
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ slug: /about-clickhouse
sidebar_label: 'What is ClickHouse?'
title: 'What is ClickHouse?'
description: 'Page describing what ClickHouse is'
doc_type: 'guide'
---

import Content from '@site/docs/intro.md';
Expand Down
1 change: 1 addition & 0 deletions docs/about-us/support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: 'Support'
title: 'ClickHouse Cloud support services'
sidebar_position: 30
description: 'Information on ClickHouse Cloud support services'
doc_type: 'reference'
---

# ClickHouse Cloud support services
Expand Down
1 change: 1 addition & 0 deletions docs/best-practices/avoid_mutations.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sidebar_label: 'Avoid mutations'
title: 'Avoid mutations'
description: 'Page describing why to avoid mutations in ClickHouse'
keywords: ['mutations']
doc_type: 'guide'
---

import Content from '@site/docs/best-practices/_snippets/_avoid_mutations.md';
Expand Down
1 change: 1 addition & 0 deletions docs/best-practices/avoid_optimize_final.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ title: 'Avoid OPTIMIZE FINAL'
description: 'Page describing why you should avoid the OPTIMIZE FINAL clause in ClickHouse'
keywords: ['avoid OPTIMIZE FINAL', 'background merges']
hide_title: true
doc_type: 'guide'
---

# Avoid `OPTIMIZE FINAL`
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 @@ -6,6 +6,7 @@ title: 'Choosing a Primary Key'
description: 'Page describing how to choose a primary key in ClickHouse'
keywords: ['primary key']
show_related_blogs: true
doc_type: 'guide'
---

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'
doc_type: 'landing-page'
---

import TableOfContents from '@site/docs/best-practices/_snippets/_table_of_contents.md';
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 @@ -6,6 +6,7 @@ title: 'Use JSON where appropriate'
description: 'Page describing when to use JSON'
keywords: ['JSON']
show_related_blogs: true
doc_type: 'reference'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
doc_type: 'reference'
doc_type: 'how-to'

---

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
1 change: 1 addition & 0 deletions docs/best-practices/minimize_optimize_joins.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ title: 'Minimize and optimize JOINs'
description: 'Page describing best practices for JOINs'
keywords: ['JOIN', 'Parallel Hash JOIN']
show_related_blogs: true
doc_type: 'guide'
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/best-practices/partitioning_keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sidebar_label: 'Choosing a Partitioning Key'
title: 'Choosing a Partitioning Key'
description: 'Page describing how to choose a partitioning key'
keywords: ['partitioning key']
doc_type: 'reference'
---

import Image from '@theme/IdealImage';
Expand Down
1 change: 1 addition & 0 deletions docs/best-practices/select_data_type.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ sidebar_label: 'Selecting data Types'
title: 'Selecting data Types'
description: 'Page describing how to choose data types in ClickHouse'
keywords: ['data types']
doc_type: 'reference'
---

import NullableColumns from '@site/docs/best-practices/_snippets/_avoid_nullable_columns.md';
Expand Down
1 change: 1 addition & 0 deletions docs/best-practices/selecting_an_insert_strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ title: 'Selecting an insert strategy'
description: 'Page describing how to choose an insert strategy in ClickHouse'
keywords: ['INSERT', 'asynchronous inserts', 'compression', 'batch inserts']
show_related_blogs: true
doc_type: 'guide'
---

import Image from '@theme/IdealImage';
Expand Down
Loading