anitab-org / anitab-org/mentorship-backend

Write on README how to create and run db migration script

Aperta
#996 3 commenti 0 reazioni 1 assegnatario Rivendicata da @mtreacy002 Vedi su GitHub
Category: Documentation/Training
Lingua principale
Python
Stelle
200
Fork
449
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

## Description

As a developer,
I need steps to create an Alembic migration script,
so that I can know how to create migration script and upgrade database schema version.

Write couple steps concisely on README to explain how to create and run migration script

**tip:** If you are inexperienced with alembic migrations, it might be worth it to try this out your self, by changing a property in a database model (sqlalchemy) and create script + upgrade/downgrade versions. If you use `local` env variable, your db will be sqlite based, so easily deleted and created.

**References:**
- https://github.com/anitab-org/mentorship-backend/pull/335 this PR introduced support to flask migrate, so "how do I use it?" section might help with this.
- https://flask-migrate.readthedocs.io/en/latest/

## Acceptance Criteria
### Update [Required]
- [ ] Steps to do this are concisely explained on a separate README section

## Definition of Done
- [ ] All of the required items are completed.
- [x] Approval by 1 mentor.

## Estimation
1 hours

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.