diff --git a/docs-cn/03-get-started/03-get-started.md b/docs-cn/03-get-started/03-get-started.md index c47881170994302baa3a9cf6f1add5fbc951665d..de44d62fc93d5838e7870de70db6130cc5f6efff 100644 --- a/docs-cn/03-get-started/03-get-started.md +++ b/docs-cn/03-get-started/03-get-started.md @@ -10,7 +10,7 @@ import AptGetInstall from "./\_apt_get_install.mdx"; ## 安装 -TDengine 包括服务端、客户端和周边生态工具软件，目前 2.0 版服务端仅在 Linux 系统上安装和运行，后续将支持 Windows、macOS 等系统。客户端可以在 Windows 或 Linux 上安装和运行。在任何操作系统上的应用都可以使用 RESTful 接口连接 TDengine，其中 2.4 之后版本默认使用单独运行的独立组件 taosAdapter 提供 http 服务和更多数据写入方式, taosAdapter 需要手动启动。 +TDengine 包括服务端、命令行程序 (CLI) 和周边生态工具软件，目前 2.0 版服务端仅在 Linux 系统上安装和运行，后续将支持 Windows、macOS 等系统。 TDengine CLI 可以在 Windows 或 Linux 上安装和运行。在任何操作系统上的应用都可以使用 RESTful 接口连接 TDengine，其中 2.4 之后版本默认使用单独运行的独立组件 taosAdapter 提供 http 服务和更多数据写入方式, taosAdapter 需要手动启动。 2.4 之前的版本中 TDengine 服务端，以及所有服务端 lite 版，均使用由 taosd 内置的 http 服务。 TDengine 支持 X64/ARM64/MIPS64/Alpha64 硬件平台，后续将支持 ARM32、RISC-V 等 CPU 架构。 @@ -45,7 +45,7 @@ docker exec -it bash ::: :::note -暂时不建议生产环境采用 Docker 来部署 TDengine 的客户端或服务端，但在开发环境下或初次尝试时，使用 Docker 方式部署是十分方便的。特别是，利用 Docker，可以方便地在 macOS 和 Windows 环境下尝试 TDengine。 +暂时不建议生产环境采用 Docker 来部署 TDengine CLI 或服务端，但在开发环境下或初次尝试时，使用 Docker 方式部署是十分方便的。特别是，利用 Docker，可以方便地在 macOS 和 Windows 环境下尝试 TDengine。 ::: @@ -84,7 +84,7 @@ systemctl status taosd - systemctl 命令需要 _root_ 权限来运行，如果您非 _root_ 用户，请在命令前添加 sudo 。 - 为更好的获得产品反馈，改善产品，TDengine 会采集基本的使用信息，但您可以修改系统配置文件 taos.cfg 里的配置参数 telemetryReporting，将其设为 0，就可将其关闭。 -- TDengine 采用 FQDN（一般就是 hostname）作为节点的 ID，为保证正常运行，需要给运行 taosd 的服务器配置好 hostname，在客户端应用运行的机器配置好 DNS 服务或 hosts 文件，保证 FQDN 能够解析。 +- TDengine 采用 FQDN（一般就是 hostname）作为节点的 ID，为保证正常运行，需要给运行 taosd 的服务器配置好 hostname， 在 TDengine CLI 运行的机器配置好 DNS 服务或 hosts 文件，保证 FQDN 能够解析。 - `systemctl stop taosd` 指令在执行后并不会马上停止 TDengine 服务，而是会等待系统中必要的落盘工作正常完成。在数据量很大的情况下，这可能会消耗较长时间。 TDengine 支持在使用 [`systemd`](https://en.wikipedia.org/wiki/Systemd) 做进程服务管理的 Linux 系统上安装，用 `which systemctl` 命令来检测系统中是否存在 `systemd` 包: @@ -97,21 +97,25 @@ which systemctl :::note -## 进入命令行 +## TDengine 命令行 (CLI) -执行 TDengine 客户端程序，您只要在 Linux 终端执行 `taos` 即可。 +### 进入 命令行 + +要进入 TDengine 命令行 （以下简称为 TDengine CLI)，您只要在 Linux 终端执行 `taos` 即可。 ```bash taos ``` -如果连接服务成功，将会打印出欢迎消息和版本信息。如果失败，则会打印错误消息出来（请参考 [FAQ](/train-fqa/faq) 来解决终端连接服务端失败的问题）。客户端的提示符号如下： +如果连接服务成功，将会打印出欢迎消息和版本信息。如果失败，则会打印错误消息出来（请参考 [FAQ](/train-fqa/faq) 来解决终端连接服务端失败的问题）。 TDengine CLI 的提示符号如下： ```cmd taos> ``` -在 TDengine 客户端中，用户可以通过 SQL 命令来创建/删除数据库、表等，并进行插入查询操作。在终端中运行的 SQL 语句需要以分号结束来运行。示例： +### 执行 SQL 命令 + +在 TDengine CLI中，用户可以通过 SQL 命令来创建/删除数据库、表等，并进行插入查询操作。在终端中运行的 SQL 语句需要以分号结束来运行。示例： ```sql create database demo; @@ -127,26 +131,10 @@ select * from t; Query OK, 2 row(s) in set (0.003128s) ``` -除执行 SQL 语句外，系统管理员还可以从 TDengine 客户端进行检查系统运行状态、添加删除用户账号等操作。 - -## 命令行参数 - -您可通过配置命令行参数来改变 TDengine 客户端的行为。以下为常用的几个命令行参数： - -- -c, --config-dir: 指定配置文件目录，默认为 `/etc/taos` -- -h, --host: 指定服务的 FQDN 地址或 IP 地址，默认为连接本地服务 -- -s, --commands: 在不进入终端的情况下运行 TDengine 命令 -- -u, --user: 连接 TDengine 服务端的用户名，缺省为 root -- -p, --password: 连接 TDengine 服务端的密码，缺省为 taosdata -- -?, --help: 打印出所有命令行参数 +除执行 SQL 语句外，系统管理员还可以从 TDengine CLI 进行检查系统运行状态、添加删除用户账号等操作。 -示例： -```bash -taos -h h1.taos.com -s "use db; show tables;" -``` - -## 运行 SQL 命令脚本 +### 执行 SQL 脚本 TDengine 终端可以通过 `source` 命令来运行 SQL 命令脚本。 @@ -154,23 +142,11 @@ TDengine 终端可以通过 `source` 命令来运行 SQL 命令脚本。 taos> source ; ``` -## taos shell 小技巧 - -- 可以使用上下光标键查看历史输入的指令 -- 修改用户密码：在 shell 中使用 `alter user` 命令，缺省密码为 taosdata -- ctrl+c 中止正在进行中的查询 -- 执行 `RESET QUERY CACHE` 可清除本地缓存的表 schema -- 批量执行 SQL 语句。可以将一系列的 shell 命令（以英文 ; 结尾，每个 SQL 语句为一行）按行存放在文件里，在 shell 里执行命令 `source ` 自动执行该文件里所有的 SQL 语句 -- 输入 q 回车，退出 taos shell -- 在线修改显示字符宽度 - ``` - SET MAX_BINARY_DISPLAY_WIDTH ; - ``` - 如显示的内容后面以...结尾时，表示该内容已被截断，可通过本命令修改显示字符宽度以显示完整的内容。 +更多细节请参考 [这里](../reference/taos-shell/) ## 使用 taosBenchmark 体验写入速度 -启动 TDengine 的服务，在 Linux 终端执行 `taosBenchmark` （曾命名为 taosdemo）： +启动 TDengine 的服务，在 Linux 终端执行 `taosBenchmark` （曾命名为 `taosdemo`）： ```bash taosBenchmark @@ -180,15 +156,13 @@ taosBenchmark 这条命令很快完成 1 亿条记录的插入。具体时间取决于硬件性能，即使在一台普通的 PC 服务器往往也仅需十几秒。 -## taosBenchmark 详细功能列表 - taosBenchmark 命令本身带有很多选项，配置表的数目、记录条数等等，请执行 `taosBenchmark --help` 详细列出。您可以设置不同参数进行体验。 taosBenchmark 详细使用方法请参照 [如何使用 taosBenchmark 对 TDengine 进行性能测试](https://www.taosdata.com/2021/10/09/3111.html)。 -## 使用 taos shell 体验查询速度 +## 使用 TDengine CLI 体验查询速度 -在 TDengine 客户端输入查询命令，体验查询速度。 +在 TDengine CLI 输入查询命令，体验查询速度。 查询超级表下记录总条数： diff --git a/docs-cn/14-reference/08-taos-shell.md b/docs-cn/14-reference/08-taos-shell.md new file mode 100644 index 0000000000000000000000000000000000000000..7c653671202d87375f72cfb53af8c2c21b1792cb --- /dev/null +++ b/docs-cn/14-reference/08-taos-shell.md @@ -0,0 +1,55 @@ +--- +title: TDengine 命令行(CLI) +sidebar_label: TDengine CLI +description: TDengine CLI 的使用说明和技巧 +--- + +TDengine 命令行 （以下简称 TDengine CLI）是用户操作 TDengine 并与之交互的最简洁最常用的方式。 + +## 基本使用 +请参考[这里](/get-started/) + +## 命令行参数 + +您可通过配置命令行参数来改变 TDengine CLI 的行为。以下为常用的几个命令行参数： + +- -c, --config-dir: 指定配置文件目录，默认为 `/etc/taos`，该目录下的配置文件默认名称为 taos.cfg +- -C, --dump-config: 打印 -c 指定的目录中 taos.cfg 的配置参数 +- -d, --database=DATABASE: 指定连接到服务端时使用的数据库 +- -D, --directory=DIRECTORY: 导入指定路径中的 SQL 脚本文件 +- -f, --file=FILE: 以非交互模式执行 SQL 脚本文件 +- -h, --host=HOST: 要连接的 TDengine 服务端所在服务器的 FQDN, 默认为连接本地服务 +- -k, --check=CHECK: 指定要检查的表 +- -l, --pktlen=PKTLEN: 网络测试时使用的测试包大小 +- -n, --netrole=NETROLE: 网络连接测试时的测试范围，默认为 startup, 可选值为 client, server, rpc, startup, sync, speed, fqdn +- -p, --password=PASSWORD: 连接服务端时使用的密码 +- -P, --port=PORT: 指定服务端所用端口号 +- -r, --raw-time: 将时间输出出 uint64_t +- -s, --commands=COMMAND: 以非交互模式执行的 SQL 命令 +- -S, --pkttype=PKTTYPE: 指定网络测试所用的包类型，默认为 TCP。只有 netrole 为 speed 时既可以指定为 TCP 也可以指定为 UDP +- -T, --thread=THREADNUM: 以多线程模式导入数据时的线程数 +- -u, --user=USER: 连接时使用的用户名 +- -s, --commands: 在不进入终端的情况下运行 TDengine 命令 +- -z, --timezone=TIMEZONE: 指定时区，默认为本地 +- -V, --version: 打印出当前版本号 +- -?, --help: 打印出所有命令行参数 + +示例： + +```bash +taos -h h1.taos.com -s "use db; show tables;" +``` + +## TDengine CLI 小技巧 + +- 可以使用上下光标键查看历史输入的指令 +- 修改用户密码：在 shell 中使用 `alter user` 命令，缺省密码为 taosdata +- ctrl+c 中止正在进行中的查询 +- 执行 `RESET QUERY CACHE` 可清除本地缓存的表 schema +- 批量执行 SQL 语句。可以将一系列的 shell 命令（以英文 ; 结尾，每个 SQL 语句为一行）按行存放在文件里，在 shell 里执行命令 `source ` 自动执行该文件里所有的 SQL 语句 +- 输入 q 回车，退出 taos shell +- 在线修改显示字符宽度 + ```sql + SET MAX_BINARY_DISPLAY_WIDTH ; + ``` + 如显示的内容后面以...结尾时，表示该内容已被截断，可通过本命令修改显示字符宽度以显示完整的内容。 \ No newline at end of file