feat: adds 'data:pg:upgrade:run/wait' commands (W-21304392)#3551
Merged
feat: adds 'data:pg:upgrade:run/wait' commands (W-21304392)#3551
Conversation
79f06c3 to
afc5fd8
Compare
heicheng18
reviewed
Apr 8, 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
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.
Summary
Here we implement two new commands that will be part of NGPG GA launch enabling customers to upgrade major versions of Heroku Postgres Advanced databases:
data:pg:upgrade:runanddata:pg:upgrade:wait.Initially,
data:pg:upgrade:waitwould be an alias fordata:pg:wait, but we just created a new command inheriting the behavior ofdata:pg:waitin order to update some static help messaging and dynamically generated error messages guiding the user to run the correct command when dealing with a Classic database.Type of Change
Breaking Changes (major semver update)
!after your change type to denote a change that breaks current behaviorFeature Additions (minor semver update)
Patch Updates (patch semver update)
Testing
For smoke testing this command, pull this branch, build and run through
./bin/run:If you need to create an upgradeable database for testing, you can use:
heroku data:pg:create --level 4G-Performance --no-high-availability --app test-app-name --version=16 --as UPGRADEABLE_DBSteps:
git checkout sbosio/data-pg-upgrade-runnpm install && npm run build./bin/run data:pg:upgrade:run --help./bin/run data:pg:upgrade:run UPGRADEABLE_DB --app test-app-nameRemember to destroy the database when you're finished with your tests:
./bin/run data:pg:destroy UPGRADEABLE_DB --app test-app-name --confirm test-app-nameScreenshots (if applicable)
Example run (happy path smoke test)
Static help and error messages to review by CX on
data:pg:upgrade:waitRelated Issues
GUS work item: W-21304392