Skip to content

Commit 76f48b2

Browse files
docs: user authentication for connecting to Databend (#1045)
* added * updates --------- Co-authored-by: Quan <[email protected]>
1 parent 595d072 commit 76f48b2

File tree

5 files changed

+21
-9
lines changed

5 files changed

+21
-9
lines changed

docs/en/guides/30-sql-clients/00-bendsql/index.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,15 @@ When building from source, some dependencies may involve compiling C/C++ code. E
6666
cargo install bendsql
6767
```
6868

69+
## User Authentication
70+
71+
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/datafuselabs/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.
72+
73+
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.
74+
6975
## Tutorials
7076

71-
- [Connecting to Databend using BendSQL](/tutorials/)
77+
- [Connecting to Self-Hosted Databend using BendSQL](/tutorials/)
7278
- [Connecting to Databend Cloud using BendSQL](/tutorials/connect/connect-to-databendcloud-bendsql)
7379

7480
## BendSQL Settings

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,12 @@ Databend recommends updating to the latest version of the Databend JDBC driver t
4141

4242
4. Click **OK** to close the windows.
4343

44+
## User Authentication
45+
46+
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/datafuselabs/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.
47+
48+
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.
49+
4450
## Tutorials
4551

4652
- [Connecting to Databend using DBeaver](/tutorials/connect/connect-to-databend-dbeaver)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ title: Connect to Databend
33
---
44
import IndexOverviewList from '@site/src/components/IndexOverviewList';
55

6-
To connect effortlessly to Databend and Databend Cloud, BendSQL is recommended. It offers a user-friendly experience, streamlining the connection process.
6+
To connect effortlessly to a self-hosted Databend instance or Databend Cloud, BendSQL is recommended. It offers a user-friendly experience, streamlining the connection process.
77

8-
Alternatively, you can also leverage Databend's JDBC driver for a more customizable integration. Explore the following links to get started:
8+
Alternatively, you can leverage Databend's JDBC driver to connect with other SQL clients. Explore the following links to get started:
99

1010
<IndexOverviewList />

docs/en/tutorials/connect/connect-to-databend-bendsql.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: 'Connecting to Databend using BendSQL'
3-
sidebar_label: 'Connecting to Databend (BendSQL)'
2+
title: 'Connecting to Self-Hosted Databend using BendSQL'
3+
sidebar_label: 'Connecting to Self-Hosted Databend (BendSQL)'
44
slug: /
55
---
66
import StepsWrap from '@site/src/components/StepsWrap';
77
import StepContent from '@site/src/components/Steps/step-content';
88

9-
In this tutorial, we will guide you through the process of connecting to Databend using BendSQL as the user `root`.
9+
In this tutorial, we will guide you through the process of connecting to a self-hosted Databend instance using BendSQL as the user `root`.
1010

1111
<StepsWrap>
1212
<StepContent number="1">

docs/en/tutorials/connect/connect-to-databend-dbeaver.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: "Connecting to Databend using DBeaver"
3-
sidebar_label: "Connecting to Databend (DBeaver)"
2+
title: "Connecting to Self-Hosted Databend using DBeaver"
3+
sidebar_label: "Connecting to Self-Hosted Databend (DBeaver)"
44
---
55

66
import StepsWrap from '@site/src/components/StepsWrap';
77
import StepContent from '@site/src/components/Steps/step-content';
88

9-
In this tutorial, we will guide you through the process of connecting to Databend through the Databend JDBC driver as the user `root`.
9+
In this tutorial, we will guide you through the process of connecting to a self-hosted Databend instance through the Databend JDBC driver as the user `root`.
1010

1111
<StepsWrap>
1212
<StepContent number="1">

0 commit comments

Comments
 (0)