diff --git a/docs/en/integrations/data-visualization.md b/docs/en/integrations/data-visualization.md index 39aa0892a77..45231fada28 100644 --- a/docs/en/integrations/data-visualization.md +++ b/docs/en/integrations/data-visualization.md @@ -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 @@ -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) @@ -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 | ✅ | ✅ | | diff --git a/docs/en/integrations/data-visualization/images/luzmo_01.png b/docs/en/integrations/data-visualization/images/luzmo_01.png new file mode 100644 index 00000000000..cff278088ca Binary files /dev/null and b/docs/en/integrations/data-visualization/images/luzmo_01.png differ diff --git a/docs/en/integrations/data-visualization/images/luzmo_02.png b/docs/en/integrations/data-visualization/images/luzmo_02.png new file mode 100644 index 00000000000..f8d3e4fef82 Binary files /dev/null and b/docs/en/integrations/data-visualization/images/luzmo_02.png differ diff --git a/docs/en/integrations/data-visualization/images/luzmo_03.png b/docs/en/integrations/data-visualization/images/luzmo_03.png new file mode 100644 index 00000000000..0a32f00e59c Binary files /dev/null and b/docs/en/integrations/data-visualization/images/luzmo_03.png differ diff --git a/docs/en/integrations/data-visualization/luzmo-and-clickhouse.md b/docs/en/integrations/data-visualization/luzmo-and-clickhouse.md new file mode 100644 index 00000000000..117bc4169ec --- /dev/null +++ b/docs/en/integrations/data-visualization/luzmo-and-clickhouse.md @@ -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. + +

+ Create a ClickHouse connection +

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

+ Provide ClickHouse connection details +

+ +* **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. + +

+ Luzmo dashboard example +

+ +## 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 | \ No newline at end of file diff --git a/docs/en/integrations/images/logos/luzmo.png b/docs/en/integrations/images/logos/luzmo.png new file mode 100644 index 00000000000..14588abbf35 Binary files /dev/null and b/docs/en/integrations/images/logos/luzmo.png differ diff --git a/docs/en/integrations/index.mdx b/docs/en/integrations/index.mdx index d1b74975772..51c2733878a 100644 --- a/docs/en/integrations/index.mdx +++ b/docs/en/integrations/index.mdx @@ -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||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|Luzmo logo|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|Metaplane logo|Data Ingestion|Open-source data pipeline tool for transforming and integrating data|[Documentation](https://docs.mage.ai/integrations/databases/ClickHouse) |Metaplane|Metaplane logo|Data management|Data observability for every data team|[Website](https://www.metaplane.dev/integrations)| |MindsDB|MindsDB logo|AI/ML| The platform for customizing AI from enterprise data |[Website](https://mindsdb.com/clickhouse-machine-learning )|