【GaussDB】使用gs_dump和gs_dumpall命令导出数据使用gs_dump和gs_dumpall命令导出数

使用gs_dump和gs_dumpall命令导出数据

操作场景

GaussDB提供的gs_dump和gs_dumpall工具，能够帮助用户导出需要的数据库对象或其相关信息。通过导入工具将导出的数据信息导入至需要的数据库，可以完成数据库信息的迁移。gs_dump支持导出单个数据库或其内的对象，而gs_dumpall支持导出数据库中所有数据库或各库的公共全局对象。详细的使用场景见表1。

说明：

在多租场景下，gs_dump支持导出单个PDB或其内的对象，而gs_dumpall不支持导出PDB及其内的对象。

表1 适用场景

适用场景

支持的导出粒度

支持的导出格式

配套的导入方法

导出单个数据库

数据库级导出（参见导出数据库）。

导出全量信息。

使用导出的全量信息可以创建一个与当前库相同的数据库，且库中数据也与当前库相同。
仅导出库中所有对象的定义，包含库定义、函数定义、模式定义、表定义、索引定义和存储过程定义等。

使用导出的对象定义，可以快速创建一个相同的数据库，但是库中并无原数据库的数据。
仅导出数据。
纯文本格式
自定义归档格式
目录归档格式
tar归档格式
纯文本格式数据文件导入使用gsql工具，请参见《工具参考》中“gsql”章节。
自定义归档格式、目录归档格式和tar归档格式数据文件导入请参见使用gs_restore命令导入数据。

模式级导出（参见导出模式）。

导出模式的全量信息。
仅导出模式中数据。
仅导出对象的定义，包含表定义、存储过程定义和索引定义等。

表级导出（参见导出表）。

导出表的全量信息。
仅导出表中数据。
仅导出表的定义。

导出所有数据库

数据库级导出（参见导出所有数据库）。

导出全量信息。

使用导出的全量信息可以创建与当前主机相同的一个主机环境，拥有相同数据库和公共全局对象，且库中数据也与当前各库相同。
仅导出各数据库中的对象定义，包含表空间、库定义、函数定义、模式定义、表定义、索引定义和存储过程定义等。

使用导出的对象定义，可以快速创建与当前主机相同的一个主机环境，拥有相同的数据库和表空间，但是库中并无原数据库的数据。
仅导出数据。

纯文本格式

数据文件导入请参见使用copy from命令导入数据。

各库公共全局对象导出（参见导出全局对象）。

仅导出表空间信息。
仅导出角色信息。
导出角色与表空间。

gs_dump和gs_dumpall通过-U指定执行导出的用户账户。如果当前使用的账户不具备导出所要求的权限时，会无法导出数据。可使用该功能的场景请参见表1

注意事项

gs_dump和gs_dumpall通过对导出的数据文件加密，导入时对加密的数据文件进行解密，可以防止数据信息泄露，为数据库的安全提供保证。注意，使用gs_dump加密的纯文本格式文件，因gsql不支持解密导入存储过程和函数，因此如果导出的数据库中包含存储过程/函数，请使用另外三种模式导出数据库，并使用gs_restore恢复。

gs_dump和gs_dumpall工具在进行数据导出时，其他用户可以访问数据库（读或写）。

gs_dump和gs_dumpall工具支持导出完整一致的数据。例如，T1时刻启动gs_dump导出A数据库，或者启动gs_dumpall导出GaussDB数据库，那么导出数据结果将会是T1时刻A数据库或者该GaussDB数据库的数据状态，T1时刻之后对A数据库或GaussDB数据库的修改不会被导出。

gs_dump和gs_dumpall工具导出数据时，生成列不会被转储。

禁止修改-F c/d/t 格式导出的文件和内容，否则可能无法恢复成功。对于-F p 格式导出的文件，如有需要，可根据需要谨慎编辑导出文件。
如果数据库中包含的对象数量（数据表、视图、索引）在50万以上，为了提高性能且避免出现内存问题，建议联系技术支持。
为了保证数据一致性和完整性，导出工具会对需要转储的表设置共享锁。如果表在别的事务中设置了共享锁，gs_dump和gs_dumpall会等待锁释放后锁定表。如果无法在指定时间内锁定某个表，转储会失败。用户可以通过指定--lock-wait-timeout选项，自定义等待锁超时时间。
由于gs_dumpall读取所有数据库中的表，因此必须以数据库管理员身份进行连接，才能导出完整文件。在使用gsql执行脚本文件导入时，同样需要管理员权限，以便添加用户和组，以及创建数据库。

迁移准备

准备弹性云服务器或可通过公网访问GaussDB。
- 通过弹性云服务器连接GaussDB数据库实例，需要创建一台弹性云服务器。
  
  创建并登录弹性云服务器，请参见《弹性云服务器快速入门》中“购买弹性云服务器”和“登录弹性云服务器”。
- 通过公网地址连接GaussDB数据库实例，需具备以下条件。
  1. 先对GaussDB数据库实例绑定公网地址，如何绑定公网地址，请参见绑定弹性公网IP。
  2. 保证本地设备可以访问GaussDB数据库实例绑定的公网地址。
在准备的弹性云服务器或可访问GaussDB数据库的设备上，安装gsql客户端，并连接到GaussDB数据库实例。详情请参见使用gsql连接数据库。

导出数据库

创建准备导出的库和表，并插入数据。

create database gs_example;

\c gs_example
password: 

create schema gs_sch_example;
set search_path to gs_sch_example;
create table gs_table_example
(
 col_1 integer,
 col_2 text,
 col_3 varchar(12),
 col_4 date,
 col_5 time
);
insert into gs_table_example values(1,'iamtext','iamvarchar','2006-07-07','12:00:00');
insert into gs_table_example values(2,'sometext','somevarchar','2006-07-07','12:00:00');
insert into gs_table_example values(3,'sometext','somevarchar','2006-07-07','12:00:00');
insert into gs_table_example values(4,'sometext','somevarchar','2006-07-07','19:00:02');
insert into gs_table_example values(5,'sometext','somevarchar','2006-07-07', null);
insert into gs_table_example values(6,'sometext','somevarchar','2006-07-07','19:00:02');

使用gs_dump导出gs_example数据库。

示例一：执行gs_dump，指定数据库IP，导出gs_example数据库全量信息，导出文件格式为sql文本格式。

gs_dump -U root -f /tmp/data/gs_example_dump.sql -p 8000 gs_example -F p -h 192.*.*.139; 
Password:
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:04:20]: The total objects number is 458.
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:04:20]: [100.00%] 458 objects have been dumped.
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:04:20]: dump database gs_example successfully
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:04:20]: total time: 8779  ms

示例二：执行gs_dump，指定数据库IP，导出gs_example数据库全量信息，以tar归档格式到'/tmp/data/gs_example_dump.tar'文件中。

gs_dump -U root -f /tmp/data/gs_example_dump.tar -p 8000 gs_example -F t -h 192.*.*.139; 
Password:
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 14:58:49]: The total objects number is 458.
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 14:58:49]: [100.00%] 458 objects have been dumped.
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 14:58:49]: dump database gs_example successfully
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 14:58:49]: total time: 8201  ms

示例三：执行gs_dump，指定数据库IP，仅导出gs_example数据库中的数据，不包含数据库对象定义，导出文件格式为自定义归档格式。

gs_dump -U root -f /tmp/data/gs_example_dump.dmp -p 8000 gs_example -a -F c -h 192.*.*.139; 
Password:
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:07:23]: dump database gs_example successfully
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:07:23]: total time: 8369  ms

示例四：执行gs_dump，指定数据库IP，仅导出gs_example数据库所有对象的定义，导出文件格式为sql文本格式。

gs_dump -U root -f /tmp/data/gs_example_dump_s.sql -p 8000 gs_example -s -F p -h 192.*.*.139; 
Password:
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:09:37]: The total objects number is 457.
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:09:37]: [100.00%] 457 objects have been dumped.
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:09:37]: dump database gs_example successfully
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:09:37]: total time: 8523  ms

示例五：执行gs_dump，指定数据库IP，仅导出gs_example数据库的所有对象的定义，导出文件格式为文本格式，并对导出文件进行加密。

gs_dump -U root -f /tmp/data/gs_example_dump_s_key.sql -p 8000 gs_example --with-encryption AES128 --with-key abcdefg_?1234567 -s -F p -h 192.*.*.139;
Password:
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:10:38]: The total objects number is 457.
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:10:38]: [100.00%] 457 objects have been dumped.
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:10:38]: dump database gs_example successfully
gs_dump[user='root'][localhost][port='8000'][gs_example][2024-07-26 15:10:38]: total time: 9101  ms