Skip to content

✨ Add IntEnum for sqltypes #1337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 16 commits into
base: main
Choose a base branch
from
Open

✨ Add IntEnum for sqltypes #1337

wants to merge 16 commits into from

Conversation

KunxiSun
Copy link

@KunxiSun KunxiSun commented Apr 3, 2025 •
edited
Loading

I add a IntEnum type decorator which I used in my private project.

I wish it helps!

from enum import IntEnum
class HeroStatus(IntEnum):
    ACTIVE = 1
    DISABLE = 2    

from sqlmodel import IntEnum
class Hero(SQLModel):
    hero_status: HeroStatus = Field(sa_type=IntEnum(HeroStatus))


# Save as Integer in database, but load as IntEnum in program
user.hero_status == HeroStatus.ACTIVE

@KunxiSun

This comment was marked as resolved.

Sign in to view
@svlandeg svlandeg changed the title Add IntEnum for sqltypes ✨ Add IntEnum for sqltypes Apr 4, 2025
@svlandeg svlandeg added the feature New feature or request label Apr 4, 2025
@KunxiSun

This comment was marked as resolved.

Sign in to view
@svlandeg

This comment was marked as resolved.

Sign in to view
@KunxiSun
Copy link
Author

@KunxiSun: Yes - those are unrelated to your PR. We're looking into it here.

Thanks to let me know

YuriiMotov
YuriiMotov reviewed Aug 25, 2025
View reviewed changes
Copy link
Contributor

@YuriiMotov YuriiMotov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KunxiSun, thanks for your interest and efforts!

I think this feature is quite useful.
There seems to be no simple solution to configure int enums this way without creating custom TypeDecorator. This PR will provide such solution.

Please take a look at my in-code comments.
Also, we need to update these tests to check statements for new field

KunxiSun and others added 4 commits September 22, 2025 15:11
@KunxiSun @YuriiMotov
Apply suggestions from code review
3d04d94 
Co-authored-by: Motov Yurii <[email protected]>
@KunxiSun
test: add sa_type to BaseModel.int_enum_field
fecdbd2
@KunxiSun
update: Uses SmallInteger type for IntEnum
433ef53 
Updates the `IntEnum` SQLAlchemy type to `SmallInteger`.

This change reduces the storage size required for `IntEnum` columns when the full range of `Integer` is not needed.
@KunxiSun
test: Adds tests for integer enum fields
d1f65ac 
Adds tests to ensure that integer enum fields are correctly
handled in both Postgres and SQLite DDL generation.
@KunxiSun
Copy link
Author

@KunxiSun, thanks for your interest and efforts!

I think this feature is quite useful. There seems to be no simple solution to configure int enums this way without creating custom TypeDecorator. This PR will provide such solution.

Please take a look at my in-code comments. Also, we need to update these tests to check statements for new field

Thanks for your code suggestion.
The statement tests are added.

I also changed the type from Integer to Small Integer, cuz I think the size of Integer is too large to be needed.

@github-actions github-actions bot removed the waiting label Sep 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@YuriiMotov YuriiMotov YuriiMotov left review comments

Assignees
No one assigned
Labels
feature New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@KunxiSun @svlandeg @YuriiMotov