Updated on 2022-06-11 GMT+08:00

Exporting Global Objects

You can use gs_dumpall to export global objects from GaussDB(DWS), including database users, user groups, tablespaces, and attributes (for example, global access permissions).

Procedure

  1. Prepare an ECS as the gsql client host. For details, see "Preparing an ECS as the gsql Client Host" in the Data Warehouse Service (DWS) User Guide.
  2. Download the gsql client and use an SSH transfer tool (such as WinSCP) to upload it to the Linux server where gsql is to be installed. For details, see "Downloading the Client" in Data Warehouse Service User Guide.

    The user who uploads the client must have the full control permission on the target directory on the host to which the client is uploaded.

  3. Run the following commands to decompress the client:

    cd <Path_for_storing_the_client>
    unzip dws_client_8.1.x_redhat_x64.zip

    Where,

    • <Path_for_storing_the_client>: Replace it with the actual path.
    • dws_client_8.1.x_redhat_x86.zip: This is the client tool package of RedHat x86. Replace it with the actual one.

  4. Run the following command to configure the GaussDB(DWS) client:

    source gsql_env.sh

    If the following information is displayed, the GaussDB(DWS) client is successfully configured:

    All things done.

  5. Use gs_dumpall to run the following command to export tablespace objects.

    gs_dumpall -W Passwd@123 -U dbadmin -f /home/dbadmin/backup/MPPDB_tablespace.sql -p 8000 -h 10.10.10.100 -t
    Table 1 Common parameters

    Parameter

    Description

    Example Value

    -U

    Username for database connection. The user must be a cluster administrator.

    -U dbadmin

    -W

    User password for database connection.

    • This parameter is not required for database administrators if the trust policy is used for authentication.
    • If you connect to the database without specifying this parameter and you are not a database administrator, you will be prompted to enter the password.

    -W Passwd@123

    -f

    Folder to store exported files. If this parameter is not specified, the exported files are stored in the standard output.

    -f /home//backup/MPPDB_tablespace.sql

    -p

    Name extension of the TCP port on which the server is listening or the local Unix domain socket. This parameter is configured to ensure connections.

    -p 8000

    -h

    Cluster address: If a public network address is used for connection, set this parameter to Public Network Address or Public Network Domain Name. If a private network address is used for connection, set this parameter to Private Network Address or Private Network Domain Name.

    -h 10.10.10.100

    -t

    Dumps only tablespaces. You can also use --tablespaces-only alternatively.

    -

    For details about other parameters, see "gs_dumpall" in the Tool Guide.

Examples

Example 1: Use gs_dumpall to run the following command as the cluster administrator dbadmin to export information of global tablespaces and users in a cluster. The exported files are in text format.

gs_dumpall -W Passwd@123 -U dbadmin -f /home/dbadmin/backup/MPPDB_globals.sql -p 8000 -h 10.10.10.100 -g
gs_dumpall[port=''][2018-11-14 19:06:24]: dumpall operation successful
gs_dumpall[port=''][2018-11-14 19:06:24]: total time: 1150  ms

Example 2: Use gs_dumpall to run the following command as the cluster administrator dbadmin to export global tablespaces in a cluster, encrypt the exported files, and store them in text format.

gs_dumpall -W Passwd@123 -U dbadmin -f /home/dbadmin/backup/MPPDB_tablespace.sql -p 8000 -h 10.10.10.100 -t --with-encryption AES128 --with-key 1212121212121212
gs_dumpall[port=''][2018-11-14 19:00:58]: dumpall operation successful
gs_dumpall[port=''][2018-11-14 19:00:58]: total time: 186  ms

Example 3: Use gs_dumpall to run the following command as the cluster administrator dbadmin to export information of global users in a cluster. The exported files are in text format.

gs_dumpall -W Passwd@123 -U dbadmin -f /home/dbadmin/backup/MPPDB_user.sql -p 8000 -h 10.10.10.100 -r
gs_dumpall[port=''][2018-11-14 19:03:18]: dumpall operation successful
gs_dumpall[port=''][2018-11-14 19:03:18]: total time: 162  ms