Skip to content

Commit 73c11fc

Browse files
lsbardellsbardel
committed
Add migs
1 parent f76c702 commit 73c11fc

10 files changed

Lines changed: 395 additions & 5 deletions

File tree

‎.vscode/settings.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"python.defaultInterpreterPath": ".venv/bin/python",
3+
"[python]": {
4+
"editor.defaultFormatter": "ms-python.black-formatter",
5+
"editor.formatOnSave": true
6+
}
7+
}

‎examples/full_cli.py‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,19 @@
99

1010
dotenv.load_dotenv()
1111

12-
MIGRATIONS_PATH = Path(__file__).parent / "migrations"
12+
MIGRATIONS_PATH = Path(__file__).parent / "tasks" / "migrations"
1313

1414

1515
def create_cli() -> TaskManagerCLI:
1616
from examples.tasks import task_app
1717

18-
# create the database
18+
# create the database for the db plugin
1919
db = CrudDB.from_env(migration_path=MIGRATIONS_PATH, db_name="fluid_full_cli")
2020
# create the client
2121
task_manager_cli = TaskManagerCLI(
2222
task_app(plugins=[TaskDbPlugin(db)]),
23-
commands=list(DEFAULT_COMMANDS) + [DbGroup(db)],
23+
commands=list(DEFAULT_COMMANDS)
24+
+ [DbGroup(db, help="Task database plugin management")],
2425
help="Task Manager CLI with db plugin",
2526
)
2627
return task_manager_cli

‎examples/tasks/migrations/README‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Generic single-database configuration.

‎examples/tasks/migrations/alembic.ini‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
# A generic, single database configuration.
2+
3+
[alembic]
4+
# path to migration scripts.
5+
# this is typically a path given in POSIX (e.g. forward slashes)
6+
# format, relative to the token %(here)s which refers to the location of this
7+
# ini file
8+
script_location = /home/luca/metablock/aio-fluid/examples/tasks/migrations
9+
10+
# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
11+
# Uncomment the line below if you want the files to be prepended with date and time
12+
# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
13+
# for all available tokens
14+
# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
15+
# Or organize into date-based subdirectories (requires recursive_version_locations = true)
16+
# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).2d_%%(rev)s_%%(slug)s
17+
18+
# sys.path path, will be prepended to sys.path if present.
19+
# defaults to the current working directory. for multiple paths, the path separator
20+
# is defined by "path_separator" below.
21+
prepend_sys_path = .
22+
23+
24+
# timezone to use when rendering the date within the migration file
25+
# as well as the filename.
26+
# If specified, requires the tzdata library which can be installed by adding
27+
# `alembic[tz]` to the pip requirements.
28+
# string value is passed to ZoneInfo()
29+
# leave blank for localtime
30+
# timezone =
31+
32+
# max length of characters to apply to the "slug" field
33+
# truncate_slug_length = 40
34+
35+
# set to 'true' to run the environment during
36+
# the 'revision' command, regardless of autogenerate
37+
# revision_environment = false
38+
39+
# set to 'true' to allow .pyc and .pyo files without
40+
# a source .py file to be detected as revisions in the
41+
# versions/ directory
42+
# sourceless = false
43+
44+
# version location specification; This defaults
45+
# to <script_location>/versions. When using multiple version
46+
# directories, initial revisions must be specified with --version-path.
47+
# The path separator used here should be the separator specified by "path_separator"
48+
# below.
49+
# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions
50+
51+
# path_separator; This indicates what character is used to split lists of file
52+
# paths, including version_locations and prepend_sys_path within configparser
53+
# files such as alembic.ini.
54+
# The default rendered in new alembic.ini files is "os", which uses os.pathsep
55+
# to provide os-dependent path splitting.
56+
#
57+
# Note that in order to support legacy alembic.ini files, this default does NOT
58+
# take place if path_separator is not present in alembic.ini. If this
59+
# option is omitted entirely, fallback logic is as follows:
60+
#
61+
# 1. Parsing of the version_locations option falls back to using the legacy
62+
# "version_path_separator" key, which if absent then falls back to the legacy
63+
# behavior of splitting on spaces and/or commas.
64+
# 2. Parsing of the prepend_sys_path option falls back to the legacy
65+
# behavior of splitting on spaces, commas, or colons.
66+
#
67+
# Valid values for path_separator are:
68+
#
69+
# path_separator = :
70+
# path_separator = ;
71+
# path_separator = space
72+
# path_separator = newline
73+
#
74+
# Use os.pathsep. Default configuration used for new projects.
75+
path_separator = os
76+
77+
# set to 'true' to search source files recursively
78+
# in each "version_locations" directory
79+
# new in Alembic version 1.10
80+
# recursive_version_locations = false
81+
82+
# the output encoding used when revision files
83+
# are written from script.py.mako
84+
# output_encoding = utf-8
85+
86+
# database URL. This is consumed by the user-maintained env.py script only.
87+
# other means of configuring database URLs may be customized within the env.py
88+
# file.
89+
sqlalchemy.url = driver://user:pass@localhost/dbname
90+
91+
92+
[post_write_hooks]
93+
# post_write_hooks defines scripts or Python functions that are run
94+
# on newly generated revision scripts. See the documentation for further
95+
# detail and examples
96+
97+
# format using "black" - use the console_scripts runner, against the "black" entrypoint
98+
# hooks = black
99+
# black.type = console_scripts
100+
# black.entrypoint = black
101+
# black.options = -l 79 REVISION_SCRIPT_FILENAME
102+
103+
# lint with attempts to fix using "ruff" - use the module runner, against the "ruff" module
104+
# hooks = ruff
105+
# ruff.type = module
106+
# ruff.module = ruff
107+
# ruff.options = check --fix REVISION_SCRIPT_FILENAME
108+
109+
# Alternatively, use the exec runner to execute a binary found on your PATH
110+
# hooks = ruff
111+
# ruff.type = exec
112+
# ruff.executable = ruff
113+
# ruff.options = check --fix REVISION_SCRIPT_FILENAME
114+
115+
# Logging configuration. This is also consumed by the user-maintained
116+
# env.py script only.
117+
[loggers]
118+
keys = root,sqlalchemy,alembic
119+
120+
[handlers]
121+
keys = console
122+
123+
[formatters]
124+
keys = generic
125+
126+
[logger_root]
127+
level = WARNING
128+
handlers = console
129+
qualname =
130+
131+
[logger_sqlalchemy]
132+
level = WARNING
133+
handlers =
134+
qualname = sqlalchemy.engine
135+
136+
[logger_alembic]
137+
level = INFO
138+
handlers =
139+
qualname = alembic
140+
141+
[handler_console]
142+
class = StreamHandler
143+
args = (sys.stderr,)
144+
level = NOTSET
145+
formatter = generic
146+
147+
[formatter_generic]
148+
format = %(levelname)-5.5s [%(name)s] %(message)s
149+
datefmt = %H:%M:%S

‎examples/tasks/migrations/env.py‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
from logging.config import fileConfig
2+
3+
from sqlalchemy import engine_from_config
4+
from sqlalchemy import pool
5+
6+
from alembic import context
7+
8+
# this is the Alembic Config object, which provides
9+
# access to the values within the .ini file in use.
10+
config = context.config
11+
12+
# Interpret the config file for Python logging.
13+
# This line sets up loggers basically.
14+
if config.config_file_name is not None:
15+
fileConfig(config.config_file_name)
16+
17+
# add your model's MetaData object here
18+
# for 'autogenerate' support
19+
# from myapp import mymodel
20+
# target_metadata = mymodel.Base.metadata
21+
target_metadata = getattr(config, "metadata", None)
22+
23+
# other values from the config, defined by the needs of env.py,
24+
# can be acquired:
25+
# my_important_option = config.get_main_option("my_important_option")
26+
# ... etc.
27+
28+
29+
def run_migrations_offline() -> None:
30+
"""Run migrations in 'offline' mode.
31+
32+
This configures the context with just a URL
33+
and not an Engine, though an Engine is acceptable
34+
here as well. By skipping the Engine creation
35+
we don't even need a DBAPI to be available.
36+
37+
Calls to context.execute() here emit the given string to the
38+
script output.
39+
40+
"""
41+
url = config.get_main_option("sqlalchemy.url")
42+
context.configure(
43+
url=url,
44+
target_metadata=target_metadata,
45+
literal_binds=True,
46+
dialect_opts={"paramstyle": "named"},
47+
)
48+
49+
with context.begin_transaction():
50+
context.run_migrations()
51+
52+
53+
def run_migrations_online() -> None:
54+
"""Run migrations in 'online' mode.
55+
56+
In this scenario we need to create an Engine
57+
and associate a connection with the context.
58+
59+
"""
60+
connectable = engine_from_config(
61+
config.get_section(config.config_ini_section, {}),
62+
prefix="sqlalchemy.",
63+
poolclass=pool.NullPool,
64+
)
65+
66+
with connectable.connect() as connection:
67+
context.configure(
68+
connection=connection, target_metadata=target_metadata
69+
)
70+
71+
with context.begin_transaction():
72+
context.run_migrations()
73+
74+
75+
if context.is_offline_mode():
76+
run_migrations_offline()
77+
else:
78+
run_migrations_online()

‎examples/tasks/migrations/script.py.mako‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
"""${message}
2+
3+
Revision ID: ${up_revision}
4+
Revises: ${down_revision | comma,n}
5+
Create Date: ${create_date}
6+
7+
"""
8+
from typing import Sequence, Union
9+
10+
from alembic import op
11+
import sqlalchemy as sa
12+
${imports if imports else ""}
13+
14+
# revision identifiers, used by Alembic.
15+
revision: str = ${repr(up_revision)}
16+
down_revision: Union[str, Sequence[str], None] = ${repr(down_revision)}
17+
branch_labels: Union[str, Sequence[str], None] = ${repr(branch_labels)}
18+
depends_on: Union[str, Sequence[str], None] = ${repr(depends_on)}
19+
20+
21+
def upgrade() -> None:
22+
"""Upgrade schema."""
23+
${upgrades if upgrades else "pass"}
24+
25+
26+
def downgrade() -> None:
27+
"""Downgrade schema."""
28+
${downgrades if downgrades else "pass"}

‎examples/tasks/migrations/versions/d941c11ca25a_jsonb.py‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
"""jsonb
2+
3+
Revision ID: d941c11ca25a
4+
Revises: eae1cf7032bd
5+
Create Date: 2026-06-05 16:09:21.529862
6+
7+
"""
8+
from typing import Sequence, Union
9+
10+
from alembic import op
11+
import sqlalchemy as sa
12+
from sqlalchemy.dialects import postgresql
13+
14+
# revision identifiers, used by Alembic.
15+
revision: str = 'd941c11ca25a'
16+
down_revision: Union[str, Sequence[str], None] = 'eae1cf7032bd'
17+
branch_labels: Union[str, Sequence[str], None] = None
18+
depends_on: Union[str, Sequence[str], None] = None
19+
20+
21+
def upgrade() -> None:
22+
"""Upgrade schema."""
23+
# ### commands auto generated by Alembic - please adjust! ###
24+
op.alter_column('fluid_tasks', 'params',
25+
existing_type=postgresql.JSON(astext_type=sa.Text()),
26+
type_=postgresql.JSONB(astext_type=sa.Text()),
27+
existing_nullable=True)
28+
op.create_index('ix_fluid_tasks_params', 'fluid_tasks', ['params'], unique=False, postgresql_using='gin')
29+
op.create_index(op.f('ix_fluid_tasks_queued'), 'fluid_tasks', ['queued'], unique=False)
30+
# ### end Alembic commands ###
31+
32+
33+
def downgrade() -> None:
34+
"""Downgrade schema."""
35+
# ### commands auto generated by Alembic - please adjust! ###
36+
op.drop_index(op.f('ix_fluid_tasks_queued'), table_name='fluid_tasks')
37+
op.drop_index('ix_fluid_tasks_params', table_name='fluid_tasks', postgresql_using='gin')
38+
op.alter_column('fluid_tasks', 'params',
39+
existing_type=postgresql.JSONB(astext_type=sa.Text()),
40+
type_=postgresql.JSON(astext_type=sa.Text()),
41+
existing_nullable=True)
42+
# ### end Alembic commands ###

‎examples/tasks/migrations/versions/eae1cf7032bd_initial.py‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
"""initial
2+
3+
Revision ID: eae1cf7032bd
4+
Revises:
5+
Create Date: 2026-06-05 16:05:06.939033
6+
7+
"""
8+
from typing import Sequence, Union
9+
10+
from alembic import op
11+
import sqlalchemy as sa
12+
13+
14+
# revision identifiers, used by Alembic.
15+
revision: str = 'eae1cf7032bd'
16+
down_revision: Union[str, Sequence[str], None] = None
17+
branch_labels: Union[str, Sequence[str], None] = None
18+
depends_on: Union[str, Sequence[str], None] = None
19+
20+
21+
def upgrade() -> None:
22+
"""Upgrade schema."""
23+
# ### commands auto generated by Alembic - please adjust! ###
24+
op.create_table('fluid_tasks',
25+
sa.Column('id', sa.String(length=32), nullable=False),
26+
sa.Column('name', sa.String(length=64), nullable=False),
27+
sa.Column('priority', sa.String(length=64), nullable=False),
28+
sa.Column('state', sa.Enum('init', 'queued', 'running', 'success', 'failure', 'aborted', 'rate_limited', 'interrupted', name='taskstate'), nullable=False),
29+
sa.Column('queued', sa.DateTime(timezone=True), nullable=False),
30+
sa.Column('start', sa.DateTime(timezone=True), nullable=True),
31+
sa.Column('end', sa.DateTime(timezone=True), nullable=True),
32+
sa.Column('params', sa.JSON(), nullable=True),
33+
sa.PrimaryKeyConstraint('id')
34+
)
35+
op.create_index(op.f('ix_fluid_tasks_name'), 'fluid_tasks', ['name'], unique=False)
36+
op.create_index(op.f('ix_fluid_tasks_priority'), 'fluid_tasks', ['priority'], unique=False)
37+
op.create_index(op.f('ix_fluid_tasks_state'), 'fluid_tasks', ['state'], unique=False)
38+
# ### end Alembic commands ###
39+
40+
41+
def downgrade() -> None:
42+
"""Downgrade schema."""
43+
# ### commands auto generated by Alembic - please adjust! ###
44+
op.drop_index(op.f('ix_fluid_tasks_state'), table_name='fluid_tasks')
45+
op.drop_index(op.f('ix_fluid_tasks_priority'), table_name='fluid_tasks')
46+
op.drop_index(op.f('ix_fluid_tasks_name'), table_name='fluid_tasks')
47+
op.drop_table('fluid_tasks')
48+
# ### end Alembic commands ###

0 commit comments

Comments
 (0)