22title : BendSQL
33---
44
5- [ BendSQL] ( https://github.com/datafuselabs/BendSQL ) 是一个专为 Databend 设计的命令行工具。它允许用户与 Databend 建立连接，并直接从命令行窗口执行查询 。
5+ [ BendSQL] ( https://github.com/datafuselabs/BendSQL ) 是一个专为 Databend 设计的命令行工具。它允许用户与 Databend 建立连接，并直接从 CLI 窗口执行查询 。
66
7- BendSQL 特别适用于那些偏好命令行界面并需要经常与 Databend 打交道的用户。通过 BendSQL，用户可以轻松高效地管理数据库 、表和数据，并轻松执行各种查询和操作 。
7+ BendSQL 特别适用于那些偏好命令行界面并需要经常与 Databend 打交道的用户。通过 BendSQL，用户可以轻松高效地管理其数据库 、表和数据，并轻松执行广泛的查询和操作 。
88
99## 安装 BendSQL
1010
@@ -20,7 +20,7 @@ brew install databendcloud/homebrew-tap/bendsql
2020
2121### Apt（适用于 Ubuntu/Debian）
2222
23- 在 Ubuntu 和 Debian 系统上，BendSQL 可以通过 Apt 包管理器安装。根据发行版版本选择适当的说明 。
23+ 在 Ubuntu 和 Debian 系统上，BendSQL 可以通过 Apt 包管理器安装。根据发行版本选择合适的说明 。
2424
2525#### DEB822-STYLE 格式（Ubuntu-22.04/Debian-12 及更高版本）
2626
@@ -66,9 +66,15 @@ cargo binstall bendsql
6666cargo install bendsql
6767```
6868
69+ ## 用户认证
70+
71+ 如果您连接到自托管的 Databend 实例，可以使用 [ databend-query.toml] ( https://github.com/datafuselabs/databend/blob/main/scripts/distribution/configs/databend-query.toml ) 配置文件中指定的管理员用户，或者使用通过 [ CREATE USER] ( /sql/sql-commands/ddl/user/user-create-user ) 命令创建的 SQL 用户进行连接。
72+
73+ 对于连接到 Databend Cloud，您可以使用默认的 ` cloudapp ` 用户或通过 [ CREATE USER] ( /sql/sql-commands/ddl/user/user-create-user ) 命令创建的 SQL 用户。请注意，您用于登录 [ Databend Cloud 控制台] ( https://app.databend.com/ ) 的用户账户不能用于连接到 Databend Cloud。
74+
6975## 教程
7076
71- - [ 使用 BendSQL 连接到 Databend] ( /tutorials/ )
77+ - [ 使用 BendSQL 连接到自托管的 Databend] ( /tutorials/ )
7278- [ 使用 BendSQL 连接到 Databend Cloud] ( /tutorials/connect/connect-to-databendcloud-bendsql )
7379
7480## BendSQL 设置
@@ -78,19 +84,19 @@ BendSQL 提供了一系列设置，允许您定义查询结果的呈现方式：
7884| 设置 | 描述 |
7985| ------------------ | --------------------------------------------------------------------------------------------- |
8086| ` display_pretty_sql ` | 当设置为 ` true ` 时，SQL 查询将以视觉上吸引人的方式格式化，使其更易于阅读和理解。 |
81- | ` prompt ` | 命令行界面中显示的提示符，通常指示用户、仓库和正在访问的数据库 。 |
82- | ` progress_color ` | 指定用于进度指示器的颜色，例如在执行需要一些时间完成的查询时。 |
83- | ` show_progress ` | 当设置为 ` true ` 时，将显示进度指示器，以显示长时间运行的查询或操作的进度。 |
84- | ` show_stats ` | 如果为 ` true ` ，将在执行每个查询后显示查询统计信息 ，如执行时间、读取的行数和处理的字节数。 |
85- | ` max_display_rows ` | 设置查询结果输出中将显示的最大行数。 |
86- | ` max_col_width ` | 设置每个列显示渲染的最大宽度（以字符为单位）。小于 3 的值将禁用限制。 |
87- | ` max_width ` | 设置整个显示输出的最大宽度（以字符为单位）。值为 0 时默认为终端窗口的宽度。 |
88- | ` output_format ` | 设置用于显示查询结果的格式（` table ` 、` csv ` 、` tsv ` 、` null ` ）。 |
89- | ` expand ` | 控制查询输出的显示方式是作为单独的记录还是以表格格式显示。可用值：` on ` 、` off ` 和 ` auto ` 。 |
90- | ` multi_line ` | 确定是否允许多行输入 SQL 查询。当设置为 ` true ` 时，查询可以跨越多行，以提高可读性。 |
91- | ` replace_newline ` | 指定查询结果输出中的换行符是否应替换为空格。这可以防止显示中出现意外的换行。 |
92-
93- 有关每个设置的详细信息，请参阅下面的参考信息 ：
87+ | ` prompt ` | 命令行界面中显示的提示，通常指示正在访问的用户、仓库和数据库 。 |
88+ | ` progress_color ` | 指定用于进度指示器的颜色，例如在执行需要一些时间完成的查询时。 |
89+ | ` show_progress ` | 当设置为 ` true ` 时，将显示进度指示器，以显示长时间运行的查询或操作的进度。 |
90+ | ` show_stats ` | 如果为 ` true ` ，执行每个查询后将显示查询统计信息 ，如执行时间、读取的行数和处理的字节数。 |
91+ | ` max_display_rows ` | 设置查询结果输出中将显示的最大行数。 |
92+ | ` max_col_width ` | 设置每个列显示渲染的最大宽度（以字符为单位）。小于 3 的值将禁用限制。 |
93+ | ` max_width ` | 设置整个显示输出的最大宽度（以字符为单位）。值为 0 时默认为终端窗口的宽度。 |
94+ | ` output_format ` | 设置用于显示查询结果的格式（` table ` 、` csv ` 、` tsv ` 、` null ` ）。 |
95+ | ` expand ` | 控制查询输出的显示方式是作为单独的记录还是以表格格式显示。可用值：` on ` 、` off ` 和 ` auto ` 。 |
96+ | ` multi_line ` | 确定是否允许多行输入 SQL 查询。当设置为 ` true ` 时，查询可以跨越多行，以提高可读性。 |
97+ | ` replace_newline ` | 指定查询结果输出中的换行符是否应替换为空格。这可以防止显示中出现意外的换行。 |
98+
99+ 有关每个设置的详细信息，请参阅以下参考信息 ：
94100
95101#### ` display_pretty_sql `
96102
@@ -132,7 +138,7 @@ SELECT
132138
133139#### ` prompt `
134140
135- ` prompt ` 设置控制命令行界面提示符的格式 。在下面的示例中，它最初设置为显示用户和仓库（` {user}@{warehouse} ` ）。在更新为 ` {user}@{warehouse}/{database} ` 后，提示符现在包括用户 、仓库和数据库。
141+ ` prompt ` 设置控制命令行界面提示的格式 。在下面的示例中，它最初设置为显示用户和仓库（` {user}@{warehouse} ` ）。更新为 ` {user}@{warehouse}/{database} ` 后，提示现在包括用户 、仓库和数据库。
136142
137143``` shell title='示例:'
138144// highlight-next-line
@@ -170,7 +176,7 @@ root@localhost:8000/default> !set progress_color blue
170176
171177#### ` show_progress `
172178
173- 当设置为 ` true ` 时，在执行查询期间会显示进度信息 。进度信息包括已处理的行数、查询中的总行数、处理速度（行/秒）、已处理的内存量和处理速度（内存/秒）。
179+ 当设置为 ` true ` 时，执行查询期间会显示进度信息 。进度信息包括已处理的行数、查询中的总行数、处理速度（行/秒）、已处理的内存量和处理速度（内存/秒）。
174180
175181``` shell title='示例:'
176182// highlight-next-line
@@ -181,7 +187,7 @@ root@localhost:8000/default> select * from numbers(1000000000000000);
181187
182188# ### `show_stats`
183189
184- ` ` 设置控制是否在执行每个查询后显示查询统计信息 。当设置为 ` ` 时，如第一个查询在下面的示例中所示，查询统计信息不会显示。相反，当设置为 ` ` 时，如第二个查询所示，查询统计信息如执行时间、读取的行数和处理的字节数将在执行每个查询后显示 。
190+ ` ` 设置控制执行每个查询后是否显示查询统计信息 。当设置为 ` ` 时，如第一个查询在下面的示例中所示，查询统计信息不会显示。相反，当设置为 ` ` 时，如第二个查询所示，执行每个查询后将显示查询统计信息，如执行时间、读取的行数和处理的字节数 。
185191
186192` ` ` ' 示例:'
187193// highlight-next-line
@@ -207,7 +213,24 @@ root@localhost:8000/default> select now();
207213
208214# ### `max_display_rows`
209215
210- ` ` 设置控制查询结果输出中显示的最大行数。在下面的示例中，当设置为 ` ` 时，查询结果中最多显示 5 行。其余行用 (5 shown) 表示。
216+ ` ` 设置控制查询结果输出中显示的最大行数。当设置为 ` ` 时，如以下示例所示，查询结果中仅显示最多 5 行。剩余的行会用 (5 shown) 表示。
217+
218+ ` ` ` ' 示例:'
219+ // highlight-next-line
220+ root@localhost:8000/default> ! set max_display_rows 5
221+ root@localhost:8000/default> select * from numbers(10);
222+ ┌─────┐
223+ │ col │
224+ │ Int │
225+ ├─────┤
226+ │ 0 │
227+ │ 1 │
228+ │ 2 │
229+ │ 3 │
230+ │ 4 │
231+ └─────┘
232+ (5 shown)
233+ ` ` `
211234
212235` ` ` ' 示例:'
213236// highlight-next-line
@@ -300,7 +323,7 @@ root@localhost:8000/default> show users;
300323
301324# ### `expand`
302325
303- ` ` 设置控制查询输出的显示方式是作为单独的记录还是表格格式 。当 ` ` 设置为 ` ` 时，系统会根据查询返回的行数自动决定如何显示输出。如果查询仅返回一行，则输出显示为单个记录。
326+ ` ` 设置控制查询输出的显示方式是作为单独的记录还是以表格格式显示 。当 ` ` 设置为 ` ` 时，系统会根据查询返回的行数自动决定如何显示输出。如果查询仅返回一行，则输出显示为单个记录。
304327
305328` ` ` ' 示例:'
306329// highlight-next-line
@@ -384,6 +407,8 @@ root@localhost:8000/default> SELECT 'Hello\nWorld' AS message;
384407└──────────────┘
3854081 row read in 0.056 sec. Processed 1 row, 1 B (18 rows/s, 17 B/s)
386409
410+ ` ` `
411+
387412` ` `
388413// highlight-next-line
389414root@localhost:8000/default> ! set replace_newline false ;
@@ -400,7 +425,7 @@ root@localhost:8000/default> SELECT 'Hello\nWorld' AS message;
400425
401426# ## 配置 BendSQL 设置
402427
403- 您可以通过以下选项配置 BendSQL 设置：
428+ 您可以通过以下方式配置 BendSQL 设置：
404429
405430- 使用 ` ! set < setting> < value> ` 命令。更多信息，请参阅 [实用命令](# utility-commands)。
406431
@@ -425,12 +450,12 @@ root@localhost:8000/default> .max_width 100
425450
426451BendSQL 为用户提供了一系列命令，以简化其工作流程并自定义其体验。以下是 BendSQL 中可用的命令概览：
427452
428- | 命令 | 描述 |
429- | ------------------------ | ------------------------------ |
430- | ` ! exit` | 退出 BendSQL。 |
431- | ` ! quit` | 退出 BendSQL。 |
453+ | 命令 | 描述 |
454+ | ------------------------ | ---------------------------- |
455+ | ` ! exit` | 退出 BendSQL。 |
456+ | ` ! quit` | 退出 BendSQL。 |
432457| ` ! configs` | 显示当前 BendSQL 设置。 |
433- | ` ! set < setting> < value> ` | 修改 BendSQL 设置。 |
458+ | ` ! set < setting> < value> ` | 修改 BendSQL 设置。 |
434459| ` ! source < sql_file> ` | 执行 SQL 文件。 |
435460
436461有关每个命令的示例，请参阅下面的参考信息：
@@ -441,13 +466,13 @@ BendSQL 为用户提供了一系列命令，以简化其工作流程并自定义
441466
442467` ` ` shell title=' 示例：'
443468➜ ~ bendsql
444- Welcome to BendSQL 0.17.0-homebrew.
445- Connecting to localhost:8000 as user root.
446- Connected to Databend Query v1.2.427-nightly-b1b622d406(rust-1.77.0-nightly-2024-04-20T22:12:35.318382488Z)
469+ 欢迎使用 BendSQL 0.17.0-homebrew。
470+ 正在连接到 localhost:8000 作为用户 root。
471+ 已连接到 Databend Query v1.2.427-nightly-b1b622d406(rust-1.77.0-nightly-2024-04-20T22:12:35.318382488Z)
447472
448473// highlight-next-line
449474root@localhost:8000/default> ! exit
450- Bye ~
475+ 再见 ~
451476` ` `
452477
453478# ### `!quit`
@@ -456,13 +481,13 @@ Bye~
456481
457482` ` ` shell title=' 示例：'
458483➜ ~ bendsql
459- Welcome to BendSQL 0.17.0-homebrew.
460- Connecting to localhost:8000 as user root.
461- Connected to Databend Query v1.2.427-nightly-b1b622d406(rust-1.77.0-nightly-2024-04-20T22:12:35.318382488Z)
484+ 欢迎使用 BendSQL 0.17.0-homebrew。
485+ 正在连接到 localhost:8000 作为用户 root。
486+ 已连接到 Databend Query v1.2.427-nightly-b1b622d406(rust-1.77.0-nightly-2024-04-20T22:12:35.318382488Z)
462487
463488// highlight-next-line
464489root@localhost:8000/default> ! quit
465- Bye ~
490+ 再见 ~
466491➜ ~
467492` ` `
468493
@@ -514,9 +539,9 @@ INSERT INTO test_table (id, name) VALUES (1, 'Alice');
514539INSERT INTO test_table (id, name) VALUES (2, ' Bob' ;
515540INSERT INTO test_table (id, name) VALUES (3, ' Charlie' ;
516541➜ ~ bendsql
517- Welcome to BendSQL 0.17.0-homebrew.
518- Connecting to localhost:8000 as user root.
519- Connected to Databend Query v1.2.427-nightly-b1b622d406(rust-1.77.0-nightly-2024-04-20T22:12:35.318382488Z)
542+ 欢迎使用 BendSQL 0.17.0-homebrew。
543+ 正在连接到 localhost:8000 作为用户 root。
544+ 已连接到 Databend Query v1.2.427-nightly-b1b622d406(rust-1.77.0-nightly-2024-04-20T22:12:35.318382488Z)
520545
521546// highlight-next-line
522547root@localhost:8000/default> ! source ./desktop/test.sql
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments