Skip to content

Commit 6c4678b

Browse files
authored
[fivetran] Revamp docs (#5777)
Update Fivetran docs to include a complete view of all existing documentation. Includes good practices and troubleshooting guides.
1 parent 4772b1e commit 6c4678b

4 files changed

Lines changed: 673 additions & 11 deletions

File tree

docs/integrations/data-ingestion/etl-tools/fivetran/index.md

Lines changed: 32 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22
sidebar_label: 'Fivetran'
33
slug: /integrations/fivetran
44
sidebar_position: 2
5-
description: 'You can transform and model your data in ClickHouse using dbt'
5+
description: 'Use Fivetran to move data from any source into ClickHouse Cloud with automated schema creation, deduplication, and History Mode (SCD Type 2).'
66
title: 'Fivetran and ClickHouse Cloud'
77
doc_type: 'guide'
88
integration:
99
- support_level: 'core'
1010
- category: 'data_ingestion'
11-
keywords: ['fivetran', 'data movement', 'etl', 'clickhouse destination', 'automated data platform']
11+
- website: 'https://github.com/ClickHouse/clickhouse-fivetran-destination'
12+
keywords: ['fivetran', 'data movement', 'etl', 'clickhouse destination', 'automated data platform', 'history mode', 'SCD Type 2']
1213
---
1314

1415
import ClickHouseSupportedBadge from '@theme/badges/ClickHouseSupported';
@@ -21,10 +22,12 @@ import ClickHouseSupportedBadge from '@theme/badges/ClickHouseSupported';
2122

2223
[Fivetran](https://www.fivetran.com) is the automated data movement platform moving data out of, into and across your cloud data platforms.
2324

24-
[ClickHouse Cloud](https://clickhouse.com/cloud) is supported as a [Fivetran destination](https://fivetran.com/docs/destinations/clickhouse), allowing users to load data from various sources into ClickHouse.
25+
[ClickHouse Cloud](https://clickhouse.com/cloud) is supported as a [Fivetran destination](https://fivetran.com/docs/destinations/clickhouse), allowing you to load data from various sources into ClickHouse. Open Source ClickHouse version isn't supported as a destination.
26+
27+
The destination connector is developed and maintained together by ClickHouse and Fivetran. The source code is available on [GitHub](https://github.com/ClickHouse/clickhouse-fivetran-destination).
2528

2629
:::note
27-
[ClickHouse Cloud destination](https://fivetran.com/docs/destinations/clickhouse) is currently in private preview, please contact ClickHouse support in the case of any problems.
30+
[ClickHouse Cloud destination](https://fivetran.com/docs/destinations/clickhouse) is currently in **Beta** but we are working to make it generally available soon.
2831
:::
2932

3033
<div class='vimeo-container'>
@@ -39,13 +42,32 @@ import ClickHouseSupportedBadge from '@theme/badges/ClickHouseSupported';
3942
</iframe>
4043
</div>
4144

42-
## ClickHouse Cloud destination {#clickhouse-cloud-destination}
45+
## Key features {#key-features}
46+
- **ClickHouse Cloud compatible**: use your ClickHouse Cloud database as a Fivetran destination.
47+
- **SaaS deployment model**: fully managed by Fivetran, no need to manage your own infrastructure.
48+
- **History Mode (SCD Type 2)**: preserves complete history of all record versions for point-in-time analysis and audit trails.
49+
- **Configurable batch sizes**: You can adapt Fivetran to your particular use case by tuning write, select, mutation, and hard delete batch sizes via a JSON configuration file.
50+
51+
## Limitations {#limitations}
52+
- Schema migrations are not supported yet, but we are working on it.
53+
- Adding, removing, or modifying primary key columns is not supported.
54+
- Custom ClickHouse settings on `CREATE TABLE` statements are not supported.
55+
- Role-based grants are not fully supported. The connector's grants check only queries direct user grants. Use [direct grants](/integrations/fivetran/troubleshooting#role-based-grants) instead.
56+
57+
## Related pages {#related-pages}
58+
- [Technical Reference](/integrations/fivetran/reference): type mappings, table engines, metadata columns and advanced configurations
59+
- [Troubleshooting & Best Practices](/integrations/fivetran/troubleshooting): common errors and optimization tips and debugging queries
60+
- [ClickHouse Fivetran destination on GitHub](https://github.com/ClickHouse/clickhouse-fivetran-destination)
61+
62+
## Setup guide {#setup-guide}
63+
- If you're looking for configurations and general technical details, please refer to the [technical reference](/integrations/fivetran/reference).
64+
- For a comprehensive guide, check the [setup guide](https://fivetran.com/docs/destinations/clickhouse/setup-guide) in the Fivetran documentation.
4365

44-
See the official documentation on the Fivetran website:
66+
## Contact and support {#contact-us}
4567

46-
- [ClickHouse destination overview](https://fivetran.com/docs/destinations/clickhouse)
47-
- [ClickHouse destination setup guide](https://fivetran.com/docs/destinations/clickhouse/setup-guide)
68+
The ClickHouse Fivetran destination has a split ownership model:
4869

49-
## Contact us {#contact-us}
70+
- **ClickHouse** develops and maintains the destination connector code.
71+
- **Fivetran** hosts the connector and is responsible for data movement, pipeline scheduling, and source connectors.
5072

51-
If you have any questions, or if you have a feature request, please open a [support ticket](/about-us/support).
73+
Both Fivetran and ClickHouse provide support for the Fivetran ClickHouse destination. For general inquiries, we recommend reaching out to Fivetran, as they are the experts on the Fivetran platform. For any ClickHouse-specific questions or issues, our support team is happy to help. Create a [support ticket](/about-us/support) to ask a question or report an issue.

0 commit comments

Comments
 (0)