diff --git a/docs/index.rst b/docs/index.rst index 710558e..38b4c7b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -47,8 +47,14 @@ This will add a `migrations` folder to your application. The contents of this fo You can then generate an initial migration:: - $ flask db migrate - + $ flask db migrate #-m "You can leave optional message." + +- ``Revision script without message:`` + 5d3244f628be.py + +- ``Revision script with message:`` + 5d3244f628be_you_can_leave_message_optional.py + The migration script needs to be reviewed and edited, as Alembic currently does not detect every change you make to your models. In particular, Alembic is currently unable to detect table name changes, column name changes, or anonymously named constraints. A detailed summary of limitations can be found in the `Alembic autogenerate documentation `_. Once finalized, the migration script also needs to be added to version control. Then you can apply the migration to the database::