Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@ dist/
.env.local
# uv.lock は再現性のためコミットする(削除)
.coverage
data/
149 changes: 149 additions & 0 deletions alembic.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,149 @@
# A generic, single database configuration.

[alembic]
# path to migration scripts.
# this is typically a path given in POSIX (e.g. forward slashes)
# format, relative to the token %(here)s which refers to the location of this
# ini file
script_location = %(here)s/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
# 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
# Or organize into date-based subdirectories (requires recursive_version_locations = true)
# file_template = %%(year)d/%%(month).2d/%%(day).2d_%%(hour).2d%%(minute).2d_%%(second).2d_%%(rev)s_%%(slug)s

# sys.path path, will be prepended to sys.path if present.
# defaults to the current working directory. for multiple paths, the path separator
# is defined by "path_separator" below.
prepend_sys_path = .


# timezone to use when rendering the date within the migration file
# as well as the filename.
# If specified, requires the tzdata library which can be 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 <script_location>/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 "path_separator"
# below.
# version_locations = %(here)s/bar:%(here)s/bat:%(here)s/alembic/versions

# path_separator; This indicates what character is used to split lists of file
# paths, including version_locations and prepend_sys_path within configparser
# files such as alembic.ini.
# The default rendered in new alembic.ini files is "os", which uses os.pathsep
# to provide os-dependent path splitting.
#
# Note that in order to support legacy alembic.ini files, this default does NOT
# take place if path_separator is not present in alembic.ini. If this
# option is omitted entirely, fallback logic is as follows:
#
# 1. Parsing of the version_locations option falls back to using the legacy
# "version_path_separator" key, which if absent then falls back to the legacy
# behavior of splitting on spaces and/or commas.
# 2. Parsing of the prepend_sys_path option falls back to the legacy
# behavior of splitting on spaces, commas, or colons.
#
# Valid values for path_separator are:
#
# path_separator = :
# path_separator = ;
# path_separator = space
# path_separator = newline
#
# Use os.pathsep. Default configuration used for new projects.
path_separator = os

# 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

# database URL. This is consumed by the user-maintained env.py script only.
# other means of configuring database URLs may be customized within the env.py
# file.
sqlalchemy.url = sqlite:///data/nene2.db


[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 module runner, against the "ruff" module
# hooks = ruff
# ruff.type = module
# ruff.module = ruff
# ruff.options = check --fix REVISION_SCRIPT_FILENAME

# Alternatively, use the exec runner to execute a binary found on your PATH
# hooks = ruff
# ruff.type = exec
# ruff.executable = ruff
# ruff.options = check --fix REVISION_SCRIPT_FILENAME

# Logging configuration. This is also consumed by the user-maintained
# env.py script only.
[loggers]
keys = root,sqlalchemy,alembic

[handlers]
keys = console

[formatters]
keys = generic

[logger_root]
level = WARNING
handlers = console
qualname =

[logger_sqlalchemy]
level = WARNING
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
1 change: 1 addition & 0 deletions alembic/README
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Generic single-database configuration.
75 changes: 75 additions & 0 deletions alembic/env.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
"""Alembic migration environment.

Reads DB_ADAPTER / DB_NAME from environment (via AppSettings) to build
the SQLAlchemy URL. Falls back to alembic.ini sqlalchemy.url for offline mode.
"""

import os
from logging.config import fileConfig

from sqlalchemy import engine_from_config, pool

from alembic import context

config = context.config

if config.config_file_name is not None:
fileConfig(config.config_file_name)

target_metadata = None


def _build_url() -> str:
"""Build SQLAlchemy URL from environment variables."""
adapter = os.getenv("DB_ADAPTER", "sqlite")
db_name = os.getenv("DB_NAME", "data/nene2.db")

if adapter == "sqlite":
return f"sqlite:///{db_name}"
if adapter == "mysql":
user = os.getenv("DB_USER", "root")
password = os.getenv("DB_PASSWORD", "")
host = os.getenv("DB_HOST", "localhost")
port = os.getenv("DB_PORT", "3306")
return f"mysql+pymysql://{user}:{password}@{host}:{port}/{db_name}"
if adapter == "pgsql":
user = os.getenv("DB_USER", "postgres")
password = os.getenv("DB_PASSWORD", "")
host = os.getenv("DB_HOST", "localhost")
port = os.getenv("DB_PORT", "5432")
return f"postgresql+psycopg2://{user}:{password}@{host}:{port}/{db_name}"

return config.get_main_option("sqlalchemy.url") or ""


def run_migrations_offline() -> None:
context.configure(
url=_build_url(),
target_metadata=target_metadata,
literal_binds=True,
dialect_opts={"paramstyle": "named"},
)
with context.begin_transaction():
context.run_migrations()


def run_migrations_online() -> None:
ini_section = config.get_section(config.config_ini_section, {})
ini_section["sqlalchemy.url"] = _build_url()

connectable = engine_from_config(
ini_section,
prefix="sqlalchemy.",
poolclass=pool.NullPool,
)

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()
28 changes: 28 additions & 0 deletions alembic/script.py.mako
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
"""${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, Sequence[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:
"""Upgrade schema."""
${upgrades if upgrades else "pass"}


def downgrade() -> None:
"""Downgrade schema."""
${downgrades if downgrades else "pass"}
44 changes: 44 additions & 0 deletions alembic/versions/001_create_notes_and_tags_tables.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
"""create notes and tags tables

Revision ID: 001
Revises:
Create Date: 2026-05-19
"""

from typing import Sequence, Union

import sqlalchemy as sa
from alembic import op

revision: str = "001"
down_revision: Union[str, Sequence[str], None] = None
branch_labels: Union[str, Sequence[str], None] = None
depends_on: Union[str, Sequence[str], None] = None


def upgrade() -> None:
op.create_table(
"notes",
sa.Column("id", sa.Integer, primary_key=True, autoincrement=True),
sa.Column("title", sa.String(200), nullable=False),
sa.Column("body", sa.Text, nullable=False),
sa.Column("created_at", sa.DateTime, server_default=sa.func.now(), nullable=False),
sa.Column(
"updated_at",
sa.DateTime,
server_default=sa.func.now(),
onupdate=sa.func.now(),
nullable=False,
),
)
op.create_table(
"tags",
sa.Column("id", sa.Integer, primary_key=True, autoincrement=True),
sa.Column("name", sa.String(100), nullable=False, unique=True),
sa.Column("created_at", sa.DateTime, server_default=sa.func.now(), nullable=False),
)


def downgrade() -> None:
op.drop_table("tags")
op.drop_table("notes")
2 changes: 2 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ dependencies = [
"pydantic>=2.9",
"pydantic-settings>=2.6",
"python-multipart>=0.0.12",
"sqlalchemy>=2.0.49",
"alembic>=1.18.4",
]

[project.optional-dependencies]
Expand Down
13 changes: 13 additions & 0 deletions src/nene2/database/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
"""NENE2 database abstraction layer."""

from .exceptions import DatabaseConnectionException
from .interfaces import DatabaseQueryExecutorInterface, DatabaseTransactionManagerInterface
from .sqlalchemy_executor import SqlAlchemyQueryExecutor, SqlAlchemyTransactionManager

__all__ = [
"DatabaseConnectionException",
"DatabaseQueryExecutorInterface",
"DatabaseTransactionManagerInterface",
"SqlAlchemyQueryExecutor",
"SqlAlchemyTransactionManager",
]
5 changes: 5 additions & 0 deletions src/nene2/database/exceptions.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
"""Database exceptions."""


class DatabaseConnectionException(Exception):
"""Raised when a database connection cannot be established."""
43 changes: 43 additions & 0 deletions src/nene2/database/interfaces.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
"""Database abstraction interfaces.

Equivalent to PHP Nene2\\Database\\DatabaseQueryExecutorInterface
and DatabaseTransactionManagerInterface.
"""

from abc import ABC, abstractmethod
from typing import Any


class DatabaseQueryExecutorInterface(ABC):
"""Execute parameterised SQL queries against a database."""

@abstractmethod
def fetch_all(
self, sql: str, params: dict[str, Any] | None = None
) -> list[dict[str, Any]]: ...

@abstractmethod
def fetch_one(
self, sql: str, params: dict[str, Any] | None = None
) -> dict[str, Any] | None: ...

@abstractmethod
def write(self, sql: str, params: dict[str, Any] | None = None) -> int:
"""Execute INSERT / UPDATE / DELETE.

Returns lastrowid for INSERT, affected rowcount for UPDATE/DELETE.
"""
...


class DatabaseTransactionManagerInterface(ABC):
"""Manage database transactions."""

@abstractmethod
def begin(self) -> None: ...

@abstractmethod
def commit(self) -> None: ...

@abstractmethod
def rollback(self) -> None: ...
Loading
Loading