diff --git a/warehouse/__init__.py b/warehouse/__init__.py index 923d68d4b537bc6e446e863fae9e71a0b48f5d26..e700600fed417dd72c338e06abef3fc51241f985 100644 --- a/warehouse/__init__.py +++ b/warehouse/__init__.py @@ -3,6 +3,7 @@ import time import os from flask import Flask, render_template, request, redirect, url_for, Response, abort, session, flash +from flask_migrate import Migrate from requests_oauthlib import OAuth2Session from .models import db, Item, Location, Photo @@ -16,6 +17,7 @@ if not os.path.isdir(photo_upload_dir): os.mkdir(photo_upload_dir) db.init_app(app) +Migrate(app, db, render_as_batch=True, directory=os.path.join(app.root_path, 'migrations')) app.add_template_filter(qrcode_svg) app.add_template_filter(render_markdown, 'markdown') diff --git a/warehouse/migrations/alembic.ini b/warehouse/migrations/alembic.ini new file mode 100644 index 0000000000000000000000000000000000000000..ec9d45c26a6bb54e833fd4e6ce2de29343894f4b --- /dev/null +++ b/warehouse/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/warehouse/migrations/env.py b/warehouse/migrations/env.py new file mode 100644 index 0000000000000000000000000000000000000000..89f80b2112214f873958284ac5a3299608d63728 --- /dev/null +++ b/warehouse/migrations/env.py @@ -0,0 +1,110 @@ +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') + + +def get_engine(): + try: + # this works with Flask-SQLAlchemy<3 and Alchemical + return current_app.extensions['migrate'].db.get_engine() + except TypeError: + # this works with Flask-SQLAlchemy>=3 + return current_app.extensions['migrate'].db.engine + + +def get_engine_url(): + try: + return get_engine().url.render_as_string(hide_password=False).replace( + '%', '%%') + except AttributeError: + return str(get_engine().url).replace('%', '%%') + + +# 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', get_engine_url()) +target_db = current_app.extensions['migrate'].db + +# 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 get_metadata(): + if hasattr(target_db, 'metadatas'): + return target_db.metadatas[None] + return target_db.metadata + + +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=get_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 = get_engine() + + with connectable.connect() as connection: + context.configure( + connection=connection, + target_metadata=get_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/warehouse/migrations/script.py.mako b/warehouse/migrations/script.py.mako new file mode 100644 index 0000000000000000000000000000000000000000..2c0156303a8df3ffdc9de87765bf801bf6bea4a5 --- /dev/null +++ b/warehouse/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/warehouse/migrations/versions/549a81db4351_initial_migration.py b/warehouse/migrations/versions/549a81db4351_initial_migration.py new file mode 100644 index 0000000000000000000000000000000000000000..2f51f6b0056ebeb7a541f36cc474a4051f59677e --- /dev/null +++ b/warehouse/migrations/versions/549a81db4351_initial_migration.py @@ -0,0 +1,61 @@ +"""Initial migration + +Revision ID: 549a81db4351 +Revises: +Create Date: 2023-03-11 12:53:25.561808 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '549a81db4351' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('location', + sa.Column('id', sa.String(length=5), nullable=False), + sa.Column('name', sa.String(length=128), nullable=False), + sa.Column('description', sa.Text(), server_default='', nullable=False), + sa.Column('parent_id', sa.String(length=5), nullable=True), + sa.ForeignKeyConstraint(['parent_id'], ['location.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('photo', + sa.Column('id', sa.Integer(), autoincrement=True, nullable=False), + sa.Column('mimetype', sa.String(length=128), nullable=False), + sa.Column('path', sa.String(length=128), nullable=True), + sa.PrimaryKeyConstraint('id') + ) + op.create_table('item', + sa.Column('id', sa.String(length=5), nullable=False), + sa.Column('qr_code', sa.String(length=128), nullable=False), + sa.Column('name', sa.String(length=128), nullable=False), + sa.Column('description', sa.Text(), server_default='', nullable=False), + sa.Column('location_id', sa.String(length=5), nullable=True), + sa.ForeignKeyConstraint(['location_id'], ['location.id'], ), + sa.PrimaryKeyConstraint('id'), + sa.UniqueConstraint('qr_code') + ) + op.create_table('item_photo', + sa.Column('item_id', sa.String(length=5), nullable=False), + sa.Column('photo_id', sa.Integer(), nullable=False), + sa.ForeignKeyConstraint(['item_id'], ['item.id'], onupdate='CASCADE', ondelete='CASCADE'), + sa.ForeignKeyConstraint(['photo_id'], ['photo.id'], onupdate='CASCADE', ondelete='CASCADE'), + sa.PrimaryKeyConstraint('item_id', 'photo_id') + ) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('item_photo') + op.drop_table('item') + op.drop_table('photo') + op.drop_table('location') + # ### end Alembic commands ###