Help Center/ GaussDB(DWS)/ Data Migration and Synchronization/ Exporting Data/ Using GDS to Export Data to a Remote Server/ Installing, Configuring, and Starting GDS
Updated on 2025-03-24 GMT+08:00
View PDF
Share

Installing, Configuring, and Starting GDS

GDS is a data service tool provided by GaussDB(DWS). Using the foreign table mechanism, this tool helps export data at a high speed.

To install, configure, and start GDS, perform the following steps. For details, see Installing, Configuring, and Starting GDS.

Procedure

  1. Before using GDS to import or export data, see "Preparing an ECS as the GDS Server" and "Downloading the GDS Package" in Tutorial: Using GDS to Import Data from a Remote Server.
  2. Log in as user root to the data server where GDS is to be installed and run the following command to create the directory for storing the GDS package: 

    mkdir -p /opt/bin/dws

  3. Upload the GDS package to the created directory.

    Use the SUSE Linux package as an example. Upload the GDS package dws_client_8.x.x_suse_x64.zip to the directory created in the previous step.

  4. (Optional) If SSL is used, upload the SSL certificates to the directory created in 2.
  5. Go to the directory and extract the package. 

    cd /opt/bin/dws
unzip dws_client_8.x.x_suse_x64.zip

  6. Create a GDS user and the user group to which the user belongs. This user is used to start GDS and read source data. 

    groupadd gdsgrp
useradd -g gdsgrp gds_user

  7. Change the owner of the GDS package directory and source data file directory to the GDS user. 

    chown -R gds_user:gdsgrp /opt/bin/dws/gds
chown -R gds_user:gdsgrp /input_data

  8. Switch to user gds_user. 

    su - gds_user

    If the current cluster version is 8.0.x or earlier, skip 9 and go to 10.

    If the current cluster version is 8.1.x, go to the next step.

  9. Execute the script on which the environment depends (applicable only to version 8.1.x). 

    cd /opt/bin/dws/gds/bin
source gds_env

  10. Start GDS.

    GDS is green software and can be started after being decompressed. There are two ways to start GDS.

    Method 1: Run the gds command to set startup parameters.

    Method 2: Write the startup parameters into the gds.conf configuration file and run the gds_ctl.py command to start GDS.

    The first method is recommended when you do not need to import data again. The second method is recommended when you need to import data regularly.
    • Method 1: Run the gds command to start GDS.
      • If data is transmitted in non-SSL mode, run the following command to start GDS: 
        gds -d dir -p ip:port -H address_string -l log_file -D -t worker_num

        Example:

        /opt/bin/dws/gds/bin/gds -d /input_data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 -l /opt/bin/dws/gds/gds_log.txt -D -t 2
      • If data is transmitted in SSL mode, run the following command to start GDS: 
        gds -d dir -p ip:port -H address_string -l log_file -D 
-t worker_num --enable-ssl --ssl-dir Cert_file

        Example:

        Run the following commands to upload the SSL certificates mentioned in 4 to /opt/bin: 
        /opt/bin/dws/gds/bin/gds -d /input_data/ -p 192.168.0.90:5000 -H 10.10.0.1/24 -l /opt/bin/dws/gds/gds_log.txt -D --enable-ssl --ssl-dir /opt/bin/

      Replace the information in italic as required.

      • -d dir: directory to store data files that contain data to import. This tutorial uses /input_data/ as an example.
      • -p ip:port: listening IP address and port for GDS. The default value is 127.0.0.1. Replace it with the IP address of a 10GE network that can communicate with GaussDB(DWS). The port number ranges from 1024 to 65535. The default value is 8098. This tutorial uses 192.168.0.90:5000 as an example.
      • -H address_string: servers that are allowed to connect to and use GDS. The value must be in CIDR format. Set this parameter to enable a GaussDB(DWS) cluster to access GDS for data import. Ensure that the network segment covers all hosts in a GaussDB(DWS) cluster.
      • -l log_file: GDS log directory and log file name. This tutorial uses /opt/bin/dws/gds/gds_log.txt as an example.
      • -D: GDS in daemon mode. This command can only be used in Linux.
      • -t worker_num: number of concurrent GDS threads. If the data server and GaussDB(DWS) have available I/O resources, you can increase the number of concurrent GDS threads.

        GDS determines the number of threads based on the number of parallel import transactions. Even if multi-thread import is configured before GDS startup, the import of a single transaction will not be accelerated. By default, an INSERT statement is an import transaction.

      • --enable-ssl: enables SSL for data transmission.
      • --ssl-dir Cert_file: SSL certificate directory. Set this parameter to the certificate directory in 4.
      • For details about GDS parameters, see gds.
    • Method 2: Write the startup parameters into the gds.conf configuration file and run the gds_ctl.py command to start GDS.
      1. Run the following command to go to the config directory of the GDS package and modify the gds.conf configuration file. For details about the parameters in the gds.conf configuration file, see Table 1. 
        vim /opt/bin/dws/gds/config/gds.conf

        Example:

        Configure the gds.conf file as follows:

        <?xml version="1.0"?>
<config>
<gds name="gds1" ip="192.168.0.90" port="5000" data_dir="/input_data/" err_dir="/err" data_seg="100MB" err_seg="100MB" log_file="/log/gds_log.txt" host="10.10.0.1/24" daemon='true' recursive="true" parallel="32"></gds>
</config>

        Information in the configuration file is as follows:

        • The data server IP address is 192.168.0.90, and the GDS listening port is 5000.
        • Data files are stored in /input_data/.
        • Error log files are stored in /err. This directory must be created by a user with GDS read and write permissions.
        • The size of a single data file is 100 MB.
        • The size of each error log file is 100 MB.
        • Logs are stored in the /log/gds_log.txt file. This directory must be created by a user with GDS read and write permissions.
        • Only nodes with the IP address 10.10.0.* can be connected.
        • The GDS process runs in the background.
        • Data file directories are recursive.
        • The number of concurrent import threads is 2.
      2. Start GDS and check whether it has been started. 
        python3 gds_ctl.py start

        Example:

        cd /opt/bin/dws/gds/bin
python3 gds_ctl.py start
Start GDS gds1                  [OK]
gds [options]:
 -d dir            Set data directory.
 -p port           Set GDS listening port.
    ip:port        Set GDS listening ip address and port.
 -l log_file       Set log file.
 -H secure_ip_range
                   Set secure IP checklist in CIDR notation. Required for GDS to start.
 -e dir            Set error log directory.
 -E size           Set size of per error log segment.(0 < size < 1TB)
 -S size           Set size of data segment.(1MB < size < 100TB)
 -t worker_num     Set number of worker thread in multi-thread mode, the upper limit is 200. If without setting, the default value is 8.
 -s status_file    Enable GDS status report.
 -D                Run the GDS as a daemon process.
 -r                Read the working directory recursively.
 -h                Display usage.