diff --git a/README.md b/README.md index 1766ca0d..f9b1eb2d 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,14 @@ This will start: * A local PostgreSQL database listening on port 5432 * An Adminer instance listening on port 8432 +### Migrating the database schema + +Run the database migrations to build the database schema: + +``` +alembic upgrade head +``` + ### Seeding the database To load seed data into PostgreSQL, run: diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 00000000..00dd9ea1 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,110 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = alembic + +# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s +# Uncomment the line below if you want the files to be prepended with date and time +# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file +# for all available tokens +# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s + +# sys.path path, will be prepended to sys.path if present. +# defaults to the current working directory. +prepend_sys_path = . + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the python-dateutil library that can be +# installed by adding `alembic[tz]` to the pip requirements +# string value is passed to dateutil.tz.gettz() +# leave blank for localtime +# timezone = + +# max length of characters to apply to the +# "slug" field +# truncate_slug_length = 40 + +# set to 'true' to run the environment during +# the 'revision' command, regardless of autogenerate +# revision_environment = false + +# set to 'true' to allow .pyc and .pyo files without +# a source .py file to be detected as revisions in the +# versions/ directory +# sourceless = false + +# version location specification; This defaults +# to alembic/versions. When using multiple version +# directories, initial revisions must be specified with --version-path. +# The path separator used here should be the separator specified by "version_path_separator" below. +# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions + +# version path separator; As mentioned above, this is the character used to split +# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep. +# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas. +# Valid values for version_path_separator are: +# +# version_path_separator = : +# version_path_separator = ; +# version_path_separator = space +version_path_separator = os # Use os.pathsep. Default configuration used for new projects. + +# set to 'true' to search source files recursively +# in each "version_locations" directory +# new in Alembic version 1.10 +# recursive_version_locations = false + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +# sqlalchemy.url = driver://user:pass@localhost/dbname + + +[post_write_hooks] +# post_write_hooks defines scripts or Python functions that are run +# on newly generated revision scripts. See the documentation for further +# detail and examples + +# format using "black" - use the console_scripts runner, against the "black" entrypoint +# hooks = black +# black.type = console_scripts +# black.entrypoint = black +# black.options = -l 79 REVISION_SCRIPT_FILENAME + +# 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 diff --git a/alembic/README.md b/alembic/README.md new file mode 100644 index 00000000..6d7932af --- /dev/null +++ b/alembic/README.md @@ -0,0 +1,9 @@ +# Alembic database migrations + +This project uses [Alembic](https://alembic.sqlalchemy.org/) to manage database migrations. Please see the documentation for more information on how to generate new migrations for each database change. + +The preferred approach is to make changes to the [SQLAlchemy models in the `training.models` module](../training/models/), then have Alembic [autogenerate a migration](https://alembic.sqlalchemy.org/en/latest/autogenerate.html) based on those changes. The autogenerate approach supports most [common changes](https://alembic.sqlalchemy.org/en/latest/autogenerate.html#what-does-autogenerate-detect-and-what-does-it-not-detect) to the models, but more involved changes will require some manual migration editing. + +[Refer to the Alembic documentation](https://alembic.sqlalchemy.org/en/latest/) while creating migrations in order to ensure they are done properly. + +In general, each migration (whether an upgrade or downgrade) should preserve existing data as much as possible. diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 00000000..86bfcfe0 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,83 @@ +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +from alembic import context + +from training.models import Base +from training.database import db_uri + +# 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. +if config.config_file_name is not None: + fileConfig(config.config_file_name) + +# add your model's MetaData object here +# for 'autogenerate' support +# from myapp import mymodel +# target_metadata = mymodel.Base.metadata +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=db_uri, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={"paramstyle": "named"}, + ) + + 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. + + """ + config_section = config.get_section(config.config_ini_section, {}) + config_section["sqlalchemy.url"] = db_uri + connectable = engine_from_config( + config_section, + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + with connectable.connect() as connection: + context.configure( + connection=connection, target_metadata=target_metadata + ) + + with context.begin_transaction(): + context.run_migrations() + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/alembic/script.py.mako b/alembic/script.py.mako new file mode 100644 index 00000000..55df2863 --- /dev/null +++ b/alembic/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() -> None: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/7fd6082de5fa_add_agencies_table.py b/alembic/versions/7fd6082de5fa_add_agencies_table.py new file mode 100644 index 00000000..c423350c --- /dev/null +++ b/alembic/versions/7fd6082de5fa_add_agencies_table.py @@ -0,0 +1,31 @@ +"""add agencies table + +Revision ID: 7fd6082de5fa +Revises: +Create Date: 2023-03-16 16:51:51.977844 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '7fd6082de5fa' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + op.create_table( + 'agencies', + sa.Column('id', sa.Integer(), nullable=False), + sa.Column('name', sa.String(), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + op.create_index(op.f('ix_agencies_name'), 'agencies', ['name'], unique=True) + + +def downgrade() -> None: + op.drop_index(op.f('ix_agencies_name'), table_name='agencies') + op.drop_table('agencies') diff --git a/requirements.txt b/requirements.txt index 6b870372..6862b5de 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,4 +5,5 @@ pyjwt==2.6.0 fastapi_mail==1.2.5 cfenv==0.5.3 SQLAlchemy==2.0.5.post1 -psycopg2==2.9.5 \ No newline at end of file +psycopg2==2.9.5 +alembic==1.10.2 \ No newline at end of file diff --git a/training/database/__init__.py b/training/database/__init__.py index 56f65bdd..becfe9b2 100644 --- a/training/database/__init__.py +++ b/training/database/__init__.py @@ -1 +1 @@ -from .database import engine, SessionLocal +from .database import db_uri, engine, SessionLocal