|
| 1 | +--- |
| 2 | +sidebar_label: 'Databrain' |
| 3 | +sidebar_position: 131 |
| 4 | +slug: /integrations/databrain |
| 5 | +keywords: ['clickhouse', 'Databrain', 'connect', 'integrate', 'ui', 'analytics', 'embedded', 'dashboard', 'visualization'] |
| 6 | +description: 'Databrain is an embedded analytics platform that integrates seamlessly with ClickHouse for building customer facing dashboards, metrics, and data visualizations.' |
| 7 | +title: 'Connecting Databrain to ClickHouse' |
| 8 | +doc_type: 'guide' |
| 9 | +--- |
| 10 | + |
| 11 | +import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx'; |
| 12 | +import databrain_01 from '@site/static/images/integrations/data-visualization/databrain_01.png'; |
| 13 | +import databrain_02 from '@site/static/images/integrations/data-visualization/databrain_02.png'; |
| 14 | +import databrain_03 from '@site/static/images/integrations/data-visualization/databrain_03.png'; |
| 15 | +import databrain_04 from '@site/static/images/integrations/data-visualization/databrain_04.png'; |
| 16 | +import databrain_05 from '@site/static/images/integrations/data-visualization/databrain_05.png'; |
| 17 | +import databrain_06 from '@site/static/images/integrations/data-visualization/databrain_06.png'; |
| 18 | +import Image from '@theme/IdealImage'; |
| 19 | +import CommunityMaintainedBadge from '@theme/badges/CommunityMaintained'; |
| 20 | + |
| 21 | +# Connecting Databrain to ClickHouse |
| 22 | + |
| 23 | +<CommunityMaintainedBadge/> |
| 24 | + |
| 25 | +[Databrain](https://usedatabrain.com) is an embedded analytics platform that enables you to build and share interactive dashboards, metrics, and data visualizations with your customers. Databrain connects to ClickHouse using the HTTPS interface, making it easy to visualize and analyze your ClickHouse data with a modern, user-friendly interface. |
| 26 | + |
| 27 | +<Image size="md" img={databrain_01} alt="Databrain dashboard interface showing ClickHouse data visualization" border /> |
| 28 | + |
| 29 | +<br/> |
| 30 | + |
| 31 | +This guide will walk you through the steps to connect Databrain with your ClickHouse instance. |
| 32 | + |
| 33 | +## Pre-requisites {#pre-requisites} |
| 34 | + |
| 35 | +- A ClickHouse database either hosted on your own infrastructure or on [ClickHouse Cloud](https://clickhouse.com/). |
| 36 | +- A [Databrain account](https://app.usedatabrain.com/users/sign-up). |
| 37 | +- A Databrain workspace to connect your data source. |
| 38 | + |
| 39 | +## Steps to connect Databrain to ClickHouse {#steps-to-connect-databrain-to-clickhouse} |
| 40 | + |
| 41 | +### 1. Gather your connection details {#1-gather-your-connection-details} |
| 42 | + |
| 43 | +<ConnectionDetails /> |
| 44 | + |
| 45 | +### 2. Allow Databrain IP addresses (if required) {#2-allow-databrain-ip-addresses} |
| 46 | + |
| 47 | +If your ClickHouse instance has IP filtering enabled, you'll need to whitelist Databrain's IP addresses. |
| 48 | + |
| 49 | +For ClickHouse Cloud users: |
| 50 | +1. Navigate to your service in the ClickHouse Cloud console |
| 51 | +2. Go to **Settings** → **Security** |
| 52 | +3. Add Databrain's IP addresses to the allow list |
| 53 | + |
| 54 | +:::tip |
| 55 | +Refer to [Databrain's IP whitelisting documentation](https://docs.usedatabrain.com/guides/datasources/allow-access-to-our-ip) for the current list of IP addresses to whitelist. |
| 56 | +::: |
| 57 | + |
| 58 | +### 3. Add ClickHouse as a data source in Databrain {#3-add-clickhouse-as-a-data-source} |
| 59 | + |
| 60 | +1. Log in to your Databrain account and navigate to the workspace where you want to add the data source. |
| 61 | + |
| 62 | +2. Click on **Data Sources** in the navigation menu. |
| 63 | + |
| 64 | +<Image size="md" img={databrain_02} alt="Databrain data sources menu" border /> |
| 65 | + |
| 66 | +3. Click **Add a Data Source** or **Connect Data Source**. |
| 67 | + |
| 68 | +4. Select **ClickHouse** from the list of available connectors. |
| 69 | + |
| 70 | +<Image size="md" img={databrain_03} alt="Databrain connector selection showing ClickHouse option" border /> |
| 71 | + |
| 72 | +5. Fill in the connection details: |
| 73 | + - **Destination Name**: Enter a descriptive name for this connection (e.g., "Production ClickHouse" or "Analytics DB") |
| 74 | + - **Host**: Enter your ClickHouse host URL (e.g., `https://your-instance.region.aws.clickhouse.cloud`) |
| 75 | + - **Port**: Enter `8443` (default HTTPS port for ClickHouse) |
| 76 | + - **Username**: Enter your ClickHouse username |
| 77 | + - **Password**: Enter your ClickHouse password |
| 78 | + |
| 79 | +<Image size="md" img={databrain_04} alt="Databrain ClickHouse connection form with configuration fields" border /> |
| 80 | + |
| 81 | +6. Click **Test Connection** to verify that Databrain can connect to your ClickHouse instance. |
| 82 | + |
| 83 | +7. Once the connection is successful, click **Save** or **Connect** to add the data source. |
| 84 | + |
| 85 | +### 4. Configure user permissions {#4-configure-user-permissions} |
| 86 | + |
| 87 | +Ensure the ClickHouse user you're connecting with has the necessary permissions: |
| 88 | + |
| 89 | +```sql |
| 90 | +-- Grant permissions to read schema information |
| 91 | +GRANT SELECT ON information_schema.* TO your_databrain_user; |
| 92 | + |
| 93 | +-- Grant read access to your database and tables |
| 94 | +GRANT SELECT ON your_database.* TO your_databrain_user; |
| 95 | +``` |
| 96 | + |
| 97 | +Replace `your_databrain_user` and `your_database` with your actual username and database name. |
| 98 | + |
| 99 | +## Using Databrain with ClickHouse {#using-databrain-with-clickhouse} |
| 100 | + |
| 101 | +### Explore your data {#explore-your-data} |
| 102 | + |
| 103 | +1. After connecting, navigate to your workspace in Databrain. |
| 104 | + |
| 105 | +2. You'll see your ClickHouse tables listed in the data explorer. |
| 106 | + |
| 107 | +<Image size="md" img={databrain_05} alt="Databrain data explorer showing ClickHouse tables" border /> |
| 108 | + |
| 109 | +3. Click on a table to explore its schema and preview the data. |
| 110 | + |
| 111 | +### Create metrics and visualizations {#create-metrics-and-visualizations} |
| 112 | + |
| 113 | +1. Click **Create Metric** to start building visualizations from your ClickHouse data. |
| 114 | + |
| 115 | +2. Select your ClickHouse data source and choose the table you want to visualize. |
| 116 | + |
| 117 | +3. Use Databrain's intuitive interface to: |
| 118 | + - Select dimensions and measures |
| 119 | + - Apply filters and aggregations |
| 120 | + - Choose visualization types (bar charts, line charts, pie charts, tables, etc.) |
| 121 | + - Add custom SQL queries for advanced analysis |
| 122 | + |
| 123 | +4. Save your metric to reuse it across dashboards. |
| 124 | + |
| 125 | +### Build dashboards {#build-dashboards} |
| 126 | + |
| 127 | +1. Click **Create Dashboard** to start building a dashboard. |
| 128 | + |
| 129 | +2. Add metrics to your dashboard by dragging and dropping saved metrics. |
| 130 | + |
| 131 | +3. Customize the layout and appearance of your dashboard. |
| 132 | + |
| 133 | +<Image size="md" img={databrain_06} alt="Databrain dashboard with multiple ClickHouse visualizations" border /> |
| 134 | + |
| 135 | +4. Share your dashboard with your team or embed it in your application. |
| 136 | + |
| 137 | +### Advanced features {#advanced-features} |
| 138 | + |
| 139 | +Databrain offers several advanced features when working with ClickHouse: |
| 140 | + |
| 141 | +- **Custom SQL Console**: Write and execute custom SQL queries directly against your ClickHouse database |
| 142 | +- **Multi-tenancy and single-tenancy**: Connect your Clickhouse database, with both single-tenant and multi-tenant architectures |
| 143 | +- **Report Scheduling**: Schedule automated reports and email them to stakeholders |
| 144 | +- **AI-powered Insights**: Use AI to generate summaries and insights from your data |
| 145 | +- **Embedded Analytics**: Embed dashboards and metrics directly into your applications |
| 146 | +- **Semantic Layer**: Create reusable data models and business logic |
| 147 | + |
| 148 | +## Troubleshooting {#troubleshooting} |
| 149 | + |
| 150 | +### Connection fails {#connection-fails} |
| 151 | + |
| 152 | +If you're unable to connect to ClickHouse: |
| 153 | + |
| 154 | +1. **Verify credentials**: Double-check your username, password, and host URL |
| 155 | +2. **Check port**: Ensure you're using port `8443` for HTTPS (or `8123` for HTTP if not using SSL) |
| 156 | +3. **IP whitelisting**: Confirm that Databrain's IP addresses are whitelisted in your ClickHouse firewall/security settings |
| 157 | +4. **SSL/TLS**: Ensure SSL/TLS is properly configured if you're using HTTPS |
| 158 | +5. **User permissions**: Verify the user has SELECT permissions on `information_schema` and your target databases |
| 159 | + |
| 160 | +### Slow query performance {#slow-query-performance} |
| 161 | + |
| 162 | +If queries are running slowly: |
| 163 | + |
| 164 | +1. **Optimize your queries**: Use filters and aggregations efficiently |
| 165 | +2. **Create materialized views**: For frequently accessed aggregations, consider creating materialized views in ClickHouse |
| 166 | +3. **Use appropriate data types**: Ensure your ClickHouse schema uses optimal data types |
| 167 | +4. **Index optimization**: Leverage ClickHouse's primary keys and skipping indices |
| 168 | + |
| 169 | +## Learn more {#learn-more} |
| 170 | + |
| 171 | +For more information about Databrain features and how to build powerful analytics: |
| 172 | + |
| 173 | +- [Databrain Documentation](https://docs.usedatabrain.com/) |
| 174 | +- [ClickHouse Integration Guide](https://docs.usedatabrain.com/guides/datasources/connecting-data-sources-to-databrain/clickhouse) |
| 175 | +- [Creating Dashboards](https://docs.usedatabrain.com/guides/dashboards/create-a-dashboard) |
| 176 | +- [Building Metrics](https://docs.usedatabrain.com/guides/metrics/create-metrics) |
0 commit comments