Настройка среды миграции

Откроем файл alembic.ini, который содержит общую конфигурацию и увидим следующее содержание:

# A generic, single database configuration.

[alembic]
# path to migration scripts
script_location = app/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>=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 app/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:app/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.

# 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

Этот файл содержит следующие функции:

• script_location - это местоположение среды Alembic. Обычно он указывается как местоположение файловой системы, относительное или абсолютное. Если местоположение является относительным путем, оно интерпретируется как относительно текущего каталога.

• file_template - это схема именования, используемая для создания новых файлов миграции. Указанное в файле значение является значением по умолчанию, поэтому оно закомментировано.

• timezone - необязательное название часового пояса (например, UTC и т. д.), которые будут применены к временной метке, которая отображается внутри комментария файла миграции, а также внутри имени файла.

• truncate_slug_length - по умолчанию 40, максимальное количество символов для поля "slug".

• sqlalchemy.url - URL для подключения к базе данных через SQLAlchemy.

• revision_environment - это флаг, который при установлении True будет указывать на то, что скрипт среды миграции env.py должен запускаться безоговорочно при создании новых файлов миграции.

• sourceless - если установлено True, файлы ревизий, которые существуют только как файлы .pyc или .pyo в каталоге версий. Если по умолчанию установлено значение "false", только файлы .py используются в качестве файлов версий.

• version_locations - необязательный список местоположений файлов ревизий, позволяющий ревизиям существовать в нескольких каталогах одновременно.

• version_path_separator - разделитель путей version_locations. Он должен быть определен, если используется несколько version_locations.

• output_encoding - кодировка, используемая при записи файла script.py.mako в новый файл миграции. По умолчанию 'utf-8'.

• [loggers], [handlers], [formatters], [logger_], [handler_], [formatter_*] - все эти разделы являются частью стандартной конфигурации ведения журнала Python, механика которой документирована в Configuration File Format. Как и в случае с подключением к базе данных, эти директивы используются непосредственно в результате вызова logging.config.fileConfig(), присутствующего в скрипте env.py.

Чтобы продолжить дальше, настройки в файле alembic.ini должны быть изменены, чтобы Alembic мог работать с нашей базой данных и приложением. Нам нужно изменить опцию sqlalchemy.url, чтобы она соответствовала строке подключения нашей базы данных:

sqlalchemy.url = sqlite:///ecommerce.db

В следующем шаге мы закончим настройку миграций и выполним первую из них.