Using the IoTDB Client

Updated on 2024-10-09 GMT+08:00

View PDF

Scenario

This section describes how to use the IoTDB client in the O&M or service scenario.

Prerequisites

The client has been installed. For example, the installation directory is /opt/client. The client directory in the following operations is only an example. Change it based on the actual installation directory onsite.
Service component users have been created by the MRS cluster administrator. In security mode, machine-machine users need to download the keytab file. A human-machine user must change the password upon the first login.

Procedure

Log in to the node where the client is installed as the client installation user.
Run the following command to go to the client installation directory:

cd /opt/client
Run the following command to configure environment variables:

source bigdata_env
Before logging in to the IoTDB client for the first time, perform the following steps to generate a client SSL certificate:
1. Run the following command to generate a client SSL certificate:
  keytool -noprompt -import -alias myservercert -file ca.crt -keystore truststore.jks
  
  After running this command, you are required to set a password.
2. Copy the generated truststore.jks file to the Client installation directory/IoTDB/iotdb/conf directory.
  cp truststore.jks Client installation directory/IoTDB/iotdb/conf
Log in to the IoTDB client based on the cluster authentication mode.
- In security mode, run the following command to authenticate the user and log in to the IoTDB client:
  kinit Component service user
- Skip this step in normal mode.
Run the following command to switch to the directory where the IoTDB client running script is stored:

cd /opt/client/IoTDB/iotdb/sbin
If Kerberos authentication is disabled for the cluster (the cluster is in normal mode), invoke the alter-cli-password.sh script to change the default password of the default user root.

sh alter-cli-password.sh IP address of the IoTDBServer instance RPC port number
NOTE:
- To view the IP address of the IoTDBServer instance node, log in to FusionInsight Manager and choose Cluster > Services > IoTDB > Instances.
- The IoTDBServer RPC port can be configured in the IoTDB_SERVER_RPC_PORT parameter. The default ports are as follows:
  - The default open-source port number is 6667.
  - The default customized port number is 22260.
  Port customization/open source: When creating an LTS version cluster, you can set Component Port to Open source or Custom. If Open source is selected, the open source port is used. If Custom is selected, the customized port is used.
- The initial password of user root is root in versions earlier than MRS 3.3.0 and Iotdb@123 in MRS 3.3.3.0 and later versions.
  The password must contain at least four characters in versions earlier than MRS 3.3.0 and at least eight characters in MRS 3.3.0 and later versions, and cannot contain spaces.
Run the following command to log in to the client:

./start-cli.sh -h IP address of the IoTDBServer instance node -p IoTDBServer RPC port

After you run this command, specify the service username as required.
- To specify the service username, enter yes and enter the service username and password as prompted.
- If you will not specify the service username, enter no. In this case, you will perform subsequent operations as the user in 5.
- If you enter other information, you will log out.
NOTE:
- If Kerberos authentication is disabled for the cluster (the cluster is in normal mode), use the default user root to log in to the IoTDB client.
- When you log in to the client, you can configure the -maxRPC parameter to control the number of lines of execution results to be printed at a time. The default value is 1000. If the value of -maxRPC is less than or equal to 0, all results are printed at a time. This parameter is typically used to redirect SQL execution results.
- Meanwhile, you can optionally use the -disableISO8601 parameter to control the display format of the time column in the query result. If this parameter is not specified, the time is displayed in YYYYMMDDHHMMSS format. If this parameter is specified, the timestamp is displayed.
- If the SSL configuration is disabled on the server, you need to disable it on the client as follows:
  cd Client installation directory/IoTDB/iotdb/conf
  
  vi iotdb-client.env
  
  Change the value of iotdb_ssl_enable to false, save the configuration, and exit.
  
  To check the SSL configuration of the server, log in to FusionInsight Manager, choose Cluster > Services > IoTDB > Configurations, and search for SSL_ENABLE. Value true indicates that SSL is enabled, and value false indicates that it is disabled.
After logging in to the client, you can run SQL statements.

Parent topic: Using IoTDB

Previous topic: Creating an IoTDB Permission Role

Next topic: Getting Started with IoTDB

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot