Skip to content

✨ Support sqlalchemy MappedColumn #1143

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
spazm wants to merge 12 commits into
base: main
Choose a base branch
from
+34 −22
Open

✨ Support sqlalchemy MappedColumn #1143

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
0e281d5
add: support mapped_column with sa_column
mavwolverine Apr 14, 2024
63abd0a
add: support mapped_column with sa_column
mavwolverine Apr 14, 2024
3fcbffd
Test MappedColumn support for sa_column field
spazm Oct 21, 2024
2853efe
tests: use fixture to clear sqlmodel between tests
spazm Oct 21, 2024
1f0351b
Simplify type checking of sa_column
spazm Oct 29, 2024
1f5d33c
Merge branch 'main' into feature/mapped_column
svlandeg Feb 24, 2025
91da939
Reduced code duplication in tests using parametrization
YuriiMotov Oct 7, 2025
1b3ecc8
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Oct 7, 2025
930827d
Merge branch 'main' into feature/mapped_column
YuriiMotov Oct 7, 2025
88171a3
Merge branch 'main' into feature/mapped_column
svlandeg Oct 8, 2025
66644fc
Merge branch 'main' into feature/mapped_column
YuriiMotov Jan 8, 2026
1adb815
Merge branch 'main' into feature/mapped_column
svlandeg Feb 2, 2026
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
5 changes: 3 additions & 2 deletions sqlmodel/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
from sqlalchemy import Enum as sa_Enum
from sqlalchemy.orm import (
Mapped,
MappedColumn,
RelationshipProperty,
declared_attr,
registry,
Expand Down Expand Up @@ -736,10 +737,10 @@ def get_sqlalchemy_type(field: Any) -> Any:
raise ValueError(f"{type_} has no matching SQLAlchemy type")


def get_column_from_field(field: Any) -> Column: # type: ignore
def get_column_from_field(field: Any) -> Union[Column, MappedColumn]: # type: ignore
field_info = field
sa_column = _get_sqlmodel_field_value(field_info, "sa_column", Undefined)
if isinstance(sa_column, Column):
if isinstance(sa_column, (Column, MappedColumn)):
return sa_column
sa_type = get_sqlalchemy_type(field)
primary_key = _get_sqlmodel_field_value(field_info, "primary_key", Undefined)
Expand Down
51 changes: 31 additions & 20 deletions tests/test_field_sa_column.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,16 @@

import pytest
from sqlalchemy import Column, Integer, String
from sqlalchemy.orm import mapped_column
from sqlmodel import Field, SQLModel


def test_sa_column_takes_precedence() -> None:
@pytest.mark.parametrize("column_class", [Column, mapped_column])
def test_sa_column_takes_precedence(clear_sqlmodel, column_class) -> None:
class Item(SQLModel, table=True):
id: Optional[int] = Field(
default=None,
sa_column=Column(String, primary_key=True, nullable=False),
sa_column=column_class(String, primary_key=True, nullable=False),
)

# It would have been nullable with no sa_column
Expand All @@ -28,62 +30,68 @@ class Item(SQLModel, table=True):
assert isinstance(Item.id.type, String) # type: ignore


def test_sa_column_no_sa_args() -> None:
@pytest.mark.parametrize("column_class", [Column, mapped_column])
def test_sa_column_no_sa_args(column_class) -> None:
with pytest.raises(RuntimeError):

class Item(SQLModel, table=True):
id: Optional[int] = Field(
default=None,
sa_column_args=[Integer],
sa_column=Column(Integer, primary_key=True),
sa_column=column_class(Integer, primary_key=True),
)


def test_sa_column_no_sa_kargs() -> None:
@pytest.mark.parametrize("column_class", [Column, mapped_column])
def test_sa_column_no_sa_kargs(column_class) -> None:
with pytest.raises(RuntimeError):

class Item(SQLModel, table=True):
id: Optional[int] = Field(
default=None,
sa_column_kwargs={"primary_key": True},
sa_column=Column(Integer, primary_key=True),
sa_column=column_class(Integer, primary_key=True),
)


def test_sa_column_no_type() -> None:
@pytest.mark.parametrize("column_class", [Column, mapped_column])
def test_sa_column_no_type(column_class) -> None:
with pytest.raises(RuntimeError):

class Item(SQLModel, table=True):
id: Optional[int] = Field(
default=None,
sa_type=Integer,
sa_column=Column(Integer, primary_key=True),
sa_column=column_class(Integer, primary_key=True),
)


def test_sa_column_no_primary_key() -> None:
@pytest.mark.parametrize("column_class", [Column, mapped_column])
def test_sa_column_no_primary_key(column_class) -> None:
with pytest.raises(RuntimeError):

class Item(SQLModel, table=True):
id: Optional[int] = Field(
default=None,
primary_key=True,
sa_column=Column(Integer, primary_key=True),
sa_column=column_class(Integer, primary_key=True),
)


def test_sa_column_no_nullable() -> None:
@pytest.mark.parametrize("column_class", [Column, mapped_column])
def test_sa_column_no_nullable(column_class) -> None:
with pytest.raises(RuntimeError):

class Item(SQLModel, table=True):
id: Optional[int] = Field(
default=None,
nullable=True,
sa_column=Column(Integer, primary_key=True),
sa_column=column_class(Integer, primary_key=True),
)


def test_sa_column_no_foreign_key() -> None:
@pytest.mark.parametrize("column_class", [Column, mapped_column])
def test_sa_column_no_foreign_key(clear_sqlmodel, column_class) -> None:
with pytest.raises(RuntimeError):

class Team(SQLModel, table=True):
Expand All @@ -95,38 +103,41 @@ class Hero(SQLModel, table=True):
team_id: Optional[int] = Field(
default=None,
foreign_key="team.id",
sa_column=Column(Integer, primary_key=True),
sa_column=column_class(Integer, primary_key=True),
)


def test_sa_column_no_unique() -> None:
@pytest.mark.parametrize("column_class", [Column, mapped_column])
def test_sa_column_no_unique(column_class) -> None:
with pytest.raises(RuntimeError):

class Item(SQLModel, table=True):
id: Optional[int] = Field(
default=None,
unique=True,
sa_column=Column(Integer, primary_key=True),
sa_column=column_class(Integer, primary_key=True),
)


def test_sa_column_no_index() -> None:
@pytest.mark.parametrize("column_class", [Column, mapped_column])
def test_sa_column_no_index(column_class) -> None:
with pytest.raises(RuntimeError):

class Item(SQLModel, table=True):
id: Optional[int] = Field(
default=None,
index=True,
sa_column=Column(Integer, primary_key=True),
sa_column=column_class(Integer, primary_key=True),
)


def test_sa_column_no_ondelete() -> None:
@pytest.mark.parametrize("column_class", [Column, mapped_column])
def test_sa_column_no_ondelete(column_class) -> None:
with pytest.raises(RuntimeError):

class Item(SQLModel, table=True):
id: Optional[int] = Field(
default=None,
sa_column=Column(Integer, primary_key=True),
sa_column=column_class(Integer, primary_key=True),
ondelete="CASCADE",
)