How ankane/pgsync works
pgsync is a command-line tool for selectively copying PostgreSQL data between a source and a destination, with optional schema transfer and data anonymization. The main workflow parses CLI options, resolves configuration and table/group selections, then performs schema and/or table synchronization. Table transfers can run in parallel and support filtered rows, conflict handling, batching, and constraint controls. The README also documents initialization, sequence handling, and table listing. Some orchestration and sequence implementation details are unsampled, so those connections are limited to documented behavior or shown calls.
Main entry points: sync.rb Sync coordinator · data_source.rb Database adapter · table_sync.rb Table scheduler · schema_sync.rb Schema transfer
Components 15
CLI and setup
- CLI client
lib/pgsync/client.rb - Config initializer
lib/pgsync/init.rb - Config template
config.yml
Sync planning
- Sync coordinator
lib/pgsync/sync.rb - Task resolver
lib/pgsync/task_resolver.rb - Table identity
lib/pgsync/table.rb
Schema and data transfer
- Schema transfer
lib/pgsync/schema_sync.rb - Postgres dump tools
- Table scheduler
lib/pgsync/table_sync.rb - Table transfer task
lib/pgsync/task.rb - Sequence identity
lib/pgsync/sequence.rb
Database access
- Database adapter
lib/pgsync/data_source.rb
Other components
- Operator
- Source PostgreSQL
- Destination PostgreSQL
Connections 22
- Operator → CLI client: runs commands
README.md - CLI client → Config initializer: dispatches init
lib/pgsync/client.rb - CLI client → Sync coordinator: dispatches sync
lib/pgsync/client.rb - Config initializer → Config template: reads template
lib/pgsync/init.rb - Sync coordinator → Database adapter: creates adapters
lib/pgsync/sync.rb - Database adapter → Source PostgreSQL: queries
lib/pgsync/data_source.rb - Database adapter → Destination PostgreSQL: queries
lib/pgsync/data_source.rb - Sync coordinator → Task resolver: resolves tasks
lib/pgsync/sync.rb - Task resolver → Table identity: builds table IDs
lib/pgsync/task_resolver.rb - Task resolver → Database adapter: lists tables
lib/pgsync/task_resolver.rb - Sync coordinator → Schema transfer: runs schema transfer
lib/pgsync/sync.rb - Schema transfer → Postgres dump tools: pipes dump to restore
lib/pgsync/schema_sync.rb - Schema transfer → Database adapter: creates schemas
lib/pgsync/schema_sync.rb - Sync coordinator → Table scheduler: runs table transfer
lib/pgsync/sync.rb - Table scheduler → Table transfer task: runs tasks
lib/pgsync/table_sync.rb - Table transfer task → Database adapter: copies rows
lib/pgsync/task.rb - Table scheduler → Sequence identity: builds sequence IDs
lib/pgsync/table_sync.rb - Table transfer task → Destination PostgreSQL: applies data rules
README.md - Operator → Sync coordinator: selects tables and rows
README.md - Sync coordinator → Schema transfer: schema-first or schema-only
README.md - Sync coordinator → Table scheduler: supports filtered and batched sync
README.md - Table scheduler → Destination PostgreSQL: updates sequences