Document db schema escape hatch
- Dominant language
- Jupyter Notebook
- Stars
- 201
- Forks
- 62
- PR merge metrics
- No merged PRs in 30d
Description
We had an instance where a user dropped metadata tables. Using schema migrations recovery from this is not crystal-clear as the state of the database doesn't map to any of the known versions.
You can generally fix this with `Base.metadata.create_all`, but most people aren't just going to know this. We should add a section in the documentation.
Contributor guide
Research direction
Start by locating the documentation section covering schema migrations and review the recovery context described in the issue. Document when migration state no longer matches the database and explain the Base.metadata.create_all recovery path; done means a reader can follow the recovery steps without prior knowledge.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100