Document PlanetScale role successors#6932
Open
klaemo wants to merge 1 commit into
Open
Conversation
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.
Problem
PlanetScale Postgres branch roles can own database objects after an app or migration tool creates or changes schema objects. In branch-per-stage and preview workflows, SST removes non-production resources automatically. If a
PostgresBranchRoleowns objects and no successor is configured, PlanetScale can reject role deletion during preview cleanup because it does not know which role should receive ownership of those objects.Representative cleanup failure from a preview stage:
Fix
This updates the PlanetScale docs and Postgres examples to model
successor: "postgres"on branch roles. The successor gives PlanetScale a role to reassign owned objects to before deleting a temporary branch role.The docs now call out that runtime-only roles which never own objects do not require a successor, but setting one makes cleanup robust if the role later creates or owns objects.
Changes
successor: "postgres"to the AWS PlanetScale Drizzle Postgres example.successor: "postgres"to the Cloudflare Hyperdrive PlanetScale example.Validation
git diff --checkbun run typecheckwas attempted, but the current checkout fails on pre-existing platform AWS provider type errors before reaching these docs/example changes.