From 500e6fae115792d54b5c4b84b10d451bac7fb9b0 Mon Sep 17 00:00:00 2001 From: Ryan Reed Date: Tue, 2 Jul 2019 19:22:28 -0400 Subject: [PATCH] Adding automation alembic scripts --- README.md | 15 ++++ alembic.ini | 74 ++++++++++++++++++ alembic/README | 1 + alembic/env.py | 76 +++++++++++++++++++ alembic/script.py.mako | 24 ++++++ ...3d42f09bc_adding_users_and_items_tables.py | 54 +++++++++++++ alembic/versions/b00a3ca977cc_baseline.py | 24 ++++++ app/database.py | 4 +- config.py | 9 +++ 9 files changed, 279 insertions(+), 2 deletions(-) create mode 100644 alembic.ini create mode 100644 alembic/README create mode 100644 alembic/env.py create mode 100644 alembic/script.py.mako create mode 100644 alembic/versions/4fe3d42f09bc_adding_users_and_items_tables.py create mode 100644 alembic/versions/b00a3ca977cc_baseline.py create mode 100644 config.py diff --git a/README.md b/README.md index 95bf4ce..11d8385 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,25 @@ * [Requirements](#requirements) +* [Alembic Database Migrations / Upgrades](#alembic-database-migrations--upgrades) +* [Running the Server](#running-the-server) # Requirements * FastAPI +* alembic * SQLAlchemy * uvicorn + +# Alembic Database Migrations / Upgrades + +```bash +alembic upgrade head # Upgrade/create database +alembic revision --autogenerate -m "My comment" # Commit/Create new migration script for database changes +``` + +# Running the Server +```bash +uvicorn app.main:app --reload +``` diff --git a/alembic.ini b/alembic.ini new file mode 100644 index 0000000..cc41841 --- /dev/null +++ b/alembic.ini @@ -0,0 +1,74 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = alembic + +# template used to generate migration files +# file_template = %%(rev)s_%%(slug)s + +# timezone to use when rendering the date +# within the migration file as well as the filename. +# 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 +# version_locations = %(here)s/bar %(here)s/bat alembic/versions + +# the output encoding used when revision files +# are written from script.py.mako +# output_encoding = utf-8 + +sqlalchemy.url = driver://user:pass@localhost/dbname + + +# 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 b/alembic/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/alembic/env.py b/alembic/env.py new file mode 100644 index 0000000..74c9bf3 --- /dev/null +++ b/alembic/env.py @@ -0,0 +1,76 @@ + +from logging.config import fileConfig + +from sqlalchemy import engine_from_config +from sqlalchemy import pool + +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) + +# The following is custom to get migration autogenerating working +import sys, os +sys.path.insert(0, os.path.dirname(os.path.dirname(__file__))) + +from config import Config as my_config +from app import database +config.set_main_option("sqlalchemy.url", my_config.SQLALCHEMY_DATABASE_URI) + +target_metadata = database.Base.metadata +# target_metadata = None + + + +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. + + """ + connectable = engine_from_config( + config.get_section(config.config_ini_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 0000000..2c01563 --- /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(): + ${upgrades if upgrades else "pass"} + + +def downgrade(): + ${downgrades if downgrades else "pass"} diff --git a/alembic/versions/4fe3d42f09bc_adding_users_and_items_tables.py b/alembic/versions/4fe3d42f09bc_adding_users_and_items_tables.py new file mode 100644 index 0000000..3f1eb8c --- /dev/null +++ b/alembic/versions/4fe3d42f09bc_adding_users_and_items_tables.py @@ -0,0 +1,54 @@ +"""Adding users and items tables + +Revision ID: 4fe3d42f09bc +Revises: b00a3ca977cc +Create Date: 2019-07-02 19:13:32.182089 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = '4fe3d42f09bc' +down_revision = 'b00a3ca977cc' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index('ix_users_email', table_name='users') + op.drop_index('ix_users_id', table_name='users') + op.drop_table('users') + op.drop_index('ix_items_description', table_name='items') + op.drop_index('ix_items_id', table_name='items') + op.drop_index('ix_items_title', table_name='items') + op.drop_table('items') + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('items', + sa.Column('id', sa.INTEGER(), nullable=False), + sa.Column('title', sa.VARCHAR(), nullable=True), + sa.Column('description', sa.VARCHAR(), nullable=True), + sa.Column('owner_id', sa.INTEGER(), nullable=True), + sa.ForeignKeyConstraint(['owner_id'], ['users.id'], ), + sa.PrimaryKeyConstraint('id') + ) + op.create_index('ix_items_title', 'items', ['title'], unique=False) + op.create_index('ix_items_id', 'items', ['id'], unique=False) + op.create_index('ix_items_description', 'items', ['description'], unique=False) + op.create_table('users', + sa.Column('id', sa.INTEGER(), nullable=False), + sa.Column('email', sa.VARCHAR(), nullable=True), + sa.Column('hashed_password', sa.VARCHAR(), nullable=True), + sa.Column('is_active', sa.BOOLEAN(), nullable=True), + sa.CheckConstraint('is_active IN (0, 1)'), + sa.PrimaryKeyConstraint('id') + ) + op.create_index('ix_users_id', 'users', ['id'], unique=False) + op.create_index('ix_users_email', 'users', ['email'], unique=1) + # ### end Alembic commands ### diff --git a/alembic/versions/b00a3ca977cc_baseline.py b/alembic/versions/b00a3ca977cc_baseline.py new file mode 100644 index 0000000..7c57909 --- /dev/null +++ b/alembic/versions/b00a3ca977cc_baseline.py @@ -0,0 +1,24 @@ +"""baseline + +Revision ID: b00a3ca977cc +Revises: +Create Date: 2019-07-02 18:51:54.019630 + +""" +from alembic import op +import sqlalchemy as sa + + +# revision identifiers, used by Alembic. +revision = 'b00a3ca977cc' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade(): + pass + + +def downgrade(): + pass diff --git a/app/database.py b/app/database.py index 6a23fd5..a9dd00f 100644 --- a/app/database.py +++ b/app/database.py @@ -2,10 +2,10 @@ from sqlalchemy import create_engine from sqlalchemy.ext.declarative import declarative_base from sqlalchemy.orm import sessionmaker -SQLALCHEMY_DATABASE_URL = "sqlite:///./test.db" +from config import Config engine = create_engine( - SQLALCHEMY_DATABASE_URL, + Config.SQLALCHEMY_DATABASE_URI, connect_args={"check_same_thread": False} #sqlite ) SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine) diff --git a/config.py b/config.py new file mode 100644 index 0000000..84eea9f --- /dev/null +++ b/config.py @@ -0,0 +1,9 @@ +import os + +class Config(): + BASEDIR = os.path.abspath(os.path.dirname(__file__)) + + SQLALCHEMY_DATABASE_URI = os.environ.get("DATABASE_URL") or "sqlite:///{}".format( + os.path.join(BASEDIR, "test.db") + ) + SQLALCHEMY_TRACK_MODIFICATIONS = False