Help Center/ GaussDB(DWS)/ Management Guide/ Cluster Connection/ Using the gsql CLI Client to Connect to a Cluster/ Downloading the Client
Updated on 2024-09-05 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:

  • Linux database connection tool gsql and the script for testing sample data

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

    The script for testing sample data is used to execute the introductory example.

  • Windows gsql

    Windows gsql is a command line client running on the Windows OS. It is used to connect to the database in a data warehouse cluster.

    Only 8.1.3.101 and later cluster versions can be downloaded from the console.

  • GDS tool package

    Gauss Data Service (GDS) is a data service tool. You can use the GDS tool to import a data file in a common file system to the GaussDB(DWS) database. The GDS tool package must be installed on the server where the data source file is located. The server where the data source file is located is called a data server or GDS server.

Downloading the Client

  1. Log in to the GaussDB(DWS) console.
  2. In the navigation tree on the left, choose Management > Client Connections.
  3. Select the GaussDB(DWS) client of the corresponding version from the drop-down list of CLI Client.

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

    Table 1 gsql download links

    OS Type

    Applicable OS

    Download Link

    Verification File

    Microsoft Windows

    Microsoft Windows x86_64:

    • Windows 7 or later
    • Windows Server 2008 or later

    dws_8.1.x_gsql_for_windows.zip

    dws_8.1.x_gsql_for_windows.zip.sha256

    dws_8.2.x_gsql_for_windows.zip

    dws_8.2.x_gsql_for_windows.zip.sha256

    Redhat x86_64

    RHEL 6.4~7.6

    dws_client_8.2.x_redhat_x64.zip

    dws_client_8.2.x_redhat_x64.zip.sha256

    dws_client_8.1.x_redhat_x64.zip

    dws_client_8.1.x_redhat_x64.zip.sha256

    dws_client_8.0.x_redhat_x64.zip

    dws_client_8.0.x_redhat_x64.zip.sha256

    SUSE x86_64

    SLES 11.1~11.4, SLES 12.0~12.3

    dws_client_8.2.x_suse_x64.zip

    dws_client_8.2.x_suse_x64.zip.sha256

    dws_client_8.1.x_suse_x64.zip

    dws_client_8.1.x_suse_x64.zip.sha256

    dws_client_8.0.x_suse_x64.zip

    dws_client_8.0.x_suse_x64.zip.sha256

    Euler Kunpeng_64

    EulerOS 2.0 SP8

    dws_client_8.1.x_euler_kunpeng_x64.zip

    dws_client_8.1.x_euler_kunpeng_x64.zip.sha256

    Redhat Kunpeng_64

    CentOS-7.6-aarch64 and NeoKylin-7.6-aarch64

    (adapted to Kunpeng 920 CPU)

    dws_client_8.1.x_redhat_kunpeng_x64.zip

    dws_client_8.1.x_redhat_kunpeng_x64.zip.sha256
    • The CPU architecture of the client must be the same as that of the cluster. If the cluster uses x86 servers, select an x86 client.
    • Select Microsoft Windows from the Windows gsql package drop-down list. You will get the 32-bit and 64-bit executable binary files.

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

    • You are advised to download the gsql tool that matches the cluster version. That is, use gsql 8.1.x for clusters of 8.1.0 or later, and use gsql 8.2.x for clusters of 8.2.0 or later.
    • The following table describes the files and folders in the Linux gsql tool package.
      Table 2 Files and folders in the Linux gsql tool package

      File or Folder

      Description

      bin

      This folder holds the Linux executable files for gsql, which include 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.
    • The following table describes the files and folders in the Windows gsql tool package.
      Table 3 Files and folders in the Windows gsql tool package

      File or Folder

      Description

      x64

      This folder contains the 64-bit Windows gsql execution binary file and the dynamic library.

      x86

      This folder contains the 32-bit Windows gsql execution binary file and the dynamic library.

      In the cluster list on the Clusters > Dedicated Clusters page, click the name of the specified cluster to go to the Cluster Information page and view the cluster version.