Skip to content

Commit 7cdae53

Browse files
BohuTANGBohuTANG
authored
sql clients and visualize index.md (#2237)
1 parent 65d86d4 commit 7cdae53

File tree

12 files changed

+140
-12
lines changed

12 files changed

+140
-12
lines changed

‎docs/en/guides/30-sql-clients/01-jdbc/index.md

Lines changed: 92 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,106 @@
22
title: DBeaver
33
---
44

5+
import StepsWrap from '@site/src/components/StepsWrap';
6+
import StepContent from '@site/src/components/Steps/step-content';
7+
58
[DBeaver](https://dbeaver.com/) supports connecting to Databend using a built-in driver categorized under **Analytical**, available starting from **version 24.3.1**.
69

710
![](@site/static/img/connect/dbeaver.png)
811

12+
## Prerequisites
13+
14+
- DBeaver 24.3.1 or later version installed
15+
- For self-hosted Databend: [Docker](https://www.docker.com/) installed (if using Docker deployment)
16+
917
## User Authentication
1018

1119
If you are connecting to a self-hosted Databend instance, you can use the admin users specified in the [databend-query.toml](https://github.com/databendlabs/databend/blob/main/scripts/distribution/configs/databend-query.toml) configuration file, or you can connect using an SQL user created with the [CREATE USER](/sql/sql-commands/ddl/user/user-create-user) command.
1220

1321
For connections to Databend Cloud, you can use the default `cloudapp` user or an SQL user created with the [CREATE USER](/sql/sql-commands/ddl/user/user-create-user) command. Please note that the user account you use to log in to the [Databend Cloud console](https://app.databend.com/) cannot be used for connecting to Databend Cloud.
1422

15-
## Tutorials
23+
## Connecting to Self-Hosted Databend
24+
25+
<StepsWrap>
26+
<StepContent number="1">
27+
28+
### Start Databend (Docker)
29+
30+
Run the following command to launch a Databend instance:
31+
32+
:::note
33+
If no custom values for `QUERY_DEFAULT_USER` or `QUERY_DEFAULT_PASSWORD` are specified when starting the container, a default `root` user will be created with no password.
34+
:::
35+
36+
```bash
37+
docker run -d --name databend \
38+
-p 3307:3307 -p 8000:8000 -p 8124:8124 -p 8900:8900 \
39+
datafuselabs/databend:nightly
40+
```
41+
42+
</StepContent>
43+
<StepContent number="2">
44+
45+
### Configure Connection
46+
47+
1. In DBeaver, go to **Database** > **New Database Connection** to open the connection wizard, then select **Databend** under the **Analytical** category.
48+
49+
![alt text](@site/static/img/connect/dbeaver-analytical.png)
50+
51+
2. Enter `root` for the **Username** (or your configured username).
52+
53+
![alt text](@site/static/img/connect/dbeaver-user-root.png)
54+
55+
3. Click **Test Connection** to verify the connection. If this is your first time connecting to Databend, you will be prompted to download the driver. Click **Download** to proceed.
56+
57+
![alt text](@site/static/img/connect/dbeaver-download-driver.png)
58+
59+
Once the download is complete, the test connection should succeed:
60+
61+
![alt text](@site/static/img/connect/dbeaver-success.png)
62+
63+
</StepContent>
64+
</StepsWrap>
65+
66+
## Connecting to Databend Cloud
67+
68+
<StepsWrap>
69+
<StepContent number="1">
70+
71+
### Obtain Connection Information
72+
73+
Log in to Databend Cloud to obtain connection information. For more information, see [Connecting to a Warehouse](/guides/cloud/using-databend-cloud/warehouses#connecting).
74+
75+
![alt text](@site/static/img/connect/dbeaver-connect-info.png)
76+
77+
:::note
78+
If your `user` or `password` contains special characters, you need to provide them separately in the corresponding fields (e.g., the `Username` and `Password` fields in DBeaver). In this case, Databend will handle the necessary encoding for you. However, if you're providing the credentials together (e.g., as `user:password`), you must ensure that the entire string is properly encoded before use.
79+
:::
80+
81+
</StepContent>
82+
<StepContent number="2">
83+
84+
### Configure Connection
85+
86+
1. In DBeaver, go to **Database** > **New Database Connection** to open the connection wizard, then select **Databend** under the **Analytical** category.
87+
88+
![alt text](@site/static/img/connect/dbeaver-analytical.png)
89+
90+
2. In the **Main** tab, enter the **Host**, **Port**, **Username**, and **Password** based on the connection information obtained in the previous step.
91+
92+
![alt text](@site/static/img/connect/dbeaver-main-tab.png)
93+
94+
3. In the **Driver properties** tab, enter the **Warehouse** name based on the connection information obtained in the previous step.
95+
96+
![alt text](@site/static/img/connect/dbeaver-driver-properties.png)
97+
98+
4. In the **SSL** tab, select the **Use SSL** checkbox.
99+
100+
![alt text](@site/static/img/connect/dbeaver-use-ssl.png)
101+
102+
5. Click **Test Connection** to verify the connection. If this is your first time connecting to Databend, you will be prompted to download the driver. Click **Download** to proceed. Once the download is complete, the test connection should succeed:
103+
104+
![alt text](@site/static/img/connect/dbeaver-cloud-success.png)
16105

17-
- [Connecting to Databend using DBeaver](/tutorials/connect/connect-to-databend-dbeaver)
18-
- [Connecting to Databend Cloud using DBeaver](/tutorials/connect/connect-to-databendcloud-dbeaver)
106+
</StepContent>
107+
</StepsWrap>

‎docs/en/guides/30-sql-clients/index.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,29 @@
11
---
22
title: Connect to Databend
33
---
4-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
54

6-
This guide outlines various methods to connect to Databend:
5+
Databend supports multiple connection methods to suit different use cases. Choose the method that best fits your needs:
76

8-
<IndexOverviewList />
7+
## SQL Clients & Tools
8+
9+
| Client | Type | Best For | Key Features |
10+
|--------|------|----------|--------------|
11+
| **[BendSQL](/guides/sql-clients/bendsql)** | Command Line | Developers, Scripts | Native CLI, Rich formatting, Multiple install options |
12+
| **[DBeaver](/guides/sql-clients/jdbc)** | GUI Application | Data Analysis, Visual Queries | Built-in driver, Cross-platform, Query builder |
13+
14+
## Developer Drivers
15+
16+
| Language | Driver | Use Case | Documentation |
17+
|----------|--------|----------|---------------|
18+
| **Go** | Native Driver | Backend Applications | [Golang Guide](/guides/sql-clients/developers/golang) |
19+
| **Python** | Python Connector | Data Science, Analytics | [Python Guide](/guides/sql-clients/developers/python) |
20+
| **Node.js** | JavaScript Driver | Web Applications | [Node.js Guide](/guides/sql-clients/developers/nodejs) |
21+
| **Java** | JDBC Driver | Enterprise Applications | [JDBC Guide](/guides/sql-clients/developers/jdbc) |
22+
| **Rust** | Native Driver | System Programming | [Rust Guide](/guides/sql-clients/developers/rust) |
23+
24+
## Connection Methods
25+
26+
| Method | Security Level | Use Case | Setup Complexity |
27+
|--------|----------------|----------|------------------|
28+
| **Direct Connection** | Standard | Development, Testing | ⭐ Simple |
29+
| **[AWS PrivateLink](/guides/sql-clients/privatelink)** | High | Production, Enterprise | ⭐⭐⭐ Advanced |

‎docs/en/guides/31-visualize/deepnote.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Deepnote
3+
sidebar_position: 5
34
---
45

56
[Deepnote](https://deepnote.com) allows you to easily work on your data science projects, together in real-time and in one place with your friends and colleagues; helping you turn your ideas and analyses into products faster. Deepnote is built for the browser so you can use it across any platform (Windows, Mac, Linux or Chromebook). No downloads required, with updates shipped to you daily. All changes are instantly saved.

‎docs/en/guides/31-visualize/grafana.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Grafana
3+
sidebar_position: 1
34
---
45

56
[Grafana](https://grafana.com/) is a monitoring dashboard system, which is an open-source monitoring tool developed by Grafana Labs. It can greatly simplify the complexity of monitoring by allowing us to provide the data to be monitored, and it generates various visualizations. Additionally, it has an alarm function that sends notifications when there is an issue with the system. Databend and Databend Cloud can integrate with Grafana through the [Grafana Databend Data Source Plugin](https://github.com/databendlabs/grafana-databend-datasource).

‎docs/en/guides/31-visualize/index.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
---
22
title: Visualize
33
---
4-
import IndexOverviewList from '@site/src/components/IndexOverviewList';
54

6-
<IndexOverviewList />
5+
Databend supports integration with various visualization tools to help you analyze and present your data effectively. The following table lists some popular tools and their respective guides:
6+
7+
| Tool | Description | Guide |
8+
| :--- | :---------- | :---- |
9+
| [Grafana](https://grafana.com/) | An open-source platform for monitoring and observability, allowing you to create dashboards and visualize metrics. | [Connect to Grafana](/guides/visualize/grafana) |
10+
| [Tableau](https://www.tableau.com/) | A powerful data visualization tool that helps you see and understand your data. | [Connect to Tableau](/guides/visualize/tableau) |
11+
| [Superset](https://superset.apache.org/) | An open-source data exploration and visualization web application. | [Connect to Superset](/guides/visualize/superset) |
12+
| [Metabase](https://www.metabase.com/) | An open-source business intelligence tool that lets you create dashboards and charts. | [Connect to Metabase](/guides/visualize/metabase) |
13+
| [Deepnote](https://deepnote.com) | A collaborative data science notebook that allows real-time collaboration. | [Connect to Deepnote](/guides/visualize/deepnote) |
14+
| [Jupyter Notebook](https://jupyter.org) | A web-based interactive computing platform for creating and sharing documents containing live code, equations, visualizations, and narrative text. | [Connect to Jupyter Notebook](/guides/visualize/jupyter) |
15+
| [MindsDB](https://mindsdb.com/) | An open-source machine learning platform that brings ML capabilities into databases. | [Connect to MindsDB](/guides/visualize/mindsdb) |
16+
| [Redash](https://redash.io/) | A data visualization platform that enables you to explore, query, visualize, and share data from any data sources. | [Connect to Redash](/guides/visualize/redash) |

‎docs/en/guides/31-visualize/jupyter.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Jupyter Notebook
3+
sidebar_position: 6
34
---
45

56
[Jupyter Notebook](https://jupyter.org) is a web-based interactive application that enables you to create notebook documents that feature live code, interactive plots, widgets, equations, images, etc., and share these documents easily. It is also quite versatile as it can support many programming languages via kernels such as Julia, Python, Ruby, Scala, Haskell, and R.

‎docs/en/guides/31-visualize/metabase.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Metabase
3+
sidebar_position: 4
34
---
45

56
[Metabase](https://www.metabase.com/) is an open-source business intelligence platform. You can use Metabase to ask questions about your data, or embed Metabase in your app to let your customers explore their data on their own.

‎docs/en/guides/31-visualize/mindsdb.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: MindsDB
3+
sidebar_position: 7
34
---
45

56
Data that lives in your database is a valuable asset. [MindsDB](https://mindsdb.com/) enables you to use your data and make forecasts. It speeds up the ML development process by bringing machine learning into the database. With MindsDB, you can build, train, optimize, and deploy your ML models without the need for other platforms.

‎docs/en/guides/31-visualize/redash.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Redash
3+
sidebar_position: 8
34
---
45

56
[Redash](https://redash.io/) is designed to enable anyone, regardless of the level of technical sophistication, to harness the power of data big and small. SQL users leverage Redash to explore, query, visualize, and share data from any data sources. Their work in turn enables anybody in their organization to use the data. Every day, millions of users at thousands of organizations around the world use Redash to develop insights and make data-driven decisions.

‎docs/en/guides/31-visualize/superset.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Superset
3+
sidebar_position: 3
34
---
45
import StepsWrap from '@site/src/components/StepsWrap';
56
import StepContent from '@site/src/components/Steps/step-content';

‎docs/en/guides/31-visualize/tableau.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Tableau
3+
sidebar_position: 2
34
---
45

56
[Tableau](https://www.tableau.com/) is a visual analytics platform transforming the way we use data to solve problems—empowering people and organizations to make the most of their data. By leveraging the [databend-jdbc driver](https://github.com/databendcloud/databend-jdbc) (version 0.3.4 or higher), both Databend and Databend Cloud can integrate with Tableau, enabling seamless data access and efficient analysis. It is important to note that for optimal compatibility, it is advisable to use Tableau version 2022.3 or higher to avoid potential compatibility issues.

‎docs/en/guides/54-query/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Databend supports standard SQL with ANSI SQL:1999 and SQL:2003 analytic extensio
1010
|---------|-------------|--------------|
1111
| [**Common Table Expressions (CTE)**](00-cte.md) | Define named temporary result sets with WITH clause | Improved query readability, reusable subqueries |
1212
| [**JOIN**](02-join.md) | Combine data from multiple tables | Support for Inner, Outer, Cross, Semi, and Anti joins |
13-
| [**GROUP BY Operations**](01-groupby/index.md) | Group and aggregate data with extensions | CUBE, ROLLUP, and GROUPING SETS support |
13+
| [**GROUP BY**](01-groupby/index.md) | Group and aggregate data with extensions | CUBE, ROLLUP, and GROUPING SETS support |
1414
| [**Sequence**](02-sequences.md) | Generate sequential numeric values | Auto-incrementing identifiers and counters |
1515

1616
## Advanced Query Capabilities
@@ -39,9 +39,9 @@ Databend supports standard SQL with ANSI SQL:1999 and SQL:2003 analytic extensio
3939

4040
## Quick Start Guide
4141

42-
1. **Basic Queries**: Start with [JOINs](02-join.md) and [GROUP BY](01-groupby/index.md) for fundamental data operations
43-
2. **Advanced Logic**: Use [CTEs](00-cte.md) for complex query structures
44-
3. **Custom Functions**: Implement [UDFs](03-udf.md) for specialized data processing
42+
1. **Basic Queries**: Start with [JOIN](02-join.md) and [GROUP BY](01-groupby/index.md) for fundamental data operations
43+
2. **Advanced Logic**: Use [CTE](00-cte.md) for complex query structures
44+
3. **Custom Functions**: Implement [UDF](03-udf.md) for specialized data processing
4545
4. **Performance**: Leverage [Query Profile](05-query-profile.md) for optimization insights
4646
5. **External Data**: Integrate external sources with [Dictionary](07-dictionary.md)
4747

0 commit comments

Comments
 (0)