How can I create a SQL View?

[raffaem]

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

from sqlalchemy_utils.view import create_view

class HeroView(SQLModel, table=True):
    __table__ = create_view(
        metadata=SQLModel.metadata,
        name="hero_view",
        selectable=select(
            Hero.name.label("hero_name"), 
            Team.name.label("team_name")
        ).join(Team, Hero.team_id == Team.id, isouter=True)
    )

Description

Have an article on the Advanced User Guide that explains how to create a view.

Please find above a possible implementation.

Operating System

Windows

Operating System Details

No response

SQLModel Version

0.0.24

Python Version

3.13.3

Additional Context

No response

[raffaem]

In reality the code I provided doesn't work as expected, because the second time the code is run it will error out telling that the view already exists.

Apparently sqlalchemy_utils still issues CREATE VIEW even if exists.

I have also tried the SQLAlchemy's view recipe but without luck.

So I guess I'm here asking how to make a view with SQLModel.