Skip to content

Commit

Permalink
add supported engines
Browse files Browse the repository at this point in the history
  • Loading branch information
WanYixian committed Dec 2, 2024
1 parent 1332b48 commit d9cd5d8
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 2 deletions.
2 changes: 1 addition & 1 deletion get-started/rw-premium-edition-intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ RisingWave Premium 1.0 is the first major release of this new edition with sever

### Connectors

<CardGroup> <Card title="Sink to Snowflake" icon="snowflake" href="/integrations/destinations/snowflake" horizontal /> <Card title="Sink to DynamoDB" icon="database" href="/integrations/destinations/amazon-dynamodb" horizontal /> <Card title="Sink to OpenSearch" icon="magnifying-glass" href="/integrations/destinations/opensearch" horizontal /> <Card title="Sink to BigQuery" icon="table" href="/integrations/destinations/bigquery" horizontal /> <Card title="Sink to SharedMergeTree table engine on ClickHouse Cloud" icon="server" horizontal /> <Card title="Sink to SQL Server" icon="database" href="/integrations/destinations/sql-server" horizontal /> <Card title="Direct SQL Server CDC source connector" icon="plug" href="/integrations/sources/sql-server-cdc" horizontal /> <Card title="Sink to Iceberg with glue catalog" icon="mountain" href="/integrations/destinations/apache-iceberg#glue-catelogs" horizontal /> <Card title="Ingest data from webhook" icon="laptop-code" href="/integrations/sources/webhook" horizontal /></CardGroup>
<CardGroup> <Card title="Sink to Snowflake" icon="snowflake" href="/integrations/destinations/snowflake" horizontal /> <Card title="Sink to DynamoDB" icon="database" href="/integrations/destinations/amazon-dynamodb" horizontal /> <Card title="Sink to OpenSearch" icon="magnifying-glass" href="/integrations/destinations/opensearch" horizontal /> <Card title="Sink to BigQuery" icon="table" href="/integrations/destinations/bigquery" horizontal /> <Card title="Sink to SharedMergeTree table engine on ClickHouse Cloud" icon="server" href="/integrations/destinations/clickhouse#supported-table-engines" horizontal /> <Card title="Sink to SQL Server" icon="database" href="/integrations/destinations/sql-server" horizontal /> <Card title="Direct SQL Server CDC source connector" icon="plug" href="/integrations/sources/sql-server-cdc" horizontal /> <Card title="Sink to Iceberg with glue catalog" icon="mountain" href="/integrations/destinations/apache-iceberg#glue-catelogs" horizontal /> <Card title="Ingest data from webhook" icon="laptop-code" href="/integrations/sources/webhook" horizontal /></CardGroup>

For users who are already using these features in 1.9.x or earlier versions, rest assured that the functionality of these features will be intact if you stay on the version. If you choose to upgrade to v2.0 or later versions, an error will show up to indicate you need a license to use the features.

Expand Down
38 changes: 37 additions & 1 deletion integrations/destinations/clickhouse.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ WITH (
| commit\_checkpoint\_interval | Optional. Commit every N checkpoints (N > 0). Default value is 10. <br/>The behavior of this field also depends on the `sink_decouple` setting:<ul><li>If `sink_decouple` is true (the default), the default value of `commit_checkpoint_interval` is 10.</li> <li>If `sink_decouple` is set to false, the default value of `commit_checkpoint_interval` is 1.</li> <li>If `sink_decouple` is set to false and `commit_checkpoint_interval` is set to larger than 1, an error will occur.</li></ul> |
| clickhouse.delete.column | Optional. You can run an upsert sink using the ReplacingMergeTree engine. When using the ReplacingMergeTree engine, you can specify the delete column with this parameter. |

### Upsert sinks
## Upsert sinks

While RisingWave supports `append-only` sinks for all ClickHouse engines, support for `upsert` sinks is limited. Additionally, for ReplacingMergeTree engines, an `append-only` sink will not insert duplicate data.

Expand All @@ -50,6 +50,42 @@ RisingWave supports `upsert` sinks for the following ClickHouse engines:
* VersionedCollapsingMergeTree: `DELETE` operations are transformed into `INSERT with SIGN = -1`.
* ReplacingMergeTree: `DELETE` operations are transformed into `INSERT with SIGN = 1`.

## Supported table engines

RisingWave supports the following table engines of ClickHouse:

* MergeTree
* ReplacingMergeTree
* SummingMergeTree
* AggregatingMergeTree
* CollapsingMergeTree
* VersionedCollapsingMergeTree
* GraphiteMergeTree
* ReplicatedMergeTree
* ReplicatedReplacingMergeTree
* ReplicatedSummingMergeTree
* ReplicatedAggregatingMergeTree
* ReplicatedCollapsingMergeTree
* ReplicatedVersionedCollapsingMergeTree
* ReplicatedGraphiteMergeTree
* SharedMergeTree
* SharedReplacingMergeTree
* SharedSummingMergeTree
* SharedAggregatingMergeTree
* SharedCollapsingMergeTree
* SharedVersionedCollapsingMergeTree
* SharedGraphiteMergeTree

Among these, engines prefixed with "Shared" are exclusively available in ClickHouse Cloud and are premium features in RisingWave. They provide enhanced capabilities for distributed deployments, automatic replication, and improved resource management. For more information about it, see [MergeTree Engine Family
](https://clickhouse.com/docs/en/engines/table-engines/mergetree-family).

<Tip>
**PREMIUM EDITION FEATURE**

This feature is only available in the premium edition of RisingWave. The premium edition offers additional advanced features and capabilities beyond the free and community editions. If you have any questions about upgrading to the premium edition, please contact our sales team at [[email protected]](mailto:[email protected]).
</Tip>


## Examples

This section includes several examples that you can use if you want to quickly experiment with sinking data to ClickHouse.
Expand Down

0 comments on commit d9cd5d8

Please sign in to comment.