How to ignore list of tables: specifically phpMyAdmin tables.

[hasansezertasan]

Hello everyone 👋 Thanks for the great work!

I'm using MySQL as my database and phpMyAdmin to navigate it visually. I have enabled some features of phpMyAdmin and it created 19 tables. Some of them are crucial to me, I use some pre-defined SQL Queries and those are in the pma__bookmark table.

The problem is that whenever I use the alembic revision --autogenerate command, it detects these tables and creates a removal code, and I manually delete these codes every time.

These are the tables that I want "alembic" to ignore: pma__bookmark, pma__central_columns, pma__column_info, pma__designer_settings, pma__export_templates, pma__favorite, pma__history, pma__navigationhiding, pma__pdf_pages, pma__recent, pma__relation, pma__savedsearches, pma__table_coords, pma__table_info, pma__table_uiprefs, pma__tracking, pma_userconfig, pma__usergroups, pma__users

Is there any way to ignore these tables?

[CaselIT]

Hi,

Sure, it's documented here https://alembic.sqlalchemy.org/en/latest/autogenerate.html#omitting-schema-names-from-the-autogenerate-process

[hasansezertasan]

Thank you 🙏, with the help of the documentation I was able to know what to search for clearly.

This is the StackOverflow question I got helped from python - Alembic ignore specific tables - Stack Overflow

Here is my final env.py file:

from logging.config import fileConfig

from alembic import context
from sqlalchemy import engine_from_config, pool

# this is the Alembic Config object, which provides
# access to the values within the .ini file in use.
config = context.config


# ! Custom Start
from src.config import SQLALCHEMY_DATABASE_URL

config.set_main_option("sqlalchemy.url", SQLALCHEMY_DATABASE_URL)

IGNORE_TABLES = [
    "pma__bookmark",
    "pma__central_columns",
    "pma__column_info",
    "pma__designer_settings",
    "pma__export_templates",
    "pma__favorite",
    "pma__history",
    "pma__navigationhiding",
    "pma__pdf_pages",
    "pma__recent",
    "pma__relation",
    "pma__savedsearches",
    "pma__table_coords",
    "pma__table_info",
    "pma__table_uiprefs",
    "pma__tracking",
    "pma__userconfig",
    "pma__usergroups",
    "pma__users",
]

def include_object(object, name, type_, reflected, compare_to):
    """
    Should you include this table or not?
    """

    if type_ == 'table' and (name in IGNORE_TABLES or object.info.get("skip_autogenerate", False)):
        return False

    elif type_ == "column" and object.info.get("skip_autogenerate", False):
        return False

    return True
# ! Custom End

# Interpret the config file for Python logging.
# This line sets up loggers basically.
if config.config_file_name is not None:
    fileConfig(config.config_file_name)

from database.config import Base

# add your model's MetaData object here
# for 'autogenerate' support
# from myapp import mymodel
# target_metadata = mymodel.Base.metadata
# ! Custom Start
from database.models import *  # I highly recommend not to import everything like this, but it's your choice...
# ! Custom End

target_metadata = Base.metadata

# other values from the config, defined by the needs of env.py,
# can be acquired:
# my_important_option = config.get_main_option("my_important_option")
# ... etc.


def run_migrations_offline() -> None:
    """Run migrations in 'offline' mode.

    This configures the context with just a URL
    and not an Engine, though an Engine is acceptable
    here as well.  By skipping the Engine creation
    we don't even need a DBAPI to be available.

    Calls to context.execute() here emit the given string to the
    script output.

    """
    url = config.get_main_option("sqlalchemy.url")
    context.configure(
        url=url,
        target_metadata=target_metadata,
        literal_binds=True,
        dialect_opts={"paramstyle": "named"},
        render_as_batch=True,
    )

    with context.begin_transaction():
        context.run_migrations()


def run_migrations_online() -> None:
    """Run migrations in 'online' mode.

    In this scenario we need to create an Engine
    and associate a connection with the context.

    """
    connectable = engine_from_config(
        config.get_section(config.config_ini_section, {}),
        prefix="sqlalchemy.",
        poolclass=pool.NullPool,
    )

    with connectable.connect() as connection:
        context.configure(
            connection=connection,
            target_metadata=target_metadata,
            render_as_batch=True,
            # ! Custom Start
            include_object = include_object,
            # ! Custom End
        )

        with context.begin_transaction():
            context.run_migrations()


if context.is_offline_mode():
    run_migrations_offline()
else:
    run_migrations_online()

Please just don't copy and paste the code. Your alembic version could be different than mine and it can cause problems. Edit your env.py file accordingly.