how to use return value of sqlmodel_update()

[himkt]

First Check

• I added a very descriptive title here.
• 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

# documented
db_hero.sqlmodel_update(hero_data, update=extra_data)
session.add(db_hero)

# undocumented but it works
db_hero = db_hero.sqlmodel_update(hero_data, update=extra_data)
session.add(db_hero)

Description

I just have one simple question; when we should use the returned value of .sqlmodel_update()?

I'm following the tutorial to update data as in the example code.

• tutorial: https://sqlmodel.tiangolo.com/tutorial/fastapi/update-extra-data/#update-with-extra-data

At the same time, .sqlmodel_update() also returns self. But I didn't find any usage of this value in the tutorial.

• sqlmodel/sqlmodel/main.py

  Line 1008 in e7744e5

  return self

Given the context, I'm just curious why .sqlmodel_update() returns a value. It just aligns with .model_validate() in Pydantic?

Operating System

macOS

Operating System Details

No response

SQLModel Version

0.0.16

Python Version

3.11.11

Additional Context

No response