Repository navigation
Return a Column class for relationship attributes that require it #107
Description
First Check
- I added a very descriptive title to this issue.
- I used the GitHub search to find a similar issue and didn't find it.
- I searched the SQLModel documentation, with the integrated search.
- I already searched in Google "How to X in SQLModel" and didn't find any information.
- I already read and followed all the tutorial in the docs and didn't find an answer.
- I already checked if it is not related to SQLModel but to Pydantic.
- I already checked if it is not related to SQLModel but to SQLAlchemy.
Commit to Help
- I commit to help with one of those options 👆
Example Code
class UpsertByModelMixin(SQLModel):
created_by_id : Optional[int] = Field(default=None, foreign_key="users.id")
created_by: Optional["User"] = Relationship(sa_relationship_kwargs={ 'foreign_keys': [created_by_id] })
updated_by_id : Optional[int] = Field(default=None, foreign_key="users.id")
updated_by: Optional["User"] = Relationship(sa_relationship_kwargs={ 'foreign_keys': [updated_by_id] })
class Team(UpsertByModelMixin, SQLModel, table=True,):
__tablename__ = 'teams'
id: Optional[int] = Field(default=None, primary_key=True)
name: str = Field(max_length=500)
### Description
Use models such as above will result in the following error because the `foreign_keys` argument expects a `Column` (not a SQLModel `Field`).
| sqlalchemy.exc.ArgumentError: Column expression expected for argument 'foreign_keys'; got FieldInfo(default=PydanticUndefined, extra={'exclude': None, 'include': None}).
As such, its impossible right now for anyone to deploy classes with multiple FKs to the same identity and/or use custom named foreign key columns.
### Wanted Solution
To be able to specify foreign keys to the same related entity and/or name my fk columns however I choose.
### Wanted Code
```python
Just like above
Alternatives
No response
Operating System
Linux
Operating System Details
No response
SQLModel Version
0.0.4
Python Version
3.9.5
Additional Context
No response
Activity
ohmeow commentedon Sep 20, 2021
Maybe something like this would work ...
pmarcelll commentedon Mar 26, 2022
I've encountered the same issue and after reading this SQLAlchemy guide I've managed to work around it.
Based to the guide your code should look like this:
alextremblay commentedon May 28, 2024
it would be nice if
Relationshiphad alocal_keyparam to handle this, to avoid a lot of boilerplate.Ex, instead of
It would be nice to be able to write