From 8b3dd0a1f98f3f9cb819f119c11110f3ca15c5dd Mon Sep 17 00:00:00 2001 From: Shuduo Sang Date: Tue, 7 Jun 2022 12:44:39 +0800 Subject: [PATCH] docs: refine cloud doc cli (#13544) * docs: describe how tdengine cli connect to cloud. * docs: fix install link mistake * docs: fix install client driver link * docs: refine 07-tools/01-cli.md * docs: refine 07-tools/01-cli.md * docs: fix code block * docs: refine 07-tools/01-cli.md --- docs-en/07-tools/01-cli.md | 89 ++++++++++++++------------------------ 1 file changed, 32 insertions(+), 57 deletions(-) diff --git a/docs-en/07-tools/01-cli.md b/docs-en/07-tools/01-cli.md index 0ad859994a..9aaaeeeeb4 100644 --- a/docs-en/07-tools/01-cli.md +++ b/docs-en/07-tools/01-cli.md @@ -4,26 +4,28 @@ sidebar_label: TDengine CLI description: Instructions and tips for using the TDengine CLI to connect TDengine Cloud --- +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +import Preparation from "./_preparation.mdx" The TDengine command-line application (hereafter referred to as `TDengine CLI`) is the most simplest way for users to manipulate and interact with TDengine instances. ## Installation If executed on the TDengine server-side, there is no need for additional installation steps to install TDengine CLI as it is already included and installed automatically. To run TDengine CLI on the environment which no TDengine server running, the TDengine client installation package needs to be installed first. For details, please refer to [Install Client Driver](/reference/connector/#install-client-driver). -## Config (Linux or Mac) + + -Run this command in your Linux terminal or Mac terminal to save your URL and token as variables: +Run this command in your Linux terminal to save your URL and token as variables: ``` export TDENGINE_CLOUD_URL= export TDENGINE_CLOUD_TOKEN= ``` -## Connect (Linux or Mac) - -To access the TDengine Cloud, you can execute `taos -R -h $TDENGINE_CLOUD_URL -t $TDENGINE_CLOUD_TOKEN` command-line utility from a Linux terminal, or Mac terminal. - -## Config (Windows, WIP, coming soon) + + Run this command in your Windows terminal to save your URL and token as variables: @@ -32,70 +34,43 @@ set TDENGINE_CLOUD_URL= set TDENGINE_CLOUD_TOKEN= ``` -## Connect (Windows, WIP, coming soon) + + -To access the TDengine Cloud, you can execute `taos -R -h %TDENGINE_CLOUD_URL% -t %TDENGINE_CLOUD_TOKEN%` command-line utility from a Windows terminal. - -## using TDengine CLI +Run this command in your Mac terminal to save your URL and token as variables: -TDengine CLI will display a welcome message and version information if it successfully connected to the TDengine service. If it fails, TDengine CLI will print an error message. See [FAQ](/train-faq/faq) to solve the problem of terminal connection failure to the server. The TDengine CLI prompts as follows: - -```cmd -taos> ``` -After entering the TDengine CLI, you can execute various SQL commands, including inserts, queries, or administrative commands. - -## Execute SQL script file - -Run SQL command script file in the TDengine CLI via the `source` command. - -```sql -taos> source ; +export TDENGINE_CLOUD_URL= +export TDENGINE_CLOUD_TOKEN= ``` -## Adjust display width to show more characters + + -Users can adjust the display width in TDengine CLI to show more characters with the following command: + + -```sql -taos> SET MAX_BINARY_DISPLAY_WIDTH ; -``` +To access the TDengine Cloud, you can execute `taos -R -h $TDENGINE_CLOUD_URL -t $TDENGINE_CLOUD_TOKEN` command-line utility from a Linux terminal. -If the displayed content is followed by `...` you can use this command to change the display width to display the full content. + + -## Command Line Parameters +To access the TDengine Cloud, you can execute `taos -R -h %TDENGINE_CLOUD_URL% -t %TDENGINE_CLOUD_TOKEN%` command-line utility from a Windows terminal. -You can change the behavior of TDengine CLI by specifying command-line parameters. The following parameters are commonly used. + + -- -R, --restful: The flag to use REST interface to access TDengine Cloud. -- -h, --host=CLOUD_HOST: specify the host url the TDengine Cloud assign for the registered user to access the cloud. -- -t, --token=CLOUD_TOKEN: specify the token the TDengine Cloud assign for the registered user to access the cloud. -- -?, --help: print out all command-line arguments +To access the TDengine Cloud, you can execute `taos -R -h $TDENGINE_CLOUD_URL -t $TDENGINE_CLOUD_TOKEN` command-line utility from a Mac terminal. -And many more parameters. + + -- -d, --database=DATABASE: Specify the database to use when connecting to the server -- -D, --directory=DIRECTORY: Import the SQL script file in the specified path -- -f, --file=FILE: Execute the SQL script file in non-interactive mode -- -k, --check=CHECK: Specify the table to be checked -- -r, --raw-time: output the timestamp format as unsigned 64-bits integer (uint64_t in C language) -- -s, --commands=COMMAND: execute SQL commands in non-interactive mode -- -T, --thread=THREADNUM: The number of threads to import data in multi-threaded mode -- -s, --commands: Run TDengine CLI commands without entering the terminal -- -z, --timezone=TIMEZONE: Specify time zone. Default is the value of current configuration file -- -V, --version: Print out the current version number +## using TDengine CLI -Example. +TDengine CLI will display a welcome message and version information if it successfully connected to the TDengine service. If it fails, TDengine CLI will print an error message. See [FAQ](/train-faq/faq) to solve the problem of terminal connection failure to the server. The TDengine CLI prompts as follows: -```bash -taos -R -h $CLOUD_HOST -t $CLOUD_TOKEN -s "use db; show tables;" +```cmd +taos> ``` +After entering the TDengine CLI, you can execute various SQL commands, including inserts, queries, or administrative commands. Please see [official document](https://docs.tdengine.com/reference/taos-shell#execute-sql-script-file) for more details. -## TDengine CLI tips - -- You can use the up and down keys to iterate the history of commands entered -- Change user password: use `alter user` command in TDengine CLI to change user's password. The default password is `taosdata`. -- use Ctrl+C to stop a query in progress -- Execute `RESET QUERY CACHE` to clear the local cache of the table schema -- Execute SQL statements in batches. You can store a series of shell commands (ending with ;, one line for each SQL command) in a script file and execute the command `source ` in the TDengine CLI to execute all SQL commands in that file automatically -- Enter `q` to exit TDengine CLI -- GitLab