• Data Warehouse Service

dws
  1. Help Center
  2. Data Warehouse Service
  3. User Guide
  4. Connecting to a Cluster
  5. Using the Data Studio GUI Client to Connect to a Cluster

Using the Data Studio GUI Client to Connect to a Cluster

Data Studio is a SQL client tool running on the Windows OS. It provides various GUIs for you to manage databases and database objects, as well as edit, run, and debug SQL scripts, and view execution plans. Download the Data Studio software package from the DWS management console. The package can be used without installation after being decompressed.

DataStudio versions include Windows x86 (32-bit Windows system) and Windows x64 (64-bit Windows system).

Preparations Before Connecting to a Cluster

  • An EIP has been bound to the data warehouse cluster.
  • You have obtained the administrator username and password for logging in to the database in the data warehouse cluster.
  • You have obtained the public network address, including the IP address and port number in the data warehouse cluster. For details, see Obtaining the Cluster Connection Address.
  • You have configured the security group to which the data warehouse cluster belongs and added a rule that allows users' IP addresses to access ports using the TCP.

    For details, see section Adding a Security Group Rule in the Virtual Private Cloud User Guide.

Using Data Studio to Connect to the Cluster's Database

  1. Log in to the management console at https://console.otc.t-systems.com/dws/.
  2. Click Connection Management.
  3. On the Download Client and Driver page, select the corresponding Data Studio GUI Client. Select Microsoft Windows x86 or Microsoft Windows x64 based on the OS type and click Download.
  4. Decompress the downloaded client software package (32-bit or 64-bit) to the installation directory.
  5. Open the installation directory and double-click Data Studio.exe to start the Data Studio client. See Figure 1.

    NOTE:

    Install Java 1.8.0_141 or later corresponding to the OS bits. Otherwise, the Data Studio client cannot be started.

    Figure 1 Starting the client

  6. Choose File > New Connection from the main menu. See Figure 2.

    Figure 2 Creating a connection

  7. In the displayed New Database Connection window, enter the connection parameters. See Figure 3.

    Figure 3 Configuring connection parameters
    Table 1 Connection parameters

    Field Name

    Description

    Example

    Connection Name

    Connection name

    DWS_DB

    Host

    IP address (IPv4) or domain name of the cluster to be connected

    -

    Host Port

    Port address

    8000

    Database Name

    Database name

    postgres

    User Name

    Name of the user who wants to connect to the database

    -

    Password

    Password for logging in to the database to be connected

    -

    Save Password

    Select an option from the drop-down list:

    • Current Session Only: The password is saved only in the current session.
    • Do Not Save: The password is not saved.

    -

  8. Determine whether to enable SSL. The SSL mode is more secure than the common mode. You are advised to enable the SSL mode on the client.

    • To enable SSL, select Enable SSL on the General tab and perform Step 9 to Step 11.
    • To disable SSL, deselect Enable SSL on the General tab and perform Step 10.

  9. Enable SSL connection.

    1. On the General tab, select Enable SSL.
    2. Click the SSL tab.
    3. On the SSL configuration page, set the following parameters:
      Download the SSL certificate. For details, see section Downloading the SSL Certificate File. Then, decompress the certificate file to the specified path.
      • Client SSL Certificate: Click and select the sslcert\client.crt file in the decompressed directory.
      • Client SSL Key: Click and select the sslcert\client.key file in the decompressed directory.
      • Root Certificate: Based on the selected SSL Mode, click and select the sslcert\cacert.pem file in the decompressed directory.
      • SSL mode: Select an SSL mode from the drop-down list. Possible values are require and verify-ca (DWS does not support the verify-full mode). If SSL Mode is set to verify-ca, the root certificate is required.
      Figure 4 Configuring SSL parameters

  10. Click OK to establish the database connection.
  11. (Optional) If SSL is enabled, click Continue in the displayed Connection Security Alert dialog box.

    After the login is successful, the RECENT LOGIN ACTIVITY dialog box is displayed, indicating that the Data Studio is connected to the database. You can run the SQL statement in the SQL Terminal window on the Data Studio page.

    Figure 5 Successful login

  12. (Optional) For details about how to use other functions of Data Studio, press F1 to view the Data Studio user manual.