From 114b2f6729ad9a3b64ba1d13338e7f4e5805a00d Mon Sep 17 00:00:00 2001 From: Augusto Gunsch Date: Mon, 27 Dec 2021 19:01:49 -0300 Subject: [PATCH] Add migrations --- Procfile.txt | 3 +- api/migrations/README | 1 + api/migrations/alembic.ini | 50 +++++++++++++ api/migrations/env.py | 91 ++++++++++++++++++++++++ api/migrations/script.py.mako | 24 +++++++ api/migrations/versions/94e765018166_.py | 56 +++++++++++++++ 6 files changed, 224 insertions(+), 1 deletion(-) create mode 100644 api/migrations/README create mode 100644 api/migrations/alembic.ini create mode 100644 api/migrations/env.py create mode 100644 api/migrations/script.py.mako create mode 100644 api/migrations/versions/94e765018166_.py diff --git a/Procfile.txt b/Procfile.txt index 8c2d034..44a5a1a 100644 --- a/Procfile.txt +++ b/Procfile.txt @@ -1 +1,2 @@ -web: flask run +release: cd api && flask db upgrade +web: cd api && flask run diff --git a/api/migrations/README b/api/migrations/README new file mode 100644 index 0000000..0e04844 --- /dev/null +++ b/api/migrations/README @@ -0,0 +1 @@ +Single-database configuration for Flask. diff --git a/api/migrations/alembic.ini b/api/migrations/alembic.ini new file mode 100644 index 0000000..ec9d45c --- /dev/null +++ b/api/migrations/alembic.ini @@ -0,0 +1,50 @@ +# A generic, single database configuration. + +[alembic] +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + + +# Logging configuration +[loggers] +keys = root,sqlalchemy,alembic,flask_migrate + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console +qualname = + +[logger_sqlalchemy] +level = WARN +handlers = +qualname = sqlalchemy.engine + +[logger_alembic] +level = INFO +handlers = +qualname = alembic + +[logger_flask_migrate] +level = INFO +handlers = +qualname = flask_migrate + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(levelname)-5.5s [%(name)s] %(message)s +datefmt = %H:%M:%S diff --git a/api/migrations/env.py b/api/migrations/env.py new file mode 100644 index 0000000..68feded --- /dev/null +++ b/api/migrations/env.py @@ -0,0 +1,91 @@ +from __future__ import with_statement + +import logging +from logging.config import fileConfig + +from flask import current_app + +from alembic import context + +# this is the Alembic Config object, which provides +# access to the values within the .ini file in use. +config = context.config + +# Interpret the config file for Python logging. +# This line sets up loggers basically. +fileConfig(config.config_file_name) +logger = logging.getLogger('alembic.env') + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +config.set_main_option( + 'sqlalchemy.url', + str(current_app.extensions['migrate'].db.get_engine().url).replace( + '%', '%%')) +target_metadata = current_app.extensions['migrate'].db.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(): + """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 + ) + + with context.begin_transaction(): + context.run_migrations() + + +def run_migrations_online(): + """Run migrations in 'online' mode. + + In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + # this callback is used to prevent an auto-migration from being generated + # when there are no changes to the schema + # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html + def process_revision_directives(context, revision, directives): + if getattr(config.cmd_opts, 'autogenerate', False): + script = directives[0] + if script.upgrade_ops.is_empty(): + directives[:] = [] + logger.info('No changes in schema detected.') + + connectable = current_app.extensions['migrate'].db.get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=target_metadata, + process_revision_directives=process_revision_directives, + **current_app.extensions['migrate'].configure_args + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/api/migrations/script.py.mako b/api/migrations/script.py.mako new file mode 100644 index 0000000..2c01563 --- /dev/null +++ b/api/migrations/script.py.mako @@ -0,0 +1,24 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +${imports if imports else ""} + +# revision identifiers, used by Alembic. +revision = ${repr(up_revision)} +down_revision = ${repr(down_revision)} +branch_labels = ${repr(branch_labels)} +depends_on = ${repr(depends_on)} + + +def upgrade(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/api/migrations/versions/94e765018166_.py b/api/migrations/versions/94e765018166_.py new file mode 100644 index 0000000..cab6f17 --- /dev/null +++ b/api/migrations/versions/94e765018166_.py @@ -0,0 +1,56 @@ +"""empty message + +Revision ID: 94e765018166 +Revises: +Create Date: 2021-12-27 19:01:01.913495 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '94e765018166' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('trainers', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('nickname', sa.String(length=20), nullable=False), + sa.Column('first_name', sa.String(length=30), nullable=False), + sa.Column('last_name', sa.String(length=30), nullable=False), + sa.Column('email', sa.String(length=60), nullable=False), + sa.Column('password', sa.String(length=200), nullable=False), + sa.Column('team', sa.String(length=10), nullable=False), + sa.Column('pokemons_owned', sa.Integer(), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_trainers_email'), 'trainers', ['email'], unique=True) + op.create_index(op.f('ix_trainers_nickname'), 'trainers', ['nickname'], unique=True) + op.create_table('pokemons_owned', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('name', sa.Text(length=50), nullable=False), + sa.Column('level', sa.Integer(), nullable=True), + sa.Column('pokemon_id', sa.Integer(), nullable=True), + sa.Column('trainer_id', sa.Integer(), nullable=True), + sa.ForeignKeyConstraint(['trainer_id'], ['trainers.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_pokemons_owned_name'), 'pokemons_owned', ['name'], unique=True) + op.create_index(op.f('ix_pokemons_owned_trainer_id'), 'pokemons_owned', ['trainer_id'], unique=False) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index(op.f('ix_pokemons_owned_trainer_id'), table_name='pokemons_owned') + op.drop_index(op.f('ix_pokemons_owned_name'), table_name='pokemons_owned') + op.drop_table('pokemons_owned') + op.drop_index(op.f('ix_trainers_nickname'), table_name='trainers') + op.drop_index(op.f('ix_trainers_email'), table_name='trainers') + op.drop_table('trainers') + # ### end Alembic commands ###