The field name is python keywords, the field type is Mysql8.0 JSON

[TingHsi]

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

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# author: TingHsi

from typing import Optional, List, Any

from sqlmodel import Field, Session, SQLModel, create_engine

from time import time


# the table is created in MySQL 8.0
# SQLModel.metadata.create_all(engine)


class Logs_Push(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    content: str
    createdAt: int = int(time())
    _from: str
    remark: str
    result: str
    type: str
    userIds: List[str]


engine = create_engine("mysql+cymysql://root:123@127.0.0.1:3308/db1?charset=utf8mb4")


log_1 = Logs_Push(content="log_1", createdAt=time(),_from='from',remark='remark',result='result',type='im',userIds=['0','1'])
log_2 = Logs_Push(content="log_2", createdAt=time(),_from='from',remark='remark',result='result',type='im',userIds=['2','3'])


if __name__ == '__main__':
    with Session(engine) as session:
        session.add(log_1)
        session.add(log_2)
        session.commit()

Description

• I have a field, the name is "from"，rename to "_from" that's work in sqlalchemy, but sqlmodel not support;
• I have a field "userIds", the type is "json" in mysql8.0, use code "userIds = Column(JSON)" is work in sqlalchemy, use "userIds: List[str]" in sqlmodel not work.

Operating System

macOS

Operating System Details

No response

SQLModel Version

0.0.5

Python Version

Python 3.7.3

Additional Context

I try patch "sqlmodel/main.py" line 378 ,function get_sqlachemy_type
add code

if issubclass(field.type_, list) or issubclass(field.type_, dict):
    return JSON

And change my code "userIds: List[str]" to "userIds: Any"

Run this code return error:

if issubclass(field.type_, str):
TypeError: issubclass() arg 1 must be a class

my code not work, so i need your helps.

[TingHsi]

change code:
userIds: List[str]
to
userIds: Optional[List[str]] = Field(sa_column=Column(JSON),default=[])

question 2 is done

---

question 1

I have a field, the name is "from"，rename to "_from" that's work in sqlalchemy, but sqlmodel not support;

[ashleney]

Have you tried using pydantic's alias?

_from: str = Field(alias="from")

[YuriiMotov]

alias="form" doesn't work with Pydantic V2.
I managed to make it work with the following code:

    from_: str = Field(
        schema_extra={"validation_alias": "from"},  # Validation alias for Pydantic
        sa_column=Column("from", String),  # Column name and type for SQLAlchemy
    )

Runnable code example in the details:

from typing import Optional

from sqlmodel import Column, Field, Session, SQLModel, String, create_engine


class LogsPush(SQLModel, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    from_: str = Field(
        schema_extra={"validation_alias": "from"}, sa_column=Column("from", String)
    )


if __name__ == "__main__":
    engine = create_engine("sqlite:///", echo=True)
    SQLModel.metadata.create_all(engine)

    log_1 = LogsPush(id=1, from_="from")
    log_2 = LogsPush.model_validate({"id": 2, "from": "from"})

    with Session(engine) as session:
        session.add(log_1)
        session.add(log_2)
        session.commit()

    with Session(engine) as session:
        lp1 = session.get(LogsPush, 1)
        lp2 = session.get(LogsPush, 2)
        assert lp1.from_ == "from"
        assert lp2.from_ == "from"

    print(f"{lp1=}, {lp2=}")

[YuriiMotov]

I just created an issue to track the problem with alias parameter: #1536

Let's close this issue and track this there