#377 Setup database migrations (Cole)

Author: ColeMeikle

Dockerfile

@@ -3,7 +3,9 @@ FROM python:3.11-slim
 WORKDIR /app
 COPY requirements.txt /app/
 COPY /gs/backend /app/
+RUN apt-get update && apt-get install -y gcc build-essential
 RUN pip install -r requirements.txt
 EXPOSE 8000
 
-CMD ["fastapi", "run", "gs/backend/main.py"]
+#CMD ["fastapi", "run", "gs/backend/main.py"]
+CMD ["uvicorn", "gs.backend.main:app", "--host", "0.0.0.0", "--port", "8000"]

alembic.ini

@@ -0,0 +1,110 @@
+# 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
+# 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
+
+# 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 = driver://user:pass@localhost/dbname
+
+
+[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

gs/backend/data/database/engine.py

@@ -2,9 +2,9 @@
 from sqlmodel import Session, create_engine, text
 
 from gs.backend.config.config import DATABASE_CONNECTION_STRING
-from gs.backend.data.tables.aro_user_tables import ARO_USER_SCHEMA_METADATA, ARO_USER_SCHEMA_NAME
-from gs.backend.data.tables.main_tables import MAIN_SCHEMA_METADATA, MAIN_SCHEMA_NAME
-from gs.backend.data.tables.transactional_tables import TRANSACTIONAL_SCHEMA_METADATA, TRANSACTIONAL_SCHEMA_NAME
+from gs.backend.data.tables.aro_user_tables import ARO_USER_SCHEMA_NAME
+from gs.backend.data.tables.main_tables import MAIN_SCHEMA_NAME
+from gs.backend.data.tables.transactional_tables import TRANSACTIONAL_SCHEMA_NAME
 
 
 def get_db_engine() -> Engine:
@@ -43,26 +43,11 @@ def _create_schemas(session: Session) -> None:
     connection.commit()
 
 
-def _create_tables(session: Session) -> None:
-    """
-    Creates the tables.
-
-    :warning: This assumes the relevant schemas were already created
-
-    :param session: The session for which to create the schemas
-    """
-    metadatas = [MAIN_SCHEMA_METADATA, ARO_USER_SCHEMA_METADATA, TRANSACTIONAL_SCHEMA_METADATA]
-    connection = session.connection()
-    for metadata in metadatas:
-        metadata.create_all(connection)
-        connection.commit()
-
-
 def setup_database(session: Session) -> None:
     """
-    Creates the schemas and tables for the session.
+    Creates the schemas for the session.
+    Table creation is now handled by Alembic migrations
 
     :param session: The session for which to create the schemas
     """
     _create_schemas(session)
-    _create_tables(session)

gs/backend/data/database/utils.py

@@ -1,4 +1,5 @@
 def to_foreign_key_value(
+    schema_name: str,
     foreign_table_name: str,
     foreign_column_name: str = "id",
 ) -> str:
@@ -17,5 +18,5 @@ def to_foreign_key_value(
 
     :return: The foreign key value
     """
-    foreign_key_value = f"{foreign_table_name}.{foreign_column_name}"
+    foreign_key_value = f"{schema_name}.{foreign_table_name}.{foreign_column_name}"
     return foreign_key_value

gs/backend/data/tables/aro_user_tables.py

@@ -6,7 +6,7 @@
 from pydantic import EmailStr
 from sqlalchemy import Enum
 from sqlalchemy.dialects.postgresql import UUID as DB_UUID
-from sqlalchemy.schema import Column, ForeignKey, MetaData
+from sqlalchemy.schema import Column, ForeignKey
 from sqlmodel import Field
 
 from gs.backend.config.data_config import (
@@ -20,7 +20,6 @@
 
 # Schema information
 ARO_USER_SCHEMA_NAME: Final[str] = "aro_users"
-ARO_USER_SCHEMA_METADATA: Final[MetaData] = MetaData(ARO_USER_SCHEMA_NAME)
 
 # Table names in database
 ARO_USER_TABLE_NAME: Final[str] = "users_data"
@@ -54,8 +53,8 @@ class AROUsers(BaseSQLModel, table=True):
     phone_number: str
 
     # table information
-    metadata = ARO_USER_SCHEMA_METADATA
     __tablename__ = ARO_USER_TABLE_NAME
+    __table_args__ = {"schema": ARO_USER_SCHEMA_NAME}
 
 
 class AROUserLogin(BaseSQLModel, table=True):
@@ -81,8 +80,8 @@ class AROUserLogin(BaseSQLModel, table=True):
     user_data_id: UUID = Column(DB_UUID, ForeignKey(AROUsers.id))  # type: ignore
     email_verification_token: str = Field(min_length=1, max_length=200)
 
-    metadata = ARO_USER_SCHEMA_METADATA
     __tablename__ = ARO_USER_LOGIN
+    __table_args__ = {"schema": ARO_USER_SCHEMA_NAME}
 
 
 class AROUserAuthToken(BaseSQLModel, table=True):
@@ -104,5 +103,5 @@ class AROUserAuthToken(BaseSQLModel, table=True):
     expiry: datetime = Field()
     auth_type: AROAuthToken = Field(sa_column=Column(Enum(AROAuthToken, name="auth_type"), nullable=False))
 
-    metadata = ARO_USER_SCHEMA_METADATA
     __tablename__ = ARO_AUTH_TOKEN
+    __table_args__ = {"schema": ARO_USER_SCHEMA_NAME}

gs/backend/data/tables/main_tables.py

@@ -1,14 +1,12 @@
 from typing import Final, TypeAlias
 
 from sqlalchemy import Integer
-from sqlalchemy.schema import MetaData
 from sqlmodel import Field
 
 from gs.backend.data.tables.base_model import BaseSQLModel
 
 # Schema information
 MAIN_SCHEMA_NAME: Final[str] = "main"
-MAIN_SCHEMA_METADATA: Final[MetaData] = MetaData(MAIN_SCHEMA_NAME)
 
 # Table names in database
 MAIN_COMMAND_TABLE_NAME: Final[str] = "commands"
@@ -35,8 +33,8 @@ class MainCommand(BaseSQLModel, table=True):
     total_size: int = Field(gt=0)
 
     # table information
-    metadata = MAIN_SCHEMA_METADATA
     __tablename__ = MAIN_COMMAND_TABLE_NAME
+    __table_args__ = {"schema": MAIN_SCHEMA_NAME}
 
 
 class MainTelemetry(BaseSQLModel, table=True):
@@ -54,5 +52,5 @@ class MainTelemetry(BaseSQLModel, table=True):
     total_size: int = Field(gt=0)
 
     # table information
-    metadata = MAIN_SCHEMA_METADATA
     __tablename__ = MAIN_TELEMETRY_TABLE_NAME
+    __table_args__ = {"schema": MAIN_SCHEMA_NAME}