Skip to content

From Neon

Tested with: Neon preset: offline fixtures (URL detection, rewrites, checklist) · sync/cutover end-to-end on PostgreSQL 17 · zb migrate 0.1

Neon runs PostgreSQL, so a Neon branch moves to a Databasezy PostgreSQL instance with pg_dump and, if you want near-zero downtime, logical replication.

Neon migration at a glance, from the migration source catalogue
Status Available
Target engines PostgreSQL
How we read it Connection string
Continuous sync Yes, for PostgreSQL
Provider preset neon
  • A Databasezy PostgreSQL instance on the same or a newer major version, or use --create.
  • The connection string of the branch your application writes to, for a role that owns the tables.
  • For continuous sync: logical replication enabled on the Neon project.

In the Neon console, open the project, pick the branch and choose Connect. Either the pooled or the direct string works: the preset rewrites a -pooler host to the direct endpoint, because the pooler runs in transaction mode and cannot serve pg_dump snapshots or replication.

  • Use the direct endpoint, not the "-pooler" hostname; pg_dump needs a session connection.
  • Each Neon branch is a separate source; migrate the branch your app writes to.
  • Logical replication must be enabled in the project settings before continuous sync.

The preset also adds sslmode=require and options=endpoint=<ep-id>, which routes clients that do not send SNI. --dry-run prints the rewritten URL (code neon.pooler_rewritten). A child branch includes its parent’s data as of the branch point; migrate other branches as separate instances.

  1. Open the target PostgreSQL instance (create one first if you need to) and choose the Migrate in tab.
  2. Under Source, pick Connection string and paste the URL. The host is recognised as Neon; you can also pick it from the provider list.
  3. Choose Copy and sync to keep the target current until cutover, or Copy for a one-off copy.
  4. Run Preflight and work through the checklist. Blocking items must be fixed before the copy starts.
  5. Start the copy and follow Copy and Verify. Mismatches are listed per table or collection.
  6. When the sync lag is low, stop writes and choose Cut over. The Report step keeps the timings and verification results.

For copy and sync, turn on logical replication first (project settings, Logical Replication). This sets wal_level=logical and restarts the computes. Preflight fails with pg.wal_level until it is on, and checks that the role may replicate.

Verification runs automatically after the copy and compares source and target: row counts per table, sequence or AUTO_INCREMENT values, the number of indexes and a schema hash. A missing table or a short row count fails the migration and lists what differs. Check the result with zb migrate status <mig_id> or the Verify step in the portal, then run your application’s own smoke tests against the new instance before you switch traffic.

With copy and sync, the target keeps receiving changes after the copy. When zb migrate status reports ready_for_cutover (two lag samples in a row under 5 seconds):

  1. Stop writes to the source: maintenance mode, scale writers to zero, or revoke the application user.
  2. Run zb migrate cutover <mig_id> (or Cut over in the portal). The agent drains the last changes, copies sequence values (PostgreSQL), verifies again and stops replication. If the target cannot catch up in time, the cutover is abandoned and sync keeps running; nothing changes on either side.
  3. Point the application at the Databasezy connection string and resume writes. zb migrate status shows the measured downtime.

Schema changes are not replicated, so freeze migrations between the copy and cutover. Details: what happens at cutover.

A migration never deletes anything on the source. Until you decommission it, rolling back means pointing the application back at the source.

  • Before cutover: cancel with zb migrate cancel <mig_id>. The publication, replication slot or replication channel the migration created is removed.
  • After cutover: writes made on Databasezy are not on the source. For PostgreSQL, start the migration with --reverse-sync so the old database keeps receiving them after cutover and stays a valid fallback. Without it, copy the new data back with a migration in the other direction before you switch.

Logical replication is not enabled on the Neon project yet. Enable it, wait for the computes to restart, then run preflight again.

A pooled endpoint was forced through. Use the direct endpoint, or let the preset rewrite the -pooler host.

Check that the source accepts connections from the egress addresses preflight prints, that the host is the public one and that the password has not been rotated. zb migrate --dry-run shows the exact URL that will be used after any rewrites.

Each item has a machine code and a fix. Nothing is written to the target until every blocking item is resolved; warnings do not block.

The source uses an extension Databasezy does not ship. Drop it on the source if it is unused, or exclude the objects that depend on it with --exclude.

Sync is blocked with pg.wal_level or pg.replica_identity

Section titled “Sync is blocked with pg.wal_level or pg.replica_identity”

Logical replication needs wal_level=logical on the source and a primary key (or REPLICA IDENTITY FULL) on every published table. Preflight lists the tables.

For anything else, zb migrate status <mig_id> shows the failing step and its message. How migrations work describes every step.