Sqlmodel Versions Save

Internal

• ✨ Add sqlmodel-slim setup. PR #916 by @tiangolo.

In the future SQLModel will include the standard default recommended packages, and sqlmodel-slim will come without those recommended standard packages and with a group of optional dependencies sqlmodel-slim[standard], equivalent to sqlmodel, for those that want to opt out of those packages.

• 🔧 Re-enable MkDocs Material Social plugin. PR #915 by @tiangolo.

Refactors

• ♻️ Refactor types to properly support Pydantic 2.7. PR #913 by @tiangolo.

Docs

• 📝 Update ModelRead to ModelPublic documentation and examples. PR #885 by @estebanx64.
• ✨ Add source examples for Python 3.10 and 3.9 with updated syntax. PR #842 by @tiangolo and @estebanx64.

Internal

• ⬆ Bump actions/setup-python from 4 to 5. PR #733 by @dependabot[bot].
• 🔨 Update internal scripts and remove unused ones. PR #914 by @tiangolo.
• 🔧 Migrate from Poetry to PDM for the internal build config. PR #912 by @tiangolo.
• 🔧 Update MkDocs, disable cards while I can upgrade to the latest MkDocs Material, that fixes an issue with social cards. PR #888 by @tiangolo.
• 👷 Add cron to run test once a week on monday. PR #869 by @estebanx64.
• ⬆️ Upgrade Ruff version and configs. PR #859 by @tiangolo.
• 🔥 Remove Jina QA Bot as it has been discontinued. PR #840 by @tiangolo.

Features

• ✨ Add new method .sqlmodel_update() to update models in place, including an update parameter for extra data. And fix implementation for the (now documented) update parameter for .model_validate(). PR #804 by @tiangolo.
  • Updated docs: Update Data with FastAPI.
  • New docs: Update with Extra Data (Hashed Passwords) with FastAPI.

Fixes

• 🐛 Fix class initialization compatibility with Pydantic and SQLModel, fixing errors revealed by the latest Pydantic. PR #807 by @tiangolo.

Internal

• ⬆ Bump tiangolo/issue-manager from 0.4.0 to 0.4.1. PR #775 by @dependabot[bot].
• 👷 Fix GitHub Actions build docs filter paths for GitHub workflows. PR #738 by @tiangolo.

Features

• ✨ Add support for Pydantic v2 (while keeping support for v1 if v2 is not available). PR #722 by @tiangolo including initial work in PR #699 by @AntonDeMeester.

Fixes

• ♻️ Refactor type generation of selects re-order to prioritize models to optimize editor support. PR #718 by @tiangolo.

Refactors

• 🔇 Do not raise deprecation warnings for execute as it's automatically used internally. PR #716 by @tiangolo.
• ✅ Move OpenAPI tests inline to simplify updating them with Pydantic v2. PR #709 by @tiangolo.

Upgrades

• ⬆️ Add support for Python 3.11 and Python 3.12. PR #710 by @tiangolo.

Docs

• ✏️ Fix typo, simplify single quote/apostrophe character in "Sister Margaret's" everywhere in the docs. PR #721 by @tiangolo.
• 📝 Update docs for Decimal, use proper types. PR #719 by @tiangolo.
• 📝 Add source examples for Python 3.9 and 3.10. PR #715 by @tiangolo.

Internal

• 🙈 Update gitignore, include all coverage files. PR #711 by @tiangolo.
• 🔧 Update config with new pymdown extensions. PR #712 by @tiangolo.
• 🔧 Update docs build setup, add support for sponsors, add sponsor GOVCERT.LU. PR #720 by @tiangolo.
• ⬆ [pre-commit.ci] pre-commit autoupdate. PR #697 by @pre-commit-ci[bot].
• 🔧 Show line numbers in docs during local development. PR #714 by @tiangolo.
• 📝 Update details syntax with new pymdown extensions format. PR #713 by @tiangolo.

Features

• ✨ Upgrade SQLAlchemy to 2.0. PR #700 by @tiangolo including initial work in PR #563 by @farahats9.

Internal

• ⬆ [pre-commit.ci] pre-commit autoupdate. PR #686 by @pre-commit-ci[bot].
• 👷 Upgrade latest-changes GitHub Action. PR #693 by @tiangolo.

Features

• ✨ Add support for passing a custom SQLAlchemy type to Field() with sa_type. PR #505 by @maru0123-2004.
  • You might consider this a breaking change if you were using an incompatible combination of arguments, those arguments were not taking effect and now you will have a type error and runtime error telling you that.
• ✨ Do not allow invalid combinations of field parameters for columns and relationships, sa_column excludes sa_column_args, primary_key, nullable, etc. PR #681 by @tiangolo.

Docs

• 🎨 Update inline source examples, hide # in annotations (from MkDocs Material). PR #677 by @Matthieu-LAURENT39.

Internal

• ⬆ Update coverage requirement from ^6.2 to >=6.2,<8.0. PR #663 by @dependabot[bot].
• ⬆ Update mkdocs-material requirement from 9.1.21 to 9.2.7. PR #675 by @dependabot[bot].
• ⬆️ Upgrade mypy manually. PR #684 by @tiangolo.
• ⬆ Update black requirement from ^22.10.0 to >=22.10,<24.0. PR #664 by @dependabot[bot].
• 👷 Update CI to build MkDocs Insiders only when the secrets are available, for Dependabot. PR #683 by @tiangolo.

Features

• ✨ Add support for all Field parameters from Pydantic 1.9.0 and above, make Pydantic 1.9.0 the minimum required version. PR #440 by @daniil-berg.

Internal

• 🔧 Adopt Ruff for formatting. PR #679 by @tiangolo.

Breaking Changes

• 🗑️ Deprecate Python 3.6 and upgrade Poetry and Poetry Version Plugin. PR #627 by @tiangolo.

Features

• ✨ Raise a more clear error when a type is not valid. PR #425 by @ddanier.

Fixes

• 🐛 Fix AsyncSession type annotations for exec(). PR #58 by @Bobronium.
• 🐛 Fix allowing using a ForeignKey directly, remove repeated column construction from SQLModelMetaclass.__init__ and upgrade minimum SQLAlchemy to >=1.4.36. PR #443 by @daniil-berg.
• 🐛 Fix enum type checks ordering in get_sqlalchemy_type. PR #669 by @tiangolo.
• 🐛 Fix SQLAlchemy version 1.4.36 breaks SQLModel relationships (#315). PR #461 by @byrman.

Upgrades

• ⬆️ Upgrade support for SQLAlchemy 1.4.49, update tests. PR #519 by @sandrotosi.
• ⬆ Raise SQLAlchemy version requirement to at least 1.4.29 (related to #434). PR #439 by @daniil-berg.

Docs

• 📝 Clarify description of in-memory SQLite database in docs/tutorial/create-db-and-table.md. PR #601 by @SimonCW.
• 📝 Tweak wording in docs/tutorial/fastapi/multiple-models.md. PR #674 by @tiangolo.
• ✏️ Fix contributing instructions to run tests, update script name. PR #634 by @PookieBuns.
• 📝 Update link to docs for intro to databases. PR #593 by @abenezerBelachew.
• 📝 Update docs, use offset in example with limit and where. PR #273 by @jbmchuck.
• 📝 Fix docs for Pydantic's fields using le (lte is invalid, use le ). PR #207 by @jrycw.
• 📝 Update outdated link in docs/db-to-code.md. PR #649 by @MatveyF.
• ✏️ Fix typos found with codespell. PR #520 by @kianmeng.
• 📝 Fix typos (duplication) in main page. PR #631 by @Mr-DRP.
• 📝 Update release notes, add second author to PR. PR #429 by @br-follow.
• 📝 Update instructions about how to make a foreign key required in docs/tutorial/relationship-attributes/define-relationships-attributes.md. PR #474 by @jalvaradosegura.
• 📝 Update help SQLModel docs. PR #548 by @tiangolo.
• ✏️ Fix typo in internal function name get_sqlachemy_type(). PR #496 by @cmarqu.
• ✏️ Fix typo in docs. PR #446 by @davidbrochart.
• ✏️ Fix typo in docs/tutorial/create-db-and-table.md. PR #477 by @FluffyDietEngine.
• ✏️ Fix small typos in docs. PR #481 by @micuffaro.

Internal

• ⬆ [pre-commit.ci] pre-commit autoupdate. PR #672 by @pre-commit-ci[bot].
• ⬆ Bump dawidd6/action-download-artifact from 2.24.2 to 2.28.0. PR #660 by @dependabot[bot].
• ✅ Refactor OpenAPI FastAPI tests to simplify updating them later, this moves things around without changes. PR #671 by @tiangolo.
• ⬆ Bump actions/checkout from 3 to 4. PR #670 by @dependabot[bot].
• 🔧 Update mypy config, use strict = true instead of manual configs. PR #428 by @michaeloliverx.
• ⬆️ Upgrade MkDocs Material. PR #668 by @tiangolo.
• 🎨 Update docs format and references with pre-commit and Ruff. PR #667 by @tiangolo.
• 🎨 Run pre-commit on all files and autoformat. PR #666 by @tiangolo.
• 👷 Move to Ruff and add pre-commit. PR #661 by @tiangolo.
• 🛠️ Add CITATION.cff file for academic citations. PR #13 by @sugatoray.
• 👷 Update docs deployments to Cloudflare. PR #630 by @tiangolo.
• 👷‍♂️ Upgrade CI for docs. PR #628 by @tiangolo.
• 👷 Update CI debug mode with Tmate. PR #629 by @tiangolo.
• 👷 Update latest changes token. PR #616 by @tiangolo.
• ⬆️ Upgrade analytics. PR #558 by @tiangolo.
• 🔧 Update new issue chooser to point to GitHub Discussions. PR #546 by @tiangolo.
• 🔧 Add template for GitHub Discussion questions and update issues template. PR #544 by @tiangolo.
• 👷 Refactor CI artifact upload/download for docs previews. PR #514 by @tiangolo.
• ⬆ Bump actions/cache from 2 to 3. PR #497 by @dependabot[bot].
• ⬆ Bump dawidd6/action-download-artifact from 2.24.0 to 2.24.2. PR #493 by @dependabot[bot].
• 🔧 Update Smokeshow coverage threshold. PR #487 by @tiangolo.
• 👷 Move from Codecov to Smokeshow. PR #486 by @tiangolo.
• ⬆ Bump actions/setup-python from 2 to 4. PR #411 by @dependabot[bot].
• ⬆ Update black requirement from ^21.5-beta.1 to ^22.10.0. PR #460 by @dependabot[bot].
• ➕ Add extra dev dependencies for MkDocs Material. PR #485 by @tiangolo.
• ⬆ Update mypy requirement from 0.930 to 0.971. PR #380 by @dependabot[bot].
• ⬆ Update coverage requirement from ^5.5 to ^6.2. PR #171 by @dependabot[bot].
• ⬆ Bump codecov/codecov-action from 2 to 3. PR #415 by @dependabot[bot].
• ⬆ Bump actions/upload-artifact from 2 to 3. PR #412 by @dependabot[bot].
• ⬆ Update flake8 requirement from ^3.9.2 to ^5.0.4. PR #396 by @dependabot[bot].
• ⬆ Update pytest requirement from ^6.2.4 to ^7.0.1. PR #242 by @dependabot[bot].
• ⬆ Bump actions/checkout from 2 to 3.1.0. PR #458 by @dependabot[bot].
• ⬆ Bump dawidd6/action-download-artifact from 2.9.0 to 2.24.0. PR #470 by @dependabot[bot].
• 👷 Update Dependabot config. PR #484 by @tiangolo.