specify different column names in SQLModel to match different naming convention

[matthiasburger]

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 typing import Optional
from uuid import UUID

from sqlmodel import SQLModel, Field


class ProjectBase(SQLModel):
    """
    Entity for the inspections.
    """
    guid: Optional[UUID] = Field(default=None, primary_key=True)
    manager_id: Optional[UUID] = Field(default=None)

Description

Our SQL-naming conventions are, that the column-names are written in camelCase. So we should have managerId instead of manager_id. But in python we want to use the correct python naming convention in snake_case.
I tried to use the event with column_reflect from SQLAlchemy, but it doesn't work - and doesn't change my column names.

edit: I don't want to change each single column, but more change the columns names dynamically with a function. Like the def __tablename__(cls): thingy for table-names.

Operating System

Windows, macOS

Operating System Details

No response

SQLModel Version

0.0.8

Python Version

3.10.10

Additional Context

No response

[antont]

We are using SA Column for this. Had an avatar field earlier, and it's still in the DB but not used in newer data, so the attr name in the class was changed, there's now a property for it instead.

    avatar_: Optional[str] = Field(sa_column=Column("avatar", String, default=None))

So you would do:

    manager_id: UUID = Field(sa_column=Column("managerId", String)) #or so

[matthiasburger]

ehm, yeah.. that's the easy answer - I think I was too fast with my question.
What I mean is, how to change the column names in general, dynamically - not specifying every single column-name.

[rivamarco]

Anything new on this?
We also need something like this for having uppercase columns.

Thanks!