]> git.ipfire.org Git - thirdparty/fastapi/fastapi.git/commitdiff
:memo: Add note about Alembic in project generator in SQL docs (#1183)
authorHarsha Laxman <HarshaLaxman@users.noreply.github.com>
Sun, 5 Apr 2020 13:15:39 +0000 (06:15 -0700)
committerGitHub <noreply@github.com>
Sun, 5 Apr 2020 13:15:39 +0000 (15:15 +0200)
* Update sql-databases alembic docs

Was helpful to refer to the full-stack project when integrating alembic into my own project

* :memo: Update Alembic note in docs

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
docs/en/docs/tutorial/sql-databases.md

index 726acc7c46c343954b393f2700fd54d97188459b..c60eda0f80d738a0cd5e468d122f306409b57949 100644 (file)
@@ -437,6 +437,8 @@ And you would also use Alembic for "migrations" (that's its main job).
 
 A "migration" is the set of steps needed whenever you change the structure of your SQLAlchemy models, add a new attribute, etc. to replicate those changes in the database, add a new column, a new table, etc.
 
+You can find an example of Alembic in a FastAPI project in the templates from [Project Generation - Template](../project-generation.md){.internal-link target=_blank}. Specifically in <a href="https://github.com/tiangolo/full-stack-fastapi-postgresql/tree/master/%7B%7Bcookiecutter.project_slug%7D%7D/backend/app/alembic/" class="external-link" target="_blank">the `alembic` directory in the source code</a>.
+
 ### Create a dependency
 
 !!! info