Skip to content

Commit 39b07c7

Browse files
committed
Add migrations
1 parent 9761794 commit 39b07c7

File tree

6 files changed

+202
-3
lines changed

6 files changed

+202
-3
lines changed

README.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,8 @@ Rename the env.template file to .env file.
4040
$ psql -U postgres -c "create user dpr_user password 'secret' createdb;"
4141
$ psql -U postgres -c "create database dpr_db owner=dpr_user;"
4242
43-
# create and populate tables
44-
$ python manager.py createdb
45-
$ python manager.py populate
43+
# create tables
44+
python manager.py db upgrade
4645
4746
# you may need to install psysopg2 manually if comand throws errors
4847
$ sudo apt-get install libpq-dev python-dev

migrations/README

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Generic single-database configuration.

migrations/alembic.ini

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# A generic, single database configuration.
2+
3+
[alembic]
4+
# template used to generate migration files
5+
file_template = %%(rev)s_%%(slug)s
6+
7+
# set to 'true' to run the environment during
8+
# the 'revision' command, regardless of autogenerate
9+
# revision_environment = false
10+
11+
12+
# Logging configuration
13+
[loggers]
14+
keys = root,sqlalchemy,alembic
15+
16+
[handlers]
17+
keys = console
18+
19+
[formatters]
20+
keys = generic
21+
22+
[logger_root]
23+
level = WARN
24+
handlers = console
25+
qualname =
26+
27+
[logger_sqlalchemy]
28+
level = WARN
29+
handlers =
30+
qualname = sqlalchemy.engine
31+
32+
[logger_alembic]
33+
level = INFO
34+
handlers =
35+
qualname = alembic
36+
37+
[handler_console]
38+
class = StreamHandler
39+
args = (sys.stderr,)
40+
level = NOTSET
41+
formatter = generic
42+
43+
[formatter_generic]
44+
format = %(levelname)-5.5s [%(name)s] %(message)s
45+
datefmt = %H:%M:%S

migrations/env.py

+87
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
from __future__ import with_statement
2+
from alembic import context
3+
from sqlalchemy import engine_from_config, pool
4+
from logging.config import fileConfig
5+
import logging
6+
7+
# this is the Alembic Config object, which provides
8+
# access to the values within the .ini file in use.
9+
config = context.config
10+
11+
# Interpret the config file for Python logging.
12+
# This line sets up loggers basically.
13+
fileConfig(config.config_file_name)
14+
logger = logging.getLogger('alembic.env')
15+
16+
# add your model's MetaData object here
17+
# for 'autogenerate' support
18+
# from myapp import mymodel
19+
# target_metadata = mymodel.Base.metadata
20+
from flask import current_app
21+
config.set_main_option('sqlalchemy.url',
22+
current_app.config.get('SQLALCHEMY_DATABASE_URI'))
23+
target_metadata = current_app.extensions['migrate'].db.metadata
24+
25+
# other values from the config, defined by the needs of env.py,
26+
# can be acquired:
27+
# my_important_option = config.get_main_option("my_important_option")
28+
# ... etc.
29+
30+
31+
def run_migrations_offline():
32+
"""Run migrations in 'offline' mode.
33+
34+
This configures the context with just a URL
35+
and not an Engine, though an Engine is acceptable
36+
here as well. By skipping the Engine creation
37+
we don't even need a DBAPI to be available.
38+
39+
Calls to context.execute() here emit the given string to the
40+
script output.
41+
42+
"""
43+
url = config.get_main_option("sqlalchemy.url")
44+
context.configure(url=url)
45+
46+
with context.begin_transaction():
47+
context.run_migrations()
48+
49+
50+
def run_migrations_online():
51+
"""Run migrations in 'online' mode.
52+
53+
In this scenario we need to create an Engine
54+
and associate a connection with the context.
55+
56+
"""
57+
58+
# this callback is used to prevent an auto-migration from being generated
59+
# when there are no changes to the schema
60+
# reference: http://alembic.readthedocs.org/en/latest/cookbook.html
61+
def process_revision_directives(context, revision, directives):
62+
if getattr(config.cmd_opts, 'autogenerate', False):
63+
script = directives[0]
64+
if script.upgrade_ops.is_empty():
65+
directives[:] = []
66+
logger.info('No changes in schema detected.')
67+
68+
engine = engine_from_config(config.get_section(config.config_ini_section),
69+
prefix='sqlalchemy.',
70+
poolclass=pool.NullPool)
71+
72+
connection = engine.connect()
73+
context.configure(connection=connection,
74+
target_metadata=target_metadata,
75+
process_revision_directives=process_revision_directives,
76+
**current_app.extensions['migrate'].configure_args)
77+
78+
try:
79+
with context.begin_transaction():
80+
context.run_migrations()
81+
finally:
82+
connection.close()
83+
84+
if context.is_offline_mode():
85+
run_migrations_offline()
86+
else:
87+
run_migrations_online()

migrations/script.py.mako

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
"""${message}
2+
3+
Revision ID: ${up_revision}
4+
Revises: ${down_revision}
5+
Create Date: ${create_date}
6+
7+
"""
8+
9+
# revision identifiers, used by Alembic.
10+
revision = ${repr(up_revision)}
11+
down_revision = ${repr(down_revision)}
12+
13+
from alembic import op
14+
import sqlalchemy as sa
15+
${imports if imports else ""}
16+
17+
def upgrade():
18+
${upgrades if upgrades else "pass"}
19+
20+
21+
def downgrade():
22+
${downgrades if downgrades else "pass"}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
"""initial
2+
3+
Revision ID: ad2dd594a486
4+
Revises: None
5+
Create Date: 2016-11-03 17:45:07.971498
6+
7+
"""
8+
9+
# revision identifiers, used by Alembic.
10+
revision = 'ad2dd594a486'
11+
down_revision = None
12+
13+
from alembic import op
14+
import sqlalchemy as sa
15+
from sqlalchemy.dialects import postgresql
16+
17+
def upgrade():
18+
### commands auto generated by Alembic - please adjust! ###
19+
op.create_table('packages',
20+
sa.Column('id', sa.Integer(), nullable=False),
21+
sa.Column('name', sa.String(length=64), nullable=True),
22+
sa.Column('publisher', sa.String(length=64), nullable=True),
23+
sa.Column('descriptor', postgresql.JSON(astext_type=sa.Text()), nullable=True),
24+
sa.Column('status', sa.String(length=16), nullable=True),
25+
sa.Column('private', sa.Boolean(), nullable=True),
26+
sa.PrimaryKeyConstraint('id'),
27+
sa.UniqueConstraint('name', 'publisher')
28+
)
29+
op.create_table('user',
30+
sa.Column('user_id', sa.String(length=64), nullable=False),
31+
sa.Column('email', sa.String(length=128), nullable=True),
32+
sa.Column('secret', sa.String(length=64), nullable=True),
33+
sa.Column('user_name', sa.String(length=64), nullable=True),
34+
sa.PrimaryKeyConstraint('user_id')
35+
)
36+
op.create_index(op.f('ix_user_email'), 'user', ['email'], unique=False)
37+
### end Alembic commands ###
38+
39+
40+
def downgrade():
41+
### commands auto generated by Alembic - please adjust! ###
42+
op.drop_index(op.f('ix_user_email'), table_name='user')
43+
op.drop_table('user')
44+
op.drop_table('packages')
45+
### end Alembic commands ###

0 commit comments

Comments
 (0)