Skip to content

✨ Allow specifying the foreign_key using an instance of ForeignKey #894

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
earshinov wants to merge 11 commits into
base: main
Choose a base branch
from
Open

✨ Allow specifying the foreign_key using an instance of ForeignKey #894

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
0e03bac
✨Add `foreign_key_args` and `foreign_key_kwargs` arguments to `Field(…
earshinov Apr 12, 2024
6a8878d
Alternative implementation: remove sa_column_fk_{args,kwargs}, allow …
earshinov Sep 1, 2025
9828b5a
Merge branch 'main' into fk-attrs
YuriiMotov Oct 27, 2025
5b4509a
Clarify error message
YuriiMotov Oct 27, 2025
5ff875e
Fix `This ForeignKey already has a parent` for `test_base_model_fk`
YuriiMotov Oct 27, 2025
573bd10
Simplify tests
YuriiMotov Oct 27, 2025
1d5add9
Revert comment removal
YuriiMotov Oct 27, 2025
34181b3
Fix typing error
YuriiMotov Oct 27, 2025
5b3ff03
Merge branch 'main' into fk-attrs
YuriiMotov Jan 8, 2026
58d4eec
Merge branch 'main' into fk-attrs
svlandeg Feb 2, 2026
abf0d97
🎨 Auto format
pre-commit-ci-lite[bot] 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
35 changes: 26 additions & 9 deletions sqlmodel/main.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import uuid
import weakref
from collections.abc import Mapping, Sequence, Set
from copy import copy
from dataclasses import dataclass
from datetime import date, datetime, time, timedelta
from decimal import Decimal
Expand Down Expand Up @@ -156,6 +157,12 @@ def __init__(self, default: Any = Undefined, **kwargs: Any) -> None:
if ondelete is not Undefined:
if foreign_key is Undefined:
raise RuntimeError("ondelete can only be used with foreign_key")
if not isinstance(foreign_key, str):
raise RuntimeError(
"Passing ondelete to Field is not supported when foreign_key is "
"specified as sa_column_args=[ForeignKey(...)]. Pass ondelete as "
"a parameter to ForeignKey instead"
)
super().__init__(default=default, **kwargs)
self.primary_key = primary_key
self.nullable = nullable
Expand Down Expand Up @@ -763,14 +770,20 @@ def get_column_from_field(field: Any) -> Column: # type: ignore
if unique is Undefined:
unique = False
if foreign_key:
ondelete_value = _get_sqlmodel_field_value(field_info, "ondelete", Undefined)
if ondelete_value is Undefined:
ondelete_value = None
if ondelete_value == "SET NULL" and not nullable:
raise RuntimeError('ondelete="SET NULL" requires nullable=True')
assert isinstance(foreign_key, str)
assert isinstance(ondelete_value, (str, type(None))) # for typing
args.append(ForeignKey(foreign_key, ondelete=ondelete_value))
if isinstance(foreign_key, str):
ondelete_value = _get_sqlmodel_field_value(
field_info, "ondelete", Undefined
)
if ondelete_value is Undefined:
ondelete_value = None
if ondelete_value == "SET NULL" and not nullable:
raise RuntimeError('ondelete="SET NULL" requires nullable=True')
assert isinstance(foreign_key, str)
assert isinstance(ondelete_value, (str, type(None))) # for typing
args.append(ForeignKey(foreign_key, ondelete=ondelete_value))
else:
assert isinstance(foreign_key, ForeignKey)
args.append(copy(foreign_key))
kwargs = {
"primary_key": primary_key,
"nullable": nullable,
Expand All @@ -786,7 +799,11 @@ def get_column_from_field(field: Any) -> Column: # type: ignore
kwargs["default"] = sa_default
sa_column_args = _get_sqlmodel_field_value(field_info, "sa_column_args", Undefined)
if sa_column_args is not Undefined:
args.extend(list(cast(Sequence[Any], sa_column_args)))
for arg_v in list(cast(Sequence[Any], sa_column_args)):
if isinstance(arg_v, ForeignKey):
args.append(copy(arg_v))
else:
args.append(arg_v)
sa_column_kwargs = _get_sqlmodel_field_value(
field_info, "sa_column_kwargs", Undefined
)
Expand Down
51 changes: 51 additions & 0 deletions tests/test_field_sa_fk_args_kwargs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
from typing import Optional

from sqlalchemy import ForeignKey, create_engine
from sqlmodel import Field, SQLModel


def test_base_model_fk(clear_sqlmodel, caplog) -> None:
class User(SQLModel, table=True):
id: Optional[int] = Field(default=None, primary_key=True)

class Base(SQLModel):
owner_id: Optional[int] = Field(
default=None, sa_column_args=(ForeignKey("user.id", ondelete="SET NULL"),)
)

class Asset(Base, table=True):
id: Optional[int] = Field(default=None, primary_key=True)

class Document(Base, table=True):
id: Optional[int] = Field(default=None, primary_key=True)

engine = create_engine("sqlite://", echo=True)
SQLModel.metadata.create_all(engine)

assert (
"FOREIGN KEY(owner_id) REFERENCES user (id) ON DELETE SET NULL" in caplog.text
)


def test_base_model_fk_args(clear_sqlmodel, caplog) -> None:
class User(SQLModel, table=True):
id: Optional[int] = Field(default=None, primary_key=True)

class Base(SQLModel):
owner_id: Optional[int] = Field(
default=None,
foreign_key=ForeignKey("user.id", ondelete="SET NULL"),
)

class Asset(Base, table=True):
id: Optional[int] = Field(default=None, primary_key=True)

class Document(Base, table=True):
id: Optional[int] = Field(default=None, primary_key=True)

engine = create_engine("sqlite://", echo=True)
SQLModel.metadata.create_all(engine)

assert (
"FOREIGN KEY(owner_id) REFERENCES user (id) ON DELETE SET NULL" in caplog.text
)