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
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
20 changes: 10 additions & 10 deletions docs/_snippets/_clickhouse_mysql_cloud_setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@ import {VerticalStepper} from "@clickhouse/click-ui/bundled";

<VerticalStepper headerLevel="h4">

#### Select `Connect your app` {#select-connect-your-app}
#### Select `Connect your app` \{#select-connect-your-app\}

After creating your ClickHouse Cloud Service, on the `Connect your app` screen, select MySQL from the drop down.

<Image size="lg" img={mysql_1} alt="ClickHouse Cloud credentials screen showing MySQL interface selection dropdown" border />

#### Enable the MySQL interface {#enable-mysql-interface}
#### Enable the MySQL interface \{#enable-mysql-interface\}

Toggle the switch to enable the MySQL interface for this specific service.
This will expose port `3306` for this service and prompt you with a MySQL connection screen that includes your unique MySQL username.
Expand All @@ -23,20 +23,20 @@ This will expose port `3306` for this service and prompt you with a MySQL connec

Alternatively, in order to enable the MySQL interface for an existing service:

#### Select `Connect` {#select-connect}
#### Select `Connect` \{#select-connect\}

Ensure your service is in `Running` state then click on the service you want to enable the MySQL interface for.
Select "Connect" from the left menu:

<Image size="lg" img={mysql_3} alt="ClickHouse Cloud service connection screen with Connect option highlighted" border />

#### Choose `MySQL` {#choose-mysql}
#### Choose `MySQL` \{#choose-mysql\}

Select `MySQL` from the `Connect With` drop down.

<Image size="md" img={mysql_4} alt="ClickHouse Cloud connection screen showing MySQL option selection" border />

#### Enable the MySQL interface {#enable-mysql-interface}
#### Enable the MySQL interface \{#enable-mysql-interface\}

Toggle the switch to enable the MySQL interface for this specific service.
This will expose port `3306` for this service and prompt you with your MySQL connection screen that include your unique MySQL username.
Expand All @@ -45,7 +45,7 @@ This will expose port `3306` for this service and prompt you with your MySQL con

<Image size="md" img={mysql_5} alt="ClickHouse Cloud connection screen with MySQL interface enabled showing connection details" border />

## Creating a readonly MySQL user in ClickHouse Cloud {#creating-multiple-mysql-users-in-clickhouse-cloud}
## Creating a readonly MySQL user in ClickHouse Cloud \{#creating-multiple-mysql-users-in-clickhouse-cloud\}

ClickHouse Cloud automatically creates a `mysql4<subdomain>` user that shares the same password as the default user.
The `<subdomain>` portion corresponds to the first part of your ClickHouse Cloud hostname.
Expand All @@ -64,7 +64,7 @@ For a ClickHouse Cloud hostname like `foobar.us-east1.aws.clickhouse.cloud`, the

<VerticalStepper headerLevel="h4">

#### Create a readonly settings profile {#create-a-custom-settings-user}
#### Create a readonly settings profile \{#create-a-custom-settings-user\}

Create a [settings profile](/sql-reference/statements/create/settings-profile) to apply to your readonly user,
setting the `readonly` setting to `1`:
Expand All @@ -73,7 +73,7 @@ setting the `readonly` setting to `1`:
CREATE SETTINGS PROFILE readonly_profile SETTINGS readonly = 1
```

#### Create a new readonly MySQL user {#create-a-readonly-mysql-user}
#### Create a new readonly MySQL user \{#create-a-readonly-mysql-user\}

[Create a user](/sql-reference/statements/create/user) with a name following this format:

Expand All @@ -89,7 +89,7 @@ IDENTIFIED WITH double_sha1_password BY 'YourPassword42$'
SETTINGS PROFILE 'readonly_profile';
```

#### Grant the new user permissions to access the desired tables {#grant-the-new-user-the-necessary-permissions}
#### Grant the new user permissions to access the desired tables \{#grant-the-new-user-the-necessary-permissions\}

[Grant](/sql-reference/statements/grant) the new user the necessary permissions to interact with the desired tables or databases.
For example, if you want to grant access to `system.query_log` only:
Expand All @@ -106,7 +106,7 @@ The newly created user can be used to connect to your ClickHouse Cloud service w

</VerticalStepper>

### Troubleshooting multiple MySQL users in ClickHouse Cloud {#troubleshooting-multiple-mysql-users-in-clickhouse-cloud}
### Troubleshooting multiple MySQL users in ClickHouse Cloud \{#troubleshooting-multiple-mysql-users-in-clickhouse-cloud\}

If you created a new MySQL user, and you see the following error while connecting via MySQL CLI client:

Expand Down
2 changes: 1 addition & 1 deletion docs/_snippets/_clickstack_tagging.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import clickstackTagsDashboard from '@site/static/images/use-cases/observability
You can add tags to dashboards and saved searches to help organize them.
Tags provide a flexible way to categorize and filter based on your needs.

#### How tags work {#how-tags-work}
#### How tags work \{#how-tags-work\}

- **Organization**: Tags appear in the left sidebar, where dashboards and saved searches are grouped by their assigned tags
- **Multiple tags**: You can add one or more tags to a single item for better categorization
Expand Down
32 changes: 16 additions & 16 deletions docs/about-us/beta-and-experimental-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,18 @@ Please note: no additional experimental features are allowed to be enabled in Cl

| Name | Default |
|------|--------|
| [shared_merge_tree_activate_coordinated_merges_tasks](/operations/settings/merge-tree-settings#shared_merge_tree_activate_coordinated_merges_tasks) | `0` |
| [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) | `1.1` |
| [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` |
| [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` |
Expand Down Expand Up @@ -95,18 +107,6 @@ Please note: no additional experimental features are allowed to be enabled in Cl
| [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_activate_coordinated_merges_tasks](/operations/settings/merge-tree-settings#shared_merge_tree_activate_coordinated_merges_tasks) | `0` |
| [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) | `1.1` |
| [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` |
| [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` |
Expand All @@ -115,7 +115,6 @@ Please note: no additional experimental features are allowed to be enabled in Cl
| [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` |
Expand All @@ -128,10 +127,8 @@ Please note: no additional experimental features are allowed to be enabled in Cl
| [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` |
| [use_statistics_cache](/operations/settings/settings#use_statistics_cache) | `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` |
Expand Down Expand Up @@ -159,11 +156,14 @@ Please note: no additional experimental features are allowed to be enabled in Cl
| [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` |
| [enable_join_runtime_filters](/operations/settings/settings#enable_join_runtime_filters) | `0` |
| [join_runtime_filter_exact_values_limit](/operations/settings/settings#join_runtime_filter_exact_values_limit) | `10000` |
| [join_runtime_bloom_filter_bytes](/operations/settings/settings#join_runtime_bloom_filter_bytes) | `524288` |
| [join_runtime_bloom_filter_hash_functions](/operations/settings/settings#join_runtime_bloom_filter_hash_functions) | `3` |
| [rewrite_in_to_join](/operations/settings/settings#rewrite_in_to_join) | `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) | `` |
| [promql_evaluation_time](/operations/settings/settings#promql_evaluation_time) | `auto` |
| [allow_experimental_alias_table_engine](/operations/settings/settings#allow_experimental_alias_table_engine) | `0` |
| [use_paimon_partition_pruning](/operations/settings/settings#use_paimon_partition_pruning) | `0` |
<!--AUTOGENERATED_END-->
4 changes: 2 additions & 2 deletions docs/best-practices/partitioning_keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ With partitioning enabled, ClickHouse only [merges](/merges) data parts within,

<Image img={merges_with_partitions} size="md" alt="Partitions" />

## Applications of partitioning {#applications-of-partitioning}
## Applications of partitioning \{#applications-of-partitioning\}

Partitioning is a powerful tool for managing large datasets in ClickHouse, especially in observability and analytics use cases. It enables efficient data life cycle operations by allowing entire partitions, often aligned with time or business logic, to be dropped, moved, or archived in a single metadata operation. This is significantly faster and less resource-intensive than row-level delete or copy operations. Partitioning also integrates cleanly with ClickHouse features like TTL and tiered storage, making it possible to implement retention policies or hot/cold storage strategies without custom orchestration. For example, recent data can be kept on fast SSD-backed storage, while older partitions are automatically moved to cheaper object storage.

Expand All @@ -57,7 +57,7 @@ Conversely, if queries need to query across partitions performance may be negati

In summary, users should primarily think of partitioning as a data management technique. For an example of managing data, see ["Managing Data"](/observability/managing-data) from the observability use-case guide and ["What are table partitions used for?"](/partitions#data-management) from Core Concepts - Table partitions.

## Choose a low cardinality partitioning key {#choose-a-low-cardinality-partitioning-key}
## Choose a low cardinality partitioning key \{#choose-a-low-cardinality-partitioning-key\}

Importantly, a higher number of parts will negatively affect query performance. ClickHouse will therefore respond to inserts with a [“too many parts”](/knowledgebase/exception-too-many-parts) error if the number of parts exceeds specified limits either in [total](/operations/settings/merge-tree-settings#max_parts_in_total) or [per partition](/operations/settings/merge-tree-settings#parts_to_throw_insert).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "SQL console",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
2 changes: 1 addition & 1 deletion docs/cloud/features/04_infrastructure/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Infrastructure",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Automatic Scaling",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
2 changes: 1 addition & 1 deletion docs/cloud/features/05_admin_features/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Admin",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
2 changes: 1 addition & 1 deletion docs/cloud/features/07_monitoring/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Monitoring",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
2 changes: 1 addition & 1 deletion docs/cloud/features/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Features",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
2 changes: 1 addition & 1 deletion docs/cloud/guides/SQL_console/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "SQL console",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "ML/AI",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Use cases",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Migration guide",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Snowflake",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Redshift",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "OSS to Cloud",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Other...",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Migration guides",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
2 changes: 1 addition & 1 deletion docs/cloud/reference/09_security/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Security",
"collapsible": true,
"collapsed": true,
"collapsed": true
}
Loading