Skip to content

Commit c41d059

Browse files
authored
Merge pull request #5171 from Blargian/compatibility-notice-migration-guides
2 parents 7e1e469 + a4fdfb8 commit c41d059

File tree

2 files changed

+16
-6
lines changed

2 files changed

+16
-6
lines changed

docs/_snippets/compatibility.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
:::note Compatibility
2+
If you are noticing differences in behavior between your self-hosted ClickHouse deployment and your ClickHouse Cloud service,
3+
it may be related to the [compatibility setting](/operations/settings/settings#compatibility).
4+
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.
5+
If you wish to change compatibility, you may request to do so via [support](https://clickhouse.com/support/program).
6+
:::

docs/cloud/onboard/02_migrate/01_migration_guides/07_OSS_to_Cloud/01_clickhouse-to-cloud.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,23 +15,24 @@ import self_managed_03 from '@site/static/images/integrations/migration/self-man
1515
import self_managed_04 from '@site/static/images/integrations/migration/self-managed-04.png';
1616
import self_managed_05 from '@site/static/images/integrations/migration/self-managed-05.png';
1717
import self_managed_06 from '@site/static/images/integrations/migration/self-managed-06.png';
18+
import CompatibilityNote from '@site/docs/_snippets/compatibility.mdx'
1819

1920
# Migrating between self-managed ClickHouse and ClickHouse Cloud
2021

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

23-
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`.
24+
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.
25+
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`.
2426

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

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

29-
:::note
30-
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),
31-
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.
32-
:::
31+
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),
32+
and ClickHouse Cloud will automatically take care of vertical and horizontal scaling.
33+
There is no need from your side to think about how to replicate and shard the table.
3334

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

3637
### Overview {#overview}
3738

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

4647
### Migration of tables from one system to another: {#migration-of-tables-from-one-system-to-another}
48+
4749
This example migrates one table from a self-managed ClickHouse server to ClickHouse Cloud.
4850

51+
<CompatibilityNote/>
52+
4953
### On the source ClickHouse system (the system that currently hosts the data) {#on-the-source-clickhouse-system-the-system-that-currently-hosts-the-data}
5054

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

0 commit comments

Comments
 (0)