diff --git a/docs/integrations/data-visualization/community_integrations/holistics-and-clickhouse.md b/docs/integrations/data-visualization/community_integrations/holistics-and-clickhouse.md new file mode 100644 index 00000000000..cf5586ab8cc --- /dev/null +++ b/docs/integrations/data-visualization/community_integrations/holistics-and-clickhouse.md @@ -0,0 +1,112 @@ +--- +sidebar_label: 'Holistics' +slug: /integrations/holistics +keywords: ['clickhouse', 'Holistics', 'AI', 'integrate', 'bi', 'data visualization'] +description: 'Holistics is an AI-powered platform for self-service BI and embedded analytics that helps everyone make better decisions with governed, easily accessible metrics.' +title: 'Connect ClickHouse to Holistics' +doc_type: 'guide' +--- + +import Image from '@theme/IdealImage'; +import CommunityMaintainedBadge from '@theme/badges/CommunityMaintained'; +import holistics_01 from '@site/static/images/integrations/data-visualization/holistics_01.png'; +import holistics_02 from '@site/static/images/integrations/data-visualization/holistics_02.png'; +import holistics_03 from '@site/static/images/integrations/data-visualization/holistics_03.png'; +import holistics_04 from '@site/static/images/integrations/data-visualization/holistics_04.png'; +import holistics_05 from '@site/static/images/integrations/data-visualization/holistics_05.png'; +import holistics_06 from '@site/static/images/integrations/data-visualization/holistics_06.png'; + +# Connecting ClickHouse to Holistics + + + +[Holistics](https://www.holistics.io/) is an AI-native self-service BI platform with a programmable semantic layer for consistent, trustworthy metrics. + +By connecting ClickHouse to Holistics, your teams get a fast, reliable AI-powered self-service experience grounded in a code-based semantic layer. Business users can explore data confidently with drag-and-drop and AI, while you keep metric definitions reusable, composable, and version-controlled in Git. + +## Prerequisites {#prerequisites} + +Before connecting, ensure you have the following: + +- **Permissions:** You must be an Admin in Holistics to add new Data Sources. +- **Network Access:** Your ClickHouse server must be accessible from [Holistics' IP addresses](https://docs.holistics.io/docs/connect/ip-whitelisting). +- **Database User:** Create a dedicated, read-only user for Holistics rather than using an admin account. + +### Recommended privileges {#recommended-privileges} + +The dedicated user requires `SELECT` privileges on the tables you wish to query, as well as the `system` tables (for schema detection). + +```sql +-- Example: Grant read access to a specific database +GRANT SELECT ON my_database.* TO holistics_user; + +-- Grant access to system metadata +GRANT SELECT ON system.* TO holistics_user; +``` + + + +## Gather connection details {#step-1-gather-connection-details} + +To connect to ClickHouse with HTTP(S) you will need this information: + +| **Parameter** | **Description** | +| ----------------- | ----------------------------------------------------------------------------------------- | +| **Host** | The hostname of your ClickHouse server (e.g., `mz322.eu-central-1.aws.clickhouse.cloud`). | +| **Port** | **8443** for ClickHouse Cloud (SSL/TLS). **8123** for self-managed instances without SSL. | +| **Database Name** | The name of the database you want to connect to. The default is usually `default`. | +| **Username** | The database user. The default is `default`. | +| **Password** | The password for the database user. | + +You can find these details by clicking the **Connect** button in your ClickHouse Cloud console and selecting **HTTPS**. + +Location of the Connect button in the ClickHouse Cloud console + +## Configure network access {#step-2-configure-network-access} + +Since Holistics is a cloud-based application, its servers must be able to reach your database. You have two options: + +1. **Direct Connection (Recommended):** Allowlist Holistics' IP addresses in your firewall or ClickHouse Cloud IP Access List. You can find the list of IPs in the [IP Whitelisting guide](https://docs.holistics.io/docs/connect/ip-whitelisting). + + Example of IP allowlisting in ClickHouse Cloud + +2. **Reverse SSH Tunnel:** If your database is in a private network (VPC) and cannot be exposed publicly, use a [Reverse SSH Tunnel](https://docs.holistics.io/docs/connect/connect-tunnel). + +## Add data source in Holistics {#step-3-add-data-source-in-holistics} + +1. In Holistics, go to **Settings → Data Sources**. + + Navigating to Data Sources in Holistics settings + +2. Click **New Data Source** and select **ClickHouse**. + + Selecting ClickHouse from the list of new data sources + +3. Fill in the form with the details gathered in Step 1. + + | **Field** | **Setting** | + | ----------------- | ----------------------------------------------------------------- | + | **Host** | Your ClickHouse Hostname | + | **Port** | `8443` (or `8123`) | + | **Require SSL** | Toggle **ON** if using port 8443 (Required for ClickHouse Cloud). | + | **Database Name** | `default` (or your specific DB) | + + Filling in ClickHouse connection details in Holistics + +4. Click **Test Connection**. + + Successful ClickHouse connection test in Holistics + + - **Success:** Click **Save**. + - **Failure:** Check your username/password and ensure the [Holistics IPs are allowlisted](https://docs.holistics.io/docs/connect/ip-whitelisting). + + + +## Known limitations {#known-limitations} + +Holistics supports most standard SQL features in ClickHouse, with the following exceptions: + +- **Running Total:** This analytic function currently has limited support on ClickHouse. +- **Nested Data Types:** Deeply nested JSON or Array structures may require flattening via SQL models before visualization. + +For a full list of supported features, please refer to the [Database-specific Limitations page](https://docs.holistics.io/docs/connect/faqs/clickhouse-limitations). diff --git a/docs/integrations/data-visualization/index.md b/docs/integrations/data-visualization/index.md index 6a34ac3417c..ee3754d7c90 100644 --- a/docs/integrations/data-visualization/index.md +++ b/docs/integrations/data-visualization/index.md @@ -46,6 +46,7 @@ Now that your data is in ClickHouse, it's time to analyze it, which often involv - [Rocket BI](./community_integrations/rocketbi-and-clickhouse.md) - [Tableau](./tableau/tableau-and-clickhouse.md) - [Zing Data](./community_integrations/zingdata-and-clickhouse.md) +- [Holistics BI](./community_integrations/holistics-and-clickhouse.md) ## ClickHouse Cloud compatibility with data visualization tools {#clickhouse-cloud-compatibility-with-data-visualization-tools} @@ -62,6 +63,7 @@ Now that your data is in ClickHouse, it's time to analyze it, which often involv | [Fabi.ai](./community_integrations/fabi-and-clickhouse.md) | Native connector | ✅ | ✅ | | | [Grafana](./grafana/index.md) | ClickHouse official connector | ✅ | ✅ | | | [Hashboard](./community_integrations/hashboard-and-clickhouse.md) | Native connector | ✅ | ✅ | | +| [Holistics](./community_integrations/holistics-and-clickhouse.md) | Native connector | ✅ | ✅ | | | [Lightdash](./lightdash-and-clickhouse.md) | Native connector | ✅ | ✅ | | | [Looker](./looker-and-clickhouse.md) | Native connector | ✅ | ✅ | Works with some limitations, see [the documentation](./looker-and-clickhouse.md) for more details | diff --git a/static/images/integrations/data-visualization/holistics_01.png b/static/images/integrations/data-visualization/holistics_01.png new file mode 100644 index 00000000000..ea316ed8894 Binary files /dev/null and b/static/images/integrations/data-visualization/holistics_01.png differ diff --git a/static/images/integrations/data-visualization/holistics_02.png b/static/images/integrations/data-visualization/holistics_02.png new file mode 100644 index 00000000000..488085ecffe Binary files /dev/null and b/static/images/integrations/data-visualization/holistics_02.png differ diff --git a/static/images/integrations/data-visualization/holistics_03.png b/static/images/integrations/data-visualization/holistics_03.png new file mode 100644 index 00000000000..967e604dc17 Binary files /dev/null and b/static/images/integrations/data-visualization/holistics_03.png differ diff --git a/static/images/integrations/data-visualization/holistics_04.png b/static/images/integrations/data-visualization/holistics_04.png new file mode 100644 index 00000000000..b733cf16486 Binary files /dev/null and b/static/images/integrations/data-visualization/holistics_04.png differ diff --git a/static/images/integrations/data-visualization/holistics_05.png b/static/images/integrations/data-visualization/holistics_05.png new file mode 100644 index 00000000000..38e62c6e033 Binary files /dev/null and b/static/images/integrations/data-visualization/holistics_05.png differ diff --git a/static/images/integrations/data-visualization/holistics_06.png b/static/images/integrations/data-visualization/holistics_06.png new file mode 100644 index 00000000000..b63a33468a9 Binary files /dev/null and b/static/images/integrations/data-visualization/holistics_06.png differ diff --git a/static/integrations-fallback.json b/static/integrations-fallback.json index c7e68de0df1..5293db2638f 100644 --- a/static/integrations-fallback.json +++ b/static/integrations-fallback.json @@ -4904,7 +4904,7 @@ "createdAt": "2024-06-10T21:57:05.622Z", "updatedAt": "2024-07-01T09:52:46.923Z", "publishedAt": "2024-07-08T09:21:27.746Z", - "docsLink": "https://www.holistics.io/integrations/clickhouse/", + "docsLink": "https://docs.holistics.io/docs/connect/databases/clickhouse", "about": null, "changelog": null, "version": null,