Skip to content

Commit 66c8ffd

Browse files
committed
Restore beta-and-experimental-features.md from main
1 parent 891dd53 commit 66c8ffd

File tree

1 file changed

+169
-0
lines changed

1 file changed

+169
-0
lines changed
Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: 'Beta Features and Experimental'
4+
title: 'Beta and Experimental Features'
5+
description: 'ClickHouse has beta and experimental features. This documentation page discusses definition.'
6+
slug: /beta-and-experimental-features
7+
doc_type: 'reference'
8+
---
9+
10+
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).
11+
12+
Due to the uncertainty of when features are classified as generally available, we delineate features into two categories: **Beta** and **Experimental**.
13+
14+
**Beta** features are officially supported by the ClickHouse team. **Experimental** features are early prototypes driven by either the ClickHouse team or the community and are not officially supported.
15+
16+
The sections below explicitly describe the properties of **Beta** and **Experimental** features:
17+
18+
## Beta features {#beta-features}
19+
20+
- Under active development to make them generally available (GA)
21+
- Main known issues can be tracked on GitHub
22+
- Functionality may change in the future
23+
- Possibly enabled in ClickHouse Cloud
24+
- The ClickHouse team supports beta features
25+
26+
You can find below the features considered Beta in ClickHouse Cloud and are available for use in your ClickHouse Cloud Services.
27+
28+
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.
29+
30+
## Experimental features {#experimental-features}
31+
32+
- May never become GA
33+
- May be removed
34+
- Can introduce breaking changes
35+
- Functionality may change in the feature
36+
- Need to be deliberately enabled
37+
- The ClickHouse team **does not support** experimental features
38+
- May lack important functionality and documentation
39+
- Cannot be enabled in the cloud
40+
41+
Please note: no additional experimental features are allowed to be enabled in ClickHouse Cloud other than those listed above as Beta.
42+
43+
<!-- The inner content of the tags below are replaced at build time with a table generated from source
44+
Please do not modify or remove the tags
45+
-->
46+
47+
<!--AUTOGENERATED_START-->
48+
## Beta settings {#beta-settings}
49+
50+
| Name | Default |
51+
|------|--------|
52+
| [geotoh3_argument_order](/operations/settings/settings#geotoh3_argument_order) | `lat_lon` |
53+
| [enable_lightweight_update](/operations/settings/settings#enable_lightweight_update) | `1` |
54+
| [allow_experimental_correlated_subqueries](/operations/settings/settings#allow_experimental_correlated_subqueries) | `1` |
55+
| [allow_experimental_parallel_reading_from_replicas](/operations/settings/settings#allow_experimental_parallel_reading_from_replicas) | `0` |
56+
| [parallel_replicas_mode](/operations/settings/settings#parallel_replicas_mode) | `read_tasks` |
57+
| [parallel_replicas_count](/operations/settings/settings#parallel_replicas_count) | `0` |
58+
| [parallel_replica_offset](/operations/settings/settings#parallel_replica_offset) | `0` |
59+
| [parallel_replicas_custom_key](/operations/settings/settings#parallel_replicas_custom_key) | `` |
60+
| [parallel_replicas_custom_key_range_lower](/operations/settings/settings#parallel_replicas_custom_key_range_lower) | `0` |
61+
| [parallel_replicas_custom_key_range_upper](/operations/settings/settings#parallel_replicas_custom_key_range_upper) | `0` |
62+
| [cluster_for_parallel_replicas](/operations/settings/settings#cluster_for_parallel_replicas) | `` |
63+
| [parallel_replicas_allow_in_with_subquery](/operations/settings/settings#parallel_replicas_allow_in_with_subquery) | `1` |
64+
| [parallel_replicas_for_non_replicated_merge_tree](/operations/settings/settings#parallel_replicas_for_non_replicated_merge_tree) | `0` |
65+
| [parallel_replicas_min_number_of_rows_per_replica](/operations/settings/settings#parallel_replicas_min_number_of_rows_per_replica) | `0` |
66+
| [parallel_replicas_prefer_local_join](/operations/settings/settings#parallel_replicas_prefer_local_join) | `1` |
67+
| [parallel_replicas_mark_segment_size](/operations/settings/settings#parallel_replicas_mark_segment_size) | `0` |
68+
| [parallel_replicas_local_plan](/operations/settings/settings#parallel_replicas_local_plan) | `1` |
69+
| [parallel_replicas_index_analysis_only_on_coordinator](/operations/settings/settings#parallel_replicas_index_analysis_only_on_coordinator) | `1` |
70+
| [parallel_replicas_support_projection](/operations/settings/settings#parallel_replicas_support_projection) | `1` |
71+
| [parallel_replicas_only_with_analyzer](/operations/settings/settings#parallel_replicas_only_with_analyzer) | `1` |
72+
| [parallel_replicas_insert_select_local_pipeline](/operations/settings/settings#parallel_replicas_insert_select_local_pipeline) | `1` |
73+
| [parallel_replicas_connect_timeout_ms](/operations/settings/settings#parallel_replicas_connect_timeout_ms) | `300` |
74+
| [allow_experimental_database_iceberg](/operations/settings/settings#allow_experimental_database_iceberg) | `0` |
75+
| [allow_experimental_database_unity_catalog](/operations/settings/settings#allow_experimental_database_unity_catalog) | `0` |
76+
| [allow_experimental_database_glue_catalog](/operations/settings/settings#allow_experimental_database_glue_catalog) | `0` |
77+
| [session_timezone](/operations/settings/settings#session_timezone) | `` |
78+
| [low_priority_query_wait_time_ms](/operations/settings/settings#low_priority_query_wait_time_ms) | `1000` |
79+
| [allow_experimental_delta_kernel_rs](/operations/settings/settings#allow_experimental_delta_kernel_rs) | `1` |
80+
81+
82+
## Experimental settings {#experimental-settings}
83+
84+
| Name | Default |
85+
|------|--------|
86+
| [allow_experimental_replacing_merge_with_cleanup](/operations/settings/merge-tree-settings#allow_experimental_replacing_merge_with_cleanup) | `0` |
87+
| [allow_experimental_reverse_key](/operations/settings/merge-tree-settings#allow_experimental_reverse_key) | `0` |
88+
| [allow_remote_fs_zero_copy_replication](/operations/settings/merge-tree-settings#allow_remote_fs_zero_copy_replication) | `0` |
89+
| [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` |
90+
| [force_read_through_cache_for_merges](/operations/settings/merge-tree-settings#force_read_through_cache_for_merges) | `0` |
91+
| [merge_selector_algorithm](/operations/settings/merge-tree-settings#merge_selector_algorithm) | `Simple` |
92+
| [notify_newest_block_number](/operations/settings/merge-tree-settings#notify_newest_block_number) | `0` |
93+
| [part_moves_between_shards_delay_seconds](/operations/settings/merge-tree-settings#part_moves_between_shards_delay_seconds) | `30` |
94+
| [part_moves_between_shards_enable](/operations/settings/merge-tree-settings#part_moves_between_shards_enable) | `0` |
95+
| [remote_fs_zero_copy_path_compatible_mode](/operations/settings/merge-tree-settings#remote_fs_zero_copy_path_compatible_mode) | `0` |
96+
| [remote_fs_zero_copy_zookeeper_path](/operations/settings/merge-tree-settings#remote_fs_zero_copy_zookeeper_path) | `/clickhouse/zero_copy` |
97+
| [remove_rolled_back_parts_immediately](/operations/settings/merge-tree-settings#remove_rolled_back_parts_immediately) | `1` |
98+
| [shared_merge_tree_activate_coordinated_merges_tasks](/operations/settings/merge-tree-settings#shared_merge_tree_activate_coordinated_merges_tasks) | `0` |
99+
| [shared_merge_tree_enable_coordinated_merges](/operations/settings/merge-tree-settings#shared_merge_tree_enable_coordinated_merges) | `0` |
100+
| [shared_merge_tree_enable_keeper_parts_extra_data](/operations/settings/merge-tree-settings#shared_merge_tree_enable_keeper_parts_extra_data) | `0` |
101+
| [shared_merge_tree_merge_coordinator_election_check_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_election_check_period_ms) | `30000` |
102+
| [shared_merge_tree_merge_coordinator_factor](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_factor) | `1.1` |
103+
| [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` |
104+
| [shared_merge_tree_merge_coordinator_max_merge_request_size](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_max_merge_request_size) | `20` |
105+
| [shared_merge_tree_merge_coordinator_max_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_max_period_ms) | `10000` |
106+
| [shared_merge_tree_merge_coordinator_merges_prepare_count](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_merges_prepare_count) | `100` |
107+
| [shared_merge_tree_merge_coordinator_min_period_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_coordinator_min_period_ms) | `1` |
108+
| [shared_merge_tree_merge_worker_fast_timeout_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_worker_fast_timeout_ms) | `100` |
109+
| [shared_merge_tree_merge_worker_regular_timeout_ms](/operations/settings/merge-tree-settings#shared_merge_tree_merge_worker_regular_timeout_ms) | `10000` |
110+
| [shared_merge_tree_virtual_parts_discovery_batch](/operations/settings/merge-tree-settings#shared_merge_tree_virtual_parts_discovery_batch) | `1` |
111+
| [allow_experimental_time_time64_type](/operations/settings/settings#allow_experimental_time_time64_type) | `0` |
112+
| [allow_experimental_kafka_offsets_storage_in_keeper](/operations/settings/settings#allow_experimental_kafka_offsets_storage_in_keeper) | `0` |
113+
| [allow_experimental_delta_lake_writes](/operations/settings/settings#allow_experimental_delta_lake_writes) | `0` |
114+
| [allow_experimental_materialized_postgresql_table](/operations/settings/settings#allow_experimental_materialized_postgresql_table) | `0` |
115+
| [allow_experimental_funnel_functions](/operations/settings/settings#allow_experimental_funnel_functions) | `0` |
116+
| [allow_experimental_nlp_functions](/operations/settings/settings#allow_experimental_nlp_functions) | `0` |
117+
| [allow_experimental_hash_functions](/operations/settings/settings#allow_experimental_hash_functions) | `0` |
118+
| [allow_experimental_object_type](/operations/settings/settings#allow_experimental_object_type) | `0` |
119+
| [allow_experimental_time_series_table](/operations/settings/settings#allow_experimental_time_series_table) | `0` |
120+
| [allow_experimental_codecs](/operations/settings/settings#allow_experimental_codecs) | `0` |
121+
| [throw_on_unsupported_query_inside_transaction](/operations/settings/settings#throw_on_unsupported_query_inside_transaction) | `1` |
122+
| [wait_changes_become_visible_after_commit_mode](/operations/settings/settings#wait_changes_become_visible_after_commit_mode) | `wait_unknown` |
123+
| [implicit_transaction](/operations/settings/settings#implicit_transaction) | `0` |
124+
| [grace_hash_join_initial_buckets](/operations/settings/settings#grace_hash_join_initial_buckets) | `1` |
125+
| [grace_hash_join_max_buckets](/operations/settings/settings#grace_hash_join_max_buckets) | `1024` |
126+
| [join_to_sort_minimum_perkey_rows](/operations/settings/settings#join_to_sort_minimum_perkey_rows) | `40` |
127+
| [join_to_sort_maximum_table_rows](/operations/settings/settings#join_to_sort_maximum_table_rows) | `10000` |
128+
| [allow_experimental_join_right_table_sorting](/operations/settings/settings#allow_experimental_join_right_table_sorting) | `0` |
129+
| [allow_statistics_optimize](/operations/settings/settings#allow_statistics_optimize) | `0` |
130+
| [allow_experimental_statistics](/operations/settings/settings#allow_experimental_statistics) | `0` |
131+
| [allow_experimental_full_text_index](/operations/settings/settings#allow_experimental_full_text_index) | `0` |
132+
| [allow_experimental_live_view](/operations/settings/settings#allow_experimental_live_view) | `0` |
133+
| [live_view_heartbeat_interval](/operations/settings/settings#live_view_heartbeat_interval) | `15` |
134+
| [max_live_view_insert_blocks_before_refresh](/operations/settings/settings#max_live_view_insert_blocks_before_refresh) | `64` |
135+
| [allow_experimental_window_view](/operations/settings/settings#allow_experimental_window_view) | `0` |
136+
| [window_view_clean_interval](/operations/settings/settings#window_view_clean_interval) | `60` |
137+
| [window_view_heartbeat_interval](/operations/settings/settings#window_view_heartbeat_interval) | `15` |
138+
| [wait_for_window_view_fire_signal_timeout](/operations/settings/settings#wait_for_window_view_fire_signal_timeout) | `10` |
139+
| [stop_refreshable_materialized_views_on_startup](/operations/settings/settings#stop_refreshable_materialized_views_on_startup) | `0` |
140+
| [allow_experimental_database_materialized_postgresql](/operations/settings/settings#allow_experimental_database_materialized_postgresql) | `0` |
141+
| [allow_experimental_qbit_type](/operations/settings/settings#allow_experimental_qbit_type) | `0` |
142+
| [allow_experimental_query_deduplication](/operations/settings/settings#allow_experimental_query_deduplication) | `0` |
143+
| [allow_experimental_database_hms_catalog](/operations/settings/settings#allow_experimental_database_hms_catalog) | `0` |
144+
| [allow_experimental_kusto_dialect](/operations/settings/settings#allow_experimental_kusto_dialect) | `0` |
145+
| [allow_experimental_prql_dialect](/operations/settings/settings#allow_experimental_prql_dialect) | `0` |
146+
| [enable_adaptive_memory_spill_scheduler](/operations/settings/settings#enable_adaptive_memory_spill_scheduler) | `0` |
147+
| [allow_experimental_insert_into_iceberg](/operations/settings/settings#allow_experimental_insert_into_iceberg) | `0` |
148+
| [allow_experimental_iceberg_compaction](/operations/settings/settings#allow_experimental_iceberg_compaction) | `0` |
149+
| [write_full_path_in_iceberg_metadata](/operations/settings/settings#write_full_path_in_iceberg_metadata) | `0` |
150+
| [iceberg_metadata_compression_method](/operations/settings/settings#iceberg_metadata_compression_method) | `` |
151+
| [make_distributed_plan](/operations/settings/settings#make_distributed_plan) | `0` |
152+
| [distributed_plan_execute_locally](/operations/settings/settings#distributed_plan_execute_locally) | `0` |
153+
| [distributed_plan_default_shuffle_join_bucket_count](/operations/settings/settings#distributed_plan_default_shuffle_join_bucket_count) | `8` |
154+
| [distributed_plan_default_reader_bucket_count](/operations/settings/settings#distributed_plan_default_reader_bucket_count) | `8` |
155+
| [distributed_plan_force_exchange_kind](/operations/settings/settings#distributed_plan_force_exchange_kind) | `` |
156+
| [distributed_plan_max_rows_to_broadcast](/operations/settings/settings#distributed_plan_max_rows_to_broadcast) | `20000` |
157+
| [allow_experimental_ytsaurus_table_engine](/operations/settings/settings#allow_experimental_ytsaurus_table_engine) | `0` |
158+
| [allow_experimental_ytsaurus_table_function](/operations/settings/settings#allow_experimental_ytsaurus_table_function) | `0` |
159+
| [allow_experimental_ytsaurus_dictionary_source](/operations/settings/settings#allow_experimental_ytsaurus_dictionary_source) | `0` |
160+
| [distributed_plan_force_shuffle_aggregation](/operations/settings/settings#distributed_plan_force_shuffle_aggregation) | `0` |
161+
| [enable_join_runtime_filters](/operations/settings/settings#enable_join_runtime_filters) | `0` |
162+
| [join_runtime_bloom_filter_bytes](/operations/settings/settings#join_runtime_bloom_filter_bytes) | `524288` |
163+
| [join_runtime_bloom_filter_hash_functions](/operations/settings/settings#join_runtime_bloom_filter_hash_functions) | `3` |
164+
| [rewrite_in_to_join](/operations/settings/settings#rewrite_in_to_join) | `0` |
165+
| [allow_experimental_time_series_aggregate_functions](/operations/settings/settings#allow_experimental_time_series_aggregate_functions) | `0` |
166+
| [promql_database](/operations/settings/settings#promql_database) | `` |
167+
| [promql_table](/operations/settings/settings#promql_table) | `` |
168+
| [promql_evaluation_time](/operations/settings/settings#promql_evaluation_time) | `auto` |
169+
<!--AUTOGENERATED_END-->

0 commit comments

Comments
 (0)