Skip to content

Reference

Use the reference section when you already understand the basic flow and need exact behavior, defaults, or source-specific constraints.

  1. Configuration for every TOML option, defaults, and incompatible combinations.
  2. Type Mapping for source-to-PostgreSQL conversions and per-source knobs.
  3. Migration Pipeline for stage order, mode differences, resume, and validation.
  4. Hooks for the four SQL phases and {{schema}} templating.
  5. Conventions & limitations for naming, generated columns, unsupported objects, and source caveats.
Question Start here
Which flags matter for a first production run? Configuration
How do I rerun built-in validation without migrating again? Migration Pipeline and Configuration
How do I inspect resume progress without opening JSON manually? Migration Pipeline and Conventions & limitations
Which options only apply to MySQL-family or MSSQL sources? Configuration and Type Mapping
What happens in schema_only or data_only mode? Migration Pipeline
When do hook files run? Hooks
What does pgferry report but not migrate automatically? Conventions & limitations