Connect to OceanBase Cloud by using OBClient

This topic describes the prerequisites and procedure for connecting to a MySQL-compatible tenant in an OceanBase Cloud instance by using OceanBase Client (OBClient).

Prerequisites

• You have downloaded and installed OBClient. To download OBClient of the required version, go to OceanBase Download Center.

• You have obtained the connection string of the target MySQL-compatible tenant in an OceanBase Cloud instance. For more information, see Obtain the connection string.

Procedure

1. Open a command shell locally.

2. Run the following command to use OBClient to connect to the target MySQL-compatible tenant in the OceanBase Cloud instance based on the obtained connection string mentioned in the "Prerequisites" section.

   obclient -h ********.oceanbase.cloud -P 3306 -u ***** -D *****  -p
   

   The parameters are described as follows:

   • -h: the access address of OceanBase Cloud.
   • -P: the access port of OceanBase Cloud.
   • -u: the username of the database account.
   • -D: the name of the database to be accessed.
   • -p: the password of the account.

     Note

     For security purposes, we recommend that you do not directly enter the password on the CLI, especially in an environment where the script or historical records are visible. You can skip this option and enter the password when being prompted to.

   The return result is as follows:

   Welcome to the OceanBase.  Commands end with ; or \g.
   Your OceanBase connection id is 16
   Server version: OceanBase 4.3.2.0 (r200000272024061717-93c0ed73ebbcac6edbf7b585860b75d825935358) (Built Jun 17 2024 18:06:04)
   
   Copyright (c) 2000, 2018, OceanBase and/or its affiliates. All rights reserved.
   
   Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
   
   obclient [oceanbase]>
   

3. To exit the OBClient command line, enter exit and press Enter, or press the keyboard shortcut Ctrl + D.