From f2ef53c1a2ce584938efc4cd28a7fba15e10061d Mon Sep 17 00:00:00 2001 From: Wu Clan Date: Sun, 17 Dec 2023 01:24:18 +0800 Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0Alembic=E6=95=B0=E6=8D=AE?= =?UTF-8?q?=E5=BA=93=E8=BF=81=E7=A7=BB=E5=B7=A5=E5=85=B7?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + README.md | 18 ++++- backend/app/.env.example | 14 ++++ backend/app/alembic.ini | 114 +++++++++++++++++++++++++++++ backend/app/alembic/README | 1 + backend/app/alembic/env.py | 103 ++++++++++++++++++++++++++ backend/app/alembic/script.py.mako | 26 +++++++ backend/app/core/path_conf.py | 4 + backend/app/models/base.py | 3 +- requirements.txt | 1 + 10 files changed, 280 insertions(+), 5 deletions(-) create mode 100644 backend/app/alembic.ini create mode 100644 backend/app/alembic/README create mode 100644 backend/app/alembic/env.py create mode 100644 backend/app/alembic/script.py.mako diff --git a/.gitignore b/.gitignore index 58f40c2..1b641c6 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ __pycache__/ venv/ backend/app/log/ .ruff_cache/ +backend/app/alembic/versions/ diff --git a/README.md b/README.md index 43a2509..f42d1ec 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,6 @@ ## TODO - [ ] Docker -- [ ] Alembic ## 使用 @@ -44,8 +43,20 @@ cp .env.example .env ``` -6. 执行 backend/app/main.py 文件启动服务 -7. 浏览器访问: http://127.0.0.1:8000/api/v1/docs +6. 数据库迁移 [alembic](https://alembic.sqlalchemy.org/en/latest/tutorial.html) + + ```shell + cd backend/app/ + + # 生成迁移文件 + alembic revision --autogenerate + + # 执行迁移 + alembic upgrade head + ``` + +7. 执行 backend/app/main.py 文件启动服务 +8. 浏览器访问: http://127.0.0.1:8000/api/v1/docs --- @@ -86,4 +97,3 @@ ## 许可证 本项目根据 MIT 许可证的条款进行许可 - diff --git a/backend/app/.env.example b/backend/app/.env.example index e69de29..0d25232 100644 --- a/backend/app/.env.example +++ b/backend/app/.env.example @@ -0,0 +1,14 @@ +# Env: dev、pro +ENVIRONMENT='dev' +# MySQL +DB_HOST='127.0.0.1' +DB_PORT=3306 +DB_USER='root' +DB_PASSWORD='123456' +# Redis +REDIS_HOST='127.0.0.1' +REDIS_PORT=6379 +REDIS_PASSWORD='' +REDIS_DATABASE=0 +# Token +TOKEN_SECRET_KEY='1VkVF75nsNABBjK_7-qz7GtzNy3AMvktc9TCPwKczCk' diff --git a/backend/app/alembic.ini b/backend/app/alembic.ini new file mode 100644 index 0000000..4688a57 --- /dev/null +++ b/backend/app/alembic.ini @@ -0,0 +1,114 @@ +# A generic, single database configuration. + +[alembic] +# path to migration scripts +script_location = ./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 +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. +prepend_sys_path = . + +# timezone to use when rendering the date within the migration file +# as well as the filename. +# If specified, requires the python>=3.9 or backports.zoneinfo library. +# Any required deps can 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 ./alembic/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 "version_path_separator" below. +# version_locations = %(here)s/bar:%(here)s/bat:./alembic/versions + +# version path separator; As mentioned above, this is the character used to split +# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep. +# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas. +# Valid values for version_path_separator are: +# +# version_path_separator = : +# version_path_separator = ; +# version_path_separator = space +version_path_separator = os # Use os.pathsep. Default configuration used for new projects. + +# 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 + +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 exec runner, execute a binary +# hooks = ruff +# ruff.type = exec +# ruff.executable = %(here)s/.venv/bin/ruff +# ruff.options = --fix REVISION_SCRIPT_FILENAME + +# 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/backend/app/alembic/README b/backend/app/alembic/README new file mode 100644 index 0000000..e0d0858 --- /dev/null +++ b/backend/app/alembic/README @@ -0,0 +1 @@ +Generic single-database configuration with an async dbapi. \ No newline at end of file diff --git a/backend/app/alembic/env.py b/backend/app/alembic/env.py new file mode 100644 index 0000000..7ab90b7 --- /dev/null +++ b/backend/app/alembic/env.py @@ -0,0 +1,103 @@ +import asyncio +import os +import sys +from logging.config import fileConfig + +from sqlalchemy import pool +from sqlalchemy.engine import Connection +from sqlalchemy.ext.asyncio import async_engine_from_config + +from alembic import context +from sqlmodel import SQLModel + +sys.path.append('../../') + +from backend.app.core import path_conf # noqa: E402 + +if not os.path.exists(path_conf.Versions): + os.makedirs(path_conf.Versions) + +# 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 = 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. +from backend.app.database.db_mysql import SQLALCHEMY_DATABASE_URL # noqa: E402 + +config.set_main_option('sqlalchemy.url', SQLALCHEMY_DATABASE_URL) + + +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 do_run_migrations(connection: Connection) -> None: + context.configure(connection=connection, target_metadata=target_metadata) + + with context.begin_transaction(): + context.run_migrations() + + +async def run_async_migrations() -> None: + """In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + connectable = async_engine_from_config( + config.get_section(config.config_ini_section, {}), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + async with connectable.connect() as connection: + await connection.run_sync(do_run_migrations) + + await connectable.dispose() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode.""" + + asyncio.run(run_async_migrations()) + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/backend/app/alembic/script.py.mako b/backend/app/alembic/script.py.mako new file mode 100644 index 0000000..fbc4b07 --- /dev/null +++ b/backend/app/alembic/script.py.mako @@ -0,0 +1,26 @@ +"""${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, 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: + ${upgrades if upgrades else "pass"} + + +def downgrade() -> None: + ${downgrades if downgrades else "pass"} diff --git a/backend/app/core/path_conf.py b/backend/app/core/path_conf.py index 2376c80..725e0c1 100644 --- a/backend/app/core/path_conf.py +++ b/backend/app/core/path_conf.py @@ -8,5 +8,9 @@ # 或使用绝对路径，指到 backend 目录为止，例如 windows：BasePath = D:\git_project\fastapi_mysql\backend BasePath = Path(__file__).resolve().parent.parent.parent + +# 迁移文件存放路径 +Versions = os.path.join(BasePath, 'app', 'alembic', 'versions') + # 日志文件路径 LogPath = os.path.join(BasePath, 'app', 'log') diff --git a/backend/app/models/base.py b/backend/app/models/base.py index 826eca5..009c391 100644 --- a/backend/app/models/base.py +++ b/backend/app/models/base.py @@ -2,7 +2,7 @@ # -*- coding: utf-8 -*- from datetime import datetime -from sqlmodel import Field, SQLModel +from sqlmodel import Field from backend.app.utils.timezone import timezone @@ -12,6 +12,7 @@ ❓ MiXin 似乎并不支持：https://github.com/tiangolo/sqlmodel/pull/256 """ + # Mixin: 一种面向对象编程概念, 使结构变得更加清晰, `Wiki `__ class UserMixin: """用户 Mixin 数据类""" diff --git a/requirements.txt b/requirements.txt index 0ff31c3..5112257 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ +alembic==1.13.0 asgiref==3.7.2 asyncmy==0.2.9 bcrypt==4.0.1