Skip to content

📝 Add migrations section #1555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ezeparziale wants to merge 7 commits into
base: main
Choose a base branch
from
Open

📝 Add migrations section #1555

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
956f43b
:memo: docs: add migrations section
ezeparziale Dec 15, 2022
7bcf499
:art: update: code format
ezeparziale Dec 15, 2022
cb497ad
:art: update: code format for lint
ezeparziale Dec 15, 2022
23a6b35
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Sep 7, 2025
5cb04c1
:art: update: replace warning and tip syntax with consistent format
ezeparziale Sep 7, 2025
9b58d73
:art: update: add spacing for clarity in migration documentation
ezeparziale Sep 7, 2025
2258c98
:art: update: add success type
ezeparziale Sep 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
🎨 update: add spacing for clarity in migration documentation
  • Loading branch information
@ezeparziale
ezeparziale committed Sep 7, 2025
commit 9b58d73ac67c22272543ad248dc51839ea6590b5
8 changes: 8 additions & 0 deletions docs/advanced/migrations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ Then go to `migrations\env.py` to finish the alembic configuration.
```

/// warning

First import your models and then import SQLModel otherwise sqlmodel doesn´t recognize all models.

///
Expand All @@ -137,7 +138,9 @@ Then go to `migrations\env.py` to finish the alembic configuration.
```

/// tip

This step can be replaced setting the same `sqlalchemy.url` variable in `alembic.ini` file.

///

- Finally set `target_metadata` with your `SQLModel.metada`
Expand Down Expand Up @@ -179,6 +182,7 @@ Generating migrations\versions\34abfb7ac266_init_db.py ... done
Now in `versions` folder we have a new file called `34abfb7ac266_init_db.py`

/// info

This file has a revision id and the message part from our revision command.

///
Expand All @@ -190,6 +194,7 @@ Now in `versions` folder we have a new file called `34abfb7ac266_init_db.py`
{!./docs_src/advanced/migrations/annotations/en/tutorial005.md!}

/// success

At this moment we have all the files to create our new database model.

///
Expand Down Expand Up @@ -295,6 +300,7 @@ The new file `b39b8d3c77f0_new_field_power.py`:
{!./docs_src/advanced/migrations/annotations/en/tutorial007.md!}

/// note

Run `alembic upgrade head` to add the new field named power

///
Expand All @@ -312,6 +318,7 @@ INFO [alembic.runtime.migration] Running upgrade 357d6ebcfadf -> b39b8d3c77f0,
</div>

/// note

After you can downgrade the database to the previous version, run `alembic downgrade -1`

///
Expand All @@ -329,6 +336,7 @@ INFO [alembic.runtime.migration] Running downgrade b39b8d3c77f0 -> 357d6ebcfadf
</div>

/// success

Migrations complete!!! Try adding new tables and relationship.

///