Skip to content
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.

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

How to configure alembic autogenerate with multiple model files #1157

Open
lehoangnam040 opened this issue Aug 1, 2023 · 5 comments
Open
Labels
bug Something isn't working

Comments

@lehoangnam040
Copy link

lehoangnam040 commented Aug 1, 2023

Describe the bug
Have a versions file that create Account. After add another Product model, Run alembic revision --autogenerate -m "..." doesn't create new table Product but drop current table Account on new ..py in versions

To Reproduce

  • Project structure
.
├── devops
│   ├── db_migration
│   │   ├── alembic.ini
│   │   └── pg
│   │       ├── env.py
│   │       └── versions
│   │           ├── d65c5dec925e_create_account_table.py
├── service
│   ├── __init__.py
│   ├── databases
│   │   ├── __init__.py
│   │   ├── postgres
│   │   │   ├── __init__.py
│   │   │   ├── account.py
│   │   │   ├── product.py
  • devops/db_migration/pg/env.py
myPath = os.path.dirname(os.path.abspath(__file__))
sys.path.insert(0, myPath + "/../../../")

config = context.config
if config.config_file_name is not None:
    fileConfig(config.config_file_name)

from service.databases.postgres import DB_URL, metadata
target_metadata = metadata
...
  • devops/db_migration/pg/versions/d65c5dec925e_create_account_table.py
revision = 'd65c5dec925e'
down_revision = None
branch_labels = None
depends_on = None
def upgrade() -> None:
    op.create_table('account',
    sa.Column('uid', sa.BigInteger(), autoincrement=False, nullable=False),
    ...
    )
def downgrade() -> None:
    op.drop_table('account')
  • service/databases/__init__.py
DB_URL = f"postgresql://..."
metadata = sqlalchemy.MetaData()
database = databases.Database(DB_URL)

class PgBaseMeta(ormar.ModelMeta):
    database = database
    metadata = metadata
  • service/databases/account.py
from . import PgBaseMeta
class PgAccount(ormar.Model):
    class Meta(PgBaseMeta):
        tablename = "account"
    uid = ormar.BigInteger(autoincrement=False, primary_key=True)
    username = ormar.String(max_length=64, unique=True)
  • service/databases/product.py
from . import PgBaseMeta
class PgProduct(ormar.Model):
    class Meta(PgBaseMeta):
        tablename = "product"
    pid = ormar.BigInteger(autoincrement=False, primary_key=True)
    product_name = ormar.String(max_length=256)
  • Run command ...devops/db_migration $ alembic revision --autogenerate -m "create product table" create new file devops/db_migration/pg/versions/64ec73d106d7_create_product_table.py
revision = '64ec73d106d7'
down_revision = 'd65c5dec925e'
branch_labels = None
depends_on = None
def upgrade() -> None:
    op.drop_table('account')
def downgrade() -> None:
    # ### commands auto generated by Alembic - please adjust! ###
    op.create_table('account',
    ...
    )

Expected behavior

  • File devops/db_migration/pg/versions/64ec73d106d7_create_product_table.py should be
revision = '64ec73d106d7'
down_revision = 'd65c5dec925e'
branch_labels = None
depends_on = None
def upgrade() -> None:
    op.create_table('product')
def downgrade() -> None:
    # ### commands auto generated by Alembic - please adjust! ###
    op.drop_table('product',
    ...
    )

Versions (please complete the following information):

  • postgresql 14
  • Python version 3.11.4
  • ormar version 0.12.2
  • pydantic version 1.10.8
  • fastapi version 0.99.1
@lehoangnam040 lehoangnam040 added the bug Something isn't working label Aug 1, 2023
@rorik302
Copy link

rorik302 commented Aug 3, 2023

Have you try to import models to alembic env.py?

@lehoangnam040
Copy link
Author

Have you try to import models to alembic env.py?

Thank you, it worked when I import in env.py as

from service.databases.postgres import account, product

but not worked if I import

from service.databases.postgres import *

And honestly, I don't want to modify env.py everytime I add a new model.

@WojciechPartyka
Copy link

I think you just might need to sort out your imports,
first you need module where your metadata and PgBaseMeta lies,
then in env.py import that module and import all models from all apps

#somewhere at the beggining of env.py
from app1.models import *
from app2.models import *
import module_with_base

and set target_metadata = module_with_base.PgBaseMeta.metadata
that kind of structure works fine on my side at least :D

@lehoangnam040
Copy link
Author

lehoangnam040 commented Aug 4, 2023

and set target_metadata = module_with_base.PgBaseMeta.metadata that kind of structure works fine on my side at least :D

Thank you but it doesn't work on my side :))

@rorik302
Copy link

rorik302 commented Aug 4, 2023

Have you try to import models to alembic env.py?

Thank you, it worked when I import in env.py as

from service.databases.postgres import account, product

but not worked if I import

from service.databases.postgres import *

And honestly, I don't want to modify env.py everytime I add a new model.

Create variable somewhere in project, for example:

# src/models.py
app_models = [account, product]

Then just import app_models to env.py. When you create new models just add them to models.py app_models

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

3 participants