blob: e91860057d09e0a556405e93c735e8bc4cd8cdcc (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
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.")
|