open-nuclear-ops/starter-kit
1
0
Fork 0
Code Issues 3 Pull requests Projects Releases Packages Wiki Activity Actions

Add alembic to manage data migrations

Browse source
This commit is contained in:
Nick Touran 2026-01-05 12:05:32 -05:00
parent 8c73123862
commit e69b80b52c
6 changed files with 466 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

147
alembic.ini Normal file
View file

@ -0,0 +1,147 @@
# A generic, single database configuration.
[alembic]
# path to migration scripts.
# this is typically a path given in POSIX (e.g. forward slashes)
# format, relative to the token %(here)s which refers to the location of this
# ini file
script_location = %(here)s/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. for multiple paths, the path separator
# is defined by "path_separator" below.
prepend_sys_path = .
# timezone to use when rendering the date within the migration file
# as well as the filename.
# If specified, requires the tzdata library which can be installed by adding
# `alembic[tz]` to the pip requirements.
# string value is passed to ZoneInfo()
# 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 <script_location>/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 "path_separator"
# below.
# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions
# path_separator; This indicates what character is used to split lists of file
# paths, including version_locations and prepend_sys_path within configparser
# files such as alembic.ini.
# The default rendered in new alembic.ini files is "os", which uses os.pathsep
# to provide os-dependent path splitting.
#
# Note that in order to support legacy alembic.ini files, this default does NOT
# take place if path_separator is not present in alembic.ini. If this
# option is omitted entirely, fallback logic is as follows:
#
# 1. Parsing of the version_locations option falls back to using the legacy
# "version_path_separator" key, which if absent then falls back to the legacy
# behavior of splitting on spaces and/or commas.
# 2. Parsing of the prepend_sys_path option falls back to the legacy
# behavior of splitting on spaces, commas, or colons.
#
# Valid values for path_separator are:
#
# path_separator = :
# path_separator = ;
# path_separator = space
# path_separator = newline
#
# Use os.pathsep. Default configuration used for new projects.
path_separator = os
# 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
# database URL. This is consumed by the user-maintained env.py script only.
# other means of configuring database URLs may be customized within the env.py
# file.
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
# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
# hooks = ruff
# ruff.type = module
# ruff.module = ruff
# ruff.options = check --fix REVISION_SCRIPT_FILENAME
# Alternatively, use the exec runner to execute a binary found on your PATH
# hooks = ruff
# ruff.type = exec
# ruff.executable = ruff
# ruff.options = check --fix REVISION_SCRIPT_FILENAME
# Logging configuration. This is also consumed by the user-maintained
# env.py script only.
[loggers]
keys = root,sqlalchemy,alembic
[handlers]
keys = console
[formatters]
keys = generic
[logger_root]
level = WARNING
handlers = console
qualname =
[logger_sqlalchemy]
level = WARNING
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

1
alembic/README Normal file
View file

@ -0,0 +1 @@
pyproject configuration, based on the generic configuration.

80
alembic/env.py Normal file
View file

@ -0,0 +1,80 @@
from logging.config import fileConfig
from sqlalchemy import engine_from_config, pool
from sqlmodel import SQLModel
from alembic import context
from nrsk.db import get_engine
from nrsk.models import Document, User
# 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
# allow autogeneration of models
target_metadata = SQLModel.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=url,
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.
"""
# connectable = engine_from_config(
# config.get_section(config.config_ini_section, {}),
# prefix="sqlalchemy.",
# poolclass=pool.NullPool,
# )
connectable = get_engine()
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()

29
alembic/script.py.mako Normal file
View file

@ -0,0 +1,29 @@
"""${message}
Revision ID: ${up_revision}
Revises: ${down_revision | comma,n}
Create Date: ${create_date}
"""
from typing import Sequence, Union
from alembic import op
import sqlalchemy as sa
import sqlmodel
${imports if imports else ""}
# revision identifiers, used by Alembic.
revision: str = ${repr(up_revision)}
down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)}
branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
def upgrade() -> None:
"""Upgrade schema."""
${upgrades if upgrades else "pass"}
def downgrade() -> None:
"""Downgrade schema."""
${downgrades if downgrades else "pass"}

192
alembic/versions/3791144a7ad2_initial_setup.py Normal file
View file

@ -0,0 +1,192 @@
"""initial_setup
Revision ID: 3791144a7ad2
Revises:
Create Date: 2026-01-05 10:24:53.993818
"""
from typing import Sequence, Union
import sqlalchemy as sa
import sqlmodel
from alembic import op
# revision identifiers, used by Alembic.
revision: str = "3791144a7ad2"
down_revision: Union[str, Sequence[str], None] = None
branch_labels: Union[str, Sequence[str], None] = None
depends_on: Union[str, Sequence[str], None] = None
def upgrade() -> None:
"""Upgrade schema."""
# ### commands auto generated by Alembic - please adjust! ###
op.create_table(
"informationtype",
sa.Column("id", sa.Integer(), nullable=False),
sa.Column("name", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("abbrev", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("examples", sa.JSON(), nullable=True),
sa.Column("description", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("retention", sqlmodel.sql.sqltypes.AutoString(), nullable=True),
sa.Column("record", sa.Boolean(), nullable=False),
sa.Column("use_cases", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("notes", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("parent_id", sa.Integer(), nullable=True),
sa.ForeignKeyConstraint(
["parent_id"],
["informationtype.id"],
),
sa.PrimaryKeyConstraint("id"),
)
op.create_table(
"organization",
sa.Column("id", sa.Integer(), nullable=False),
sa.Column("name", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("abbreviation", sqlmodel.sql.sqltypes.AutoString(), nullable=True),
sa.Column("website", sqlmodel.sql.sqltypes.AutoString(), nullable=True),
sa.Column("is_active", sa.Boolean(), nullable=False),
sa.Column("parent_id", sa.Integer(), nullable=True),
sa.ForeignKeyConstraint(
["parent_id"],
["organization.id"],
),
sa.PrimaryKeyConstraint("id"),
)
op.create_index(
op.f("ix_organization_abbreviation"),
"organization",
["abbreviation"],
unique=False,
)
op.create_index(
op.f("ix_organization_name"), "organization", ["name"], unique=False
)
op.create_table(
"user",
sa.Column("id", sa.Integer(), nullable=False),
sa.Column("given_name", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("family_name", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("preferred_name", sqlmodel.sql.sqltypes.AutoString(), nullable=True),
sa.Column("previous_name", sqlmodel.sql.sqltypes.AutoString(), nullable=True),
sa.Column("email", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("joined_on", sa.DateTime(), nullable=True),
sa.Column("deactivated_on", sa.DateTime(), nullable=True),
sa.Column("organization", sqlmodel.sql.sqltypes.AutoString(), nullable=True),
sa.Column("title", sqlmodel.sql.sqltypes.AutoString(), nullable=True),
sa.PrimaryKeyConstraint("id"),
)
op.create_table(
"document",
sa.Column("id", sa.Integer(), nullable=False),
sa.Column("number", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("title", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("revision", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("originating_organization_id", sa.Integer(), nullable=True),
sa.Column(
"originator_number", sqlmodel.sql.sqltypes.AutoString(), nullable=True
),
sa.Column(
"originator_revision", sqlmodel.sql.sqltypes.AutoString(), nullable=True
),
sa.Column("type_id", sa.Integer(), nullable=False),
sa.Column(
"revision_comment", sqlmodel.sql.sqltypes.AutoString(), nullable=True
),
sa.Column(
"status",
sa.Enum(
"RESERVED",
"IN_PROGRESS",
"IN_REVIEW",
"REJECTED",
"AUTHORIZED",
"REFERENCE",
"NATIVE",
"APPROVED",
"QUARANTINED",
"SUPERSEDED",
"REVISED",
"VOIDED",
"CLOSED",
name="status",
),
nullable=False,
),
sa.Column(
"usage",
sa.Enum(
"FOR_INFORMATION",
"FOR_STAGE_APPROVAL",
"FOR_BID",
"FOR_CONSTRUCTION",
"FOR_OPERATION",
"AS_BUILT",
name="usage",
),
nullable=False,
),
sa.Column(
"retention_plan", sa.Enum("LIFETIME", name="retention"), nullable=False
),
sa.Column(
"restriction_codes", sqlmodel.sql.sqltypes.AutoString(), nullable=False
),
sa.Column("actual_reviewed_date", sa.DateTime(), nullable=True),
sa.Column("actual_approved_date", sa.DateTime(), nullable=True),
sa.Column(
"filenames", sa.JSON(), server_default=sa.text("'[]'"), nullable=False
),
sa.Column(
"file_notes", sa.JSON(), server_default=sa.text("'[]'"), nullable=False
),
sa.Column(
"checksums", sa.JSON(), server_default=sa.text("'[]'"), nullable=False
),
sa.Column(
"physical_location", sqlmodel.sql.sqltypes.AutoString(), nullable=True
),
sa.Column("notes", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.ForeignKeyConstraint(
["originating_organization_id"],
["organization.id"],
),
sa.ForeignKeyConstraint(
["type_id"],
["informationtype.id"],
),
sa.PrimaryKeyConstraint("id"),
)
op.create_table(
"documentuserlink",
sa.Column("id", sa.Integer(), nullable=False),
sa.Column("position", sa.Integer(), nullable=False),
sa.Column("role_note", sqlmodel.sql.sqltypes.AutoString(), nullable=False),
sa.Column("document_id", sa.Integer(), nullable=False),
sa.Column("user_id", sa.Integer(), nullable=False),
sa.ForeignKeyConstraint(
["document_id"],
["document.id"],
),
sa.ForeignKeyConstraint(
["user_id"],
["user.id"],
),
sa.PrimaryKeyConstraint("id", "document_id", "user_id"),
)
# ### end Alembic commands ###
def downgrade() -> None:
"""Downgrade schema."""
# ### commands auto generated by Alembic - please adjust! ###
op.drop_table("documentuserlink")
op.drop_table("document")
op.drop_table("user")
op.drop_index(op.f("ix_organization_name"), table_name="organization")
op.drop_index(op.f("ix_organization_abbreviation"), table_name="organization")
op.drop_table("organization")
op.drop_table("informationtype")
# ### end Alembic commands ###

17
pyproject.toml
View file

@ -43,6 +43,7 @@ dependencies = [
"uvicorn>=0.38.0", "uvicorn>=0.38.0",
"python-dotenv>=1.2.1", "python-dotenv>=1.2.1",
"psycopg2>=2.9.11", "psycopg2>=2.9.11",
"alembic>=1.17.2",
] ]
classifiers = [ classifiers = [
"Programming Language :: Python :: 3", "Programming Language :: Python :: 3",
@ -98,3 +99,19 @@ dev = [
"ipython>=8.18.1", "ipython>=8.18.1",
"pytest>=9.0.2", "pytest>=9.0.2",
] ]
[tool.alembic]
script_location = "%(here)s/alembic"
# file_template = "%%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s"
prepend_sys_path = [
"."
]
[[tool.alembic.post_write_hooks]]
name = "ruff"
type = "module"
module = "ruff"
options = "check --fix REVISION_SCRIPT_FILENAME"