diff --git a/README.md b/README.md index 84100ff..fc6c57b 100644 --- a/README.md +++ b/README.md @@ -1 +1,24 @@ # FastAPI + SQLModel + Alembic + +Sample FastAPI project that uses async SQLAlchemy, SQLModel, Postgres, Alembic, and Docker. + +## Want to learn how to build this? + +Check out the [post](https://testdriven.io/blog/fastapi-sqlmodel/). + +## Want to use this project? + +```sh +$ docker-compose up -d --build +$ docker-compose exec web alembic upgrade head +``` + +Sanity check: [http://localhost:8004/ping](http://localhost:8004/ping) + +Add a song: + +```sh +$ curl -d '{"name":"Midnight Fit", "artist":"Mogwai", "year":"2021"}' -H "Content-Type: application/json" -X POST http://localhost:8004/songs +``` + +Get all songs: [http://localhost:8004/songs](http://localhost:8004/songs) \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml index bb426d9..ed0e352 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -10,7 +10,7 @@ services: ports: - 8004:8000 environment: - - DATABASE_URL=postgresql://postgres:postgres@db:5432/foo + - DATABASE_URL=postgresql+asyncpg://postgres:postgres@db:5432/foo depends_on: - db diff --git a/project/alembic.ini b/project/alembic.ini new file mode 100644 index 0000000..782a236 --- /dev/null +++ b/project/alembic.ini @@ -0,0 +1,108 @@ +# 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 +# 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. + +# 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 = postgresql+asyncpg://postgres:postgres@db:5432/foo + + +[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 diff --git a/project/app/db.py b/project/app/db.py new file mode 100644 index 0000000..95b7692 --- /dev/null +++ b/project/app/db.py @@ -0,0 +1,24 @@ +import os + +from sqlmodel import SQLModel, create_engine +from sqlmodel.ext.asyncio.session import AsyncSession, AsyncEngine + +from sqlalchemy.orm import sessionmaker + + +DATABASE_URL = os.environ.get("DATABASE_URL") + +engine = AsyncEngine(create_engine(DATABASE_URL, echo=True, future=True)) + +async def init_db(): + async with engine.begin() as conn: + # await conn.run_sync(SQLModel.metadata.drop_all) + await conn.run_sync(SQLModel.metadata.create_all) + + +async def get_session() -> AsyncSession: + async_session = sessionmaker( + engine, class_=AsyncSession, expire_on_commit=False + ) + async with async_session() as session: + yield session \ No newline at end of file diff --git a/project/app/main.py b/project/app/main.py index 2ab3684..b4d68ae 100644 --- a/project/app/main.py +++ b/project/app/main.py @@ -1,4 +1,9 @@ -from fastapi import FastAPI +from fastapi import Depends, FastAPI +from sqlmodel import select +from sqlmodel.ext.asyncio.session import AsyncSession + +from app.db import get_session, init_db +from app.models import Song, SongCreate app = FastAPI() @@ -6,3 +11,19 @@ app = FastAPI() @app.get("/ping") async def pong(): return {"ping": "pong!"} + + +@app.get("/songs", response_model=list[Song]) +async def get_songs(session: AsyncSession = Depends(get_session)): + result = await session.execute(select(Song)) + songs = result.scalars().all() + return [Song(name=song.name, artist=song.artist, year=song.year, id=song.id) for song in songs] + + +@app.post("/songs") +async def add_song(song: SongCreate, session: AsyncSession = Depends(get_session)): + song = Song(name=song.name, artist=song.artist, year=song.year) + session.add(song) + await session.commit() + await session.refresh(song) + return song \ No newline at end of file diff --git a/project/app/models.py b/project/app/models.py new file mode 100644 index 0000000..e0953c4 --- /dev/null +++ b/project/app/models.py @@ -0,0 +1,16 @@ +from sqlmodel import SQLModel, Field +from typing import Optional + + +class SongBase(SQLModel): + name: str + artist: str + year: Optional[int] = None + + +class Song(SongBase, table=True): + id: int = Field(default=None, nullable=False, primary_key=True) + + +class SongCreate(SongBase): + pass \ No newline at end of file diff --git a/project/migrations/README b/project/migrations/README new file mode 100644 index 0000000..e0d0858 --- /dev/null +++ b/project/migrations/README @@ -0,0 +1 @@ +Generic single-database configuration with an async dbapi. \ No newline at end of file diff --git a/project/migrations/env.py b/project/migrations/env.py new file mode 100644 index 0000000..f17f0a5 --- /dev/null +++ b/project/migrations/env.py @@ -0,0 +1,93 @@ +import asyncio +from logging.config import fileConfig + +from sqlalchemy import pool +from sqlalchemy.engine import Connection +from sqlalchemy.ext.asyncio import async_engine_from_config +from sqlmodel import SQLModel # NEW + + +from alembic import context + +from app.models import Song # NEW + +# 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 +target_metadata = SQLModel.metadata # UPDATED + +# 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. + + +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. + + """ + url = config.get_main_option("sqlalchemy.url") + context.configure( + url=url, + target_metadata=target_metadata, + literal_binds=True, + dialect_opts={"paramstyle": "named"}, + ) + + with context.begin_transaction(): + context.run_migrations() + + +def do_run_migrations(connection: Connection) -> None: + context.configure(connection=connection, target_metadata=target_metadata) + + with context.begin_transaction(): + context.run_migrations() + + +async def run_async_migrations() -> None: + """In this scenario we need to create an Engine + and associate a connection with the context. + + """ + + connectable = async_engine_from_config( + config.get_section(config.config_ini_section, {}), + prefix="sqlalchemy.", + poolclass=pool.NullPool, + ) + + async with connectable.connect() as connection: + await connection.run_sync(do_run_migrations) + + await connectable.dispose() + + +def run_migrations_online() -> None: + """Run migrations in 'online' mode.""" + + asyncio.run(run_async_migrations()) + + +if context.is_offline_mode(): + run_migrations_offline() +else: + run_migrations_online() diff --git a/project/migrations/script.py.mako b/project/migrations/script.py.mako new file mode 100644 index 0000000..09e55d3 --- /dev/null +++ b/project/migrations/script.py.mako @@ -0,0 +1,25 @@ +"""${message} + +Revision ID: ${up_revision} +Revises: ${down_revision | comma,n} +Create Date: ${create_date} + +""" +from alembic import op +import sqlalchemy as sa +import sqlmodel # NEW +${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"} diff --git a/project/migrations/versions/842abcd80d3e_init.py b/project/migrations/versions/842abcd80d3e_init.py new file mode 100644 index 0000000..4522cde --- /dev/null +++ b/project/migrations/versions/842abcd80d3e_init.py @@ -0,0 +1,34 @@ +"""init + +Revision ID: 842abcd80d3e +Revises: +Create Date: 2023-07-10 17:10:45.380832 + +""" +from alembic import op +import sqlalchemy as sa +import sqlmodel # NEW + + +# revision identifiers, used by Alembic. +revision = '842abcd80d3e' +down_revision = None +branch_labels = None +depends_on = None + + +def upgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.create_table('song', + sa.Column('name', sqlmodel.sql.sqltypes.AutoString(), nullable=False), + sa.Column('artist', sqlmodel.sql.sqltypes.AutoString(), nullable=False), + sa.Column('id', sa.Integer(), nullable=False), + sa.PrimaryKeyConstraint('id') + ) + # ### end Alembic commands ### + + +def downgrade() -> None: + # ### commands auto generated by Alembic - please adjust! ### + op.drop_table('song') + # ### end Alembic commands ### diff --git a/project/migrations/versions/f68b489cdeb0_add_year.py b/project/migrations/versions/f68b489cdeb0_add_year.py new file mode 100644 index 0000000..2badcc1 --- /dev/null +++ b/project/migrations/versions/f68b489cdeb0_add_year.py @@ -0,0 +1,31 @@ +"""add year + +Revision ID: f68b489cdeb0 +Revises: 842abcd80d3e +Create Date: 2023-07-10 17:12:35.936572 + +""" +from alembic import op +import sqlalchemy as sa +import sqlmodel # NEW + + +# revision identifiers, used by Alembic. +revision = 'f68b489cdeb0' +down_revision = '842abcd80d3e' +branch_labels = None +depends_on = None + + +def upgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.add_column('song', sa.Column('year', sa.Integer(), nullable=True)) + op.create_index(op.f('ix_song_year'), 'song', ['year'], unique=False) + # ### end Alembic commands ### + + +def downgrade(): + # ### commands auto generated by Alembic - please adjust! ### + op.drop_index(op.f('ix_song_year'), table_name='song') + op.drop_column('song', 'year') + # ### end Alembic commands ### diff --git a/project/requirements.txt b/project/requirements.txt index 64fad5d..a65a3e0 100644 --- a/project/requirements.txt +++ b/project/requirements.txt @@ -1,2 +1,5 @@ -fastapi==0.99.0 -uvicorn==0.22.0 +alembic==1.11.1 +asyncpg==0.28.0 +fastapi==0.100.0 +sqlmodel==0.0.8 +uvicorn==0.22.0 \ No newline at end of file