• 簡介
• 工具獲取
• 運行
• 命令行參數
  • 基礎參數
  • 高級參數
• 數據導出/導入
  • 數據導出
  • 數據導入
• 執行 SQL 腳本
• 使用小技巧
  • TAB 鍵自動補全
  • 設置字符列顯示寬度
  • 其它
• 錯誤代碼表

簡介

TDengine 命令行工具（以下簡稱 TDengine CLI）是用戶操作 TDengine 實例并與之交互最簡潔常用工具。

工具獲取

TDengine CLI 是 TDengine 服務器及客戶端安裝包中默認安裝組件，安裝后即可使用，參考 TDengine 安裝

運行

進入 TDengine CLI 交互執行模式，在終端命令行執行：

taos

如果連接服務成功，將會打印出歡迎消息和版本信息。若失敗，打印錯誤消息。

TDengine CLI 的提示符號如下：

taos>

進入 TDengine CLI 后，可執行各種 SQL 語句，包括插入、查詢以及各種管理命令。
退出 TDengine CLI， 執行 q 或 quit 或 exit 回車即可。

taos> quit

命令行參數

基礎參數

可通過配置命令行參數來改變 TDengine CLI 的行為。以下為常用的幾個命令行參數：

• -h HOST: 要連接的 TDengine 服務端所在服務器的 FQDN, 默認值： 127.0.0.1 。

• -P PORT: 指定服務端所用端口號，默認值：6030 。

• -u USER: 連接時使用的用戶名，默認值：root 。

• -p PASSWORD: 連接服務端時使用的密碼，特殊字符如 ! & ( ) < > ; | 需使用字符 \ 進行轉義處理, 默認值：taosdata 。

• -?, --help: 打印出所有命令行參數。

• -s COMMAND: 以非交互模式執行的 SQL 命令。

  使用 -s 參數可進行非交互式執行 SQL，執行完成后退出，此模式適合在自動化腳本中使用。
  如以下命令連接到服務器 h1.taos.com, 執行 -s 指定的 SQL:

  taos -h my-server -s "use db; show tables;"
  

• -c CONFIGDIR: 指定配置文件目錄。

  Linux 環境下默認為 /etc/taos，該目錄下的配置文件默認名稱為 taos.cfg 。
  使用 -c 參數改變 taosc 客戶端加載配置文件的位置，客戶端配置參數參考 客戶端配置 。
  以下命令指定了 taosc 客戶端加載 /root/cfg/ 下的 taos.cfg 配置文件。

  taos -c /root/cfg/
  

高級參數

• -a AUTHSTR: 連接服務端的授權信息。

• -A: 通過用戶名和密碼計算授權信息。

• -B: 設置 BI 工具顯示模式，設置后所有輸出都遵循 BI 工具的格式進行輸出。

• -C: 打印 -c 指定的目錄中 taos.cfg 的配置參數。

• -d DATABASE: 指定連接到服務端時使用的數據庫。

• -E dsn: 使用 WebSocket DSN 連接云服務或者提供 WebSocket 連接的服務端。

• -f FILE: 以非交互模式執行 SQL 腳本文件。文件中一個 SQL 語句只能占一行。

• -k: 測試服務端運行狀態，0: unavailable，1: network ok，2: service ok，3: service degraded，4: exiting 。

• -l PKTLEN: 網絡測試時使用的測試包大小。

• -n NETROLE: 網絡連接測試時的測試范圍，默認為 client, 可選值為 client、server 。

• -N PKTNUM: 網絡測試時使用的測試包數量。

• -r: 將時間列轉化為無符號 64 位整數類型輸出(即 C 語言中 uint64_t) 。

• -R: 使用 RESTful 模式連接服務端。

• -t: 測試服務端啟動狀態，狀態同 -k 。

• -w DISPLAYWIDTH: 客戶端列顯示寬度。

• -z TIMEZONE: 指定時區，默認為本地時區。

• -V: 打印出當前版本號。

數據導出/導入

數據導出

• 可以使用符號 “>>” 導出查詢結果到某個文件中，語法為： sql 查詢語句 >> ‘輸出文件名’; 輸出文件如果不寫路徑的話，將輸出至當前目錄下。如 select * from d0 >> ‘/root/d0.csv’; 將把查詢結果輸出到 /root/d0.csv 中。

數據導入

• 可以使用 insert into table_name file ‘輸入文件名’，把上一步中導出的數據文件再導入到指定表中。如 insert into d0 file '/root/d0.csv'; 表示把上面導出的數據全部再導致至 d0 表中。

執行 SQL 腳本

在 TDengine CLI 里可以通過 source 命令來運行腳本文件中的多條 SQL 命令。

taos> source <filename>;

使用小技巧

TAB 鍵自動補全

• TAB 鍵前為空命令狀態下按 TAB 鍵，會列出 TDengine CLI 支持的所有命令。
• TAB 鍵前為空格狀態下按 TAB 鍵，會顯示此位置可以出現的所有命令詞的第一個，再次按 TAB 鍵切為下一個。
• TAB 鍵前為字符串，會搜索與此字符串前綴匹配的所有可出現命令詞，并顯示第一個，再次按 TAB 鍵切為下一個。
• 輸入反斜杠 \ + TAB 鍵, 會自動補全為列顯示模式命令詞 \G; 。

設置字符列顯示寬度

可以在 TDengine CLI 里使用如下命令調整字符串類型字段列顯示寬度，默認顯示寬度為 30 個字符。
以下命令設置了顯示寬度為 120 個字符：

taos> SET MAX_BINARY_DISPLAY_WIDTH 120;

如顯示的內容后面以 … 結尾時，表示該內容已被截斷，可通過本命令修改顯示字符寬度以顯示完整的內容。

其它

• 可以使用上下光標鍵查看歷史輸入的指令。
• 在 TDengine CLI 中使用 alter user 命令可以修改用戶密碼，缺省密碼為 taosdata 。
• Ctrl+C 中止正在進行中的查詢。
• 執行 RESET QUERY CACHE 可清除本地表 Schema 的緩存。
• 批量執行 SQL 語句。可以將一系列的 TDengine CLI 命令（以英文 ; 結尾，每個 SQL 語句為一行）按行存放在文件里，在 TDengine CLI 里執行命令 source <file-name> 自動執行該文件里所有的 SQL 語句。

錯誤代碼表

在 TDengine 3.3.4.8 版本后 TDengine CLI 在返回錯誤信息中返回了具體錯誤碼，用戶可到 TDengine 官網錯誤碼頁面查找具體原因及解決措施，見：錯誤碼參考表