diff --git a/docs/index.rst b/docs/index.rst index 988f752..e52b8d0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -44,7 +44,7 @@ You can then generate an initial migration:: $ flask db migrate -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 indexes. Once finalized, the migration script also needs to be added to version control. +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:: @@ -185,7 +185,7 @@ Notes: - All commands also take a ``--directory DIRECTORY`` option that points to the directory containing the migration scripts. If this argument is omitted the directory used is ``migrations``. - The default directory can also be specified as a ``directory`` argument to the ``Migrate`` constructor. - The ``--sql`` option present in several commands performs an 'offline' mode migration. Instead of executing the database commands the SQL statements that need to be executed are printed to the console. -- Detailed documentation on these commands can be found in the `Alembic's command reference page `_. +- Detailed documentation on these commands can be found in the `Alembic's command reference page `_. API Reference -------------