From Xata
Tested with: Generic connection-string flow · zb migrate 0.1 · no Xata preset yet
Xata branches expose a PostgreSQL wire endpoint, so they move to a Databasezy PostgreSQL instance with a copy.
| Status | Coming soon · phase 3 |
|---|---|
| Target engines | PostgreSQL |
| How we read it | Connection string |
| Continuous sync | No, copy only |
| Provider preset | None yet (generic) |
Before you start
Section titled “Before you start”- A Databasezy PostgreSQL instance, or use
--create. - The PostgreSQL connection string for the branch you migrate.
- A short write freeze for the copy.
Find the connection string
Section titled “Find the connection string”Copy the PostgreSQL wire endpoint from the branch’s settings in Xata. The example host on this page is illustrative; use exactly what Xata shows for your branch.
Xata notes
Section titled “Xata notes”- Use the Postgres wire endpoint from the branch settings.
Migrate
Section titled “Migrate”- Open the target PostgreSQL instance (create one first if you need to) and choose the Migrate in tab.
- Under Source, pick Connection string and paste the URL.
- Run Preflight and work through the checklist. Blocking items must be fixed before the copy starts.
- Start the copy and follow Copy and Verify. Mismatches are listed per table or collection.
- Point your application at the new instance. The Report step keeps the timings and verification results.
# Dry run: print the preflight checklist and the plan, change nothingzb migrate --from "postgresql://user:[email protected]:5432/app:main?sslmode=require" --to inst_abc --dry-run
# Start it (or use --create --size s1 instead of --to to create the target)
zb migrate status mig_123curl -sS https://api.databasezy.com/v1/orgs/$ZB_ORG/instances/inst_abc/migrations \ -H "Authorization: Bearer $ZB_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "source": { "kind": "connection_string", "url": "postgresql://user:[email protected]:5432/app:main?sslmode=require" }, "mode": "copy"}'
# Follow progress, preflight report and verificationcurl -sS https://api.databasezy.com/v1/orgs/$ZB_ORG/instances/inst_abc/migrations/mig_123 -H "Authorization: Bearer $ZB_API_KEY"Verify
Section titled “Verify”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.
Cutover
Section titled “Cutover”This source is copy only. Writes that reach the source after the copy starts are not carried over, so for a database that changes, stop writes before you start the copy (maintenance mode, or scale writers to zero), run the migration, check verification, then point the application at the Databasezy connection string.
Roll back
Section titled “Roll back”A migration never deletes anything on the source. Until you decommission it, rolling back means pointing the
application back at the source. Writes made on Databasezy after you switched are not on the source; if you need
them, copy them back before switching. Cancel a running migration with zb migrate cancel <mig_id>; partially
restored data stays on the target, so restart with --drop-target or delete the instance.
Troubleshooting
Section titled “Troubleshooting”Preflight cannot connect to the source
Section titled “Preflight cannot connect to the source”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.
Preflight lists blocking items
Section titled “Preflight lists blocking items”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 restore stops on an extension
Section titled “The restore stops on an extension”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.
For anything else, zb migrate status <mig_id> shows the failing step and its message. How migrations work describes every step.