danhuawang opened a new pull request, #11461:
URL: https://github.com/apache/gravitino/pull/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
   #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.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to