Skip to content

From Netlify DB

Tested with: Generic connection-string flow · zb migrate 0.1 · no Netlify DB preset yet

Netlify DB is backed by Neon. Its connection string points at a Neon endpoint, so the Neon notes apply and zb migrate treats the host as Neon.

Netlify DB migration at a glance, from the migration source catalogue
Status Coming soon · phase 2
Target engines PostgreSQL
How we read it Connection string
Continuous sync Yes, for PostgreSQL
Provider preset None yet (generic)
  • A Databasezy PostgreSQL instance, or use --create.
  • The database connection string from your Netlify site’s environment variables.

In your Netlify site’s environment variables, copy the database URL. Prefer the unpooled variant if both are present; if you paste the pooled one, the Neon preset rewrites the -pooler host to the direct endpoint.

  • Netlify DB is backed by Neon; the Neon notes apply.

Because the host is a Neon endpoint (*.neon.tech), the Neon guide applies in full, including branches and the pooler rewrite.

  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.
  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, logical replication must be enabled on the Neon project behind the database. Preflight fails with pg.wal_level until it is.

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.

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.