Skip to content

Commit

Permalink
Add Luzmo to data visualization integrations
Browse files Browse the repository at this point in the history
  • Loading branch information
Kagaherk committed Nov 29, 2024
1 parent 7226f5e commit fe80ab9
Show file tree
Hide file tree
Showing 7 changed files with 67 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/en/integrations/data-visualization.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_label: Overview
sidebar_position: 1
keywords: [clickhouse, connect, explo, tableau, grafana, metabase, mitzu, superset, deepnote, draxlr, rocketbi, omni, bi, visualization, tool]
keywords: [clickhouse, connect, luzmo, explo, tableau, grafana, metabase, mitzu, superset, deepnote, draxlr, rocketbi, omni, bi, visualization, tool]
---

# Visualizing Data in ClickHouse
Expand All @@ -28,6 +28,7 @@ Now that your data is in ClickHouse, it's time to analyze it, which often involv
- [Explo](./data-visualization/explo-and-clickhouse.md)
- [Grafana](./data-visualization/grafana/index.md)
- [Looker](./data-visualization/looker-and-clickhouse.md)
- [Luzmo](data-visualization/luzmo-and-clickhouse.md)
- [Metabase](./data-visualization/metabase-and-clickhouse.md)
- [Mitzu](./data-visualization/mitzu-and-clickhouse.md)
- [Omni](./data-visualization/omni-and-clickhouse.md)
Expand All @@ -49,6 +50,7 @@ Now that your data is in ClickHouse, it's time to analyze it, which often involv
| [Hashboard](./data-visualization/hashboard-and-clickhouse.md) | Native connector ||| |
| [Looker](./data-visualization/looker-and-clickhouse.md) | Native connector ||| Works with some limitations, see [the documentation](./data-visualization/looker-and-clickhouse.md) for more details |
| Looker | MySQL interface | 🚧 || |
| [Luzmo](./data-visualization/luzmo-and-clickhouse.md) | ClickHouse official connector ||| |
| [Looker Studio](./data-visualization/looker-studio-and-clickhouse.md) | MySQL interface ||| |
| [Metabase](./data-visualization/metabase-and-clickhouse.md) | ClickHouse official connector |||
| [Mitzu](./data-visualization/mitzu-and-clickhouse.md) | Native connector ||| |
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.
63 changes: 63 additions & 0 deletions docs/en/integrations/data-visualization/luzmo-and-clickhouse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
sidebar_label: Luzmo
slug: /en/integrations/luzmo
keywords: [ clickhouse, luzmo, connect, integrate, ui, embedded ]
description: Luzmo is an embedded analytics platform with a native ClickHouse integration, purpose-built for Software and SaaS applications.
---
import ConnectionDetails from '@site/docs/en/_snippets/_gather_your_details_http.mdx';

# Integrating Luzmo with ClickHouse

## 1. Setup a ClickHouse connection

To make a connection to ClickHouse, navigate to the **Connections page**, select **New Connection**, then select the ClickHouse from the New Connection modal.

<p>
<img src={require('./images/luzmo_01.png').default} class="image" alt="Create a ClickHouse connection" />
</p>

You'll be asked to provide a **host**, **username** and **password**:

<p>
<img src={require('./images/luzmo_02.png').default} class="image" alt="Provide ClickHouse connection details" />
</p>

* **Host**: this is the host where your ClickHouse database is exposed. Note that only `https` is allowed here in order to securely transfer data over the wire. The structure of the host url expects: `https://url-to-clickhouse-db:port/database`
By default, the plugin will connect to the 'default' database and the 443 port. By providing a database after the '/' you can configure which database to connect to.
* **Username**: the username that will be used to connect to your ClickHouse cluster.
* **Password**: the password to connect to your ClickHouse cluster

Please refer to the examples in our developer documentation to find out how to [create a connection to ClickHouse](https://developer.luzmo.com/api/createAccount?exampleSection=AccountCreateClickhouseRequestBody) via our API.

## 2. Add datasets

Once you have connected your ClickHouse you can add datasets as explained [here](https://academy.luzmo.com/article/ldx3iltg). You can select one or multiple datasets as available in your ClickHouse and [link](https://academy.luzmo.com/article/gkrx48x5) them in Luzmo to ensure they can be used together in a dashboard. Also make sure to check out this article on [Preparing your data for analytics](https://academy.luzmo.com/article/u492qov0).

To find out how to add datasets using our API, please refer to [this example in our developer documentation](https://developer.luzmo.com/api/createDataprovider?exampleSection=DataproviderCreateClickhouseRequestBody).

You can now use your datasets to build beautiful (embedded) dashboards, or even power an AI Data Analyst ([Luzmo IQ](https://luzmo.com/iq)) that can answer your clients' questions.

<p>
<img src={require('./images/luzmo_03.png').default} class="image" alt="Luzmo dashboard example" />
</p>

## Usage notes

1. The Luzmo ClickHouse connector uses the HTTP API interface (typically running on port 8123) to connect.
2. If you use tables with the `Distributed` table engine some Luzmo-charts might fail when `distributed_product_mode` is `deny`. This should only occur, however, if you link the table to another table and use that link in a chart. In that case make sure to set the `distributed_product_mode` to another option that makes sense for you within your ClickHouse cluster. If you are using ClickHouse Cloud you can safely ignore this setting.
3. To ensure that e.g. only the Luzmo application can access your ClickHouse instance, it is highly recommended to **whitelist** [Luzmo's range of static IP addresses](https://academy.luzmo.com/article/u9on8gbm). We also recommend using a technical read-only user.
4. The ClickHouse connector currently supports following data types:

| ClickHouse Type | Luzmo Type |
| --- | --- |
| UInt | numeric |
| Int | numeric |
| Float | numeric |
| Decimal | numeric |
| Date | datetime |
| DateTime | datetime |
| String | hierarchy |
| Enum | hierarchy |
| FixedString | hierarchy |
| UUID | hierarchy |
| Bool | hierarchy |
Binary file added docs/en/integrations/images/logos/luzmo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/en/integrations/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,7 @@ We are actively compiling this list of ClickHouse integrations below, so it's no
|IBM Instana| |Data management|Instana can auto-discover and monitor ClickHouse server processes|[Documentation](https://www.ibm.com/docs/en/instana-observability/current?topic=technologies-monitoring-clickhouse)|
|Jitsu|<JitsuSVG style={{width: '3rem'}} />|Data analytics|An open-source event collection platform.|[Documentation](https://classic.jitsu.com/docs/destinations-configuration/clickhouse-destination)|
|LangChain|🦜️🔗|SDK|LangChain is a framework for developing applications powered by language models|[Documentation](https://python.langchain.com/v0.2/docs/integrations/vectorstores/clickhouse/)|
|Luzmo|<img src={require('./images/logos/luzmo.png').default} class="image" alt="Luzmo logo" style={{width: '3rem', 'background-color': 'transparent'}}/>|Data visualization|Luzmo is an embedded analytics platform with a native ClickHouse integration, purpose-built for Software and SaaS applications.|[Documentation](/docs/en/integrations/data-visualization/luzmo-and-clickhouse.md)|
|Mage|<img src={require('./images/logos/mage.jpg').default} class="image" alt="Metaplane logo" style={{width: '3rem', 'background-color': 'transparent'}}/>|Data Ingestion|Open-source data pipeline tool for transforming and integrating data|[Documentation](https://docs.mage.ai/integrations/databases/ClickHouse)
|Metaplane|<img src={require('./images/logos/logo_metaplane.png').default} class="image" alt="Metaplane logo" style={{width: '3rem', 'background-color': 'transparent'}}/>|Data management|Data observability for every data team|[Website](https://www.metaplane.dev/integrations)|
|MindsDB|<img src={require('./images/logos/logo_mindsdb.png').default} class="image" alt="MindsDB logo" style={{width: '3rem', 'background-color': 'transparent'}}/>|AI/ML| The platform for customizing AI from enterprise data |[Website](https://mindsdb.com/clickhouse-machine-learning )|
Expand Down

0 comments on commit fe80ab9

Please sign in to comment.