Exporting a Schema

You can use gs_dump to export data and all object definitions of a schema from openGauss. You can export one or more specified schemas as needed. You can specify the information to export as follows:

• Export full information of a schema, including its data and object definitions.
• Export data of a schema, excluding its object definitions.
• Export the object definitions of a schema, including the definitions of tables, stored procedures, and indexes.

Procedure

1. Log in as the OS user omm to the primary node of the database.

2. Run gs_dump to export the hr and public schemas.

   gs_dump -U jack -f /home/omm/backup/MPPDB_schema_backup -p 8000 human_resource -n hr -n public -F d 
   Password:
   

   Table 1 Common parameters

   Parameter	Parameter Description	Example Value
   -U	Username for database connection.	-U jack
   -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 abcd@123
   -f	Folder to store exported files. If this parameter is not specified, the exported files are stored in the standard output.	-f /home/omm/backup/MPPDB_schema_backup
   -p	TCP port or the local Unix-domain socket file name extension on which the server is listening for connections.	-p 8000
   dbname	Name of the database to export.	human_resource
   -n	Names of schemas to export. Data of the specified schemas will also be exported. Single schema: Enter -n schemaname. Multiple schemas: Enter -n schemaname for each schema.	Single schemas: -n hr Multiple schemas: -n hr -n public
   -F	Select the format of file to export. The values of -F are as follows: p: plaintext c: custom d: directory t: .tar	-F d

   For details about other parameters, see “Server Tools > gs_dump” in the Tool Reference.

Examples

Example 1: Run gs_dump to export full information of the hr schema. The exported files are compressed and stored in text format.

gs_dump -f /home/omm/backup/MPPDB_schema_backup.sql -p 8000 human_resource -n hr -Z 6 -F p
Password:
gs_dump[port='8000'][human_resource][2017-07-21 16:05:55]: dump database human_resource successfully
gs_dump[port='8000'][human_resource][2017-07-21 16:05:55]: total time: 2425  ms

Example 2: Run gs_dump to export data of the hr schema. The exported files are in .tar format.

gs_dump -f /home/omm/backup/MPPDB_schema_data_backup.tar -p 8000 human_resource -n hr -a -F t
Password:
gs_dump[port='8000'][human_resource][2018-11-14 15:07:16]: dump database human_resource successfully
gs_dump[port='8000'][human_resource][2018-11-14 15:07:16]: total time: 1865  ms

Example 3: Run gs_dump to export the object definitions of the hr schema. The exported files are stored in a directory.

gs_dump -f /home/omm/backup/MPPDB_schema_def_backup -p 8000 human_resource -n hr -s -F d
Password:
gs_dump[port='8000'][human_resource][2018-11-14 15:11:34]: dump database human_resource successfully
gs_dump[port='8000'][human_resource][2018-11-14 15:11:34]: total time: 1652  ms

Example 4: Run gs_dump to export the human_resource database excluding the hr schema. The exported files are in a custom format.

gs_dump -f /home/omm/backup/MPPDB_schema_backup.dmp -p 8000 human_resource -N hr -F c
Password:
gs_dump[port='8000'][human_resource][2017-07-21 16:06:31]: dump database human_resource successfully
gs_dump[port='8000'][human_resource][2017-07-21 16:06:31]: total time: 2522  ms

Example 5: Run gs_dump to export the object definitions of the hr and public schemas, encrypt the exported files, and store them in .tar format.

gs_dump -f /home/omm/backup/MPPDB_schema_backup1.tar -p 8000 human_resource -n hr -n public -s --with-encryption AES128 --with-key 1234567812345678 -F t
Password:
gs_dump[port='8000'][human_resource][2017-07-21 16:07:16]: dump database human_resource successfully
gs_dump[port='8000'][human_resource][2017-07-21 16:07:16]: total time: 2132  ms

Example 6: Run gs_dump to export the human_resource database excluding the hr and public schemas. The exported files are in a custom format.

gs_dump -f /home/omm/backup/MPPDB_schema_backup2.dmp -p 8000 human_resource -N hr -N public -F c
Password:
gs_dump[port='8000'][human_resource][2017-07-21 16:07:55]: dump database human_resource successfully
gs_dump[port='8000'][human_resource][2017-07-21 16:07:55]: total time: 2296  ms

Example 7: Run gs_dump to export all tables (views, sequences, and foreign tables are also included) in the public schema and the staffs table in the hr schema, including data and table definition. The exported files are in a custom format.

gs_dump -f /home/omm/backup/MPPDB_backup3.dmp -p 8000 human_resource -t public.* -t hr.staffs -F c
Password:
gs_dump[port='8000'][human_resource][2018-12-13 09:40:24]: dump database human_resource successfully
gs_dump[port='8000'][human_resource][2018-12-13 09:40:24]: total time: 896  ms