From 91ff9a4caf5e55a656784a7c2294a308570c12e9 Mon Sep 17 00:00:00 2001 From: Jack Case Date: Mon, 30 Mar 2026 10:29:31 -0400 Subject: [PATCH 1/4] create directory for DB migrations with alembic --- migrations/requirements.txt | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 migrations/requirements.txt diff --git a/migrations/requirements.txt b/migrations/requirements.txt new file mode 100644 index 0000000..6535812 --- /dev/null +++ b/migrations/requirements.txt @@ -0,0 +1,2 @@ +alembic + From 500ab56be0969fe7327f520b2e0630b6f7a46a85 Mon Sep 17 00:00:00 2001 From: Jack Case Date: Mon, 30 Mar 2026 10:35:29 -0400 Subject: [PATCH 2/4] ran `alembic init alembic` --- migrations/alembic.ini | 149 ++++++++++++++++++++++++++++++ migrations/alembic/README | 1 + migrations/alembic/env.py | 78 ++++++++++++++++ migrations/alembic/script.py.mako | 28 ++++++ 4 files changed, 256 insertions(+) create mode 100644 migrations/alembic.ini create mode 100644 migrations/alembic/README create mode 100644 migrations/alembic/env.py create mode 100644 migrations/alembic/script.py.mako diff --git a/migrations/alembic.ini b/migrations/alembic.ini new file mode 100644 index 0000000..807ded2 --- /dev/null +++ b/migrations/alembic.ini @@ -0,0 +1,149 @@ +# 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 +# Or organize into date-based subdirectories (requires recursive_version_locations = true) +# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).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 /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 diff --git a/migrations/alembic/README b/migrations/alembic/README new file mode 100644 index 0000000..98e4f9c --- /dev/null +++ b/migrations/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration. \ No newline at end of file diff --git a/migrations/alembic/env.py b/migrations/alembic/env.py new file mode 100644 index 0000000..36112a3 --- /dev/null +++ b/migrations/alembic/env.py @@ -0,0 +1,78 @@ +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. +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 = None + +# 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, + ) + + 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/migrations/alembic/script.py.mako b/migrations/alembic/script.py.mako new file mode 100644 index 0000000..1101630 --- /dev/null +++ b/migrations/alembic/script.py.mako @@ -0,0 +1,28 @@ +"""${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 +${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"} From 7c895c8191ffcf8c6ac6cefda6a0b733b210b17d Mon Sep 17 00:00:00 2001 From: Jack Case Date: Mon, 30 Mar 2026 11:31:55 -0400 Subject: [PATCH 3/4] update .gitignore for files under migrations ignore pycache files, etc. --- .gitignore | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.gitignore b/.gitignore index 0b188bc..cb8da0a 100644 --- a/.gitignore +++ b/.gitignore @@ -16,3 +16,8 @@ target/ # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ + +# ignorable files in migrations/ +**/__pycache__ +migrations/env/ +migrations/test_db.sqlite From d76d1afd9df013164119e9a695b0b3d246d024a5 Mon Sep 17 00:00:00 2001 From: Jack Case Date: Mon, 30 Mar 2026 11:32:42 -0400 Subject: [PATCH 4/4] create a first alembic revision to generate blocks and pages tables point alembic.ini at a local sqlite db for testing --- migrations/alembic.ini | 2 +- .../040713502ba4_initial_outline_rs_schema.py | 48 +++++++++++++++++++ 2 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 migrations/alembic/versions/040713502ba4_initial_outline_rs_schema.py diff --git a/migrations/alembic.ini b/migrations/alembic.ini index 807ded2..d682a3a 100644 --- a/migrations/alembic.ini +++ b/migrations/alembic.ini @@ -86,7 +86,7 @@ path_separator = os # 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 +sqlalchemy.url = sqlite+pysqlite:///test_db.sqlite [post_write_hooks] diff --git a/migrations/alembic/versions/040713502ba4_initial_outline_rs_schema.py b/migrations/alembic/versions/040713502ba4_initial_outline_rs_schema.py new file mode 100644 index 0000000..d51f884 --- /dev/null +++ b/migrations/alembic/versions/040713502ba4_initial_outline_rs_schema.py @@ -0,0 +1,48 @@ +"""initial outline-rs schema + +Revision ID: 040713502ba4 +Revises: +Create Date: 2026-03-30 10:47:36.255978 + +""" +from typing import Sequence, Union + +from alembic import op +import sqlalchemy as sa + + + +# revision identifiers, used by Alembic. +revision: str = '040713502ba4' +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.""" + + # block table holds individual bullet points in the outline + op.create_table( + "blocks", + sa.Column("id", sa.INTEGER, primary_key=True), + sa.Column("first_child_id", sa.INTEGER, sa.schema.ForeignKey("blocks.id")), + sa.Column("next_sibling_id", sa.INTEGER, sa.schema.ForeignKey("blocks.id")), + sa.Column("page_id", sa.INTEGER, sa.schema.ForeignKey("pages.id"), index=True), + sa.Column("content", sa.types.UnicodeText) + ) + + op.create_table( + "pages", + sa.Column("id", sa.INTEGER, primary_key=True), + sa.Column("root_block_id", sa.INTEGER, sa.schema.ForeignKey("blocks.id")), + sa.Column("title", sa.types.UnicodeText) + ) + pass + + +def downgrade() -> None: + """Downgrade schema.""" + op.drop_table("blocks") + op.drop_table("pages") + pass