Skip to content

Improvement: add a note about compatibility setting to OSS to Cloud migration guide #5171

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.

Sign up for GitHub

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

Merged
Blargian merged 1 commit into from
Jan 8, 2026
Merged

Improvement: add a note about compatibility setting to OSS to Cloud migration guide #5171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/_snippets/compatibility.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
:::note Compatibility
If you are noticing differences in behavior between your self-hosted ClickHouse deployment and your ClickHouse Cloud service,
it may be related to the [compatibility setting](/operations/settings/settings#compatibility).
In Cloud, compatibility is set when a service is created and does not change at the service level to ensure that clients get consistent behavior even as the service upgrades.
If you wish to change compatibility, you may request to do so via [support](https://clickhouse.com/support/program).
:::
16 changes: 10 additions & 6 deletions ...nboard/02_migrate/01_migration_guides/07_OSS_to_Cloud/01_clickhouse-to-cloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,24 @@ import self_managed_03 from '@site/static/images/integrations/migration/self-man
import self_managed_04 from '@site/static/images/integrations/migration/self-managed-04.png';
import self_managed_05 from '@site/static/images/integrations/migration/self-managed-05.png';
import self_managed_06 from '@site/static/images/integrations/migration/self-managed-06.png';
import CompatibilityNote from '@site/docs/_snippets/compatibility.mdx'

# Migrating between self-managed ClickHouse and ClickHouse Cloud

<Image img={self_managed_01} size='lg' alt='Migrating Self-managed ClickHouse'/>

This guide will show how to migrate from a self-managed ClickHouse server to ClickHouse Cloud, and also how to migrate between ClickHouse Cloud services. The [`remoteSecure`](/sql-reference/table-functions/remote) function is used in `SELECT` and `INSERT` queries to allow access to remote ClickHouse servers, which makes migrating tables as simple as writing an `INSERT INTO` query with an embedded `SELECT`.
This guide shows you how to migrate from a self-managed ClickHouse server to ClickHouse Cloud, and also how to migrate between ClickHouse Cloud services.
The [`remoteSecure`](/sql-reference/table-functions/remote) function is used in `SELECT` and `INSERT` queries to allow access to remote ClickHouse servers, which makes migrating tables as simple as writing an `INSERT INTO` query with an embedded `SELECT`.

## Migrating from Self-managed ClickHouse to ClickHouse Cloud {#migrating-from-self-managed-clickhouse-to-clickhouse-cloud}

<Image img={self_managed_02} size='lg' alt='Migrating Self-managed ClickHouse' />

:::note
Regardless of if your source table is sharded and/or replicated, on ClickHouse Cloud you just create a destination table (you can leave out the Engine parameter for this table, it will be automatically a ReplicatedMergeTree table),
and ClickHouse Cloud will automatically take care of vertical and horizontal scaling. There is no need from your side to think about how to replicate and shard the table.
:::
Regardless of if your source table is sharded and/or replicated, on ClickHouse Cloud you only need to create a destination table (you can leave out the Engine parameter for this table, `SharedMergeTree` will be selected automatically as the table engine),
and ClickHouse Cloud will automatically take care of vertical and horizontal scaling.
There is no need from your side to think about how to replicate and shard the table.

In this example the self-managed ClickHouse server is the *source* and the ClickHouse Cloud service is the *destination*.
In this example, the self-managed ClickHouse server is the *source* and the ClickHouse Cloud service is the *destination*.

### Overview {#overview}

Expand All @@ -44,8 +45,11 @@ The process is:
1. Remove the read-only user from the source service

### Migration of tables from one system to another: {#migration-of-tables-from-one-system-to-another}

This example migrates one table from a self-managed ClickHouse server to ClickHouse Cloud.

<CompatibilityNote/>

### On the source ClickHouse system (the system that currently hosts the data) {#on-the-source-clickhouse-system-the-system-that-currently-hosts-the-data}

- Add a read only user that can read the source table (`db.table` in this example)
Expand Down