docs: bendsql dsn (#1950)

* dsn

* Update index.md

* Update migrating-from-mysql-with-db-archiver.md

* Update index.md

Author: soyeric128

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

@@ -147,6 +147,98 @@ If you are connecting to a self-hosted Databend instance, you can use the admin
 
 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.
 
+## Connecting with BendSQL
+
+BendSQL allows you to connect to both Databend Cloud and self-hosted Databend instances.
+
+### Customize Connections with a DSN 
+
+A DSN (Data Source Name) is a simple yet powerful way to configure and manage your Databend connection in BendSQL using a single URI-style string. This method allows you to embed your credentials and connection settings directly into your environment, streamlining the connection process.
+
+#### DSN Format and Parmaeters
+
+```bash title='DSN Format'
+databend[+flight]://user[:password]@host[:port]/[database][?sslmode=disable][&arg1=value1]
+```
+
+| Common DSN Parameters | Description                          |
+|-----------------------|--------------------------------------|
+| `tenant`              | Tenant ID, Databend Cloud only.      |
+| `warehouse`           | Warehouse name, Databend Cloud only. |
+| `sslmode`             | Set to `disable` if not using TLS.   |
+| `tls_ca_file`         | Custom root CA certificate path.     |
+| `connect_timeout`     | Connect timeout in seconds.          |
+
+| RestAPI Client Parameters   | Description                                                                                                                   |
+|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------|
+| `wait_time_secs`            | Request wait time for page, default is `1`.                                                                                   |
+| `max_rows_in_buffer`        | Maximum rows for page buffer.                                                                                                 |
+| `max_rows_per_page`         | Maximum response rows for a single page.                                                                                      |
+| `page_request_timeout_secs` | Timeout for a single page request, default is `30`.                                                                           |
+| `presign`                   | Enable presign for data loading. Options: `auto`, `detect`, `on`, `off`. Default is `auto` (only enabled for Databend Cloud). |
+
+| FlightSQL Client Parameters | Description                                                          |
+|-----------------------------|----------------------------------------------------------------------|
+| `query_timeout`             | Query timeout in seconds.                                            |
+| `tcp_nodelay`               | Defaults to `true`.                                                  |
+| `tcp_keepalive`             | TCP keepalive in seconds (default is `3600`, set to `0` to disable). |
+| `http2_keep_alive_interval` | Keep-alive interval in seconds, default is `300`.                    |
+| `keep_alive_timeout`        | Keep-alive timeout in seconds, default is `20`.                      |
+| `keep_alive_while_idle`     | Defaults to `true`.                                                  |
+
+#### DSN Examples
+
+```bash
+# Local connection using HTTP API with presign detection
+databend://root:@localhost:8000/?sslmode=disable&presign=detect
+
+# Databend Cloud connection with tenant and warehouse info
+databend://user1:[email protected]:443/benchmark?enable_dphyp=1
+
+# Local connection using FlightSQL API
+databend+flight://root:@localhost:8900/database1?connect_timeout=10
+```
+
+### Connect to Databend Cloud
+
+The best practice for connecting to Databend Cloud is to obtain your DSN from Databend Cloud and export it as an environment variable. To obtain your DSN:
+
+1. Log in to Databend Cloud and click **Connect** on the **Overview** page.
+
+2. Select the database and warehouse you want to connect to.
+
+3. Your DSN will be automatically generated in the **Examples** section. Below the DSN, you'll find a BendSQL snippet that exports the DSN as an environment variable named `BENDSQL_DSN` and launches BendSQL with the correct configuration. You can copy and paste it directly into your terminal.
+
+  ```bash title='Example'
+  export BENDSQL_DSN="databend://cloudapp:******@tn3ftqihs.gw.aws-us-east-2.default.databend.com:443/information_schema?warehouse=small-xy2t"
+  bendsql
+  ```
+
+### Connect to Self-hosted Databend
+
+You can connect to a self-hosted Databend instance using either BendSQL command-line arguments or a DSN.
+
+#### Option 1: Use BendSQL Arguments
+
+```bash
+bendsql --host <HOST> --port <PORT> --user <USER> --password <PASSWORD> --database <DATABASE>
+```
+
+This example connects to a Databend instance running locally on port `8000` using `eric` as the user:
+
+```bash title='Example'
+bendsql --host 127.0.0.1 --port 8000 --user eric --password abc123
+```
+
+#### Option 2: Use a DSN
+
+You can also define the connection using a DSN and export it as the `BENDSQL_DSN` environment variable:
+
+```bash title='Example'
+export BENDSQL_DSN="databend://eric:abc123@localhost:8000/?sslmode=disable"
+bendsql
+```
+
 ## Tutorials
 
 - [Connecting to Self-Hosted Databend using BendSQL](/tutorials/)

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

@@ -7,53 +7,92 @@ slug: /
 import StepsWrap from '@site/src/components/StepsWrap';
 import StepContent from '@site/src/components/Steps/step-content';
 
-In this tutorial, we will guide you through the process of connecting to a self-hosted Databend instance using BendSQL as the user `root`.
+In this tutorial, we will guide you through the process of connecting to a self-hosted Databend instance using BendSQL.
 
 <StepsWrap>
 <StepContent number="1">
 
 ### Before You Start
 
+- Ensure that [Docker](https://www.docker.com/) is installed on your local machine, as it will be used to launch Databend.
 - Ensure that BendSQL is installed on your machine. See [Installing BendSQL](/guides/sql-clients/bendsql/#installing-bendsql) for instructions on how to install BendSQL using various package managers.
-- Ensure that your Databend instance has started up successfully.
-- In this tutorial, you will use the `root` account to connect to Databend. During deployment, uncomment the following lines in the [databend-query.toml](https://github.com/databendlabs/databend/blob/main/scripts/distribution/configs/databend-query.toml) configuration file to select this account:
-
-  ```sql title="databend-query.toml"
-  [[query.users]]
-  name = "root"
-  auth_type = "no_password"
-  ```
 
 </StepContent>
 <StepContent number="2">
 
-### Launch BendSQL
+### Start Databend
 
-To launch BendSQL, enter `bendsql` directly into your terminal or command prompt.
+Run the following command in your terminal to launch a Databend instance:
 
-:::note
-The command `bendsql` launches and connects BendSQL to the local Databend at 127.0.0.1 using the `root` user without requiring a password. If you wish to connect to a local Databend with a different user, such as 'eric' with the password 'abc123', use the command `bendsql --user eric --password abc123`. To view all available arguments and their default values, type `bendsql --help`.
-:::
+```bash
+docker run -d --name databend \
+  -e QUERY_DEFAULT_USER=eric \
+  -e QUERY_DEFAULT_PASSWORD=abc123 \
+  -p 3307:3307 -p 8000:8000 -p 8124:8124 -p 8900:8900 \
+  datafuselabs/databend:nightly
+```
 
-![Alt text](/img/connect/bendsql-1.gif)
+This command starts a Databend instance locally in a Docker container with the following connection info:
+
+- Host: `127.0.0.1`
+- Port: `8000`
+- User: `eric`
+- Password: `abc123`
 
 </StepContent>
 <StepContent number="3">
 
+### Launch BendSQL
+
+Once the Databend instance is running, you can connect to it using BendSQL. Open a terminal and use the following command to connect:
+
+```bash
+bendsql --host 127.0.0.1 --port 8000 --user eric --password abc123
+```
+
+This will connect to Databend using the HTTP API at `127.0.0.1:8000` with the user `eric` and the password `abc123`. After running this command, you should see a successful connection message, like the one below:
+
+```bash
+Welcome to BendSQL 0.24.7-ff9563a(2024-12-27T03:23:17.723492000Z).
+Connecting to 127.0.0.1:8000 as user eric.
+Connected to Databend Query v1.2.725-nightly-25ee2d6e65(rust-1.88.0-nightly-2025-04-16T13:54:25.363718584Z)
+Loaded 1432 auto complete keywords from server.
+Started web server at 127.0.0.1:8080
+```
+
+</StepContent>
+<StepContent number="4">
+
 ### Execute Queries
 
 Once connected, you can execute SQL queries in the BendSQL shell. For instance, type `SELECT NOW();` to return the current time:
 
-![Alt text](/img/connect/bendsql-2.gif)
+```bash
+[email protected]:8000/default> SELECT NOW();
+
+SELECT NOW()
+
+┌────────────────────────────┐
+│            now()           │
+│          Timestamp         │
+├────────────────────────────┤
+│ 2025-04-24 13:24:06.640616 │
+└────────────────────────────┘
+1 row read in 0.025 sec. Processed 1 row, 1 B (40 rows/s, 40 B/s)
+```
 
 </StepContent>
-<StepContent number="4">
+<StepContent number="5">
 
 ### Quit BendSQL
 
 To quit BendSQL, type `quit`.
 
-![Alt text](/img/connect/bendsql-3.gif)
+```bash
+[email protected]:8000/default> quit
+Bye~
+➜  ~
+```
 
 </StepContent>
 </StepsWrap>

docs/en/tutorials/migrate/migrating-from-mysql-with-db-archiver.md

@@ -126,7 +126,6 @@ Download the db-archiver from the [release page](https://github.com/databendclou
 
 ```json
 {
-    // Replace the placeholders with your actual values:
     "sourceHost": "127.0.0.1",
     "sourcePort": 3306,
     "sourceUser": "root",