pgclone

概览

preload for async/progress

版本

构建

您可以使用 pig build 命令构建 pgclone 扩展的 RPM / DEB 包：

pig build pkg pgclone         # 构建 RPM / DEB 包

安装

您可以直接安装 pgclone 扩展包的预置二进制包，首先确保 PGDG 和 PIGSTY 仓库已经添加并启用：

pig repo add pgsql -u          # 添加仓库并更新缓存

使用 pig 或者是 apt/yum/dnf 安装扩展：

• 安装
• pig
• dnf
• apt

pig install pgclone;          # 当前活跃 PG 版本安装

pig ext install -y pgclone -v 18  # PG 18
pig ext install -y pgclone -v 17  # PG 17
pig ext install -y pgclone -v 16  # PG 16
pig ext install -y pgclone -v 15  # PG 15
pig ext install -y pgclone -v 14  # PG 14

dnf install -y pgclone_18       # PG 18
dnf install -y pgclone_17       # PG 17
dnf install -y pgclone_16       # PG 16
dnf install -y pgclone_15       # PG 15
dnf install -y pgclone_14       # PG 14

apt install -y postgresql-18-pgclone   # PG 18
apt install -y postgresql-17-pgclone   # PG 17
apt install -y postgresql-16-pgclone   # PG 16
apt install -y postgresql-15-pgclone   # PG 15
apt install -y postgresql-14-pgclone   # PG 14

预加载配置：

shared_preload_libraries = 'pgclone';

创建扩展：

CREATE EXTENSION pgclone;

用法

来源：README，Usage guide，Async guide，Release v4.0.0，SQL install script

pgclone 可以直接通过 SQL 克隆 tables、schemas、functions、roles 以及整个 database。在 v4.0.0 中，公开 API 被放入 pgclone schema。

核心克隆函数

CREATE EXTENSION pgclone;

SELECT pgclone.table(
  'host=source-server dbname=mydb user=postgres password=secret',
  'public',
  'customers',
  true
);

SELECT pgclone.schema(
  'host=source-server dbname=mydb user=postgres password=secret',
  'sales',
  true
);

SELECT pgclone.database(
  'host=source-server dbname=mydb user=postgres password=secret',
  true
);

• pgclone.table(...)、pgclone.schema(...)、pgclone.functions(...)、pgclone.database(...)
• pgclone.database_create(...) 会创建本地目标 database 并在其中执行克隆。
• _ex 变体显式暴露 indexes、constraints 与 triggers 的布尔开关。

选项与脱敏

• JSON 选项支持 columns、where、conflict，以及 indexes、constraints、triggers 等对象开关。
• 上游在 usage guide 中记录了 masking、敏感列自动发现、静态脱敏、动态脱敏、clone verification，以及 GDPR/compliance reporting。

SELECT pgclone.table(
  'host=source-server dbname=mydb user=postgres',
  'public', 'users', true, 'users_lite',
  '{"columns":["id","name","email"],"where":"status = ''active''"}'
);

异步与进度

-- postgresql.conf
shared_preload_libraries = 'pgclone'

SELECT pgclone.schema_async(
  'host=source-server dbname=mydb user=postgres',
  'sales', true, '{"parallel":4}'
);

SELECT * FROM pgclone.jobs_view;
SELECT pgclone.progress(1);
SELECT pgclone.cancel(1);

• pgclone.table_async(...) 与 pgclone.schema_async(...) 在 background workers 中运行。
• pgclone.jobs_view、pgclone.progress_detail()、pgclone.resume() 与 pgclone.clear_jobs() 提供 job 跟踪与恢复能力。

注意事项

• 上游要求 PostgreSQL 14+。
• usage guide 说明安装和使用该扩展都需要 superuser 权限。
• 异步功能需要 shared_preload_libraries = 'pgclone'；worker pool 并行度还取决于 max_worker_processes。