"sqlmodel" is not defined (in alembic version files)

[daudln]

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

"""empty message

Revision ID: bd8e5185e36b
Revises: 
Create Date: 2024-04-23 08:50:34.102629

"""
from typing import Sequence, Union

from alembic import op
import sqlalchemy as sa
# missing import sqlmodel.sql.sqltypes

# revision identifiers, used by Alembic.
revision: str = 'bd8e5185e36b'
down_revision: Union[str, None] = None
branch_labels: Union[str, Sequence[str], None] = None
depends_on: Union[str, Sequence[str], None] = None


def upgrade() -> None:
    # ### commands auto generated by Alembic - please adjust! ###
    op.create_table('permission',
    sa.Column('id', sa.Integer(), nullable=False),
    sa.Column('unique_id', sqlmodel.sql.sqltypes.GUID(), nullable=True),
    sa.Column('name', sqlmodel.sql.sqltypes.AutoString(), nullable=False),
    sa.Column('code', sqlmodel.sql.sqltypes.AutoString(), nullable=False),
    sa.PrimaryKeyConstraint('id'),
    sa.UniqueConstraint('unique_id')
    )
    # ...

Description

Every time I run

alembic revision --autogenerate

In versions files, sqlmodel is not automatically imported. Which make me navigate to version file and add this line of code in input

import sqlmodel.sql.sqltypes

Operating System

Linux

Operating System Details

Ubuntu 22.04

SQLModel Version

0.0.16

Python Version

3.10.12

Additional Context

No response

[lanbaoshen]

You can modify script.py.mako and add the follow line:

import sqlmodel

[Kasuletrevor]

This helps first time. Thank you.

[KunxiSun]

First, Make sure you have the sqlmodel dependency

pip install sqlmodel

Then, add this line in script.py.mako. That is how the sqlmodel author does in the example.

import sqlmodel.sql.sqltypes

By adding this line, when you run alembic revision ...., the migration scripts will automatically have the import import sqlmodel.sql.sqltypes.