Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
---
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

<CommunityMaintainedBadge/>

[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](/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;
```

## Step 1: 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**.

<Image size="md" img={holistics_01} alt="Location of the Connect button in the ClickHouse Cloud console" border />

## Step 2: 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](/docs/connect/ip-whitelisting).

<Image size="md" img={holistics_02} alt="Example of IP allowlisting in ClickHouse Cloud" border />

2. **Reverse SSH Tunnel:** If your database is in a private network (VPC) and cannot be exposed publicly, use a [Reverse SSH Tunnel](/docs/connect/connect-tunnel).

## Step 3: Add Data Source in Holistics {#step-3-add-data-source-in-holistics}

1. In Holistics, go to **Settings → Data Sources**.

<Image size="md" img={holistics_03} alt="Navigating to Data Sources in Holistics settings" border />

2. Click **New Data Source** and select **ClickHouse**.

<Image size="md" img={holistics_04} alt="Selecting ClickHouse from the list of new data sources" border />

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) |

<Image size="md" img={holistics_05} alt="Filling in ClickHouse connection details in Holistics" border />

4. Click **Test Connection**.

<Image size="md" img={holistics_06} alt="Successful ClickHouse connection test in Holistics" border />

- **Success:** Click **Save**.
- **Failure:** Check your username/password and ensure the [Holistics IPs are allowlisted](/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](/docs/connect/faqs/clickhouse-limitations).
2 changes: 2 additions & 0 deletions docs/integrations/data-visualization/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand All @@ -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 |
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion static/integrations-fallback.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down