Repository navigation
Closed
Labels
questionFurther information is requestedFurther information is requested
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
from typing import Optional
from sqlmodel import Field, SQLModel
class Server(SQLModel, table=True):
id: Optional[int] = Field(default=None, primary_key=True)
ip: str
health_status: Optional[str] = None
cpu_cores: Optional[int] = None
@router.post("/add")
def add_server(item:Server):
return server_action.add_server(item)
def add_server(item):
with Session(engine) as session:
session.add(item)
session.commit()
session.refresh(item) # could not refresh instance
return itemDescription
In sql model documentation I saw an example of session.refresh() but when I am trying to implement this in my fastapi project this not working and raise exception that is could not refresh instance and also I am trying to print item.id, this is not also working, raise exception that is expired.
Operating System
Linux
Operating System Details
No response
SQLModel Version
0.0.8
Python Version
3.10.6
Additional Context
raise sa_exc.InvalidRequestError(
sqlalchemy.exc.InvalidRequestError: Could not refresh instance '<Server at 0x7f69b549f500>'
Reacted by Théodore BOURGEON, oktavlachs, Vladyslav Udod, Ashikur Rahman, Craig, Ernesto Martinez del Pino, Jesus Alvarez, cristianciortea and Raphael-Dtonic
Metadata
Metadata
Assignees
Labels
questionFurther information is requestedFurther information is requested
Activity
AshikurRahman-sec commentedon Jan 25, 2023
database is mysql
JeseYe commentedon Feb 2, 2023
del session.refresh(item)
add session.flush()
maybe work
AshikurRahman-sec commentedon Feb 6, 2023
@JeseYe thanks but I want to know why session.refresh not refresh item.
fishfacegit commentedon Apr 3, 2023
You cannot refresh the item because there is no database instance connected with it.
To do that you need to retrieve the item from the database using an select statement.
You can use refresh in the following:
hero = session.get(Hero, {'name': 'Hans'})or a select statementhero.age=42session.add(hero)session.commit()session.refresh(hero)starryknight64 commentedon Dec 27, 2023
I'm running into this problem myself as well. Pardon my ignorance, but shouldn't SQLModel do this for us? Or is this just something that must be done when using MySQL (assuming this isn't a problem for other DB types)?
starryknight64 commentedon Dec 27, 2023
I discovered a solution for this:
As it turns out, the object I was passing to the REST endpoint had an ID specified (the ID was 0). When I either don't specify an ID or set it to None prior to adding/committing/refreshing then everything works as desired.
starryknight64 commentedon Dec 27, 2023
Although... again... shouldn't SQLModel (or FastAPI?) determine that since
default=Noneis specified that it passid=Noneinside the/docsendpoint? Right now, it passesid=0for the primary key when I assumed it would've passedid=None...thebirdgr commentedon Feb 26, 2024
Depends on what the default value in the Item schema is, whether 0 or None. However, we shouldn't be having to do this. Using an if condition to check for an id that is passed from a request seems like hacky fix to this problem. If the id is set as the primary key in the models it should be auto incremented by the orm.
makisukurisu commentedon Mar 19, 2024
I also have this (or, rather, a similar) issue. But in my case I do have both defaults that are not none, and a record with the same primary key in DB.
Code that doesn't work (right now at least)
Models
Endpoint
Code sample:
Basically - it takes in the model for a department, and spits out it's representation from the database by performing an update.
I'm using model validation to convert input to the DB model, and set the foreign key to the one specified in path.
department_existsjust verifies that specifieddepartment_idis valid and is present in the DBUpdate call
Error
I get exception
InvalidRequestErrorthat looks like this:There's a lengthy INSERT SQL query, which is performed in
db.commit()line. Which is expected, I guess, but not helpful in this case.Code that does work (right now)
Update the
update_entityand call to it by adding primary_key parameter. In my case it'sdepartment_id, and the method now looks like this:Right now I see this as my only solution, but if you have different ideas, please, let me (or, rather - us) know.
P.S. Just using refresh won't do, since then you will get an error that this object is not in registry yet.
Thanks!
Additional info
I'm using sqlmodel 0.0.16, the latest version at the moment of writing this comment.
AbirAbbas commentedon Jun 19, 2024
had a similar issue, setting auto_increment=True on primary_key id solved it
YuriiMotov commentedon Aug 6, 2025
The code example from the initial post seems to work well. I can't reproduce the issue.
YuriiMotov commentedon Aug 6, 2025
@makisukurisu, your issue is different from the issue above.
You are trying to update the existing item, but use
session.add. You should either use approach withupdate(entity_class).where()or usedb.get()to fetch the object that you can then update and commit.