Skip to content

Release Notes

Latest Changes

  • 🙈 Update gitignore, include all coverage files. PR #711 by @tiangolo.

Refactors

  • ✅ 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.

0.0.12

Features

Internal

0.0.11

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.

0.0.10

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

0.0.9

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

0.0.8

Fixes

  • 🐛 Fix auto detecting and setting nullable, allowing overrides in field. PR #423 by @JonasKs and @br-follow.
  • ♻️ Update expresion.py, sync from Jinja2 template, implement inherit_cache to solve errors like: SAWarning: Class SelectOfScalar will not make use of SQL compilation caching. PR #422 by @tiangolo.

Docs

  • 📝 Adjust and clarify docs for docs/tutorial/create-db-and-table.md. PR #426 by @tiangolo.
  • ✏ Fix typo in docs/tutorial/connect/remove-data-connections.md. PR #421 by @VerdantFox.

0.0.7

Features

  • ✨ Allow setting unique in Field() for a column. PR #83 by @raphaelgibson.
  • ✨ Update GUID handling to use stdlib UUID.hex instead of an int. PR #26 by @andrewbolster.
  • ✨ Raise an exception when using a Pydantic field type with no matching SQLAlchemy type. PR #18 by @elben10.
  • ⬆ Upgrade constrain for SQLAlchemy = ">=1.4.17,<=1.4.41". PR #371 by @RobertRosca.
  • ✨ Add new Session.get() parameter execution_options. PR #302 by @tiangolo.

Fixes

  • 🐛 Fix type annotations for Model.parse_obj(), and Model.validate(). PR #321 by @phi-friday.
  • 🐛 Fix Select and SelectOfScalar to inherit cache to avoid warning: SAWarning: Class SelectOfScalar will not make use of SQL compilation caching. PR #234 by @rabinadk1.
  • 🐛 Fix handling validators for non-default values. PR #253 by @byrman.
  • 🐛 Fix fields marked as "set" in models. PR #117 by @statt8900.
  • 🐛 Fix Enum handling in SQLAlchemy. PR #165 by @chriswhite199.
  • 🐛 Fix setting nullable property of Fields that don't accept None. PR #79 by @van51.
  • 🐛 Fix SQLAlchemy version 1.4.36 breaks SQLModel relationships (#315). PR #322 by @byrman.

Docs

  • 📝 Update docs for models for updating, id should not be updatable. PR #335 by @kurtportelli.
  • ✏ Fix broken variable/typo in docs for Read Relationships, hero_spider_boy.id => hero_spider_boy.team_id. PR #106 by @yoannmos.
  • 🎨 Remove unwanted highlight in the docs. PR #233 by @jalvaradosegura.
  • ✏ Fix typos in docs/databases.md and docs/tutorial/index.md. PR #35 by @prrao87.
  • ✏ Fix typo in docs/tutorial/relationship-attributes/define-relationships-attributes.md. PR #239 by @jalvaradosegura.
  • ✏ Fix typo in docs/tutorial/fastapi/simple-hero-api.md. PR #80 by @joemudryk.
  • ✏ Fix typos in multiple files in the docs. PR #400 by @VictorGambarini.
  • ✏ Fix typo in docs/tutorial/code-structure.md. PR #344 by @marciomazza.
  • ✏ Fix typo in docs/db-to-code.md. PR #155 by @gr8jam.
  • ✏ Fix typo in docs/contributing.md. PR #323 by @Fardad13.
  • ✏ Fix typo in docs/tutorial/fastapi/tests.md. PR #265 by @johnhoman.
  • ✏ Fix typo in docs/tutorial/where.md. PR #286 by @jalvaradosegura.
  • ✏ Fix typos in docs/tutorial/fastapi/update.md. PR #268 by @cirrusj.
  • ✏ Fix typo in docs/tutorial/fastapi/simple-hero-api.md. PR #247 by @hao-wang.
  • ✏ Fix typos in docs/tutorial/automatic-id-none-refresh.md, docs/tutorial/fastapi/update.md, docs/tutorial/select.md. PR #185 by @rootux.
  • ✏ Fix typo in docs/databases.md. PR #177 by @seandlg.
  • ✏ Fix typos in docs/tutorial/fastapi/update.md. PR #162 by @wmcgee3.
  • ✏ Fix typos in docs/tutorial/code-structure.md, docs/tutorial/fastapi/multiple-models.md, docs/tutorial/fastapi/simple-hero-api.md, docs/tutorial/many-to-many/index.md. PR #116 by @moonso.
  • ✏ Fix typo in docs/tutorial/fastapi/teams.md. PR #154 by @chrisgoddard.
  • ✏ Fix typo variable in example about relationships and back_populates, always use hero instead of owner. PR #120 by @onionj.
  • ✏ Fix typo in docs/tutorial/fastapi/tests.md. PR #113 by @feanil.
  • ✏ Fix typo in docs/tutorial/where.md. PR #72 by @ZettZet.
  • ✏ Fix typo in docs/tutorial/code-structure.md. PR #91 by @dhiraj.
  • ✏ Fix broken link to newsletter sign-up in docs/help.md. PR #84 by @mborus.
  • ✏ Fix typos in docs/tutorial/many-to-many/create-models-with-link.md. PR #45 by @xginn8.
  • ✏ Fix typo in docs/tutorial/index.md. PR #398 by @ryangrose.

Internal

  • ♻ Refactor internal statements to simplify code. PR #53 by @yezz123.
  • ♻ Refactor internal imports to reduce redundancy. PR #272 by @aminalaee.
  • ⬆ Update development requirement for FastAPI from ^0.68.0 to ^0.68.1. PR #48 by @alucarddelta.
  • ⏪ Revert upgrade Poetry, to make a release that supports Python 3.6 first. PR #417 by @tiangolo.
  • 👷 Add dependabot for GitHub Actions. PR #410 by @tiangolo.
  • ⬆️ Upgrade Poetry to version ==1.2.0b1. PR #303 by @tiangolo.
  • 👷 Add CI for Python 3.10. PR #305 by @tiangolo.
  • 📝 Add Jina's QA Bot to the docs to help people that want to ask quick questions. PR #263 by @tiangolo.
  • 👷 Upgrade Codecov GitHub Action. PR #304 by @tiangolo.
  • 💚 Only run CI on push when on master, to avoid duplicate runs on PRs. PR #244 by @tiangolo.
  • 🔧 Upgrade MkDocs Material and update configs. PR #217 by @tiangolo.
  • ⬆ Upgrade mypy, fix type annotations. PR #218 by @tiangolo.

0.0.6

Breaking Changes

SQLModel no longer creates indexes by default for every column, indexes are now opt-in. You can read more about it in PR #205.

Before this change, if you had a model like this:

from typing import Optional

from sqlmodel import Field, SQLModel


class Hero(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    name: str
    secret_name: str
    age: Optional[int] = None

...when creating the tables, SQLModel version 0.0.5 and below, would also create an index for name, one for secret_name, and one for age (id is the primary key, so it doesn't need an additional index).

If you depended on having an index for each one of those columns, now you can (and would have to) define them explicitly:

class Hero(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    name: str = Field(index=True)
    secret_name: str = Field(index=True)
    age: Optional[int] = Field(default=None, index=True)

There's a high chance you don't need indexes for all the columns. For example, you might only need indexes for name and age, but not for secret_name. In that case, you could define the model as:

class Hero(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    name: str = Field(index=True)
    secret_name: str
    age: Optional[int] = Field(default=None, index=True)

If you already created your database tables with SQLModel using versions 0.0.5 or below, it would have also created those indexes in the database. In that case, you might want to manually drop (remove) some of those indexes, if they are unnecessary, to avoid the extra cost in performance and space.

Depending on the database you are using, there will be a different way to find the available indexes.

For example, let's say you no longer need the index for secret_name. You could check the current indexes in the database and find the one for secret_name, it could be named ix_hero_secret_name. Then you can remove it with SQL:

DROP INDEX ix_hero_secret_name

or

DROP INDEX ix_hero_secret_name ON hero;

Here's the new, extensive documentation explaining indexes and how to use them: Indexes - Optimize Queries.

Docs

  • ✨ Document indexes and make them opt-in. Here's the new documentation: Indexes - Optimize Queries. This is the same change described above in Breaking Changes. PR #205 by @tiangolo.
  • ✏ Fix typo in FastAPI tutorial. PR #192 by @yaquelinehoyos.
  • 📝 Add links to the license file. PR #29 by @sobolevn.
  • ✏ Fix typos in docs titles. PR #28 by @Batalex.
  • ✏ Fix multiple typos and some rewording. PR #22 by @egrim.
  • ✏ Fix typo in docs/tutorial/automatic-id-none-refresh.md. PR #14 by @leynier.
  • ✏ Fix typos in docs/tutorial/index.md and docs/databases.md. PR #5 by @sebastianmarines.

0.0.5

Features

Docs

  • ✏ Update decimal tutorial source for consistency. PR #188 by @tiangolo.

Internal

  • 🔧 Split MkDocs insiders build in CI to support building from PRs. PR #186 by @tiangolo.
  • 🎨 Format expression.py and expression template, currently needed by CI. PR #187 by @tiangolo.
  • 🐛Fix docs light/dark theme switcher. PR #1 by @Lehoczky.
  • 🔧 Add MkDocs Material social cards. PR #90 by @tiangolo.
  • ✨ Update type annotations and upgrade mypy. PR #173 by @tiangolo.

0.0.4

  • 🎨 Fix type detection of select results in PyCharm. PR #15 by @tiangolo.

0.0.3

  • ⬆️ Update and relax specification range for sqlalchemy-stubs. PR #4 by @tiangolo.

0.0.2

  • This includes several small bug fixes detected during the first CI runs.
  • 💚 Fix CI installs and tests. PR #2 by @tiangolo.

0.0.1

  • First release. 🎉