clockworklabs / clockworklabs/SpacetimeDB
Module reference docs: automatic migrations: specify that altering an enum type used in a table requires a manual migration
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 25.2k
- Forks
- 1.1k
- Avg merge
- 2d 7h
- Merged PRs (30d)
- 46
Description
Reported on Discord, with the suggestion of adding:
Altering (adding, renaming, deleting, reordering) variants of an enum
to the list of things that require a manual migration. I would suggest generalizing this to include redefining any user-defined type, and clarify that it only affects types used as columns of tables (or types used within types used as columns within tables, recursively).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the module reference documentation's automatic migrations section and review how changes requiring manual migrations are currently described. Update the guidance to cover changes to user-defined types used by table columns, including nested types, and specify the enum variants listed in the issue. Done means the documentation clearly distinguishes these cases from automatically handled migrations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100