Skip to content

Commit 360651f

Browse files
committed
Created initial db migration version. TODO: wire migrations into docker startup
1 parent 1ae5ea1 commit 360651f

File tree

8 files changed

+338
-8
lines changed

8 files changed

+338
-8
lines changed

backend/alembic.ini

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

backend/alembic/README

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

backend/alembic/env.py

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

backend/alembic/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"}
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
"""create events table
2+
3+
Revision ID: 7a6c39d2fd2e
4+
Revises:
5+
Create Date: 2026-01-03 20:07:59.554852
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 = '7a6c39d2fd2e'
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('events',
25+
sa.Column('id', sa.Integer(), nullable=False),
26+
sa.Column('source', sa.String(), nullable=False),
27+
sa.Column('type', sa.String(), nullable=False),
28+
sa.Column('payload', sa.JSON(), nullable=False),
29+
sa.Column('created_at', sa.DateTime(timezone=True), server_default=sa.text('now()'), nullable=True),
30+
sa.PrimaryKeyConstraint('id')
31+
)
32+
# ### end Alembic commands ###
33+
34+
35+
def downgrade() -> None:
36+
"""Downgrade schema."""
37+
# ### commands auto generated by Alembic - please adjust! ###
38+
op.drop_table('events')
39+
# ### end Alembic commands ###

backend/app/core/config.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,10 @@
88
DB_USER = os.getenv("POSTGRES_USER", "eventrelayuser")
99
DB_PASSWORD = os.getenv("POSTGRES_PASSWORD", "123")
1010
DB_NAME = os.getenv("POSTGRES_DB", "eventrelay")
11-
DB_HOST = os.getenv("POSTGRES_HOST", "db")
11+
DB_HOST = os.getenv("POSTGRES_HOST", "localhost")
1212
DB_PORT = os.getenv("POSTGRES_PORT", "5432")
1313

1414
print(f"DEBUG - DB Config: user={DB_USER}, db={DB_NAME}, host={DB_HOST}, port={DB_PORT}")
1515

16-
DATABASE_URL = f"postgresql://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}"
16+
DATABASE_URL = f"postgresql+asyncpg://{DB_USER}:{DB_PASSWORD}@{DB_HOST}:{DB_PORT}/{DB_NAME}"
1717
print(f"DEBUG - DATABASE_URL: {DATABASE_URL}")
18-

backend/app/db.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
from sqlalchemy.orm import declarative_base
12
from databases import Database
23
from app.core.config import DATABASE_URL
34

4-
database = Database(DATABASE_URL)
5+
database = Database(DATABASE_URL)
6+
7+
Base = declarative_base()

backend/app/models/event.py

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,20 @@
1+
from sqlalchemy import Column, Integer, String, JSON, DateTime, func
12
from pydantic import BaseModel, Field
2-
from typing import Optional, Dict
3-
from datetime import datetime
4-
3+
from typing import Dict
4+
from app.db import Base
55

6+
# pyndantic model (api inp)
67
class EventIn(BaseModel):
78
source: str = Field(..., example="auth-service")
89
type: str = Field(..., example="user.login")
9-
payload: Dict = Field(..., example={"user_id": 123})
10+
payload: Dict = Field(..., example={"user_id": 123})
11+
12+
# sqlalchemy (db schema)
13+
class Event(Base):
14+
__tablename__ = "events"
15+
16+
id = Column(Integer, primary_key=True)
17+
source = Column(String, nullable=False)
18+
type = Column(String, nullable=False)
19+
payload = Column(JSON, nullable=False)
20+
created_at = Column(DateTime(timezone=True), server_default=func.now())

0 commit comments

Comments
 (0)