You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I used the GitHub search to find a similar question 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
# My question is not code-based.
Description
SQLModel has extensive tutorials, which is very helpful for getting started, but it could really use an API reference. I often find myself trying to figure out whether a function or constructor has an argument for what I'm trying to do. I can search the tutorials, but even when I find what I'm looking for, the description is often incomplete. In other cases, SQLModel does have the feature I'm looking for, but it's not documented anywhere (like the nullable argument to sqlmodel.Field()).
For an example of what I'm requesting, see this comprehensive description of sqlalchemy's Column constructor. This level of detail may not be feasible, but even something that just lists all arguments would be very helpful.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
-
First Check
Commit to Help
Example Code
# My question is not code-based.
Description
SQLModel has extensive tutorials, which is very helpful for getting started, but it could really use an API reference. I often find myself trying to figure out whether a function or constructor has an argument for what I'm trying to do. I can search the tutorials, but even when I find what I'm looking for, the description is often incomplete. In other cases, SQLModel does have the feature I'm looking for, but it's not documented anywhere (like the
nullable
argument tosqlmodel.Field()
).For an example of what I'm requesting, see this comprehensive description of sqlalchemy's
Column
constructor. This level of detail may not be feasible, but even something that just lists all arguments would be very helpful.Operating System
Linux, Windows, macOS, Other
Operating System Details
This applies to all operating systems.
SQLModel Version
0.0.24
Python Version
3.13.5
Additional Context
No response
Beta Was this translation helpful? Give feedback.
All reactions