新增 alembic 管理数据库架构

Author: veoco

alembic.ini

@@ -0,0 +1,105 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = migrations
+
+# 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.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# 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 migrations/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:migrations/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.
+
+# 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
+
+# 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

database.py

@@ -1,18 +1,23 @@
 import datetime
 
+from alembic import command
+from alembic.config import Config
 from sqlalchemy import Boolean, Column, Integer, String, DateTime
 from sqlalchemy.ext.declarative import declarative_base
 from sqlalchemy.ext.asyncio import create_async_engine
 from sqlalchemy.ext.asyncio.session import AsyncSession
 
-engine = create_async_engine("sqlite+aiosqlite:///database.db")
+import settings
+
+engine = create_async_engine(f"sqlite+aiosqlite:///{settings.DATABASE_FILE}")
 
 Base = declarative_base()
 
 
 async def init_models():
-    async with engine.begin() as conn:
-        await conn.run_sync(Base.metadata.create_all)
+    config = Config()
+    config.set_main_option("script_location", "migrations")
+    command.upgrade(config, "head")
 
 
 async def get_session():

main.py

@@ -160,4 +160,4 @@ async def share(background_tasks: BackgroundTasks, text: str = Form(default=None
 if __name__ == '__main__':
     import uvicorn
 
-    uvicorn.run('main:app', host='0.0.0.0', port=settings.PORT, debug=settings.DEBUG)
+    uvicorn.run('main:app', host='0.0.0.0', port=settings.PORT, reload=settings.DEBUG)

migrations/README

@@ -0,0 +1 @@
+Generic single-database configuration.

migrations/env.py

@@ -0,0 +1,71 @@
+from logging.config import fileConfig
+from sqlalchemy import create_engine
+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
+from database import Base
+target_metadata = Base.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.
+import settings
+
+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.
+
+    """
+    context.configure(
+        url=f"sqlite:///{settings.DATABASE_FILE}",
+        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 = create_engine(f"sqlite:///{settings.DATABASE_FILE}")
+
+    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()

migrations/script.py.mako

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

migrations/versions/5a7ea072b184_init.py

@@ -0,0 +1,51 @@
+"""init
+
+Revision ID: 5a7ea072b184
+Revises: 
+Create Date: 2022-12-13 20:21:25.645856
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+import settings
+
+# revision identifiers, used by Alembic.
+revision = '5a7ea072b184'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+engine = sa.create_engine(f"sqlite:///{settings.DATABASE_FILE}")
+
+def upgrade() -> None:
+    if sa.inspect(engine).has_table("codes"):
+        return
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('codes',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('code', sa.String(length=10), nullable=True),
+    sa.Column('key', sa.String(length=30), nullable=True),
+    sa.Column('name', sa.String(length=500), nullable=True),
+    sa.Column('size', sa.Integer(), nullable=True),
+    sa.Column('type', sa.String(length=20), nullable=True),
+    sa.Column('text', sa.String(length=500), nullable=True),
+    sa.Column('used', sa.Boolean(), nullable=True),
+    sa.Column('count', sa.Integer(), nullable=True),
+    sa.Column('use_time', sa.DateTime(), nullable=True),
+    sa.Column('exp_time', sa.DateTime(), nullable=True),
+    sa.PrimaryKeyConstraint('id')
+    )
+    op.create_index(op.f('ix_codes_code'), 'codes', ['code'], unique=True)
+    op.create_index(op.f('ix_codes_id'), 'codes', ['id'], unique=False)
+    op.create_index(op.f('ix_codes_key'), 'codes', ['key'], unique=True)
+    # ### end Alembic commands ###
+
+
+def downgrade() -> None:
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(op.f('ix_codes_key'), table_name='codes')
+    op.drop_index(op.f('ix_codes_id'), table_name='codes')
+    op.drop_index(op.f('ix_codes_code'), table_name='codes')
+    op.drop_table('codes')
+    # ### end Alembic commands ###

requirements.txt

@@ -1,5 +1,6 @@
 fastapi==0.88.0
 aiosqlite==0.17.0
+alembic==1.8.1
 SQLAlchemy==1.4.44
 python-multipart==0.0.5
 uvicorn==0.15.0

settings.py

@@ -7,7 +7,7 @@
 # 端口
 PORT = config('PORT', cast=int, default=12345)
 # Sqlite数据库文件
-DATABASE_URL = config('DATABASE_URL', cast=str, default="sqlite+aiosqlite:///database.db")
+DATABASE_FILE = config('DATABASE_URL', cast=str, default="database.db")
 # 静态文件夹
 DATA_ROOT = config('DATA_ROOT', cast=str, default="./static")
 # 静态文件夹URL