Help Center> GaussDB(DWS)> User Guide (Moscow Region)> Cluster Connection> Using the gsql CLI Client to Connect to a Cluster> Downloading the Client
Updated on 2022-06-16 GMT+08:00
View PDF

Downloading the Client

GaussDB(DWS) provides client tool packages that match the cluster versions. You can download the desired client tool package on the GaussDB(DWS) management console.

The client tool package contains the following:

  • Database connection tool gsql and the script for testing sample data

    gsql is a command line client running on the Linux operating system. It is used to connect to the database in a data warehouse cluster.

    The script for testing sample data is used when you start an example.

Downloading the Client

  1. Log in to the GaussDB(DWS) console. For details, see Accessing the GaussDB(DWS) Management Console.
  2. In the navigation pane on the left, click Connections.
  3. Select the GaussDB(DWS) client of the corresponding version from the drop-down list of gsql CLI Client.

    Choose a corresponding client version according to the cluster version and operating system to which the client is to be installed.

    • The Redhat x86_64 client can be used on the following OSs:
      • RHEL 6.4 to RHEL 7.6
      • CentOS 6.4 to CentOS 7.4
      • EulerOS 2.3
    • The SUSE x86_64 client can be used on the following OSs:
      • SLES 11.1 to SLES 11.4
      • SLES 12.0 to SLES 12.3
    • The Euler Kunpeng_64 client can be used on the following OS:
      • EulerOS 2.8
    Figure 1 Downloading a gsql client

  4. Click Download to download the gsql tool matching the current cluster version. Click Historical Version to download the gsql tool corresponding to the cluster version.

    If clusters of different versions are available, you will download the gsql tool matching the earliest cluster version after clicking Download. If there is no cluster, you will download the gsql tool of the earliest version after clicking Download. GaussDB(DWS) clusters are compatible with earlier versions of gsql tools.

    • In the cluster list on the Clusters page, click the name of the specified cluster and click the Basic Information tab to view the cluster version.

    Table 1 lists the files and folders in the downloaded tool package.

    Table 1 Files and folders in the downloaded tool package

    File or Folder

    Description

    bin

    This folder contains the executable files of gsql on Linux, including the tools gsql, GDS, gs_dump, gs_dumpall, and gs_restore. For details, see "Server Tool".

    gds

    This folder contains the files of the GDS data service tool. The GDS tool is used for parallel data loading and can import the data files stored in a common file system to a GaussDB(DWS) database.

    lib

    This folder contains the lib library required for executing the gsql client.

    sample

    This folder contains the following directories and files:

    • setup.sh: script file for configuring the AK/SK before using gsql to import sample data
    • tpcds_load_data_from_obs.sql: script file for importing the TPC-DS sample data using the gsql client
    • query_sql directory: script file for querying the TPC-DS sample data

    gsql_env.sh

    Script file for configuring environment variables before running the gsql client.