diff options
Diffstat (limited to 'webmentions_ssg/cli')
| -rw-r--r-- | webmentions_ssg/cli/database.py | 49 | ||||
| -rw-r--r-- | webmentions_ssg/cli/mail.py | 4 | ||||
| -rw-r--r-- | webmentions_ssg/cli/users.py | 4 |
3 files changed, 57 insertions, 0 deletions
diff --git a/webmentions_ssg/cli/database.py b/webmentions_ssg/cli/database.py new file mode 100644 index 0000000..e918600 --- /dev/null +++ b/webmentions_ssg/cli/database.py @@ -0,0 +1,49 @@ +# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me> +# +# SPDX-License-Identifier: BSD-3-Clause + +"""Simple database commands built on Flask-Migrate.""" + +import click +from flask.cli import AppGroup +from flask_migrate import upgrade as migrate_upgrade +from sqlalchemy import inspect + +from .. import DATABASE + +DB_CLI = AppGroup("db", help="Handle database") + + +def _table_names() -> set[str]: + """Return existing table names without modifying the database schema.""" + with DATABASE.engine.connect() as connection: + return set(inspect(connection).get_table_names()) + + +@DB_CLI.command("create-db", help="Create a new database using all migrations") +def create_db() -> None: + """Initialize an empty database and record its Alembic revision.""" + if _table_names(): + raise click.ClickException( + "The database already contains tables. " + "Use 'flask db upgrade' for an existing migrated database." + ) + + # Applying migrations (rather than create_all()) keeps alembic_version in sync. + migrate_upgrade() + click.echo("Database created at the latest migration revision.") + + +@DB_CLI.command("upgrade", help="Upgrade an existing database to the latest revision") +def upgrade_db() -> None: + """Apply pending migrations to a previously initialized database.""" + if "alembic_version" not in _table_names(): + raise click.ClickException( + "No Flask-Migrate revision table found. " + "For a new, empty database run 'flask db create-db'. " + "For a legacy database, inspect its schema and use " + "'flask migrate stamp' only if appropriate." + ) + + migrate_upgrade() + click.echo("Database upgraded to the latest migration revision.") diff --git a/webmentions_ssg/cli/mail.py b/webmentions_ssg/cli/mail.py index 07dc50b..3ea903e 100644 --- a/webmentions_ssg/cli/mail.py +++ b/webmentions_ssg/cli/mail.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me> +# +# SPDX-License-Identifier: BSD-3-Clause + import click from flask import current_app from flask.cli import AppGroup diff --git a/webmentions_ssg/cli/users.py b/webmentions_ssg/cli/users.py index 2dcb17e..4ece2f4 100644 --- a/webmentions_ssg/cli/users.py +++ b/webmentions_ssg/cli/users.py @@ -1,3 +1,7 @@ +# SPDX-FileCopyrightText: 2026 Dennis Fink <me+coding@dennisfink.me> +# +# SPDX-License-Identifier: BSD-3-Clause + import click import sqlalchemy as sa from flask.cli import AppGroup |
