Merge pull request #46 from ZeusWPI/add_db_migrations

Added alembic and flask-migrate to haldis (fixes #21 )

app/haldis.py

@@ -8,6 +8,12 @@ from models import *
 from forms import *
 from utils import *
 from views import *
+from flask.ext.migrate import Migrate, MigrateCommand
+from flask.ext.script import Manager
 
 if __name__ == '__main__':
-    app.run()
+    # do it here, because make accessing db changes only possible when executing the program directly
+    migrate = Migrate(app, db)
+    manager = Manager(app)
+    manager.add_command('db', MigrateCommand)
+    manager.run()

app/migrations/README

@@ -0,0 +1,6 @@
+Generic single-database configuration.
+
++On the existing databases, initialize flask-migrate and alembic with:
++```
++python haldis.py db stamp "354676f60be"
++```

app/migrations/alembic.ini

@@ -0,0 +1,45 @@
+# 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
+
+[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
+
+[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

app/migrations/env.py

@@ -0,0 +1,73 @@
+from __future__ import with_statement
+from alembic import context
+from sqlalchemy import engine_from_config, pool
+from logging.config import fileConfig
+
+# 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)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+from flask import current_app
+config.set_main_option('sqlalchemy.url', current_app.config.get('SQLALCHEMY_DATABASE_URI'))
+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)
+
+    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.
+
+    """
+    engine = engine_from_config(config.get_section(config.config_ini_section),
+                                prefix='sqlalchemy.',
+                                poolclass=pool.NullPool)
+
+    connection = engine.connect()
+    context.configure(connection=connection,
+                      target_metadata=target_metadata,
+                      **current_app.extensions['migrate'].configure_args)
+
+    try:
+        with context.begin_transaction():
+            context.run_migrations()
+    finally:
+        connection.close()
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()
+

app/migrations/script.py.mako

@@ -0,0 +1,22 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision}
+Create Date: ${create_date}
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

app/migrations/versions/2d696203e56_.py

@@ -0,0 +1,54 @@
+"""Make it possible for some columns to be null
+
+Revision ID: 2d696203e56
+Revises: 354676f60be
+Create Date: 2015-06-04 17:25:39.119678
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = '2d696203e56'
+down_revision = '354676f60be'
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.alter_column('location', 'name',
+               existing_type=sa.VARCHAR(length=120),
+               nullable=False)
+    op.alter_column('order_item', 'order_id',
+               existing_type=sa.INTEGER(),
+               nullable=False)
+    op.alter_column('product', 'name',
+               existing_type=sa.VARCHAR(length=120),
+               nullable=False)
+    op.alter_column('product', 'price',
+               existing_type=sa.INTEGER(),
+               nullable=False)
+    op.alter_column('user', 'username',
+               existing_type=sa.VARCHAR(length=80),
+               nullable=False)
+    ### end Alembic commands ###
+
+
+def downgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.alter_column('user', 'username',
+               existing_type=sa.VARCHAR(length=80),
+               nullable=True)
+    op.alter_column('product', 'price',
+               existing_type=sa.INTEGER(),
+               nullable=True)
+    op.alter_column('product', 'name',
+               existing_type=sa.VARCHAR(length=120),
+               nullable=True)
+    op.alter_column('order_item', 'order_id',
+               existing_type=sa.INTEGER(),
+               nullable=True)
+    op.alter_column('location', 'name',
+               existing_type=sa.VARCHAR(length=120),
+               nullable=True)
+    ### end Alembic commands ###

app/migrations/versions/354676f60be_.py

@@ -0,0 +1,74 @@
+"""Initial configuration
+
+Revision ID: 354676f60be
+Revises: None
+Create Date: 2015-06-04 17:17:28.933840
+
+"""
+
+# revision identifiers, used by Alembic.
+revision = '354676f60be'
+down_revision = None
+
+from alembic import op
+import sqlalchemy as sa
+
+
+def upgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('location',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('name', sa.String(length=120), nullable=True),
+    sa.Column('address', sa.String(length=254), nullable=True),
+    sa.Column('website', sa.String(length=120), nullable=True),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_table('user',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('username', sa.String(length=80), nullable=True),
+    sa.Column('admin', sa.Boolean(), nullable=True),
+    sa.Column('bias', sa.Integer(), nullable=True),
+    sa.PrimaryKeyConstraint('id'),
+    sa.UniqueConstraint('username')
+    )
+    op.create_table('product',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('location_id', sa.Integer(), nullable=True),
+    sa.Column('name', sa.String(length=120), nullable=True),
+    sa.Column('price', sa.Integer(), nullable=True),
+    sa.ForeignKeyConstraint(['location_id'], ['location.id'], ),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_table('order',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('courrier_id', sa.Integer(), nullable=True),
+    sa.Column('location_id', sa.Integer(), nullable=True),
+    sa.Column('starttime', sa.DateTime(), nullable=True),
+    sa.Column('stoptime', sa.DateTime(), nullable=True),
+    sa.Column('public', sa.Boolean(), nullable=True),
+    sa.ForeignKeyConstraint(['courrier_id'], ['user.id'], ),
+    sa.ForeignKeyConstraint(['location_id'], ['location.id'], ),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_table('order_item',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('user_id', sa.Integer(), nullable=True),
+    sa.Column('order_id', sa.Integer(), nullable=True),
+    sa.Column('product_id', sa.Integer(), nullable=True),
+    sa.Column('name', sa.String(length=120), nullable=True),
+    sa.ForeignKeyConstraint(['order_id'], ['order.id'], ),
+    sa.ForeignKeyConstraint(['product_id'], ['product.id'], ),
+    sa.ForeignKeyConstraint(['user_id'], ['user.id'], ),
+    sa.PrimaryKeyConstraint('id')
+    )
+    ### end Alembic commands ###
+
+
+def downgrade():
+    ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('order_item')
+    op.drop_table('order')
+    op.drop_table('product')
+    op.drop_table('user')
+    op.drop_table('location')
+    ### end Alembic commands ###

requirements.txt

@@ -6,6 +6,7 @@ Flask-Login==0.2.11
 Flask-OAuthlib==0.8.0
 Flask-SQLAlchemy==2.0
 Flask-WTF==0.10.3
+Flask-Migrate==1.4.0
 itsdangerous==0.24
 Jinja2==2.7.2
 MarkupSafe==0.23