[Cherry-pick to branch-1.3] [#11122 ][#11112] docs(upgrade): Improve PostgreSQL backup format and add rollback instructions (#11461)#11535
Merged
Conversation
… add rollback instructions (#11461) ### What changes were proposed in this pull request? This PR improves the `docs/how-to-upgrade.md` documentation with the following changes: 1. Changed the PostgreSQL data backup command to use `-Fc` (custom compressed binary format) instead of `-F c`, producing a `.dump` file instead of `.sql`, and added a note explaining the custom format. 2. Changed the PostgreSQL schema dump command to use plain-text format (`-f`) instead of custom format (`-F c`), making it easier to diff against official schema files. 3. Improved the wording in Step 4 (schema comparison) to clarify which differences are acceptable (e.g., object ordering, comments) and which need manual resolution (e.g., table structures, column types, missing tables/indexes). 4. Added a new "Rollback if Upgrade Fails" section with restore instructions for MySQL, H2, and PostgreSQL backends. ### Why are the changes needed? 1. The previous PostgreSQL backup command used `-F c` (custom format) but saved to a `.sql` extension, which is misleading. The custom format should use a `.dump` extension and be restored with `pg_restore`. 2. The schema dump should be in plain-text format so users can directly diff it against the official schema SQL files. 3. The original documentation lacked rollback guidance, leaving users without a clear recovery path if an upgrade fails. Fix: #11112 Fix: #11122 ### Does this PR introduce _any_ user-facing change? No. This is a documentation-only change. ### How was this patch tested? Documentation-only change. Verified the commands are correct by reviewing PostgreSQL and MySQL official documentation.
Author
Code Coverage Report
|
yuqi1129
approved these changes
Jun 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cherry-pick Information:
branch-1.3