Merge pull request #4 from strawberry-graphql/add-sqlalchemy-example

Author: jkimbo

common-data/movies.json

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 89
+exclude=.venv,.git
+ignore = W503
+extend-ignore =
+    # See https://github.com/PyCQA/pycodestyle/issues/373
+    E203,

fastapi-sqlalchemy/.flake8

@@ -0,0 +1,54 @@
+# FastAPI + SQLAlchemy
+
+This examples shows you how to setup Strawberry with FastAPI and SQLAlchemy. It
+setups a GraphQL API to fetch the top rated movies from IMDB (stored in a sqlite
+DB).
+
+## How to use
+
+1. Install dependencies
+
+Use [poetry](https://python-poetry.org/) to install dependencies:
+
+```bash
+poetry install
+```
+
+2. Run migrations
+
+Run [alembic](https://alembic.sqlalchemy.org/en/latest/) to create the database
+and populate it with movie data:
+
+```bash
+poetry run alembic upgrade head
+```
+
+3. Run the server
+
+Run [uvicorn](https://www.uvicorn.org/) to run the server:
+
+```bash
+poetry run uvicorn main:app --reload
+```
+
+The GraphQL API should now be available at http://localhost:8000/graphql
+
+## Example query
+
+```graphql
+query AllTopRatedMovies {
+  topRatedMovies {
+    id
+    imageUrl
+    imdbId
+    imdbRating
+    imdbRatingCount
+    title
+    year
+    director {
+      id
+      name
+    }
+  }
+}
+```

fastapi-sqlalchemy/.projectroot

@@ -0,0 +1,74 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# template used to generate migration files
+# file_template = %%(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 alembic/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"
+# version_locations = %(here)s/bar:%(here)s/bat:alembic/versions
+
+# 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

fastapi-sqlalchemy/README.md

@@ -0,0 +1 @@
+Generic single-database configuration.

fastapi-sqlalchemy/alembic.ini

@@ -0,0 +1,85 @@
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from alembic import context
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config  # type: ignore
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+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 = None
+
+from main.database import Base  # noqa
+
+target_metadata = Base.metadata
+
+# 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 get_url():
+    return "sqlite:///./db.sqlite3"
+
+
+def run_migrations_offline():
+    """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 = get_url()
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        dialect_opts={"paramstyle": "named"},
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+    configuration = config.get_section(config.config_ini_section)
+    configuration["sqlalchemy.url"] = get_url()
+    connectable = engine_from_config(
+        configuration,
+        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()

fastapi-sqlalchemy/alembic/README

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${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():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

fastapi-sqlalchemy/alembic/env.py

@@ -0,0 +1,55 @@
+"""Add initial models
+
+Revision ID: 9bc8667ab6a6
+Revises:
+Create Date: 2021-09-10 16:00:02.842263
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = "9bc8667ab6a6"
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    op.create_table(
+        "directors",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("name", sa.String(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+    )
+    op.create_index(op.f("ix_directors_id"), "directors", ["id"], unique=False)
+    op.create_index(op.f("ix_directors_name"), "directors", ["name"], unique=True)
+    op.create_table(
+        "movies",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("title", sa.String(), nullable=False),
+        sa.Column("imdb_id", sa.String(), nullable=False),
+        sa.Column("year", sa.Integer(), nullable=False),
+        sa.Column("image_url", sa.String(), nullable=False),
+        sa.Column("imdb_rating", sa.Float(), nullable=False),
+        sa.Column("imdb_rating_count", sa.String(), nullable=False),
+        sa.Column("director_id", sa.Integer(), nullable=False),
+        sa.ForeignKeyConstraint(
+            ["director_id"],
+            ["directors.id"],
+        ),
+        sa.PrimaryKeyConstraint("id"),
+        sa.UniqueConstraint("title"),
+    )
+    op.create_index(op.f("ix_movies_id"), "movies", ["id"], unique=False)
+    op.create_index(op.f("ix_movies_imdb_id"), "movies", ["imdb_id"], unique=True)
+
+
+def downgrade():
+    op.drop_index(op.f("ix_movies_imdb_id"), table_name="movies")
+    op.drop_index(op.f("ix_movies_id"), table_name="movies")
+    op.drop_table("movies")
+    op.drop_index(op.f("ix_directors_name"), table_name="directors")
+    op.drop_index(op.f("ix_directors_id"), table_name="directors")
+    op.drop_table("directors")

fastapi-sqlalchemy/alembic/script.py.mako

@@ -0,0 +1,66 @@
+"""Add data
+
+Revision ID: bea5e58f3328
+Revises: 9bc8667ab6a6
+Create Date: 2021-09-10 16:00:20.280277
+
+"""
+import json
+from pathlib import Path
+
+from alembic import op
+from sqlalchemy import orm, select
+from sqlalchemy.exc import NoResultFound
+
+from main.models import Director, Movie
+
+
+# revision identifiers, used by Alembic.
+revision = "bea5e58f3328"
+down_revision = "9bc8667ab6a6"
+branch_labels = None
+depends_on = None
+
+
+current_dir = Path(__file__).parent.resolve()
+data_file = current_dir.parent.parent.parent / "common-data" / "movies.json"
+
+
+def upgrade():
+    bind = op.get_bind()
+    session = orm.Session(bind=bind)
+
+    with data_file.open() as f:
+        json_data = json.load(f)
+
+    for movie_data in json_data:
+        try:
+            director = session.execute(
+                select(Director).filter_by(name=movie_data["director"]["name"])
+            ).scalar_one()
+        except NoResultFound:
+            director = Director(name=movie_data["director"]["name"])
+            session.add(director)
+            session.commit()
+
+        movie = Movie(
+            imdb_id=movie_data["imdb_id"],
+            title=movie_data["title"],
+            year=movie_data["year"],
+            image_url=movie_data["image_url"],
+            imdb_rating=movie_data["imdb_rating"],
+            imdb_rating_count=movie_data["imdb_rating_count"],
+            director=director,
+        )
+        session.add(movie)
+        session.commit()
+
+
+def downgrade():
+    bind = op.get_bind()
+    session = orm.Session(bind=bind)
+
+    session.execute("DELETE FROM movies")
+    session.execute("DELETE FROM directors")
+    session.commit()
+    session.close()