Skip to content

Commit 47836ce

Browse files
author
github-actions
committed
update MD by dispatch event pingcap/docs feature/preview-cloud-lake
1 parent 6ecf613 commit 47836ce

30 files changed

+164
-180
lines changed

‎markdown-pages/en/tidb/release-8.5/TOC-tidb-cloud-lake.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
- [BendSQL](/tidb-cloud-lake/guides/connect-using-bendsql.md)
3434
- [DBeaver](/tidb-cloud-lake/guides/connect-using-dbeaver.md)
3535
- Drivers
36+
- [Overview](/tidb-cloud-lake/guides/driver-overview.md)
3637
- [Golang](/tidb-cloud-lake/guides/connect-using-golang.md)
3738
- [Java](/tidb-cloud-lake/guides/connect-using-java.md)
3839
- [Node.js](/tidb-cloud-lake/guides/connect-using-node-js.md)

‎markdown-pages/en/tidb/release-8.5/tidb-cloud-lake/guides/connect-using-bendsql.md‎

Lines changed: 29 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: BendSQL
3-
summary: BendSQL is a command line tool that has been designed specifically for Databend. It allows users to establish a connection with Databend and execute queries directly from a CLI window.
3+
summary: BendSQL is a command line tool that has been designed specifically for TiDB Cloud Lake. It allows users to establish a connection with TiDB Cloud Lake and execute queries directly from a CLI window.
44
---
55

66
# BendSQL
77

8-
[BendSQL](https://github.com/databendlabs/bendsql) is a command line tool that has been designed specifically for Databend. It allows users to establish a connection with Databend and execute queries directly from a CLI window.
8+
[BendSQL](https://github.com/databendlabs/bendsql) is a command line tool that has been designed specifically for TiDB Cloud Lake. It allows users to establish a connection with TiDB Cloud Lake and execute queries directly from a CLI window.
99

10-
BendSQL is particularly useful for those who prefer a command line interface and need to work with Databend on a regular basis. With BendSQL, users can easily and efficiently manage their databases, tables, and data, and perform a wide range of queries and operations with ease.
10+
BendSQL is particularly useful for those who prefer a command line interface and need to work with TiDB Cloud Lake on a regular basis. With BendSQL, users can easily and efficiently manage their databases, tables, and data, and perform a wide range of queries and operations with ease.
1111

1212
## Installing BendSQL
1313

@@ -33,8 +33,8 @@ curl -fsSL https://repo.databend.com/install/bendsql.sh | bash
3333
Installer
3434

3535
--------------------------------------------------------------------------------
36-
Website: https://databend.com
37-
Docs: https://docs.databend.com
36+
Website: https://tidbcloud.com
37+
Docs: https://docs.tidb.io/tidbcloudlake/
3838
Github: https://github.com/databendlabs/bendsql
3939
--------------------------------------------------------------------------------
4040

@@ -73,7 +73,7 @@ curl -fsSL https://repo.databend.com/install/bendsql.sh | bash -s -- -y --prefix
7373
Installer
7474
7575
--------------------------------------------------------------------------------
76-
Website: https://databend.com
76+
Website: https://tidbcloud.com
7777
Docs: https://docs.databend.com
7878
Github: https://github.com/databendlabs/bendsql
7979
--------------------------------------------------------------------------------
@@ -146,17 +146,15 @@ cargo install bendsql
146146

147147
## User Authentication
148148

149-
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](/tidb-cloud-lake/sql/create-user.md) command.
150-
151-
For connections to Databend Cloud, you can use the default `cloudapp` user or an SQL user created with the [CREATE USER](/tidb-cloud-lake/sql/create-user.md) 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.
149+
For connections to TiDB Cloud Lake, you can use the default `cloudapp` user or an SQL user created with the [CREATE USER](/tidb-cloud-lake/sql/create-user.md) command. Note that the user account you use to log in to the [TiDB Cloud Lake console](https://app.lake.tidbcloud.com) cannot be used for connecting to TiDB Cloud Lake.
152150

153151
## Connecting with BendSQL
154152

155-
BendSQL allows you to connect to both Databend Cloud and self-hosted Databend instances.
153+
BendSQL allows you to connect to both TiDB Cloud Lake instances.
156154

157155
### Customize Connections with a DSN
158156

159-
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.
157+
A DSN (Data Source Name) is a simple yet powerful way to configure and manage your TiDB Cloud Lake 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.
160158

161159
#### DSN Format and Parameters
162160

@@ -166,8 +164,8 @@ databend[+flight]://user[:password]@host[:port]/[database][?sslmode=disable][&ar
166164

167165
| Common DSN Parameters | Description |
168166
|-----------------------|--------------------------------------|
169-
| `tenant` | Tenant ID, Databend Cloud only. |
170-
| `warehouse` | Warehouse name, Databend Cloud only. |
167+
| `tenant` | Tenant ID, TiDB Cloud Lake only. |
168+
| `warehouse` | Warehouse name, TiDB Cloud Lake only. |
171169
| `sslmode` | Set to `disable` if not using TLS. |
172170
| `tls_ca_file` | Custom root CA certificate path. |
173171
| `connect_timeout` | Connect timeout in seconds. |
@@ -178,7 +176,7 @@ databend[+flight]://user[:password]@host[:port]/[database][?sslmode=disable][&ar
178176
| `max_rows_in_buffer` | Maximum rows for page buffer. |
179177
| `max_rows_per_page` | Maximum response rows for a single page. |
180178
| `page_request_timeout_secs` | Timeout for a single page request, default is `30`. |
181-
| `presign` | Enable presign for data loading. Options: `auto`, `detect`, `on`, `off`. Default is `auto` (only enabled for Databend Cloud). |
179+
| `presign` | Enable presign for data loading. Options: `auto`, `detect`, `on`, `off`. Default is `auto` (only enabled for TiDB Cloud Lake). |
182180

183181
| FlightSQL Client Parameters | Description |
184182
|-----------------------------|----------------------------------------------------------------------|
@@ -193,54 +191,29 @@ databend[+flight]://user[:password]@host[:port]/[database][?sslmode=disable][&ar
193191

194192
```bash
195193
# Local connection using HTTP API with presign detection
196-
databend://root:@localhost:8000/?sslmode=disable&presign=detect
194+
lake://root:@localhost:8000/?sslmode=disable&presign=detect
197195
198-
# Databend Cloud connection with tenant and warehouse info
199-
databend://user1:password1@tnxxxx--default.gw.aws-us-east-2.default.databend.com:443/benchmark?enable_dphyp=1
196+
# TiDB Cloud Lake connection with tenant and warehouse info
197+
lake://user1:password1@tnxxxx--default.gw.aws-us-east-2.default.databend.com:443/benchmark?enable_dphyp=1
200198
201199
# Local connection using FlightSQL API
202-
databend+flight://root:@localhost:8900/database1?connect_timeout=10
200+
lake+flight://root:@localhost:8900/database1?connect_timeout=10
203201
```
204202

205-
### Connect to Databend Cloud
203+
### Connect to TiDB Cloud Lake
206204

207-
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:
205+
The best practice for connecting to TiDB Cloud Lake is to obtain your DSN from TiDB Cloud Lake and export it as an environment variable. To obtain your DSN:
208206

209-
1. Log in to Databend Cloud and click **Connect** on the **Overview** page.
207+
1. Log in to TiDB Cloud Lake and click **Connect** on the **Overview** page.
210208

211209
2. Select the database and warehouse you want to connect to.
212210

213211
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.
214212
215-
```bash title='Example'
216-
export BENDSQL_DSN="databend://cloudapp:******@tn3ftqihs.gw.aws-us-east-2.default.databend.com:443/information_schema?warehouse=small-xy2t"
217-
bendsql
218-
```
219-
220-
### Connect to Self-hosted Databend
221-
222-
You can connect to a self-hosted Databend instance using either BendSQL command-line arguments or a DSN.
223-
224-
#### Option 1: Use BendSQL Arguments
225-
226-
```bash
227-
bendsql --host <HOST> --port <PORT> --user <USER> --password <PASSWORD> --database <DATABASE>
228-
```
229-
230-
This example connects to a Databend instance running locally on port `8000` using `eric` as the user:
231-
232-
```bash title='Example'
233-
bendsql --host 127.0.0.1 --port 8000 --user eric --password abc123
234-
```
235-
236-
#### Option 2: Use a DSN
237-
238-
You can also define the connection using a DSN and export it as the `BENDSQL_DSN` environment variable:
239-
240-
```bash title='Example'
241-
export BENDSQL_DSN="databend://eric:abc123@localhost:8000/?sslmode=disable"
242-
bendsql
243-
```
213+
```bash title='Example'
214+
export BENDSQL_DSN="lake://cloudapp:******@tn3ftqihs.gw.aws-us-east-2.default.databend.com:443/information_schema?warehouse=small-xy2t"
215+
bendsql
216+
```
244217
245218
## BendSQL Settings
246219
@@ -427,7 +400,7 @@ root@localhost:8000/default> select * from system.settings;
427400
│ storage... │ 1048576 │ 1048576 │ None │ DEFAULT │ Sets the byte size of the buff... │ UInt64 │
428401
│ table_l... │ 10 │ 10 │ None │ DEFAULT │ Sets the seconds that the tabl... │ UInt64 │
429402
│ timezone │ UTC │ UTC │ None │ DEFAULT │ Sets the timezone. │ String │
430-
│ unquote... │ 0 │ 0 │ None │ DEFAULT │ Determines whether Databend tr... │ UInt64 │
403+
│ unquote... │ 0 │ 0 │ None │ DEFAULT │ Determines whether TiDB Cloud Lake tr... │ UInt64 │
431404
│ use_par... │ 0 │ 0 │ [0, 1] │ DEFAULT │ This setting is deprecated │ UInt64 │
432405
│ 96 rows │ │ │ │ │ │ │
433406
│ (10 shown) │ │ │ │ │ │ │
@@ -607,13 +580,13 @@ For examples of each command, please refer to the reference information below:
607580
608581
### `!exit`
609582
610-
Disconnects from Databend and exits BendSQL.
583+
Disconnects from TiDB Cloud Lake and exits BendSQL.
611584
612585
```shell title='Example:'
613586
➜ ~ bendsql
614587
Welcome to BendSQL 0.17.0-homebrew.
615588
Connecting to localhost:8000 as user root.
616-
Connected to Databend Query v1.2.427-nightly-b1b622d406(rust-1.77.0-nightly-2024-04-20T22:12:35.318382488Z)
589+
Connected to TiDB Cloud Lake Query v1.2.427-nightly-b1b622d406(rust-1.77.0-nightly-2024-04-20T22:12:35.318382488Z)
617590
618591
// highlight-next-line
619592
root@localhost:8000/default> !exit
@@ -622,13 +595,13 @@ Bye~
622595
623596
### `!quit`
624597
625-
Disconnects from Databend and exits BendSQL.
598+
Disconnects from TiDB Cloud Lake and exits BendSQL.
626599
627600
```shell title='Example:'
628601
➜ ~ bendsql
629602
Welcome to BendSQL 0.17.0-homebrew.
630603
Connecting to localhost:8000 as user root.
631-
Connected to Databend Query v1.2.427-nightly-b1b622d406(rust-1.77.0-nightly-2024-04-20T22:12:35.318382488Z)
604+
Connected to TiDB Cloud Lake Query v1.2.427-nightly-b1b622d406(rust-1.77.0-nightly-2024-04-20T22:12:35.318382488Z)
632605
633606
// highlight-next-line
634607
root@localhost:8000/default> !quit
@@ -686,7 +659,7 @@ INSERT INTO test_table (id, name) VALUES (3, 'Charlie');
686659
➜ ~ bendsql
687660
Welcome to BendSQL 0.17.0-homebrew.
688661
Connecting to localhost:8000 as user root.
689-
Connected to Databend Query v1.2.427-nightly-b1b622d406(rust-1.77.0-nightly-2024-04-20T22:12:35.318382488Z)
662+
Connected to TiDB Cloud Lake Query v1.2.427-nightly-b1b622d406(rust-1.77.0-nightly-2024-04-20T22:12:35.318382488Z)
690663
691664
// highlight-next-line
692665
root@localhost:8000/default> !source ./desktop/test.sql

‎markdown-pages/en/tidb/release-8.5/tidb-cloud-lake/guides/connect-using-dbeaver.md‎

Lines changed: 9 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,35 @@
11
---
22
title: DBeaver
3-
summary: DBeaver supports connecting to Databend using a built-in driver categorized under Analytical, available starting from version 24.3.1.
3+
summary: DBeaver supports connecting to TiDB Cloud Lake using a built-in driver categorized under Analytical, available starting from version 24.3.1.
44
---
55

66
# DBeaver
77

8-
[DBeaver](https://dbeaver.com/) supports connecting to Databend using a built-in driver categorized under **Analytical**, available starting from **version 24.3.1**.
8+
[DBeaver](https://dbeaver.com/) supports connecting to TiDB Cloud Lake using a built-in driver categorized under **Analytical**, available starting from **version 24.3.1**.
99

1010
![Connect from DBeaver](https://docs-download.pingcap.com/media/images/docs/tidb-cloud-lake/dbeaver.png)
1111

1212
## Prerequisites
1313

1414
- DBeaver 24.3.1 or later version installed
15-
- For self-hosted Databend: [Docker](https://www.docker.com/) installed (if using Docker deployment)
1615

1716
## User Authentication
1817

19-
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](/tidb-cloud-lake/sql/create-user.md) command.
18+
For connections to TiDB Cloud Lake, you can use the default `cloudapp` user or an SQL user created with the [CREATE USER](/tidb-cloud-lake/sql/create-user.md) command. Please note that the user account you use to log in to the [TiDB Cloud Lake console](https://app.lake.tidbcloud.com) cannot be used for connecting to TiDB Cloud Lake.
2019

21-
For connections to Databend Cloud, you can use the default `cloudapp` user or an SQL user created with the [CREATE USER](/tidb-cloud-lake/sql/create-user.md) 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.
20+
## Connecting to TiDB Cloud Lake
2221

23-
## Connecting to Self-Hosted Databend
22+
### Step 1: Obtain TiDB Cloud Lake Connection Information
2423

25-
## Step 1: Start Databend (Docker)
26-
27-
Run the following command to launch a Databend instance:
28-
29-
> **Note:**
30-
>
31-
> 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.
32-
33-
```bash
34-
docker run -d --name databend \
35-
-p 3307:3307 -p 8000:8000 -p 8124:8124 -p 8900:8900 \
36-
datafuselabs/databend:nightly
37-
```
38-
39-
## Step 2: Configure Connection
40-
41-
1. In DBeaver, go to **Database** > **New Database Connection** to open the connection wizard, then select **Databend** under the **Analytical** category.
42-
43-
![alt text](https://docs-download.pingcap.com/media/images/docs/tidb-cloud-lake/dbeaver-analytical.png)
44-
45-
2. Enter `root` for the **Username** (or your configured username).
46-
47-
![alt text](https://docs-download.pingcap.com/media/images/docs/tidb-cloud-lake/dbeaver-user-root.png)
48-
49-
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.
50-
51-
![alt text](https://docs-download.pingcap.com/media/images/docs/tidb-cloud-lake/dbeaver-download-driver.png)
52-
53-
Once the download is complete, the test connection should succeed:
54-
55-
![alt text](https://docs-download.pingcap.com/media/images/docs/tidb-cloud-lake/dbeaver-success.png)
56-
57-
## Connecting to Databend Cloud
58-
59-
## Step 1: Obtain Databend Cloud Connection Information
60-
61-
Log in to Databend Cloud to obtain connection information. For more information, see [Connecting to a Warehouse](/tidb-cloud-lake/guides/warehouse.md#connecting).
24+
Log in to TiDB Cloud Lake to obtain connection information. For more information, see [Connecting to a Warehouse](/tidb-cloud-lake/guides/warehouse.md#connecting).
6225

6326
![alt text](https://docs-download.pingcap.com/media/images/docs/tidb-cloud-lake/dbeaver-connect-info.png)
6427

6528
> **Note:**
6629
>
67-
> 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.
30+
> 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, TiDB Cloud Lake 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.
6831
69-
## Step 2: Configure Databend Cloud Connection
32+
### Step 2: Configure TiDB Cloud Lake Connection
7033

7134
1. In DBeaver, go to **Database** > **New Database Connection** to open the connection wizard, then select **Databend** under the **Analytical** category.
7235

@@ -84,6 +47,6 @@ Log in to Databend Cloud to obtain connection information. For more information,
8447

8548
![alt text](https://docs-download.pingcap.com/media/images/docs/tidb-cloud-lake/dbeaver-use-ssl.png)
8649

87-
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:
50+
5. Click **Test Connection** to verify the connection. If this is your first time connecting to TiDB Cloud Lake, you will be prompted to download the driver. Click **Download** to proceed. Once the download is complete, the test connection should succeed:
8851

8952
![alt text](https://docs-download.pingcap.com/media/images/docs/tidb-cloud-lake/dbeaver-cloud-success.png)

‎markdown-pages/en/tidb/release-8.5/tidb-cloud-lake/guides/connect-using-golang.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The official Go driver provides a standard `database/sql` interface for seamless
1313
go get github.com/databendlabs/databend-go
1414
```
1515

16-
**Connection String**: See [connection strings](/tidb-cloud-lake/guides/connection-overview.md#connection-strings).
16+
**Connection String**: See [drivers overview](/tidb-cloud-lake/guides/driver-overview.md) for DSN format and examples.
1717

1818
---
1919

@@ -26,7 +26,7 @@ go get github.com/databendlabs/databend-go
2626

2727
## Data Type Mappings
2828

29-
| Databend | Go | Notes |
29+
| TiDB Cloud Lake | Go | Notes |
3030
|----------|----|---------|
3131
| **Integers** | | |
3232
| `TINYINT` | `int8` | |
@@ -63,8 +63,8 @@ import (
6363
_ "github.com/databendlabs/databend-go"
6464
)
6565

66-
// Connect to Databend
67-
db, err := sql.Open("databend", "<your-dsn>")
66+
// Connect to TiDB Cloud Lake
67+
db, err := sql.Open("lake", "<your-dsn>")
6868
if err != nil {
6969
log.Fatal(err)
7070
}

‎markdown-pages/en/tidb/release-8.5/tidb-cloud-lake/guides/connect-using-java.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The official JDBC driver provides standard JDBC 4.0 compatibility for seamless i
2525
implementation 'com.databend:databend-jdbc:0.4.1'
2626
```
2727

28-
**Connection String**: See [connection strings](/tidb-cloud-lake/guides/connection-overview.md#connection-strings).
28+
**Connection String**: See [drivers overview](/tidb-cloud-lake/guides/driver-overview.md) for DSN format and examples.
2929

3030
---
3131

@@ -38,7 +38,7 @@ implementation 'com.databend:databend-jdbc:0.4.1'
3838

3939
## Data Type Mappings
4040

41-
| Databend | Java | Notes |
41+
| TiDB Cloud Lake | Java | Notes |
4242
|----------|------|---------|
4343
| **Integers** | | |
4444
| `TINYINT` | `Byte` | |
@@ -71,7 +71,7 @@ implementation 'com.databend:databend-jdbc:0.4.1'
7171
```java
7272
import java.sql.*;
7373

74-
// Connect to Databend
74+
// Connect to TiDB Cloud Lake
7575
Connection conn = DriverManager.getConnection("<your-dsn>");
7676

7777
// DDL: Create table

0 commit comments

Comments
 (0)